Struct SignalsOfResource

Source
pub struct SignalsOfResource<'c, C>
where C: WithSignals,
{ /* private fields */ }
Expand description

A collection of signals for the Resource class.

Implementations§

Source§

impl<'c, C> SignalsOfResource<'c, C>
where C: WithSignals,

Source

pub fn changed(&mut self) -> SigChanged<'c, C>

Signature: ()

Source

pub fn setup_local_to_scene_requested( &mut self, ) -> SigSetupLocalToSceneRequested<'c, C>

Signature: ()

Methods from Deref<Target = <<Resource as GodotClass>::Base as WithSignals>::SignalCollection<'c, C>>§

Source

pub fn set_path(&mut self, path: impl AsArg<GString>)

Source

pub fn take_over_path(&mut self, path: impl AsArg<GString>)

Source

pub fn get_path(&self) -> GString

Source

pub fn set_path_cache(&mut self, path: impl AsArg<GString>)

Source

pub fn set_name(&mut self, name: impl AsArg<GString>)

Source

pub fn get_name(&self) -> GString

Source

pub fn get_rid(&self) -> Rid

Source

pub fn set_local_to_scene(&mut self, enable: bool)

Source

pub fn is_local_to_scene(&self) -> bool

Source

pub fn get_local_scene(&self) -> Option<Gd<Node>>

Source

pub fn setup_local_to_scene(&mut self)

Source

pub fn reset_state(&mut self)

Source

pub fn set_id_for_path( &mut self, path: impl AsArg<GString>, id: impl AsArg<GString>, )

Source

pub fn get_id_for_path(&self, path: impl AsArg<GString>) -> GString

Source

pub fn is_built_in(&self) -> bool

Source

pub fn set_scene_unique_id(&mut self, id: impl AsArg<GString>)

Source

pub fn get_scene_unique_id(&self) -> GString

Source

pub fn emit_changed(&mut self)

Source

pub fn duplicate(&self) -> Option<Gd<Resource>>

To set the default parameters, use Self::duplicate_ex and its builder methods. See the book for detailed usage instructions.

Source

pub fn duplicate_ex<'a>(&'a self) -> ExDuplicate<'a>

Methods from Deref<Target = RefCounted>§

Methods from Deref<Target = Object>§

Source

pub fn get_class(&self) -> GString

Source

pub fn is_class(&self, class: impl AsArg<GString>) -> bool

Source

pub fn set(&mut self, property: impl AsArg<StringName>, value: &Variant)

Source

pub fn get(&self, property: impl AsArg<StringName>) -> Variant

Source

pub fn set_indexed( &mut self, property_path: impl AsArg<NodePath>, value: &Variant, )

Source

pub fn get_indexed(&self, property_path: impl AsArg<NodePath>) -> Variant

Source

pub fn get_property_list(&self) -> Array<Dictionary>

Source

pub fn get_method_list(&self) -> Array<Dictionary>

Source

pub fn property_can_revert(&self, property: impl AsArg<StringName>) -> bool

Source

pub fn property_get_revert(&self, property: impl AsArg<StringName>) -> Variant

Source

pub fn set_script(&mut self, script: &Variant)

Source

pub fn get_script(&self) -> Variant

Source

pub fn set_meta(&mut self, name: impl AsArg<StringName>, value: &Variant)

Source

pub fn remove_meta(&mut self, name: impl AsArg<StringName>)

Source

pub fn get_meta(&self, name: impl AsArg<StringName>) -> Variant

To set the default parameters, use Self::get_meta_ex and its builder methods. See the book for detailed usage instructions.

Source

pub fn get_meta_ex<'a>( &'a self, name: impl AsArg<StringName> + 'a, ) -> ExGetMeta<'a>

Source

pub fn has_meta(&self, name: impl AsArg<StringName>) -> bool

Source

pub fn get_meta_list(&self) -> Array<StringName>

Source

pub fn add_user_signal(&mut self, signal: impl AsArg<GString>)

To set the default parameters, use Self::add_user_signal_ex and its builder methods. See the book for detailed usage instructions.

Source

pub fn add_user_signal_ex<'a>( &'a mut self, signal: impl AsArg<GString> + 'a, ) -> ExAddUserSignal<'a>

Source

pub fn has_user_signal(&self, signal: impl AsArg<StringName>) -> bool

Source

pub fn remove_user_signal(&mut self, signal: impl AsArg<StringName>)

Source

pub fn emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Error

§Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

Source

pub fn try_emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Error, CallError>

§Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

Source

pub fn call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant

§Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

Source

pub fn try_call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>

§Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

Source

pub fn call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant

§Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

Source

pub fn try_call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>

§Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

Source

pub fn set_deferred( &mut self, property: impl AsArg<StringName>, value: &Variant, )

Source

