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

Hérite de : SpriteBase3D < GeometryInstance3D < VisualInstance3D < Node3D < Node < Object

Nœud de sprite en 2D dans un monde en 3D.

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.

Propriétés

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

Signaux

frame_changed() 🔗

Émis quand une frame changes.

texture_changed() 🔗

Émis quand une texture change.

Descriptions des propriétés

int frame = 0 🔗

  • void set_frame(value: int)

  • int get_frame()

Trame actuelle à afficher à partir de la feuille de sprite. hframes ou vframes doivent être supérieurs à 1. Cette propriété est automatiquement rajustée lorsque hframes ou vframes sont modifiés pour garder le pointage sur la même trame visuelle (même colonne et rangée). Si c'est impossible, cette valeur est réinitialisée à 0.

Vector2i frame_coords = Vector2i(0, 0) 🔗

Les coordonnées de la trame à afficher de la feuille de sprite. Il s'agit d'un raccourci de la propriété frame. hframes ou vframes doivent être supérieurs à 1.

int hframes = 1 🔗

  • void set_hframes(value: int)

  • int get_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.

bool region_enabled = false 🔗

  • void set_region_enabled(value: bool)

  • bool is_region_enabled()

Si true, le sprite utilisera region_rect et n'affichera que la partie spécifiée de sa texture.

Rect2 region_rect = Rect2(0, 0, 0, 0) 🔗

  • void set_region_rect(value: Rect2)

  • Rect2 get_region_rect()

La région de la texture atlas à afficher. region_enabled doit être true.

Texture2D texture 🔗

L'objet Texture2D à dessiner. Si GeometryInstance3D.material_override est utilisé, cela sera redéfini. L'information de la taille est toujours utilisée.

int vframes = 1 🔗

  • void set_vframes(value: int)

  • int get_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.