godot-docs/classes/class_os.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/4.0/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/4.0/doc/classes/OS.xml.

.. _class_OS:

OS
==

**Inherits:** :ref:`Object<class_Object>`

Provides access to common operating system functionalities.

.. rst-class:: classref-introduction-group

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 :ref:`DisplayServer<class_DisplayServer>` singleton.

.. rst-class:: classref-introduction-group

Tutorials
---------

- `OS Test Demo <https://godotengine.org/asset-library/asset/677>`__

.. rst-class:: classref-reftable-group

Properties
----------

.. table::
   :widths: auto

   +-------------------------+---------------------------------------------------------------------------------------------------+-----------+
   | :ref:`bool<class_bool>` | :ref:`low_processor_usage_mode<class_OS_property_low_processor_usage_mode>`                       | ``false`` |
   +-------------------------+---------------------------------------------------------------------------------------------------+-----------+
   | :ref:`int<class_int>`   | :ref:`low_processor_usage_mode_sleep_usec<class_OS_property_low_processor_usage_mode_sleep_usec>` | ``6900``  |
   +-------------------------+---------------------------------------------------------------------------------------------------+-----------+

.. rst-class:: classref-reftable-group

Methods
-------

.. table::
   :widths: auto

   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`alert<class_OS_method_alert>` **(** :ref:`String<class_String>` text, :ref:`String<class_String>` title="Alert!" **)**                                                                                                                                                                                                                                             |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`close_midi_inputs<class_OS_method_close_midi_inputs>` **(** **)**                                                                                                                                                                                                                                                                                                  |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`crash<class_OS_method_crash>` **(** :ref:`String<class_String>` message **)**                                                                                                                                                                                                                                                                                      |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                             | :ref:`create_instance<class_OS_method_create_instance>` **(** :ref:`PackedStringArray<class_PackedStringArray>` arguments **)**                                                                                                                                                                                                                                          |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                             | :ref:`create_process<class_OS_method_create_process>` **(** :ref:`String<class_String>` path, :ref:`PackedStringArray<class_PackedStringArray>` arguments, :ref:`bool<class_bool>` open_console=false **)**                                                                                                                                                              |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`delay_msec<class_OS_method_delay_msec>` **(** :ref:`int<class_int>` msec **)** |const|                                                                                                                                                                                                                                                                             |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`delay_usec<class_OS_method_delay_usec>` **(** :ref:`int<class_int>` usec **)** |const|                                                                                                                                                                                                                                                                             |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                             | :ref:`execute<class_OS_method_execute>` **(** :ref:`String<class_String>` path, :ref:`PackedStringArray<class_PackedStringArray>` arguments, :ref:`Array<class_Array>` output=[], :ref:`bool<class_bool>` read_stderr=false, :ref:`bool<class_bool>` open_console=false **)**                                                                                            |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Key<enum_@GlobalScope_Key>`                 | :ref:`find_keycode_from_string<class_OS_method_find_keycode_from_string>` **(** :ref:`String<class_String>` string **)** |const|                                                                                                                                                                                                                                         |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                       | :ref:`get_cache_dir<class_OS_method_get_cache_dir>` **(** **)** |const|                                                                                                                                                                                                                                                                                                  |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_cmdline_args<class_OS_method_get_cmdline_args>` **(** **)**                                                                                                                                                                                                                                                                                                    |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_cmdline_user_args<class_OS_method_get_cmdline_user_args>` **(** **)**                                                                                                                                                                                                                                                                                          |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                       | :ref:`get_config_dir<class_OS_method_get_config_dir>` **(** **)** |const|                                                                                                                                                                                                                                                                                                |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_connected_midi_inputs<class_OS_method_get_connected_midi_inputs>` **(** **)**                                                                                                                                                                                                                                                                                  |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                       | :ref:`get_data_dir<class_OS_method_get_data_dir>` **(** **)** |const|                                                                                                                                                                                                                                                                                                    |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                       | :ref:`get_distribution_name<class_OS_method_get_distribution_name>` **(** **)** |const|                                                                                                                                                                                                                                                                                  |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                       | :ref:`get_environment<class_OS_method_get_environment>` **(** :ref:`String<class_String>` variable **)** |const|                                                                                                                                                                                                                                                         |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                       | :ref:`get_executable_path<class_OS_method_get_executable_path>` **(** **)** |const|                                                                                                                                                                                                                                                                                      |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_granted_permissions<class_OS_method_get_granted_permissions>` **(** **)** |const|                                                                                                                                                                                                                                                                              |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                       | :ref:`get_keycode_string<class_OS_method_get_keycode_string>` **(** :ref:`Key<enum_@GlobalScope_Key>` code **)** |const|                                                                                                                                                                                                                                                 |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                       | :ref:`get_locale<class_OS_method_get_locale>` **(** **)** |const|                                                                                                                                                                                                                                                                                                        |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                       | :ref:`get_locale_language<class_OS_method_get_locale_language>` **(** **)** |const|                                                                                                                                                                                                                                                                                      |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                             | :ref:`get_main_thread_id<class_OS_method_get_main_thread_id>` **(** **)** |const|                                                                                                                                                                                                                                                                                        |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                       | :ref:`get_model_name<class_OS_method_get_model_name>` **(** **)** |const|                                                                                                                                                                                                                                                                                                |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                       | :ref:`get_name<class_OS_method_get_name>` **(** **)** |const|                                                                                                                                                                                                                                                                                                            |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                             | :ref:`get_process_id<class_OS_method_get_process_id>` **(** **)** |const|                                                                                                                                                                                                                                                                                                |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                             | :ref:`get_processor_count<class_OS_method_get_processor_count>` **(** **)** |const|                                                                                                                                                                                                                                                                                      |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                       | :ref:`get_processor_name<class_OS_method_get_processor_name>` **(** **)** |const|                                                                                                                                                                                                                                                                                        |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_restart_on_exit_arguments<class_OS_method_get_restart_on_exit_arguments>` **(** **)** |const|                                                                                                                                                                                                                                                                  |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                             | :ref:`get_static_memory_peak_usage<class_OS_method_get_static_memory_peak_usage>` **(** **)** |const|                                                                                                                                                                                                                                                                    |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                             | :ref:`get_static_memory_usage<class_OS_method_get_static_memory_usage>` **(** **)** |const|                                                                                                                                                                                                                                                                              |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                       | :ref:`get_system_dir<class_OS_method_get_system_dir>` **(** :ref:`SystemDir<enum_OS_SystemDir>` dir, :ref:`bool<class_bool>` shared_storage=true **)** |const|                                                                                                                                                                                                           |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                       | :ref:`get_system_font_path<class_OS_method_get_system_font_path>` **(** :ref:`String<class_String>` font_name, :ref:`int<class_int>` weight=400, :ref:`int<class_int>` stretch=100, :ref:`bool<class_bool>` italic=false **)** |const|                                                                                                                                   |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_system_font_path_for_text<class_OS_method_get_system_font_path_for_text>` **(** :ref:`String<class_String>` font_name, :ref:`String<class_String>` text, :ref:`String<class_String>` locale="", :ref:`String<class_String>` script="", :ref:`int<class_int>` weight=400, :ref:`int<class_int>` stretch=100, :ref:`bool<class_bool>` italic=false **)** |const| |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_system_fonts<class_OS_method_get_system_fonts>` **(** **)** |const|                                                                                                                                                                                                                                                                                            |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                             | :ref:`get_thread_caller_id<class_OS_method_get_thread_caller_id>` **(** **)** |const|                                                                                                                                                                                                                                                                                    |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                       | :ref:`get_unique_id<class_OS_method_get_unique_id>` **(** **)** |const|                                                                                                                                                                                                                                                                                                  |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                       | :ref:`get_user_data_dir<class_OS_method_get_user_data_dir>` **(** **)** |const|                                                                                                                                                                                                                                                                                          |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                       | :ref:`get_version<class_OS_method_get_version>` **(** **)** |const|                                                                                                                                                                                                                                                                                                      |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_video_adapter_driver_info<class_OS_method_get_video_adapter_driver_info>` **(** **)** |const|                                                                                                                                                                                                                                                                  |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                           | :ref:`has_environment<class_OS_method_has_environment>` **(** :ref:`String<class_String>` variable **)** |const|                                                                                                                                                                                                                                                         |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                           | :ref:`has_feature<class_OS_method_has_feature>` **(** :ref:`String<class_String>` tag_name **)** |const|                                                                                                                                                                                                                                                                 |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                           | :ref:`is_debug_build<class_OS_method_is_debug_build>` **(** **)** |const|                                                                                                                                                                                                                                                                                                |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                           | :ref:`is_keycode_unicode<class_OS_method_is_keycode_unicode>` **(** :ref:`int<class_int>` code **)** |const|                                                                                                                                                                                                                                                             |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                           | :ref:`is_process_running<class_OS_method_is_process_running>` **(** :ref:`int<class_int>` pid **)** |const|                                                                                                                                                                                                                                                              |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                           | :ref:`is_restart_on_exit_set<class_OS_method_is_restart_on_exit_set>` **(** **)** |const|                                                                                                                                                                                                                                                                                |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                           | :ref:`is_stdout_verbose<class_OS_method_is_stdout_verbose>` **(** **)** |const|                                                                                                                                                                                                                                                                                          |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                           | :ref:`is_userfs_persistent<class_OS_method_is_userfs_persistent>` **(** **)** |const|                                                                                                                                                                                                                                                                                    |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`             | :ref:`kill<class_OS_method_kill>` **(** :ref:`int<class_int>` pid **)**                                                                                                                                                                                                                                                                                                  |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`             | :ref:`move_to_trash<class_OS_method_move_to_trash>` **(** :ref:`String<class_String>` path **)** |const|                                                                                                                                                                                                                                                                 |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`open_midi_inputs<class_OS_method_open_midi_inputs>` **(** **)**                                                                                                                                                                                                                                                                                                    |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                       | :ref:`read_string_from_stdin<class_OS_method_read_string_from_stdin>` **(** **)**                                                                                                                                                                                                                                                                                        |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                           | :ref:`request_permission<class_OS_method_request_permission>` **(** :ref:`String<class_String>` name **)**                                                                                                                                                                                                                                                               |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                           | :ref:`request_permissions<class_OS_method_request_permissions>` **(** **)**                                                                                                                                                                                                                                                                                              |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`set_environment<class_OS_method_set_environment>` **(** :ref:`String<class_String>` variable, :ref:`String<class_String>` value **)** |const|                                                                                                                                                                                                                      |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`set_restart_on_exit<class_OS_method_set_restart_on_exit>` **(** :ref:`bool<class_bool>` restart, :ref:`PackedStringArray<class_PackedStringArray>` arguments=PackedStringArray() **)**                                                                                                                                                                             |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`             | :ref:`set_thread_name<class_OS_method_set_thread_name>` **(** :ref:`String<class_String>` name **)**                                                                                                                                                                                                                                                                     |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`set_use_file_access_save_and_swap<class_OS_method_set_use_file_access_save_and_swap>` **(** :ref:`bool<class_bool>` enabled **)**                                                                                                                                                                                                                                  |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`             | :ref:`shell_open<class_OS_method_shell_open>` **(** :ref:`String<class_String>` uri **)**                                                                                                                                                                                                                                                                                |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`unset_environment<class_OS_method_unset_environment>` **(** :ref:`String<class_String>` variable **)** |const|                                                                                                                                                                                                                                                     |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Enumerations
------------

.. _enum_OS_RenderingDriver:

.. rst-class:: classref-enumeration

enum **RenderingDriver**:

.. _class_OS_constant_RENDERING_DRIVER_VULKAN:

.. rst-class:: classref-enumeration-constant

:ref:`RenderingDriver<enum_OS_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.

