2018-07-26 17:56:21 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2022-02-14 21:18:53 +08:00
<class name= "AnimationNode" inherits= "Resource" version= "4.0" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2018-07-26 17:56:21 +08:00
<brief_description >
2018-11-26 18:21:06 +08:00
Base resource for [AnimationTree] 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.
2021-12-15 22:26:54 +08:00
Inherit this when creating nodes mainly for use in [AnimationNodeBlendTree], otherwise [AnimationRootNode] should be used instead.
2018-07-26 17:56:21 +08:00
</description>
<tutorials >
2021-11-15 17:43:07 +08:00
<link title= "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 >
Gets the text caption for this node (used by some editors).
</description>
</method>
2021-08-22 09:52:44 +08:00
<method name= "_get_child_by_name" qualifiers= "virtual const" >
<return type= "AnimationNode" />
<argument index= "0" name= "name" type= "StringName" />
2021-05-16 05:48:59 +08:00
<description >
Gets a child node by index (used by editors inheriting from [AnimationRootNode]).
</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 >
Gets all children nodes in order as a [code]name: node[/code] dictionary. Only useful when inheriting [AnimationRootNode].
</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" />
2021-08-22 09:52:44 +08:00
<argument index= "0" name= "parameter" type= "StringName" />
2021-05-16 05:48:59 +08:00
<description >
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.
</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 >
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 [method Object.get_property_list].
</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 >
2022-02-17 23:18:07 +08:00
Returns whether you want the blend tree editor to display filter editing on this node.
2021-05-16 05:48:59 +08:00
</description>
</method>
2021-08-22 09:52:44 +08:00
<method name= "_process" qualifiers= "virtual const" >
<return type= "float" />
2021-07-30 21:28:05 +08:00
<argument index= "0" name= "time" type= "float" />
<argument index= "1" name= "seek" type= "bool" />
2021-05-16 05:48:59 +08:00
<description >
User-defined callback called when a custom node is processed. The [code]time[/code] parameter is a relative delta, unless [code]seek[/code] is [code]true[/code], in which case it is absolute.
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" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "name" type= "String" />
2018-07-26 17:56:21 +08:00
<description >
2020-01-23 18:14:14 +08:00
Adds an input to the node. This is only useful for nodes created for use in an [AnimationNodeBlendTree].
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" />
<argument index= "0" name= "animation" type= "StringName" />
<argument index= "1" name= "time" type= "float" />
<argument index= "2" name= "delta" type= "float" />
<argument index= "3" name= "seeked" type= "bool" />
<argument index= "4" name= "blend" type= "float" />
2021-10-15 21:25:00 +08:00
<argument index= "5" name= "pingponged" type= "int" default= "0" />
2018-07-26 17:56:21 +08:00
<description >
2020-01-23 18:14:14 +08:00
Blend an animation by [code]blend[/code] amount (name must be valid in the linked [AnimationPlayer]). A [code]time[/code] and [code]delta[/code] may be passed, as well as whether [code]seek[/code] happened.
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" />
<argument index= "0" name= "input_index" type= "int" />
<argument index= "1" name= "time" type= "float" />
<argument index= "2" name= "seek" type= "bool" />
<argument index= "3" name= "blend" type= "float" />
<argument index= "4" name= "filter" type= "int" enum= "AnimationNode.FilterAction" default= "0" />
<argument index= "5" name= "optimize" type= "bool" default= "true" />
2018-07-26 17:56:21 +08:00
<description >
2020-01-23 18:14:14 +08:00
Blend an input. This is only useful for nodes created for an [AnimationNodeBlendTree]. The [code]time[/code] parameter is a relative delta, unless [code]seek[/code] 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" />
<argument index= "0" name= "name" type= "StringName" />
<argument index= "1" name= "node" type= "AnimationNode" />
<argument index= "2" name= "time" type= "float" />
<argument index= "3" name= "seek" type= "bool" />
<argument index= "4" name= "blend" type= "float" />
<argument index= "5" name= "filter" type= "int" enum= "AnimationNode.FilterAction" default= "0" />
<argument index= "6" name= "optimize" type= "bool" default= "true" />
2018-07-26 17:56:21 +08:00
<description >
Fix misc. source comment typos
Found using `codespell -q 3 -S ./thirdparty,*.po -L ang,ba,cas,dof,doubleclick,fave,hist,leapyear,lod,nd,numer,ois,paket,seeked,sinc,switchs,te,uint -D ~/Projects/codespell/codespell_lib/data/dictionary.txt `
2019-09-20 02:36:39 +08:00
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.
2018-07-26 17:56:21 +08:00
</description>
</method>
<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 >
2019-01-07 17:02:04 +08:00
Amount of inputs in this node, only useful for nodes that go into [AnimationNodeBlendTree].
2018-07-26 17:56:21 +08:00
</description>
</method>
<method name= "get_input_name" >
2021-07-30 21:28:05 +08:00
<return type= "String" />
<argument 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" />
<argument index= "0" name= "name" type= "StringName" />
2018-07-26 17:56:21 +08:00
<description >
2019-06-22 07:04:47 +08:00
Gets the value of a parameter. Parameters are custom local memory used for your 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" />
<argument 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" />
<argument 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" />
<argument index= "0" name= "path" type= "NodePath" />
<argument 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>
2018-08-21 06:35:30 +08:00
<method name= "set_parameter" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "name" type= "StringName" />
<argument 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 >
<signal name= "removed_from_graph" >
<description >
2022-02-17 23:18:07 +08:00
Emitted when the node was removed from the graph.
2018-07-26 17:56:21 +08:00
</description>
</signal>
2018-08-21 06:35:30 +08:00
<signal name= "tree_changed" >
<description >
2019-06-04 08:01:24 +08:00
Emitted by nodes that inherit from this class and that have an internal tree when one of their nodes changes. The nodes that emit this signal are [AnimationNodeBlendSpace1D], [AnimationNodeBlendSpace2D], [AnimationNodeStateMachine], and [AnimationNodeBlendTree].
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>