summaryrefslogtreecommitdiff
path: root/modules/gdscript/doc_classes/GDScript.xml
blob: 5acb29e74823d62cb6e526a1855112cbe8b793b3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GDScript" inherits="Script" version="4.0">
	<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 title="GDScript documentation index">$DOCS_URL/tutorials/scripting/gdscript/index.html</link>
	</tutorials>
	<methods>
		<method name="get_as_byte_code" qualifiers="const">
			<return type="PackedByteArray" />
			<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>
</class>