RID.xml 1023 B

1234567891011121314151617181920212223242526272829
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="RID" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
  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. <argument index="0" name="from" type="Object" />
  15. <description>
  16. Creates a new RID instance with the ID of a given resource. When not handed a valid resource, silently stores the unused ID 0.
  17. </description>
  18. </method>
  19. <method name="get_id">
  20. <return type="int" />
  21. <description>
  22. Returns the ID of the referenced resource.
  23. </description>
  24. </method>
  25. </methods>
  26. <constants>
  27. </constants>
  28. </class>