mirror of
https://github.com/godotengine/godot-docs-l10n.git
synced 2026-01-02 21:48:52 +03:00
Currently including `zh_CN` and `es` which both have very high completion ratios. Others will be added once they reach a significant percentage too. These RST files will be used by godot-docs in place of its `classes` folder after we sync with https://github.com/godotengine/godot-docs/pull/5458. The update workflow is manual for now (example for `zh_CN`): - Build `godotengine/godot` in the branch we currently track (now `3.x`) - Run `godot --doctool -l zh_CN` - Run `cd doc && make rst LANGARG=zh_CN` - Copy `doc/_build/rst/*` to `classes/zh_CN/` here - Make sure to have `classes/zh_CN/index.rst` copied from `docs/classes`
191 lines
9.5 KiB
ReStructuredText
191 lines
9.5 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the Script.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_Script:
|
|
|
|
Script
|
|
======
|
|
|
|
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
|
|
**Inherited By:** :ref:`CSharpScript<class_CSharpScript>`, :ref:`GDScript<class_GDScript>`, :ref:`NativeScript<class_NativeScript>`, :ref:`PluginScript<class_PluginScript>`, :ref:`VisualScript<class_VisualScript>`
|
|
|
|
Una clase almacenada como recurso.
|
|
|
|
Descripción
|
|
----------------------
|
|
|
|
Una clase almacenada como recurso. Un script extiende la funcionalidad de todos los objetos que lo ejemplifican.
|
|
|
|
El método ``new`` de una subclase de un script crea una nueva instancia. El :ref:`Object.set_script<class_Object_method_set_script>` extiende un objeto existente, si la clase de ese objeto coincide con una de las clases base del script.
|
|
|
|
Tutoriales
|
|
--------------------
|
|
|
|
- :doc:`../tutorials/scripting/index`
|
|
|
|
Propiedades
|
|
----------------------
|
|
|
|
+-----------------------------+-------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`source_code<class_Script_property_source_code>` |
|
|
+-----------------------------+-------------------------------------------------------+
|
|
|
|
Métodos
|
|
--------------
|
|
|
|
+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`can_instance<class_Script_method_can_instance>` **(** **)** |const| |
|
|
+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Script<class_Script>` | :ref:`get_base_script<class_Script_method_get_base_script>` **(** **)** |const| |
|
|
+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`get_instance_base_type<class_Script_method_get_instance_base_type>` **(** **)** |const| |
|
|
+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Variant<class_Variant>` | :ref:`get_property_default_value<class_Script_method_get_property_default_value>` **(** :ref:`String<class_String>` property **)** |
|
|
+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Dictionary<class_Dictionary>` | :ref:`get_script_constant_map<class_Script_method_get_script_constant_map>` **(** **)** |
|
|
+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Array<class_Array>` | :ref:`get_script_method_list<class_Script_method_get_script_method_list>` **(** **)** |
|
|
+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Array<class_Array>` | :ref:`get_script_property_list<class_Script_method_get_script_property_list>` **(** **)** |
|
|
+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Array<class_Array>` | :ref:`get_script_signal_list<class_Script_method_get_script_signal_list>` **(** **)** |
|
|
+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`has_script_signal<class_Script_method_has_script_signal>` **(** :ref:`String<class_String>` signal_name **)** |const| |
|
|
+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`has_source_code<class_Script_method_has_source_code>` **(** **)** |const| |
|
|
+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`instance_has<class_Script_method_instance_has>` **(** :ref:`Object<class_Object>` base_object **)** |const| |
|
|
+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_tool<class_Script_method_is_tool>` **(** **)** |const| |
|
|
+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`reload<class_Script_method_reload>` **(** :ref:`bool<class_bool>` keep_state=false **)** |
|
|
+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Descripciones de Propiedades
|
|
--------------------------------------------------------
|
|
|
|
.. _class_Script_property_source_code:
|
|
|
|
- :ref:`String<class_String>` **source_code**
|
|
|
|
+----------+------------------------+
|
|
| *Setter* | set_source_code(value) |
|
|
+----------+------------------------+
|
|
| *Getter* | get_source_code() |
|
|
+----------+------------------------+
|
|
|
|
El código fuente del script o una string vacía si el código fuente no está disponible. Cuando está configurado, no recarga la implementación de la clase automáticamente.
|
|
|
|
Descripciones de Métodos
|
|
------------------------------------------------
|
|
|
|
.. _class_Script_method_can_instance:
|
|
|
|
- :ref:`bool<class_bool>` **can_instance** **(** **)** |const|
|
|
|
|
Devuelve ``true`` si el script puede ser instanciado.
|
|
|
|
----
|
|
|
|
.. _class_Script_method_get_base_script:
|
|
|
|
- :ref:`Script<class_Script>` **get_base_script** **(** **)** |const|
|
|
|
|
Devuelve el script directamente heredado por este script.
|
|
|
|
----
|
|
|
|
.. _class_Script_method_get_instance_base_type:
|
|
|
|
- :ref:`String<class_String>` **get_instance_base_type** **(** **)** |const|
|
|
|
|
Devuelve el tipo de base del script.
|
|
|
|
----
|
|
|
|
.. _class_Script_method_get_property_default_value:
|
|
|
|
- :ref:`Variant<class_Variant>` **get_property_default_value** **(** :ref:`String<class_String>` property **)**
|
|
|
|
Devuelve el valor por defecto de la propiedad especificada.
|
|
|
|
----
|
|
|
|
.. _class_Script_method_get_script_constant_map:
|
|
|
|
- :ref:`Dictionary<class_Dictionary>` **get_script_constant_map** **(** **)**
|
|
|
|
Devuelve un diccionario que contiene nombres de constantes y sus valores.
|
|
|
|
----
|
|
|
|
.. _class_Script_method_get_script_method_list:
|
|
|
|
- :ref:`Array<class_Array>` **get_script_method_list** **(** **)**
|
|
|
|
Devuelve la lista de métodos en este ``Script``.
|
|
|
|
----
|
|
|
|
.. _class_Script_method_get_script_property_list:
|
|
|
|
- :ref:`Array<class_Array>` **get_script_property_list** **(** **)**
|
|
|
|
Devuelve la lista de propiedades en este ``Script``.
|
|
|
|
----
|
|
|
|
.. _class_Script_method_get_script_signal_list:
|
|
|
|
- :ref:`Array<class_Array>` **get_script_signal_list** **(** **)**
|
|
|
|
Devuelve la lista de señales de usuario definidas en este ``Script``.
|
|
|
|
----
|
|
|
|
.. _class_Script_method_has_script_signal:
|
|
|
|
- :ref:`bool<class_bool>` **has_script_signal** **(** :ref:`String<class_String>` signal_name **)** |const|
|
|
|
|
Devuelve ``true`` si el script, o una clase base, define una señal con el nombre dado.
|
|
|
|
----
|
|
|
|
.. _class_Script_method_has_source_code:
|
|
|
|
- :ref:`bool<class_bool>` **has_source_code** **(** **)** |const|
|
|
|
|
Devuelve ``true`` si el script contiene un código fuente no vacío.
|
|
|
|
----
|
|
|
|
.. _class_Script_method_instance_has:
|
|
|
|
- :ref:`bool<class_bool>` **instance_has** **(** :ref:`Object<class_Object>` base_object **)** |const|
|
|
|
|
Devuelve ``true`` si ``base_object`` es una instancia de este script.
|
|
|
|
----
|
|
|
|
.. _class_Script_method_is_tool:
|
|
|
|
- :ref:`bool<class_bool>` **is_tool** **(** **)** |const|
|
|
|
|
Devuelve ``true`` si el script es un script de herramientas. Un script de herramienta puede ejecutarse en el editor.
|
|
|
|
----
|
|
|
|
.. _class_Script_method_reload:
|
|
|
|
- :ref:`Error<enum_@GlobalScope_Error>` **reload** **(** :ref:`bool<class_bool>` keep_state=false **)**
|
|
|
|
Recarga la implementación de la clase del script. Devuelve un código de error.
|
|
|
|
.. |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.)`
|