Table of Contents

Class AnimationTree

Namespace
Godot
Assembly
GodotSharp.dll

A node used for advanced animation transitions in an AnimationPlayer.

Note: When linked with an AnimationPlayer, several properties and methods of the corresponding AnimationPlayer will not function as expected. Playback and transitions should be handled using only the AnimationTree and its constituent AnimationNode(s). The AnimationPlayer node should be used solely for adding, deleting, and editing animations.

public class AnimationTree : AnimationMixer, IDisposable
Inheritance
AnimationTree
Implements
Inherited Members

Constructors

AnimationTree() 

public AnimationTree()

Properties

AdvanceExpressionBaseNode

The path to the Node used to evaluate the AnimationNodeExpression if one is not explicitly specified internally.

public NodePath AdvanceExpressionBaseNode { get; set; }

Property Value

NodePath

AnimPlayer

The path to the AnimationPlayer used for animating.

public NodePath AnimPlayer { get; set; }

Property Value

NodePath

TreeRoot

The root animation node of this AnimationTree. See AnimationRootNode.

public AnimationRootNode TreeRoot { get; set; }

Property Value

AnimationRootNode

Methods

GetProcessCallback()

For backward compatibility. See AnimationMixer.AnimationCallbackModeProcess.

[Obsolete("This method is deprecated.")]
public AnimationTree.AnimationProcessCallback GetProcessCallback()

Returns

AnimationTree.AnimationProcessCallback

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool

SetProcessCallback(AnimationProcessCallback)

For backward compatibility. See AnimationMixer.AnimationCallbackModeProcess.

[Obsolete("This method is deprecated.")]
public void SetProcessCallback(AnimationTree.AnimationProcessCallback mode)

Parameters

mode AnimationTree.AnimationProcessCallback

Events

AnimationPlayerChanged

Emitted when the AnimPlayer is changed.

public event Action AnimationPlayerChanged

Event Type

Action
Edit this page