Up to date
This page is up to date for Godot
If you still find outdated information, please open an issue.
Inherits: SpriteBase3D < GeometryInstance3D < VisualInstance3D < Node3D < Node < Object
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 =
Current frame to display from sprite sheet. hframes or vframes must be greater than 1.
Vector2i 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 =
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
Texture2D object to draw. If GeometryInstance3D.material_override is used, this will be overridden. The size information is still used.
int vframes =
The number of rows in the sprite sheet.