Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 33 additions & 1 deletion doc/classes/AnimationNodeBlendSpace1D.xml
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,17 @@
<param index="0" name="node" type="AnimationRootNode" />
<param index="1" name="pos" type="float" />
<param index="2" name="at_index" type="int" default="-1" />
<param index="3" name="name" type="StringName" default="&amp;&quot;&quot;" />
<description>
Adds a new point that represents a [param node] on the virtual axis at a given position set by [param pos]. You can insert it at a specific index using the [param at_index] argument. If you use the default value for [param at_index], the point is inserted at the end of the blend points array.
Adds a new point with [param name] that represents a [param node] on the virtual axis at a given position set by [param pos]. You can insert it at a specific index using the [param at_index] argument. If you use the default value for [param at_index], the point is inserted at the end of the blend points array.
Comment thread
vaner-org marked this conversation as resolved.
[b]Note:[/b] If no name is provided, safe index is used as reference. In the future, empty names will be deprecated, so explicitly passing a name is recommended.
</description>
</method>
<method name="find_blend_point_by_name" qualifiers="const">
<return type="int" />
<param index="0" name="name" type="StringName" />
<description>
Returns the index of the blend point with the given [param name]. Returns [code]-1[/code] if no blend point with that name is found.
</description>
</method>
<method name="get_blend_point_count" qualifiers="const">
Expand All @@ -27,6 +36,13 @@
Returns the number of points on the blend axis.
</description>
</method>
<method name="get_blend_point_name" qualifiers="const">
<return type="StringName" />
<param index="0" name="point" type="int" />
<description>
Returns the name of the blend point at index [param point].
</description>
</method>
<method name="get_blend_point_node" qualifiers="const">
<return type="AnimationRootNode" />
<param index="0" name="point" type="int" />
Expand All @@ -48,6 +64,22 @@
Removes the point at index [param point] from the blend axis.
</description>
</method>
<method name="reorder_blend_point">
<return type="void" />
<param index="0" name="from_index" type="int" />
<param index="1" name="to_index" type="int" />
<description>
Swaps the blend points at indices [param from_index] and [param to_index], exchanging their positions and properties.
</description>
</method>
<method name="set_blend_point_name">
<return type="void" />
<param index="0" name="point" type="int" />
<param index="1" name="name" type="StringName" />
<description>
Sets the name of the blend point at index [param point]. If the name conflicts with an existing point, a unique name will be generated automatically.
</description>
</method>
<method name="set_blend_point_node">
<return type="void" />
<param index="0" name="point" type="int" />
Expand Down
34 changes: 33 additions & 1 deletion doc/classes/AnimationNodeBlendSpace2D.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,10 @@
<param index="0" name="node" type="AnimationRootNode" />
<param index="1" name="pos" type="Vector2" />
<param index="2" name="at_index" type="int" default="-1" />
<param index="3" name="name" type="StringName" default="&amp;&quot;&quot;" />
<description>
Adds a new point that represents a [param node] at the position set by [param pos]. You can insert it at a specific index using the [param at_index] argument. If you use the default value for [param at_index], the point is inserted at the end of the blend points array.
Adds a new point with [param name] that represents a [param node] at the position set by [param pos]. You can insert it at a specific index using the [param at_index] argument. If you use the default value for [param at_index], the point is inserted at the end of the blend points array.
[b]Note:[/b] If no name is provided, safe index is used as reference. In the future, empty names will be deprecated, so explicitly passing a name is recommended.
</description>
</method>
<method name="add_triangle">
Expand All @@ -32,12 +34,26 @@
Creates a new triangle using three points [param x], [param y], and [param z]. Triangles can overlap. You can insert the triangle at a specific index using the [param at_index] argument. If you use the default value for [param at_index], the point is inserted at the end of the blend points array.
</description>
</method>
<method name="find_blend_point_by_name" qualifiers="const">
<return type="int" />
<param index="0" name="name" type="StringName" />
<description>
Returns the index of the blend point with the given [param name]. Returns [code]-1[/code] if no blend point with that name is found.
</description>
</method>
<method name="get_blend_point_count" qualifiers="const">
<return type="int" />
<description>
Returns the number of points in the blend space.
</description>
</method>
<method name="get_blend_point_name" qualifiers="const">
<return type="StringName" />
<param index="0" name="point" type="int" />
<description>
Returns the name of the blend point at index [param point].
</description>
</method>
<method name="get_blend_point_node" qualifiers="const">
<return type="AnimationRootNode" />
<param index="0" name="point" type="int" />
Expand Down Expand Up @@ -80,6 +96,22 @@
Removes the triangle at index [param triangle] from the blend space.
</description>
</method>
<method name="reorder_blend_point">
<return type="void" />
<param index="0" name="from_index" type="int" />
<param index="1" name="to_index" type="int" />
<description>
Swaps the blend points at indices [param from_index] and [param to_index], exchanging their positions and properties.
</description>
</method>
<method name="set_blend_point_name">
<return type="void" />
<param index="0" name="point" type="int" />
<param index="1" name="name" type="StringName" />
<description>
Sets the name of the blend point at index [param point]. If the name conflicts with an existing point, a unique name will be generated automatically.
</description>
</method>
<method name="set_blend_point_node">
<return type="void" />
<param index="0" name="point" type="int" />
Expand Down
Loading