| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the VisualScriptFunctionState.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_VisualScriptFunctionState:
- VisualScriptFunctionState
- =========================
- **Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
- A Visual Script node representing a function state.
- Description
- -----------
- ``VisualScriptFunctionState`` is returned from :ref:`VisualScriptYield<class_VisualScriptYield>` and can be used to resume a paused function call.
- Methods
- -------
- +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Method Descriptions
- -------------------
- .. _class_VisualScriptFunctionState_method_connect_to_signal:
- - 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.
- ----
- .. _class_VisualScriptFunctionState_method_is_valid:
- - :ref:`bool<class_bool>` **is_valid** **(** **)** |const|
- Returns whether the function state is valid.
- ----
- .. _class_VisualScriptFunctionState_method_resume:
- - :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.)`
|
