diff options
Diffstat (limited to 'doc/classes/AnimationNodeBlendSpace1D.xml')
| -rw-r--r-- | doc/classes/AnimationNodeBlendSpace1D.xml | 24 |
1 files changed, 20 insertions, 4 deletions
diff --git a/doc/classes/AnimationNodeBlendSpace1D.xml b/doc/classes/AnimationNodeBlendSpace1D.xml index b13aee277e..82d5716ee3 100644 --- a/doc/classes/AnimationNodeBlendSpace1D.xml +++ b/doc/classes/AnimationNodeBlendSpace1D.xml @@ -1,8 +1,13 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AnimationNodeBlendSpace1D" inherits="AnimationRootNode" category="Core" version="3.2"> <brief_description> + Blends linearly between two of any number of [AnimationNode] of any type placed on a virtual axis. </brief_description> <description> + A resource to add to an [AnimationNodeBlendTree]. + This is a virtual axis on which you can add any type of [AnimationNode] using [method add_blend_point]. + Outputs the linear blend of the two [code]AnimationNode[/code] closest to the node's current [code]value[/code]. + You can set the extents of the axis using the [member min_space] and [member max_space]. </description> <tutorials> </tutorials> @@ -17,12 +22,14 @@ <argument index="2" name="at_index" type="int" default="-1"> </argument> <description> + Adds a new point that represents a [code]node[/code] on the virtual axis at a given position set by [code]pos[/code]. You can insert it at a specific index using the [code]at_index[/code] argument. If you use the default value for [code]at_index[/code] , the point is inserted at the end of the blend points array. </description> </method> <method name="get_blend_point_count" qualifiers="const"> <return type="int"> </return> <description> + Returns the number of points on the blend axis. </description> </method> <method name="get_blend_point_node" qualifiers="const"> @@ -31,6 +38,7 @@ <argument index="0" name="point" type="int"> </argument> <description> + Returns the [code]AnimationNode[/code] referenced by the point at index [code]point[/code]. </description> </method> <method name="get_blend_point_position" qualifiers="const"> @@ -39,6 +47,7 @@ <argument index="0" name="point" type="int"> </argument> <description> + Returns the position of the point at index [code]point[/code]. </description> </method> <method name="remove_blend_point"> @@ -47,6 +56,7 @@ <argument index="0" name="point" type="int"> </argument> <description> + Removes the point at index [code]point[/code] from the blend axis. </description> </method> <method name="set_blend_point_node"> @@ -57,6 +67,7 @@ <argument index="1" name="node" type="AnimationRootNode"> </argument> <description> + Changes the AnimationNode referenced by the point at index [code]point[/code]. </description> </method> <method name="set_blend_point_position"> @@ -67,17 +78,22 @@ <argument index="1" name="pos" type="float"> </argument> <description> + Updates the position of the point at index [code]point[/code] on the blend axis. </description> </method> </methods> <members> - <member name="max_space" type="float" setter="set_max_space" getter="get_max_space"> + <member name="max_space" type="float" setter="set_max_space" getter="get_max_space" default="1.0"> + The blend space's axis's upper limit for the points' position. See [method add_blend_point]. </member> - <member name="min_space" type="float" setter="set_min_space" getter="get_min_space"> + <member name="min_space" type="float" setter="set_min_space" getter="get_min_space" default="-1.0"> + The blend space's axis's lower limit for the points' position. See [method add_blend_point]. </member> - <member name="snap" type="float" setter="set_snap" getter="get_snap"> + <member name="snap" type="float" setter="set_snap" getter="get_snap" default="0.1"> + Position increment to snap to when moving a point on the axis. </member> - <member name="value_label" type="String" setter="set_value_label" getter="get_value_label"> + <member name="value_label" type="String" setter="set_value_label" getter="get_value_label" default=""value""> + Label of the virtual axis of the blend space. </member> </members> <constants> |