2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-07-06 16:08:05 +08:00
<class name= "RID" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2017-09-13 04:42:36 +08:00
<brief_description >
2023-04-28 07:35:33 +08:00
A handle for a [Resource]'s unique identifier.
2017-09-13 04:42:36 +08:00
</brief_description>
<description >
2022-11-04 04:00:52 +08:00
The RID [Variant] type is used to access a low-level resource by its unique ID. RIDs are opaque, which means they do not grant access to the resource by themselves. They are used by the low-level server classes, such as [DisplayServer], [RenderingServer], [TextServer], etc.
A low-level resource may correspond to a high-level [Resource], such as [Texture] or [Mesh].
2017-09-13 04:42:36 +08:00
</description>
<tutorials >
</tutorials>
2021-09-21 10:49:02 +08:00
<constructors >
<constructor name= "RID" >
2021-07-30 21:28:05 +08:00
<return type= "RID" />
2020-11-10 00:46:03 +08:00
<description >
Constructs an empty [RID] with the invalid ID [code]0[/code].
</description>
2021-09-21 10:49:02 +08:00
</constructor>
<constructor name= "RID" >
2021-07-30 21:28:05 +08:00
<return type= "RID" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "from" type= "RID" />
2017-09-13 04:42:36 +08:00
<description >
2020-11-10 00:46:03 +08:00
Constructs a [RID] as a copy of the given [RID].
2017-09-13 04:42:36 +08:00
</description>
2021-09-21 10:49:02 +08:00
</constructor>
</constructors>
<methods >
2021-03-18 21:44:42 +08:00
<method name= "get_id" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "int" />
2017-09-13 04:42:36 +08:00
<description >
2022-11-04 04:00:52 +08:00
Returns the ID of the referenced low-level resource.
2017-09-13 04:42:36 +08:00
</description>
</method>
2022-02-08 15:49:14 +08:00
<method name= "is_valid" qualifiers= "const" >
<return type= "bool" />
<description >
2022-11-04 04:00:52 +08:00
Returns [code]true[/code] if the [RID] is not [code]0[/code].
2022-02-08 15:49:14 +08:00
</description>
</method>
2021-09-21 10:49:02 +08:00
</methods>
<operators >
<operator name= "operator !=" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "right" type= "RID" />
2020-11-10 21:16:20 +08:00
<description >
2022-11-04 04:00:52 +08:00
Returns [code]true[/code] if the [RID]s are not equal.
2020-11-10 21:16:20 +08:00
</description>
2021-09-21 10:49:02 +08:00
</operator>
<operator name= "operator <" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "right" type= "RID" />
2020-11-10 21:16:20 +08:00
<description >
2022-11-04 04:00:52 +08:00
Returns [code]true[/code] if the [RID]'s ID is less than [param right]'s ID.
2020-11-10 21:16:20 +08:00
</description>
2021-09-21 10:49:02 +08:00
</operator>
<operator name= "operator <=" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "right" type= "RID" />
2020-11-10 21:16:20 +08:00
<description >
2022-11-04 04:00:52 +08:00
Returns [code]true[/code] if the [RID]'s ID is less than or equal to [param right]'s ID.
2020-11-10 21:16:20 +08:00
</description>
2021-09-21 10:49:02 +08:00
</operator>
<operator name= "operator ==" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "right" type= "RID" />
2020-11-10 21:16:20 +08:00
<description >
2022-11-04 04:00:52 +08:00
Returns [code]true[/code] if both [RID]s are equal, which means they both refer to the same low-level resource.
2020-11-10 21:16:20 +08:00
</description>
2021-09-21 10:49:02 +08:00
</operator>
<operator name= "operator >" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "right" type= "RID" />
2020-11-10 21:16:20 +08:00
<description >
2022-11-04 04:00:52 +08:00
Returns [code]true[/code] if the [RID]'s ID is greater than [param right]'s ID.
2020-11-10 21:16:20 +08:00
</description>
2021-09-21 10:49:02 +08:00
</operator>
<operator name= "operator >=" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "right" type= "RID" />
2020-11-10 21:16:20 +08:00
<description >
2022-11-04 04:00:52 +08:00
Returns [code]true[/code] if the [RID]'s ID is greater than or equal to [param right]'s ID.
2020-11-10 21:16:20 +08:00
</description>
2021-09-21 10:49:02 +08:00
</operator>
</operators>
2017-09-13 04:42:36 +08:00
</class>