RID.xml 973 B

12345678910111213141516171819202122232425262728293031
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="RID" version="3.4">
  3. <brief_description>
  4. Handle for a [Resource]'s unique ID.
  5. </brief_description>
  6. <description>
  7. 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 [VisualServer].
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <methods>
  12. <method name="RID">
  13. <return type="RID">
  14. </return>
  15. <argument index="0" name="from" type="Object">
  16. </argument>
  17. <description>
  18. Creates a new RID instance with the ID of a given resource. When not handed a valid resource, silently stores the unused ID 0.
  19. </description>
  20. </method>
  21. <method name="get_id">
  22. <return type="int">
  23. </return>
  24. <description>
  25. Returns the ID of the referenced resource.
  26. </description>
  27. </method>
  28. </methods>
  29. <constants>
  30. </constants>
  31. </class>