godot/doc/classes/RID.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="RID" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A handle for a [Resource]'s unique identifier.
	</brief_description>
	<description>
		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].
	</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" />
			<param 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 low-level resource.
			</description>
		</method>
		<method name="is_valid" qualifiers="const">
			<return type="bool" />
			<description>
				Returns [code]true[/code] if the [RID] is not [code]0[/code].
			</description>
		</method>
	</methods>
	<operators>
		<operator name="operator !=">
			<return type="bool" />
			<param index="0" name="right" type="RID" />
			<description>
				Returns [code]true[/code] if the [RID]s are not equal.
			</description>
		</operator>
		<operator name="operator &lt;">
			<return type="bool" />
			<param index="0" name="right" type="RID" />
			<description>
				Returns [code]true[/code] if the [RID]'s ID is less than [param right]'s ID.
			</description>
		</operator>
		<operator name="operator &lt;=">
			<return type="bool" />
			<param index="0" name="right" type="RID" />
			<description>
				Returns [code]true[/code] if the [RID]'s ID is less than or equal to [param right]'s ID.
			</description>
		</operator>
		<operator name="operator ==">
			<return type="bool" />
			<param index="0" name="right" type="RID" />
			<description>
				Returns [code]true[/code] if both [RID]s are equal, which means they both refer to the same low-level resource.
			</description>
		</operator>
		<operator name="operator &gt;">
			<return type="bool" />
			<param index="0" name="right" type="RID" />
			<description>
				Returns [code]true[/code] if the [RID]'s ID is greater than [param right]'s ID.
			</description>
		</operator>
		<operator name="operator &gt;=">
			<return type="bool" />
			<param index="0" name="right" type="RID" />
			<description>
				Returns [code]true[/code] if the [RID]'s ID is greater than or equal to [param right]'s ID.
			</description>
		</operator>
	</operators>
</class>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Bump version to 4.1-dev Can't stop, won't stop, they said, huh? 2023-03-01 00:44:37 +00:00			`<class name="RID" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`<brief_description>`
Overhaul the top sections of the class reference (Core classes) 2023-04-27 23:35:33 +00:00			`A handle for a [Resource]'s unique identifier.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</brief_description>`
			`<description>`
Add missing RID operator descriptions Also tweaks the descriptions above a bit. 2022-11-03 20:00:52 +00: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].`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</description>`
			`<tutorials>`
			`</tutorials>`
Move the docs for constructors and operators out of methods section 2021-09-21 02:49:02 +00:00			`<constructors>`
			`<constructor name="RID">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 13:28:05 +00:00			`<return type="RID" />`
Variant: Sync docs with new constructors, fixups after #43403 Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors. 2020-11-09 16:46:03 +00:00			`<description>`
			`Constructs an empty [RID] with the invalid ID [code]0[/code].`
			`</description>`
Move the docs for constructors and operators out of methods section 2021-09-21 02:49:02 +00:00			`</constructor>`
			`<constructor name="RID">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 13:28:05 +00:00			`<return type="RID" />`
Rename the argument tag to param in XML documentation 2022-08-06 18:11:48 +00:00			`<param index="0" name="from" type="RID" />`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`<description>`
Variant: Sync docs with new constructors, fixups after #43403 Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors. 2020-11-09 16:46:03 +00:00			`Constructs a [RID] as a copy of the given [RID].`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</description>`
Move the docs for constructors and operators out of methods section 2021-09-21 02:49:02 +00:00			`</constructor>`
			`</constructors>`
			`<methods>`
doc: Sync classref with current source And move GLTF docs to its module folder. 2021-03-18 13:44:42 +00:00			`<method name="get_id" qualifiers="const">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 13:28:05 +00:00			`<return type="int" />`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`<description>`
Add missing RID operator descriptions Also tweaks the descriptions above a bit. 2022-11-03 20:00:52 +00:00			`Returns the ID of the referenced low-level resource.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</description>`
			`</method>`
[GDExtension] Add binds for missing methods, operators, and constants required for GDExtension TextServer implementation. 2022-02-08 07:49:14 +00:00			`<method name="is_valid" qualifiers="const">`
			`<return type="bool" />`
			`<description>`
Add missing RID operator descriptions Also tweaks the descriptions above a bit. 2022-11-03 20:00:52 +00:00			`Returns [code]true[/code] if the [RID] is not [code]0[/code].`
[GDExtension] Add binds for missing methods, operators, and constants required for GDExtension TextServer implementation. 2022-02-08 07:49:14 +00:00			`</description>`
			`</method>`
Move the docs for constructors and operators out of methods section 2021-09-21 02:49:02 +00:00			`</methods>`
			`<operators>`
			`<operator name="operator !=">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 13:28:05 +00:00			`<return type="bool" />`
