Files
godot-docs/classes/class_visualscriptyield.rst
2017-04-07 22:11:07 +02:00

64 lines
2.4 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_VisualScriptYield:
VisualScriptYield
=================
**Inherits:** :ref:`VisualScriptNode<class_visualscriptnode>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+----------------------------+---------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_wait_time<class_VisualScriptYield_get_wait_time>` **(** **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_yield_mode<class_VisualScriptYield_get_yield_mode>` **(** **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------+
| void | :ref:`set_wait_time<class_VisualScriptYield_set_wait_time>` **(** :ref:`float<class_float>` sec **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------+
| void | :ref:`set_yield_mode<class_VisualScriptYield_set_yield_mode>` **(** :ref:`int<class_int>` mode **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`int<class_int>` **mode**
- :ref:`float<class_float>` **wait_time**
Numeric Constants
-----------------
- **YIELD_FRAME** = **1**
- **YIELD_FIXED_FRAME** = **2**
- **YIELD_WAIT** = **3**
Member Function Description
---------------------------
.. _class_VisualScriptYield_get_wait_time:
- :ref:`float<class_float>` **get_wait_time** **(** **)**
.. _class_VisualScriptYield_get_yield_mode:
- :ref:`int<class_int>` **get_yield_mode** **(** **)**
.. _class_VisualScriptYield_set_wait_time:
- void **set_wait_time** **(** :ref:`float<class_float>` sec **)**
.. _class_VisualScriptYield_set_yield_mode:
- void **set_yield_mode** **(** :ref:`int<class_int>` mode **)**