SpriteFrames #

func add_animation(anim: StringName) -> void#

Adds a new anim animation to the library.

func add_frame(at_position: int = -1) -> void#

Adds a frame to the anim animation. If at_position is -1, the frame will be added to the end of the animation. duration specifies the relative duration, see get_frame_duration for details.

func clear(anim: StringName) -> void#

Removes all frames from the anim animation.

func clear_all() -> void#

Removes all animations. An empty default animation will be created.

func duplicate_animation(anim_to: StringName) -> void#

Duplicates the animation anim_from to a new animation named anim_to. Fails if anim_to already exists, or if anim_from does not exist.

const func get_animation_loop(anim: StringName) -> bool#

Returns true if the given animation is configured to loop when it finishes playing. Otherwise, returns false.

const func get_animation_names() -> PackedStringArray#

Returns an array containing the names associated to each animation. Values are placed in alphabetical order.

const func get_animation_speed(anim: StringName) -> float#

Returns the speed in frames per second for the anim animation.

const func get_frame_count(anim: StringName) -> int#

Returns the number of frames for the anim animation.

const func get_frame_duration(idx: int) -> float#

Returns a relative duration of the frame idx in the anim animation (defaults to 1.0). For example, a frame with a duration of 2.0 is displayed twice as long as a frame with a duration of 1.0. You can calculate the absolute duration (in seconds) of a frame using the following formula:

absolute_duration = relative_duration / (animation_fps * abs(playing_speed))

In this example, playing_speed refers to either AnimatedSprite2D.get_playing_speed or AnimatedSprite3D.get_playing_speed.

const func get_frame_texture(idx: int) -> Texture2D#

Returns the texture of the frame idx in the anim animation.

const func has_animation(anim: StringName) -> bool#

Returns true if the anim animation exists.

func remove_animation(anim: StringName) -> void#

Removes the anim animation.

func remove_frame(idx: int) -> void#

Removes the anim animation's frame idx.

func rename_animation(newname: StringName) -> void#

Changes the anim animation's name to newname.

func set_animation_loop(loop: bool) -> void#

If loop is true, the anim animation will loop when it reaches the end, or the start if it is played in reverse.

func set_animation_speed(fps: float) -> void#

Sets the speed for the anim animation in frames per second.

func set_frame(duration: float = 1.0) -> void#

Sets the texture and the duration of the frame idx in the anim animation. duration specifies the relative duration, see get_frame_duration for details.