From 677e95d8d189a62e6473b43989012a8258f193a4 Mon Sep 17 00:00:00 2001
From: Rémi Verschelde
Date: Wed, 15 Nov 2017 19:23:20 +0100
Subject: doc: Make all module docs self-contained
---
modules/gdscript/doc_classes/GDFunctionState.xml | 46 ++++++++++++++++++++++++
modules/gdscript/doc_classes/GDNativeClass.xml | 21 +++++++++++
modules/gdscript/doc_classes/GDScript.xml | 38 ++++++++++++++++++++
3 files changed, 105 insertions(+)
create mode 100644 modules/gdscript/doc_classes/GDFunctionState.xml
create mode 100644 modules/gdscript/doc_classes/GDNativeClass.xml
create mode 100644 modules/gdscript/doc_classes/GDScript.xml
(limited to 'modules/gdscript/doc_classes')
diff --git a/modules/gdscript/doc_classes/GDFunctionState.xml b/modules/gdscript/doc_classes/GDFunctionState.xml
new file mode 100644
index 000000000..e1aafa8a5
--- /dev/null
+++ b/modules/gdscript/doc_classes/GDFunctionState.xml
@@ -0,0 +1,46 @@
+
+
+
+ State of a function call after yielding.
+
+
+ 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.
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/modules/gdscript/doc_classes/GDNativeClass.xml b/modules/gdscript/doc_classes/GDNativeClass.xml
new file mode 100644
index 000000000..95789e1b6
--- /dev/null
+++ b/modules/gdscript/doc_classes/GDNativeClass.xml
@@ -0,0 +1,21 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/modules/gdscript/doc_classes/GDScript.xml b/modules/gdscript/doc_classes/GDScript.xml
new file mode 100644
index 000000000..13d45aa52
--- /dev/null
+++ b/modules/gdscript/doc_classes/GDScript.xml
@@ -0,0 +1,38 @@
+
+
+
+ A script implemented in the GDScript programming language.
+
+
+ A script implemented in the GDScript programming language. The script exends the functionality of all objects that instance it.
+ [method new] creates a new instance of the script. [method Object.set_script] extends an existing object, if that object's class matches one of the script's base classes.
+
+
+
+
+
+
+
+
+
+
+ Returns byte code for the script source code.
+
+
+
+
+
+
+ Returns a new instance of the script.
+ For example:
+ [codeblock]
+ var MyClass = load("myclass.gd")
+ var instance = MyClass.new()
+ assert(instance.get_script() == MyClass)
+ [/codeblock]
+
+
+
+
+
+
--
cgit v1.2.3-70-g09d2