Script

    Inherited By: , GDScript, , PluginScript,

    A class stored as a resource.

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

    The 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

    Methods

    • 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

    • bool can_instance ( ) const
    • get_base_script ( ) const

    Returns the script directly inherited by this script.

    • String get_instance_base_type ( ) const

    Returns the script’s base type.

    • get_property_default_value ( String property )

    Returns the default value of the specified property.

    • get_script_constant_map ( )

    Returns a dictionary containing constant names and their values.

    Returns the list of methods in this Script.

    • Array get_script_property_list ( )
    • get_script_signal_list ( )

    Returns the list of user signals defined in this Script.

    • bool has_script_signal ( signal_name ) const

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

    • bool has_source_code ( ) const

    Returns if the script contains non-empty source code.

    • instance_has ( Object base_object ) const

    Returns true if base_object is an instance of this script.

    • is_tool ( ) const

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