Class reference
Sprite3D
Inherits SpriteBase3D
2D sprite node in a 3D world.
Description
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.
Properties
int frame = 0
int frame = 0Current frame to display from sprite sheet. hframes or vframes must be greater than 1. This property is automatically adjusted when hframes or vframes are changed to keep pointing to the same visual frame (same column and row). If that's impossible, this value is reset to 0.
Vector2i frame_coords = Vector2i(0, 0)
Vector2i frame_coords = Vector2i(0, 0)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
int hframes = 1The number of columns in the sprite sheet. When this property is changed, frame is adjusted so that the same visual frame is maintained (same row and column). If that's impossible, frame is reset to 0.
bool region_enabled = false
bool region_enabled = falseIf true, the sprite will use region_rect and display only the specified part of its texture.
Rect2 region_rect = Rect2(0, 0, 0, 0)
Rect2 region_rect = Rect2(0, 0, 0, 0)The region of the atlas texture to display. region_enabled must be true.
Texture2D texture
Texture2D textureTexture2D object to draw. If GeometryInstance3D.material_override is used, this will be overridden. The size information is still used.
int vframes = 1
int vframes = 1The number of rows in the sprite sheet. When this property is changed, frame is adjusted so that the same visual frame is maintained (same row and column). If that's impossible, frame is reset to 0.