Struct Os

#[repr(C)]
pub struct Os { /* private fields */ }

Godot class OS.

Inherits Object.

Related symbols:

• os: sidecar module with related enum/flag types

See also Godot docs for OS.

Singleton

This class is a singleton. You can get the one instance using Os::singleton().

Final class

This class is final, meaning you cannot inherit from it, and it comes without I* interface trait. It is still possible that other Godot classes inherit from it, but that is limited to the engine itself.

Implementations

impl Os

pub fn singleton() -> Gd<Self>

pub fn get_entropy(&mut self, size: i32) -> PackedByteArray

pub fn get_system_ca_certificates(&mut self) -> GString

pub fn get_connected_midi_inputs(&mut self) -> PackedStringArray

pub fn open_midi_inputs(&mut self)

pub fn close_midi_inputs(&mut self)

pub fn alert(&mut self, text: impl AsArg<GString>)

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

pub fn alert_ex<'a>(&'a mut self, text: impl AsArg<GString> + 'a) -> ExAlert<'a>

pub fn crash(&mut self, message: impl AsArg<GString>)

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

pub fn is_in_low_processor_usage_mode(&self) -> bool

pub fn set_low_processor_usage_mode_sleep_usec(&mut self, usec: i32)

pub fn get_low_processor_usage_mode_sleep_usec(&self) -> i32

pub fn set_delta_smoothing(&mut self, delta_smoothing_enabled: bool)

pub fn is_delta_smoothing_enabled(&self) -> bool

pub fn get_processor_count(&self) -> i32

pub fn get_processor_name(&self) -> GString

pub fn get_system_fonts(&self) -> PackedStringArray

pub fn get_system_font_path(&self, font_name: impl AsArg<GString>) -> GString

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

pub fn get_system_font_path_ex<'a>( &'a self, font_name: impl AsArg<GString> + 'a, ) -> ExGetSystemFontPath<'a>

pub fn get_system_font_path_for_text( &self, font_name: impl AsArg<GString>, text: impl AsArg<GString>, ) -> PackedStringArray

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

pub fn get_system_font_path_for_text_ex<'a>( &'a self, font_name: impl AsArg<GString> + 'a, text: impl AsArg<GString> + 'a, ) -> ExGetSystemFontPathForText<'a>

pub fn get_executable_path(&self) -> GString

pub fn read_string_from_stdin(&mut self, buffer_size: i64) -> GString

pub fn read_buffer_from_stdin(&mut self, buffer_size: i64) -> PackedByteArray

pub fn get_stdin_type(&self) -> StdHandleType

pub fn get_stdout_type(&self) -> StdHandleType

pub fn get_stderr_type(&self) -> StdHandleType

pub fn execute( &mut self, path: impl AsArg<GString>, arguments: &PackedStringArray, ) -> i32

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

pub fn execute_ex<'a>( &'a mut self, path: impl AsArg<GString> + 'a, arguments: &'a PackedStringArray, ) -> ExExecute<'a>

pub fn execute_with_pipe( &mut self, path: impl AsArg<GString>, arguments: &PackedStringArray, ) -> Dictionary

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

pub fn execute_with_pipe_ex<'a>( &'a mut self, path: impl AsArg<GString> + 'a, arguments: &'a PackedStringArray, ) -> ExExecuteWithPipe<'a>

pub fn create_process( &mut self, path: impl AsArg<GString>, arguments: &PackedStringArray, ) -> i32

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

pub fn create_process_ex<'a>( &'a mut self, path: impl AsArg<GString> + 'a, arguments: &'a PackedStringArray, ) -> ExCreateProcess<'a>

pub fn create_instance(&mut self, arguments: &PackedStringArray) -> i32

pub fn kill(&mut self, pid: i32) -> Error

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

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

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

pub fn shell_show_in_file_manager_ex<'a>( &'a mut self, file_or_dir_path: impl AsArg<GString> + 'a, ) -> ExShellShowInFileManager<'a>

pub fn is_process_running(&self, pid: i32) -> bool

