Class Sprite3D

2D sprite node in a 3D world.

Inheritance

SpriteBase3D

GeometryInstance3D

VisualInstance3D

Node3D

Node

Object

Sprite3D

Remarks

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

frame

Current 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.

var frame : int = 0

Property Value

int

Remarks

• void set_frame(int value)
• int get_frame

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.

var frame_coords : Vector2i = Vector2i(0, 0)

Property Value

Vector2i

Remarks

• void set_frame_coords(Vector2i value)
• Vector2i get_frame_coords

hframes

The 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.

var hframes : int = 1

Property Value

int

Remarks

• void set_hframes(int value)
• int get_hframes

region_enabled

If true, the sprite will use region_rect and display only the specified part of its texture.

var region_enabled : bool = false

Property Value

bool

Remarks

• void set_region_enabled(bool value)
• bool is_region_enabled

region_rect

The region of the atlas texture to display. region_enabled must be true.

var region_rect : Rect2 = Rect2(0, 0, 0, 0)

Property Value

Rect2

Remarks

• void set_region_rect(Rect2 value)
• Rect2 get_region_rect

texture

Texture2D object to draw. If material_override is used, this will be overridden. The size information is still used.

var texture : Texture2D

Property Value

Texture2D

Remarks

• void set_texture(Texture2D value)
• Texture2D get_texture

vframes

The 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.

var vframes : int = 1

Property Value

int

Remarks

• void set_vframes(int value)
• int get_vframes

Events

frame_changed

Emitted when the frame changes.

signal frame_changed

texture_changed

Emitted when the texture changes.

signal texture_changed