Sprite3D¶
Inherits: SpriteBase3D < GeometryInstance < VisualInstance < CullInstance < Spatial < Node < Object
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.
Properties¶
|
||
|
||
|
||
|
||
|
||
|
Signals¶
frame_changed ( )
Emitted when the frame changes.
Property Descriptions¶
int frame
Default |
|
Setter |
set_frame(value) |
Getter |
get_frame() |
Current frame to display from sprite sheet. hframes or vframes must be greater than 1.
Vector2 frame_coords
Default |
|
Setter |
set_frame_coords(value) |
Getter |
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
Default |
|
Setter |
set_hframes(value) |
Getter |
get_hframes() |
The number of columns in the sprite sheet.
bool region_enabled
Default |
|
Setter |
set_region(value) |
Getter |
is_region() |
If true
, texture will be cut from a larger atlas texture. See region_rect.
Rect2 region_rect
Default |
|
Setter |
set_region_rect(value) |
Getter |
get_region_rect() |
The region of the atlas texture to display. region_enabled must be true
.
Texture texture
Setter |
set_texture(value) |
Getter |
get_texture() |
Texture object to draw. If GeometryInstance.material_override is used, this will be overridden. The size information is still used.
int vframes
Default |
|
Setter |
set_vframes(value) |
Getter |
get_vframes() |
The number of rows in the sprite sheet.