Rename the argument tag to param in XML documentation 2022-08-06 18:11:48 +00:00			`<param index="0" name="right" type="RID" />`
doc: Sync classref to add operators after #43419 2020-11-10 13:16:20 +00:00			`<description>`
Add missing RID operator descriptions Also tweaks the descriptions above a bit. 2022-11-03 20:00:52 +00:00			`Returns [code]true[/code] if the [RID]s are not equal.`
doc: Sync classref to add operators after #43419 2020-11-10 13:16:20 +00:00			`</description>`
Move the docs for constructors and operators out of methods section 2021-09-21 02:49:02 +00:00			`</operator>`
			`<operator name="operator <">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 13:28:05 +00:00			`<return type="bool" />`
Rename the argument tag to param in XML documentation 2022-08-06 18:11:48 +00:00			`<param index="0" name="right" type="RID" />`
doc: Sync classref to add operators after #43419 2020-11-10 13:16:20 +00:00			`<description>`
Add missing RID operator descriptions Also tweaks the descriptions above a bit. 2022-11-03 20:00:52 +00:00			`Returns [code]true[/code] if the [RID]'s ID is less than [param right]'s ID.`
doc: Sync classref to add operators after #43419 2020-11-10 13:16:20 +00:00			`</description>`
Move the docs for constructors and operators out of methods section 2021-09-21 02:49:02 +00:00			`</operator>`
			`<operator name="operator <=">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 13:28:05 +00:00			`<return type="bool" />`
Rename the argument tag to param in XML documentation 2022-08-06 18:11:48 +00:00			`<param index="0" name="right" type="RID" />`
doc: Sync classref to add operators after #43419 2020-11-10 13:16:20 +00:00			`<description>`
Add missing RID operator descriptions Also tweaks the descriptions above a bit. 2022-11-03 20:00:52 +00:00			`Returns [code]true[/code] if the [RID]'s ID is less than or equal to [param right]'s ID.`
doc: Sync classref to add operators after #43419 2020-11-10 13:16:20 +00:00			`</description>`
Move the docs for constructors and operators out of methods section 2021-09-21 02:49:02 +00:00			`</operator>`
			`<operator name="operator ==">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 13:28:05 +00:00			`<return type="bool" />`
Rename the argument tag to param in XML documentation 2022-08-06 18:11:48 +00:00			`<param index="0" name="right" type="RID" />`
doc: Sync classref to add operators after #43419 2020-11-10 13:16:20 +00:00			`<description>`
Add missing RID operator descriptions Also tweaks the descriptions above a bit. 2022-11-03 20:00:52 +00:00			`Returns [code]true[/code] if both [RID]s are equal, which means they both refer to the same low-level resource.`
doc: Sync classref to add operators after #43419 2020-11-10 13:16:20 +00:00			`</description>`
Move the docs for constructors and operators out of methods section 2021-09-21 02:49:02 +00:00			`</operator>`
			`<operator name="operator >">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 13:28:05 +00:00			`<return type="bool" />`
Rename the argument tag to param in XML documentation 2022-08-06 18:11:48 +00:00			`<param index="0" name="right" type="RID" />`
doc: Sync classref to add operators after #43419 2020-11-10 13:16:20 +00:00			`<description>`
Add missing RID operator descriptions Also tweaks the descriptions above a bit. 2022-11-03 20:00:52 +00:00			`Returns [code]true[/code] if the [RID]'s ID is greater than [param right]'s ID.`
doc: Sync classref to add operators after #43419 2020-11-10 13:16:20 +00:00			`</description>`
Move the docs for constructors and operators out of methods section 2021-09-21 02:49:02 +00:00			`</operator>`
			`<operator name="operator >=">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 13:28:05 +00:00			`<return type="bool" />`
Rename the argument tag to param in XML documentation 2022-08-06 18:11:48 +00:00			`<param index="0" name="right" type="RID" />`
doc: Sync classref to add operators after #43419 2020-11-10 13:16:20 +00:00			`<description>`
Add missing RID operator descriptions Also tweaks the descriptions above a bit. 2022-11-03 20:00:52 +00:00			`Returns [code]true[/code] if the [RID]'s ID is greater than or equal to [param right]'s ID.`
doc: Sync classref to add operators after #43419 2020-11-10 13:16:20 +00:00			`</description>`
Move the docs for constructors and operators out of methods section 2021-09-21 02:49:02 +00:00			`</operator>`
			`</operators>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</class>`