diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2020-11-27 08:28:27 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-11-27 08:28:27 +0100 |
| commit | a1680ffc98221458b7dc34f72592f202ab3d8536 (patch) | |
| tree | 2c32d91fe94760027bc7359729040cb22c0e421e /modules/gdscript/doc_classes/GDScriptFunctionState.xml | |
| parent | ed2f84735b0fe6b75c823716426d62e6b80e7ae3 (diff) | |
| parent | fbb806fd68c9ce6d49228d67e0c09eb381b7c621 (diff) | |
Merge pull request #43905 from vnen/gdscript-unregister-function-state
Unregister GDScriptFunctionState class
Diffstat (limited to 'modules/gdscript/doc_classes/GDScriptFunctionState.xml')
| -rw-r--r-- | modules/gdscript/doc_classes/GDScriptFunctionState.xml | 45 |
1 files changed, 0 insertions, 45 deletions
diff --git a/modules/gdscript/doc_classes/GDScriptFunctionState.xml b/modules/gdscript/doc_classes/GDScriptFunctionState.xml deleted file mode 100644 index 5e369b32d9..0000000000 --- a/modules/gdscript/doc_classes/GDScriptFunctionState.xml +++ /dev/null @@ -1,45 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="GDScriptFunctionState" inherits="Reference" version="4.0"> - <brief_description> - State of a function call after yielding. - </brief_description> - <description> - FIXME: Outdated docs as of GDScript rewrite in 4.0. - Calling [code]yield[/code] 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 [method resume] on this state object. - </description> - <tutorials> - </tutorials> - <methods> - <method name="is_valid" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="extended_check" type="bool" default="false"> - </argument> - <description> - Check whether the function call may be resumed. This is not the case if the function state was already resumed. - If [code]extended_check[/code] is enabled, it also checks if the associated script and object still exist. The extended check is done in debug mode as part of [method GDScriptFunctionState.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. - </description> - </method> - <method name="resume"> - <return type="Variant"> - </return> - <argument index="0" name="arg" type="Variant" default="null"> - </argument> - <description> - Resume execution of the yielded function call. - If handed an argument, return the argument from the [code]yield[/code] call in the yielded function call. You can pass e.g. an [Array] to hand multiple arguments. - This function returns what the resumed function call returns, possibly another function state if yielded again. - </description> - </method> - </methods> - <signals> - <signal name="completed"> - <argument index="0" name="result" type="Variant"> - </argument> - <description> - </description> - </signal> - </signals> - <constants> - </constants> -</class> |