Merge pull request #29055 from cbscribe/kcc_docs_animstate

[DOCS] Add descriptions to AnimationNodeStateMachine[Playback]

2 files changed, 37 insertions, 4 deletions

diff --git a/doc/classes/AnimationNodeStateMachine.xml b/doc/classes/AnimationNodeStateMachine.xml
index 8f4e6dff69..2834f83d2f 100644
--- a/doc/classes/AnimationNodeStateMachine.xml
+++ b/doc/classes/AnimationNodeStateMachine.xml
@@ -1,12 +1,13 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="AnimationNodeStateMachine" inherits="AnimationRootNode" category="Core" version="3.2">
 	<brief_description>
+		State machine for control of animations.
 	</brief_description>
 	<description>
-		Contains multiple root nodes as children in a graph. Each node is used as a state, and provides multiple functions to alternate between states. Retrieve the AnimationNodeStateMachinePlayback object from the [AnimationTree] node to control it programmatically.
+		Contains multiple nodes representing animation states, connected in a graph. Nodes transitions can be configured to happen automatically or via code, using a shortest-path algorithm. Retrieve the AnimationNodeStateMachinePlayback object from the [AnimationTree] node to control it programatically. Example:
 		[codeblock]
-		var state_machine = anim_tree["parameters/StateMachine/playback"]
-		state_machine.travel("SomeState")
+		var state_machine = $AnimationTree.get("parameters/playback")
+		state_machine.travel("some_state")
 		[/codeblock]
 	</description>
 	<tutorials>
@@ -22,6 +23,7 @@
 			<argument index="2" name="position" type="Vector2" default="Vector2( 0, 0 )">
 			</argument>
 			<description>
+				Adds a new node to the graph. The [code]position[/code] is used for display in the editor.
 			</description>
 		</method>
 		<method name="add_transition">
@@ -34,18 +36,21 @@
 			<argument index="2" name="transition" type="AnimationNodeStateMachineTransition">
 			</argument>
 			<description>
+				Adds a transition between the given nodes.
 			</description>
 		</method>
 		<method name="get_end_node" qualifiers="const">
 			<return type="String">
 			</return>
 			<description>
+				Returns the graph's end node.
 			</description>
 		</method>
 		<method name="get_graph_offset" qualifiers="const">
 			<return type="Vector2">
 			</return>
 			<description>
+				Returns the draw offset of the graph. Used for display in the editor.
 			</description>
 		</method>
 		<method name="get_node" qualifiers="const">
@@ -54,6 +59,7 @@
 			<argument index="0" name="name" type="String">
 			</argument>
 			<description>
+				Returns the animation node with the given name.
 			</description>
 		</method>
 		<method name="get_node_name" qualifiers="const">
@@ -62,6 +68,7 @@
 			<argument index="0" name="node" type="AnimationNode">
 			</argument>
 			<description>
+				Returns the given animation node's name.
 			</description>
 		</method>
 		<method name="get_node_position" qualifiers="const">
@@ -70,12 +77,14 @@
 			<argument index="0" name="name" type="String">
 			</argument>
 			<description>
+				Returns the given node's coordinates. Used for display in the editor.
 			</description>
 		</method>
 		<method name="get_start_node" qualifiers="const">
 			<return type="String">
 			</return>
 			<description>
+				Returns the graph's end node.
 			</description>
 		</method>
 		<method name="get_transition" qualifiers="const">
@@ -84,12 +93,14 @@
 			<argument index="0" name="idx" type="int">
 			</argument>
 			<description>
+				Returns the given transition.
 			</description>
 		</method>
 		<method name="get_transition_count" qualifiers="const">
 			<return type="int">
 			</return>
 			<description>
+				Returns the number of connections in the graph.
 			</description>
 		</method>
 		<method name="get_transition_from" qualifiers="const">
@@ -98,6 +109,7 @@
 			<argument index="0" name="idx" type="int">
 			</argument>
 			<description>
+				Returns the given transition's start node.
 			</description>
 		</method>
 		<method name="get_transition_to" qualifiers="const">
@@ -106,6 +118,7 @@
 			<argument index="0" name="idx" type="int">
 			</argument>
 			<description>
+				Returns the given transition's end node.
 			</description>
 		</method>
 		<method name="has_node" qualifiers="const">
