diff options
| author | Rémi Verschelde | 2017-11-15 21:54:21 +0100 |
|---|---|---|
| committer | GitHub | 2017-11-15 21:54:21 +0100 |
| commit | c7f7dd3e3e3592264a05e0dc7ee5f1ea37fad738 (patch) | |
| tree | a22a88d22bd079a8404150fbf5b870df6046240e /modules/gdscript/doc_classes/GDScript.xml | |
| parent | 4d08e7c4204ff3fa0e17e0de7e5a08ef03968202 (diff) | |
| parent | 11e07d18bd80c0b7d8836698d98e058750e33660 (diff) | |
| download | godot-c7f7dd3e3e3592264a05e0dc7ee5f1ea37fad738.tar.gz godot-c7f7dd3e3e3592264a05e0dc7ee5f1ea37fad738.tar.zst godot-c7f7dd3e3e3592264a05e0dc7ee5f1ea37fad738.zip | |
Merge pull request #12954 from akien-mga/docs
Make module docs self-contained and various improvements
Diffstat (limited to 'modules/gdscript/doc_classes/GDScript.xml')
| -rw-r--r-- | modules/gdscript/doc_classes/GDScript.xml | 38 |
1 files changed, 38 insertions, 0 deletions
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 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="GDScript" inherits="Script" category="Core" version="3.0-alpha"> + <brief_description> + A script implemented in the GDScript programming language. + </brief_description> + <description> + 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. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_as_byte_code" qualifiers="const"> + <return type="PoolByteArray"> + </return> + <description> + Returns byte code for the script source code. + </description> + </method> + <method name="new" qualifiers="vararg"> + <return type="Object"> + </return> + <description> + 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] + </description> + </method> + </methods> + <constants> + </constants> +</class> |