summaryrefslogtreecommitdiff
path: root/doc/classes/EncodedObjectAsID.xml
blob: 50caa3f9734c0e9a12b95dbbf1fc2b7d506c6ca4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<?xml version="1.0" encoding="UTF-8" ?>
<class name="EncodedObjectAsID" inherits="Reference" version="3.2">
	<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 @GDScript.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>
	<methods>
	</methods>
	<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 @GDScript.instance_from_id].
		</member>
	</members>
	<constants>
	</constants>
</class>