Struct Reference
Base class for reference-counted objects.
struct Reference
;
Base class for any object that keeps a reference count. Resource and many other helper objects inherit this class.
References keep an internal reference counter so that they are automatically released when no longer in use, and only then. References therefore do not need to be freed manually with GodotObject.
In the vast majority of use cases, instantiating and using Reference-derived types is all you need to do. The methods provided in this class are only for advanced users, and can cause issues if misused.
Methods
| Name | Description |
|---|---|
initRef
|
Initializes the internal reference counter. Use this only if you really know what you are doing. Returns whether the initialization was successful. |
reference
|
Increments the internal reference counter. Use this only if you really know what you are doing.
Returns true if the increment was successful, false otherwise.
|
unreference
|
Decrements the internal reference counter. Use this only if you really know what you are doing.
Returns true if the decrement was successful, false otherwise.
|