virtualx-engine/doc/classes/EncodedObjectAsID.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="EncodedObjectAsID" inherits="RefCounted" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Holds a reference to an [Object]'s instance ID.
	</brief_description>
	<description>
		Utility class which holds a reference to the internal identifier of an [Object] instance, as given by [method Object.get_instance_id]. This ID can then be used to retrieve the object instance with [method @GlobalScope.instance_from_id].
		This class is used internally by the editor inspector and script debugger, but can also be used in plugins to pass and display objects as their IDs.
	</description>
	<tutorials>
	</tutorials>
	<members>
		<member name="object_id" type="int" setter="set_object_id" getter="get_object_id" default="0">
			The [Object] identifier stored in this [EncodedObjectAsID] instance. The object instance can be retrieved with [method @GlobalScope.instance_from_id].
		</member>
	</members>
</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" ?>`
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions. 2022-02-14 14:18:53 +01:00			`<class name="EncodedObjectAsID" inherits="RefCounted" version="4.0" 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 22:42:36 +02:00			`<brief_description>`
doc: Document EncodedObjectAsID, expose its property 2019-06-26 10:50:45 +02:00			`Holds a reference to an [Object]'s instance ID.`
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>`
			`<description>`
doc: Sync classref with current source 2021-01-04 14:33:44 +01:00			`Utility class which holds a reference to the internal identifier of an [Object] instance, as given by [method Object.get_instance_id]. This ID can then be used to retrieve the object instance with [method @GlobalScope.instance_from_id].`
doc: Document EncodedObjectAsID, expose its property 2019-06-26 10:50:45 +02:00			`This class is used internally by the editor inspector and script debugger, but can also be used in plugins to pass and display objects as their IDs.`
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>`
doc: Document EncodedObjectAsID, expose its property 2019-06-26 10:50:45 +02:00			`<members>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="object_id" type="int" setter="set_object_id" getter="get_object_id" default="0">`
doc: Sync classref with current source 2021-01-04 14:33:44 +01:00			`The [Object] identifier stored in this [EncodedObjectAsID] instance. The object instance can be retrieved with [method @GlobalScope.instance_from_id].`
doc: Document EncodedObjectAsID, expose its property 2019-06-26 10:50:45 +02:00			`</member>`
			`</members>`
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			`</class>`