mirror of
https://github.com/godotengine/godot-docs-l10n.git
synced 2025-12-31 09:49:22 +03:00
242 lines
11 KiB
ReStructuredText
242 lines
11 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. _class_ResourceUID:
|
|
|
|
ResourceUID
|
|
===========
|
|
|
|
**Hereda:** :ref:`Object<class_Object>`
|
|
|
|
Un singleton que administra los identificadores únicos de todos los recursos dentro de un proyecto.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Descripción
|
|
----------------------
|
|
|
|
Los UID (Identificadores Únicos) de los recursos permiten que el motor mantenga las referencias entre los recursos intactos, incluso si los archivos se renombran o se mueven. Se puede acceder a ellos con ``uid://``.
|
|
|
|
\ **ResourceUID** realiza un seguimiento de todos los UID de recursos registrados en un proyecto, genera nuevos UID y convierte entre sus representaciones de string y enteras.
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Métodos
|
|
--------------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+-----------------------------+----------------------------------------------------------------------------------------------------------------------+
|
|
| |void| | :ref:`add_id<class_ResourceUID_method_add_id>`\ (\ id\: :ref:`int<class_int>`, path\: :ref:`String<class_String>`\ ) |
|
|
+-----------------------------+----------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`create_id<class_ResourceUID_method_create_id>`\ (\ ) |
|
|
+-----------------------------+----------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`create_id_for_path<class_ResourceUID_method_create_id_for_path>`\ (\ path\: :ref:`String<class_String>`\ ) |
|
|
+-----------------------------+----------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`ensure_path<class_ResourceUID_method_ensure_path>`\ (\ path_or_uid\: :ref:`String<class_String>`\ ) |static| |
|
|
+-----------------------------+----------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`get_id_path<class_ResourceUID_method_get_id_path>`\ (\ id\: :ref:`int<class_int>`\ ) |const| |
|
|
+-----------------------------+----------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`has_id<class_ResourceUID_method_has_id>`\ (\ id\: :ref:`int<class_int>`\ ) |const| |
|
|
+-----------------------------+----------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`id_to_text<class_ResourceUID_method_id_to_text>`\ (\ id\: :ref:`int<class_int>`\ ) |const| |
|
|
+-----------------------------+----------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`path_to_uid<class_ResourceUID_method_path_to_uid>`\ (\ path\: :ref:`String<class_String>`\ ) |static| |
|
|
+-----------------------------+----------------------------------------------------------------------------------------------------------------------+
|
|
| |void| | :ref:`remove_id<class_ResourceUID_method_remove_id>`\ (\ id\: :ref:`int<class_int>`\ ) |
|
|
+-----------------------------+----------------------------------------------------------------------------------------------------------------------+
|
|
| |void| | :ref:`set_id<class_ResourceUID_method_set_id>`\ (\ id\: :ref:`int<class_int>`, path\: :ref:`String<class_String>`\ ) |
|
|
+-----------------------------+----------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`text_to_id<class_ResourceUID_method_text_to_id>`\ (\ text_id\: :ref:`String<class_String>`\ ) |const| |
|
|
+-----------------------------+----------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`uid_to_path<class_ResourceUID_method_uid_to_path>`\ (\ uid\: :ref:`String<class_String>`\ ) |static| |
|
|
+-----------------------------+----------------------------------------------------------------------------------------------------------------------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Constantes
|
|
--------------------
|
|
|
|
.. _class_ResourceUID_constant_INVALID_ID:
|
|
|
|
.. rst-class:: classref-constant
|
|
|
|
**INVALID_ID** = ``-1`` :ref:`🔗<class_ResourceUID_constant_INVALID_ID>`
|
|
|
|
El valor a utilizar para un UID no válido, por ejemplo, si el recurso no se pudo cargar.
|
|
|
|
Su representación de texto es ``uid://<invalid>``.
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Descripciones de Métodos
|
|
------------------------------------------------
|
|
|
|
.. _class_ResourceUID_method_add_id:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
|void| **add_id**\ (\ id\: :ref:`int<class_int>`, path\: :ref:`String<class_String>`\ ) :ref:`🔗<class_ResourceUID_method_add_id>`
|
|
|
|
Añade un nuevo valor de UID que se asigna a la ruta del recurso dado.
|
|
|
|
Falla con un error si el UID ya existe, así que asegúrate de comprobar :ref:`has_id()<class_ResourceUID_method_has_id>` de antemano, o usa :ref:`set_id()<class_ResourceUID_method_set_id>` en su lugar.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ResourceUID_method_create_id:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`int<class_int>` **create_id**\ (\ ) :ref:`🔗<class_ResourceUID_method_create_id>`
|
|
|
|
Genera un UID de recurso aleatorio que garantiza que sea único dentro de la lista de UIDs cargados actualmente.
|
|
|
|
Para que este UID se registre, debes llamar a :ref:`add_id()<class_ResourceUID_method_add_id>` o :ref:`set_id()<class_ResourceUID_method_set_id>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ResourceUID_method_create_id_for_path:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`int<class_int>` **create_id_for_path**\ (\ path\: :ref:`String<class_String>`\ ) :ref:`🔗<class_ResourceUID_method_create_id_for_path>`
|
|
|
|
Como :ref:`create_id()<class_ResourceUID_method_create_id>`, pero el UID se inicializa con la ``path`` proporcionada y el nombre del proyecto. Los UID generados para esa ruta siempre serán los mismos dentro del proyecto actual.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ResourceUID_method_ensure_path:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`String<class_String>` **ensure_path**\ (\ path_or_uid\: :ref:`String<class_String>`\ ) |static| :ref:`🔗<class_ResourceUID_method_ensure_path>`
|
|
|
|
Returns a path, converting ``path_or_uid`` if necessary. Fails and returns an empty string if an invalid UID is provided.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ResourceUID_method_get_id_path:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`String<class_String>` **get_id_path**\ (\ id\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_ResourceUID_method_get_id_path>`
|
|
|
|
Devuelve la ruta a la que se refiere el valor UID dado.
|
|
|
|
Falla con un error si el UID no existe, así que asegúrate de comprobar :ref:`has_id()<class_ResourceUID_method_has_id>` de antemano.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ResourceUID_method_has_id:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`bool<class_bool>` **has_id**\ (\ id\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_ResourceUID_method_has_id>`
|
|
|
|
Devuelve si el valor de UID dado es conocido por la caché.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ResourceUID_method_id_to_text:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`String<class_String>` **id_to_text**\ (\ id\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_ResourceUID_method_id_to_text>`
|
|
|
|
Convierte el UID dado en un valor de string ``uid://``.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ResourceUID_method_path_to_uid:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`String<class_String>` **path_to_uid**\ (\ path\: :ref:`String<class_String>`\ ) |static| :ref:`🔗<class_ResourceUID_method_path_to_uid>`
|
|
|
|
Convierte el recurso proporcionado ``path`` en un UID. Devuelve la ruta sin cambios si no tiene un UID asociado.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ResourceUID_method_remove_id:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
|void| **remove_id**\ (\ id\: :ref:`int<class_int>`\ ) :ref:`🔗<class_ResourceUID_method_remove_id>`
|
|
|
|
Elimina un valor UID cargado de la caché.
|
|
|
|
Se produce un error si el UID no existe, así que asegúrate de comprobar :ref:`has_id()<class_ResourceUID_method_has_id>` de antemano.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ResourceUID_method_set_id:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
|void| **set_id**\ (\ id\: :ref:`int<class_int>`, path\: :ref:`String<class_String>`\ ) :ref:`🔗<class_ResourceUID_method_set_id>`
|
|
|
|
Actualiza la ruta del recurso de un UID existente.
|
|
|
|
Falla con un error si el UID no existe, así que asegúrate de comprobar :ref:`has_id()<class_ResourceUID_method_has_id>` de antemano, o usa :ref:`add_id()<class_ResourceUID_method_add_id>` en su lugar.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ResourceUID_method_text_to_id:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`int<class_int>` **text_to_id**\ (\ text_id\: :ref:`String<class_String>`\ ) |const| :ref:`🔗<class_ResourceUID_method_text_to_id>`
|
|
|
|
Extrae el valor UID de la ``uid://`` string dada.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ResourceUID_method_uid_to_path:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`String<class_String>` **uid_to_path**\ (\ uid\: :ref:`String<class_String>`\ ) |static| :ref:`🔗<class_ResourceUID_method_uid_to_path>`
|
|
|
|
Convierte el ``uid`` proporcionado a una ruta. Imprime un error si el UID no es válido.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (Normalmente, este método debería ser sobreescrito por el usuario para que tenga algún efecto.)`
|
|
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
|
|
.. |const| replace:: :abbr:`const (Este método no tiene efectos secundarios. No modifica ninguna de las variables miembro de la instancia.)`
|
|
.. |vararg| replace:: :abbr:`vararg (Este método permite agregar cualquier número de argumentos después de los descritos aquí.)`
|
|
.. |constructor| replace:: :abbr:`constructor (Este método se utiliza para construir un tipo.)`
|
|
.. |static| replace:: :abbr:`static (Este método no necesita una instancia para ser llamado, por lo que puede llamarse directamente utilizando el nombre de la clase.)`
|
|
.. |operator| replace:: :abbr:`operator (Este método describe un operador válido para usar con este tipo como operando izquierdo.)`
|
|
.. |bitfield| replace:: :abbr:`BitField (Este valor es un entero compuesto como una máscara de bits de las siguientes banderas.)`
|
|
.. |void| replace:: :abbr:`void (Sin valor de retorno.)`
|