godot-docs/classes/class_visualscriptfunctionstate.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptFunctionState.xml.

.. _class_VisualScriptFunctionState:

VisualScriptFunctionState
=========================

**Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

A Visual Script node representing a function state.

.. rst-class:: classref-introduction-group

Description
-----------

**VisualScriptFunctionState** is returned from :ref:`VisualScriptYield<class_VisualScriptYield>` and can be used to resume a paused function call.

.. rst-class:: classref-reftable-group

Methods
-------

.. table::
   :widths: auto

   +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                          | :ref:`connect_to_signal<class_VisualScriptFunctionState_method_connect_to_signal>` **(** :ref:`Object<class_Object>` obj, :ref:`String<class_String>` signals, :ref:`Array<class_Array>` args **)** |
   +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`       | :ref:`is_valid<class_VisualScriptFunctionState_method_is_valid>` **(** **)** |const|                                                                                                                |
   +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Variant<class_Variant>` | :ref:`resume<class_VisualScriptFunctionState_method_resume>` **(** :ref:`Array<class_Array>` args=null **)**                                                                                        |
   +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Method Descriptions
-------------------

.. _class_VisualScriptFunctionState_method_connect_to_signal:

.. rst-class:: classref-method

void **connect_to_signal** **(** :ref:`Object<class_Object>` obj, :ref:`String<class_String>` signals, :ref:`Array<class_Array>` args **)**

Connects this **VisualScriptFunctionState** to a signal in the given object to automatically resume when it's emitted.

.. rst-class:: classref-item-separator

----

.. _class_VisualScriptFunctionState_method_is_valid:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_valid** **(** **)** |const|

Returns whether the function state is valid.

.. rst-class:: classref-item-separator

----

.. _class_VisualScriptFunctionState_method_resume:

.. rst-class:: classref-method

:ref:`Variant<class_Variant>` **resume** **(** :ref:`Array<class_Array>` args=null **)**

Resumes the function to run from the point it was yielded.

.. |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.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`