pandemonium_engine/modules/cscript/doc_classes/CScript.xml

36 lines
1.2 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="CScript" inherits="Script" version="4.1">
<brief_description>
A script implemented in the CScript programming language.
</brief_description>
<description>
A script implemented in the CScript 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>$DOCS_URL/tutorials/scripting/gdscript/index.md</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>