Description¶

A class stored as a resource. A script extends the functionality of all objects that instance it.

Thenew method of a script subclass creates a new instance.Object.set_script extends an existing object, if that object's class matches one of the script's base classes.

Tutorials¶

• Scripting

Properties¶

Methods¶

Property Descriptions¶

• Stringsource_code

The script source code or an empty string if source code is not available. When set, does not reload the class implementation automatically.

Method Descriptions¶

• boolcan_instance()const

Returnstrue if the script can be instanced.

• Scriptget_base_script()const

Returns the script directly inherited by this script.

• Stringget_instance_base_type()const

Returns the script's base type.

• Variantget_property_default_value(String property)

Returns the default value of the specified property.

• Dictionaryget_script_constant_map()

Returns a dictionary containing constant names and their values.

• Arrayget_script_method_list()

Returns the list of methods in thisScript.

• Arrayget_script_property_list()

Returns the list of properties in thisScript.

• Arrayget_script_signal_list()

Returns the list of user signals defined in thisScript.

• boolhas_script_signal(String signal_name)const

Returnstrue if the script, or a base class, defines a signal with the given name.

• boolhas_source_code()const

Returnstrue if the script contains non-empty source code.

• boolinstance_has(Object base_object)const

Returnstrue ifbase_object is an instance of this script.

• boolis_tool()const

Returnstrue if the script is a tool script. A tool script can run in the editor.

• Errorreload(bool keep_state=false)

Reloads the script's class implementation. Returns an error code.