Attention: Here be dragons
This is the
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
2D sprite node in a 3D world.
A node that displays a 2D texture in a 3D environment. The texture displayed can be a region from a larger atlas texture, or a frame from a sprite sheet animation. See also SpriteBase3D where properties such as the billboard mode are defined.
frame_changed ( )
Emitted when the frame changes.
texture_changed ( )
Emitted when the texture changes.
int frame =
Vector2i frame_coords =
int hframes =
The number of columns in the sprite sheet.
bool region_enabled =
true, the sprite will use region_rect and display only the specified part of its texture.
Rect2 region_rect =
Rect2(0, 0, 0, 0)
The region of the atlas texture to display. region_enabled must be
int vframes =
The number of rows in the sprite sheet.