Struct GlobalConstants

Source

pub struct GlobalConstants { /* private fields */ }

Expand description

core singleton class GlobalConstants (reference-counted)

§Official documentation

See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.

§Memory management

The lifetime of this object is automatically managed through reference counting.

§Safety

All types in the Godot API have interior mutability in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Ownership in these types tracks whether ownership is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations§

Source §

impl GlobalConstants

Constants

Source

pub fn godot_singleton() -> &'static Self

Returns a reference to the singleton instance.

Trait Implementations§

Source §

impl Debug for GlobalConstants

Source §

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Source §

impl GodotObject for GlobalConstants

Source §

type Memory = RefCounted

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

Source §

fn class_name() -> &'static str

Source §

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

Source §

fn cast<T>(&self) -> Option<&T>
where T: GodotObject + SubClass<Self>,

Performs a dynamic reference downcast to target type. Read more

Source §

fn upcast<T>(&self) -> &T
where T: GodotObject, Self: SubClass<T>,

Performs a static reference upcast to a supertype that is guaranteed to be valid. Read more

Source §

unsafe fn assume_shared(&self) -> Ref<Self>
where Self: Sized,

Creates a persistent reference to the same Godot object with shared thread access. Read more

Source §

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal>
where Self: Sized + GodotObject<Memory = RefCounted>,

Creates a persistent reference to the same Godot object with thread-local thread access. Read more

Source §

unsafe fn assume_unique(&self) -> Ref<Self, Unique>
where Self: Sized,

Creates a persistent reference to the same Godot object with unique access. Read more

Source §

unsafe fn try_from_instance_id<'a>(id: i64) -> Option<TRef<'a, Self>>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive. See also TRef::try_from_instance_id. Read more

Source §

unsafe fn from_instance_id<'a>(id: i64) -> TRef<'a, Self>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive, and panics otherwise. This does NOT guarantee that the resulting reference is safe to use. Read more

Source §