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

Properties

String

animation

"default"

int

frame

0

SpriteFrames

frames

bool

playing

false

Methods

bool

is_playing ( ) const

void

play ( String anim="" )

void

stop ( )

Signals

  • animation_finished ( )

Emitted when the animation is finished (when it plays the last frame). If the animation is looping, this signal is emitted every time the last frame is drawn.


  • frame_changed ( )

Emitted when frame changed.

Property Descriptions

Default

"default"

Setter

set_animation(value)

Getter

get_animation()

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


Default

0

Setter

set_frame(value)

Getter

get_frame()

The displayed animation frame's index.


Setter

set_sprite_frames(value)

Getter

get_sprite_frames()

The SpriteFrames resource containing the animation(s).


Default

false

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