.. _class_OS_constant_RENDERING_DRIVER_OPENGL3:

.. rst-class:: classref-enumeration-constant

:ref:`RenderingDriver<enum_OS_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.

.. rst-class:: classref-item-separator

----

.. _enum_OS_SystemDir:

.. rst-class:: classref-enumeration

enum **SystemDir**:

.. _class_OS_constant_SYSTEM_DIR_DESKTOP:

.. rst-class:: classref-enumeration-constant

:ref:`SystemDir<enum_OS_SystemDir>` **SYSTEM_DIR_DESKTOP** = ``0``

Desktop directory path.

.. _class_OS_constant_SYSTEM_DIR_DCIM:

.. rst-class:: classref-enumeration-constant

:ref:`SystemDir<enum_OS_SystemDir>` **SYSTEM_DIR_DCIM** = ``1``

DCIM (Digital Camera Images) directory path.

.. _class_OS_constant_SYSTEM_DIR_DOCUMENTS:

.. rst-class:: classref-enumeration-constant

:ref:`SystemDir<enum_OS_SystemDir>` **SYSTEM_DIR_DOCUMENTS** = ``2``

Documents directory path.

.. _class_OS_constant_SYSTEM_DIR_DOWNLOADS:

.. rst-class:: classref-enumeration-constant

:ref:`SystemDir<enum_OS_SystemDir>` **SYSTEM_DIR_DOWNLOADS** = ``3``

Downloads directory path.

.. _class_OS_constant_SYSTEM_DIR_MOVIES:

.. rst-class:: classref-enumeration-constant

:ref:`SystemDir<enum_OS_SystemDir>` **SYSTEM_DIR_MOVIES** = ``4``

Movies directory path.

.. _class_OS_constant_SYSTEM_DIR_MUSIC:

.. rst-class:: classref-enumeration-constant

:ref:`SystemDir<enum_OS_SystemDir>` **SYSTEM_DIR_MUSIC** = ``5``

Music directory path.

.. _class_OS_constant_SYSTEM_DIR_PICTURES:

.. rst-class:: classref-enumeration-constant

:ref:`SystemDir<enum_OS_SystemDir>` **SYSTEM_DIR_PICTURES** = ``6``

Pictures directory path.

.. _class_OS_constant_SYSTEM_DIR_RINGTONES:

.. rst-class:: classref-enumeration-constant

:ref:`SystemDir<enum_OS_SystemDir>` **SYSTEM_DIR_RINGTONES** = ``7``

Ringtones directory path.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Property Descriptions
---------------------

.. _class_OS_property_low_processor_usage_mode:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **low_processor_usage_mode** = ``false``

.. rst-class:: classref-property-setget

- void **set_low_processor_usage_mode** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_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.

.. rst-class:: classref-item-separator

----

.. _class_OS_property_low_processor_usage_mode_sleep_usec:

.. rst-class:: classref-property

:ref:`int<class_int>` **low_processor_usage_mode_sleep_usec** = ``6900``

.. rst-class:: classref-property-setget

- void **set_low_processor_usage_mode_sleep_usec** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_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.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Method Descriptions
-------------------

.. _class_OS_method_alert:

.. rst-class:: classref-method

void **alert** **(** :ref:`String<class_String>` text, :ref:`String<class_String>` title="Alert!" **)**

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

.. rst-class:: classref-item-separator

----

.. _class_OS_method_close_midi_inputs:

.. rst-class:: classref-method

void **close_midi_inputs** **(** **)**

Shuts down system MIDI driver.

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

.. rst-class:: classref-item-separator

----

.. _class_OS_method_crash:

.. rst-class:: classref-method

void **crash** **(** :ref:`String<class_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) :ref:`@GDScript.assert<class_@GDScript_method_assert>`, :ref:`@GlobalScope.push_error<class_@GlobalScope_method_push_error>` or :ref:`alert<class_OS_method_alert>`. See also :ref:`kill<class_OS_method_kill>`.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_create_instance:

