AnimationNode #

virtual const func _get_caption() -> String#

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

virtual const func _get_child_by_name(name: StringName) -> AnimationNode#

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

virtual const func _get_child_nodes() -> Dictionary#

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

virtual const func _get_parameter_default_value(parameter: StringName) -> Variant#

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.

virtual const func _get_parameter_list() -> Array#

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 Object.get_property_list.

virtual const func _has_filter() -> bool#

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

virtual const func _is_parameter_read_only(parameter: StringName) -> bool#

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.

virtual func _process(test_only: bool) -> float#

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 blend_input, blend_node or blend_animation functions. You can also use get_parameter and set_parameter to modify local memory.

This function should return the delta.

func add_input(name: String) -> bool#

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.

func blend_animation(looped_flag: int = 0 enumAnimation.LoopedFlag) -> void#

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 looped_flag is used by internal processing immediately after the loop. See also Animation.LoopedFlag.

func blend_input(test_only: bool = false) -> float#

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 FilterAction for options).

func blend_node(test_only: bool = false) -> float#

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.

const func find_input(name: String) -> int#

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

const func get_input_count() -> int#

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

const func get_input_name(input: int) -> String#

Gets the name of an input by index.

const func get_parameter(name: StringName) -> Variant#

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.

const func get_processing_animation_tree_instance_id() -> int#

Returns the object id of the AnimationTree that owns this node.

Note: This method should only be called from within the AnimationNodeExtension._process_animation_node method, and will return an invalid id otherwise.

const func is_path_filtered(path: NodePath) -> bool#

Returns true if the given path is filtered.

const func is_process_testing() -> bool#

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

func remove_input(index: int) -> void#

Removes an input, call this only when inactive.

func set_filter_path(enable: bool) -> void#

Adds or removes a path for the filter.

func set_input_name(name: String) -> bool#

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

func set_parameter(value: Variant) -> void#

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