class_rid.rst 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the RID.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_RID:
  5. RID
  6. ===
  7. **Category:** Built-In Types
  8. Brief Description
  9. -----------------
  10. Handle for a :ref:`Resource<class_resource>`'s unique ID.
  11. Member Functions
  12. ----------------
  13. +------------------------+------------------------------------------------------------------------+
  14. | :ref:`RID<class_rid>` | :ref:`RID<class_RID_RID>` **(** :ref:`Object<class_object>` from **)** |
  15. +------------------------+------------------------------------------------------------------------+
  16. | :ref:`int<class_int>` | :ref:`get_id<class_RID_get_id>` **(** **)** |
  17. +------------------------+------------------------------------------------------------------------+
  18. Description
  19. -----------
  20. 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>`.
  21. Member Function Description
  22. ---------------------------
  23. .. _class_RID_RID:
  24. - :ref:`RID<class_rid>` **RID** **(** :ref:`Object<class_object>` from **)**
  25. Create a new RID instance with the ID of a given resource. When not handed a valid resource, silently stores the unused ID 0.
  26. .. _class_RID_get_id:
  27. - :ref:`int<class_int>` **get_id** **(** **)**
  28. Retrieve the ID of the referenced resource.