mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
54 lines
2.6 KiB
ReStructuredText
54 lines
2.6 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EncodedObjectAsID.xml.
|
|
|
|
.. _class_EncodedObjectAsID:
|
|
|
|
EncodedObjectAsID
|
|
=================
|
|
|
|
**Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
Holds a reference to an :ref:`Object<class_Object>`'s instance 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:`@GlobalScope.instance_from_id<class_@GlobalScope_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.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-----------------------+--------------------------------------------------------------+-------+
|
|
| :ref:`int<class_int>` | :ref:`object_id<class_EncodedObjectAsID_property_object_id>` | ``0`` |
|
|
+-----------------------+--------------------------------------------------------------+-------+
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_EncodedObjectAsID_property_object_id:
|
|
|
|
- :ref:`int<class_int>` **object_id**
|
|
|
|
+-----------+----------------------+
|
|
| *Default* | ``0`` |
|
|
+-----------+----------------------+
|
|
| *Setter* | set_object_id(value) |
|
|
+-----------+----------------------+
|
|
| *Getter* | get_object_id() |
|
|
+-----------+----------------------+
|
|
|
|
The :ref:`Object<class_Object>` identifier stored in this ``EncodedObjectAsID`` instance. The object instance can be retrieved with :ref:`@GlobalScope.instance_from_id<class_@GlobalScope_method_instance_from_id>`.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
|
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
|
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|