godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-11-04 12:00:25 +00:00
Code Releases Wiki Activity

Expose helper methods for converting UIDs

Browse Source
This commit is contained in:
kobewi
2025-05-22 15:08:22 +02:00
parent 4a44078451
commit 9c37ca5383
2 changed files with 25 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
core/io/resource_uid.cpp
View File

@@ -364,6 +364,10 @@ void ResourceUID::_bind_methods() {
ClassDB::bind_method(D_METHOD("get_id_path", "id"), &ResourceUID::get_id_path);
ClassDB::bind_method(D_METHOD("remove_id", "id"), &ResourceUID::remove_id);
ClassDB::bind_static_method("ResourceUID", D_METHOD("uid_to_path", "uid"), &ResourceUID::uid_to_path);
ClassDB::bind_static_method("ResourceUID", D_METHOD("path_to_uid", "path"), &ResourceUID::path_to_uid);
ClassDB::bind_static_method("ResourceUID", D_METHOD("ensure_path", "path_or_uid"), &ResourceUID::ensure_path);
BIND_CONSTANT(INVALID_ID)
}
ResourceUID *ResourceUID::singleton = nullptr;

21
doc/classes/ResourceUID.xml
View File

@@ -33,6 +33,13 @@
Like [method create_id], but the UID is seeded with the provided [param path] and project name. UIDs generated for that path will be always the same within the current project.
</description>
</method>
<method name="ensure_path" qualifiers="static">
<return type="String" />
<param index="0" name="path_or_uid" type="String" />
<description>
Returns a path, converting [param path_or_uid] if necessary. Prints an error if provided an invalid UID.
</description>
</method>
<method name="get_id_path" qualifiers="const">
<return type="String" />
<param index="0" name="id" type="int" />
@@ -55,6 +62,13 @@
Converts the given UID to a [code]uid://[/code] string value.
</description>
</method>
<method name="path_to_uid" qualifiers="static">
<return type="String" />
<param index="0" name="path" type="String" />
<description>
Converts the provided resource [param path] to a UID. Returns the unchanged path if it has no associated UID.
</description>
</method>
<method name="remove_id">
<return type="void" />
<param index="0" name="id" type="int" />
@@ -79,6 +93,13 @@
Extracts the UID value from the given [code]uid://[/code] string.
</description>
</method>
<method name="uid_to_path" qualifiers="static">
<return type="String" />
<param index="0" name="uid" type="String" />
<description>
Converts the provided [param uid] to a path. Prints an error if the UID is invalid.
</description>
</method>
</methods>
<constants>
<constant name="INVALID_ID" value="-1">