godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #28985 from rcorre/advance_condition_docs

Browse Source 
Clarify auto_advance.
This commit is contained in:
Rémi Verschelde 2019-05-20 18:00:14 +02:00 committed by GitHub
commit 5cc1c7d642
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/classes/AnimationNodeStateMachineTransition.xml
View File

@ -10,7 +10,10 @@
</methods> </methods>
<members> <members>
<member name="advance_condition" type="String" setter="set_advance_condition" getter="get_advance_condition"> <member name="advance_condition" type="String" setter="set_advance_condition" getter="get_advance_condition">
Turn on auto advance when this condition is set. This is a custom text field that can be filled with a variable name. The variable can be modified from code. Turn on auto advance when this condition is set. The provided name will become a boolean parameter on the [AnimationTree] that can be controlled from code (see [url=https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html#controlling-from-code][/url]). For example, if [member AnimationTree.tree_root] is an [AnimationNodeStateMachine] and [member advance_condition] is set to "idle":
[codeblock]
$animation_tree["parameters/conditions/idle"] = is_on_floor and linear_velocity.x == 0
[codeblock]
</member> </member>
<member name="auto_advance" type="bool" setter="set_auto_advance" getter="has_auto_advance"> <member name="auto_advance" type="bool" setter="set_auto_advance" getter="has_auto_advance">
Turn on the transition automatically when this state is reached. This works best with [code]SWITCH_MODE_AT_END[/code]. Turn on the transition automatically when this state is reached. This works best with [code]SWITCH_MODE_AT_END[/code].