godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
603cf9de16bfdc96e2436a9651724ac582de128a
godot-docs/classes/class_os.rst
Rémi Verschelde 603cf9de16 Sync classref with current source
2019-11-08 16:01:57 +01:00

1629 lines
106 KiB
ReStructuredText
Raw Blame History

:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the OS.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_OS:
OS
==
**Inherits:** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------
Operating System functions.
Properties
----------
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+
| :ref:`String<class_String>` | :ref:`clipboard<class_OS_property_clipboard>` | "" |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+
| :ref:`int<class_int>` | :ref:`current_screen<class_OS_property_current_screen>` | 0 |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+
| :ref:`int<class_int>` | :ref:`exit_code<class_OS_property_exit_code>` | 0 |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+
| :ref:`bool<class_bool>` | :ref:`keep_screen_on<class_OS_property_keep_screen_on>` | true |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+
| :ref:`bool<class_bool>` | :ref:`low_processor_usage_mode<class_OS_property_low_processor_usage_mode>` | false |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+
| :ref:`Vector2<class_Vector2>` | :ref:`max_window_size<class_OS_property_max_window_size>` | Vector2( 0, 0 ) |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+
| :ref:`Vector2<class_Vector2>` | :ref:`min_window_size<class_OS_property_min_window_size>` | Vector2( 0, 0 ) |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+
| :ref:`ScreenOrientation<enum_OS_ScreenOrientation>` | :ref:`screen_orientation<class_OS_property_screen_orientation>` | 0 |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+
| :ref:`bool<class_bool>` | :ref:`vsync_enabled<class_OS_property_vsync_enabled>` | true |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+
| :ref:`bool<class_bool>` | :ref:`window_borderless<class_OS_property_window_borderless>` | false |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+
| :ref:`bool<class_bool>` | :ref:`window_fullscreen<class_OS_property_window_fullscreen>` | false |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+
| :ref:`bool<class_bool>` | :ref:`window_maximized<class_OS_property_window_maximized>` | false |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+
| :ref:`bool<class_bool>` | :ref:`window_minimized<class_OS_property_window_minimized>` | false |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+
| :ref:`bool<class_bool>` | :ref:`window_per_pixel_transparency_enabled<class_OS_property_window_per_pixel_transparency_enabled>` | false |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+
| :ref:`Vector2<class_Vector2>` | :ref:`window_position<class_OS_property_window_position>` | Vector2( 0, 0 ) |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+
| :ref:`bool<class_bool>` | :ref:`window_resizable<class_OS_property_window_resizable>` | true |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+
| :ref:`Vector2<class_Vector2>` | :ref:`window_size<class_OS_property_window_size>` | Vector2( 0, 0 ) |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+
Methods
-------
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`alert<class_OS_method_alert>` **(** :ref:`String<class_String>` text, :ref:`String<class_String>` title="Alert!" **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`can_draw<class_OS_method_can_draw>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`can_use_threads<class_OS_method_can_use_threads>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`center_window<class_OS_method_center_window>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`close_midi_inputs<class_OS_method_close_midi_inputs>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`dump_memory_to_file<class_OS_method_dump_memory_to_file>` **(** :ref:`String<class_String>` file **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`dump_resources_to_file<class_OS_method_dump_resources_to_file>` **(** :ref:`String<class_String>` file **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`execute<class_OS_method_execute>` **(** :ref:`String<class_String>` path, :ref:`PoolStringArray<class_PoolStringArray>` arguments, :ref:`bool<class_bool>` blocking, :ref:`Array<class_Array>` output=[ ], :ref:`bool<class_bool>` read_stderr=false **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`find_scancode_from_string<class_OS_method_find_scancode_from_string>` **(** :ref:`String<class_String>` string **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_audio_driver_count<class_OS_method_get_audio_driver_count>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_audio_driver_name<class_OS_method_get_audio_driver_name>` **(** :ref:`int<class_int>` driver **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_cmdline_args<class_OS_method_get_cmdline_args>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_connected_midi_inputs<class_OS_method_get_connected_midi_inputs>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`VideoDriver<enum_OS_VideoDriver>` | :ref:`get_current_video_driver<class_OS_method_get_current_video_driver>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`get_date<class_OS_method_get_date>` **(** :ref:`bool<class_bool>` utc=false **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`get_datetime<class_OS_method_get_datetime>` **(** :ref:`bool<class_bool>` utc=false **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`get_datetime_from_unix_time<class_OS_method_get_datetime_from_unix_time>` **(** :ref:`int<class_int>` unix_time_val **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_dynamic_memory_usage<class_OS_method_get_dynamic_memory_usage>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_environment<class_OS_method_get_environment>` **(** :ref:`String<class_String>` environment **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_executable_path<class_OS_method_get_executable_path>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_granted_permissions<class_OS_method_get_granted_permissions>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_ime_selection<class_OS_method_get_ime_selection>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_ime_text<class_OS_method_get_ime_text>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_latin_keyboard_variant<class_OS_method_get_latin_keyboard_variant>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_locale<class_OS_method_get_locale>` **(** **)** 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_power_percent_left<class_OS_method_get_power_percent_left>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_power_seconds_left<class_OS_method_get_power_seconds_left>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PowerState<enum_OS_PowerState>` | :ref:`get_power_state<class_OS_method_get_power_state>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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:`Vector2<class_Vector2>` | :ref:`get_real_window_size<class_OS_method_get_real_window_size>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_scancode_string<class_OS_method_get_scancode_string>` **(** :ref:`int<class_int>` code **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_screen_count<class_OS_method_get_screen_count>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_screen_dpi<class_OS_method_get_screen_dpi>` **(** :ref:`int<class_int>` screen=-1 **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_screen_position<class_OS_method_get_screen_position>` **(** :ref:`int<class_int>` screen=-1 **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_screen_size<class_OS_method_get_screen_size>` **(** :ref:`int<class_int>` screen=-1 **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_splash_tick_msec<class_OS_method_get_splash_tick_msec>` **(** **)** 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 **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_system_time_msecs<class_OS_method_get_system_time_msecs>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_system_time_secs<class_OS_method_get_system_time_secs>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_ticks_msec<class_OS_method_get_ticks_msec>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_ticks_usec<class_OS_method_get_ticks_usec>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`get_time<class_OS_method_get_time>` **(** :ref:`bool<class_bool>` utc=false **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`get_time_zone_info<class_OS_method_get_time_zone_info>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_unique_id<class_OS_method_get_unique_id>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_unix_time<class_OS_method_get_unix_time>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_unix_time_from_datetime<class_OS_method_get_unix_time_from_datetime>` **(** :ref:`Dictionary<class_Dictionary>` datetime **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_user_data_dir<class_OS_method_get_user_data_dir>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_video_driver_count<class_OS_method_get_video_driver_count>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_video_driver_name<class_OS_method_get_video_driver_name>` **(** :ref:`VideoDriver<enum_OS_VideoDriver>` driver **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_virtual_keyboard_height<class_OS_method_get_virtual_keyboard_height>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_Rect2>` | :ref:`get_window_safe_area<class_OS_method_get_window_safe_area>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`global_menu_add_item<class_OS_method_global_menu_add_item>` **(** :ref:`String<class_String>` menu, :ref:`String<class_String>` label, :ref:`Variant<class_Variant>` id, :ref:`Variant<class_Variant>` meta **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`global_menu_add_separator<class_OS_method_global_menu_add_separator>` **(** :ref:`String<class_String>` menu **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`global_menu_clear<class_OS_method_global_menu_clear>` **(** :ref:`String<class_String>` menu **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`global_menu_remove_item<class_OS_method_global_menu_remove_item>` **(** :ref:`String<class_String>` menu, :ref:`int<class_int>` idx **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_environment<class_OS_method_has_environment>` **(** :ref:`String<class_String>` environment **)** 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:`has_touchscreen_ui_hint<class_OS_method_has_touchscreen_ui_hint>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_virtual_keyboard<class_OS_method_has_virtual_keyboard>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`hide_virtual_keyboard<class_OS_method_hide_virtual_keyboard>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_debug_build<class_OS_method_is_debug_build>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_ok_left_and_cancel_right<class_OS_method_is_ok_left_and_cancel_right>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_scancode_unicode<class_OS_method_is_scancode_unicode>` **(** :ref:`int<class_int>` code **)** 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:`bool<class_bool>` | :ref:`is_window_always_on_top<class_OS_method_is_window_always_on_top>` **(** **)** const |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`kill<class_OS_method_kill>` **(** :ref:`int<class_int>` pid **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`move_window_to_foreground<class_OS_method_move_window_to_foreground>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`native_video_is_playing<class_OS_method_native_video_is_playing>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`native_video_pause<class_OS_method_native_video_pause>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`native_video_play<class_OS_method_native_video_play>` **(** :ref:`String<class_String>` path, :ref:`float<class_float>` volume, :ref:`String<class_String>` audio_track, :ref:`String<class_String>` subtitle_track **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`native_video_stop<class_OS_method_native_video_stop>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`native_video_unpause<class_OS_method_native_video_unpause>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`open_midi_inputs<class_OS_method_open_midi_inputs>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`print_all_resources<class_OS_method_print_all_resources>` **(** :ref:`String<class_String>` tofile="" **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`print_all_textures_by_size<class_OS_method_print_all_textures_by_size>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`print_resources_by_type<class_OS_method_print_resources_by_type>` **(** :ref:`PoolStringArray<class_PoolStringArray>` types **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`print_resources_in_use<class_OS_method_print_resources_in_use>` **(** :ref:`bool<class_bool>` short=false **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`request_attention<class_OS_method_request_attention>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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_icon<class_OS_method_set_icon>` **(** :ref:`Image<class_Image>` icon **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_ime_active<class_OS_method_set_ime_active>` **(** :ref:`bool<class_bool>` active **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_ime_position<class_OS_method_set_ime_position>` **(** :ref:`Vector2<class_Vector2>` position **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_native_icon<class_OS_method_set_native_icon>` **(** :ref:`String<class_String>` filename **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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 **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_window_always_on_top<class_OS_method_set_window_always_on_top>` **(** :ref:`bool<class_bool>` enabled **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_window_title<class_OS_method_set_window_title>` **(** :ref:`String<class_String>` title **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`shell_open<class_OS_method_shell_open>` **(** :ref:`String<class_String>` uri **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`show_virtual_keyboard<class_OS_method_show_virtual_keyboard>` **(** :ref:`String<class_String>` existing_text="" **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Enumerations
------------
.. _enum_OS_VideoDriver:
.. _class_OS_constant_VIDEO_DRIVER_GLES2:
.. _class_OS_constant_VIDEO_DRIVER_GLES3:
enum **VideoDriver**:
- **VIDEO_DRIVER_GLES2** = **1** --- The GLES2 rendering backend. It uses OpenGL ES 2.0 on mobile devices, OpenGL 2.1 on desktop platforms and WebGL 1.0 on the web.
- **VIDEO_DRIVER_GLES3** = **0** --- The GLES3 rendering backend. It uses OpenGL ES 3.0 on mobile devices, OpenGL 3.3 on desktop platforms and WebGL 2.0 on the web.
----
.. _enum_OS_Weekday:
.. _class_OS_constant_DAY_SUNDAY:
.. _class_OS_constant_DAY_MONDAY:
.. _class_OS_constant_DAY_TUESDAY:
.. _class_OS_constant_DAY_WEDNESDAY:
.. _class_OS_constant_DAY_THURSDAY:
.. _class_OS_constant_DAY_FRIDAY:
.. _class_OS_constant_DAY_SATURDAY:
enum **Weekday**:
- **DAY_SUNDAY** = **0** --- Sunday.
- **DAY_MONDAY** = **1** --- Monday.
- **DAY_TUESDAY** = **2** --- Tuesday.
- **DAY_WEDNESDAY** = **3** --- Wednesday.
- **DAY_THURSDAY** = **4** --- Thursday.
- **DAY_FRIDAY** = **5** --- Friday.
- **DAY_SATURDAY** = **6** --- Saturday.
----
.. _enum_OS_Month:
.. _class_OS_constant_MONTH_JANUARY:
.. _class_OS_constant_MONTH_FEBRUARY:
.. _class_OS_constant_MONTH_MARCH:
.. _class_OS_constant_MONTH_APRIL:
.. _class_OS_constant_MONTH_MAY:
.. _class_OS_constant_MONTH_JUNE:
.. _class_OS_constant_MONTH_JULY:
.. _class_OS_constant_MONTH_AUGUST:
.. _class_OS_constant_MONTH_SEPTEMBER:
.. _class_OS_constant_MONTH_OCTOBER:
.. _class_OS_constant_MONTH_NOVEMBER:
.. _class_OS_constant_MONTH_DECEMBER:
enum **Month**:
- **MONTH_JANUARY** = **1** --- January.
- **MONTH_FEBRUARY** = **2** --- February.
- **MONTH_MARCH** = **3** --- March.
- **MONTH_APRIL** = **4** --- April.
- **MONTH_MAY** = **5** --- May.
- **MONTH_JUNE** = **6** --- June.
- **MONTH_JULY** = **7** --- July.
- **MONTH_AUGUST** = **8** --- August.
- **MONTH_SEPTEMBER** = **9** --- September.
- **MONTH_OCTOBER** = **10** --- October.
- **MONTH_NOVEMBER** = **11** --- November.
- **MONTH_DECEMBER** = **12** --- December.
----
.. _enum_OS_ScreenOrientation:
.. _class_OS_constant_SCREEN_ORIENTATION_LANDSCAPE:
.. _class_OS_constant_SCREEN_ORIENTATION_PORTRAIT:
.. _class_OS_constant_SCREEN_ORIENTATION_REVERSE_LANDSCAPE:
.. _class_OS_constant_SCREEN_ORIENTATION_REVERSE_PORTRAIT:
.. _class_OS_constant_SCREEN_ORIENTATION_SENSOR_LANDSCAPE:
.. _class_OS_constant_SCREEN_ORIENTATION_SENSOR_PORTRAIT:
.. _class_OS_constant_SCREEN_ORIENTATION_SENSOR:
enum **ScreenOrientation**:
- **SCREEN_ORIENTATION_LANDSCAPE** = **0** --- Landscape screen orientation.
- **SCREEN_ORIENTATION_PORTRAIT** = **1** --- Portrait screen orientation.
- **SCREEN_ORIENTATION_REVERSE_LANDSCAPE** = **2** --- Reverse landscape screen orientation.
- **SCREEN_ORIENTATION_REVERSE_PORTRAIT** = **3** --- Reverse portrait screen orientation.
- **SCREEN_ORIENTATION_SENSOR_LANDSCAPE** = **4** --- Uses landscape or reverse landscape based on the hardware sensor.
- **SCREEN_ORIENTATION_SENSOR_PORTRAIT** = **5** --- Uses portrait or reverse portrait based on the hardware sensor.
- **SCREEN_ORIENTATION_SENSOR** = **6** --- Uses most suitable orientation based on the hardware sensor.
----
.. _enum_OS_SystemDir:
.. _class_OS_constant_SYSTEM_DIR_DESKTOP:
.. _class_OS_constant_SYSTEM_DIR_DCIM:
.. _class_OS_constant_SYSTEM_DIR_DOCUMENTS:
.. _class_OS_constant_SYSTEM_DIR_DOWNLOADS:
.. _class_OS_constant_SYSTEM_DIR_MOVIES:
.. _class_OS_constant_SYSTEM_DIR_MUSIC:
.. _class_OS_constant_SYSTEM_DIR_PICTURES:
.. _class_OS_constant_SYSTEM_DIR_RINGTONES:
enum **SystemDir**:
- **SYSTEM_DIR_DESKTOP** = **0** --- Desktop directory path.
- **SYSTEM_DIR_DCIM** = **1** --- DCIM (Digital Camera Images) directory path.
- **SYSTEM_DIR_DOCUMENTS** = **2** --- Documents directory path.
- **SYSTEM_DIR_DOWNLOADS** = **3** --- Downloads directory path.
- **SYSTEM_DIR_MOVIES** = **4** --- Movies directory path.
- **SYSTEM_DIR_MUSIC** = **5** --- Music directory path.
- **SYSTEM_DIR_PICTURES** = **6** --- Pictures directory path.
- **SYSTEM_DIR_RINGTONES** = **7** --- Ringtones directory path.
----
.. _enum_OS_PowerState:
.. _class_OS_constant_POWERSTATE_UNKNOWN:
.. _class_OS_constant_POWERSTATE_ON_BATTERY:
.. _class_OS_constant_POWERSTATE_NO_BATTERY:
.. _class_OS_constant_POWERSTATE_CHARGING:
.. _class_OS_constant_POWERSTATE_CHARGED:
enum **PowerState**:
- **POWERSTATE_UNKNOWN** = **0** --- Unknown powerstate.
- **POWERSTATE_ON_BATTERY** = **1** --- Unplugged, running on battery.
- **POWERSTATE_NO_BATTERY** = **2** --- Plugged in, no battery available.
- **POWERSTATE_CHARGING** = **3** --- Plugged in, battery charging.
- **POWERSTATE_CHARGED** = **4** --- Plugged in, battery fully charged.
Description
-----------
Operating System functions. OS wraps the most common functionality to communicate with the host operating system, such as the clipboard, video driver, date and time, timers, environment variables, execution of binaries, command line, etc.
Property Descriptions
---------------------
.. _class_OS_property_clipboard:
- :ref:`String<class_String>` **clipboard**
+-----------+----------------------+
| *Default* | "" |
+-----------+----------------------+
| *Setter* | set_clipboard(value) |
+-----------+----------------------+
| *Getter* | get_clipboard() |
+-----------+----------------------+
The clipboard from the host OS. Might be unavailable on some platforms.
----
.. _class_OS_property_current_screen:
- :ref:`int<class_int>` **current_screen**
+-----------+---------------------------+
| *Default* | 0 |
+-----------+---------------------------+
| *Setter* | set_current_screen(value) |
+-----------+---------------------------+
| *Getter* | get_current_screen() |
+-----------+---------------------------+
The current screen index (starting from 0).
----
.. _class_OS_property_exit_code:
- :ref:`int<class_int>` **exit_code**
+-----------+----------------------+
| *Default* | 0 |
+-----------+----------------------+
| *Setter* | set_exit_code(value) |
+-----------+----------------------+
| *Getter* | get_exit_code() |
+-----------+----------------------+
The exit code passed to the OS when the main loop exits.
----
.. _class_OS_property_keep_screen_on:
- :ref:`bool<class_bool>` **keep_screen_on**
+-----------+---------------------------+
| *Default* | true |
+-----------+---------------------------+
| *Setter* | set_keep_screen_on(value) |
+-----------+---------------------------+
| *Getter* | is_keep_screen_on() |
+-----------+---------------------------+
If ``true``, the engine tries to keep the screen on while the game is running. Useful on mobile.
----
.. _class_OS_property_low_processor_usage_mode:
- :ref:`bool<class_bool>` **low_processor_usage_mode**
+-----------+-------------------------------------+
| *Default* | false |
+-----------+-------------------------------------+
| *Setter* | set_low_processor_usage_mode(value) |
+-----------+-------------------------------------+
| *Getter* | 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.
----
.. _class_OS_property_max_window_size:
- :ref:`Vector2<class_Vector2>` **max_window_size**
+-----------+----------------------------+
| *Default* | Vector2( 0, 0 ) |
+-----------+----------------------------+
| *Setter* | set_max_window_size(value) |
+-----------+----------------------------+
| *Getter* | get_max_window_size() |
+-----------+----------------------------+
The maximum size of the window (without counting window manager decorations). Does not affect fullscreen mode. Set to ``(0, 0)`` to reset to the system default value.
----
.. _class_OS_property_min_window_size:
- :ref:`Vector2<class_Vector2>` **min_window_size**
+-----------+----------------------------+
| *Default* | Vector2( 0, 0 ) |
+-----------+----------------------------+
| *Setter* | set_min_window_size(value) |
+-----------+----------------------------+
| *Getter* | get_min_window_size() |
+-----------+----------------------------+
The minimum size of the window (without counting window manager decorations). Does not affect fullscreen mode. Set to ``(0, 0)`` to reset to the system default value.
----
.. _class_OS_property_screen_orientation:
- :ref:`ScreenOrientation<enum_OS_ScreenOrientation>` **screen_orientation**
+-----------+-------------------------------+
| *Default* | 0 |
+-----------+-------------------------------+
| *Setter* | set_screen_orientation(value) |
+-----------+-------------------------------+
| *Getter* | get_screen_orientation() |
+-----------+-------------------------------+
The current screen orientation.
----
.. _class_OS_property_vsync_enabled:
- :ref:`bool<class_bool>` **vsync_enabled**
+-----------+----------------------+
| *Default* | true |
+-----------+----------------------+
| *Setter* | set_use_vsync(value) |
+-----------+----------------------+
| *Getter* | is_vsync_enabled() |
+-----------+----------------------+
If ``true``, vertical synchronization (Vsync) is enabled.
----
.. _class_OS_property_window_borderless:
- :ref:`bool<class_bool>` **window_borderless**
+-----------+------------------------------+
| *Default* | false |
+-----------+------------------------------+
| *Setter* | set_borderless_window(value) |
+-----------+------------------------------+
| *Getter* | get_borderless_window() |
+-----------+------------------------------+
If ``true``, removes the window frame.
**Note:** Setting ``window_borderless`` to ``false`` disables per-pixel transparency.
----
.. _class_OS_property_window_fullscreen:
- :ref:`bool<class_bool>` **window_fullscreen**
+-----------+------------------------------+
| *Default* | false |
+-----------+------------------------------+
| *Setter* | set_window_fullscreen(value) |
+-----------+------------------------------+
| *Getter* | is_window_fullscreen() |
+-----------+------------------------------+
If ``true``, the window is fullscreen.
----
.. _class_OS_property_window_maximized:
- :ref:`bool<class_bool>` **window_maximized**
+-----------+-----------------------------+
| *Default* | false |
+-----------+-----------------------------+
| *Setter* | set_window_maximized(value) |
+-----------+-----------------------------+
| *Getter* | is_window_maximized() |
+-----------+-----------------------------+
If ``true``, the window is maximized.
----
.. _class_OS_property_window_minimized:
- :ref:`bool<class_bool>` **window_minimized**
+-----------+-----------------------------+
| *Default* | false |
+-----------+-----------------------------+
| *Setter* | set_window_minimized(value) |
+-----------+-----------------------------+
| *Getter* | is_window_minimized() |
+-----------+-----------------------------+
If ``true``, the window is minimized.
----
.. _class_OS_property_window_per_pixel_transparency_enabled:
- :ref:`bool<class_bool>` **window_per_pixel_transparency_enabled**
+-----------+--------------------------------------------------+
| *Default* | false |
+-----------+--------------------------------------------------+
| *Setter* | set_window_per_pixel_transparency_enabled(value) |
+-----------+--------------------------------------------------+
| *Getter* | get_window_per_pixel_transparency_enabled() |
+-----------+--------------------------------------------------+
If ``true``, the window background is transparent and window frame is removed.
Use ``get_tree().get_root().set_transparent_background(true)`` to disable main viewport background rendering.
**Note:** This property has no effect if **Project > Project Settings > Display > Window > Per-pixel transparency > Allowed** setting is disabled.
----
.. _class_OS_property_window_position:
- :ref:`Vector2<class_Vector2>` **window_position**
+-----------+----------------------------+
| *Default* | Vector2( 0, 0 ) |
+-----------+----------------------------+
| *Setter* | set_window_position(value) |
+-----------+----------------------------+
| *Getter* | get_window_position() |
+-----------+----------------------------+
The window position relative to the screen, the origin is the top left corner, +Y axis goes to the bottom and +X axis goes to the right.
----
.. _class_OS_property_window_resizable:
- :ref:`bool<class_bool>` **window_resizable**
+-----------+-----------------------------+
| *Default* | true |
+-----------+-----------------------------+
| *Setter* | set_window_resizable(value) |
+-----------+-----------------------------+
| *Getter* | is_window_resizable() |
+-----------+-----------------------------+
If ``true``, the window is resizable by the user.
----
.. _class_OS_property_window_size:
- :ref:`Vector2<class_Vector2>` **window_size**
+-----------+------------------------+
| *Default* | Vector2( 0, 0 ) |
+-----------+------------------------+
| *Setter* | set_window_size(value) |
+-----------+------------------------+
| *Getter* | get_window_size() |
+-----------+------------------------+
The size of the window (without counting window manager decorations).
Method Descriptions
-------------------
.. _class_OS_method_alert:
- 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.
----
.. _class_OS_method_can_draw:
- :ref:`bool<class_bool>` **can_draw** **(** **)** const
Returns ``true`` if the host OS allows drawing.
----
.. _class_OS_method_can_use_threads:
- :ref:`bool<class_bool>` **can_use_threads** **(** **)** const
Returns ``true`` if the current host platform is using multiple threads.
----
.. _class_OS_method_center_window:
- void **center_window** **(** **)**
Centers the window on the screen if in windowed mode.
----
.. _class_OS_method_close_midi_inputs:
- void **close_midi_inputs** **(** **)**
----
.. _class_OS_method_delay_msec:
- void **delay_msec** **(** :ref:`int<class_int>` msec **)** const
Delay execution of the current thread by ``msec`` milliseconds.
----
.. _class_OS_method_delay_usec:
- void **delay_usec** **(** :ref:`int<class_int>` usec **)** const
Delay execution of the current thread by ``usec`` microseconds.
----
.. _class_OS_method_dump_memory_to_file:
- void **dump_memory_to_file** **(** :ref:`String<class_String>` file **)**
Dumps the memory allocation ringlist to a file (only works in debug).
Entry format per line: "Address - Size - Description".
----
.. _class_OS_method_dump_resources_to_file:
- void **dump_resources_to_file** **(** :ref:`String<class_String>` file **)**
Dumps all used resources to file (only works in debug).
Entry format per line: "Resource Type : Resource Location".
At the end of the file is a statistic of all used Resource Types.
----
.. _class_OS_method_execute:
- :ref:`int<class_int>` **execute** **(** :ref:`String<class_String>` path, :ref:`PoolStringArray<class_PoolStringArray>` arguments, :ref:`bool<class_bool>` blocking, :ref:`Array<class_Array>` output=[ ], :ref:`bool<class_bool>` read_stderr=false **)**
Execute the file at the given path with the arguments passed as an array of strings. Platform path resolution will take place. The resolved file must exist and be executable.
The arguments are used in the given order and separated by a space, so ``OS.execute("ping", ["-w", "3", "godotengine.org"], false)`` will resolve to ``ping -w 3 godotengine.org`` in the system's shell.
This method has slightly different behavior based on whether the ``blocking`` mode is enabled.
If ``blocking`` is ``true``, the Godot thread will pause its execution while waiting for the process to terminate. The shell output of the process will be written to the ``output`` array as a single string. When the process terminates, the Godot thread will resume execution.
If ``blocking`` is ``false``, the Godot thread will continue while the new process runs. It is not possible to retrieve the shell output in non-blocking mode, so ``output`` will be empty.
The return value also depends on the blocking mode. When blocking, the method will return an exit code of the process. When non-blocking, the method returns a process ID, which you can use to monitor the process (and potentially terminate it with :ref:`kill<class_OS_method_kill>`). If the process forking (non-blocking) or opening (blocking) fails, the method will return ``-1`` or another exit code.
Example of blocking mode and retrieving the shell output:
::
var output = []
var exit_code = OS.execute("ls", ["-l", "/tmp"], true, output)
Example of non-blocking mode, running another instance of the project and storing its process ID:
::
var pid = OS.execute(OS.get_executable_path(), [], false)
If you wish to access a shell built-in or perform a composite command, a platform-specific shell can be invoked. For example:
::
OS.execute("CMD.exe", ["/C", "cd %TEMP% && dir"], true, output)
----
.. _class_OS_method_find_scancode_from_string:
- :ref:`int<class_int>` **find_scancode_from_string** **(** :ref:`String<class_String>` string **)** const
Returns the scancode of the given string (e.g. "Escape").
----
.. _class_OS_method_get_audio_driver_count:
- :ref:`int<class_int>` **get_audio_driver_count** **(** **)** const
Returns the total number of available audio drivers.
----
.. _class_OS_method_get_audio_driver_name:
- :ref:`String<class_String>` **get_audio_driver_name** **(** :ref:`int<class_int>` driver **)** const
Returns the audio driver name for the given index.
----
.. _class_OS_method_get_cmdline_args:
- :ref:`PoolStringArray<class_PoolStringArray>` **get_cmdline_args** **(** **)**
Returns the command line arguments passed to the engine.
----
.. _class_OS_method_get_connected_midi_inputs:
- :ref:`PoolStringArray<class_PoolStringArray>` **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 initialised with :ref:`open_midi_inputs<class_OS_method_open_midi_inputs>`.
----
.. _class_OS_method_get_current_video_driver:
- :ref:`VideoDriver<enum_OS_VideoDriver>` **get_current_video_driver** **(** **)** const
Returns the currently used video driver, using one of the values from :ref:`VideoDriver<enum_OS_VideoDriver>`.
----
.. _class_OS_method_get_date:
- :ref:`Dictionary<class_Dictionary>` **get_date** **(** :ref:`bool<class_bool>` utc=false **)** const
Returns current date as a dictionary of keys: ``year``, ``month``, ``day``, ``weekday``, ``dst`` (Daylight Savings Time).
----
.. _class_OS_method_get_datetime:
- :ref:`Dictionary<class_Dictionary>` **get_datetime** **(** :ref:`bool<class_bool>` utc=false **)** const
Returns current datetime as a dictionary of keys: ``year``, ``month``, ``day``, ``weekday``, ``dst`` (Daylight Savings Time), ``hour``, ``minute``, ``second``.
----
.. _class_OS_method_get_datetime_from_unix_time:
- :ref:`Dictionary<class_Dictionary>` **get_datetime_from_unix_time** **(** :ref:`int<class_int>` unix_time_val **)** const
Gets a dictionary of time values corresponding to the given UNIX epoch time (in seconds).
The returned Dictionary's values will be the same as :ref:`get_datetime<class_OS_method_get_datetime>`, with the exception of Daylight Savings Time as it cannot be determined from the epoch.
----
.. _class_OS_method_get_dynamic_memory_usage:
- :ref:`int<class_int>` **get_dynamic_memory_usage** **(** **)** const
Returns the total amount of dynamic memory used (only works in debug).
----
.. _class_OS_method_get_environment:
- :ref:`String<class_String>` **get_environment** **(** :ref:`String<class_String>` environment **)** const
Returns an environment variable.
----
.. _class_OS_method_get_executable_path:
- :ref:`String<class_String>` **get_executable_path** **(** **)** const
Returns the path to the current engine executable.
----
.. _class_OS_method_get_granted_permissions:
- :ref:`PoolStringArray<class_PoolStringArray>` **get_granted_permissions** **(** **)** const
With this function you can get the list of dangerous permissions that have been granted to the Android application.
----
.. _class_OS_method_get_ime_selection:
- :ref:`Vector2<class_Vector2>` **get_ime_selection** **(** **)** const
Returns the IME cursor position (the currently-edited portion of the string) relative to the characters in the composition string.
:ref:`MainLoop.NOTIFICATION_OS_IME_UPDATE<class_MainLoop_constant_NOTIFICATION_OS_IME_UPDATE>` is sent to the application to notify it of changes to the IME cursor position.
----
.. _class_OS_method_get_ime_text:
- :ref:`String<class_String>` **get_ime_text** **(** **)** const
Returns the IME intermediate composition string.
:ref:`MainLoop.NOTIFICATION_OS_IME_UPDATE<class_MainLoop_constant_NOTIFICATION_OS_IME_UPDATE>` is sent to the application to notify it of changes to the IME composition string.
----
.. _class_OS_method_get_latin_keyboard_variant:
- :ref:`String<class_String>` **get_latin_keyboard_variant** **(** **)** const
Returns the current latin keyboard variant as a String.
Possible return values are: ``"QWERTY"``, ``"AZERTY"``, ``"QZERTY"``, ``"DVORAK"``, ``"NEO"``, ``"COLEMAK"`` or ``"ERROR"``.
----
.. _class_OS_method_get_locale:
- :ref:`String<class_String>` **get_locale** **(** **)** const
Returns the host OS locale.
----
.. _class_OS_method_get_model_name:
- :ref:`String<class_String>` **get_model_name** **(** **)** const
Returns the model name of the current device.
----
.. _class_OS_method_get_name:
- :ref:`String<class_String>` **get_name** **(** **)** const
Returns the name of the host OS. Possible values are: ``"Android"``, ``"Haiku"``, ``"iOS"``, ``"HTML5"``, ``"OSX"``, ``"Server"``, ``"Windows"``, ``"UWP"``, ``"X11"``.
----
.. _class_OS_method_get_power_percent_left:
- :ref:`int<class_int>` **get_power_percent_left** **(** **)**
Returns the amount of battery left in the device as a percentage.
----
.. _class_OS_method_get_power_seconds_left:
- :ref:`int<class_int>` **get_power_seconds_left** **(** **)**
Returns an estimate of the time left in seconds before the device runs out of battery.
----
.. _class_OS_method_get_power_state:
- :ref:`PowerState<enum_OS_PowerState>` **get_power_state** **(** **)**
Returns the current state of the device regarding battery and power. See :ref:`PowerState<enum_OS_PowerState>` constants.
----
.. _class_OS_method_get_process_id:
- :ref:`int<class_int>` **get_process_id** **(** **)** const
Returns the project's process ID.
----
.. _class_OS_method_get_processor_count:
- :ref:`int<class_int>` **get_processor_count** **(** **)** const
Returns the number of threads available on the host machine.
----
.. _class_OS_method_get_real_window_size:
- :ref:`Vector2<class_Vector2>` **get_real_window_size** **(** **)** const
Returns the window size including decorations like window borders.
----
.. _class_OS_method_get_scancode_string:
- :ref:`String<class_String>` **get_scancode_string** **(** :ref:`int<class_int>` code **)** const
Returns the given scancode as a string (e.g. Return values: ``"Escape"``, ``"Shift+Escape"``).
----
.. _class_OS_method_get_screen_count:
- :ref:`int<class_int>` **get_screen_count** **(** **)** const
Returns the number of displays attached to the host machine.
----
.. _class_OS_method_get_screen_dpi:
- :ref:`int<class_int>` **get_screen_dpi** **(** :ref:`int<class_int>` screen=-1 **)** const
Returns the dots per inch density of the specified screen. If ``screen`` is ``-1`` (the default value), the current screen will be used.
On Android devices, the actual screen densities are grouped into six generalized densities:
::
ldpi - 120 dpi
mdpi - 160 dpi
hdpi - 240 dpi
xhdpi - 320 dpi
xxhdpi - 480 dpi
xxxhdpi - 640 dpi
----
.. _class_OS_method_get_screen_position:
- :ref:`Vector2<class_Vector2>` **get_screen_position** **(** :ref:`int<class_int>` screen=-1 **)** const
Returns the position of the specified screen by index. If ``screen`` is ``-1`` (the default value), the current screen will be used.
----
.. _class_OS_method_get_screen_size:
- :ref:`Vector2<class_Vector2>` **get_screen_size** **(** :ref:`int<class_int>` screen=-1 **)** const
Returns the dimensions in pixels of the specified screen. If ``screen`` is ``-1`` (the default value), the current screen will be used.
----
.. _class_OS_method_get_splash_tick_msec:
- :ref:`int<class_int>` **get_splash_tick_msec** **(** **)** const
Returns the amount of time in milliseconds it took for the boot logo to appear.
----
.. _class_OS_method_get_static_memory_peak_usage:
- :ref:`int<class_int>` **get_static_memory_peak_usage** **(** **)** const
Returns the maximum amount of static memory used (only works in debug).
----
.. _class_OS_method_get_static_memory_usage:
- :ref:`int<class_int>` **get_static_memory_usage** **(** **)** const
Returns the amount of static memory being used by the program in bytes.
----
.. _class_OS_method_get_system_dir:
- :ref:`String<class_String>` **get_system_dir** **(** :ref:`SystemDir<enum_OS_SystemDir>` dir **)** const
Returns the actual path to commonly used folders across different platforms. Available locations are specified in :ref:`SystemDir<enum_OS_SystemDir>`.
----
.. _class_OS_method_get_system_time_msecs:
- :ref:`int<class_int>` **get_system_time_msecs** **(** **)** const
Returns the epoch time of the operating system in milliseconds.
----
.. _class_OS_method_get_system_time_secs:
- :ref:`int<class_int>` **get_system_time_secs** **(** **)** const
Returns the epoch time of the operating system in seconds.
----
.. _class_OS_method_get_ticks_msec:
- :ref:`int<class_int>` **get_ticks_msec** **(** **)** const
Returns the amount of time passed in milliseconds since the engine started.
----
.. _class_OS_method_get_ticks_usec:
- :ref:`int<class_int>` **get_ticks_usec** **(** **)** const
Returns the amount of time passed in microseconds since the engine started.
----
.. _class_OS_method_get_time:
- :ref:`Dictionary<class_Dictionary>` **get_time** **(** :ref:`bool<class_bool>` utc=false **)** const
Returns current time as a dictionary of keys: hour, minute, second.
----
.. _class_OS_method_get_time_zone_info:
- :ref:`Dictionary<class_Dictionary>` **get_time_zone_info** **(** **)** const
Returns the current time zone as a dictionary with the keys: bias and name.
----
.. _class_OS_method_get_unique_id:
- :ref:`String<class_String>` **get_unique_id** **(** **)** const
Returns a string that is unique to the device.
**Note:** Returns an empty string on HTML5 and UWP, as this method isn't implemented on those platforms yet.
----
.. _class_OS_method_get_unix_time:
- :ref:`int<class_int>` **get_unix_time** **(** **)** const
Returns the current UNIX epoch timestamp.
----
.. _class_OS_method_get_unix_time_from_datetime:
- :ref:`int<class_int>` **get_unix_time_from_datetime** **(** :ref:`Dictionary<class_Dictionary>` datetime **)** const
Gets an epoch time value from a dictionary of time values.
``datetime`` must be populated with the following keys: ``year``, ``month``, ``day``, ``hour``, ``minute``, ``second``.
You can pass the output from :ref:`get_datetime_from_unix_time<class_OS_method_get_datetime_from_unix_time>` directly into this function. Daylight Savings Time (``dst``), if present, is ignored.
----
.. _class_OS_method_get_user_data_dir:
- :ref:`String<class_String>` **get_user_data_dir** **(** **)** const
Returns the absolute directory path where user data is written (``user://``).
On Linux, this is ``~/.local/share/godot/app_userdata/[project_name]``, or ``~/.local/share/[custom_name]`` if ``use_custom_user_dir`` is set.
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 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``.
If the project name is empty, ``user://`` falls back to ``res://``.
----
.. _class_OS_method_get_video_driver_count:
- :ref:`int<class_int>` **get_video_driver_count** **(** **)** const
Returns the number of video drivers supported on the current platform.
----
.. _class_OS_method_get_video_driver_name:
- :ref:`String<class_String>` **get_video_driver_name** **(** :ref:`VideoDriver<enum_OS_VideoDriver>` driver **)** const
Returns the name of the video driver matching the given ``driver`` index. This index is a value from :ref:`VideoDriver<enum_OS_VideoDriver>`, and you can use :ref:`get_current_video_driver<class_OS_method_get_current_video_driver>` to get the current backend's index.
----
.. _class_OS_method_get_virtual_keyboard_height:
- :ref:`int<class_int>` **get_virtual_keyboard_height** **(** **)**
Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or if it is currently hidden.
----
.. _class_OS_method_get_window_safe_area:
- :ref:`Rect2<class_Rect2>` **get_window_safe_area** **(** **)** const
Returns unobscured area of the window where interactive controls should be rendered.
----
.. _class_OS_method_global_menu_add_item:
- void **global_menu_add_item** **(** :ref:`String<class_String>` menu, :ref:`String<class_String>` label, :ref:`Variant<class_Variant>` id, :ref:`Variant<class_Variant>` meta **)**
Add a new item with text "label" to global menu. Use "_dock" menu to add item to the macOS dock icon menu.
----
.. _class_OS_method_global_menu_add_separator:
- void **global_menu_add_separator** **(** :ref:`String<class_String>` menu **)**
Add a separator between items. Separators also occupy an index.
----
.. _class_OS_method_global_menu_clear:
- void **global_menu_clear** **(** :ref:`String<class_String>` menu **)**
Clear the global menu, in effect removing all items.
----
.. _class_OS_method_global_menu_remove_item:
- void **global_menu_remove_item** **(** :ref:`String<class_String>` menu, :ref:`int<class_int>` idx **)**
Removes the item at index "idx" from the global menu. Note that the indexes of items after the removed item are going to be shifted by one.
----
.. _class_OS_method_has_environment:
- :ref:`bool<class_bool>` **has_environment** **(** :ref:`String<class_String>` environment **)** const
Returns ``true`` if an environment variable exists.
----
.. _class_OS_method_has_feature:
- :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 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 `Feature Tags <https://docs.godotengine.org/en/latest/getting_started/workflow/export/feature_tags.html>`_ documentation for more details.
**Note:** Tag names are case-sensitive.
----
.. _class_OS_method_has_touchscreen_ui_hint:
- :ref:`bool<class_bool>` **has_touchscreen_ui_hint** **(** **)** const
Returns ``true`` if the device has a touchscreen or emulates one.
----
.. _class_OS_method_has_virtual_keyboard:
- :ref:`bool<class_bool>` **has_virtual_keyboard** **(** **)** const
Returns ``true`` if the platform has a virtual keyboard, ``false`` otherwise.
----
.. _class_OS_method_hide_virtual_keyboard:
- void **hide_virtual_keyboard** **(** **)**
Hides the virtual keyboard if it is shown, does nothing otherwise.
----
.. _class_OS_method_is_debug_build:
- :ref:`bool<class_bool>` **is_debug_build** **(** **)** const
Returns ``true`` if the build is a debug build.
Returns ``true`` when running in the editor.
Returns ``false`` if the build is a release build.
----
.. _class_OS_method_is_ok_left_and_cancel_right:
- :ref:`bool<class_bool>` **is_ok_left_and_cancel_right** **(** **)** const
Returns ``true`` if the **OK** button should appear on the left and **Cancel** on the right.
----
.. _class_OS_method_is_scancode_unicode:
- :ref:`bool<class_bool>` **is_scancode_unicode** **(** :ref:`int<class_int>` code **)** const
Returns ``true`` if the input scancode corresponds to a Unicode character.
----
.. _class_OS_method_is_stdout_verbose:
- :ref:`bool<class_bool>` **is_stdout_verbose** **(** **)** const
Returns ``true`` if the engine was executed with ``-v`` (verbose stdout).
----
.. _class_OS_method_is_userfs_persistent:
- :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 HTML5 platform, where this persistence may be unavailable.
----
.. _class_OS_method_is_window_always_on_top:
- :ref:`bool<class_bool>` **is_window_always_on_top** **(** **)** const
Returns ``true`` if the window should always be on top of other windows.
----
.. _class_OS_method_kill:
- :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.
**Note:** This method can also be used to kill processes that were not spawned by the game.
----
.. _class_OS_method_move_window_to_foreground:
- void **move_window_to_foreground** **(** **)**
Moves the window to the front.
----
.. _class_OS_method_native_video_is_playing:
- :ref:`bool<class_bool>` **native_video_is_playing** **(** **)**
Returns ``true`` if native video is playing.
----
.. _class_OS_method_native_video_pause:
- void **native_video_pause** **(** **)**
Pauses native video playback.
----
.. _class_OS_method_native_video_play:
- :ref:`Error<enum_@GlobalScope_Error>` **native_video_play** **(** :ref:`String<class_String>` path, :ref:`float<class_float>` volume, :ref:`String<class_String>` audio_track, :ref:`String<class_String>` subtitle_track **)**
Plays native video from the specified path, at the given volume and with audio and subtitle tracks.
**Note:** This method is only implemented on Android and iOS, and the current Android implementation does not support the ``volume``, ``audio_track`` and ``subtitle_track`` options.
----
.. _class_OS_method_native_video_stop:
- void **native_video_stop** **(** **)**
Stops native video playback.
----
.. _class_OS_method_native_video_unpause:
- void **native_video_unpause** **(** **)**
Resumes native video playback.
----
.. _class_OS_method_open_midi_inputs:
- void **open_midi_inputs** **(** **)**
Initialises the singleton for the system MIDI driver.
----
.. _class_OS_method_print_all_resources:
- void **print_all_resources** **(** :ref:`String<class_String>` tofile="" **)**
Shows all resources in the game. Optionally, the list can be written to a file by specifying a file path in ``tofile``.
----
.. _class_OS_method_print_all_textures_by_size:
- void **print_all_textures_by_size** **(** **)**
Shows the list of loaded textures sorted by size in memory.
----
.. _class_OS_method_print_resources_by_type:
- void **print_resources_by_type** **(** :ref:`PoolStringArray<class_PoolStringArray>` types **)**
Shows the number of resources loaded by the game of the given types.
----
.. _class_OS_method_print_resources_in_use:
- void **print_resources_in_use** **(** :ref:`bool<class_bool>` short=false **)**
Shows all resources currently used by the game.
----
.. _class_OS_method_request_attention:
- void **request_attention** **(** **)**
Request the user attention to the window. It'll flash the taskbar button on Windows or bounce the dock icon on OSX.
----
.. _class_OS_method_request_permission:
- :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.
----
.. _class_OS_method_request_permissions:
- :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 application.
----
.. _class_OS_method_set_icon:
- void **set_icon** **(** :ref:`Image<class_Image>` icon **)**
Sets the game's icon using an :ref:`Image<class_Image>` resource.
The same image is used for window caption, taskbar/dock and window selection dialog. Image is scaled as needed.
----
.. _class_OS_method_set_ime_active:
- void **set_ime_active** **(** :ref:`bool<class_bool>` active **)**
Sets whether IME input mode should be enabled.
If active IME handles key events before the application and creates an composition string and suggestion list.
Application can retrieve the composition status by using :ref:`get_ime_selection<class_OS_method_get_ime_selection>` and :ref:`get_ime_text<class_OS_method_get_ime_text>` functions.
Completed composition string is committed when input is finished.
----
.. _class_OS_method_set_ime_position:
- void **set_ime_position** **(** :ref:`Vector2<class_Vector2>` position **)**
Sets position of IME suggestion list popup (in window coordinates).
----
.. _class_OS_method_set_native_icon:
- void **set_native_icon** **(** :ref:`String<class_String>` filename **)**
Sets the game's icon using a multi-size platform-specific icon file (``*.ico`` on Windows and ``*.icns`` on macOS).
Appropriate size sub-icons are used for window caption, taskbar/dock and window selection dialog.
**Note:** This method is only implemented on macOS and Windows.
----
.. _class_OS_method_set_thread_name:
- :ref:`Error<enum_@GlobalScope_Error>` **set_thread_name** **(** :ref:`String<class_String>` name **)**
Sets the name of the current thread.
----
.. _class_OS_method_set_use_file_access_save_and_swap:
- void **set_use_file_access_save_and_swap** **(** :ref:`bool<class_bool>` enabled **)**
Enables backup saves if ``enabled`` is ``true``.
----
.. _class_OS_method_set_window_always_on_top:
- void **set_window_always_on_top** **(** :ref:`bool<class_bool>` enabled **)**
Sets whether the window should always be on top.
----
.. _class_OS_method_set_window_title:
- void **set_window_title** **(** :ref:`String<class_String>` title **)**
Sets the window title to the specified string.
**Note:** This should be used sporadically. Don't set this every frame, as that will negatively affect performance on some window managers.
----
.. _class_OS_method_shell_open:
- :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 `Customizing ``mailto:`` Links <https://blog.escapecreative.com/customizing-mailto-links/>`_ for a list of fields that can be added.
----
.. _class_OS_method_show_virtual_keyboard:
- void **show_virtual_keyboard** **(** :ref:`String<class_String>` existing_text="" **)**
Shows the virtual keyboard if the platform has one. The ``existing_text`` parameter is useful for implementing your own LineEdit, as it tells the virtual keyboard what text has already been typed (the virtual keyboard uses it for auto-correct and predictions).
Reference in New Issue View Git Blame Copy Permalink