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.
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 has_id() beforehand, or use set_id() instead.
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 add_id() or set_id().
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 has_id() beforehand.
Returns whether the given UID value is known to the cache.
Converts the given UID to a uid://
string value.
Removes a loaded UID value from the cache.
Fails with an error if the UID does not exist, so be sure to check has_id() beforehand.
Updates the resource path of an existing UID.
Fails with an error if the UID does not exist, so be sure to check has_id() beforehand, or use add_id() instead.
Extracts the UID value from the given uid://
string.