.. rst-class:: classref-method

:ref:`int<class_int>` **create_instance** **(** :ref:`PackedStringArray<class_PackedStringArray>` arguments **)**

Creates a new instance of Godot that runs independently. The ``arguments`` are used in the given order and separated by a space.

If the process creation succeeds, the method will return the new process ID, which you can use to monitor the process (and potentially terminate it with :ref:`kill<class_OS_method_kill>`). If the process creation fails, the method will return ``-1``.

\ **Note:** This method is implemented on Android, iOS, Linux, macOS and Windows.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_create_process:

.. rst-class:: classref-method

:ref:`int<class_int>` **create_process** **(** :ref:`String<class_String>` path, :ref:`PackedStringArray<class_PackedStringArray>` arguments, :ref:`bool<class_bool>` open_console=false **)**

Creates a new process that runs independently of Godot. It will not terminate if Godot terminates. The path specified in ``path`` must exist and be executable file or macOS .app bundle. Platform path resolution will be used. The ``arguments`` are used in the given order and separated by a space.

On Windows, if ``open_console`` is ``true`` and the process is a console app, a new terminal window will be opened. This is ignored on other platforms.

If the process creation succeeds, the method will return the new process ID, which you can use to monitor the process (and potentially terminate it with :ref:`kill<class_OS_method_kill>`). If the process creation fails, the method will return ``-1``.

For example, running another instance of the project:


.. tabs::

 .. code-tab:: gdscript

    var pid = OS.create_process(OS.get_executable_path(), [])

 .. code-tab:: csharp

    var pid = OS.CreateProcess(OS.GetExecutablePath(), new string[] {});



See :ref:`execute<class_OS_method_execute>` if you wish to run an external command and retrieve the results.

\ **Note:** This method is implemented on Android, iOS, Linux, macOS and Windows.

\ **Note:** On macOS, sandboxed applications are limited to run only embedded helper executables, specified during export or system .app bundle, system .app bundles will ignore arguments.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_delay_msec:

.. rst-class:: classref-method

void **delay_msec** **(** :ref:`int<class_int>` msec **)** |const|

Delays execution of the current thread by ``msec`` milliseconds. ``msec`` must be greater than or equal to ``0``. Otherwise, :ref:`delay_msec<class_OS_method_delay_msec>` will do nothing and will print an error message.

\ **Note:** :ref:`delay_msec<class_OS_method_delay_msec>` is a *blocking* way to delay code execution. To delay code execution in a non-blocking way, see :ref:`SceneTree.create_timer<class_SceneTree_method_create_timer>`. Awaiting with :ref:`SceneTree.create_timer<class_SceneTree_method_create_timer>` will delay the execution of code placed below the ``await`` without affecting the rest of the project (or editor, for :ref:`EditorPlugin<class_EditorPlugin>`\ s and :ref:`EditorScript<class_EditorScript>`\ s).

\ **Note:** When :ref:`delay_msec<class_OS_method_delay_msec>` is called on the main thread, it will freeze the project and will prevent it from redrawing and registering input until the delay has passed. When using :ref:`delay_msec<class_OS_method_delay_msec>` as part of an :ref:`EditorPlugin<class_EditorPlugin>` or :ref:`EditorScript<class_EditorScript>`, it will freeze the editor but won't freeze the project if it is currently running (since the project is an independent child process).

