Sprite frame library for AnimatedSprite2D and AnimatedSprite3D.
Sprite frame library for an [AnimatedSprite2D] or [AnimatedSprite3D] node. Contains frames and animation data for playback.
[b]Note:[/b] You can associate a set of normal or specular maps by creating additional [SpriteFrames] resources with a [code]_normal[/code] or [code]_specular[/code] suffix. For example, having 3 [SpriteFrames] resources [code]run[/code], [code]run_normal[/code], and [code]run_specular[/code] will make it so the [code]run[/code] animation uses normal and specular maps.
Adds a new animation to the library.
Adds a frame to the given animation.
Removes all frames from the given animation.
Removes all animations. A "default" animation will be created.
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(speed_scale))
[/codeblock]
In this example, [code]speed_scale[/code] refers to either [member AnimatedSprite2D.speed_scale] or [member AnimatedSprite3D.speed_scale].
Returns the texture of the frame [param idx] in the [param anim] animation.
If [code]true[/code], the named animation exists.
Removes the given animation.
Removes the animation's selected frame.
Changes the animation's name to [param newname].
If [code]true[/code], the animation will loop.
Sets the speed for the [param anim] animation in frames per second.
Sets the texture and the duration of the frame [param idx] in the [param anim] animation.