Etusivu Tutki Apua
Kirjaudu sisään
Godot
/
godot-docs
peilaus alkaen https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Tiedostot Ongelmat 0 Wiki
Puu: def522830a
Haarat Tagit
godot-docs
/
classes
/
class_animationnodestatemachineplayback.rst

class_animationnodestatemachineplayback.rst 4.1 KB
Historia Raaka

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the AnimationNodeStateMachinePlayback.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_AnimationNodeStateMachinePlayback:
    8. 

  8. 

  9. AnimationNodeStateMachinePlayback
    10. 

  10. =================================
    11. 

  11. 

  12. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. **Category:** Core
    15. 

  15. 

  16. Brief Description
    17. 

  17. -----------------
    18. 

  18. 

  19. Playback control for AnimationNodeStateMachine.
    20. 

  20. 

  21. Methods
    22. 

  22. -------
    23. 

  23. 

  24. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
    25. 

  25. | :ref:`String<class_String>`                   | :ref:`get_current_node<class_AnimationNodeStateMachinePlayback_method_get_current_node>` **(** **)** const           |
    26. 

  26. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
    27. 

  27. | :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_travel_path<class_AnimationNodeStateMachinePlayback_method_get_travel_path>` **(** **)** const             |
    28. 

  28. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
    29. 

  29. | :ref:`bool<class_bool>`                       | :ref:`is_playing<class_AnimationNodeStateMachinePlayback_method_is_playing>` **(** **)** const                       |
    30. 

  30. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
    31. 

  31. | void                                          | :ref:`start<class_AnimationNodeStateMachinePlayback_method_start>` **(** :ref:`String<class_String>` node **)**      |
    32. 

  32. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
    33. 

  33. | void                                          | :ref:`stop<class_AnimationNodeStateMachinePlayback_method_stop>` **(** **)**                                         |
    34. 

  34. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
    35. 

  35. | void                                          | :ref:`travel<class_AnimationNodeStateMachinePlayback_method_travel>` **(** :ref:`String<class_String>` to_node **)** |
    36. 

  36. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
    37. 

  37. 

  38. Description
    39. 

  39. -----------
    40. 

  40. 

  41. Allows control of :ref:`AnimationTree<class_AnimationTree>` state machines created with :ref:`AnimationNodeStateMachine<class_AnimationNodeStateMachine>`. Retrieve with ``$AnimationTree.get("parameters/playback")``.
    42. 

  42. 

  43. **Example:**
    44. 

  44. 

  45. ::
    46. 

  46. 

  47.     var state_machine = $AnimationTree.get("parameters/playback")
    48. 

  48.     state_machine.travel("some_state")
    49. 

  49. 

  50. Method Descriptions
    51. 

  51. -------------------
    52. 

  52. 

  53. .. _class_AnimationNodeStateMachinePlayback_method_get_current_node:
    54. 

  54. 

  55. - :ref:`String<class_String>` **get_current_node** **(** **)** const
    56. 

  56. 

  57. Returns the currently playing animation state.
    58. 

  58. 

  59. .. _class_AnimationNodeStateMachinePlayback_method_get_travel_path:
    60. 

  60. 

  61. - :ref:`PoolStringArray<class_PoolStringArray>` **get_travel_path** **(** **)** const
    62. 

  62. 

  63. .. _class_AnimationNodeStateMachinePlayback_method_is_playing:
    64. 

  64. 

  65. - :ref:`bool<class_bool>` **is_playing** **(** **)** const
    66. 

  66. 

  67. Returns ``true`` if an animation is playing.
    68. 

  68. 

  69. .. _class_AnimationNodeStateMachinePlayback_method_start:
    70. 

  70. 

  71. - void **start** **(** :ref:`String<class_String>` node **)**
    72. 

  72. 

  73. Starts playing the given animation.
    74. 

  74. 

  75. .. _class_AnimationNodeStateMachinePlayback_method_stop:
    76. 

  76. 

  77. - void **stop** **(** **)**
    78. 

  78. 

  79. Stops the currently playing animation.
    80. 

  80. 

  81. .. _class_AnimationNodeStateMachinePlayback_method_travel:
    82. 

  82. 

  83. - void **travel** **(** :ref:`String<class_String>` to_node **)**
    84. 

  84. 

  85. Transitions from the current state to another one, following the shortest path.
    86. 

  86.