584288a32c
The API docs for various animation nodes are pretty empty, yet the tutorial at https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html contains some details. These details should be included in the API docs so looking up a particular class actually provides some information rather than requiring the user to hunt for a different tutorial. This also links the AnimationTree tutorial and demo in the docs. I've found the TPS demo to be the best resource so far for learning how to use the AnimationTree. This should be easy to find if someone looks up the AnimationTree API docs. Finally, this fixes a param typo in AnimationNodeStateMachine.
145 lines
4 KiB
XML
145 lines
4 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="AnimationNodeBlendSpace2D" inherits="AnimationRootNode" category="Core" version="3.2">
|
|
<brief_description>
|
|
</brief_description>
|
|
<description>
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<demos>
|
|
</demos>
|
|
<methods>
|
|
<method name="add_blend_point">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="node" type="AnimationRootNode">
|
|
</argument>
|
|
<argument index="1" name="pos" type="Vector2">
|
|
</argument>
|
|
<argument index="2" name="at_index" type="int" default="-1">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="add_triangle">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="x" type="int">
|
|
</argument>
|
|
<argument index="1" name="y" type="int">
|
|
</argument>
|
|
<argument index="2" name="z" type="int">
|
|
</argument>
|
|
<argument index="3" name="at_index" type="int" default="-1">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="get_blend_point_count" qualifiers="const">
|
|
<return type="int">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="get_blend_point_node" qualifiers="const">
|
|
<return type="AnimationRootNode">
|
|
</return>
|
|
<argument index="0" name="point" type="int">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="get_blend_point_position" qualifiers="const">
|
|
<return type="Vector2">
|
|
</return>
|
|
<argument index="0" name="point" type="int">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="get_triangle_count" qualifiers="const">
|
|
<return type="int">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="get_triangle_point">
|
|
<return type="int">
|
|
</return>
|
|
<argument index="0" name="triangle" type="int">
|
|
</argument>
|
|
<argument index="1" name="point" type="int">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="remove_blend_point">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="point" type="int">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="remove_triangle">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="triangle" type="int">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="set_blend_point_node">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="point" type="int">
|
|
</argument>
|
|
<argument index="1" name="node" type="AnimationRootNode">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="set_blend_point_position">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="point" type="int">
|
|
</argument>
|
|
<argument index="1" name="pos" type="Vector2">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="auto_triangles" type="bool" setter="set_auto_triangles" getter="get_auto_triangles">
|
|
</member>
|
|
<member name="blend_mode" type="int" setter="set_blend_mode" getter="get_blend_mode" enum="AnimationNodeBlendSpace2D.BlendMode">
|
|
</member>
|
|
<member name="max_space" type="Vector2" setter="set_max_space" getter="get_max_space">
|
|
</member>
|
|
<member name="min_space" type="Vector2" setter="set_min_space" getter="get_min_space">
|
|
</member>
|
|
<member name="snap" type="Vector2" setter="set_snap" getter="get_snap">
|
|
</member>
|
|
<member name="x_label" type="String" setter="set_x_label" getter="get_x_label">
|
|
</member>
|
|
<member name="y_label" type="String" setter="set_y_label" getter="get_y_label">
|
|
</member>
|
|
</members>
|
|
<signals>
|
|
<signal name="triangles_updated">
|
|
<description>
|
|
</description>
|
|
</signal>
|
|
</signals>
|
|
<constants>
|
|
<constant name="BLEND_MODE_INTERPOLATED" value="0" enum="BlendMode">
|
|
</constant>
|
|
<constant name="BLEND_MODE_DISCRETE" value="1" enum="BlendMode">
|
|
Useful for frame-by-frame 2D animations.
|
|
</constant>
|
|
<constant name="BLEND_MODE_DISCRETE_CARRY" value="2" enum="BlendMode">
|
|
Keep the current play position when switching between discrete animations.
|
|
</constant>
|
|
</constants>
|
|
</class>
|