summaryrefslogtreecommitdiff
path: root/doc/classes/AnimationNodeStateMachinePlayback.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/AnimationNodeStateMachinePlayback.xml')
-rw-r--r--doc/classes/AnimationNodeStateMachinePlayback.xml14
1 files changed, 8 insertions, 6 deletions
diff --git a/doc/classes/AnimationNodeStateMachinePlayback.xml b/doc/classes/AnimationNodeStateMachinePlayback.xml
index 09cd369bc4..f4b89a5086 100644
--- a/doc/classes/AnimationNodeStateMachinePlayback.xml
+++ b/doc/classes/AnimationNodeStateMachinePlayback.xml
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8" ?>
-<class name="AnimationNodeStateMachinePlayback" inherits="Resource" category="Core" version="3.2">
+<class name="AnimationNodeStateMachinePlayback" inherits="Resource" version="4.0">
<brief_description>
- Playback control for AnimationNodeStateMachine.
+ Playback control for [AnimationNodeStateMachine].
</brief_description>
<description>
Allows control of [AnimationTree] state machines created with [AnimationNodeStateMachine]. Retrieve with [code]$AnimationTree.get("parameters/playback")[/code].
@@ -12,19 +12,21 @@
[/codeblock]
</description>
<tutorials>
+ <link>https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html</link>
</tutorials>
<methods>
<method name="get_current_node" qualifiers="const">
- <return type="String">
+ <return type="StringName">
</return>
<description>
Returns the currently playing animation state.
</description>
</method>
<method name="get_travel_path" qualifiers="const">
- <return type="PoolStringArray">
+ <return type="PackedStringArray">
</return>
<description>
+ Returns the current travel path as computed internally by the A* algorithm.
</description>
</method>
<method name="is_playing" qualifiers="const">
@@ -37,7 +39,7 @@
<method name="start">
<return type="void">
</return>
- <argument index="0" name="node" type="String">
+ <argument index="0" name="node" type="StringName">
</argument>
<description>
Starts playing the given animation.
@@ -53,7 +55,7 @@
<method name="travel">
<return type="void">
</return>
- <argument index="0" name="to_node" type="String">
+ <argument index="0" name="to_node" type="StringName">
</argument>
<description>
Transitions from the current state to another one, following the shortest path.