AnimationPlayer

Inherits: Node < Object

A node used for animation playback.

Description

An animation player is used for general-purpose playback of animations. It contains a dictionary of AnimationLibrary resources and custom blend times between animation transitions.

Some methods and properties use a single key to reference an animation directly. These keys are formatted as the key for the library, followed by a forward slash, then the key for the animation within the library, for example "movement/run". If the library's key is an empty string (known as the default library), the forward slash is omitted, being the same key used by the library.

AnimationPlayer is better-suited than Tween for more complex animations, for example ones with non-trivial timings. It can also be used over Tween if the animation track editor is more convenient than doing it in code.

Updating the target properties of animations occurs at the process frame.

Tutorials

• 2D Sprite animation

• Animation documentation index

• Third Person Shooter Demo

Properties

String	assigned_animation
int	audio_max_polyphony	32
String	autoplay	""
String	current_animation	""
float	current_animation_length
float	current_animation_position
AnimationMethodCallMode	method_call_mode	0
bool	movie_quit_on_finish	false
bool	playback_active
float	playback_default_blend_time	0.0
AnimationProcessCallback	playback_process_mode	1
bool	reset_on_save	true
NodePath	root_node	NodePath("..")
float	speed_scale	1.0

Methods

Variant	_post_process_key_value ( Animation animation, int track, Variant value, Object object, int object_idx ) virtual const
Error	add_animation_library ( StringName name, AnimationLibrary library )
void	advance ( float delta )
StringName	animation_get_next ( StringName anim_from ) const
void	animation_set_next ( StringName anim_from, StringName anim_to )
void	clear_caches ( )
void	clear_queue ( )
StringName	find_animation ( Animation animation ) const
StringName	find_animation_library ( Animation animation ) const
Animation	get_animation ( StringName name ) const
AnimationLibrary	get_animation_library ( StringName name ) const
StringName[]	get_animation_library_list ( ) const
PackedStringArray	get_animation_list ( ) const
float	get_blend_time ( StringName anim_from, StringName anim_to ) const
float	get_playing_speed ( ) const