summaryrefslogtreecommitdiff
path: root/doc/classes/AnimationNode.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/AnimationNode.xml')
-rw-r--r--doc/classes/AnimationNode.xml147
1 files changed, 49 insertions, 98 deletions
diff --git a/doc/classes/AnimationNode.xml b/doc/classes/AnimationNode.xml
index fddd8989ab..a9a08efcf1 100644
--- a/doc/classes/AnimationNode.xml
+++ b/doc/classes/AnimationNode.xml
@@ -12,58 +12,47 @@
</tutorials>
<methods>
<method name="_get_caption" qualifiers="virtual">
- <return type="String">
- </return>
+ <return type="String" />
<description>
Gets the text caption for this node (used by some editors).
</description>
</method>
<method name="_get_child_by_name" qualifiers="virtual">
- <return type="Object">
- </return>
- <argument index="0" name="name" type="String">
- </argument>
+ <return type="Object" />
+ <argument index="0" name="name" type="String" />
<description>
Gets a child node by index (used by editors inheriting from [AnimationRootNode]).
</description>
</method>
<method name="_get_child_nodes" qualifiers="virtual">
- <return type="Dictionary">
- </return>
+ <return type="Dictionary" />
<description>
Gets all children nodes in order as a [code]name: node[/code] dictionary. Only useful when inheriting [AnimationRootNode].
</description>
</method>
<method name="_get_parameter_default_value" qualifiers="virtual">
- <return type="Variant">
- </return>
- <argument index="0" name="name" type="StringName">
- </argument>
+ <return type="Variant" />
+ <argument index="0" name="name" type="StringName" />
<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>
<method name="_get_parameter_list" qualifiers="virtual">
- <return type="Array">
- </return>
+ <return type="Array" />
<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>
<method name="_has_filter" qualifiers="virtual">
- <return type="bool">
- </return>
+ <return type="bool" />
<description>
Returns [code]true[/code] whether you want the blend tree editor to display filter editing on this node.
</description>
</method>
<method name="_process" qualifiers="virtual">
- <return type="void">
- </return>
- <argument index="0" name="time" type="float">
- </argument>
- <argument index="1" name="seek" type="bool">
- </argument>
+ <return type="void" />
+ <argument index="0" name="time" type="float" />
+ <argument index="1" name="seek" type="bool" />
<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.
@@ -71,132 +60,94 @@
</description>
</method>
<method name="add_input">
- <return type="void">
- </return>
- <argument index="0" name="name" type="String">
- </argument>
+ <return type="void" />
+ <argument 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].
</description>
</method>
<method name="blend_animation">
- <return type="void">
- </return>
- <argument index="0" name="animation" type="StringName">
- </argument>
- <argument index="1" name="time" type="float">
- </argument>
- <argument index="2" name="delta" type="float">
- </argument>
- <argument index="3" name="seeked" type="bool">
- </argument>
- <argument index="4" name="blend" type="float">
- </argument>
+ <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" />
<description>
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.
</description>
</method>
<method name="blend_input">
- <return type="float">
- </return>
- <argument index="0" name="input_index" type="int">
- </argument>
- <argument index="1" name="time" type="float">
- </argument>
- <argument index="2" name="seek" type="bool">
- </argument>
- <argument index="3" name="blend" type="float">
- </argument>
- <argument index="4" name="filter" type="int" enum="AnimationNode.FilterAction" default="0">
- </argument>
- <argument index="5" name="optimize" type="bool" default="true">
- </argument>
+ <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" />
<description>
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).
</description>
</method>
<method name="blend_node">
- <return type="float">
- </return>
- <argument index="0" name="name" type="StringName">
- </argument>
- <argument index="1" name="node" type="AnimationNode">
- </argument>
- <argument index="2" name="time" type="float">
- </argument>
- <argument index="3" name="seek" type="bool">
- </argument>
- <argument index="4" name="blend" type="float">
- </argument>
- <argument index="5" name="filter" type="int" enum="AnimationNode.FilterAction" default="0">
- </argument>
- <argument index="6" name="optimize" type="bool" default="true">
- </argument>
+ <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" />
<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.
</description>
</method>
<method name="get_input_count" qualifiers="const">
- <return type="int">
- </return>
+ <return type="int" />
<description>
Amount of inputs in this node, only useful for nodes that go into [AnimationNodeBlendTree].
</description>
</method>
<method name="get_input_name">
- <return type="String">
- </return>
- <argument index="0" name="input" type="int">
- </argument>
+ <return type="String" />
+ <argument index="0" name="input" type="int" />
<description>
Gets the name of an input by index.
</description>
</method>
<method name="get_parameter" qualifiers="const">
- <return type="Variant">
- </return>
- <argument index="0" name="name" type="StringName">
- </argument>
+ <return type="Variant" />
+ <argument 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.
</description>
</method>
<method name="is_path_filtered" qualifiers="const">
- <return type="bool">
- </return>
- <argument index="0" name="path" type="NodePath">
- </argument>
+ <return type="bool" />
+ <argument index="0" name="path" type="NodePath" />
<description>
Returns [code]true[/code] whether a given path is filtered.
</description>
</method>
<method name="remove_input">
- <return type="void">
- </return>
- <argument index="0" name="index" type="int">
- </argument>
+ <return type="void" />
+ <argument index="0" name="index" type="int" />
<description>
Removes an input, call this only when inactive.
</description>
</method>
<method name="set_filter_path">
- <return type="void">
- </return>
- <argument index="0" name="path" type="NodePath">
- </argument>
- <argument index="1" name="enable" type="bool">
- </argument>
+ <return type="void" />
+ <argument index="0" name="path" type="NodePath" />
+ <argument index="1" name="enable" type="bool" />
<description>
Adds or removes a path for the filter.
</description>
</method>
<method name="set_parameter">
- <return type="void">
- </return>
- <argument index="0" name="name" type="StringName">
- </argument>
- <argument index="1" name="value" type="Variant">
- </argument>
+ <return type="void" />
+ <argument index="0" name="name" type="StringName" />
+ <argument index="1" name="value" type="Variant" />
<description>
Sets a custom parameter. These are used as local storage, because resources can be reused across the tree or scenes.
</description>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-20 04:35:23 +0000