Index · Object → RefCounted → Resource → SpriteFrames

SpriteFrames

Sprite frame library for AnimatedSprite2D and AnimatedSprite3D.

Class Description

Sprite frame library for an AnimatedSprite2D or AnimatedSprite3D node. Contains frames and animation data for playback.

Properties

Inherited from Resource (4)

Methods

func add_animation(anim: StringName) -> void

Adds a new anim animation to the library.

func add_frame(anim: StringName, texture: Texture2D, duration: float = 1.0, 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_from: StringName, 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.

func get_animation_loop(anim: StringName) -> bool

Returns true if get_animation_loop_mode(anim) == LOOP_LINEAR. Otherwise, returns false.

func get_animation_loop_mode(anim: StringName) -> SpriteFrames.LoopMode

Returns the loop mode for the anim animation.

func get_animation_names() -> PackedStringArray

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

func get_animation_speed(anim: StringName) -> float

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

func get_frame_count(anim: StringName) -> int

Returns the number of frames for the anim animation.

func get_frame_duration(anim: StringName, 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().

func get_frame_texture(anim: StringName, idx: int) -> Texture2D

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

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(anim: StringName, idx: int) -> void

Removes the anim animation's frame idx.

func rename_animation(anim: StringName, newname: StringName) -> void

Changes the anim animation's name to newname.

func set_animation_loop(anim: StringName, loop: bool) -> void

If loop is false equivalent to set_animation_loop_mode(LOOP_NONE).

If loop is true equivalent to set_animation_loop_mode(LOOP_LINEAR).

func set_animation_loop_mode(anim: StringName, loop_mode: SpriteFrames.LoopMode) -> void

Sets the loop_mode for the anim animation.

func set_animation_speed(anim: StringName, fps: float) -> void

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

func set_frame(anim: StringName, idx: int, texture: Texture2D, 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.

Inherited from Resource (18)
func _get_rid() -> RID
func _reset_state() -> void
func _set_path_cache(path: String) -> void
func _setup_local_to_scene() -> void
func copy_from_resource(resource: Resource) -> Error
func duplicate(deep: bool = false) -> Resource
func duplicate_deep(deep_subresources_mode: Resource.DeepDuplicateMode = 1) -> Resource
func emit_changed() -> void
func get_rid() -> RID
func is_built_in() -> bool
func reset_state() -> void
func set_id_for_path(path: String, id: String) -> void
func set_path_cache(path: String) -> void
func setup_local_to_scene() -> void
func take_over_path(path: String) -> void
Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Resource (2)
signal changed()
Inherited from Object (2)

Enums & Constants

enum LoopMode
LOOP_NONE = 0

The animation plays once and stops when it reaches the end, or the start if played in reverse.

LOOP_LINEAR = 1

The animation restarts from the beginning when it reaches the end, or from the end if played in reverse, repeating continuously.

LOOP_PINGPONG = 2

The animation alternates direction each time it reaches the end or start, playing forward and then in reverse repeatedly.

Note: Both AnimatedSprite2D and AnimatedSprite3D play the first/last frame for its duration only once at each end of the animation loop (instead of twice, once per forward/backward animation direction).