Script

Inherits: Resource < Reference < Object Inherited By: CSharpScript, GDScript, NativeScript, PluginScript, VisualScript A class stored as a resource.

Description

A class stored as a resource. A script extends the functionality of all objects that instance it. 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.

Tutorials

  • Scripting

    Properties

    Methods

    Property Descriptions

  • String 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 true if the script can be instanced.
  • Script get_base_script ( ) const Returns the script directly inherited by this script.
  • String get_instance_base_type ( ) const Returns the script’s base type.
  • Variant get_property_default_value ( String property ) Returns the default value of the specified property.
  • Dictionary get_script_constant_map ( ) Returns a dictionary containing constant names and their values.
  • Array get_script_method_list ( ) Script.
  • Array get_script_property_list ( ) Script.
  • Array get_script_signal_list ( ) Script.
  • bool has_script_signal ( String signal_name ) const true if the script, or a base class, defines a signal with the given name.
  • bool has_source_code ( ) const true if the script contains non-empty source code.
  • bool instance_has ( Object base_object ) const true if base_object is an instance of this script.
  • bool is_tool ( ) const true if the script is a tool script. A tool script can run in the editor.
  • Error reload ( bool keep_state=false ) Reloads the script’s class implementation. Returns an error code.