Reference

Base class for reference-counted objects.

Base class for any object that keeps a reference count. Resource and many other helper objects inherit this class. Unlike other GodotObject types, 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.free. 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. Note: In C#, references will not be freed instantly after they are no longer in use. Instead, garbage collection will run periodically and will free references that are no longer in use. This means that unused references will linger on for a while before being removed.

@GodotBaseClass

struct Reference {

package

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(Reference other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static Reference _new();

bool initRef();

bool reference();

bool unreference();

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Functions

initRef bool initRef(): Initializes the internal reference counter. Use this only if you really know what you are doing. Returns whether the initialization was successful.
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(Reference other)
opEquals bool opEquals(typeof(null) n)
reference bool 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.
toHash size_t toHash()
unreference bool 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.

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Static functions

_new Reference _new(): Construct a new instance of Reference. Note: use memnew!Reference instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(ToRef) as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Reference

Members

Aliases

Functions

Mixins

Static functions

Static variables

Structs

Unions

Variables

Mixed In Members

From `mixin baseCasts`

Meta

Source

Reference

From mixin baseCasts

From `mixin baseCasts`