2018-07-26 17:56:21 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-07-06 16:08:05 +08:00
<class name= "AnimationNode" inherits= "Resource" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2018-07-26 17:56:21 +08:00
<brief_description >
2023-04-28 23:16:44 +08:00
Base class for [AnimationTree] nodes. Not related to scene nodes.
2018-07-26 17:56:21 +08:00
</brief_description>
<description >
2019-06-22 07:04:47 +08:00
Base resource for [AnimationTree] nodes. In general, it's not used directly, but you can create custom ones with custom blending formulas.
2023-04-30 22:32:18 +08:00
Inherit this when creating animation nodes mainly for use in [AnimationNodeBlendTree], otherwise [AnimationRootNode] should be used instead.
2018-07-26 17:56:21 +08:00
</description>
<tutorials >
2023-04-28 23:16:44 +08:00
<link title= "Using AnimationTree" > $DOCS_URL/tutorials/animation/animation_tree.html</link>
2018-07-26 17:56:21 +08:00
</tutorials>
<methods >
2021-08-22 09:52:44 +08:00
<method name= "_get_caption" qualifiers= "virtual const" >
2021-07-30 21:28:05 +08:00
<return type= "String" />
2021-05-16 05:48:59 +08:00
<description >
2023-04-30 22:32:18 +08:00
When inheriting from [AnimationRootNode], implement this virtual method to override the text caption for this animation node.
2021-05-16 05:48:59 +08:00
</description>
</method>
2021-08-22 09:52:44 +08:00
<method name= "_get_child_by_name" qualifiers= "virtual const" >
<return type= "AnimationNode" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "name" type= "StringName" />
2021-05-16 05:48:59 +08:00
<description >
2023-04-30 22:32:18 +08:00
When inheriting from [AnimationRootNode], implement this virtual method to return a child animation node by its [param name].
2021-05-16 05:48:59 +08:00
</description>
</method>
2021-08-22 09:52:44 +08:00
<method name= "_get_child_nodes" qualifiers= "virtual const" >
2021-07-30 21:28:05 +08:00
<return type= "Dictionary" />
2021-05-16 05:48:59 +08:00
<description >
2023-04-30 22:32:18 +08:00
When inheriting from [AnimationRootNode], implement this virtual method to return all children animation nodes in order as a [code]name: node[/code] dictionary.
2021-05-16 05:48:59 +08:00
</description>
</method>
2021-08-22 09:52:44 +08:00
<method name= "_get_parameter_default_value" qualifiers= "virtual const" >
2021-07-30 21:28:05 +08:00
<return type= "Variant" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "parameter" type= "StringName" />
2021-05-16 05:48:59 +08:00
<description >
2023-04-30 22:32:18 +08:00
When inheriting from [AnimationRootNode], implement this virtual method to return the default value of a [param parameter]. Parameters are custom local memory used for your animation nodes, given a resource can be reused in multiple trees.
2021-05-16 05:48:59 +08:00
</description>
</method>
2021-08-22 09:52:44 +08:00
<method name= "_get_parameter_list" qualifiers= "virtual const" >
2021-07-30 21:28:05 +08:00
<return type= "Array" />
2021-05-16 05:48:59 +08:00
<description >
2023-04-30 22:32:18 +08:00
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 [method Object.get_property_list].
2021-05-16 05:48:59 +08:00
</description>
</method>
2021-08-22 09:52:44 +08:00
<method name= "_has_filter" qualifiers= "virtual const" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
2021-05-16 05:48:59 +08:00
<description >
2023-04-30 22:32:18 +08:00
When inheriting from [AnimationRootNode], implement this virtual method to return whether the blend tree editor should display filter editing on this animation node.
2021-05-16 05:48:59 +08:00
</description>
</method>
2023-01-12 20:51:03 +08:00
<method name= "_is_parameter_read_only" qualifiers= "virtual const" >
<return type= "bool" />
<param index= "0" name= "parameter" type= "StringName" />
<description >
2023-04-30 22:32:18 +08:00
When inheriting from [AnimationRootNode], implement this virtual method to return whether the [param parameter] is read-only. Parameters are custom local memory used for your animation nodes, given a resource can be reused in multiple trees.
2023-01-12 20:51:03 +08:00
</description>
</method>
2021-08-22 09:52:44 +08:00
<method name= "_process" qualifiers= "virtual const" >
<return type= "float" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "time" type= "float" />
<param index= "1" name= "seek" type= "bool" />
2022-11-22 03:30:55 +08:00
<param index= "2" name= "is_external_seeking" type= "bool" />
2023-02-18 10:02:28 +08:00
<param index= "3" name= "test_only" type= "bool" />
2021-05-16 05:48:59 +08:00
<description >
2023-04-30 22:32:18 +08:00
When inheriting from [AnimationRootNode], implement this virtual method to run some code when this animation node is processed. The [param time] parameter is a relative delta, unless [param seek] is [code]true[/code], in which case it is absolute.
2021-05-16 05:48:59 +08:00
Here, call the [method blend_input], [method blend_node] or [method blend_animation] functions. You can also use [method get_parameter] and [method set_parameter] 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).
</description>
</method>
2018-07-26 17:56:21 +08:00
<method name= "add_input" >
2023-01-29 22:54:13 +08:00
<return type= "bool" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "name" type= "String" />
2018-07-26 17:56:21 +08:00
<description >
2023-04-30 22:32:18 +08:00
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 [code]false[/code].
2018-07-26 17:56:21 +08:00
</description>
</method>
<method name= "blend_animation" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "animation" type= "StringName" />
<param index= "1" name= "time" type= "float" />
<param index= "2" name= "delta" type= "float" />
<param index= "3" name= "seeked" type= "bool" />
2022-11-22 03:30:55 +08:00
<param index= "4" name= "is_external_seeking" type= "bool" />
2022-08-07 02:11:48 +08:00
<param index= "5" name= "blend" type= "float" />
2022-11-29 17:51:45 +08:00
<param index= "6" name= "looped_flag" type= "int" enum= "Animation.LoopedFlag" default= "0" />
2018-07-26 17:56:21 +08:00
<description >
2022-08-13 01:51:01 +08:00
Blend an animation by [param blend] amount (name must be valid in the linked [AnimationPlayer]). A [param time] and [param delta] may be passed, as well as whether [param seeked] happened.
2022-11-29 17:51:45 +08:00
A [param looped_flag] is used by internal processing immediately after the loop. See also [enum Animation.LoopedFlag].
2018-07-26 17:56:21 +08:00
</description>
</method>
<method name= "blend_input" >
2021-07-30 21:28:05 +08:00
<return type= "float" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "input_index" type= "int" />
<param index= "1" name= "time" type= "float" />
<param index= "2" name= "seek" type= "bool" />
2022-11-22 03:30:55 +08:00
<param index= "3" name= "is_external_seeking" type= "bool" />
2022-08-07 02:11:48 +08:00
<param index= "4" name= "blend" type= "float" />
<param index= "5" name= "filter" type= "int" enum= "AnimationNode.FilterAction" default= "0" />
<param index= "6" name= "sync" type= "bool" default= "true" />
2023-02-18 10:02:28 +08:00
<param index= "7" name= "test_only" type= "bool" default= "false" />
2018-07-26 17:56:21 +08:00
<description >
2023-04-30 22:32:18 +08:00
Blend an input. This is only useful for animation nodes created for an [AnimationNodeBlendTree]. The [param time] parameter is a relative delta, unless [param seek] is [code]true[/code], in which case it is absolute. A filter mode may be optionally passed (see [enum FilterAction] for options).
2018-07-26 17:56:21 +08:00
</description>
</method>
<method name= "blend_node" >
2021-07-30 21:28:05 +08:00
<return type= "float" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "name" type= "StringName" />
<param index= "1" name= "node" type= "AnimationNode" />
<param index= "2" name= "time" type= "float" />
<param index= "3" name= "seek" type= "bool" />
2022-11-22 03:30:55 +08:00
<param index= "4" name= "is_external_seeking" type= "bool" />
2022-08-07 02:11:48 +08:00
<param index= "5" name= "blend" type= "float" />
<param index= "6" name= "filter" type= "int" enum= "AnimationNode.FilterAction" default= "0" />
<param index= "7" name= "sync" type= "bool" default= "true" />
2023-02-18 10:02:28 +08:00
<param index= "8" name= "test_only" type= "bool" default= "false" />
2018-07-26 17:56:21 +08:00
<description >
2023-04-30 22:32:18 +08:00
Blend another animation node (in case this animation node contains children animation nodes). This function is only useful if you inherit from [AnimationRootNode] instead, else editors will not display your animation node for addition.
2018-07-26 17:56:21 +08:00
</description>
</method>
2023-01-29 22:54:13 +08:00
<method name= "find_input" qualifiers= "const" >
<return type= "int" />
<param index= "0" name= "name" type= "String" />
<description >
Returns the input index which corresponds to [param name]. If not found, returns [code]-1[/code].
</description>
</method>
2018-07-26 17:56:21 +08:00
<method name= "get_input_count" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "int" />
2018-07-26 17:56:21 +08:00
<description >
2023-04-30 22:32:18 +08:00
Amount of inputs in this animation node, only useful for animation nodes that go into [AnimationNodeBlendTree].
2018-07-26 17:56:21 +08:00
</description>
</method>
2023-01-29 22:54:13 +08:00
<method name= "get_input_name" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "String" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "input" type= "int" />
2018-07-26 17:56:21 +08:00
<description >
2019-06-22 07:04:47 +08:00
Gets the name of an input by index.
2018-07-26 17:56:21 +08:00
</description>
</method>
2018-08-21 06:35:30 +08:00
<method name= "get_parameter" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "Variant" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "name" type= "StringName" />
2018-07-26 17:56:21 +08:00
<description >
2023-04-30 22:32:18 +08:00
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.
2018-11-26 03:56:49 +08:00
</description>
</method>
2018-07-26 17:56:21 +08:00
<method name= "is_path_filtered" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "path" type= "NodePath" />
2018-07-26 17:56:21 +08:00
<description >
2022-02-17 23:18:07 +08:00
Returns whether the given path is filtered.
2018-07-26 17:56:21 +08:00
</description>
</method>
<method name= "remove_input" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "index" type= "int" />
2018-07-26 17:56:21 +08:00
<description >
2019-06-22 07:04:47 +08:00
Removes an input, call this only when inactive.
2018-07-26 17:56:21 +08:00
</description>
</method>
<method name= "set_filter_path" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "path" type= "NodePath" />
<param index= "1" name= "enable" type= "bool" />
2018-07-26 17:56:21 +08:00
<description >
2019-06-22 07:04:47 +08:00
Adds or removes a path for the filter.
2018-07-26 17:56:21 +08:00
</description>
</method>
2023-01-29 22:54:13 +08:00
<method name= "set_input_name" >
<return type= "bool" />
<param index= "0" name= "input" type= "int" />
<param index= "1" name= "name" type= "String" />
<description >
Sets the name of the input at the given [param input] index. If the setting fails, returns [code]false[/code].
</description>
</method>
2018-08-21 06:35:30 +08:00
<method name= "set_parameter" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "name" type= "StringName" />
<param index= "1" name= "value" type= "Variant" />
2018-07-26 17:56:21 +08:00
<description >
2022-02-17 23:18:07 +08:00
Sets a custom parameter. These are used as local memory, because resources can be reused across the tree or scenes.
2018-07-26 17:56:21 +08:00
</description>
</method>
</methods>
<members >
<member name= "filter_enabled" type= "bool" setter= "set_filter_enabled" getter= "is_filter_enabled" >
2020-01-02 09:08:19 +08:00
If [code]true[/code], filtering is enabled.
2018-07-26 17:56:21 +08:00
</member>
</members>
<signals >
2023-02-04 23:29:34 +08:00
<signal name= "animation_node_removed" >
<param index= "0" name= "object_id" type= "int" />
<param index= "1" name= "name" type= "String" />
<description >
2023-04-30 22:32:18 +08:00
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].
2023-02-04 23:29:34 +08:00
</description>
</signal>
<signal name= "animation_node_renamed" >
<param index= "0" name= "object_id" type= "int" />
<param index= "1" name= "old_name" type= "String" />
<param index= "2" name= "new_name" type= "String" />
<description >
2023-04-30 22:32:18 +08:00
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].
2023-02-04 23:29:34 +08:00
</description>
</signal>
2018-08-21 06:35:30 +08:00
<signal name= "tree_changed" >
<description >
2023-04-30 22:32:18 +08:00
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].
2018-08-21 06:35:30 +08:00
</description>
</signal>
2018-07-26 17:56:21 +08:00
</signals>
<constants >
<constant name= "FILTER_IGNORE" value= "0" enum= "FilterAction" >
2018-11-26 18:21:06 +08:00
Do not use filtering.
2018-07-26 17:56:21 +08:00
</constant>
<constant name= "FILTER_PASS" value= "1" enum= "FilterAction" >
2018-11-26 18:21:06 +08:00
Paths matching the filter will be allowed to pass.
2018-07-26 17:56:21 +08:00
</constant>
<constant name= "FILTER_STOP" value= "2" enum= "FilterAction" >
2018-11-26 18:21:06 +08:00
Paths matching the filter will be discarded.
2018-07-26 17:56:21 +08:00
</constant>
<constant name= "FILTER_BLEND" value= "3" enum= "FilterAction" >
2018-11-26 18:21:06 +08:00
Paths matching the filter will be blended (by the blend value).
2018-07-26 17:56:21 +08:00
</constant>
</constants>
</class>