AnimationTree

Inherits:AnimationMixer<Node<Object

A node used for advanced animation transitions in anAnimationPlayer.

Description

A node used for advanced animation transitions in anAnimationPlayer.

Note: When linked with anAnimationPlayer, several properties and methods of the correspondingAnimationPlayer will not function as expected. Playback and transitions should be handled using only theAnimationTree and its constituentAnimationNode(s). TheAnimationPlayer node should be used solely for adding, deleting, and editing animations.

Tutorials

Properties

NodePath

advance_expression_base_node

NodePath(".")

NodePath

anim_player

NodePath("")

AnimationCallbackModeDiscrete

callback_mode_discrete

2 (overridesAnimationMixer)

bool

deterministic

true (overridesAnimationMixer)

AnimationRootNode

tree_root

Methods

AnimationProcessCallback

get_process_callback()const

void

set_process_callback(mode:AnimationProcessCallback)


Signals

animation_player_changed()🔗

Emitted when theanim_player is changed.


Enumerations

enumAnimationProcessCallback:🔗

AnimationProcessCallbackANIMATION_PROCESS_PHYSICS =0

Deprecated: SeeAnimationMixer.ANIMATION_CALLBACK_MODE_PROCESS_PHYSICS.

AnimationProcessCallbackANIMATION_PROCESS_IDLE =1

Deprecated: SeeAnimationMixer.ANIMATION_CALLBACK_MODE_PROCESS_IDLE.

AnimationProcessCallbackANIMATION_PROCESS_MANUAL =2

Deprecated: SeeAnimationMixer.ANIMATION_CALLBACK_MODE_PROCESS_MANUAL.


Property Descriptions

NodePathadvance_expression_base_node =NodePath(".")🔗

The path to theNode used to evaluate theAnimationNodeExpression if one is not explicitly specified internally.


NodePathanim_player =NodePath("")🔗

The path to theAnimationPlayer used for animating.


AnimationRootNodetree_root🔗

The root animation node of thisAnimationTree. SeeAnimationRootNode.


Method Descriptions

AnimationProcessCallbackget_process_callback()const🔗

Deprecated: UseAnimationMixer.callback_mode_process instead.

Returns the process notification in which to update animations.


voidset_process_callback(mode:AnimationProcessCallback)🔗

Deprecated: UseAnimationMixer.callback_mode_process instead.

Sets the process notification in which to update animations.


User-contributed notes

Please read theUser-contributed notes policy before submitting a comment.