Inheritance #

AnimatedSprite3D #

is_instantiable, Node3D, Node, core, not_builtin_classes

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

AnimatedSprite3D is similar to the Sprite3D node, except it carries multiple textures as animation sprite_frames. Animations are created using a SpriteFrames resource, which allows you to import image files (or a folder containing said files) to provide the animation frames for the sprite. The SpriteFrames resource can be configured in the editor via the SpriteFrames bottom panel.

Members #

var animation: StringName = &"default"#

The current animation from the sprite_frames resource. If this value is changed, the frame counter and the frame_progress are reset.

var autoplay: String = ""#

The key of the animation to play when the scene loads.

var frame: int = 0#

The displayed animation frame's index. Setting this property also resets frame_progress. If this is not desired, use set_frame_and_progress.

var frame_progress: float = 0.0#

The progress value between 0.0 and 1.0 until the current frame transitions to the next frame. If the animation is playing backwards, the value transitions from 1.0 to 0.0.

var speed_scale: float = 1.0#

The speed scaling ratio. For example, if this value is 1, then the animation plays at normal speed. If it's 0.5, then it plays at half speed. If it's 2, then it plays at double speed.

If set to a negative value, the animation is played in reverse. If set to 0, the animation will not advance.

var sprite_frames: SpriteFrames#

The SpriteFrames resource containing the animation(s). Allows you the option to load, edit, clear, make unique and save the states of the SpriteFrames resource.

Methods #

var current_frame = animated_sprite.get_frame()
var current_progress = animated_sprite.get_frame_progress()
animated_sprite.play("walk_another_skin")
animated_sprite.set_frame_and_progress(current_frame, current_progress)

Annotations #

Constants #

Constructors #

Enums #

Operators #

Signals #

signal animation_changed()#

Emitted when animation changes.

signal animation_finished()#

Emitted when the animation reaches the end, or the start if it is played in reverse. When the animation finishes, it pauses the playback.

Note: This signal is not emitted if an animation is looping.

signal animation_looped()#

Emitted when the animation loops.

signal frame_changed()#

Emitted when frame changes.

signal sprite_frames_changed()#

Emitted when sprite_frames changes.

Theme Items #

Tutorials #