Files
godot-docs-l10n/classes/es/class_gdscriptfunctionstate.rst
Rémi Verschelde cf78697eea Add localized class reference as pre-generated RST files
Currently including `zh_CN` and `es` which both have very high completion
ratios. Others will be added once they reach a significant percentage too.

These RST files will be used by godot-docs in place of its `classes` folder
after we sync with https://github.com/godotengine/godot-docs/pull/5458.

The update workflow is manual for now (example for `zh_CN`):

- Build `godotengine/godot` in the branch we currently track (now `3.x`)
- Run `godot --doctool -l zh_CN`
- Run `cd doc && make rst LANGARG=zh_CN`
- Copy `doc/_build/rst/*` to `classes/zh_CN/` here
- Make sure to have `classes/zh_CN/index.rst` copied from `docs/classes`
2021-12-21 16:07:55 +01:00

63 lines
3.3 KiB
ReStructuredText

: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>`
Estado de una llamada de función después de ceder.
Descripción
----------------------
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.
Métodos
--------------
+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :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 **)** |
+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
Señales
--------------
.. _class_GDScriptFunctionState_signal_completed:
- **completed** **(** :ref:`Variant<class_Variant>` result **)**
Descripciones de Métodos
------------------------------------------------
.. _class_GDScriptFunctionState_method_is_valid:
- :ref:`bool<class_bool>` **is_valid** **(** :ref:`bool<class_bool>` extended_check=false **)** |const|
Comprueba si se puede reanudar la llamada de función. No es así si el estado de la función ya se ha reanudado.
Si ``extended_check`` está activado, también comprueba si el script y el objeto asociados siguen existiendo. La comprobación extendida se realiza en modo de depuración como parte del :ref:`resume<class_GDScriptFunctionState_method_resume>`, pero puedes utilizarlo si sabes que puedes estar intentando reanudar sin saber con seguridad que el objeto y/o el script han sobrevivido hasta ese momento.
----
.. _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.)`