Class AnimationNode

Namespace

Godot

Assembly

GodotSharp.dll

Base resource for AnimationTree nodes. In general, it's not used directly, but you can create custom ones with custom blending formulas.

Inherit this when creating animation nodes mainly for use in AnimationNodeBlendTree, otherwise AnimationRootNode should be used instead.

public class AnimationNode : Resource, IDisposable

Inheritance

object

GodotObject

RefCounted

Resource

AnimationNode

Implements

IDisposable

Derived

AnimationNodeOutput

AnimationNodeSync

AnimationNodeTimeScale

AnimationNodeTimeSeek

AnimationRootNode

Inherited Members

Resource._GetRid()

Resource._SetupLocalToScene()

Resource.TakeOverPath(string)

Resource.GetRid()

Resource.GetLocalScene()

Resource.SetupLocalToScene()

Resource.EmitChanged()

Resource.Duplicate(bool)

Resource.ResourceLocalToScene

Resource.ResourcePath

Resource.ResourceName

Resource.Changed

Resource.SetupLocalToSceneRequested

RefCounted.InitRef()

RefCounted.Reference()

RefCounted.Unreference()

RefCounted.GetReferenceCount()

GodotObject.NotificationPostinitialize

GodotObject.NotificationPredelete

GodotObject.NotificationExtensionReloaded

GodotObject.InstanceFromId(ulong)

GodotObject.IsInstanceIdValid(ulong)

GodotObject.IsInstanceValid(GodotObject)

GodotObject.WeakRef(GodotObject)

GodotObject.Dispose()

GodotObject.Dispose(bool)

GodotObject.ToString()

GodotObject.ToSignal(GodotObject, StringName)

GodotObject._Get(StringName)

GodotObject._GetPropertyList()

GodotObject._Notification(int)

GodotObject._PropertyCanRevert(StringName)

GodotObject._PropertyGetRevert(StringName)

GodotObject._Set(StringName, Variant)

GodotObject._ValidateProperty(Dictionary)

GodotObject.Free()

GodotObject.GetClass()

GodotObject.IsClass(string)

GodotObject.Set(StringName, Variant)

GodotObject.Get(StringName)

GodotObject.SetIndexed(NodePath, Variant)

GodotObject.GetIndexed(NodePath)

GodotObject.GetPropertyList()

GodotObject.GetMethodList()

GodotObject.PropertyCanRevert(StringName)

GodotObject.PropertyGetRevert(StringName)

GodotObject.Notification(int, bool)

GodotObject.GetInstanceId()

GodotObject.SetScript(Variant)

GodotObject.GetScript()

GodotObject.SetMeta(StringName, Variant)

GodotObject.RemoveMeta(StringName)

GodotObject.GetMeta(StringName, Variant)

GodotObject.HasMeta(StringName)

GodotObject.GetMetaList()

GodotObject.AddUserSignal(string, Array)

GodotObject.HasUserSignal(StringName)

GodotObject.EmitSignal(StringName, params Variant[])

GodotObject.Call(StringName, params Variant[])

GodotObject.CallDeferred(StringName, params Variant[])

GodotObject.SetDeferred(StringName, Variant)

GodotObject.Callv(StringName, Array)

GodotObject.HasMethod(StringName)

GodotObject.HasSignal(StringName)

GodotObject.GetSignalList()

GodotObject.GetSignalConnectionList(StringName)

GodotObject.GetIncomingConnections()

GodotObject.Connect(StringName, Callable, uint)

GodotObject.Disconnect(StringName, Callable)

GodotObject.IsConnected(StringName, Callable)

GodotObject.SetBlockSignals(bool)

GodotObject.IsBlockingSignals()

GodotObject.NotifyPropertyListChanged()

GodotObject.SetMessageTranslation(bool)

GodotObject.CanTranslateMessages()

GodotObject.Tr(StringName, StringName)

GodotObject.TrN(StringName, StringName, int, StringName)

GodotObject.IsQueuedForDeletion()

