godot-docs/classes/class_gdscriptfunctionstate.rst

:github_url: hide

.. Generated automatically by doc/tools/make_rst.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>`

State of a function call after yielding.

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.

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:`Variant<class_Variant>` result **)**

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.

.. |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.)`