.. rst-class:: classref-item-separator

----

.. _class_OS_method_delay_usec:

.. rst-class:: classref-method

void **delay_usec** **(** :ref:`int<class_int>` usec **)** |const|

Delays execution of the current thread by ``usec`` microseconds. ``usec`` must be greater than or equal to ``0``. Otherwise, :ref:`delay_usec<class_OS_method_delay_usec>` will do nothing and will print an error message.

\ **Note:** :ref:`delay_usec<class_OS_method_delay_usec>` is a *blocking* way to delay code execution. To delay code execution in a non-blocking way, see :ref:`SceneTree.create_timer<class_SceneTree_method_create_timer>`. Awaiting with :ref:`SceneTree.create_timer<class_SceneTree_method_create_timer>` will delay the execution of code placed below the ``await`` without affecting the rest of the project (or editor, for :ref:`EditorPlugin<class_EditorPlugin>`\ s and :ref:`EditorScript<class_EditorScript>`\ s).

\ **Note:** When :ref:`delay_usec<class_OS_method_delay_usec>` is called on the main thread, it will freeze the project and will prevent it from redrawing and registering input until the delay has passed. When using :ref:`delay_usec<class_OS_method_delay_usec>` as part of an :ref:`EditorPlugin<class_EditorPlugin>` or :ref:`EditorScript<class_EditorScript>`, it will freeze the editor but won't freeze the project if it is currently running (since the project is an independent child process).

.. rst-class:: classref-item-separator

----

.. _class_OS_method_execute:

.. rst-class:: classref-method

:ref:`int<class_int>` **execute** **(** :ref:`String<class_String>` path, :ref:`PackedStringArray<class_PackedStringArray>` arguments, :ref:`Array<class_Array>` output=[], :ref:`bool<class_bool>` read_stderr=false, :ref:`bool<class_bool>` open_console=false **)**

Executes a command. The file specified in ``path`` must exist and be executable. Platform path resolution will be used. The ``arguments`` are used in the given order, separated by spaces, and wrapped in quotes. If an ``output`` :ref:`Array<class_Array>` is provided, the complete shell output of the process will be appended as a single :ref:`String<class_String>` element in ``output``. If ``read_stderr`` is ``true``, the output to the standard error stream will be included too.

On Windows, if ``open_console`` is ``true`` and the process is a console app, a new terminal window will be opened. This is ignored on other platforms.

If the command is successfully executed, the method will return the exit code of the command, or ``-1`` if it fails.

\ **Note:** The Godot thread will pause its execution until the executed command terminates. Use :ref:`Thread<class_Thread>` to create a separate thread that will not pause the Godot thread, or use :ref:`create_process<class_OS_method_create_process>` to create a completely independent process.

For example, to retrieve a list of the working directory's contents:


.. tabs::

 .. code-tab:: gdscript

    var output = []
    var exit_code = OS.execute("ls", ["-l", "/tmp"], output)

 .. code-tab:: csharp

    var output = new Godot.Collections.Array();
    int exitCode = OS.Execute("ls", new string[] {"-l", "/tmp"}, output);



If you wish to access a shell built-in or execute a composite command, a platform-specific shell can be invoked. For example:


.. tabs::

 .. code-tab:: gdscript

    var output = []
    OS.execute("CMD.exe", ["/C", "cd %TEMP% && dir"], output)

 .. code-tab:: csharp

    var output = new Godot.Collections.Array();
    OS.Execute("CMD.exe", new string[] {"/C", "cd %TEMP% && dir"}, output);



\ **Note:** This method is implemented on Android, iOS, Linux, macOS and Windows.

\ **Note:** To execute a Windows command interpreter built-in command, specify ``cmd.exe`` in ``path``, ``/c`` as the first argument, and the desired command as the second argument.

\ **Note:** To execute a PowerShell built-in command, specify ``powershell.exe`` in ``path``, ``-Command`` as the first argument, and the desired command as the second argument.

\ **Note:** To execute a Unix shell built-in command, specify shell executable name in ``path``, ``-c`` as the first argument, and the desired command as the second argument.

\ **Note:** On macOS, sandboxed applications are limited to run only embedded helper executables, specified during export.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_find_keycode_from_string:

.. rst-class:: classref-method

:ref:`Key<enum_@GlobalScope_Key>` **find_keycode_from_string** **(** :ref:`String<class_String>` string **)** |const|

Returns the keycode of the given string (e.g. "Escape").

.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_cache_dir:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_cache_dir** **(** **)** |const|

Returns the *global* cache data directory according to the operating system's standards. On the Linux/BSD platform, this path can be overridden by setting the ``XDG_CACHE_HOME`` environment variable before starting the project. See :doc:`File paths in Godot projects <../tutorials/io/data_paths>` in the documentation for more information. See also :ref:`get_config_dir<class_OS_method_get_config_dir>` and :ref:`get_data_dir<class_OS_method_get_data_dir>`.

Not to be confused with :ref:`get_user_data_dir<class_OS_method_get_user_data_dir>`, which returns the *project-specific* user data path.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_cmdline_args:

.. rst-class:: classref-method

:ref:`PackedStringArray<class_PackedStringArray>` **get_cmdline_args** **(** **)**

Returns the command-line arguments passed to the engine.

Command-line arguments can be written in any form, including both ``--key value`` and ``--key=value`` forms so they can be properly parsed, as long as custom command-line arguments do not conflict with engine arguments.

You can also incorporate environment variables using the :ref:`get_environment<class_OS_method_get_environment>` method.

You can set :ref:`ProjectSettings.editor/run/main_run_args<class_ProjectSettings_property_editor/run/main_run_args>` to define command-line arguments to be passed by the editor when running the project.

Here's a minimal example on how to parse command-line arguments into a dictionary using the ``--key=value`` form for arguments:


.. tabs::

 .. code-tab:: gdscript

    var arguments = {}
    for argument in OS.get_cmdline_args():
        if argument.find("=") > -1:
            var key_value = argument.split("=")
            arguments[key_value[0].lstrip("--")] = key_value[1]
        else:
            # Options without an argument will be present in the dictionary,
            # with the value set to an empty string.
            arguments[argument.lstrip("--")] = ""

 .. code-tab:: csharp

    var arguments = new Godot.Collections.Dictionary();
    foreach (var argument in OS.GetCmdlineArgs())
    {
        if (argument.Find("=") > -1)
        {
            string[] keyValue = argument.Split("=");
            arguments[keyValue[0].LStrip("--")] = keyValue[1];
        }
        else
        {
            // Options without an argument will be present in the dictionary,
            // with the value set to an empty string.
            arguments[keyValue[0].LStrip("--")] = "";
        }
    }



