class_resourceuid.rst 4.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the ResourceUID.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_ResourceUID:
  6. ResourceUID
  7. ===========
  8. **Inherits:** :ref:`Object<class_Object>`
  9. Methods
  10. -------
  11. +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+
  12. | void | :ref:`add_id<class_ResourceUID_method_add_id>` **(** :ref:`int<class_int>` id, :ref:`String<class_String>` path **)** |
  13. +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+
  14. | :ref:`int<class_int>` | :ref:`create_id<class_ResourceUID_method_create_id>` **(** **)** |
  15. +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+
  16. | :ref:`String<class_String>` | :ref:`get_id_path<class_ResourceUID_method_get_id_path>` **(** :ref:`int<class_int>` id **)** |const| |
  17. +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+
  18. | :ref:`bool<class_bool>` | :ref:`has_id<class_ResourceUID_method_has_id>` **(** :ref:`int<class_int>` id **)** |const| |
  19. +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+
  20. | :ref:`String<class_String>` | :ref:`id_to_text<class_ResourceUID_method_id_to_text>` **(** :ref:`int<class_int>` id **)** |const| |
  21. +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+
  22. | void | :ref:`remove_id<class_ResourceUID_method_remove_id>` **(** :ref:`int<class_int>` id **)** |
  23. +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+
  24. | void | :ref:`set_id<class_ResourceUID_method_set_id>` **(** :ref:`int<class_int>` id, :ref:`String<class_String>` path **)** |
  25. +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+
  26. | :ref:`int<class_int>` | :ref:`text_to_id<class_ResourceUID_method_text_to_id>` **(** :ref:`String<class_String>` text_id **)** |const| |
  27. +-----------------------------+-----------------------------------------------------------------------------------------------------------------------+
  28. Constants
  29. ---------
  30. .. _class_ResourceUID_constant_INVALID_ID:
  31. - **INVALID_ID** = **-1**
  32. Method Descriptions
  33. -------------------
  34. .. _class_ResourceUID_method_add_id:
  35. - void **add_id** **(** :ref:`int<class_int>` id, :ref:`String<class_String>` path **)**
  36. ----
  37. .. _class_ResourceUID_method_create_id:
  38. - :ref:`int<class_int>` **create_id** **(** **)**
  39. ----
  40. .. _class_ResourceUID_method_get_id_path:
  41. - :ref:`String<class_String>` **get_id_path** **(** :ref:`int<class_int>` id **)** |const|
  42. ----
  43. .. _class_ResourceUID_method_has_id:
  44. - :ref:`bool<class_bool>` **has_id** **(** :ref:`int<class_int>` id **)** |const|
  45. ----
  46. .. _class_ResourceUID_method_id_to_text:
  47. - :ref:`String<class_String>` **id_to_text** **(** :ref:`int<class_int>` id **)** |const|
  48. ----
  49. .. _class_ResourceUID_method_remove_id:
  50. - void **remove_id** **(** :ref:`int<class_int>` id **)**
  51. ----
  52. .. _class_ResourceUID_method_set_id:
  53. - void **set_id** **(** :ref:`int<class_int>` id, :ref:`String<class_String>` path **)**
  54. ----
  55. .. _class_ResourceUID_method_text_to_id:
  56. - :ref:`int<class_int>` **text_to_id** **(** :ref:`String<class_String>` text_id **)** |const|
  57. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  58. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  59. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  60. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  61. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  62. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`