EncodedObjectAsID.xml 1.0 KB

12345678910111213141516171819202122
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="EncodedObjectAsID" inherits="Reference" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
  3. <brief_description>
  4. Holds a reference to an [Object]'s instance ID.
  5. </brief_description>
  6. <description>
  7. 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].
  8. 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.
  9. </description>
  10. <tutorials>
  11. </tutorials>
  12. <methods>
  13. </methods>
  14. <members>
  15. <member name="object_id" type="int" setter="set_object_id" getter="get_object_id" default="0">
  16. The [Object] identifier stored in this [EncodedObjectAsID] instance. The object instance can be retrieved with [method @GDScript.instance_from_id].
  17. </member>
  18. </members>
  19. <constants>
  20. </constants>
  21. </class>