GodotObject.CancelFree()

GodotObject.NativeInstance

GodotObject.ScriptChanged

GodotObject.PropertyListChanged

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

AnimationNode()

public AnimationNode()

Properties

FilterEnabled

If true, filtering is enabled.

public bool FilterEnabled { get; set; }

Property Value

bool

Filters

public Array Filters { get; set; }

Property Value

Array

Methods

AddInput(string)

Adds an input to the animation node. This is only useful for animation nodes created for use in an AnimationNodeBlendTree. If the addition fails, returns false.

public bool AddInput(string name)

Parameters

name string

Returns

bool

BlendAnimation(StringName, double, double, bool, bool, float, LoopedFlag)

Blend an animation by blend amount (name must be valid in the linked AnimationPlayer). A time and delta may be passed, as well as whether seeked happened.

A loopedFlag is used by internal processing immediately after the loop. See also Animation.LoopedFlag.

public void BlendAnimation(StringName animation, double time, double delta, bool seeked, bool isExternalSeeking, float blend, Animation.LoopedFlag loopedFlag = LoopedFlag.None)

Parameters

animation StringName

time double

delta double

seeked bool

isExternalSeeking bool

blend float

loopedFlag Animation.LoopedFlag

BlendInput(int, double, bool, bool, float, FilterAction, bool, bool)

Blend an input. This is only useful for animation nodes created for an AnimationNodeBlendTree. The time parameter is a relative delta, unless seek is true, in which case it is absolute. A filter mode may be optionally passed (see AnimationNode.FilterAction for options).

public double BlendInput(int inputIndex, double time, bool seek, bool isExternalSeeking, float blend, AnimationNode.FilterAction filter = FilterAction.Ignore, bool sync = true, bool testOnly = false)

Parameters

inputIndex int

time double

seek bool

isExternalSeeking bool

blend float

filter AnimationNode.FilterAction

sync bool

testOnly bool

Returns

double

BlendNode(StringName, AnimationNode, double, bool, bool, float, FilterAction, bool, bool)

Blend another animation node (in case this animation node contains child animation nodes). This function is only useful if you inherit from AnimationRootNode instead, otherwise editors will not display your animation node for addition.

public double BlendNode(StringName name, AnimationNode node, double time, bool seek, bool isExternalSeeking, float blend, AnimationNode.FilterAction filter = FilterAction.Ignore, bool sync = true, bool testOnly = false)

Parameters

name StringName

node AnimationNode

time double

seek bool

isExternalSeeking bool

blend float

filter AnimationNode.FilterAction

sync bool

testOnly bool

Returns

double

FindInput(string)

Returns the input index which corresponds to name. If not found, returns -1.

public int FindInput(string name)

Parameters

name string

Returns

int

GetInputCount()

Amount of inputs in this animation node, only useful for animation nodes that go into AnimationNodeBlendTree.

public int GetInputCount()

Returns

int

GetInputName(int)

Gets the name of an input by index.

public string GetInputName(int input)

Parameters

input int

Returns

string

GetParameter(StringName)

Gets the value of a parameter. Parameters are custom local memory used for your animation nodes, given a resource can be reused in multiple trees.

public Variant GetParameter(StringName name)

Parameters

name StringName

Returns

Variant

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

IsPathFiltered(NodePath)

Returns whether the given path is filtered.

public bool IsPathFiltered(NodePath path)

Parameters

path NodePath

Returns

bool

RemoveInput(int)

Removes an input, call this only when inactive.

public void RemoveInput(int index)

Parameters

index int

SetFilterPath(NodePath, bool)

Adds or removes a path for the filter.

public void SetFilterPath(NodePath path, bool enable)

Parameters

path NodePath

enable bool

SetInputName(int, string)

Sets the name of the input at the given input index. If the setting fails, returns false.

public bool SetInputName(int input, string name)

Parameters

input int

name string

Returns

bool

SetParameter(StringName, Variant)

Sets a custom parameter. These are used as local memory, because resources can be reused across the tree or scenes.

