AnimationPlayer

Inherits: Node < Object

Category: Core

Brief Description

Container and player of Animation resources.

Member Functions

int add_animation ( String name, Animation animation )
void advance ( float delta )
String animation_get_next ( String anim_from ) const
void animation_set_next ( String anim_from, String anim_to )
void clear_caches ( )
void clear_queue ( )
String find_animation ( Animation animation ) const
Animation get_animation ( String name ) const
PoolStringArray get_animation_list ( ) const
float get_blend_time ( String anim_from, String anim_to ) const
float get_current_animation_length ( ) const
float get_current_animation_position ( ) const
bool has_animation ( String name ) const
bool is_playing ( ) const
void play ( String name=””, float custom_blend=-1, float custom_speed=1.0, bool from_end=false )
void play_backwards ( String name=””, float custom_blend=-1 )
void queue ( String name )
void remove_animation ( String name )
void rename_animation ( String name, String newname )
void seek ( float seconds, bool update=false )
void set_blend_time ( String anim_from, String anim_to, float sec )
void stop ( bool reset=true )
void stop_all ( )

Signals

Emitted when the Animation with key current_anim is modified.

  • animation_finished ( String name )

Emitted when an animation finishes.

  • animation_started ( String name )

Emitted when an animation starts.

Member Variables

  • bool active - If true updates animations in response to process-related notifications. Default value: true.
  • String autoplay - The name of the animation to play when the scene loads. Default value: "".
  • String current_animation - The name of the current animation. Default value: "".
  • float playback_default_blend_time
  • int playback_process_mode - The process notification in which to update animations. Default value: enum ANIMATION_PROCESS_IDLE.
  • NodePath root_node - The node from which node path references will travel. Default value: "..".
  • float speed_scale - The speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default value: 1.

Numeric Constants

  • ANIMATION_PROCESS_PHYSICS = 0 — Process animation during the physics process. This is especially useful when animating physics bodies.
  • ANIMATION_PROCESS_IDLE = 1 — Process animation during the idle process.

Description

An animation player is used for general purpose playback of Animation resources. It contains a dictionary of animations (referenced by name) and custom blend times between their transitions. Additionally, animations can be played and blended in different channels.

Member Function Description

Adds animation to the player accessible with the key name.

  • void advance ( float delta )

Shifts position in the animation timeline. Delta is the time in seconds to shift.

Returns the name of the next animation in the queue.

  • void animation_set_next ( String anim_from, String anim_to )

Triggers the anim_to animation when the anim_from animation completes.

  • void clear_caches ( )

AnimationPlayer caches animated nodes. It may not notice if a node disappears, so clear_caches forces it to update the cache again.

  • void clear_queue ( )

Clears all queued, unplayed animations.

Returns the name of animation or empty string if not found.

Returns the Animation with key name or null if not found.

Returns the list of stored animation names.

Get the blend time (in seconds) between two animations, referenced by their names.

  • float get_current_animation_length ( ) const

Get the length (in seconds) of the currently playing animation.

  • float get_current_animation_position ( ) const

Get the position (in seconds) of the currently playing animation.

Returns true if the AnimationPlayer stores an Animation with key name.

  • bool is_playing ( ) const

Returns true if playing an animation.

  • void play ( String name=””, float custom_blend=-1, float custom_speed=1.0, bool from_end=false )

Play the animation with key name. Custom speed and blend times can be set. If custom speed is negative (-1), ‘from_end’ being true can play the animation backwards.

  • void play_backwards ( String name=””, float custom_blend=-1 )

Play the animation with key name in reverse.

Queue an animation for playback once the current one is done.

  • void remove_animation ( String name )

Remove the animation with key name.

Rename an existing animation with key name to newname.

  • void seek ( float seconds, bool update=false )

Seek the animation to the seconds point in time (in seconds). If ‘update’ is true, the animation updates too, otherwise it updates at process time.

Specify a blend time (in seconds) between two animations, referenced by their names.

  • void stop ( bool reset=true )

Stop the currently playing animation. If reset is true, the anim position is reset to 0.

  • void stop_all ( )

Stop playback of animations (deprecated).