AnimationTree.xml 3.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="AnimationTree" inherits="AnimationMixer" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
  3. <brief_description>
  4. A node used for advanced animation transitions in an [AnimationPlayer].
  5. </brief_description>
  6. <description>
  7. A node used for advanced animation transitions in an [AnimationPlayer].
  8. [b]Note:[/b] When linked with an [AnimationPlayer], several properties and methods of the corresponding [AnimationPlayer] will not function as expected. Playback and transitions should be handled using only the [AnimationTree] and its constituent [AnimationNode](s). The [AnimationPlayer] node should be used solely for adding, deleting, and editing animations.
  9. </description>
  10. <tutorials>
  11. <link title="Using AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link>
  12. <link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link>
  13. </tutorials>
  14. <methods>
  15. <method name="get_process_callback" qualifiers="const" is_deprecated="true">
  16. <return type="int" enum="AnimationTree.AnimationProcessCallback" />
  17. <description>
  18. For backward compatibility. See [enum AnimationMixer.AnimationCallbackModeProcess].
  19. </description>
  20. </method>
  21. <method name="set_process_callback" is_deprecated="true">
  22. <return type="void" />
  23. <param index="0" name="mode" type="int" enum="AnimationTree.AnimationProcessCallback" />
  24. <description>
  25. For backward compatibility. See [enum AnimationMixer.AnimationCallbackModeProcess].
  26. </description>
  27. </method>
  28. </methods>
  29. <members>
  30. <member name="advance_expression_base_node" type="NodePath" setter="set_advance_expression_base_node" getter="get_advance_expression_base_node" default="NodePath(&quot;.&quot;)">
  31. The path to the [Node] used to evaluate the [AnimationNode] [Expression] if one is not explicitly specified internally.
  32. </member>
  33. <member name="anim_player" type="NodePath" setter="set_animation_player" getter="get_animation_player" default="NodePath(&quot;&quot;)">
  34. The path to the [AnimationPlayer] used for animating.
  35. </member>
  36. <member name="deterministic" type="bool" setter="set_deterministic" getter="is_deterministic" overrides="AnimationMixer" default="true" />
  37. <member name="tree_root" type="AnimationRootNode" setter="set_tree_root" getter="get_tree_root">
  38. The root animation node of this [AnimationTree]. See [AnimationRootNode].
  39. </member>
  40. </members>
  41. <signals>
  42. <signal name="animation_player_changed">
  43. <description>
  44. Emitted when the [member anim_player] is changed.
  45. </description>
  46. </signal>
  47. </signals>
  48. <constants>
  49. <constant name="ANIMATION_PROCESS_PHYSICS" value="0" enum="AnimationProcessCallback" is_deprecated="true">
  50. For backward compatibility. See [constant AnimationMixer.ANIMATION_CALLBACK_MODE_PROCESS_PHYSICS].
  51. </constant>
  52. <constant name="ANIMATION_PROCESS_IDLE" value="1" enum="AnimationProcessCallback" is_deprecated="true">
  53. For backward compatibility. See [constant AnimationMixer.ANIMATION_CALLBACK_MODE_PROCESS_IDLE].
  54. </constant>
  55. <constant name="ANIMATION_PROCESS_MANUAL" value="2" enum="AnimationProcessCallback" is_deprecated="true">
  56. For backward compatibility. See [constant AnimationMixer.ANIMATION_CALLBACK_MODE_PROCESS_MANUAL].
  57. </constant>
  58. </constants>
  59. </class>