Module obj
Expand description
Types and traits related to objects.
The most important symbols in this module are:
GodotClass
, which is implemented for every class that Godot can work with (either engine- or user-provided).Gd
, a smart pointer that manages instances of Godot classes.
Modules§
- Different ways how bounds of a
GodotClass
can be checked. - Capability traits, providing dedicated functionalities for Godot classes
- Functionality related to script instances (Rust code that can be attached as node scripts).
Structs§
- Restricted version of
Gd
, to hold the base instance inside a user’sGodotClass
. - Mutable/exclusive reference guard for a
Base
pointer. - Shared reference guard for a
Base
pointer. - Smart pointer to objects owned by the Godot engine.
- Mutably/exclusively bound reference guard for a
Gd
smart pointer. - Immutably/shared bound reference guard for a
Gd
smart pointer. - Represents a non-zero instance ID.
- Ergonomic late-initialization container with
ready()
support.
Enums§
- Type representing the absence of a base class, at the root of the hierarchy.
Traits§
- Library-implemented trait to check bounds on
GodotClass
types. - Auto-implemented for all engine-provided bitfields.
- Auto-implemented for all engine-provided enums.
- Makes
T
eligible to be managed by Godot and stored inGd<T>
pointers. - Trait for enums that can be used as indices in arrays.
- Non-strict inheritance relationship in the Godot class hierarchy.
- Extension trait for all manually managed classes.
- Extension trait for all reference-counted classes.
- Trait that is automatically implemented for user classes containing a
Base<T>
field.