classref: Sync with current 3.4 branch

classes/class_visualscriptyield.rst

@@ -11,7 +11,12 @@ VisualScriptYield
 
 **Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
 
+A Visual Script node used to pause a function execution.
 
+Description
+-----------
+
+``VisualScriptYield`` will pause the function call and return :ref:`VisualScriptFunctionState<class_VisualScriptFunctionState>`, which can be used to resume the function.
 
 Properties
 ----------
@@ -35,11 +40,11 @@ Enumerations
 
 enum **YieldMode**:
 
-- **YIELD_FRAME** = **1**
+- **YIELD_FRAME** = **1** --- Yields during an idle frame.
 
-- **YIELD_PHYSICS_FRAME** = **2**
+- **YIELD_PHYSICS_FRAME** = **2** --- Yields during a physics frame.
 
-- **YIELD_WAIT** = **3**
+- **YIELD_WAIT** = **3** --- Yields a function and waits the given time.
 
 Property Descriptions
 ---------------------
@@ -56,6 +61,8 @@ Property Descriptions
 | *Getter*  | get_yield_mode()      |
 +-----------+-----------------------+
 
+The mode to use for yielding. See :ref:`YieldMode<enum_VisualScriptYield_YieldMode>` for available options.
+
 ----
 
 .. _class_VisualScriptYield_property_wait_time:
@@ -68,6 +75,8 @@ Property Descriptions
 | *Getter* | get_wait_time()      |
 +----------+----------------------+
 
+The time to wait when :ref:`mode<class_VisualScriptYield_property_mode>` is set to :ref:`YIELD_WAIT<class_VisualScriptYield_constant_YIELD_WAIT>`.
+
 .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
 .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
 .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`