Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

OS

Inherits: Object

Provides access to common operating system functionalities.

Description

This class wraps the most common functionalities for communicating with the host operating system, such as the video driver, delays, environment variables, execution of binaries, command line, etc.

Note: In Godot 4, OS functions related to window management were moved to the DisplayServer singleton.

Tutorials

• OS Test Demo

Properties

bool	delta_smoothing	true
bool	low_processor_usage_mode	false
int	low_processor_usage_mode_sleep_usec	6900

Methods

void	alert ( String text, String title="Alert!" )
void	close_midi_inputs ( )
void	crash ( String message )
int	create_instance ( PackedStringArray arguments )
int	create_process ( String path, PackedStringArray arguments, bool open_console=false )
void	delay_msec ( int msec ) const
void	delay_usec ( int usec ) const
int	execute ( String path, PackedStringArray arguments, Array output=[], bool read_stderr=false, bool open_console=false )
Key	find_keycode_from_string ( String string ) const
String	get_cache_dir ( ) const
PackedStringArray	get_cmdline_args ( )
PackedStringArray	get_cmdline_user_args ( )
String	get_config_dir ( ) const
PackedStringArray	get_connected_midi_inputs ( )
String	get_data_dir ( ) const
String	get_distribution_name ( ) const
String	get_environment ( String variable ) const
String	get_executable_path ( ) const
PackedStringArray	get_granted_permissions ( ) const
String	get_keycode_string ( Key code ) const
String	get_locale ( ) const
String	get_locale_language ( ) const
int	get_main_thread_id ( ) const
Dictionary	get_memory_info ( ) const
String	get_model_name ( ) const
String	get_name ( ) const
int	get_process_id ( ) const
int	get_processor_count ( ) const
String	get_processor_name ( ) const
PackedStringArray	get_restart_on_exit_arguments ( ) const
int	get_static_memory_peak_usage ( ) const
int	get_static_memory_usage ( ) const
String	get_system_dir ( SystemDir dir, bool shared_storage=true ) const
String	get_system_font_path ( String font_name, int weight=400, int stretch=100, bool italic=false ) const
PackedStringArray	get_system_font_path_for_text ( String font_name, String text, String locale="", String script="", int weight=400, int stretch=100, bool italic=false ) const
PackedStringArray	get_system_fonts ( ) const
int	get_thread_caller_id ( ) const
String	get_unique_id ( ) const
String	get_user_data_dir ( ) const
String	get_version ( ) const
PackedStringArray	get_video_adapter_driver_info ( ) const
bool	has_environment ( String variable ) const
bool	has_feature ( String tag_name ) const
bool	is_debug_build ( ) const
bool	is_keycode_unicode ( int code ) const
bool	is_process_running ( int pid ) const
bool	is_restart_on_exit_set ( ) const
bool	is_sandboxed ( )