\ **Note:** Passing custom user arguments directly is not recommended, as the engine may discard or modify them. Instead, the best way is to use the standard UNIX double dash (``--``) and then pass custom arguments, which the engine itself will ignore. These can be read via :ref:`get_cmdline_user_args<class_OS_method_get_cmdline_user_args>`.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_cmdline_user_args:

.. rst-class:: classref-method

:ref:`PackedStringArray<class_PackedStringArray>` **get_cmdline_user_args** **(** **)**

Similar to :ref:`get_cmdline_args<class_OS_method_get_cmdline_args>`, but this returns the user arguments (any argument passed after the double dash ``--`` or double plus ``++`` argument). These are left untouched by Godot for the user. ``++`` can be used in situations where ``--`` is intercepted by another program (such as ``startx``).

For example, in the command line below, ``--fullscreen`` will not be returned in :ref:`get_cmdline_user_args<class_OS_method_get_cmdline_user_args>` and ``--level 1`` will only be returned in :ref:`get_cmdline_user_args<class_OS_method_get_cmdline_user_args>`:

::

    godot --fullscreen -- --level 1
    # Or:
    godot --fullscreen ++ --level 1

.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_config_dir:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_config_dir** **(** **)** |const|

Returns the *global* user configuration directory according to the operating system's standards. On the Linux/BSD platform, this path can be overridden by setting the ``XDG_CONFIG_HOME`` environment variable before starting the project. See :doc:`File paths in Godot projects <../tutorials/io/data_paths>` in the documentation for more information. See also :ref:`get_cache_dir<class_OS_method_get_cache_dir>` and :ref:`get_data_dir<class_OS_method_get_data_dir>`.

Not to be confused with :ref:`get_user_data_dir<class_OS_method_get_user_data_dir>`, which returns the *project-specific* user data path.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_connected_midi_inputs:

.. rst-class:: classref-method

:ref:`PackedStringArray<class_PackedStringArray>` **get_connected_midi_inputs** **(** **)**

Returns an array of MIDI device names.

The returned array will be empty if the system MIDI driver has not previously been initialized with :ref:`open_midi_inputs<class_OS_method_open_midi_inputs>`.

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

.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_data_dir:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_data_dir** **(** **)** |const|

Returns the *global* user data directory according to the operating system's standards. On the Linux/BSD platform, this path can be overridden by setting the ``XDG_DATA_HOME`` environment variable before starting the project. See :doc:`File paths in Godot projects <../tutorials/io/data_paths>` in the documentation for more information. See also :ref:`get_cache_dir<class_OS_method_get_cache_dir>` and :ref:`get_config_dir<class_OS_method_get_config_dir>`.

Not to be confused with :ref:`get_user_data_dir<class_OS_method_get_user_data_dir>`, which returns the *project-specific* user data path.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_distribution_name:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_distribution_name** **(** **)** |const|

Returns the name of the distribution for Linux and BSD platforms (e.g. Ubuntu, Manjaro, OpenBSD, etc.).

Returns the same value as :ref:`get_name<class_OS_method_get_name>` for stock Android ROMs, but attempts to return the custom ROM name for popular Android derivatives such as LineageOS.

Returns the same value as :ref:`get_name<class_OS_method_get_name>` for other platforms.

\ **Note:** This method is not supported on the web platform. It returns an empty string.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_environment:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_environment** **(** :ref:`String<class_String>` variable **)** |const|

Returns the value of an environment variable. Returns an empty string if the environment variable doesn't exist.

\ **Note:** Double-check the casing of ``variable``. Environment variable names are case-sensitive on all platforms except Windows.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_executable_path:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_executable_path** **(** **)** |const|

Returns the path to the current engine executable.

\ **Note:** On macOS, always use :ref:`create_instance<class_OS_method_create_instance>` instead of relying on executable path.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_granted_permissions:

.. rst-class:: classref-method

:ref:`PackedStringArray<class_PackedStringArray>` **get_granted_permissions** **(** **)** |const|

With this function, you can get the list of dangerous permissions that have been granted to the Android application.

\ **Note:** This method is implemented on Android.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_keycode_string:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_keycode_string** **(** :ref:`Key<enum_@GlobalScope_Key>` code **)** |const|

Returns the given keycode as a string (e.g. Return values: ``"Escape"``, ``"Shift+Escape"``).

See also :ref:`InputEventKey.keycode<class_InputEventKey_property_keycode>` and :ref:`InputEventKey.get_keycode_with_modifiers<class_InputEventKey_method_get_keycode_with_modifiers>`.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_locale:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_locale** **(** **)** |const|

Returns the host OS locale as a string of the form ``language_Script_COUNTRY_VARIANT@extra``. If you want only the language code and not the fully specified locale from the OS, you can use :ref:`get_locale_language<class_OS_method_get_locale_language>`.

\ ``language`` - 2 or 3-letter `language code <https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes>`__, in lower case.

\ ``Script`` - optional, 4-letter `script code <https://en.wikipedia.org/wiki/ISO_15924>`__, in title case.

\ ``COUNTRY`` - optional, 2 or 3-letter `country code <https://en.wikipedia.org/wiki/ISO_3166-1>`__, in upper case.

\ ``VARIANT`` - optional, language variant, region and sort order. Variant can have any number of underscored keywords.

\ ``extra`` - optional, semicolon separated list of additional key words. Currency, calendar, sort order and numbering system information.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_locale_language:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_locale_language** **(** **)** |const|

Returns the host OS locale's 2 or 3-letter `language code <https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes>`__ as a string which should be consistent on all platforms. This is equivalent to extracting the ``language`` part of the :ref:`get_locale<class_OS_method_get_locale>` string.

This can be used to narrow down fully specified locale strings to only the "common" language code, when you don't need the additional information about country code or variants. For example, for a French Canadian user with ``fr_CA`` locale, this would return ``fr``.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_main_thread_id:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_main_thread_id** **(** **)** |const|

Returns the ID of the main thread. See :ref:`get_thread_caller_id<class_OS_method_get_thread_caller_id>`.

