diff options
| author | Ryan Roden-Corrent <ryan@rcorre.net> | 2019-04-07 07:21:31 -0400 |
|---|---|---|
| committer | Ryan Roden-Corrent <ryan@rcorre.net> | 2019-04-09 10:49:21 -0400 |
| commit | 584288a32c49afa02e69178381ef1e2abfb5371b (patch) | |
| tree | 793f386f5846c14e4fcda58b0e13152c2bb28bfe /doc/classes/AnimationNodeStateMachine.xml | |
| parent | e40aea7fecd86240502d8e2e8f8492428f8df307 (diff) | |
| download | redot-engine-584288a32c49afa02e69178381ef1e2abfb5371b.tar.gz | |
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.
Diffstat (limited to 'doc/classes/AnimationNodeStateMachine.xml')
| -rw-r--r-- | doc/classes/AnimationNodeStateMachine.xml | 7 |
1 files changed, 6 insertions, 1 deletions
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 @@ <brief_description> </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 programatically. + [codeblock] + var state_machine = anim_tree["parameters/StateMachine/playback"] + state_machine.travel("SomeState") + [codeblock] </description> <tutorials> </tutorials> @@ -170,7 +175,7 @@ <method name="set_graph_offset"> <return type="void"> </return> - <argument index="0" name="name" type="Vector2"> + <argument index="0" name="offset" type="Vector2"> </argument> <description> </description> |