:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceUID.xml. .. _class_ResourceUID: ResourceUID =========== **Inherits:** :ref:`Object` A singleton that manages the unique identifiers of all resources within a project. .. rst-class:: classref-introduction-group Description ----------- Resource UIDs (Unique IDentifiers) allow the engine to keep references between resources intact, even if files are renamed or moved. They can be accessed with ``uid://``. \ **ResourceUID** keeps track of all registered resource UIDs in a project, generates new UIDs, and converts between their string and integer representations. .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_id`\ (\ id\: :ref:`int`, path\: :ref:`String`\ ) | +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`create_id`\ (\ ) | +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`create_id_for_path`\ (\ path\: :ref:`String`\ ) | +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`ensure_path`\ (\ path_or_uid\: :ref:`String`\ ) |static| | +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_id_path`\ (\ id\: :ref:`int`\ ) |const| | +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_id`\ (\ id\: :ref:`int`\ ) |const| | +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`id_to_text`\ (\ id\: :ref:`int`\ ) |const| | +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`path_to_uid`\ (\ path\: :ref:`String`\ ) |static| | +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_id`\ (\ id\: :ref:`int`\ ) | +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_id`\ (\ id\: :ref:`int`, path\: :ref:`String`\ ) | +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`text_to_id`\ (\ text_id\: :ref:`String`\ ) |const| | +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`uid_to_path`\ (\ uid\: :ref:`String`\ ) |static| | +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Constants --------- .. _class_ResourceUID_constant_INVALID_ID: .. rst-class:: classref-constant **INVALID_ID** = ``-1`` :ref:`🔗` The value to use for an invalid UID, for example if the resource could not be loaded. Its text representation is ``uid://``. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_ResourceUID_method_add_id: .. rst-class:: classref-method |void| **add_id**\ (\ id\: :ref:`int`, path\: :ref:`String`\ ) :ref:`🔗` Adds a new UID value which is mapped to the given resource path. Fails with an error if the UID already exists, so be sure to check :ref:`has_id()` beforehand, or use :ref:`set_id()` instead. .. rst-class:: classref-item-separator ---- .. _class_ResourceUID_method_create_id: .. rst-class:: classref-method :ref:`int` **create_id**\ (\ ) :ref:`🔗` Generates a random resource UID which is guaranteed to be unique within the list of currently loaded UIDs. In order for this UID to be registered, you must call :ref:`add_id()` or :ref:`set_id()`. .. rst-class:: classref-item-separator ---- .. _class_ResourceUID_method_create_id_for_path: .. rst-class:: classref-method :ref:`int` **create_id_for_path**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Like :ref:`create_id()`, but the UID is seeded with the provided ``path`` and project name. UIDs generated for that path will be always the same within the current project. .. rst-class:: classref-item-separator ---- .. _class_ResourceUID_method_ensure_path: .. rst-class:: classref-method :ref:`String` **ensure_path**\ (\ path_or_uid\: :ref:`String`\ ) |static| :ref:`🔗` Returns a path, converting ``path_or_uid`` if necessary. Prints an error if provided an invalid UID. .. rst-class:: classref-item-separator ---- .. _class_ResourceUID_method_get_id_path: .. rst-class:: classref-method :ref:`String` **get_id_path**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the path that the given UID value refers to. Fails with an error if the UID does not exist, so be sure to check :ref:`has_id()` beforehand. .. rst-class:: classref-item-separator ---- .. _class_ResourceUID_method_has_id: .. rst-class:: classref-method :ref:`bool` **has_id**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether the given UID value is known to the cache. .. rst-class:: classref-item-separator ---- .. _class_ResourceUID_method_id_to_text: .. rst-class:: classref-method :ref:`String` **id_to_text**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Converts the given UID to a ``uid://`` string value. .. rst-class:: classref-item-separator ---- .. _class_ResourceUID_method_path_to_uid: .. rst-class:: classref-method :ref:`String` **path_to_uid**\ (\ path\: :ref:`String`\ ) |static| :ref:`🔗` Converts the provided resource ``path`` to a UID. Returns the unchanged path if it has no associated UID. .. rst-class:: classref-item-separator ---- .. _class_ResourceUID_method_remove_id: .. rst-class:: classref-method |void| **remove_id**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Removes a loaded UID value from the cache. Fails with an error if the UID does not exist, so be sure to check :ref:`has_id()` beforehand. .. rst-class:: classref-item-separator ---- .. _class_ResourceUID_method_set_id: .. rst-class:: classref-method |void| **set_id**\ (\ id\: :ref:`int`, path\: :ref:`String`\ ) :ref:`🔗` Updates the resource path of an existing UID. Fails with an error if the UID does not exist, so be sure to check :ref:`has_id()` beforehand, or use :ref:`add_id()` instead. .. rst-class:: classref-item-separator ---- .. _class_ResourceUID_method_text_to_id: .. rst-class:: classref-method :ref:`int` **text_to_id**\ (\ text_id\: :ref:`String`\ ) |const| :ref:`🔗` Extracts the UID value from the given ``uid://`` string. .. rst-class:: classref-item-separator ---- .. _class_ResourceUID_method_uid_to_path: .. rst-class:: classref-method :ref:`String` **uid_to_path**\ (\ uid\: :ref:`String`\ ) |static| :ref:`🔗` Converts the provided ``uid`` to a path. Prints an error if the UID is invalid. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |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.)`