mirror of
https://github.com/godotengine/godot-docs-l10n.git
synced 2026-01-04 10:09:56 +03:00
cf78697eea
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`
272 lines
22 KiB
ReStructuredText
272 lines
22 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 ClassDB.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_ClassDB:
|
|
|
|
ClassDB
|
|
=======
|
|
|
|
**Inherits:** :ref:`Object<class_Object>`
|
|
|
|
Clase Depósito Información.
|
|
|
|
Descripción
|
|
----------------------
|
|
|
|
Proporciona acceso a los metadatos almacenados para cada clase disponible.
|
|
|
|
Métodos
|
|
--------------
|
|
|
|
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`can_instance<class_ClassDB_method_can_instance>` **(** :ref:`String<class_String>` class **)** |const| |
|
|
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`class_exists<class_ClassDB_method_class_exists>` **(** :ref:`String<class_String>` class **)** |const| |
|
|
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`class_get_category<class_ClassDB_method_class_get_category>` **(** :ref:`String<class_String>` class **)** |const| |
|
|
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`class_get_enum_constants<class_ClassDB_method_class_get_enum_constants>` **(** :ref:`String<class_String>` class, :ref:`String<class_String>` enum, :ref:`bool<class_bool>` no_inheritance=false **)** |const| |
|
|
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`class_get_enum_list<class_ClassDB_method_class_get_enum_list>` **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** |const| |
|
|
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`class_get_integer_constant<class_ClassDB_method_class_get_integer_constant>` **(** :ref:`String<class_String>` class, :ref:`String<class_String>` name **)** |const| |
|
|
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`class_get_integer_constant_enum<class_ClassDB_method_class_get_integer_constant_enum>` **(** :ref:`String<class_String>` class, :ref:`String<class_String>` name, :ref:`bool<class_bool>` no_inheritance=false **)** |const| |
|
|
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`class_get_integer_constant_list<class_ClassDB_method_class_get_integer_constant_list>` **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** |const| |
|
|
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Array<class_Array>` | :ref:`class_get_method_list<class_ClassDB_method_class_get_method_list>` **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** |const| |
|
|
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Variant<class_Variant>` | :ref:`class_get_property<class_ClassDB_method_class_get_property>` **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` property **)** |const| |
|
|
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Array<class_Array>` | :ref:`class_get_property_list<class_ClassDB_method_class_get_property_list>` **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** |const| |
|
|
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Dictionary<class_Dictionary>` | :ref:`class_get_signal<class_ClassDB_method_class_get_signal>` **(** :ref:`String<class_String>` class, :ref:`String<class_String>` signal **)** |const| |
|
|
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Array<class_Array>` | :ref:`class_get_signal_list<class_ClassDB_method_class_get_signal_list>` **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** |const| |
|
|
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`class_has_enum<class_ClassDB_method_class_has_enum>` **(** :ref:`String<class_String>` class, :ref:`String<class_String>` name, :ref:`bool<class_bool>` no_inheritance=false **)** |const| |
|
|
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`class_has_integer_constant<class_ClassDB_method_class_has_integer_constant>` **(** :ref:`String<class_String>` class, :ref:`String<class_String>` name **)** |const| |
|
|
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`class_has_method<class_ClassDB_method_class_has_method>` **(** :ref:`String<class_String>` class, :ref:`String<class_String>` method, :ref:`bool<class_bool>` no_inheritance=false **)** |const| |
|
|
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`class_has_signal<class_ClassDB_method_class_has_signal>` **(** :ref:`String<class_String>` class, :ref:`String<class_String>` signal **)** |const| |
|
|
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`class_set_property<class_ClassDB_method_class_set_property>` **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` property, :ref:`Variant<class_Variant>` value **)** |const| |
|
|
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_class_list<class_ClassDB_method_get_class_list>` **(** **)** |const| |
|
|
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_inheriters_from_class<class_ClassDB_method_get_inheriters_from_class>` **(** :ref:`String<class_String>` class **)** |const| |
|
|
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`get_parent_class<class_ClassDB_method_get_parent_class>` **(** :ref:`String<class_String>` class **)** |const| |
|
|
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Variant<class_Variant>` | :ref:`instance<class_ClassDB_method_instance>` **(** :ref:`String<class_String>` class **)** |const| |
|
|
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_class_enabled<class_ClassDB_method_is_class_enabled>` **(** :ref:`String<class_String>` class **)** |const| |
|
|
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_parent_class<class_ClassDB_method_is_parent_class>` **(** :ref:`String<class_String>` class, :ref:`String<class_String>` inherits **)** |const| |
|
|
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Descripciones de Métodos
|
|
------------------------------------------------
|
|
|
|
.. _class_ClassDB_method_can_instance:
|
|
|
|
- :ref:`bool<class_bool>` **can_instance** **(** :ref:`String<class_String>` class **)** |const|
|
|
|
|
Devuelve ``true`` si se pueden incluir objetos de la clase ``class`` especificada, ``false`` en otro caso.
|
|
|
|
----
|
|
|
|
.. _class_ClassDB_method_class_exists:
|
|
|
|
- :ref:`bool<class_bool>` **class_exists** **(** :ref:`String<class_String>` class **)** |const|
|
|
|
|
Devuelve si la ``class`` especificada está disponible o no.
|
|
|
|
----
|
|
|
|
.. _class_ClassDB_method_class_get_category:
|
|
|
|
- :ref:`String<class_String>` **class_get_category** **(** :ref:`String<class_String>` class **)** |const|
|
|
|
|
Devuelve una categoría asociada a la clase para su uso en la documentación y la Biblioteca de recursos. Se requiere el modo de depuración.
|
|
|
|
----
|
|
|
|
.. _class_ClassDB_method_class_get_enum_constants:
|
|
|
|
- :ref:`PoolStringArray<class_PoolStringArray>` **class_get_enum_constants** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` enum, :ref:`bool<class_bool>` no_inheritance=false **)** |const|
|
|
|
|
Returns an array with all the keys in ``enum`` of ``class`` or its ancestry.
|
|
|
|
----
|
|
|
|
.. _class_ClassDB_method_class_get_enum_list:
|
|
|
|
- :ref:`PoolStringArray<class_PoolStringArray>` **class_get_enum_list** **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** |const|
|
|
|
|
Returns an array with all the enums of ``class`` or its ancestry.
|
|
|
|
----
|
|
|
|
.. _class_ClassDB_method_class_get_integer_constant:
|
|
|
|
- :ref:`int<class_int>` **class_get_integer_constant** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` name **)** |const|
|
|
|
|
Devuelve el valor de la constante entera ``name`` de ``class`` o su ascendencia. Siempre devuelve 0 cuando la constante no se ha podido encontrar.
|
|
|
|
----
|
|
|
|
.. _class_ClassDB_method_class_get_integer_constant_enum:
|
|
|
|
- :ref:`String<class_String>` **class_get_integer_constant_enum** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` name, :ref:`bool<class_bool>` no_inheritance=false **)** |const|
|
|
|
|
Returns which enum the integer constant ``name`` of ``class`` or its ancestry belongs to.
|
|
|
|
----
|
|
|
|
.. _class_ClassDB_method_class_get_integer_constant_list:
|
|
|
|
- :ref:`PoolStringArray<class_PoolStringArray>` **class_get_integer_constant_list** **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** |const|
|
|
|
|
Devuelve un arrayt con los nombres de todas las constantes enteras de ``class`` o su ascendencia.
|
|
|
|
----
|
|
|
|
.. _class_ClassDB_method_class_get_method_list:
|
|
|
|
- :ref:`Array<class_Array>` **class_get_method_list** **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** |const|
|
|
|
|
Returns an array with all the methods of ``class`` or its ancestry if ``no_inheritance`` is ``false``. Every element of the array is a :ref:`Dictionary<class_Dictionary>` with the following keys: ``args``, ``default_args``, ``flags``, ``id``, ``name``, ``return: (class_name, hint, hint_string, name, type, usage)``.
|
|
|
|
\ **Note:** In exported release builds the debug info is not available, so the returned dictionaries will contain only method names.
|
|
|
|
----
|
|
|
|
.. _class_ClassDB_method_class_get_property:
|
|
|
|
- :ref:`Variant<class_Variant>` **class_get_property** **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` property **)** |const|
|
|
|
|
Devuelve el valor de la ``property`` de la ``class`` o de sus ancestros.
|
|
|
|
----
|
|
|
|
.. _class_ClassDB_method_class_get_property_list:
|
|
|
|
- :ref:`Array<class_Array>` **class_get_property_list** **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** |const|
|
|
|
|
Devuelve un array con todas las propiedades de ``class`` o su ascendencia si ``no_inheritance`` es ``false``.
|
|
|
|
----
|
|
|
|
.. _class_ClassDB_method_class_get_signal:
|
|
|
|
- :ref:`Dictionary<class_Dictionary>` **class_get_signal** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` signal **)** |const|
|
|
|
|
Devuelve los datos de la ``signal`` de la ``class`` o su ascendencia. El valor devuelto es un :ref:`Dictionary<class_Dictionary>` con las siguientes claves: ``args``, ``default_args``, ``flags``, ``id``, ``name``, ``return: (class_name, hint, hint_string, name, type, usage)``.
|
|
|
|
----
|
|
|
|
.. _class_ClassDB_method_class_get_signal_list:
|
|
|
|
- :ref:`Array<class_Array>` **class_get_signal_list** **(** :ref:`String<class_String>` class, :ref:`bool<class_bool>` no_inheritance=false **)** |const|
|
|
|
|
Devuelve un array con todas las señales de ``class`` o su ascendencia si ``no_inheritance`` es ``false``. Cada elemento del array es un :ref:`Dictionary<class_Dictionary>` como se describe en :ref:`class_get_signal<class_ClassDB_method_class_get_signal>`.
|
|
|
|
----
|
|
|
|
.. _class_ClassDB_method_class_has_enum:
|
|
|
|
- :ref:`bool<class_bool>` **class_has_enum** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` name, :ref:`bool<class_bool>` no_inheritance=false **)** |const|
|
|
|
|
Returns whether ``class`` or its ancestry has an enum called ``name`` or not.
|
|
|
|
----
|
|
|
|
.. _class_ClassDB_method_class_has_integer_constant:
|
|
|
|
- :ref:`bool<class_bool>` **class_has_integer_constant** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` name **)** |const|
|
|
|
|
Devuelve si ``class`` o su ascendencia tiene una constante entera llamada ``name`` o no.
|
|
|
|
----
|
|
|
|
.. _class_ClassDB_method_class_has_method:
|
|
|
|
- :ref:`bool<class_bool>` **class_has_method** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` method, :ref:`bool<class_bool>` no_inheritance=false **)** |const|
|
|
|
|
Devuelve si ``class`` (o su ascendencia si ``no_inheritance`` es ``false``) tiene un método llamado ``method`` o no.
|
|
|
|
----
|
|
|
|
.. _class_ClassDB_method_class_has_signal:
|
|
|
|
- :ref:`bool<class_bool>` **class_has_signal** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` signal **)** |const|
|
|
|
|
Devuelve si ``class`` o su ascendencia tiene una señal llamada ``signal`` o no.
|
|
|
|
----
|
|
|
|
.. _class_ClassDB_method_class_set_property:
|
|
|
|
- :ref:`Error<enum_@GlobalScope_Error>` **class_set_property** **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` property, :ref:`Variant<class_Variant>` value **)** |const|
|
|
|
|
Establece el valor de ``property`` de ``class`` a ``value``.
|
|
|
|
----
|
|
|
|
.. _class_ClassDB_method_get_class_list:
|
|
|
|
- :ref:`PoolStringArray<class_PoolStringArray>` **get_class_list** **(** **)** |const|
|
|
|
|
Devuelve los nombres de todas las clases disponibles.
|
|
|
|
----
|
|
|
|
.. _class_ClassDB_method_get_inheriters_from_class:
|
|
|
|
- :ref:`PoolStringArray<class_PoolStringArray>` **get_inheriters_from_class** **(** :ref:`String<class_String>` class **)** |const|
|
|
|
|
Devuelve los nombres de todas las clases que directa o indirectamente heredan de ``class``.
|
|
|
|
----
|
|
|
|
.. _class_ClassDB_method_get_parent_class:
|
|
|
|
- :ref:`String<class_String>` **get_parent_class** **(** :ref:`String<class_String>` class **)** |const|
|
|
|
|
Devuelve la clase padre de ``class``.
|
|
|
|
----
|
|
|
|
.. _class_ClassDB_method_instance:
|
|
|
|
- :ref:`Variant<class_Variant>` **instance** **(** :ref:`String<class_String>` class **)** |const|
|
|
|
|
Crea una instancia de ``class``.
|
|
|
|
----
|
|
|
|
.. _class_ClassDB_method_is_class_enabled:
|
|
|
|
- :ref:`bool<class_bool>` **is_class_enabled** **(** :ref:`String<class_String>` class **)** |const|
|
|
|
|
Devuelve si esta ``clase`` está habilitada o no.
|
|
|
|
----
|
|
|
|
.. _class_ClassDB_method_is_parent_class:
|
|
|
|
- :ref:`bool<class_bool>` **is_parent_class** **(** :ref:`String<class_String>` class, :ref:`String<class_String>` inherits **)** |const|
|
|
|
|
Devuelve si ``inherits`` es un ancestro de ``class`` o no.
|
|
|
|
.. |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.)`
|