godot-docs/classes/class_encodedobjectasid.rst

:github_url: hide

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the EncodedObjectAsID.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_EncodedObjectAsID:

EncodedObjectAsID
=================

**Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

**Category:** Core

Brief Description
-----------------

Holds a reference to an :ref:`Object<class_Object>`'s instance ID.

Properties
----------

+-----------------------+--------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`object_id<class_EncodedObjectAsID_property_object_id>` |
+-----------------------+--------------------------------------------------------------+

Description
-----------

Utility class which holds a reference to the internal identifier of an :ref:`Object<class_Object>` instance, as given by :ref:`Object.get_instance_id<class_Object_method_get_instance_id>`. This ID can then be used to retrieve the object instance with :ref:`@GDScript.instance_from_id<class_@GDScript_method_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.

Property Descriptions
---------------------

.. _class_EncodedObjectAsID_property_object_id:

- :ref:`int<class_int>` **object_id**

+----------+----------------------+
| *Setter* | set_object_id(value) |
+----------+----------------------+
| *Getter* | get_object_id()      |
+----------+----------------------+

The :ref:`Object<class_Object>` identifier stored in this :ref:`EncodedObjectAsID<class_EncodedObjectAsID>` instance. The object instance can be retrieved with :ref:`@GDScript.instance_from_id<class_@GDScript_method_instance_from_id>`.