Table of Contents

Class AnimationLibrary

Container for Animation resources.

Inheritance
AnimationLibrary

Remarks

An animation library stores a set of animations accessible through StringName keys, for use with AnimationPlayer nodes.

See Also

Animation tutorial index

Methods

add_animation(StringName, Animation)

Adds the animation to the library, accessible by the key name.

int add_animation(StringName name, Animation animation)

Parameters

name StringName
animation Animation

get_animation(StringName)

Qualifiers: const

Returns the Animation with the key name. If the animation does not exist, null is returned and an error is logged.

Animation get_animation(StringName name)

Parameters

name StringName

get_animation_list

Qualifiers: const

Returns the keys for the Animations stored in the library.

StringName[] get_animation_list

get_animation_list_size

Qualifiers: const

Returns the key count for the Animations stored in the library.

int get_animation_list_size

has_animation(StringName)

Qualifiers: const

Returns true if the library stores an Animation with name as the key.

bool has_animation(StringName name)

Parameters

name StringName

remove_animation(StringName)

Removes the Animation with the key name.

void remove_animation(StringName name)

Parameters

name StringName

rename_animation(StringName, StringName)

Changes the key of the Animation associated with the key name to newname.

void rename_animation(StringName name, StringName newname)

Parameters

name StringName
newname StringName

Events

animation_added(StringName)

Emitted when an Animation is added, under the key name.

signal animation_added(StringName name)

Parameters

name StringName

animation_changed(StringName)

Emitted when there's a change in one of the animations, e.g. tracks are added, moved or have changed paths. name is the key of the animation that was changed.

See also changed, which this acts as a relay for.

signal animation_changed(StringName name)

Parameters

name StringName

animation_removed(StringName)

Emitted when an Animation stored with the key name is removed.

signal animation_removed(StringName name)

Parameters

name StringName

animation_renamed(StringName, StringName)

Emitted when the key for an Animation is changed, from name to to_name.

signal animation_renamed(StringName name, StringName to_name)

Parameters

name StringName
to_name StringName