RID.xml 1.0 KB

12345678910111213141516171819202122232425262728293031323334
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="RID" category="Built-In Types" version="3.0.alpha.custom_build">
  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, 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 [VisualServer].
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <demos>
  12. </demos>
  13. <methods>
  14. <method name="RID">
  15. <return type="RID">
  16. </return>
  17. <argument index="0" name="from" type="Object">
  18. </argument>
  19. <description>
  20. Create a new RID instance with the ID of a given resource. When not handed a valid resource, silently stores the unused ID 0.
  21. </description>
  22. </method>
  23. <method name="get_id">
  24. <return type="int">
  25. </return>
  26. <description>
  27. Retrieve the ID of the referenced resource.
  28. </description>
  29. </method>
  30. </methods>
  31. <constants>
  32. </constants>
  33. </class>