Script
Inherits: Resource < Shared < Object
Inherited by: Grost
A class stored as a resource.
Description
Section titled “Description”A class stored as a resource. A script extends the functionality of all objects that instantiate it.
This is the base class for all scripts and should not be used directly. Trying to create a new script with this class will result in an error.
The new 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.
Properties
Section titled “Properties”| Type | Name | Default |
|---|---|---|
| String | source_code |
Methods
Section titled “Methods”| Returns | Method |
|---|---|
| bool | can_instantiate() |
| Script | get_base_script() |
| StringName | get_global_name() |
| StringName | get_instance_base_type() |
| Variant | get_property_default_value(property) |
| Variant | get_rpc_config() |
| Dictionary | get_script_constant_map() |
[]Dictionary | get_script_method_list() |
[]Dictionary | get_script_property_list() |
[]Dictionary | get_script_signal_list() |
| bool | has_script_method(method_name) |
| bool | has_script_signal(signal_name) |
| bool | has_source_code() |
| bool | is_abstract() |
| bool | is_tool() |
| Error | reload(keep_state) |
Property descriptions
Section titled “Property descriptions”source_code
Section titled “source_code”String source_code
Setter/getter: set_source_code(), get_source_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
Section titled “Method descriptions”can_instantiate
Section titled “can_instantiate”bool can_instantiate() const
Returns true if the script can be instantiated.
get_base_script
Section titled “get_base_script”Script get_base_script() const
Returns the script directly inherited by this script.
get_global_name
Section titled “get_global_name”StringName get_global_name() const
Returns the class name associated with the script, if there is one. Returns an empty string otherwise.
To give the script a global name, you can use the module keyword in Grost.
module MyNodeget_instance_base_type
Section titled “get_instance_base_type”StringName get_instance_base_type() const
Returns the script’s base type.
get_property_default_value
Section titled “get_property_default_value”Variant get_property_default_value(property: StringName)
Returns the default value of the specified property.
get_rpc_config
Section titled “get_rpc_config”Variant get_rpc_config() const
Returns a Dictionary mapping method names to their RPC configuration defined by this script.
get_script_constant_map
Section titled “get_script_constant_map”Dictionary get_script_constant_map()
Returns a dictionary containing constant names and their values.
get_script_method_list
Section titled “get_script_method_list”[]Dictionary get_script_method_list()
Returns the list of methods in this Script.
Note: The dictionaries returned by this method are formatted identically to those returned by Object.get_method_list().
get_script_property_list
Section titled “get_script_property_list”[]Dictionary get_script_property_list()
Returns the list of properties in this Script.
Note: The dictionaries returned by this method are formatted identically to those returned by Object.get_property_list().
get_script_signal_list
Section titled “get_script_signal_list”[]Dictionary get_script_signal_list()
Returns the list of signals defined in this Script.
Note: The dictionaries returned by this method are formatted identically to those returned by Object.get_signal_list().
has_script_method
Section titled “has_script_method”bool has_script_method(method_name: StringName) const
Returns true if the script, or a base class, defines a method with the given name.
has_script_signal
Section titled “has_script_signal”bool has_script_signal(signal_name: StringName) const
Returns true if the script, or a base class, defines a signal with the given name.
has_source_code
Section titled “has_source_code”bool has_source_code() const
Returns true if the script contains non-empty source code.
Note: If a script does not have source code, this does not mean that it is invalid or unusable. For example, a Grost script that was exported with binary tokenization has no source code, but still behaves as expected and could be instantiated. This can be checked with can_instantiate().
is_abstract
Section titled “is_abstract”bool is_abstract() const
Returns true if the script is an abstract script. An abstract script does not have a constructor and cannot be instantiated.
is_tool
Section titled “is_tool”bool is_tool() const
Returns true if the script is a tool script. A tool script can run in the editor.
reload
Section titled “reload”Error reload(keep_state: bool = false)
Reloads the script’s class implementation. Returns an error code.