Struct SignalsOfProjectSettings 

pub struct SignalsOfProjectSettings<'c, C>
where
    C: WithSignals,
{ /* private fields */ }

A collection of signals for the ProjectSettings class.

Implementations

impl<'c, C> SignalsOfProjectSettings<'c, C>

where C: WithSignals,

pub fn settings_changed(&mut self) -> SigSettingsChanged<'c, C>

Signature: ()

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

pub fn has_setting(&self, name: impl AsArg<GString>) -> bool

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

pub fn get_setting(&self, name: impl AsArg<GString>) -> Variant

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

pub fn get_setting_ex<'a>( &'a self, name: impl AsArg<GString> + 'a, ) -> ExGetSetting<'a>

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

pub fn get_global_class_list(&mut self) -> Array<Dictionary>

pub fn get_setting_with_override_and_custom_features( &self, name: impl AsArg<StringName>, features: &PackedArray<GString>, ) -> Variant

pub fn set_order(&mut self, name: impl AsArg<GString>, position: i32)

pub fn get_order(&self, name: impl AsArg<GString>) -> i32

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

pub fn set_as_basic(&mut self, name: impl AsArg<GString>, basic: bool)

pub fn set_as_internal(&mut self, name: impl AsArg<GString>, internal: bool)

pub fn add_property_info(&mut self, hint: &Dictionary)

pub fn set_restart_if_changed( &mut self, name: impl AsArg<GString>, restart: bool, )

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

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

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

pub fn save(&mut self) -> Error

pub fn load_resource_pack(&mut self, pack: impl AsArg<GString>) -> bool

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

pub fn load_resource_pack_ex<'a>( &'a mut self, pack: impl AsArg<GString> + 'a, ) -> ExLoadResourcePack<'a>

pub fn save_custom(&mut self, file: impl AsArg<GString>) -> Error

Methods from Deref<Target = Object>

pub fn get_script(&self) -> Option<Gd<Script>>

pub fn set_script(&mut self, script: impl AsArg<Option<Gd<Script>>>)

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

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

pub fn get_class(&self) -> GString

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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.

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

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

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

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.

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.

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.

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.

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.

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.

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

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

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

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

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

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

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

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

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

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

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

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

pub fn is_blocking_signals(&self) -> bool

pub fn notify_property_list_changed(&mut self)

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

pub fn can_translate_messages(&self) -> bool

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.

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

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.

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

pub fn get_translation_domain(&self) -> StringName

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

pub fn is_queued_for_deletion(&self) -> bool

pub fn cancel_free(&mut self)

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.

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

impl<'c, C> Deref for SignalsOfProjectSettings<'c, C>

where C: WithSignals,

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

The resulting type after dereferencing.

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

Dereferences the value.

impl<'c, C> DerefMut for SignalsOfProjectSettings<'c, C>

where C: WithSignals,

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

Mutably dereferences the value.