class_visualscriptyield.rst 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  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. Properties
  12. ----------
  13. +----------------------------------------------------+-----------------------------------------------------+
  14. | :ref:`YieldMode<enum_VisualScriptYield_YieldMode>` | :ref:`mode<class_VisualScriptYield_mode>` |
  15. +----------------------------------------------------+-----------------------------------------------------+
  16. | :ref:`float<class_float>` | :ref:`wait_time<class_VisualScriptYield_wait_time>` |
  17. +----------------------------------------------------+-----------------------------------------------------+
  18. Enumerations
  19. ------------
  20. .. _enum_VisualScriptYield_YieldMode:
  21. enum **YieldMode**:
  22. - **YIELD_FRAME** = **1**
  23. - **YIELD_PHYSICS_FRAME** = **2**
  24. - **YIELD_WAIT** = **3**
  25. Property Descriptions
  26. ---------------------
  27. .. _class_VisualScriptYield_mode:
  28. - :ref:`YieldMode<enum_VisualScriptYield_YieldMode>` **mode**
  29. +----------+-----------------------+
  30. | *Setter* | set_yield_mode(value) |
  31. +----------+-----------------------+
  32. | *Getter* | get_yield_mode() |
  33. +----------+-----------------------+
  34. .. _class_VisualScriptYield_wait_time:
  35. - :ref:`float<class_float>` **wait_time**
  36. +----------+----------------------+
  37. | *Setter* | set_wait_time(value) |
  38. +----------+----------------------+
  39. | *Getter* | get_wait_time() |
  40. +----------+----------------------+