AnimationNodeStateMachine.xml 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="AnimationNodeStateMachine" inherits="AnimationRootNode" category="Core" version="3.1">
  3. <brief_description>
  4. </brief_description>
  5. <description>
  6. Contains multiple root nodes as children in a graph. Each node is used as a state, and provides multiple functions to alternate between states. Retrieve the AnimationNodeStateMachinePlayback object from the [AnimationTree] node to control it programatically.
  7. [codeblock]
  8. var state_machine = anim_tree["parameters/StateMachine/playback"]
  9. state_machine.travel("SomeState")
  10. [codeblock]
  11. </description>
  12. <tutorials>
  13. </tutorials>
  14. <methods>
  15. <method name="add_node">
  16. <return type="void">
  17. </return>
  18. <argument index="0" name="name" type="String">
  19. </argument>
  20. <argument index="1" name="node" type="AnimationNode">
  21. </argument>
  22. <argument index="2" name="position" type="Vector2" default="Vector2( 0, 0 )">
  23. </argument>
  24. <description>
  25. </description>
  26. </method>
  27. <method name="add_transition">
  28. <return type="void">
  29. </return>
  30. <argument index="0" name="from" type="String">
  31. </argument>
  32. <argument index="1" name="to" type="String">
  33. </argument>
  34. <argument index="2" name="transition" type="AnimationNodeStateMachineTransition">
  35. </argument>
  36. <description>
  37. </description>
  38. </method>
  39. <method name="get_end_node" qualifiers="const">
  40. <return type="String">
  41. </return>
  42. <description>
  43. </description>
  44. </method>
  45. <method name="get_graph_offset" qualifiers="const">
  46. <return type="Vector2">
  47. </return>
  48. <description>
  49. </description>
  50. </method>
  51. <method name="get_node" qualifiers="const">
  52. <return type="AnimationNode">
  53. </return>
  54. <argument index="0" name="name" type="String">
  55. </argument>
  56. <description>
  57. </description>
  58. </method>
  59. <method name="get_node_name" qualifiers="const">
  60. <return type="String">
  61. </return>
  62. <argument index="0" name="node" type="AnimationNode">
  63. </argument>
  64. <description>
  65. </description>
  66. </method>
  67. <method name="get_node_position" qualifiers="const">
  68. <return type="Vector2">
  69. </return>
  70. <argument index="0" name="name" type="String">
  71. </argument>
  72. <description>
  73. </description>
  74. </method>
  75. <method name="get_start_node" qualifiers="const">
  76. <return type="String">
  77. </return>
  78. <description>
  79. </description>
  80. </method>
  81. <method name="get_transition" qualifiers="const">
  82. <return type="AnimationNodeStateMachineTransition">
  83. </return>
  84. <argument index="0" name="idx" type="int">
  85. </argument>
  86. <description>
  87. </description>
  88. </method>
  89. <method name="get_transition_count" qualifiers="const">
  90. <return type="int">
  91. </return>
  92. <description>
  93. </description>
  94. </method>
  95. <method name="get_transition_from" qualifiers="const">
  96. <return type="String">
  97. </return>
  98. <argument index="0" name="idx" type="int">
  99. </argument>
  100. <description>
  101. </description>
  102. </method>
  103. <method name="get_transition_to" qualifiers="const">
  104. <return type="String">
  105. </return>
  106. <argument index="0" name="idx" type="int">
  107. </argument>
  108. <description>
  109. </description>
  110. </method>
  111. <method name="has_node" qualifiers="const">
  112. <return type="bool">
  113. </return>
  114. <argument index="0" name="name" type="String">
  115. </argument>
  116. <description>
  117. </description>
  118. </method>
  119. <method name="has_transition" qualifiers="const">
  120. <return type="bool">
  121. </return>
  122. <argument index="0" name="from" type="String">
  123. </argument>
  124. <argument index="1" name="to" type="String">
  125. </argument>
  126. <description>
  127. </description>
  128. </method>
  129. <method name="remove_node">
  130. <return type="void">
  131. </return>
  132. <argument index="0" name="name" type="String">
  133. </argument>
  134. <description>
  135. </description>
  136. </method>
  137. <method name="remove_transition">
  138. <return type="void">
  139. </return>
  140. <argument index="0" name="from" type="String">
  141. </argument>
  142. <argument index="1" name="to" type="String">
  143. </argument>
  144. <description>
  145. </description>
  146. </method>
  147. <method name="remove_transition_by_index">
  148. <return type="void">
  149. </return>
  150. <argument index="0" name="idx" type="int">
  151. </argument>
  152. <description>
  153. </description>
  154. </method>
  155. <method name="rename_node">
  156. <return type="void">
  157. </return>
  158. <argument index="0" name="name" type="String">
  159. </argument>
  160. <argument index="1" name="new_name" type="String">
  161. </argument>
  162. <description>
  163. </description>
  164. </method>
  165. <method name="set_end_node">
  166. <return type="void">
  167. </return>
  168. <argument index="0" name="name" type="String">
  169. </argument>
  170. <description>
  171. </description>
  172. </method>
  173. <method name="set_graph_offset">
  174. <return type="void">
  175. </return>
  176. <argument index="0" name="offset" type="Vector2">
  177. </argument>
  178. <description>
  179. </description>
  180. </method>
  181. <method name="set_node_position">
  182. <return type="void">
  183. </return>
  184. <argument index="0" name="name" type="String">
  185. </argument>
  186. <argument index="1" name="position" type="Vector2">
  187. </argument>
  188. <description>
  189. </description>
  190. </method>
  191. <method name="set_start_node">
  192. <return type="void">
  193. </return>
  194. <argument index="0" name="name" type="String">
  195. </argument>
  196. <description>
  197. </description>
  198. </method>
  199. </methods>
  200. <constants>
  201. </constants>
  202. </class>