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.

Checking the stable version of the documentation...

AnimationMixer¶

Inherits: Node < Object

Inherited By: AnimationPlayer, AnimationTree

Base class for AnimationPlayer and AnimationTree.

Description¶

Base class for AnimationPlayer and AnimationTree to manage animation lists. It also has general properties and methods for playback and blending.

After instantiating the playback information data within the extended class, the blending is processed by the AnimationMixer.

Properties¶

bool	active	`true`
int	audio_max_polyphony	`32`
AnimationCallbackModeMethod	callback_mode_method	`0`
AnimationCallbackModeProcess	callback_mode_process	`1`
bool	deterministic	`false`
bool	reset_on_save	`true`
NodePath	root_motion_track	`NodePath("")`
NodePath	root_node	`NodePath("..")`

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 )
void	clear_caches ( )
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
Vector3	get_root_motion_position ( ) const
Vector3	get_root_motion_position_accumulator ( ) const
Quaternion	get_root_motion_rotation ( ) const
Quaternion	get_root_motion_rotation_accumulator ( ) const
Vector3	get_root_motion_scale ( ) const
Vector3	get_root_motion_scale_accumulator ( ) const
bool	has_animation ( StringName name ) const
bool	has_animation_library ( StringName name ) const
void	remove_animation_library ( StringName name )
void	rename_animation_library ( StringName name, StringName newname )

Signals¶

animation_finished ( StringName anim_name )

Notifies when an animation finished playing.

Note: This signal is not emitted if an animation is looping.

animation_libraries_updated ( )

Notifies when the animation libraries have changed.

animation_list_changed ( )

Notifies when an animation list is changed.

animation_started ( StringName anim_name )

Notifies when an animation starts playing.

caches_cleared ( )

Notifies when the caches have been cleared, either automatically, or manually via clear_caches.

mixer_updated ( )

Editor only. Notifies when the property have been updated to update dummy AnimationPlayer in animation player editor.

Enumerations¶

enum AnimationCallbackModeProcess:

AnimationCallbackModeProcess ANIMATION_CALLBACK_MODE_PROCESS_PHYSICS = 0

Process animation during physics frames (see Node.NOTIFICATION_INTERNAL_PHYSICS_PROCESS). This is especially useful when animating physics bodies.

AnimationCallbackModeProcess ANIMATION_CALLBACK_MODE_PROCESS_IDLE = 1

Process animation during process frames (see Node.NOTIFICATION_INTERNAL_PROCESS).

AnimationCallbackModeProcess ANIMATION_CALLBACK_MODE_PROCESS_MANUAL = 2

Do not process animation. Use advance to process the animation manually.

enum AnimationCallbackModeMethod:

AnimationCallbackModeMethod ANIMATION_CALLBACK_MODE_METHOD_DEFERRED = 0

Batch method calls during the animation process, then do the calls after events are processed. This avoids bugs involving deleting nodes or modifying the AnimationPlayer while playing.

AnimationCallbackModeMethod ANIMATION_CALLBACK_MODE_METHOD_IMMEDIATE = 1

Make method calls immediately when reached in the animation.

Property Descriptions¶

bool active = true

void set_active ( bool value )
bool is_active ( )

If true, the AnimationMixer will be processing.

int audio_max_polyphony = 32

void set_audio_max_polyphony ( int value )
int get_audio_max_polyphony ( )

The number of possible simultaneous sounds for each of the assigned AudioStreamPlayers.

For example, if this value is 32 and the animation has two audio tracks, the two AudioStreamPlayers assigned can play simultaneously up to 32 voices each.

AnimationCallbackModeMethod callback_mode_method = 0

void set_callback_mode_method ( AnimationCallbackModeMethod value )
AnimationCallbackModeMethod get_callback_mode_method ( )

The call mode to use for Call Method tracks.

AnimationCallbackModeProcess callback_mode_process = 1

void set_callback_mode_process ( AnimationCallbackModeProcess value )
AnimationCallbackModeProcess get_callback_mode_process ( )

The process notification in which to update animations.

bool deterministic = false

void set_deterministic ( bool value )
bool is_deterministic ( )

If true, the blending uses the deterministic algorithm. The total weight is not normalized and the result is accumulated with an initial value (0 or a "RESET" animation if present).

This means that if the total amount of blending is 0.0, the result is equal to the "RESET" animation.

If the number of tracks between the blended animations is different, the animation with the missing track is treated as if it had the initial value.

If false, The blend does not use the deterministic algorithm. The total weight is normalized and always 1.0. If the number of tracks between the blended animations is different, nothing is done about the animation that is missing a track.

Note: In AnimationTree, the blending with AnimationNodeAdd2, AnimationNodeAdd3, AnimationNodeSub2 or the weight greater than 1.0 may produce unexpected results.

For example, if AnimationNodeAdd2 blends two nodes with the amount 1.0, then total weight is 2.0 but it will be normalized to make the total amount 1.0 and the result will be equal to AnimationNodeBlend2 with the amount 0.5.

bool reset_on_save = true

void set_reset_on_save_enabled ( bool value )
bool is_reset_on_save_enabled ( )

This is used by the editor. If set to true, the scene will be saved with the effects of the reset animation (the animation with the key "RESET") applied as if it had been seeked to time 0, with the editor keeping the values that the scene had before saving.

This makes it more convenient to preview and edit animations in the editor, as changes to the scene will not be saved as long as they are set in the reset animation.

NodePath root_motion_track = NodePath("")

void set_root_motion_track ( NodePath value )
NodePath get_root_motion_track ( )

The path to the Animation track used for root motion. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. To specify a track that controls properties or bones, append its name after the path, separated by ":". For example, "character/skeleton:ankle" or "character/mesh:transform/local".

If the track has type Animation.TYPE_POSITION_3D, Animation.TYPE_ROTATION_3D or Animation.TYPE_SCALE_3D the transformation will be canceled visually, and the animation will appear to stay in place. See also get_root_motion_position, get_root_motion_rotation, get_root_motion_scale and RootMotionView.

NodePath root_node = NodePath("..")

void set_root_node ( NodePath value )
NodePath get_root_node ( )

The node from which node path references will travel.

Method Descriptions¶

Variant _post_process_key_value ( Animation animation, int track, Variant value, Object object, int object_idx ) virtual const

A virtual function for processing after key getting during playback.

Error add_animation_library ( StringName name,