class_rid.rst 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_RID:
  4. RID
  5. ===
  6. **Category:** Built-In Types
  7. Brief Description
  8. -----------------
  9. Handle for a :ref:`Resource<class_resource>`'s unique ID.
  10. Member Functions
  11. ----------------
  12. +------------------------+--------------------------------------------------------------------------+
  13. | :ref:`RID<class_rid>` | :ref:`RID<class_RID_RID>` **(** :ref:`Object<class_object>` from **)** |
  14. +------------------------+--------------------------------------------------------------------------+
  15. | :ref:`int<class_int>` | :ref:`get_id<class_RID_get_id>` **(** **)** |
  16. +------------------------+--------------------------------------------------------------------------+
  17. Description
  18. -----------
  19. The RID type is used to access the unique integer ID of a resource. They are opaque, so they do not grant access to the associated resource by themselves. They are used by and with the low-level Server classes such as :ref:`VisualServer<class_visualserver>`.
  20. Member Function Description
  21. ---------------------------
  22. .. _class_RID_RID:
  23. - :ref:`RID<class_rid>` **RID** **(** :ref:`Object<class_object>` from **)**
  24. Create a new RID instance with the ID of a given resource. When not handed a valid resource, silently stores the unused ID 0.
  25. .. _class_RID_get_id:
  26. - :ref:`int<class_int>` **get_id** **(** **)**
  27. Retrieve the ID of the referenced resource.