diff options
Diffstat (limited to 'doc/classes/AnimationNodeStateMachineTransition.xml')
| -rw-r--r-- | doc/classes/AnimationNodeStateMachineTransition.xml | 19 |
1 files changed, 11 insertions, 8 deletions
diff --git a/doc/classes/AnimationNodeStateMachineTransition.xml b/doc/classes/AnimationNodeStateMachineTransition.xml index a21ee50949..08ff9997cf 100644 --- a/doc/classes/AnimationNodeStateMachineTransition.xml +++ b/doc/classes/AnimationNodeStateMachineTransition.xml @@ -9,22 +9,25 @@ <methods> </methods> <members> - <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. + <member name="advance_condition" type="String" setter="set_advance_condition" getter="get_advance_condition" default=""""> + 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 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]. + <member name="auto_advance" type="bool" setter="set_auto_advance" getter="has_auto_advance" default="false"> + Turn on the transition automatically when this state is reached. This works best with [constant SWITCH_MODE_AT_END]. </member> - <member name="disabled" type="bool" setter="set_disabled" getter="is_disabled"> + <member name="disabled" type="bool" setter="set_disabled" getter="is_disabled" default="false"> Don't use this transition during [method AnimationNodeStateMachinePlayback.travel] or [member auto_advance]. </member> - <member name="priority" type="int" setter="set_priority" getter="get_priority"> + <member name="priority" type="int" setter="set_priority" getter="get_priority" default="1"> Lower priority transitions are preferred when travelling through the tree via [method AnimationNodeStateMachinePlayback.travel] or [member auto_advance]. </member> - <member name="switch_mode" type="int" setter="set_switch_mode" getter="get_switch_mode" enum="AnimationNodeStateMachineTransition.SwitchMode"> + <member name="switch_mode" type="int" setter="set_switch_mode" getter="get_switch_mode" enum="AnimationNodeStateMachineTransition.SwitchMode" default="0"> The transition type. </member> - <member name="xfade_time" type="float" setter="set_xfade_time" getter="get_xfade_time"> + <member name="xfade_time" type="float" setter="set_xfade_time" getter="get_xfade_time" default="0.0"> The time to cross-fade between this state and the next. </member> </members> |