12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364 |
- :github_url: hide
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the GDScriptFunctionState.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_GDScriptFunctionState:
- GDScriptFunctionState
- =====================
- **Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
- **Category:** Core
- Brief Description
- -----------------
- State of a function call after yielding.
- Methods
- -------
- +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`is_valid<class_GDScriptFunctionState_method_is_valid>` **(** :ref:`bool<class_bool>` extended_check=false **)** const |
- +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Variant<class_Variant>` | :ref:`resume<class_GDScriptFunctionState_method_resume>` **(** :ref:`Variant<class_Variant>` arg=null **)** |
- +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
- Signals
- -------
- .. _class_GDScriptFunctionState_signal_completed:
- - **completed** **(** :ref:`Nil<class_Nil>` result **)**
- Description
- -----------
- Calling :ref:`@GDScript.yield<class_@GDScript_method_yield>` within a function will cause that function to yield and return its current state as an object of this type. The yielded function call can then be resumed later by calling :ref:`resume<class_GDScriptFunctionState_method_resume>` on this state object.
- Method Descriptions
- -------------------
- .. _class_GDScriptFunctionState_method_is_valid:
- - :ref:`bool<class_bool>` **is_valid** **(** :ref:`bool<class_bool>` extended_check=false **)** const
- Check whether the function call may be resumed. This is not the case if the function state was already resumed.
- If ``extended_check`` is enabled, it also checks if the associated script and object still exist. The extended check is done in debug mode as part of :ref:`resume<class_GDScriptFunctionState_method_resume>`, but you can use this if you know you may be trying to resume without knowing for sure the object and/or script have survived up to that point.
- ----
- .. _class_GDScriptFunctionState_method_resume:
- - :ref:`Variant<class_Variant>` **resume** **(** :ref:`Variant<class_Variant>` arg=null **)**
- Resume execution of the yielded function call.
- If handed an argument, return the argument from the :ref:`@GDScript.yield<class_@GDScript_method_yield>` call in the yielded function call. You can pass e.g. an :ref:`Array<class_Array>` to hand multiple arguments.
- This function returns what the resumed function call returns, possibly another function state if yielded again.
|