class_rid.rst 1.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the RID.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_RID:
  6. RID
  7. ===
  8. **Category:** Built-In Types
  9. Brief Description
  10. -----------------
  11. Handle for a :ref:`Resource<class_Resource>`'s unique ID.
  12. Methods
  13. -------
  14. +-----------------------+-------------------------------------------------------------------------------+
  15. | :ref:`RID<class_RID>` | :ref:`RID<class_RID_method_RID>` **(** :ref:`Object<class_Object>` from **)** |
  16. +-----------------------+-------------------------------------------------------------------------------+
  17. | :ref:`int<class_int>` | :ref:`get_id<class_RID_method_get_id>` **(** **)** |
  18. +-----------------------+-------------------------------------------------------------------------------+
  19. Description
  20. -----------
  21. 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>`.
  22. Method Descriptions
  23. -------------------
  24. .. _class_RID_method_RID:
  25. - :ref:`RID<class_RID>` **RID** **(** :ref:`Object<class_Object>` from **)**
  26. Creates a new RID instance with the ID of a given resource. When not handed a valid resource, silently stores the unused ID 0.
  27. ----
  28. .. _class_RID_method_get_id:
  29. - :ref:`int<class_int>` **get_id** **(** **)**
  30. Returns the ID of the referenced resource.