diff options
| author | Rémi Verschelde | 2017-11-16 18:38:18 +0100 |
|---|---|---|
| committer | Rémi Verschelde | 2017-11-16 18:54:56 +0100 |
| commit | 4cfc29611e21811065d024a6de1685418e60111e (patch) | |
| tree | 3d2b10ebd4d18b88709a49391cf6265185149d56 /modules/gdscript/doc_classes/GDFunctionState.xml | |
| parent | 2070b80fc05d581fc8f44ba231fc728136877828 (diff) | |
| download | godot-4cfc29611e21811065d024a6de1685418e60111e.tar.gz godot-4cfc29611e21811065d024a6de1685418e60111e.tar.zst godot-4cfc29611e21811065d024a6de1685418e60111e.zip | |
GDScript: Refactor "GD" class prefix to "GDScript"
Diffstat (limited to 'modules/gdscript/doc_classes/GDFunctionState.xml')
| -rw-r--r-- | modules/gdscript/doc_classes/GDFunctionState.xml | 46 |
1 files changed, 0 insertions, 46 deletions
diff --git a/modules/gdscript/doc_classes/GDFunctionState.xml b/modules/gdscript/doc_classes/GDFunctionState.xml deleted file mode 100644 index e1aafa8a5..000000000 --- a/modules/gdscript/doc_classes/GDFunctionState.xml +++ /dev/null @@ -1,46 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="GDFunctionState" inherits="Reference" category="Core" version="3.0-alpha"> - <brief_description> - State of a function call after yielding. - </brief_description> - <description> - Calling [method @GDScript.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 [method resume] on this state object. - </description> - <tutorials> - </tutorials> - <demos> - </demos> - <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 GDFunctionState.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 [method @GDScript.yield] 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="Nil"> - </argument> - <description> - </description> - </signal> - </signals> - <constants> - </constants> -</class> |