AnimationNodeStateMachineTransition.xml 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="AnimationNodeStateMachineTransition" inherits="Resource" category="Core" version="3.1.2">
  3. <brief_description>
  4. </brief_description>
  5. <description>
  6. </description>
  7. <tutorials>
  8. </tutorials>
  9. <methods>
  10. </methods>
  11. <members>
  12. <member name="advance_condition" type="String" setter="set_advance_condition" getter="get_advance_condition">
  13. 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":
  14. [codeblock]
  15. $animation_tree["parameters/conditions/idle"] = is_on_floor and linear_velocity.x == 0
  16. [/codeblock]
  17. </member>
  18. <member name="auto_advance" type="bool" setter="set_auto_advance" getter="has_auto_advance">
  19. Turn on the transition automatically when this state is reached. This works best with [constant SWITCH_MODE_AT_END].
  20. </member>
  21. <member name="disabled" type="bool" setter="set_disabled" getter="is_disabled">
  22. Don't use this transition during [method AnimationNodeStateMachinePlayback.travel] or [member auto_advance].
  23. </member>
  24. <member name="priority" type="int" setter="set_priority" getter="get_priority">
  25. Lower priority transitions are preferred when travelling through the tree via [method AnimationNodeStateMachinePlayback.travel] or [member auto_advance].
  26. </member>
  27. <member name="switch_mode" type="int" setter="set_switch_mode" getter="get_switch_mode" enum="AnimationNodeStateMachineTransition.SwitchMode">
  28. The transition type.
  29. </member>
  30. <member name="xfade_time" type="float" setter="set_xfade_time" getter="get_xfade_time">
  31. The time to cross-fade between this state and the next.
  32. </member>
  33. </members>
  34. <signals>
  35. <signal name="advance_condition_changed">
  36. <description>
  37. </description>
  38. </signal>
  39. </signals>
  40. <constants>
  41. <constant name="SWITCH_MODE_IMMEDIATE" value="0" enum="SwitchMode">
  42. Switch to the next state immediately. The current state will end and blend into the beginning of the new one.
  43. </constant>
  44. <constant name="SWITCH_MODE_SYNC" value="1" enum="SwitchMode">
  45. Switch to the next state immediately, but will seek the new state to the playback position of the old state.
  46. </constant>
  47. <constant name="SWITCH_MODE_AT_END" value="2" enum="SwitchMode">
  48. Wait for the current state playback to end, then switch to the beginning of the next state animation.
  49. </constant>
  50. </constants>
  51. </class>