virtualx-engine/doc/classes/RID.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="RID" category="Built-In Types" version="3.2">
	<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 [VisualServer].
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="RID">
			<return type="RID">
			</return>
			<argument index="0" name="from" type="Object">
			</argument>
			<description>
				Creates a new RID instance with the ID of a given resource. When not handed a valid resource, silently stores the unused ID 0.
			</description>
		</method>
		<method name="get_id">
			<return type="int">
			</return>
			<description>
				Returns the ID of the referenced resource.
			</description>
		</method>
	</methods>
	<constants>
	</constants>
</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 22:42:36 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
doc: Bump version to 3.2 2019-04-01 12:33:56 +02:00			`<class name="RID" category="Built-In Types" version="3.2">`
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 22:42:36 +02:00			`<brief_description>`
			`Handle for a [Resource]'s unique ID.`
			`</brief_description>`
			`<description>`
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies 2019-06-22 01:04:47 +02:00			`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 [VisualServer].`
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 22:42:36 +02:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<methods>`
			`<method name="RID">`
			`<return type="RID">`
			`</return>`
			`<argument index="0" name="from" type="Object">`
			`</argument>`
			`<description>`
[DOCS] Classref additions and corrections 2018-09-01 20:07:51 +02:00			`Creates a new RID instance with the ID of a given resource. When not handed a valid resource, silently stores the unused ID 0.`
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 22:42:36 +02:00			`</description>`
			`</method>`
			`<method name="get_id">`
			`<return type="int">`
			`</return>`
			`<description>`
[DOCS] Classref additions and corrections 2018-09-01 20:07:51 +02:00			`Returns the ID of the referenced 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 22:42:36 +02:00			`</description>`
			`</method>`
			`</methods>`
			`<constants>`
			`</constants>`
			`</class>`