AnimatedSprite3D

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

2D sprite node in 3D world, that can use multiple 2D textures for animation.

Description

Animations are created using a SpriteFrames resource, which can be configured in the editor via the SpriteFrames panel.

Tutorials

• 2D Sprite animation

Properties

Methods

Signals

frame_changed ( )

Emitted when frame changed.

Property Descriptions

String animation

The current animation from the frames resource. If this value changes, the frame counter is reset.

int frame

The displayed animation frame's index.

SpriteFrames frames

The SpriteFrames resource containing the animation(s).

bool playing

If true, the animation is currently playing.

Method Descriptions

bool is_playing ( ) const

Returns true if an animation is currently being played.

void play ( String anim="" )

Plays the animation named anim. If no anim is provided, the current animation is played.

void stop ( )

Stops the current animation (does not reset the frame counter).