Sprite frame library for AnimatedSprite2D and AnimatedSprite3D.
Sprite frame library for an [AnimatedSprite2D] or [AnimatedSprite3D] node. Contains frames and animation data for playback.
Adds a new [param anim] animation to the library.
Adds a frame to the [param anim] animation. If [param at_position] is [code]-1[/code], the frame will be added to the end of the animation. [param duration] specifies the relative duration, see [method get_frame_duration] for details.
Removes all frames from the [param anim] animation.
Removes all animations. An empty [code]default[/code] animation will be created.
Duplicates the animation [param anim_from] to a new animation named [param anim_to]. Fails if [param anim_to] already exists, or if [param anim_from] does not exist.
Returns [code]true[/code] if the given animation is configured to loop when it finishes playing. Otherwise, returns [code]false[/code].
Returns an array containing the names associated to each animation. Values are placed in alphabetical order.
Returns the speed in frames per second for the [param anim] animation.
Returns the number of frames for the [param anim] animation.
Returns a relative duration of the frame [param idx] in the [param anim] animation (defaults to [code]1.0[/code]). For example, a frame with a duration of [code]2.0[/code] is displayed twice as long as a frame with a duration of [code]1.0[/code]. You can calculate the absolute duration (in seconds) of a frame using the following formula:
[codeblock]
absolute_duration = relative_duration / (animation_fps * abs(playing_speed))
[/codeblock]
In this example, [code]playing_speed[/code] refers to either [method AnimatedSprite2D.get_playing_speed] or [method AnimatedSprite3D.get_playing_speed].
Returns the texture of the frame [param idx] in the [param anim] animation.
Returns [code]true[/code] if the [param anim] animation exists.
Removes the [param anim] animation.
Removes the [param anim] animation's frame [param idx].
Changes the [param anim] animation's name to [param newname].
If [param loop] is [code]true[/code], the [param anim] animation will loop when it reaches the end, or the start if it is played in reverse.
Sets the speed for the [param anim] animation in frames per second.
Sets the [param texture] and the [param duration] of the frame [param idx] in the [param anim] animation. [param duration] specifies the relative duration, see [method get_frame_duration] for details.