From 584288a32c49afa02e69178381ef1e2abfb5371b Mon Sep 17 00:00:00 2001 From: Ryan Roden-Corrent Date: Sun, 7 Apr 2019 07:21:31 -0400 Subject: Fill out some of the AnimationNode docs. 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. --- doc/classes/AnimationNodeStateMachine.xml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'doc/classes/AnimationNodeStateMachine.xml') diff --git a/doc/classes/AnimationNodeStateMachine.xml b/doc/classes/AnimationNodeStateMachine.xml index 6de544c9ac..348bd9eda1 100644 --- a/doc/classes/AnimationNodeStateMachine.xml +++ b/doc/classes/AnimationNodeStateMachine.xml @@ -3,6 +3,11 @@ + 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 programatically. + [codeblock] + var state_machine = anim_tree["parameters/StateMachine/playback"] + state_machine.travel("SomeState") + [codeblock] @@ -170,7 +175,7 @@ - + -- cgit v1.2.3