78 lines
2.3 KiB
XML
78 lines
2.3 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="RID" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<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>
|
|
<constructors>
|
|
<constructor name="RID">
|
|
<return type="RID" />
|
|
<description>
|
|
Constructs an empty [RID] with the invalid ID [code]0[/code].
|
|
</description>
|
|
</constructor>
|
|
<constructor name="RID">
|
|
<return type="RID" />
|
|
<argument index="0" name="from" type="RID" />
|
|
<description>
|
|
Constructs a [RID] as a copy of the given [RID].
|
|
</description>
|
|
</constructor>
|
|
</constructors>
|
|
<methods>
|
|
<method name="get_id" qualifiers="const">
|
|
<return type="int" />
|
|
<description>
|
|
Returns the ID of the referenced resource.
|
|
</description>
|
|
</method>
|
|
<method name="is_valid" qualifiers="const">
|
|
<return type="bool" />
|
|
<description>
|
|
Returns [code]true[/code] if [RID] is valid.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<operators>
|
|
<operator name="operator !=">
|
|
<return type="bool" />
|
|
<argument index="0" name="right" type="RID" />
|
|
<description>
|
|
</description>
|
|
</operator>
|
|
<operator name="operator <">
|
|
<return type="bool" />
|
|
<argument index="0" name="right" type="RID" />
|
|
<description>
|
|
</description>
|
|
</operator>
|
|
<operator name="operator <=">
|
|
<return type="bool" />
|
|
<argument index="0" name="right" type="RID" />
|
|
<description>
|
|
</description>
|
|
</operator>
|
|
<operator name="operator ==">
|
|
<return type="bool" />
|
|
<argument index="0" name="right" type="RID" />
|
|
<description>
|
|
</description>
|
|
</operator>
|
|
<operator name="operator >">
|
|
<return type="bool" />
|
|
<argument index="0" name="right" type="RID" />
|
|
<description>
|
|
</description>
|
|
</operator>
|
|
<operator name="operator >=">
|
|
<return type="bool" />
|
|
<argument index="0" name="right" type="RID" />
|
|
<description>
|
|
</description>
|
|
</operator>
|
|
</operators>
|
|
</class>
|