classref: Sync with current 3.4 branch

This commit is contained in:
Rémi Verschelde
2021-07-26 16:47:42 +02:00
parent 382d2960ec
commit a0ea14e62a
166 changed files with 6697 additions and 1745 deletions

View File

@@ -11,7 +11,12 @@ 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
-------
@@ -31,18 +36,24 @@ Method Descriptions
- 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.)`