Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

AnimationLibrary

Inherits: Resource < RefCounted < Object

Container for Animation resources.

Description

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

Tutorials

Methods

Error

add_animation ( StringName name, Animation animation )

Animation

get_animation ( StringName name ) const

StringName[]

get_animation_list ( ) const

bool

has_animation ( StringName name ) const

void

remove_animation ( StringName name )

void

rename_animation ( StringName name, StringName newname )


Signals

animation_added ( StringName name )

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


animation_changed ( StringName name )

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 Resource.changed, which this acts as a relay for.


animation_removed ( StringName name )

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


animation_renamed ( StringName name, StringName to_name )

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


Method Descriptions

Error add_animation ( StringName name, Animation animation )

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


Animation get_animation ( StringName name ) const

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


StringName[] get_animation_list ( ) const

Returns the keys for the Animations stored in the library.


bool has_animation ( StringName name ) const

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


void remove_animation ( StringName name )

Removes the Animation with the key name.


void rename_animation ( StringName name, StringName newname )

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


User-contributed notes

Please read the User-contributed notes policy before submitting a comment.