class_visualscriptyield.rst 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  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 VisualScriptYield.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_VisualScriptYield:
  6. VisualScriptYield
  7. =================
  8. **Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Properties
  10. ----------
  11. +----------------------------------------------------+--------------------------------------------------------------+-------+
  12. | :ref:`YieldMode<enum_VisualScriptYield_YieldMode>` | :ref:`mode<class_VisualScriptYield_property_mode>` | ``1`` |
  13. +----------------------------------------------------+--------------------------------------------------------------+-------+
  14. | :ref:`float<class_float>` | :ref:`wait_time<class_VisualScriptYield_property_wait_time>` | |
  15. +----------------------------------------------------+--------------------------------------------------------------+-------+
  16. Enumerations
  17. ------------
  18. .. _enum_VisualScriptYield_YieldMode:
  19. .. _class_VisualScriptYield_constant_YIELD_FRAME:
  20. .. _class_VisualScriptYield_constant_YIELD_PHYSICS_FRAME:
  21. .. _class_VisualScriptYield_constant_YIELD_WAIT:
  22. enum **YieldMode**:
  23. - **YIELD_FRAME** = **1**
  24. - **YIELD_PHYSICS_FRAME** = **2**
  25. - **YIELD_WAIT** = **3**
  26. Property Descriptions
  27. ---------------------
  28. .. _class_VisualScriptYield_property_mode:
  29. - :ref:`YieldMode<enum_VisualScriptYield_YieldMode>` **mode**
  30. +-----------+-----------------------+
  31. | *Default* | ``1`` |
  32. +-----------+-----------------------+
  33. | *Setter* | set_yield_mode(value) |
  34. +-----------+-----------------------+
  35. | *Getter* | get_yield_mode() |
  36. +-----------+-----------------------+
  37. ----
  38. .. _class_VisualScriptYield_property_wait_time:
  39. - :ref:`float<class_float>` **wait_time**
  40. +----------+----------------------+
  41. | *Setter* | set_wait_time(value) |
  42. +----------+----------------------+
  43. | *Getter* | get_wait_time() |
  44. +----------+----------------------+
  45. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  46. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  47. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`