Documentation
¶
Overview ¶
Utility class which holds a reference to the internal identifier of an graphics.gd/classdb/Object instance, as given by graphics.gd/classdb/Object.Instance.GetInstanceId. This ID can then be used to retrieve the object instance with [graphics.gd/classdb/@GlobalScope.Instance.InstanceFromId].
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.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AsEncodedObjectAsID() Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) ID() ID
- func (self Instance) ObjectId() int
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetObjectId(value int)
- func (self Instance) Virtual(name string) reflect.Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsEncodedObjectAsID ¶
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
type Instance [1]gdclass.EncodedObjectAsID
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsEncodedObjectAsID ¶
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
Source Files