class_visualscriptyield.rst 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the VisualScriptYield.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_VisualScriptYield:
  5. VisualScriptYield
  6. =================
  7. **Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Member Functions
  12. ----------------
  13. +----------------------------+---------------------------------------------------------------------------------------------------------+
  14. | :ref:`float<class_float>` | :ref:`get_wait_time<class_VisualScriptYield_get_wait_time>` **(** **)** |
  15. +----------------------------+---------------------------------------------------------------------------------------------------------+
  16. | :ref:`int<class_int>` | :ref:`get_yield_mode<class_VisualScriptYield_get_yield_mode>` **(** **)** |
  17. +----------------------------+---------------------------------------------------------------------------------------------------------+
  18. | void | :ref:`set_wait_time<class_VisualScriptYield_set_wait_time>` **(** :ref:`float<class_float>` sec **)** |
  19. +----------------------------+---------------------------------------------------------------------------------------------------------+
  20. | void | :ref:`set_yield_mode<class_VisualScriptYield_set_yield_mode>` **(** :ref:`int<class_int>` mode **)** |
  21. +----------------------------+---------------------------------------------------------------------------------------------------------+
  22. Member Variables
  23. ----------------
  24. - :ref:`int<class_int>` **mode**
  25. - :ref:`float<class_float>` **wait_time**
  26. Numeric Constants
  27. -----------------
  28. - **YIELD_FRAME** = **1**
  29. - **YIELD_PHYSICS_FRAME** = **2**
  30. - **YIELD_WAIT** = **3**
  31. Member Function Description
  32. ---------------------------
  33. .. _class_VisualScriptYield_get_wait_time:
  34. - :ref:`float<class_float>` **get_wait_time** **(** **)**
  35. .. _class_VisualScriptYield_get_yield_mode:
  36. - :ref:`int<class_int>` **get_yield_mode** **(** **)**
  37. .. _class_VisualScriptYield_set_wait_time:
  38. - void **set_wait_time** **(** :ref:`float<class_float>` sec **)**
  39. .. _class_VisualScriptYield_set_yield_mode:
  40. - void **set_yield_mode** **(** :ref:`int<class_int>` mode **)**