2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2021-04-26 13:14:51 +02:00
<class name= "Script" inherits= "Resource" version= "3.4" >
2017-09-12 22:42:36 +02:00
<brief_description >
A class stored as a resource.
</brief_description>
<description >
2019-11-30 19:15:06 +01:00
A class stored as a resource. A script extends the functionality of all objects that instance it.
2018-09-01 20:07:51 +02:00
The [code]new[/code] 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.
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
2021-03-26 10:43:43 +01:00
<link > https://docs.godotengine.org/en/3.3/getting_started/step_by_step/scripting.html</link>
2017-09-12 22:42:36 +02:00
</tutorials>
<methods >
<method name= "can_instance" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "bool" />
2017-09-12 22:42:36 +02:00
<description >
2018-09-01 20:07:51 +02:00
Returns [code]true[/code] if the script can be instanced.
2017-09-12 22:42:36 +02:00
</description>
</method>
2017-12-20 17:16:02 +01:00
<method name= "get_base_script" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "Script" />
2017-12-20 17:16:02 +01:00
<description >
2018-04-17 16:18:57 +02:00
Returns the script directly inherited by this script.
2017-12-20 17:16:02 +01:00
</description>
</method>
<method name= "get_instance_base_type" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "String" />
2017-12-20 17:16:02 +01:00
<description >
2018-09-01 20:07:51 +02:00
Returns the script's base type.
2017-12-20 17:16:02 +01:00
</description>
</method>
2019-09-24 11:44:48 +02:00
<method name= "get_property_default_value" >
2021-07-30 15:28:05 +02:00
<return type= "Variant" />
<argument index= "0" name= "property" type= "String" />
2019-09-24 11:44:48 +02:00
<description >
2020-03-03 19:21:21 +01:00
Returns the default value of the specified property.
2019-09-24 11:44:48 +02:00
</description>
</method>
<method name= "get_script_constant_map" >
2021-07-30 15:28:05 +02:00
<return type= "Dictionary" />
2019-09-24 11:44:48 +02:00
<description >
2020-03-03 19:21:21 +01:00
Returns a dictionary containing constant names and their values.
2019-09-24 11:44:48 +02:00
</description>
</method>
<method name= "get_script_method_list" >
2021-07-30 15:28:05 +02:00
<return type= "Array" />
2019-09-24 11:44:48 +02:00
<description >
2020-03-03 19:21:21 +01:00
Returns the list of methods in this [Script].
2019-09-24 11:44:48 +02:00
</description>
</method>
<method name= "get_script_property_list" >
2021-07-30 15:28:05 +02:00
<return type= "Array" />
2019-09-24 11:44:48 +02:00
<description >
2020-03-03 19:21:21 +01:00
Returns the list of properties in this [Script].
2019-09-24 11:44:48 +02:00
</description>
</method>
<method name= "get_script_signal_list" >
2021-07-30 15:28:05 +02:00
<return type= "Array" />
2019-09-24 11:44:48 +02:00
<description >
2020-03-03 19:21:21 +01:00
Returns the list of user signals defined in this [Script].
2019-09-24 11:44:48 +02:00
</description>
</method>
2017-09-12 22:42:36 +02:00
<method name= "has_script_signal" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "bool" />
<argument index= "0" name= "signal_name" type= "String" />
2017-09-12 22:42:36 +02:00
<description >
2018-09-01 20:07:51 +02:00
Returns [code]true[/code] if the script, or a base class, defines a signal with the given name.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "has_source_code" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "bool" />
2017-09-12 22:42:36 +02:00
<description >
2018-09-01 20:07:51 +02:00
Returns [code]true[/code] if the script contains non-empty source code.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "instance_has" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "bool" />
<argument index= "0" name= "base_object" type= "Object" />
2017-09-12 22:42:36 +02:00
<description >
2018-09-01 20:07:51 +02:00
Returns [code]true[/code] if [code]base_object[/code] is an instance of this script.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "is_tool" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "bool" />
2017-09-12 22:42:36 +02:00
<description >
2018-09-01 20:07:51 +02:00
Returns [code]true[/code] if the script is a tool script. A tool script can run in the editor.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "reload" >
2021-07-30 15:28:05 +02:00
<return type= "int" enum= "Error" />
<argument index= "0" name= "keep_state" type= "bool" default= "false" />
2017-09-12 22:42:36 +02:00
<description >
Reloads the script's class implementation. Returns an error code.
</description>
</method>
</methods>
2018-01-11 23:38:35 +01:00
<members >
<member name= "source_code" type= "String" setter= "set_source_code" getter= "get_source_code" >
2018-09-01 20:07:51 +02:00
The script source code or an empty string if source code is not available. When set, does not reload the class implementation automatically.
2018-01-11 23:38:35 +01:00
</member>
</members>
2017-09-12 22:42:36 +02:00
<constants >
</constants>
</class>