diff options
| author | Juan Linietsky | 2017-09-12 17:42:36 -0300 |
|---|---|---|
| committer | Juan Linietsky | 2017-09-12 17:45:41 -0300 |
| commit | 4f929a0fdfae24b1ca5acf0b732219119090ee43 (patch) | |
| tree | 730471182cae00f2e47c7430db441d057383d29b /doc/classes/Script.xml | |
| parent | 175777596ec3521731665dd750fd7087793b10fc (diff) | |
| download | godot-4f929a0fdfae24b1ca5acf0b732219119090ee43.tar.gz godot-4f929a0fdfae24b1ca5acf0b732219119090ee43.tar.zst godot-4f929a0fdfae24b1ca5acf0b732219119090ee43.zip | |
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will
recognize them.
Diffstat (limited to 'doc/classes/Script.xml')
| -rw-r--r-- | doc/classes/Script.xml | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/doc/classes/Script.xml b/doc/classes/Script.xml new file mode 100644 index 000000000..307afba8a --- /dev/null +++ b/doc/classes/Script.xml @@ -0,0 +1,88 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Script" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + A class stored as a resource. + </brief_description> + <description> + A class stored as a resource. The script exends the functionality of all objects that instance it. + The 'new' method of a script subclass creates a new instance. [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="can_instance" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns true if the script can be instanced. + </description> + </method> + <method name="get_node_type" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_source_code" qualifiers="const"> + <return type="String"> + </return> + <description> + Returns the script source code, or an empty string if source code is not available. + </description> + </method> + <method name="has_script_signal" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="signal_name" type="String"> + </argument> + <description> + Returns true if the script, or a base class, defines a signal with the given name. + </description> + </method> + <method name="has_source_code" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns true if the script contains non-empty source code. + </description> + </method> + <method name="instance_has" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="base_object" type="Object"> + </argument> + <description> + Returns true if 'base_object' is an instance of this script. + </description> + </method> + <method name="is_tool" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns true if the script is a tool script. A tool script can run in the editor. + </description> + </method> + <method name="reload"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="keep_state" type="bool" default="false"> + </argument> + <description> + Reloads the script's class implementation. Returns an error code. + </description> + </method> + <method name="set_source_code"> + <return type="void"> + </return> + <argument index="0" name="source" type="String"> + </argument> + <description> + Sets the script source code. Does not reload the class implementation. + </description> + </method> + </methods> + <constants> + </constants> +</class> |