Merge pull request #43905 from vnen/gdscript-unregister-function-state
Unregister GDScriptFunctionState class
This commit is contained in:
commit
a1680ffc98
3 changed files with 0 additions and 47 deletions
|
@ -10,7 +10,6 @@ def get_doc_classes():
|
|||
return [
|
||||
"@GDScript",
|
||||
"GDScript",
|
||||
"GDScriptFunctionState",
|
||||
]
|
||||
|
||||
|
||||
|
|
|
@ -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>
|
|
@ -112,7 +112,6 @@ static void _editor_init() {
|
|||
|
||||
void register_gdscript_types() {
|
||||
ClassDB::register_class<GDScript>();
|
||||
ClassDB::register_virtual_class<GDScriptFunctionState>();
|
||||
|
||||
script_language_gd = memnew(GDScriptLanguage);
|
||||
ScriptServer::register_language(script_language_gd);
|
||||
|
|
Loading…
Reference in a new issue