2
0

RID.xml 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="RID" version="4.0">
  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 [RenderingServer].
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <constructors>
  12. <constructor name="RID">
  13. <return type="RID" />
  14. <description>
  15. Constructs an empty [RID] with the invalid ID [code]0[/code].
  16. </description>
  17. </constructor>
  18. <constructor name="RID">
  19. <return type="RID" />
  20. <argument index="0" name="from" type="RID" />
  21. <description>
  22. Constructs a [RID] as a copy of the given [RID].
  23. </description>
  24. </constructor>
  25. </constructors>
  26. <methods>
  27. <method name="get_id" qualifiers="const">
  28. <return type="int" />
  29. <description>
  30. Returns the ID of the referenced resource.
  31. </description>
  32. </method>
  33. </methods>
  34. <operators>
  35. <operator name="operator !=">
  36. <return type="bool" />
  37. <description>
  38. </description>
  39. </operator>
  40. <operator name="operator !=">
  41. <return type="bool" />
  42. <argument index="0" name="right" type="RID" />
  43. <description>
  44. </description>
  45. </operator>
  46. <operator name="operator &lt;">
  47. <return type="bool" />
  48. <argument index="0" name="right" type="RID" />
  49. <description>
  50. </description>
  51. </operator>
  52. <operator name="operator &lt;=">
  53. <return type="bool" />
  54. <argument index="0" name="right" type="RID" />
  55. <description>
  56. </description>
  57. </operator>
  58. <operator name="operator ==">
  59. <return type="bool" />
  60. <description>
  61. </description>
  62. </operator>
  63. <operator name="operator ==">
  64. <return type="bool" />
  65. <argument index="0" name="right" type="RID" />
  66. <description>
  67. </description>
  68. </operator>
  69. <operator name="operator &gt;">
  70. <return type="bool" />
  71. <argument index="0" name="right" type="RID" />
  72. <description>
  73. </description>
  74. </operator>
  75. <operator name="operator &gt;=">
  76. <return type="bool" />
  77. <argument index="0" name="right" type="RID" />
  78. <description>
  79. </description>
  80. </operator>
  81. </operators>
  82. </class>