\ **Note:** Thread IDs are not deterministic and may be reused across application restarts.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_model_name:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_model_name** **(** **)** |const|

Returns the model name of the current device.

\ **Note:** This method is implemented on Android and iOS. Returns ``"GenericDevice"`` on unsupported platforms.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_name:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_name** **(** **)** |const|

Returns the name of the host OS.

On Windows, this is ``"Windows"`` or ``"UWP"`` if exported on Universal Windows Platform.

On macOS, this is ``"macOS"``.

On Linux-based operating systems, this is ``"Linux"``.

On BSD-based operating systems, this is ``"FreeBSD"``, ``"NetBSD"``, ``"OpenBSD"``, or ``"BSD"`` as a fallback.

On Android, this is ``"Android"``.

On iOS, this is ``"iOS"``.

On the web, this is ``"Web"``.

\ **Note:** Custom builds of the engine may support additional platforms, such as consoles, yielding other return values.


.. tabs::

 .. code-tab:: gdscript

    match OS.get_name():
        "Windows", "UWP":
            print("Windows")
        "macOS":
            print("macOS")
        "Linux", "FreeBSD", "NetBSD", "OpenBSD", "BSD":
            print("Linux/BSD")
        "Android":
            print("Android")
        "iOS":
            print("iOS")
        "Web":
            print("Web")

 .. code-tab:: csharp

    switch (OS.GetName())
    {
        case "Windows":
        case "UWP":
            GD.Print("Windows");
            break;
        case "macOS":
            GD.Print("macOS");
            break;
        case "Linux":
        case "FreeBSD":
        case "NetBSD":
        case "OpenBSD"
        case "BSD":
            GD.Print("Linux/BSD");
            break;
        case "Android":
            GD.Print("Android");
            break;
        case "iOS":
            GD.Print("iOS");
            break;
        case "Web":
            GD.Print("Web");
            break;
    }



.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_process_id:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_process_id** **(** **)** |const|

Returns the project's process ID.

\ **Note:** This method is implemented on Android, iOS, Linux, macOS and Windows.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_processor_count:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_processor_count** **(** **)** |const|

Returns the number of *logical* CPU cores available on the host machine. On CPUs with HyperThreading enabled, this number will be greater than the number of *physical* CPU cores.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_processor_name:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_processor_name** **(** **)** |const|

Returns the name of the CPU model on the host machine (e.g. "Intel(R) Core(TM) i7-6700K CPU @ 4.00GHz").

\ **Note:** This method is only implemented on Windows, macOS, Linux and iOS. On Android, Web and UWP, :ref:`get_processor_name<class_OS_method_get_processor_name>` returns an empty string.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_restart_on_exit_arguments:

.. rst-class:: classref-method

:ref:`PackedStringArray<class_PackedStringArray>` **get_restart_on_exit_arguments** **(** **)** |const|

Returns the list of command line arguments that will be used when the project automatically restarts using :ref:`set_restart_on_exit<class_OS_method_set_restart_on_exit>`. See also :ref:`is_restart_on_exit_set<class_OS_method_is_restart_on_exit_set>`.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_static_memory_peak_usage:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_static_memory_peak_usage** **(** **)** |const|

Returns the maximum amount of static memory used (only works in debug).

.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_static_memory_usage:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_static_memory_usage** **(** **)** |const|

Returns the amount of static memory being used by the program in bytes (only works in debug).

.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_system_dir:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_system_dir** **(** :ref:`SystemDir<enum_OS_SystemDir>` dir, :ref:`bool<class_bool>` shared_storage=true **)** |const|

Returns the actual path to commonly used folders across different platforms. Available locations are specified in :ref:`SystemDir<enum_OS_SystemDir>`.

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

\ **Note:** Shared storage is implemented on Android and allows to differentiate between app specific and shared directories. Shared directories have additional restrictions on Android.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_system_font_path:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_system_font_path** **(** :ref:`String<class_String>` font_name, :ref:`int<class_int>` weight=400, :ref:`int<class_int>` stretch=100, :ref:`bool<class_bool>` italic=false **)** |const|

Returns path to the system font file with ``font_name`` and style. Returns empty string if no matching fonts found.

The following aliases can be used to request default fonts: "sans-serif", "serif", "monospace", "cursive", and "fantasy".

\ **Note:** Returned font might have different style if the requested style is not available.

\ **Note:** This method is implemented on Android, iOS, Linux, macOS and Windows.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_system_font_path_for_text:

.. rst-class:: classref-method

:ref:`PackedStringArray<class_PackedStringArray>` **get_system_font_path_for_text** **(** :ref:`String<class_String>` font_name, :ref:`String<class_String>` text, :ref:`String<class_String>` locale="", :ref:`String<class_String>` script="", :ref:`int<class_int>` weight=400, :ref:`int<class_int>` stretch=100, :ref:`bool<class_bool>` italic=false **)** |const|

Returns an array of the system substitute font file paths, which are similar to the font with ``font_name`` and style for the specified text, locale and script. Returns empty array if no matching fonts found.

The following aliases can be used to request default fonts: "sans-serif", "serif", "monospace", "cursive", and "fantasy".

\ **Note:** Depending on OS, it's not guaranteed that any of the returned fonts will be suitable for rendering specified text. Fonts should be loaded and checked in the order they are returned, and the first suitable one used.

\ **Note:** Returned fonts might have different style if the requested style is not available or belong to a different font family.

\ **Note:** This method is implemented on Android, iOS, Linux, macOS and Windows.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_system_fonts:

.. rst-class:: classref-method

:ref:`PackedStringArray<class_PackedStringArray>` **get_system_fonts** **(** **)** |const|

Returns list of font family names available.

\ **Note:** This method is implemented on Android, iOS, Linux, macOS and Windows.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_thread_caller_id:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_thread_caller_id** **(** **)** |const|

Returns the ID of the current thread. This can be used in logs to ease debugging of multi-threaded applications.

\ **Note:** Thread IDs are not deterministic and may be reused across application restarts.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_unique_id:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_unique_id** **(** **)** |const|

Returns a string that is unique to the device.

\ **Note:** This string may change without notice if the user reinstalls/upgrades their operating system or changes their hardware. This means it should generally not be used to encrypt persistent data as the data saved before an unexpected ID change would become inaccessible. The returned string may also be falsified using external programs, so do not rely on the string returned by :ref:`get_unique_id<class_OS_method_get_unique_id>` for security purposes.

