class_animationnodestatemachine.rst 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the AnimationNodeStateMachine.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_AnimationNodeStateMachine:
  5. AnimationNodeStateMachine
  6. =========================
  7. **Inherits:** :ref:`AnimationRootNode<class_AnimationRootNode>` **<** :ref:`AnimationNode<class_AnimationNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Methods
  12. -------
  13. +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  14. | void | :ref:`add_node<class_AnimationNodeStateMachine_add_node>` **(** :ref:`String<class_String>` name, :ref:`AnimationNode<class_AnimationNode>` node, :ref:`Vector2<class_Vector2>` position=Vector2( 0, 0 ) **)** |
  15. +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  16. | void | :ref:`add_transition<class_AnimationNodeStateMachine_add_transition>` **(** :ref:`String<class_String>` from, :ref:`String<class_String>` to, :ref:`AnimationNodeStateMachineTransition<class_AnimationNodeStateMachineTransition>` transition **)** |
  17. +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  18. | :ref:`String<class_String>` | :ref:`get_end_node<class_AnimationNodeStateMachine_get_end_node>` **(** **)** const |
  19. +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  20. | :ref:`Vector2<class_Vector2>` | :ref:`get_graph_offset<class_AnimationNodeStateMachine_get_graph_offset>` **(** **)** const |
  21. +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  22. | :ref:`AnimationNode<class_AnimationNode>` | :ref:`get_node<class_AnimationNodeStateMachine_get_node>` **(** :ref:`String<class_String>` name **)** const |
  23. +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  24. | :ref:`String<class_String>` | :ref:`get_node_name<class_AnimationNodeStateMachine_get_node_name>` **(** :ref:`AnimationNode<class_AnimationNode>` node **)** const |
  25. +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  26. | :ref:`Vector2<class_Vector2>` | :ref:`get_node_position<class_AnimationNodeStateMachine_get_node_position>` **(** :ref:`String<class_String>` name **)** const |
  27. +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  28. | :ref:`String<class_String>` | :ref:`get_start_node<class_AnimationNodeStateMachine_get_start_node>` **(** **)** const |
  29. +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  30. | :ref:`AnimationNodeStateMachineTransition<class_AnimationNodeStateMachineTransition>` | :ref:`get_transition<class_AnimationNodeStateMachine_get_transition>` **(** :ref:`int<class_int>` idx **)** const |
  31. +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  32. | :ref:`int<class_int>` | :ref:`get_transition_count<class_AnimationNodeStateMachine_get_transition_count>` **(** **)** const |
  33. +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  34. | :ref:`String<class_String>` | :ref:`get_transition_from<class_AnimationNodeStateMachine_get_transition_from>` **(** :ref:`int<class_int>` idx **)** const |
  35. +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  36. | :ref:`String<class_String>` | :ref:`get_transition_to<class_AnimationNodeStateMachine_get_transition_to>` **(** :ref:`int<class_int>` idx **)** const |
  37. +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  38. | :ref:`bool<class_bool>` | :ref:`has_node<class_AnimationNodeStateMachine_has_node>` **(** :ref:`String<class_String>` name **)** const |
  39. +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  40. | :ref:`bool<class_bool>` | :ref:`has_transition<class_AnimationNodeStateMachine_has_transition>` **(** :ref:`String<class_String>` from, :ref:`String<class_String>` to **)** const |
  41. +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  42. | void | :ref:`remove_node<class_AnimationNodeStateMachine_remove_node>` **(** :ref:`String<class_String>` name **)** |
  43. +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  44. | void | :ref:`remove_transition<class_AnimationNodeStateMachine_remove_transition>` **(** :ref:`String<class_String>` from, :ref:`String<class_String>` to **)** |
  45. +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  46. | void | :ref:`remove_transition_by_index<class_AnimationNodeStateMachine_remove_transition_by_index>` **(** :ref:`int<class_int>` idx **)** |
  47. +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  48. | void | :ref:`rename_node<class_AnimationNodeStateMachine_rename_node>` **(** :ref:`String<class_String>` name, :ref:`String<class_String>` new_name **)** |
  49. +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  50. | void | :ref:`set_end_node<class_AnimationNodeStateMachine_set_end_node>` **(** :ref:`String<class_String>` name **)** |
  51. +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  52. | void | :ref:`set_graph_offset<class_AnimationNodeStateMachine_set_graph_offset>` **(** :ref:`Vector2<class_Vector2>` name **)** |
  53. +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  54. | void | :ref:`set_node_position<class_AnimationNodeStateMachine_set_node_position>` **(** :ref:`String<class_String>` name, :ref:`Vector2<class_Vector2>` position **)** |
  55. +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  56. | void | :ref:`set_start_node<class_AnimationNodeStateMachine_set_start_node>` **(** :ref:`String<class_String>` name **)** |
  57. +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  58. Method Descriptions
  59. -------------------
  60. .. _class_AnimationNodeStateMachine_add_node:
  61. - void **add_node** **(** :ref:`String<class_String>` name, :ref:`AnimationNode<class_AnimationNode>` node, :ref:`Vector2<class_Vector2>` position=Vector2( 0, 0 ) **)**
  62. .. _class_AnimationNodeStateMachine_add_transition:
  63. - void **add_transition** **(** :ref:`String<class_String>` from, :ref:`String<class_String>` to, :ref:`AnimationNodeStateMachineTransition<class_AnimationNodeStateMachineTransition>` transition **)**
  64. .. _class_AnimationNodeStateMachine_get_end_node:
  65. - :ref:`String<class_String>` **get_end_node** **(** **)** const
  66. .. _class_AnimationNodeStateMachine_get_graph_offset:
  67. - :ref:`Vector2<class_Vector2>` **get_graph_offset** **(** **)** const
  68. .. _class_AnimationNodeStateMachine_get_node:
  69. - :ref:`AnimationNode<class_AnimationNode>` **get_node** **(** :ref:`String<class_String>` name **)** const
  70. .. _class_AnimationNodeStateMachine_get_node_name:
  71. - :ref:`String<class_String>` **get_node_name** **(** :ref:`AnimationNode<class_AnimationNode>` node **)** const
  72. .. _class_AnimationNodeStateMachine_get_node_position:
  73. - :ref:`Vector2<class_Vector2>` **get_node_position** **(** :ref:`String<class_String>` name **)** const
  74. .. _class_AnimationNodeStateMachine_get_start_node:
  75. - :ref:`String<class_String>` **get_start_node** **(** **)** const
  76. .. _class_AnimationNodeStateMachine_get_transition:
  77. - :ref:`AnimationNodeStateMachineTransition<class_AnimationNodeStateMachineTransition>` **get_transition** **(** :ref:`int<class_int>` idx **)** const
  78. .. _class_AnimationNodeStateMachine_get_transition_count:
  79. - :ref:`int<class_int>` **get_transition_count** **(** **)** const
  80. .. _class_AnimationNodeStateMachine_get_transition_from:
  81. - :ref:`String<class_String>` **get_transition_from** **(** :ref:`int<class_int>` idx **)** const
  82. .. _class_AnimationNodeStateMachine_get_transition_to:
  83. - :ref:`String<class_String>` **get_transition_to** **(** :ref:`int<class_int>` idx **)** const
  84. .. _class_AnimationNodeStateMachine_has_node:
  85. - :ref:`bool<class_bool>` **has_node** **(** :ref:`String<class_String>` name **)** const
  86. .. _class_AnimationNodeStateMachine_has_transition:
  87. - :ref:`bool<class_bool>` **has_transition** **(** :ref:`String<class_String>` from, :ref:`String<class_String>` to **)** const
  88. .. _class_AnimationNodeStateMachine_remove_node:
  89. - void **remove_node** **(** :ref:`String<class_String>` name **)**
  90. .. _class_AnimationNodeStateMachine_remove_transition:
  91. - void **remove_transition** **(** :ref:`String<class_String>` from, :ref:`String<class_String>` to **)**
  92. .. _class_AnimationNodeStateMachine_remove_transition_by_index:
  93. - void **remove_transition_by_index** **(** :ref:`int<class_int>` idx **)**
  94. .. _class_AnimationNodeStateMachine_rename_node:
  95. - void **rename_node** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` new_name **)**
  96. .. _class_AnimationNodeStateMachine_set_end_node:
  97. - void **set_end_node** **(** :ref:`String<class_String>` name **)**
  98. .. _class_AnimationNodeStateMachine_set_graph_offset:
  99. - void **set_graph_offset** **(** :ref:`Vector2<class_Vector2>` name **)**
  100. .. _class_AnimationNodeStateMachine_set_node_position:
  101. - void **set_node_position** **(** :ref:`String<class_String>` name, :ref:`Vector2<class_Vector2>` position **)**
  102. .. _class_AnimationNodeStateMachine_set_start_node:
  103. - void **set_start_node** **(** :ref:`String<class_String>` name **)**