Struct gdnative::api::JNISingleton

pub struct JNISingleton { /* fields omitted */ }

core class JNISingleton inherits Object (unsafe).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine.

JNISingleton is a reference-only type. Persistent references can only exist in the unsafe Ref<JNISingleton> form.

In the cases where Rust code owns an object of this type, for example if the object was just created on the Rust side and not passed to the engine yet, ownership should be either given to the engine or the object must be manually destroyed using Ptr::free, or Ptr::queue_free if it is a Node.

Class hierarchy

JNISingleton inherits methods from:

• Object

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 Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl JNISingleton

pub fn new() -> Ref<JNISingleton, Unique>

Creates a new instance of this object.

Because this type is not reference counted, the lifetime of the returned object is not automatically managed.

Immediately after creation, the object is owned by the caller, and can be passed to the engine (in which case the engine will be responsible for destroying the object) or destroyed manually using Ptr::free, or preferably Ptr::queue_free if it is a Node.

Methods from Deref<Target = Object>

pub const CONNECT_DEFERRED: i64

pub const CONNECT_ONESHOT: i64

pub const CONNECT_PERSIST: i64

pub const CONNECT_REFERENCE_COUNTED: i64

pub const NOTIFICATION_POSTINITIALIZE: i64

pub const NOTIFICATION_PREDELETE: i64

pub fn add_user_signal(
    &self,
    signal: impl Into<GodotString>,
    arguments: VariantArray<Shared>
)

pub unsafe fn call(
    &self,
    method: impl Into<GodotString>,
    varargs: &[Variant]
) -> Variant

pub unsafe fn call_deferred(
    &self,
    method: impl Into<GodotString>,
    varargs: &[Variant]
) -> Variant

pub fn callv(
    &self,
    method: impl Into<GodotString>,
    arg_array: VariantArray<Shared>
) -> Variant

pub fn can_translate_messages(&self) -> bool

pub fn connect(
    &self,
    signal: impl Into<GodotString>,
    target: impl AsArg<Object>,
    method: impl Into<GodotString>,
    binds: VariantArray<Shared>,
    flags: i64
) -> Result<(), GodotError>

pub fn disconnect(
    &self,
    signal: impl Into<GodotString>,
    target: impl AsArg<Object>,
    method: impl Into<GodotString>
)

pub fn emit_signal(
    &self,
    signal: impl Into<GodotString>,
    varargs: &[Variant]
) -> Variant

pub fn get(&self, property: impl Into<GodotString>) -> Variant

pub fn get_class(&self) -> GodotString

pub fn get_incoming_connections(&self) -> VariantArray<Shared>

pub fn get_indexed(&self, property: impl Into<NodePath>) -> Variant

pub fn get_instance_id(&self) -> i64

pub fn get_meta(&self, name: impl Into<GodotString>) -> Variant

pub fn get_meta_list(&self) -> TypedArray<GodotString>

pub fn get_method_list(&self) -> VariantArray<Shared>

pub fn get_property_list(&self) -> VariantArray<Shared>

pub fn get_script(&self) -> Option<Ref<Reference, Shared>>

pub fn get_signal_connection_list(
    &self,
    signal: impl Into<GodotString>
) -> VariantArray<Shared>

pub fn get_signal_list(&self) -> VariantArray<Shared>

pub fn has_meta(&self, name: impl Into<GodotString>) -> bool

pub fn has_method(&self, method: impl Into<GodotString>) -> bool

pub fn has_signal(&self, signal: impl Into<GodotString>) -> bool

pub fn has_user_signal(&self, signal: impl Into<GodotString>) -> bool

pub fn is_blocking_signals(&self) -> bool

pub fn is_class(&self, class: impl Into<GodotString>) -> bool

pub fn is_connected(
    &self,
    signal: impl Into<GodotString>,
    target: impl AsArg<Object>,
    method: impl Into<GodotString>
) -> bool

pub fn is_queued_for_deletion(&self) -> bool

pub fn notification(&self, what: i64, reversed: bool)

pub fn property_list_changed_notify(&self)

pub fn remove_meta(&self, name: impl Into<GodotString>)

pub fn set(&self, property: impl Into<GodotString>, value: impl OwnedToVariant)

pub fn set_block_signals(&self, enable: bool)

pub fn set_deferred(
    &self,
    property: impl Into<GodotString>,
    value: impl OwnedToVariant
)

pub fn set_indexed(
    &self,
    property: impl Into<NodePath>,
    value: impl OwnedToVariant
)

pub fn set_message_translation(&self, enable: bool)

pub fn set_meta(&self, name: impl Into<GodotString>, value: impl OwnedToVariant)

pub fn set_script(&self, script: impl AsArg<Reference>)

pub fn to_string(&self) -> GodotString

pub fn tr(&self, message: impl Into<GodotString>) -> GodotString

Trait Implementations

impl Debug for JNISingleton

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

Formats the value using the given formatter.

impl Deref for JNISingleton

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Object

Dereferences the value.

impl DerefMut for JNISingleton

fn deref_mut(&mut self) -> &mut Object

Mutably dereferences the value.

impl GodotObject for JNISingleton

type RefKind = ManuallyManaged

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

fn class_name() -> &'static str

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.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

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

Performs a dynamic reference downcast to target type.

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

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

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

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

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

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

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

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

impl Instanciable for JNISingleton

fn construct() -> Ref<JNISingleton, Unique>

impl SubClass<Object> for JNISingleton