\ **Note:** Returns an empty string on Web and UWP, as this method isn't implemented on those platforms yet.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_user_data_dir:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_user_data_dir** **(** **)** |const|

Returns the absolute directory path where user data is written (``user://``).

On Windows, this is ``%AppData%\Godot\app_userdata\[project_name]``, or ``%AppData%\[custom_name]`` if ``use_custom_user_dir`` is set. ``%AppData%`` expands to ``%UserProfile%\AppData\Roaming``.

On macOS, this is ``~/Library/Application Support/Godot/app_userdata/[project_name]``, or ``~/Library/Application Support/[custom_name]`` if ``use_custom_user_dir`` is set.

On Linux and BSD, this is ``~/.local/share/godot/app_userdata/[project_name]``, or ``~/.local/share/[custom_name]`` if ``use_custom_user_dir`` is set.

On Android and iOS, this is a sandboxed directory in either internal or external storage, depending on the user's configuration.

On the web, this is a virtual directory managed by the browser.

If the project name is empty, ``[project_name]`` falls back to ``[unnamed project]``.

Not to be confused with :ref:`get_data_dir<class_OS_method_get_data_dir>`, which returns the *global* (non-project-specific) user home directory.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_version:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_version** **(** **)** |const|

Returns the exact production and build version of the operating system. This is different from the branded version used in marketing. This helps to distinguish between different releases of operating systems, including minor versions, and insider and custom builds.

For Windows, the major and minor version are returned, as well as the build number. For example, the returned string can look like ``10.0.9926`` for a build of Windows 10, and it can look like ``6.1.7601`` for a build of Windows 7 SP1.

For rolling distributions, such as Arch Linux, an empty string is returned.

For macOS and iOS, the major and minor version are returned, as well as the patch number.

For UWP, the device family version is returned.

For Android, the SDK version and the incremental build number are returned. If it's a custom ROM, it attempts to return its version instead.

\ **Note:** This method is not supported on the web platform. It returns an empty string.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_get_video_adapter_driver_info:

.. rst-class:: classref-method

:ref:`PackedStringArray<class_PackedStringArray>` **get_video_adapter_driver_info** **(** **)** |const|

Returns the video adapter driver name and version for the user's currently active graphics card. See also :ref:`RenderingServer.get_video_adapter_api_version<class_RenderingServer_method_get_video_adapter_api_version>`.

The first element holds the driver name, such as ``nvidia``, ``amdgpu``, etc.

The second element holds the driver version. For e.g. the ``nvidia`` driver on a Linux/BSD platform, the version is in the format ``510.85.02``. For Windows, the driver's format is ``31.0.15.1659``.

\ **Note:** This method is only supported on the platforms Linux/BSD and Windows when not running in headless mode. It returns an empty array on other platforms.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_has_environment:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **has_environment** **(** :ref:`String<class_String>` variable **)** |const|

Returns ``true`` if the environment variable with the name ``variable`` exists.

\ **Note:** Double-check the casing of ``variable``. Environment variable names are case-sensitive on all platforms except Windows.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_has_feature:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **has_feature** **(** :ref:`String<class_String>` tag_name **)** |const|

Returns ``true`` if the feature for the given feature tag is supported in the currently running instance, depending on the platform, build, etc. Can be used to check whether you're currently running a debug build, on a certain platform or arch, etc. Refer to the :doc:`Feature Tags <../tutorials/export/feature_tags>` documentation for more details.

\ **Note:** Tag names are case-sensitive.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_is_debug_build:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_debug_build** **(** **)** |const|

Returns ``true`` if the Godot binary used to run the project is a *debug* export template, or when running in the editor.

Returns ``false`` if the Godot binary used to run the project is a *release* export template.

To check whether the Godot binary used to run the project is an export template (debug or release), use ``OS.has_feature("template")`` instead.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_is_keycode_unicode:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_keycode_unicode** **(** :ref:`int<class_int>` code **)** |const|

Returns ``true`` if the input keycode corresponds to a Unicode character.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_is_process_running:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_process_running** **(** :ref:`int<class_int>` pid **)** |const|

Returns ``true`` if the child process ID (``pid``) is still running or ``false`` if it has terminated.

Must be a valid ID generated from :ref:`create_process<class_OS_method_create_process>`.

\ **Note:** This method is implemented on Android, iOS, Linux, macOS and Windows.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_is_restart_on_exit_set:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_restart_on_exit_set** **(** **)** |const|

Returns ``true`` if the project will automatically restart when it exits for any reason, ``false`` otherwise. See also :ref:`set_restart_on_exit<class_OS_method_set_restart_on_exit>` and :ref:`get_restart_on_exit_arguments<class_OS_method_get_restart_on_exit_arguments>`.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_is_stdout_verbose:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_stdout_verbose** **(** **)** |const|

Returns ``true`` if the engine was executed with the ``--verbose`` or ``-v`` command line argument, or if :ref:`ProjectSettings.debug/settings/stdout/verbose_stdout<class_ProjectSettings_property_debug/settings/stdout/verbose_stdout>` is ``true``. See also :ref:`@GlobalScope.print_verbose<class_@GlobalScope_method_print_verbose>`.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_is_userfs_persistent:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_userfs_persistent** **(** **)** |const|

If ``true``, the ``user://`` file system is persistent, so that its state is the same after a player quits and starts the game again. Relevant to the Web platform, where this persistence may be unavailable.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_kill:

.. rst-class:: classref-method

:ref:`Error<enum_@GlobalScope_Error>` **kill** **(** :ref:`int<class_int>` pid **)**

Kill (terminate) the process identified by the given process ID (``pid``), e.g. the one returned by :ref:`execute<class_OS_method_execute>` in non-blocking mode. See also :ref:`crash<class_OS_method_crash>`.

\ **Note:** This method can also be used to kill processes that were not spawned by the game.

\ **Note:** This method is implemented on Android, iOS, Linux, macOS and Windows.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_move_to_trash:

.. rst-class:: classref-method

:ref:`Error<enum_@GlobalScope_Error>` **move_to_trash** **(** :ref:`String<class_String>` path **)** |const|

Moves the file or directory to the system's recycle bin. See also :ref:`DirAccess.remove<class_DirAccess_method_remove>`.

The method takes only global paths, so you may need to use :ref:`ProjectSettings.globalize_path<class_ProjectSettings_method_globalize_path>`. Do not use it for files in ``res://`` as it will not work in exported projects.

\ **Note:** If the user has disabled the recycle bin on their system, the file will be permanently deleted instead.


.. tabs::

 .. code-tab:: gdscript

    var file_to_remove = "user://slot1.save"
    OS.move_to_trash(ProjectSettings.globalize_path(file_to_remove))

 .. code-tab:: csharp

    var fileToRemove = "user://slot1.save";
    OS.MoveToTrash(ProjectSettings.GlobalizePath(fileToRemove));



.. rst-class:: classref-item-separator

----

.. _class_OS_method_open_midi_inputs:

.. rst-class:: classref-method

void **open_midi_inputs** **(** **)**

Initializes the singleton for the system MIDI driver.

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

.. rst-class:: classref-item-separator

----

.. _class_OS_method_read_string_from_stdin:

.. rst-class:: classref-method

:ref:`String<class_String>` **read_string_from_stdin** **(** **)**

Reads a user input string from the standard input (usually the terminal). This operation is *blocking*, which causes the window to freeze if :ref:`read_string_from_stdin<class_OS_method_read_string_from_stdin>` is called on the main thread. The thread calling :ref:`read_string_from_stdin<class_OS_method_read_string_from_stdin>` will block until the program receives a line break in standard input (usually by the user pressing :kbd:`Enter`).

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

.. rst-class:: classref-item-separator

----

.. _class_OS_method_request_permission:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **request_permission** **(** :ref:`String<class_String>` name **)**

At the moment this function is only used by ``AudioDriverOpenSL`` to request permission for ``RECORD_AUDIO`` on Android.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_request_permissions:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **request_permissions** **(** **)**

With this function, you can request dangerous permissions since normal permissions are automatically granted at install time in Android applications.

\ **Note:** This method is implemented on Android.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_set_environment:

.. rst-class:: classref-method

void **set_environment** **(** :ref:`String<class_String>` variable, :ref:`String<class_String>` value **)** |const|

Sets the value of the environment variable ``variable`` to ``value``. The environment variable will be set for the Godot process and any process executed with :ref:`execute<class_OS_method_execute>` after running :ref:`set_environment<class_OS_method_set_environment>`. The environment variable will *not* persist to processes run after the Godot process was terminated.

\ **Note:** Environment variable names are case-sensitive on all platforms except Windows. The ``variable`` name cannot be empty or include the ``=`` character. On Windows, there is a 32767 characters limit for the combined length of ``variable``, ``value``, and the ``=`` and null terminator characters that will be registered in the environment block.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_set_restart_on_exit:

.. rst-class:: classref-method

void **set_restart_on_exit** **(** :ref:`bool<class_bool>` restart, :ref:`PackedStringArray<class_PackedStringArray>` arguments=PackedStringArray() **)**

If ``restart`` is ``true``, restarts the project automatically when it is exited with :ref:`SceneTree.quit<class_SceneTree_method_quit>` or :ref:`Node.NOTIFICATION_WM_CLOSE_REQUEST<class_Node_constant_NOTIFICATION_WM_CLOSE_REQUEST>`. Command line ``arguments`` can be supplied. To restart the project with the same command line arguments as originally used to run the project, pass :ref:`get_cmdline_args<class_OS_method_get_cmdline_args>` as the value for ``arguments``.

\ :ref:`set_restart_on_exit<class_OS_method_set_restart_on_exit>` can be used to apply setting changes that require a restart. See also :ref:`is_restart_on_exit_set<class_OS_method_is_restart_on_exit_set>` and :ref:`get_restart_on_exit_arguments<class_OS_method_get_restart_on_exit_arguments>`.

\ **Note:** This method is only effective on desktop platforms, and only when the project isn't started from the editor. It will have no effect on mobile and Web platforms, or when the project is started from the editor.

\ **Note:** If the project process crashes or is *killed* by the user (by sending ``SIGKILL`` instead of the usual ``SIGTERM``), the project won't restart automatically.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_set_thread_name:

.. rst-class:: classref-method

:ref:`Error<enum_@GlobalScope_Error>` **set_thread_name** **(** :ref:`String<class_String>` name **)**

Sets the name of the current thread.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_set_use_file_access_save_and_swap:

.. rst-class:: classref-method

void **set_use_file_access_save_and_swap** **(** :ref:`bool<class_bool>` enabled **)**

Enables backup saves if ``enabled`` is ``true``.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_shell_open:

.. rst-class:: classref-method

:ref:`Error<enum_@GlobalScope_Error>` **shell_open** **(** :ref:`String<class_String>` uri **)**

Requests the OS to open a resource with the most appropriate program. For example:

- ``OS.shell_open("C:\\Users\name\Downloads")`` on Windows opens the file explorer at the user's Downloads folder.

- ``OS.shell_open("https://godotengine.org")`` opens the default web browser on the official Godot website.

- ``OS.shell_open("mailto:example@example.com")`` opens the default email client with the "To" field set to ``example@example.com``. See `RFC 2368 - The [code]mailto[/code] URL scheme <https://datatracker.ietf.org/doc/html/rfc2368>`__ for a list of fields that can be added.

Use :ref:`ProjectSettings.globalize_path<class_ProjectSettings_method_globalize_path>` to convert a ``res://`` or ``user://`` path into a system path for use with this method.

\ **Note:** Use :ref:`String.uri_encode<class_String_method_uri_encode>` to encode characters within URLs in a URL-safe, portable way. This is especially required for line breaks. Otherwise, :ref:`shell_open<class_OS_method_shell_open>` may not work correctly in a project exported to the Web platform.

\ **Note:** This method is implemented on Android, iOS, Web, Linux, macOS and Windows.

.. rst-class:: classref-item-separator

----

.. _class_OS_method_unset_environment:

.. rst-class:: classref-method

void **unset_environment** **(** :ref:`String<class_String>` variable **)** |const|

Removes the environment ``variable`` from the current environment, if it exists. The environment variable will be removed for the Godot process and any process executed with :ref:`execute<class_OS_method_execute>` after running :ref:`unset_environment<class_OS_method_unset_environment>`. The removal of the environment variable will *not* persist to processes run after the Godot process was terminated.

\ **Note:** Environment variable names are case-sensitive on all platforms except Windows. The ``variable`` name cannot be empty or include the ``=`` character.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`