godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (705b7a0)

Browse Source
This commit is contained in:
Godot Organization
2024-05-31 13:54:35 +00:00
parent 32f1b6ea48
commit eacfba2716
835 changed files with 17350 additions and 17256 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
classes/class_script.rst
View File

@@ -99,7 +99,7 @@ Property Descriptions
.. rst-class:: classref-property
:ref:`String<class_String>` **source_code**
:ref:`String<class_String>` **source_code** :ref:`🔗<class_Script_property_source_code>`
.. rst-class:: classref-property-setget
@@ -121,7 +121,7 @@ Method Descriptions
.. rst-class:: classref-method
:ref:`bool<class_bool>` **can_instantiate**\ (\ ) |const|
:ref:`bool<class_bool>` **can_instantiate**\ (\ ) |const| :ref:`🔗<class_Script_method_can_instantiate>`
Returns ``true`` if the script can be instantiated.
@@ -133,7 +133,7 @@ Returns ``true`` if the script can be instantiated.
.. rst-class:: classref-method
:ref:`Script<class_Script>` **get_base_script**\ (\ ) |const|
:ref:`Script<class_Script>` **get_base_script**\ (\ ) |const| :ref:`🔗<class_Script_method_get_base_script>`
Returns the script directly inherited by this script.
@@ -145,7 +145,7 @@ Returns the script directly inherited by this script.
.. rst-class:: classref-method
:ref:`StringName<class_StringName>` **get_global_name**\ (\ ) |const|
:ref:`StringName<class_StringName>` **get_global_name**\ (\ ) |const| :ref:`🔗<class_Script_method_get_global_name>`
Returns the class name associated with the script, if there is one. Returns an empty string otherwise.
@@ -178,7 +178,7 @@ To give the script a global name, you can use the ``class_name`` keyword in GDSc
.. rst-class:: classref-method
:ref:`StringName<class_StringName>` **get_instance_base_type**\ (\ ) |const|
:ref:`StringName<class_StringName>` **get_instance_base_type**\ (\ ) |const| :ref:`🔗<class_Script_method_get_instance_base_type>`
Returns the script's base type.
@@ -190,7 +190,7 @@ Returns the script's base type.
.. rst-class:: classref-method
:ref:`Variant<class_Variant>` **get_property_default_value**\ (\ property\: :ref:`StringName<class_StringName>`\ )
:ref:`Variant<class_Variant>` **get_property_default_value**\ (\ property\: :ref:`StringName<class_StringName>`\ ) :ref:`🔗<class_Script_method_get_property_default_value>`
Returns the default value of the specified property.
@@ -202,7 +202,7 @@ Returns the default value of the specified property.
.. rst-class:: classref-method
:ref:`Dictionary<class_Dictionary>` **get_script_constant_map**\ (\ )
:ref:`Dictionary<class_Dictionary>` **get_script_constant_map**\ (\ ) :ref:`🔗<class_Script_method_get_script_constant_map>`
Returns a dictionary containing constant names and their values.
@@ -214,7 +214,7 @@ Returns a dictionary containing constant names and their values.
.. rst-class:: classref-method
:ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **get_script_method_list**\ (\ )
:ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **get_script_method_list**\ (\ ) :ref:`🔗<class_Script_method_get_script_method_list>`
Returns the list of methods in this **Script**.
@@ -226,7 +226,7 @@ Returns the list of methods in this **Script**.
.. rst-class:: classref-method
:ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **get_script_property_list**\ (\ )
:ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **get_script_property_list**\ (\ ) :ref:`🔗<class_Script_method_get_script_property_list>`
Returns the list of properties in this **Script**.
@@ -238,7 +238,7 @@ Returns the list of properties in this **Script**.
.. rst-class:: classref-method
:ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **get_script_signal_list**\ (\ )
:ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **get_script_signal_list**\ (\ ) :ref:`🔗<class_Script_method_get_script_signal_list>`
Returns the list of user signals defined in this **Script**.
@@ -250,7 +250,7 @@ Returns the list of user signals defined in this **Script**.
.. rst-class:: classref-method
:ref:`bool<class_bool>` **has_script_signal**\ (\ signal_name\: :ref:`StringName<class_StringName>`\ ) |const|
:ref:`bool<class_bool>` **has_script_signal**\ (\ signal_name\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`🔗<class_Script_method_has_script_signal>`
Returns ``true`` if the script, or a base class, defines a signal with the given name.
@@ -262,7 +262,7 @@ Returns ``true`` if the script, or a base class, defines a signal with the given
.. rst-class:: classref-method
:ref:`bool<class_bool>` **has_source_code**\ (\ ) |const|
:ref:`bool<class_bool>` **has_source_code**\ (\ ) |const| :ref:`🔗<class_Script_method_has_source_code>`
Returns ``true`` if the script contains non-empty source code.
@@ -274,7 +274,7 @@ Returns ``true`` if the script contains non-empty source code.
.. rst-class:: classref-method
:ref:`bool<class_bool>` **instance_has**\ (\ base_object\: :ref:`Object<class_Object>`\ ) |const|
:ref:`bool<class_bool>` **instance_has**\ (\ base_object\: :ref:`Object<class_Object>`\ ) |const| :ref:`🔗<class_Script_method_instance_has>`
Returns ``true`` if ``base_object`` is an instance of this script.
@@ -286,7 +286,7 @@ Returns ``true`` if ``base_object`` is an instance of this script.
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_abstract**\ (\ ) |const|
:ref:`bool<class_bool>` **is_abstract**\ (\ ) |const| :ref:`🔗<class_Script_method_is_abstract>`
Returns ``true`` if the script is an abstract script. An abstract script does not have a constructor and cannot be instantiated.
@@ -298,7 +298,7 @@ Returns ``true`` if the script is an abstract script. An abstract script does no
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_tool**\ (\ ) |const|
:ref:`bool<class_bool>` **is_tool**\ (\ ) |const| :ref:`🔗<class_Script_method_is_tool>`
Returns ``true`` if the script is a tool script. A tool script can run in the editor.
@@ -310,7 +310,7 @@ Returns ``true`` if the script is a tool script. A tool script can run in the ed
.. rst-class:: classref-method
:ref:`Error<enum_@GlobalScope_Error>` **reload**\ (\ keep_state\: :ref:`bool<class_bool>` = false\ )
:ref:`Error<enum_@GlobalScope_Error>` **reload**\ (\ keep_state\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_Script_method_reload>`
Reloads the script's class implementation. Returns an error code.