|
@@ -5,7 +5,7 @@
|
|
|
</brief_description>
|
|
|
<description>
|
|
|
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.
|
|
|
+ Inherit this when creating animation nodes mainly for use in [AnimationNodeBlendTree], otherwise [AnimationRootNode] should be used instead.
|
|
|
</description>
|
|
|
<tutorials>
|
|
|
<link title="Using AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link>
|
|
@@ -14,46 +14,46 @@
|
|
|
<method name="_get_caption" qualifiers="virtual const">
|
|
|
<return type="String" />
|
|
|
<description>
|
|
|
- When inheriting from [AnimationRootNode], implement this virtual method to override the text caption for this node.
|
|
|
+ When inheriting from [AnimationRootNode], implement this virtual method to override the text caption for this animation node.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="_get_child_by_name" qualifiers="virtual const">
|
|
|
<return type="AnimationNode" />
|
|
|
<param index="0" name="name" type="StringName" />
|
|
|
<description>
|
|
|
- When inheriting from [AnimationRootNode], implement this virtual method to return a child node by its [param name].
|
|
|
+ When inheriting from [AnimationRootNode], implement this virtual method to return a child animation node by its [param name].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="_get_child_nodes" qualifiers="virtual const">
|
|
|
<return type="Dictionary" />
|
|
|
<description>
|
|
|
- When inheriting from [AnimationRootNode], implement this virtual method to return all children nodes in order as a [code]name: node[/code] dictionary.
|
|
|
+ When inheriting from [AnimationRootNode], implement this virtual method to return all children animation nodes in order as a [code]name: node[/code] dictionary.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="_get_parameter_default_value" qualifiers="virtual const">
|
|
|
<return type="Variant" />
|
|
|
<param index="0" name="parameter" type="StringName" />
|
|
|
<description>
|
|
|
- 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 nodes, given a resource can be reused in multiple trees.
|
|
|
+ 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.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="_get_parameter_list" qualifiers="virtual const">
|
|
|
<return type="Array" />
|
|
|
<description>
|
|
|
- When inheriting from [AnimationRootNode], implement this virtual method to return a list of the properties on this node. 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].
|
|
|
+ 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].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="_has_filter" qualifiers="virtual const">
|
|
|
<return type="bool" />
|
|
|
<description>
|
|
|
- When inheriting from [AnimationRootNode], implement this virtual method to return whether the blend tree editor should display filter editing on this node.
|
|
|
+ When inheriting from [AnimationRootNode], implement this virtual method to return whether the blend tree editor should display filter editing on this animation node.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="_is_parameter_read_only" qualifiers="virtual const">
|
|
|
<return type="bool" />
|
|
|
<param index="0" name="parameter" type="StringName" />
|
|
|
<description>
|
|
|
- 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 nodes, given a resource can be reused in multiple trees.
|
|
|
+ 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.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="_process" qualifiers="virtual const">
|
|
@@ -63,7 +63,7 @@
|
|
|
<param index="2" name="is_external_seeking" type="bool" />
|
|
|
<param index="3" name="test_only" type="bool" />
|
|
|
<description>
|
|
|
- When inheriting from [AnimationRootNode], implement this virtual method to run some code when this node is processed. The [param time] parameter is a relative delta, unless [param seek] is [code]true[/code], in which case it is absolute.
|
|
|
+ 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.
|
|
|
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>
|
|
@@ -72,7 +72,7 @@
|
|
|
<return type="bool" />
|
|
|
<param index="0" name="name" type="String" />
|
|
|
<description>
|
|
|
- Adds an input to the node. This is only useful for nodes created for use in an [AnimationNodeBlendTree]. If the addition fails, returns [code]false[/code].
|
|
|
+ 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].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="blend_animation">
|
|
@@ -100,7 +100,7 @@
|
|
|
<param index="6" name="sync" type="bool" default="true" />
|
|
|
<param index="7" name="test_only" type="bool" default="false" />
|
|
|
<description>
|
|
|
- Blend an input. This is only useful for 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).
|
|
|
+ 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).
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="blend_node">
|
|
@@ -115,7 +115,7 @@
|
|
|
<param index="7" name="sync" type="bool" default="true" />
|
|
|
<param index="8" name="test_only" type="bool" default="false" />
|
|
|
<description>
|
|
|
- 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.
|
|
|
+ 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.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="find_input" qualifiers="const">
|
|
@@ -128,7 +128,7 @@
|
|
|
<method name="get_input_count" qualifiers="const">
|
|
|
<return type="int" />
|
|
|
<description>
|
|
|
- Amount of inputs in this node, only useful for nodes that go into [AnimationNodeBlendTree].
|
|
|
+ Amount of inputs in this animation node, only useful for animation nodes that go into [AnimationNodeBlendTree].
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="get_input_name" qualifiers="const">
|
|
@@ -142,7 +142,7 @@
|
|
|
<return type="Variant" />
|
|
|
<param index="0" name="name" type="StringName" />
|
|
|
<description>
|
|
|
- Gets the value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees.
|
|
|
+ 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.
|
|
|
</description>
|
|
|
</method>
|
|
|
<method name="is_path_filtered" qualifiers="const">
|
|
@@ -194,7 +194,7 @@
|
|
|
<param index="0" name="object_id" type="int" />
|
|
|
<param index="1" name="name" type="String" />
|
|
|
<description>
|
|
|
- Emitted by nodes that inherit from this class and that have an internal tree when one of their nodes removes. The nodes that emit this signal are [AnimationNodeBlendSpace1D], [AnimationNodeBlendSpace2D], [AnimationNodeStateMachine], and [AnimationNodeBlendTree].
|
|
|
+ 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].
|
|
|
</description>
|
|
|
</signal>
|
|
|
<signal name="animation_node_renamed">
|
|
@@ -202,12 +202,12 @@
|
|
|
<param index="1" name="old_name" type="String" />
|
|
|
<param index="2" name="new_name" type="String" />
|
|
|
<description>
|
|
|
- Emitted by nodes that inherit from this class and that have an internal tree when one of their node names changes. The nodes that emit this signal are [AnimationNodeBlendSpace1D], [AnimationNodeBlendSpace2D], [AnimationNodeStateMachine], and [AnimationNodeBlendTree].
|
|
|
+ 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].
|
|
|
</description>
|
|
|
</signal>
|
|
|
<signal name="tree_changed">
|
|
|
<description>
|
|
|
- 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], [AnimationNodeBlendTree] and [AnimationNodeTransition].
|
|
|
+ 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].
|
|
|
</description>
|
|
|
</signal>
|
|
|
</signals>
|