Class AnimatedSprite3D

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

Inheritance

SpriteBase3D

GeometryInstance3D

VisualInstance3D

Node3D

Node

Object

AnimatedSprite3D

Remarks

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.

See Also

2D Sprite animation (also applies to 3D)

Properties

animation

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

var animation : StringName = &"default"

Property Value

StringName

Remarks

• void set_animation(StringName value)
• StringName get_animation

autoplay

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

var autoplay : String = ""

Property Value

String

Remarks

• void set_autoplay(String value)
• String get_autoplay

frame

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

var frame : int = 0

Property Value

int

Remarks

• void set_frame(int value)
• int get_frame

frame_progress

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 frame_progress : float = 0.0

Property Value

float

Remarks

• void set_frame_progress(float value)
• float get_frame_progress

speed_scale

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 speed_scale : float = 1.0

Property Value

float

Remarks

• void set_speed_scale(float value)
• float get_speed_scale

sprite_frames

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.

var sprite_frames : SpriteFrames

Property Value

SpriteFrames

Remarks

• void set_sprite_frames(SpriteFrames value)
• SpriteFrames get_sprite_frames

Methods

get_playing_speed

Qualifiers: const

Returns the actual playing speed of current animation or 0 if not playing. This speed is the speed_scale property multiplied by custom_speed argument specified when calling the AnimatedSprite3D.play method.

Returns a negative value if the current animation is playing backwards.

float get_playing_speed

is_playing

Qualifiers: const

Returns true if an animation is currently playing (even if speed_scale and/or custom_speed are 0).

bool is_playing

pause

Pauses the currently playing animation. The frame and frame_progress will be kept and calling AnimatedSprite3D.play or AnimatedSprite3D.play_backwards without arguments will resume the animation from the current playback position.

See also stop.

void pause

play(StringName, float, bool)

Plays the animation with key name. If custom_speed is negative and from_end is true, the animation will play backwards (which is equivalent to calling AnimatedSprite3D.play_backwards).

If this method is called with that same animation name, or with no name parameter, the assigned animation will resume playing if it was paused.

void play(StringName name, float custom_speed, bool from_end)

Parameters

name StringName

custom_speed float

from_end bool

play_backwards(StringName)

Plays the animation with key name in reverse.

This method is a shorthand for AnimatedSprite3D.play with custom_speed = -1.0 and from_end = true, so see its description for more information.

void play_backwards(StringName name)

Parameters

name StringName

set_frame_and_progress(int, float)

Sets frame the frame_progress to the given values. Unlike setting frame, this method does not reset the frame_progress to 0.0 implicitly.

Example: Change the animation while keeping the same frame and frame_progress:

• gdscript

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)

void set_frame_and_progress(int frame, float progress)

Parameters

frame int

progress float

stop

Stops the currently playing animation. The animation position is reset to 0 and the custom_speed is reset to 1.0. See also pause.

void stop

Events

animation_changed

Emitted when animation changes.

signal animation_changed

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_finished

animation_looped

Emitted when the animation loops.

signal animation_looped

frame_changed

Emitted when frame changes.

signal frame_changed

sprite_frames_changed

Emitted when sprite_frames changes.

signal sprite_frames_changed