@@ -114,6 +127,7 @@
 			<argument index="0" name="name" type="String">
 			</argument>
 			<description>
+				Returns [code]true[/code] if the graph contains the given node.
 			</description>
 		</method>
 		<method name="has_transition" qualifiers="const">
@@ -124,6 +138,7 @@
 			<argument index="1" name="to" type="String">
 			</argument>
 			<description>
+				Returns [code]true[/code] if there is a transition between the given nodes.
 			</description>
 		</method>
 		<method name="remove_node">
@@ -132,6 +147,7 @@
 			<argument index="0" name="name" type="String">
 			</argument>
 			<description>
+				Deletes the given node from the graph.
 			</description>
 		</method>
 		<method name="remove_transition">
@@ -142,6 +158,7 @@
 			<argument index="1" name="to" type="String">
 			</argument>
 			<description>
+				Deletes the given transition.
 			</description>
 		</method>
 		<method name="remove_transition_by_index">
@@ -150,6 +167,7 @@
 			<argument index="0" name="idx" type="int">
 			</argument>
 			<description>
+				Deletes the given transition.
 			</description>
 		</method>
 		<method name="rename_node">
@@ -160,6 +178,7 @@
 			<argument index="1" name="new_name" type="String">
 			</argument>
 			<description>
+				Renames the given node.
 			</description>
 		</method>
 		<method name="set_end_node">
@@ -168,6 +187,7 @@
 			<argument index="0" name="name" type="String">
 			</argument>
 			<description>
+				Sets the given node as the graph end point.
 			</description>
 		</method>
 		<method name="set_graph_offset">
@@ -176,6 +196,7 @@
 			<argument index="0" name="offset" type="Vector2">
 			</argument>
 			<description>
+				Sets the draw offset of the graph. Used for display in the editor.
 			</description>
 		</method>
 		<method name="set_node_position">
@@ -186,6 +207,7 @@
 			<argument index="1" name="position" type="Vector2">
 			</argument>
 			<description>
+				Sets the node's coordinates. Used for display in the editor.
 			</description>
 		</method>
 		<method name="set_start_node">
@@ -194,6 +216,7 @@
 			<argument index="0" name="name" type="String">
 			</argument>
 			<description>
+				Sets the given node as the graph start point.
 			</description>
 		</method>
 	</methods>
diff --git a/doc/classes/AnimationNodeStateMachinePlayback.xml b/doc/classes/AnimationNodeStateMachinePlayback.xml
index fd38c28b16..796d92d7d6 100644
--- a/doc/classes/AnimationNodeStateMachinePlayback.xml
+++ b/doc/classes/AnimationNodeStateMachinePlayback.xml
@@ -1,8 +1,14 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="AnimationNodeStateMachinePlayback" inherits="Resource" category="Core" version="3.2">
 	<brief_description>
+		Playback control for AnimationNodeStateMachine.
 	</brief_description>
 	<description>
+		Allows control of [AnimationTree] state machines created with [AnimationNodeStateMachine]. Retrieve with [code]$AnimationTree.get("parameters/playback")[/code]. Example:
+		[codeblock]
+		var state_machine = $AnimationTree.get("parameters/playback")
+		state_machine.travel("some_state")
+		[/codeblock]
 	</description>
 	<tutorials>
 	</tutorials>
@@ -11,6 +17,7 @@
 			<return type="String">
 			</return>
 			<description>
+				Returns the currently playing animation state.
 			</description>
 		</method>
 		<method name="get_travel_path" qualifiers="const">
@@ -23,6 +30,7 @@
 			<return type="bool">
 			</return>
 			<description>
+				Returns [code]true[/code] if an animation is playing.
 			</description>
 		</method>
 		<method name="start">
@@ -31,12 +39,14 @@
 			<argument index="0" name="node" type="String">
 			</argument>
 			<description>
+				Starts playing the given animation.
 			</description>
 		</method>
 		<method name="stop">
 			<return type="void">
 			</return>
 			<description>
+				Stops the currently playing animation.
 			</description>
 		</method>
 		<method name="travel">
@@ -45,7 +55,7 @@
 			<argument index="0" name="to_node" type="String">
 			</argument>
 			<description>
-				Transition from the current state to another one, while visiting all the intermediate ones. This is done via the A* algorithm.
+				Transitions from the current state to another one, following the shortest path.
 			</description>
 		</method>
 	</methods>