class_animationnodeoneshot.rst 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the AnimationNodeOneShot.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_AnimationNodeOneShot:
  6. AnimationNodeOneShot
  7. ====================
  8. **Inherits:** :ref:`AnimationNode<class_AnimationNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Tutorials
  10. ---------
  11. - :doc:`../tutorials/animation/animation_tree`
  12. Properties
  13. ----------
  14. +---------------------------+-----------------------------------------------------------------------------------------------+-----------+
  15. | :ref:`bool<class_bool>` | :ref:`autorestart<class_AnimationNodeOneShot_property_autorestart>` | ``false`` |
  16. +---------------------------+-----------------------------------------------------------------------------------------------+-----------+
  17. | :ref:`float<class_float>` | :ref:`autorestart_delay<class_AnimationNodeOneShot_property_autorestart_delay>` | ``1.0`` |
  18. +---------------------------+-----------------------------------------------------------------------------------------------+-----------+
  19. | :ref:`float<class_float>` | :ref:`autorestart_random_delay<class_AnimationNodeOneShot_property_autorestart_random_delay>` | ``0.0`` |
  20. +---------------------------+-----------------------------------------------------------------------------------------------+-----------+
  21. | :ref:`float<class_float>` | :ref:`fadein_time<class_AnimationNodeOneShot_property_fadein_time>` | ``0.1`` |
  22. +---------------------------+-----------------------------------------------------------------------------------------------+-----------+
  23. | :ref:`float<class_float>` | :ref:`fadeout_time<class_AnimationNodeOneShot_property_fadeout_time>` | ``0.1`` |
  24. +---------------------------+-----------------------------------------------------------------------------------------------+-----------+
  25. | :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeOneShot_property_sync>` | ``false`` |
  26. +---------------------------+-----------------------------------------------------------------------------------------------+-----------+
  27. Methods
  28. -------
  29. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
  30. | :ref:`MixMode<enum_AnimationNodeOneShot_MixMode>` | :ref:`get_mix_mode<class_AnimationNodeOneShot_method_get_mix_mode>` **(** **)** const |
  31. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
  32. | void | :ref:`set_mix_mode<class_AnimationNodeOneShot_method_set_mix_mode>` **(** :ref:`MixMode<enum_AnimationNodeOneShot_MixMode>` mode **)** |
  33. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
  34. Enumerations
  35. ------------
  36. .. _enum_AnimationNodeOneShot_MixMode:
  37. .. _class_AnimationNodeOneShot_constant_MIX_MODE_BLEND:
  38. .. _class_AnimationNodeOneShot_constant_MIX_MODE_ADD:
  39. enum **MixMode**:
  40. - **MIX_MODE_BLEND** = **0**
  41. - **MIX_MODE_ADD** = **1**
  42. Property Descriptions
  43. ---------------------
  44. .. _class_AnimationNodeOneShot_property_autorestart:
  45. - :ref:`bool<class_bool>` **autorestart**
  46. +-----------+------------------------+
  47. | *Default* | ``false`` |
  48. +-----------+------------------------+
  49. | *Setter* | set_autorestart(value) |
  50. +-----------+------------------------+
  51. | *Getter* | has_autorestart() |
  52. +-----------+------------------------+
  53. ----
  54. .. _class_AnimationNodeOneShot_property_autorestart_delay:
  55. - :ref:`float<class_float>` **autorestart_delay**
  56. +-----------+------------------------------+
  57. | *Default* | ``1.0`` |
  58. +-----------+------------------------------+
  59. | *Setter* | set_autorestart_delay(value) |
  60. +-----------+------------------------------+
  61. | *Getter* | get_autorestart_delay() |
  62. +-----------+------------------------------+
  63. ----
  64. .. _class_AnimationNodeOneShot_property_autorestart_random_delay:
  65. - :ref:`float<class_float>` **autorestart_random_delay**
  66. +-----------+-------------------------------------+
  67. | *Default* | ``0.0`` |
  68. +-----------+-------------------------------------+
  69. | *Setter* | set_autorestart_random_delay(value) |
  70. +-----------+-------------------------------------+
  71. | *Getter* | get_autorestart_random_delay() |
  72. +-----------+-------------------------------------+
  73. ----
  74. .. _class_AnimationNodeOneShot_property_fadein_time:
  75. - :ref:`float<class_float>` **fadein_time**
  76. +-----------+------------------------+
  77. | *Default* | ``0.1`` |
  78. +-----------+------------------------+
  79. | *Setter* | set_fadein_time(value) |
  80. +-----------+------------------------+
  81. | *Getter* | get_fadein_time() |
  82. +-----------+------------------------+
  83. ----
  84. .. _class_AnimationNodeOneShot_property_fadeout_time:
  85. - :ref:`float<class_float>` **fadeout_time**
  86. +-----------+-------------------------+
  87. | *Default* | ``0.1`` |
  88. +-----------+-------------------------+
  89. | *Setter* | set_fadeout_time(value) |
  90. +-----------+-------------------------+
  91. | *Getter* | get_fadeout_time() |
  92. +-----------+-------------------------+
  93. ----
  94. .. _class_AnimationNodeOneShot_property_sync:
  95. - :ref:`bool<class_bool>` **sync**
  96. +-----------+---------------------+
  97. | *Default* | ``false`` |
  98. +-----------+---------------------+
  99. | *Setter* | set_use_sync(value) |
  100. +-----------+---------------------+
  101. | *Getter* | is_using_sync() |
  102. +-----------+---------------------+
  103. Method Descriptions
  104. -------------------
  105. .. _class_AnimationNodeOneShot_method_get_mix_mode:
  106. - :ref:`MixMode<enum_AnimationNodeOneShot_MixMode>` **get_mix_mode** **(** **)** const
  107. ----
  108. .. _class_AnimationNodeOneShot_method_set_mix_mode:
  109. - void **set_mix_mode** **(** :ref:`MixMode<enum_AnimationNodeOneShot_MixMode>` mode **)**