Inherits: SpriteBase3D < GeometryInstance < VisualInstance < Spatial < Node < Object

Category: Core

Brief Description

2D Sprite node in 3D world.


  • frame_changed ( )

Emitted when the frame changes.


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.

Property Descriptions

Setter set_frame(value)
Getter get_frame()

Current frame to display from sprite sheet. vframes or hframes must be greater than 1.

Setter set_hframes(value)
Getter get_hframes()

The number of columns in the sprite sheet.

  • bool region_enabled
Setter set_region(value)
Getter is_region()

If true, texture will be cut from a larger atlas texture. See region_rect. Default value: false.

Setter set_region_rect(value)
Getter get_region_rect()

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

Setter set_texture(value)
Getter get_texture()

Texture object to draw.

Setter set_vframes(value)
Getter get_vframes()

The number of rows in the sprite sheet.