Files
godot-docs/classes/class_resourceuid.rst
2022-02-22 10:06:27 +01:00

99 lines
4.7 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 ResourceUID.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_ResourceUID:
ResourceUID
===========
**Inherits:** :ref:`Object<class_Object>`
Methods
-------
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_id<class_ResourceUID_method_add_id>` **(** :ref:`int<class_int>` id, :ref:`String<class_String>` path **)** |
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`create_id<class_ResourceUID_method_create_id>` **(** **)** |
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_id_path<class_ResourceUID_method_get_id_path>` **(** :ref:`int<class_int>` id **)** |const| |
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_id<class_ResourceUID_method_has_id>` **(** :ref:`int<class_int>` id **)** |const| |
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`id_to_text<class_ResourceUID_method_id_to_text>` **(** :ref:`int<class_int>` id **)** |const| |
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_id<class_ResourceUID_method_remove_id>` **(** :ref:`int<class_int>` id **)** |
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_id<class_ResourceUID_method_set_id>` **(** :ref:`int<class_int>` id, :ref:`String<class_String>` path **)** |
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`text_to_id<class_ResourceUID_method_text_to_id>` **(** :ref:`String<class_String>` text_id **)** |const| |
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------+
Constants
---------
.. _class_ResourceUID_constant_INVALID_ID:
- **INVALID_ID** = **-1**
Method Descriptions
-------------------
.. _class_ResourceUID_method_add_id:
- void **add_id** **(** :ref:`int<class_int>` id, :ref:`String<class_String>` path **)**
----
.. _class_ResourceUID_method_create_id:
- :ref:`int<class_int>` **create_id** **(** **)**
----
.. _class_ResourceUID_method_get_id_path:
- :ref:`String<class_String>` **get_id_path** **(** :ref:`int<class_int>` id **)** |const|
----
.. _class_ResourceUID_method_has_id:
- :ref:`bool<class_bool>` **has_id** **(** :ref:`int<class_int>` id **)** |const|
----
.. _class_ResourceUID_method_id_to_text:
- :ref:`String<class_String>` **id_to_text** **(** :ref:`int<class_int>` id **)** |const|
----
.. _class_ResourceUID_method_remove_id:
- void **remove_id** **(** :ref:`int<class_int>` id **)**
----
.. _class_ResourceUID_method_set_id:
- void **set_id** **(** :ref:`int<class_int>` id, :ref:`String<class_String>` path **)**
----
.. _class_ResourceUID_method_text_to_id:
- :ref:`int<class_int>` **text_to_id** **(** :ref:`String<class_String>` text_id **)** |const|
.. |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.)`
.. |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.)`