godot/doc/classes/RID.xml
2020-11-10 15:00:50 +01:00

87 lines
2.3 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="RID" version="4.0">
<brief_description>
Handle for a [Resource]'s unique ID.
</brief_description>
<description>
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].
</description>
<tutorials>
</tutorials>
<methods>
<method name="RID" qualifiers="constructor">
<return type="RID">
</return>
<description>
Constructs an empty [RID] with the invalid ID [code]0[/code].
</description>
</method>
<method name="RID" qualifiers="constructor">
<return type="RID">
</return>
<argument index="0" name="from" type="RID">
</argument>
<description>
Constructs a [RID] as a copy of the given [RID].
</description>
</method>
<method name="get_id">
<return type="int">
</return>
<description>
Returns the ID of the referenced resource.
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="RID">
</argument>
<description>
</description>
</method>
<method name="operator &lt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="RID">
</argument>
<description>
</description>
</method>
<method name="operator &lt;=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="RID">
</argument>
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="RID">
</argument>
<description>
</description>
</method>
<method name="operator &gt;" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="RID">
</argument>
<description>
</description>
</method>
<method name="operator &gt;=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="RID">
</argument>
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>