Sprite2D

Inherits: Node2D < CanvasItem < Node < Object

General-purpose sprite node.

Description

A node that displays a 2D texture. The texture displayed can be a region from a larger atlas texture, or a frame from a sprite sheet animation.

Tutorials

• Instancing Demo

Properties

bool	centered	true
bool	flip_h	false
bool	flip_v	false
int	frame	0
Vector2i	frame_coords	Vector2i(0, 0)
int	hframes	1
Vector2	offset	Vector2(0, 0)
bool	region_enabled	false
bool	region_filter_clip_enabled	false
Rect2	region_rect	Rect2(0, 0, 0, 0)
Texture2D	texture
int	vframes	1

Methods

Rect2	get_rect ( ) const
bool	is_pixel_opaque ( Vector2 pos ) const

---

Signals

frame_changed ( )

Emitted when the frame changes.

---

texture_changed ( )

Emitted when the texture changes.

---

Property Descriptions

bool centered = true

• void set_centered ( bool value )

• bool is_centered ( )

If true, texture is centered.

---

bool flip_h = false

• void set_flip_h ( bool value )

• bool is_flipped_h ( )

If true, texture is flipped horizontally.

---

bool flip_v = false

• void set_flip_v ( bool value )

• bool is_flipped_v ( )

If true, texture is flipped vertically.

---

int frame = 0

• void set_frame ( int value )

• int get_frame ( )

Current frame to display from sprite sheet. hframes or vframes must be greater than 1.

---

Vector2i frame_coords = Vector2i(0, 0)

• void set_frame_coords ( Vector2i value )

• Vector2i get_frame_coords ( )

Coordinates of the frame to display from sprite sheet. This is as an alias for the frame property. hframes or vframes must be greater than 1.

---

int hframes = 1

• void set_hframes ( int value )

• int get_hframes ( )

The number of columns in the sprite sheet.

---

Vector2 offset = Vector2(0, 0)

• void set_offset ( Vector2 value )

• Vector2 get_offset ( )

The texture's drawing offset.

---

bool region_enabled = false

• void set_region_enabled ( bool value )

• bool is_region_enabled ( )

If true, texture is cut from a larger atlas texture. See region_rect.

---

bool region_filter_clip_enabled = false

• void set_region_filter_clip_enabled (