You've already forked godot
mirror of
https://github.com/godotengine/godot.git
synced 2025-11-07 12:30:27 +00:00
f5836b40d4
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
(cherry picked from commit 7adf4cc9b5)
36 lines
1.2 KiB
XML
36 lines
1.2 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="GDScript" inherits="Script" version="3.4">
|
|
<brief_description>
|
|
A script implemented in the GDScript programming language.
|
|
</brief_description>
|
|
<description>
|
|
A script implemented in the GDScript programming language. The script extends 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>
|
|
<link>https://docs.godotengine.org/en/3.3/getting_started/scripting/gdscript/index.html</link>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="get_as_byte_code" qualifiers="const">
|
|
<return type="PoolByteArray" />
|
|
<description>
|
|
Returns byte code for the script source code.
|
|
</description>
|
|
</method>
|
|
<method name="new" qualifiers="vararg">
|
|
<return type="Variant" />
|
|
<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>
|