class_rid.rst 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  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 RID.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_RID:
  6. RID
  7. ===
  8. Handle for a :ref:`Resource<class_Resource>`'s unique ID.
  9. Description
  10. -----------
  11. The RID type is used to access the unique integer ID of a resource. They are opaque, which means 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>`.
  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. Method Descriptions
  20. -------------------
  21. .. _class_RID_method_RID:
  22. - :ref:`RID<class_RID>` **RID** **(** :ref:`Object<class_Object>` from **)**
  23. Creates a new RID instance with the ID of a given resource. When not handed a valid resource, silently stores the unused ID 0.
  24. ----
  25. .. _class_RID_method_get_id:
  26. - :ref:`int<class_int>` **get_id** **(** **)**
  27. Returns the ID of the referenced resource.
  28. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  29. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  30. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`