summaryrefslogtreecommitdiffstats
path: root/doc/classes/AnimationNodeStateMachine.xml
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2020-01-23 11:14:14 +0100
committerRémi Verschelde <rverschelde@gmail.com>2020-01-23 12:37:33 +0100
commitba177ccaecb91c3800e220272864dfb5c23958e7 (patch)
tree8eadc7fb7365c2863fa2536f6a6db68d82588ec6 /doc/classes/AnimationNodeStateMachine.xml
parent46820527dea1fb238edbc1137f3173750e053ece (diff)
downloadredot-engine-ba177ccaecb91c3800e220272864dfb5c23958e7.tar.gz
doc: Misc updates for AnimationNode* and others
- Add some missing descriptions. - Add links to tutorials for ARVR and AnimationTree. - Style fixes. - Engine changes: * Make `AnimationNodeTransition.input_<number>` properties internal so that they don't appear in the docs. They still appear in the inspector based on the actual number of inputs requested. * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D particles in `ParticlesMaterial`, and thus only relevant for `CPUParticles3D`.
Diffstat (limited to 'doc/classes/AnimationNodeStateMachine.xml')
-rw-r--r--doc/classes/AnimationNodeStateMachine.xml7
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/classes/AnimationNodeStateMachine.xml b/doc/classes/AnimationNodeStateMachine.xml
index 9a21492b8a..a15ccc4efe 100644
--- a/doc/classes/AnimationNodeStateMachine.xml
+++ b/doc/classes/AnimationNodeStateMachine.xml
@@ -4,7 +4,7 @@
State machine for control of animations.
</brief_description>
<description>
- Contains multiple nodes representing animation states, connected in a graph. Node 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 programmatically.
+ Contains multiple nodes representing animation states, connected in a graph. Node 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 programmatically.
[b]Example:[/b]
[codeblock]
var state_machine = $AnimationTree.get("parameters/playback")
@@ -12,6 +12,7 @@
[/codeblock]
</description>
<tutorials>
+ <link>https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html</link>
</tutorials>
<methods>
<method name="add_node">
@@ -159,7 +160,7 @@
<argument index="1" name="to" type="String">
</argument>
<description>
- Deletes the given transition.
+ Deletes the transition between the two specified nodes.
</description>
</method>
<method name="remove_transition_by_index">
@@ -168,7 +169,7 @@
<argument index="0" name="idx" type="int">
</argument>
<description>
- Deletes the given transition.
+ Deletes the given transition by index.
</description>
</method>
<method name="rename_node">