:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/4.3/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/4.3/doc/classes/Script.xml. .. _class_Script: Script ====== **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` **Inherited By:** :ref:`CSharpScript`, :ref:`GDScript`, :ref:`ScriptExtension` A class stored as a resource. .. rst-class:: classref-introduction-group 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. :ref:`Object.set_script` extends an existing object, if that object's class matches one of the script's base classes. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`Scripting documentation index <../tutorials/scripting/index>` .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------+-------------------------------------------------------+ | :ref:`String` | :ref:`source_code` | +-----------------------------+-------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`can_instantiate`\ (\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Script` | :ref:`get_base_script`\ (\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StringName` | :ref:`get_global_name`\ (\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StringName` | :ref:`get_instance_base_type`\ (\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get_property_default_value`\ (\ property\: :ref:`StringName`\ ) | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_script_constant_map`\ (\ ) | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_script_method_list`\ (\ ) | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_script_property_list`\ (\ ) | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_script_signal_list`\ (\ ) | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_script_signal`\ (\ signal_name\: :ref:`StringName`\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_source_code`\ (\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`instance_has`\ (\ base_object\: :ref:`Object`\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_abstract`\ (\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_tool`\ (\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`reload`\ (\ keep_state\: :ref:`bool` = false\ ) | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_Script_property_source_code: .. rst-class:: classref-property :ref:`String` **source_code** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_source_code**\ (\ value\: :ref:`String`\ ) - :ref:`String` **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. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_Script_method_can_instantiate: .. rst-class:: classref-method :ref:`bool` **can_instantiate**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the script can be instantiated. .. rst-class:: classref-item-separator ---- .. _class_Script_method_get_base_script: .. rst-class:: classref-method :ref:`Script` **get_base_script**\ (\ ) |const| :ref:`🔗` Returns the script directly inherited by this script. .. rst-class:: classref-item-separator ---- .. _class_Script_method_get_global_name: .. rst-class:: classref-method :ref:`StringName` **get_global_name**\ (\ ) |const| :ref:`🔗` 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#. .. tabs:: .. code-tab:: gdscript class_name MyNode extends Node .. code-tab:: csharp using Godot; [GlobalClass] public partial class MyNode : Node { } .. rst-class:: classref-item-separator ---- .. _class_Script_method_get_instance_base_type: .. rst-class:: classref-method :ref:`StringName` **get_instance_base_type**\ (\ ) |const| :ref:`🔗` Returns the script's base type. .. rst-class:: classref-item-separator ---- .. _class_Script_method_get_property_default_value: .. rst-class:: classref-method :ref:`Variant` **get_property_default_value**\ (\ property\: :ref:`StringName`\ ) :ref:`🔗` Returns the default value of the specified property. .. rst-class:: classref-item-separator ---- .. _class_Script_method_get_script_constant_map: .. rst-class:: classref-method :ref:`Dictionary` **get_script_constant_map**\ (\ ) :ref:`🔗` Returns a dictionary containing constant names and their values. .. rst-class:: classref-item-separator ---- .. _class_Script_method_get_script_method_list: .. rst-class:: classref-method :ref:`Array`\[:ref:`Dictionary`\] **get_script_method_list**\ (\ ) :ref:`🔗` Returns the list of methods in this **Script**. .. rst-class:: classref-item-separator ---- .. _class_Script_method_get_script_property_list: .. rst-class:: classref-method :ref:`Array`\[:ref:`Dictionary`\] **get_script_property_list**\ (\ ) :ref:`🔗` Returns the list of properties in this **Script**. .. rst-class:: classref-item-separator ---- .. _class_Script_method_get_script_signal_list: .. rst-class:: classref-method :ref:`Array`\[:ref:`Dictionary`\] **get_script_signal_list**\ (\ ) :ref:`🔗` Returns the list of user signals defined in this **Script**. .. rst-class:: classref-item-separator ---- .. _class_Script_method_has_script_signal: .. rst-class:: classref-method :ref:`bool` **has_script_signal**\ (\ signal_name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if the script, or a base class, defines a signal with the given name. .. rst-class:: classref-item-separator ---- .. _class_Script_method_has_source_code: .. rst-class:: classref-method :ref:`bool` **has_source_code**\ (\ ) |const| :ref:`🔗` 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 :ref:`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 :ref:`can_instantiate`. .. rst-class:: classref-item-separator ---- .. _class_Script_method_instance_has: .. rst-class:: classref-method :ref:`bool` **instance_has**\ (\ base_object\: :ref:`Object`\ ) |const| :ref:`🔗` Returns ``true`` if ``base_object`` is an instance of this script. .. rst-class:: classref-item-separator ---- .. _class_Script_method_is_abstract: .. rst-class:: classref-method :ref:`bool` **is_abstract**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the script is an abstract script. An abstract script does not have a constructor and cannot be instantiated. .. rst-class:: classref-item-separator ---- .. _class_Script_method_is_tool: .. rst-class:: classref-method :ref:`bool` **is_tool**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the script is a tool script. A tool script can run in the editor. .. rst-class:: classref-item-separator ---- .. _class_Script_method_reload: .. rst-class:: classref-method :ref:`Error` **reload**\ (\ keep_state\: :ref:`bool` = false\ ) :ref:`🔗` Reloads the script's class implementation. Returns an error code. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`