Class RID

A handle for a Resource's unique identifier.

RID

Remarks

The RID Variant type is used to access a low-level resource by its unique ID. RIDs are opaque, which means they do not grant access to the resource by themselves. They are used by the low-level server classes, such as DisplayServer, RenderingServer, TextServer, etc.

A low-level resource may correspond to a high-level Resource, such as Texture or Mesh.

Note: RIDs are only useful during the current session. It won't correspond to a similar resource if sent over a network, or loaded from a file at a later time.

Constructors

RID

Constructs an empty RID with the invalid ID 0.

RID RID

RID(RID)

Constructs a RID as a copy of the given RID.

RID RID(RID from)

Parameters

from RID

Methods

get_id

Qualifiers: const

Returns the ID of the referenced low-level resource.

int get_id

is_valid

Qualifiers: const

Returns true if the RID is not 0.

bool is_valid

Operators

!= (RID)

Returns true if the RIDs are not equal.

bool != (RID right)

Parameters

right RID

< (RID)

Returns true if the RID's ID is less than right's ID.

bool < (RID right)

Parameters

right RID

<= (RID)

Returns true if the RID's ID is less than or equal to right's ID.

bool <= (RID right)

Parameters

right RID

== (RID)

Returns true if both RIDs are equal, which means they both refer to the same low-level resource.

bool == (RID right)

Parameters

right RID

> (RID)

Returns true if the RID's ID is greater than right's ID.

bool > (RID right)

Parameters

right RID

>= (RID)

Returns true if the RID's ID is greater than or equal to right's ID.

bool >= (RID right)

Parameters

right RID