Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

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_stdout_verbose ( ) const
bool	is_userfs_persistent ( ) const
Error	kill ( int pid )
Error	move_to_trash ( String path ) const
void	open_midi_inputs ( )
String	read_string_from_stdin ( )
bool	request_permission ( String name )
bool	request_permissions ( )
void	set_environment ( String variable, String value ) const
void	set_restart_on_exit ( bool restart, PackedStringArray arguments=PackedStringArray() )
Error	set_thread_name ( String name )
void	set_use_file_access_save_and_swap ( bool enabled )
Error	shell_open ( String uri )
Error	shell_show_in_file_manager ( String file_or_dir_path, bool open_folder=true )
void	unset_environment ( String variable ) const

Enumerations¶

enum RenderingDriver:

RenderingDriver RENDERING_DRIVER_VULKAN = 0

The Vulkan rendering driver. It requires Vulkan 1.0 support and automatically uses features from Vulkan 1.1 and 1.2 if available.

RenderingDriver RENDERING_DRIVER_OPENGL3 = 1

The OpenGL 3 rendering driver. It uses OpenGL 3.3 Core Profile on desktop platforms, OpenGL ES 3.0 on mobile devices, and WebGL 2.0 on Web.

enum SystemDir:

SystemDir SYSTEM_DIR_DESKTOP = 0

Desktop directory path.

SystemDir SYSTEM_DIR_DCIM = 1

DCIM (Digital Camera Images) directory path.

SystemDir SYSTEM_DIR_DOCUMENTS = 2

Documents directory path.

SystemDir SYSTEM_DIR_DOWNLOADS = 3

Downloads directory path.

SystemDir SYSTEM_DIR_MOVIES = 4

Movies directory path.

SystemDir SYSTEM_DIR_MUSIC = 5

Music directory path.

SystemDir SYSTEM_DIR_PICTURES = 6

Pictures directory path.

SystemDir SYSTEM_DIR_RINGTONES = 7

Ringtones directory path.

Property Descriptions¶

bool delta_smoothing = true

void set_delta_smoothing ( bool value )
bool is_delta_smoothing_enabled ( )

If true, the engine filters the time delta measured between each frame, and attempts to compensate for random variation. This will only operate on systems where V-Sync is active.

bool low_processor_usage_mode = false

void set_low_processor_usage_mode ( bool value )
bool is_in_low_processor_usage_mode ( )

If true, the engine optimizes for low processor usage by only refreshing the screen if needed. Can improve battery consumption on mobile.

int low_processor_usage_mode_sleep_usec = 6900

void set_low_processor_usage_mode_sleep_usec ( int value )
int get_low_processor_usage_mode_sleep_usec ( )

The amount of sleeping between frames when the low-processor usage mode is enabled (in microseconds). Higher values will result in lower CPU usage.

Method Descriptions¶

void alert ( String text, String title="Alert!" )

Displays a modal dialog box using the host OS' facilities. Execution is blocked until the dialog is closed.

void close_midi_inputs ( )

Shuts down system MIDI driver.

Note: This method is implemented on Linux, macOS and Windows.

void crash ( String message )

Crashes the engine (or the editor if called within a @tool script). This should only be used for testing the system's crash handler, not for any other purpose. For general error reporting, use (in order of preference) @GDScript.assert,