AnimatedSprite3D

public StringName Animation { get; set; }

The current animation from the AnimatedSprite3D.SpriteFrames resource. If this value is changed, the AnimatedSprite3D.Frame counter and the AnimatedSprite3D.FrameProgress are reset.

public string Autoplay { get; set; }

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

public int Frame { get; set; }

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

public float FrameProgress { get; set; }

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.

public float SpeedScale { get; set; }

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.

public SpriteFrames SpriteFrames { get; set; }

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.

public float GetPlayingSpeed();

Returns the actual playing speed of current animation or 0 if not playing. This speed is the AnimatedSprite3D.SpeedScale property multiplied by custom_speed argument specified when calling the AnimatedSprite3D.Play method. Returns a negative value if the current animation is playing backwards.

public bool IsPlaying();

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

public void Pause();

Pauses the currently playing animation. The AnimatedSprite3D.Frame and AnimatedSprite3D.FrameProgress will be kept and calling AnimatedSprite3D.Play or AnimatedSprite3D.PlayBackwards without arguments will resume the animation from the current playback position. See also AnimatedSprite3D.Stop.

public void Play(StringName name = null, float customSpeed = 1f, bool fromEnd = false);

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

public void PlayBackwards(StringName name = null);

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.

public void SetFrameAndProgress(int frame, float progress);

Sets AnimatedSprite3D.Frame and AnimatedSprite3D.FrameProgress to the given values. Unlike setting AnimatedSprite3D.Frame, this method does not reset the AnimatedSprite3D.FrameProgress to 0.0 implicitly. Example: Change the animation while keeping the same AnimatedSprite3D.Frame and AnimatedSprite3D.FrameProgress:

public void Stop();

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

public event Action AnimationChanged;

Emitted when AnimatedSprite3D.Animation changes.

public event Action AnimationFinished;

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.

public event Action AnimationLooped;

Emitted when the animation loops.

public event Action FrameChanged;

Emitted when AnimatedSprite3D.Frame changes.

public event Action SpriteFramesChanged;

Emitted when AnimatedSprite3D.SpriteFrames changes.