Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

Sprite3D¶

Inherits: SpriteBase3D < GeometryInstance3D < VisualInstance3D < Node3D < 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. See also SpriteBase3D where properties such as the billboard mode are defined.

Properties¶

int	frame	`0`
Vector2i	frame_coords	`Vector2i(0, 0)`
int	hframes	`1`
bool	region_enabled	`false`
Rect2	region_rect	`Rect2(0, 0, 0, 0)`
Texture2D	texture
int	vframes	`1`

Signals¶

frame_changed ( )

Emitted when the frame changes.

texture_changed ( )

Emitted when the texture changes.

Property Descriptions¶

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 (