pub fn callv( &mut self, method: impl AsArg<StringName>, arg_array: &Array<Variant>, ) -> Variant

Source

pub fn has_method(&self, method: impl AsArg<StringName>) -> bool

Source

pub fn get_method_argument_count(&self, method: impl AsArg<StringName>) -> i32

Source

pub fn has_signal(&self, signal: impl AsArg<StringName>) -> bool

Source

pub fn get_signal_list(&self) -> Array<Dictionary>

Source

pub fn get_signal_connection_list( &self, signal: impl AsArg<StringName>, ) -> Array<Dictionary>

Source

pub fn get_incoming_connections(&self) -> Array<Dictionary>

Source

pub fn connect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, ) -> Error

To set the default parameters, use Self::connect_ex and its builder methods. See the book for detailed usage instructions.

Source

pub fn connect_ex<'a>( &'a mut self, signal: impl AsArg<StringName> + 'a, callable: &'a Callable, ) -> ExConnect<'a>

Source

pub fn disconnect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, )

Source

pub fn is_connected( &self, signal: impl AsArg<StringName>, callable: &Callable, ) -> bool

Source

pub fn has_connections(&self, signal: impl AsArg<StringName>) -> bool

Source

pub fn set_block_signals(&mut self, enable: bool)

Source

pub fn is_blocking_signals(&self) -> bool

Source

pub fn notify_property_list_changed(&mut self)

Source

pub fn set_message_translation(&mut self, enable: bool)

Source

pub fn can_translate_messages(&self) -> bool

Source

pub fn tr(&self, message: impl AsArg<StringName>) -> GString

To set the default parameters, use Self::tr_ex and its builder methods. See the book for detailed usage instructions.

Source

pub fn tr_ex<'a>(&'a self, message: impl AsArg<StringName> + 'a) -> ExTr<'a>

Source

pub fn tr_n( &self, message: impl AsArg<StringName>, plural_message: impl AsArg<StringName>, n: i32, ) -> GString

To set the default parameters, use Self::tr_n_ex and its builder methods. See the book for detailed usage instructions.

Source

pub fn tr_n_ex<'a>( &'a self, message: impl AsArg<StringName> + 'a, plural_message: impl AsArg<StringName> + 'a, n: i32, ) -> ExTrN<'a>

Source

pub fn get_translation_domain(&self) -> StringName

Source

pub fn set_translation_domain(&mut self, domain: impl AsArg<StringName>)

Source

pub fn is_queued_for_deletion(&self) -> bool

Source

pub fn cancel_free(&mut self)

Source

pub fn notify(&mut self, what: ObjectNotification)

⚠️ Sends a Godot notification to all classes inherited by the object.

Triggers calls to on_notification(), and depending on the notification, also to Godot’s lifecycle callbacks such as ready().

Starts from the highest ancestor (the Object class) and goes down the hierarchy. See also Godot docs for Object::notification().

§Panics

If you call this method on a user-defined object while holding a GdRef or GdMut guard on the instance, you will encounter a panic. The reason is that the receiving virtual method on_notification() acquires a GdMut lock dynamically, which must be exclusive.

Source

pub fn notify_reversed(&mut self, what: ObjectNotification)

⚠️ Like Self::notify(), but starts at the most-derived class and goes up the hierarchy.

See docs of that method, including the panics.

Trait Implementations§

Source§

impl<'c, C> Deref for SignalsOfResource<'c, C>
where C: WithSignals,

Source§

type Target = <<Resource as GodotClass>::Base as WithSignals>::SignalCollection<'c, C>

The resulting type after dereferencing.
Source§

fn deref(&self) -> &<SignalsOfResource<'c, C> as Deref>::Target

Dereferences the value.
Source§

impl<'c, C> DerefMut for SignalsOfResource<'c, C>
where C: WithSignals,

Source§

fn deref_mut(&mut self) -> &mut <SignalsOfResource<'c, C> as Deref>::Target

Mutably dereferences the value.

Auto Trait Implementations§

§

impl<'c, C> Freeze for SignalsOfResource<'c, C>
where <C as WithSignals>::__SignalObj<'c>: Freeze,

§

impl<'c, C> RefUnwindSafe for SignalsOfResource<'c, C>

§

impl<'c, C> Send for SignalsOfResource<'c, C>
where <C as WithSignals>::__SignalObj<'c>: Send,

§

impl<'c, C> Sync for SignalsOfResource<'c, C>
where <C as WithSignals>::__SignalObj<'c>: Sync,

§

impl<'c, C> Unpin for SignalsOfResource<'c, C>
where <C as WithSignals>::__SignalObj<'c>: Unpin,

§

impl<'c, C> UnwindSafe for SignalsOfResource<'c, C>
where <C as WithSignals>::__SignalObj<'c>: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.