public void SetParameter(StringName name, Variant value)

Parameters

name StringName

value Variant

_GetCaption()

When inheriting from AnimationRootNode, implement this virtual method to override the text caption for this animation node.

public virtual string _GetCaption()

Returns

string

_GetChildByName(StringName)

When inheriting from AnimationRootNode, implement this virtual method to return a child animation node by its name.

public virtual AnimationNode _GetChildByName(StringName name)

Parameters

name StringName

Returns

AnimationNode

_GetChildNodes()

When inheriting from AnimationRootNode, implement this virtual method to return all child animation nodes in order as a name: node dictionary.

public virtual Dictionary _GetChildNodes()

Returns

Dictionary

_GetParameterDefaultValue(StringName)

When inheriting from AnimationRootNode, implement this virtual method to return the default value of a parameter. Parameters are custom local memory used for your animation nodes, given a resource can be reused in multiple trees.

public virtual Variant _GetParameterDefaultValue(StringName parameter)

Parameters

parameter StringName

Returns

Variant

_GetParameterList()

When inheriting from AnimationRootNode, implement this virtual method to return a list of the properties on this animation node. Parameters are custom local memory used for your animation nodes, given a resource can be reused in multiple trees. Format is similar to GetPropertyList().

public virtual Array _GetParameterList()

Returns

Array

_HasFilter()

When inheriting from AnimationRootNode, implement this virtual method to return whether the blend tree editor should display filter editing on this animation node.

public virtual bool _HasFilter()

Returns

bool

_IsParameterReadOnly(StringName)

When inheriting from AnimationRootNode, implement this virtual method to return whether the parameter is read-only. Parameters are custom local memory used for your animation nodes, given a resource can be reused in multiple trees.

public virtual bool _IsParameterReadOnly(StringName parameter)

Parameters

parameter StringName

Returns

bool

_Process(double, bool, bool, bool)

When inheriting from AnimationRootNode, implement this virtual method to run some code when this animation node is processed. The time parameter is a relative delta, unless seek is true, in which case it is absolute.

Here, call the BlendInput(int, double, bool, bool, float, FilterAction, bool, bool), BlendNode(StringName, AnimationNode, double, bool, bool, float, FilterAction, bool, bool) or BlendAnimation(StringName, double, double, bool, bool, float, LoopedFlag) functions. You can also use GetParameter(StringName) and SetParameter(StringName, Variant) to modify local memory.

This function should return the time left for the current animation to finish (if unsure, pass the value from the main blend being called).

public virtual double _Process(double time, bool seek, bool isExternalSeeking, bool testOnly)

Parameters

time double

seek bool

isExternalSeeking bool

testOnly bool

Returns

double

Events

AnimationNodeRemoved

Emitted by nodes that inherit from this class and that have an internal tree when one of their animation nodes removes. The animation nodes that emit this signal are AnimationNodeBlendSpace1D, AnimationNodeBlendSpace2D, AnimationNodeStateMachine, and AnimationNodeBlendTree.

public event AnimationNode.AnimationNodeRemovedEventHandler AnimationNodeRemoved

Event Type

AnimationNode.AnimationNodeRemovedEventHandler

AnimationNodeRenamed

Emitted by nodes that inherit from this class and that have an internal tree when one of their animation node names changes. The animation nodes that emit this signal are AnimationNodeBlendSpace1D, AnimationNodeBlendSpace2D, AnimationNodeStateMachine, and AnimationNodeBlendTree.

public event AnimationNode.AnimationNodeRenamedEventHandler AnimationNodeRenamed

Event Type

AnimationNode.AnimationNodeRenamedEventHandler

TreeChanged

Emitted by nodes that inherit from this class and that have an internal tree when one of their animation nodes changes. The animation nodes that emit this signal are AnimationNodeBlendSpace1D, AnimationNodeBlendSpace2D, AnimationNodeStateMachine, AnimationNodeBlendTree and AnimationNodeTransition.

public event Action TreeChanged

Event Type

Action