AnimationNode

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 nodes mainly for use in AnimationNodeBlendTree, otherwise AnimationRootNode should be used instead.

@GodotBaseClass

struct AnimationNode {

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(AnimationNode other);

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

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static AnimationNode _new();

enum FilterAction;

enum Constants;

Array _getFilters();

void _setFilters(Array filters);

void addInput(String name);

void blendAnimation(String animation, double time, double delta, bool seeked, double blend);

double blendInput(long input_index, double time, bool seek, double blend, long filter, bool optimize);

double blendNode(String name, AnimationNode node, double time, bool seek, double blend, long filter, bool optimize);

String getCaption();

GodotObject getChildByName(String name);

Dictionary getChildNodes();

long getInputCount();

String getInputName(long input);

Variant getParameter(String name);

Variant getParameterDefaultValue(String name);

Array getParameterList();

String hasFilter();

bool isFilterEnabled();

bool isPathFiltered(NodePathArg0 path);

void process(double time, bool seek);

void removeInput(long index);

void setFilterEnabled(bool enable);

void setFilterPath(NodePathArg0 path, bool enable);

void setParameter(String name, VariantArg1 value);

bool filterEnabled [@property getter];

bool filterEnabled [@property setter];

Array filters [@property getter];

Array filters [@property setter];

}

Members

Aliases

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

Enums

Constants enum Constants
FilterAction enum FilterAction

Functions

_getFilters Array _getFilters()
_setFilters void _setFilters(Array filters)
addInput void addInput(String name): Adds an input to the node. This is only useful for nodes created for use in an AnimationNodeBlendTree.
blendAnimation void blendAnimation(String animation, double time, double delta, bool seeked, double blend): 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 seek happened.
blendInput double blendInput(long input_index, double time, bool seek, double blend, long filter, bool optimize): Blend an input. This is only useful for 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 filteraction for options).
blendNode double blendNode(String name, AnimationNode node, double time, bool seek, double blend, long filter, bool optimize): Blend another animation node (in case this node contains children animation nodes). This function is only useful if you inherit from AnimationRootNode instead, else editors will not display your node for addition.
getCaption String getCaption(): Gets the text caption for this node (used by some editors).
getChildByName GodotObject getChildByName(String name): Gets a child node by index (used by editors inheriting from AnimationRootNode).
getChildNodes Dictionary getChildNodes(): Gets all children nodes in order as a name: node dictionary. Only useful when inheriting AnimationRootNode.
getInputCount long getInputCount(): Amount of inputs in this node, only useful for nodes that go into AnimationNodeBlendTree.
getInputName String getInputName(long input): Gets the name of an input by index.
getParameter Variant getParameter(String name): Gets the value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees.
getParameterDefaultValue Variant getParameterDefaultValue(String name): Gets the default value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees.
getParameterList Array getParameterList(): Gets the property information for parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. Format is similar to GodotObject.getPropertyList.
hasFilter String hasFilter(): Returns true whether you want the blend tree editor to display filter editing on this node.
isFilterEnabled bool isFilterEnabled()
isPathFiltered bool isPathFiltered(NodePathArg0 path): Returns true whether a given path is filtered.
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(AnimationNode other)
opEquals bool opEquals(typeof(null) n)
process void process(double time, bool seek): User-defined callback called when a custom node is processed. The time parameter is a relative delta, unless seek is true, in which case it is absolute. Here, call the blendInput, blendNode or blendAnimation functions. You can also use getParameter and setParameter 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).
removeInput void removeInput(long index): Removes an input, call this only when inactive.
setFilterEnabled void setFilterEnabled(bool enable)
setFilterPath void setFilterPath(NodePathArg0 path, bool enable): Adds or removes a path for the filter.
setParameter void setParameter(String name, VariantArg1 value): Sets a custom parameter. These are used as local storage, because resources can be reused across the tree or scenes.
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

filterEnabled bool filterEnabled [@property getter]
bool filterEnabled [@property setter]: If true, filtering is enabled.
filters Array filters [@property getter]
Array filters [@property setter]

Static functions

_new AnimationNode _new(): Construct a new instance of AnimationNode. Note: use memnew!AnimationNode 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 animationnode modules

all

structs

AnimationNode