AnimationTree

A node to be 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.

@GodotBaseClass

struct AnimationTree {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(AnimationTree other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static AnimationTree _new();

enum AnimationProcessMode;

enum Constants;

void _clearCaches();

void _nodeRemoved(Node arg0);

void _treeChanged();

void _updateProperties();

void advance(double delta);

NodePath getAnimationPlayer();

AnimationTree.AnimationProcessMode getProcessMode();

NodePath getRootMotionTrack();

Transform getRootMotionTransform();

Ref!AnimationNode getTreeRoot();

bool isActive();

void renameParameter(String old_name, String new_name);

void setActive(bool active);

void setAnimationPlayer(NodePathArg0 root);

void setProcessMode(long mode);

void setRootMotionTrack(NodePathArg0 path);

void setTreeRoot(AnimationNode root);

bool active [@property getter];

bool active [@property setter];

NodePath animPlayer [@property getter];

NodePath animPlayer [@property setter];

AnimationTree.AnimationProcessMode processMode [@property getter];

long processMode [@property setter];

NodePath rootMotionTrack [@property getter];

NodePath rootMotionTrack [@property setter];

AnimationNode treeRoot [@property getter];

AnimationNode treeRoot [@property setter];

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Enums

AnimationProcessMode enum AnimationProcessMode
Constants enum Constants

Functions

_clearCaches void _clearCaches()
_nodeRemoved void _nodeRemoved(Node arg0)
_treeChanged void _treeChanged()
_updateProperties void _updateProperties()
advance void advance(double delta): Manually advance the animations by the specified time (in seconds).
getAnimationPlayer NodePath getAnimationPlayer()
getProcessMode AnimationTree.AnimationProcessMode getProcessMode()
getRootMotionTrack NodePath getRootMotionTrack()
getRootMotionTransform Transform getRootMotionTransform(): Retrieve the motion of the rootMotionTrack as a Transform that can be used elsewhere. If rootMotionTrack is not a path to a track of type constant Animation.TYPE_TRANSFORM, returns an identity transformation. See also rootMotionTrack and RootMotionView.
getTreeRoot Ref!AnimationNode getTreeRoot()
isActive bool isActive()
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(AnimationTree other)
opEquals bool opEquals(typeof(null) n)
renameParameter void renameParameter(String old_name, String new_name)
setActive void setActive(bool active)
setAnimationPlayer void setAnimationPlayer(NodePathArg0 root)
setProcessMode void setProcessMode(long mode)
setRootMotionTrack void setRootMotionTrack(NodePathArg0 path)
setTreeRoot void setTreeRoot(AnimationNode root)
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

active bool active [@property getter]
bool active [@property setter]: If true, the AnimationTree will be processing.
animPlayer NodePath animPlayer [@property getter]
NodePath animPlayer [@property setter]: The path to the AnimationPlayer used for animating.
processMode AnimationTree.AnimationProcessMode processMode [@property getter]
long processMode [@property setter]: The process mode of this AnimationTree. See animationprocessmode for available modes.
rootMotionTrack NodePath rootMotionTrack [@property getter]
NodePath rootMotionTrack [@property setter]: 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 constant Animation.TYPE_TRANSFORM, the transformation will be cancelled visually, and the animation will appear to stay in place. See also getRootMotionTransform and RootMotionView.
treeRoot AnimationNode treeRoot [@property getter]
AnimationNode treeRoot [@property setter]: The root animation node of this AnimationTree. See AnimationNode.

Static functions

_new AnimationTree _new(): Construct a new instance of AnimationTree. Note: use memnew!AnimationTree instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(ToRef) as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

godot animationtree structs

AnimationTree