AnimationNode

public bool FilterEnabled { get; set; }

If true, filtering is enabled.

public bool AddInput(string name);

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 void BlendAnimation(StringName animation, double time, double delta, bool seeked, bool isExternalSeeking, float blend, Animation.LoopedFlag loopedFlag = Animation.LoopedFlag.None);

Blends 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 looped_flag is used by internal processing immediately after the loop.

public double BlendInput(int inputIndex, double time, bool seek, bool isExternalSeeking, float blend, AnimationNode.FilterAction filter, bool sync);

Blends 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.

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

Blends 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.

public double BlendNode(StringName name, AnimationNode node, double time, bool seek, bool isExternalSeeking, float blend, AnimationNode.FilterAction filter, bool sync);

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 = AnimationNode.FilterAction.Ignore, bool sync = true, bool testOnly = false);

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 int FindInput(string name);

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

public int GetInputCount();

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

public string GetInputName(int input);

Gets the name of an input by index.

public Variant GetParameter(StringName name);

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 ulong GetProcessingAnimationTreeInstanceId();

Returns the object id of the AnimationTree that owns this node. Note: This method should only be called from within the AnimationNodeExtension._ProcessAnimationNode method, and will return an invalid id otherwise.

public bool IsPathFiltered(EntityPath path);

Returns true if the given path is filtered.

public bool IsProcessTesting();

Returns true if this animation node is being processed in test-only mode.

public void RemoveInput(int index);

Removes an input, call this only when inactive.

public void SetFilterPath(EntityPath path, bool enable);

Adds or removes a path for the filter.

public bool SetInputName(int input, string name);

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

public void SetParameter(StringName name, Variant value);

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

public virtual string _GetCaption();

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

public virtual AnimationNode _GetChildByName(StringName name);

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

public virtual Reckfell.Collections.Dictionary _GetChildNodes();

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

public virtual Variant _GetParameterDefaultValue(StringName parameter);

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 Reckfell.Collections.Array _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 ReckfellObject.GetPropertyList.

public virtual bool _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 _IsParameterReadOnly(StringName parameter);

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 double _Process(double time, bool seek, bool isExternalSeeking, bool testOnly);

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 AnimationNode.BlendInput, AnimationNode.BlendNode or AnimationNode.BlendAnimation functions. You can also use AnimationNode.GetParameter and AnimationNode.SetParameter to modify local memory. This function should return the delta.

public event AnimationNode.AnimationEntityRemovedEventHandler AnimationEntityRemoved;

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.AnimationEntityRenamedEventHandler AnimationEntityRenamed;

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.NodeUpdatedEventHandler NodeUpdated;

Emitted by AnimationNodeAnimation when its AnimationNodeAnimation.Animation resource is changed, or by AnimationNodeBlendTree when its connections change.

public event Action 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.