pub fn get_process_exit_code(&self, pid: i32) -> i32

pub fn get_process_id(&self) -> i32

pub fn has_environment(&self, variable: impl AsArg<GString>) -> bool

pub fn get_environment(&self, variable: impl AsArg<GString>) -> GString

pub fn set_environment( &self, variable: impl AsArg<GString>, value: impl AsArg<GString>, )

pub fn unset_environment(&self, variable: impl AsArg<GString>)

pub fn get_name(&self) -> GString

pub fn get_distribution_name(&self) -> GString

pub fn get_version(&self) -> GString

pub fn get_version_alias(&self) -> GString

pub fn get_cmdline_args(&mut self) -> PackedStringArray

pub fn get_cmdline_user_args(&mut self) -> PackedStringArray

pub fn get_video_adapter_driver_info(&self) -> PackedStringArray

pub fn set_restart_on_exit(&mut self, restart: bool)

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

pub fn set_restart_on_exit_ex<'a>( &'a mut self, restart: bool, ) -> ExSetRestartOnExit<'a>

pub fn is_restart_on_exit_set(&self) -> bool

pub fn get_restart_on_exit_arguments(&self) -> PackedStringArray

pub fn delay_usec(&self, usec: i32)

pub fn delay_msec(&self, msec: i32)

pub fn get_locale(&self) -> GString

pub fn get_locale_language(&self) -> GString

pub fn get_model_name(&self) -> GString

pub fn is_userfs_persistent(&self) -> bool

pub fn is_stdout_verbose(&self) -> bool

pub fn is_debug_build(&self) -> bool

pub fn get_static_memory_usage(&self) -> u64

pub fn get_static_memory_peak_usage(&self) -> u64

pub fn get_memory_info(&self) -> Dictionary

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

pub fn get_user_data_dir(&self) -> GString

pub fn get_system_dir(&self, dir: SystemDir) -> GString

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

pub fn get_system_dir_ex<'a>(&'a self, dir: SystemDir) -> ExGetSystemDir<'a>

pub fn get_config_dir(&self) -> GString

pub fn get_data_dir(&self) -> GString

pub fn get_cache_dir(&self) -> GString

pub fn get_temp_dir(&self) -> GString

pub fn get_unique_id(&self) -> GString

pub fn get_keycode_string(&self, code: Key) -> GString

pub fn is_keycode_unicode(&self, code: u32) -> bool

pub fn find_keycode_from_string(&self, string: impl AsArg<GString>) -> Key

pub fn set_use_file_access_save_and_swap(&mut self, enabled: bool)

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

pub fn get_thread_caller_id(&self) -> u64

pub fn get_main_thread_id(&self) -> u64

pub fn has_feature(&self, tag_name: impl AsArg<GString>) -> bool

pub fn is_sandboxed(&self) -> bool

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

pub fn request_permissions(&mut self) -> bool

pub fn get_granted_permissions(&self) -> PackedStringArray

pub fn revoke_granted_permissions(&mut self)

Methods from Deref<Target = Object>

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_script(&mut self, script: &Variant)

pub fn get_script(&self) -> 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: &VariantArray, ) -> 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 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.

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

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 Bounds for Os

type Memory = MemManual

Defines the memory strategy of the static type.

type Declarer = DeclEngine

Whether this class is a core Godot class provided by the engine, or declared by the user as a Rust struct.

impl Debug for Os

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

Formats the value using the given formatter.

impl Deref for Os

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Os

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl GodotClass for Os

const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene

Initialization level, during which this class should be initialized with Godot.

type Base = Object

The immediate superclass of T. This is always a Godot engine class.

fn class_name() -> ClassName

The name of the class, under which it is registered in Godot.

fn inherits<U: GodotClass>() -> bool

Returns whether Self inherits from U.

impl WithSignals for Os

Available on since_api="4.2" only.

type SignalCollection<'c, C: WithSignals> = SignalsOfObject<'c, C>

The associated struct listing all signals of this class.

impl Inherits<Object> for Os