Script #

const func can_instantiate() -> bool#

Returns true if the script can be instantiated.

const func get_base_script() -> Script#

Returns the script directly inherited by this script.

const func get_global_name() -> StringName#

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 class_name keyword in GDScript and the GlobalClass attribute in C#.

GDScript

class_name MyNode
extends Node

C#

using Godot;

[GlobalClass]
public partial class MyNode : Node
{
}

const func get_instance_base_type() -> StringName#

Returns the script's base type.

func get_property_default_value(property: StringName) -> Variant#

Returns the default value of the specified property.

const func get_rpc_config() -> Variant#

Returns a Dictionary mapping method names to their RPC configuration defined by this script.

func get_script_constant_map() -> Dictionary#

Returns a dictionary containing constant names and their values.

func get_script_method_list() -> Dictionary[]#

Returns the list of methods in this Script.

func get_script_property_list() -> Dictionary[]#

Returns the list of properties in this Script.

func get_script_signal_list() -> Dictionary[]#

Returns the list of user signals defined in this Script.

const func has_script_signal(signal_name: StringName) -> bool#

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

const func has_source_code() -> bool#

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 GDScript 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.

const func instance_has(base_object: Object) -> bool#

Returns true if base_object is an instance of this script.

const func is_abstract() -> bool#

Returns true if the script is an abstract script. An abstract script does not have a constructor and cannot be instantiated.

const func is_tool() -> bool#

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

func reload(keep_state: bool = false) -> intError#

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