| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125 |
- .. 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_clipboard>` |
- +-------------------------------+----------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`current_screen<class_OS_current_screen>` |
- +-------------------------------+----------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`exit_code<class_OS_exit_code>` |
- +-------------------------------+----------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`keep_screen_on<class_OS_keep_screen_on>` |
- +-------------------------------+----------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`low_processor_usage_mode<class_OS_low_processor_usage_mode>` |
- +-------------------------------+----------------------------------------------------------------------------------------------+
- | _OS.ScreenOrientation | :ref:`screen_orientation<class_OS_screen_orientation>` |
- +-------------------------------+----------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`vsync_enabled<class_OS_vsync_enabled>` |
- +-------------------------------+----------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`window_borderless<class_OS_window_borderless>` |
- +-------------------------------+----------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`window_fullscreen<class_OS_window_fullscreen>` |
- +-------------------------------+----------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`window_maximized<class_OS_window_maximized>` |
- +-------------------------------+----------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`window_minimized<class_OS_window_minimized>` |
- +-------------------------------+----------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`window_per_pixel_transparency_enabled<class_OS_window_per_pixel_transparency_enabled>` |
- +-------------------------------+----------------------------------------------------------------------------------------------+
- | :ref:`Vector2<class_Vector2>` | :ref:`window_position<class_OS_window_position>` |
- +-------------------------------+----------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`window_resizable<class_OS_window_resizable>` |
- +-------------------------------+----------------------------------------------------------------------------------------------+
- | :ref:`Vector2<class_Vector2>` | :ref:`window_size<class_OS_window_size>` |
- +-------------------------------+----------------------------------------------------------------------------------------------+
- Methods
- -------
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`alert<class_OS_alert>` **(** :ref:`String<class_String>` text, :ref:`String<class_String>` title="Alert!" **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`can_draw<class_OS_can_draw>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`can_use_threads<class_OS_can_use_threads>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`center_window<class_OS_center_window>` **(** **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`close_midi_inputs<class_OS_close_midi_inputs>` **(** **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`delay_msec<class_OS_delay_msec>` **(** :ref:`int<class_int>` msec **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`delay_usec<class_OS_delay_usec>` **(** :ref:`int<class_int>` usec **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`dump_memory_to_file<class_OS_dump_memory_to_file>` **(** :ref:`String<class_String>` file **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`dump_resources_to_file<class_OS_dump_resources_to_file>` **(** :ref:`String<class_String>` file **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`execute<class_OS_execute>` **(** :ref:`String<class_String>` path, :ref:`PoolStringArray<class_PoolStringArray>` arguments, :ref:`bool<class_bool>` blocking, :ref:`Array<class_Array>` output=[ ] **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`find_scancode_from_string<class_OS_find_scancode_from_string>` **(** :ref:`String<class_String>` string **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_audio_driver_count<class_OS_get_audio_driver_count>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_audio_driver_name<class_OS_get_audio_driver_name>` **(** :ref:`int<class_int>` driver **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_cmdline_args<class_OS_get_cmdline_args>` **(** **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_connected_midi_inputs<class_OS_get_connected_midi_inputs>` **(** **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Dictionary<class_Dictionary>` | :ref:`get_date<class_OS_get_date>` **(** :ref:`bool<class_bool>` utc=false **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Dictionary<class_Dictionary>` | :ref:`get_datetime<class_OS_get_datetime>` **(** :ref:`bool<class_bool>` utc=false **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Dictionary<class_Dictionary>` | :ref:`get_datetime_from_unix_time<class_OS_get_datetime_from_unix_time>` **(** :ref:`int<class_int>` unix_time_val **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_dynamic_memory_usage<class_OS_get_dynamic_memory_usage>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_environment<class_OS_get_environment>` **(** :ref:`String<class_String>` environment **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_executable_path<class_OS_get_executable_path>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Vector2<class_Vector2>` | :ref:`get_ime_selection<class_OS_get_ime_selection>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_ime_text<class_OS_get_ime_text>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_latin_keyboard_variant<class_OS_get_latin_keyboard_variant>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_locale<class_OS_get_locale>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_model_name<class_OS_get_model_name>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_name<class_OS_get_name>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_power_percent_left<class_OS_get_power_percent_left>` **(** **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_power_seconds_left<class_OS_get_power_seconds_left>` **(** **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`PowerState<enum_OS_PowerState>` | :ref:`get_power_state<class_OS_get_power_state>` **(** **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_process_id<class_OS_get_process_id>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_processor_count<class_OS_get_processor_count>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Vector2<class_Vector2>` | :ref:`get_real_window_size<class_OS_get_real_window_size>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_scancode_string<class_OS_get_scancode_string>` **(** :ref:`int<class_int>` code **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_screen_count<class_OS_get_screen_count>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_screen_dpi<class_OS_get_screen_dpi>` **(** :ref:`int<class_int>` screen=-1 **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Vector2<class_Vector2>` | :ref:`get_screen_position<class_OS_get_screen_position>` **(** :ref:`int<class_int>` screen=-1 **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Vector2<class_Vector2>` | :ref:`get_screen_size<class_OS_get_screen_size>` **(** :ref:`int<class_int>` screen=-1 **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_splash_tick_msec<class_OS_get_splash_tick_msec>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_static_memory_peak_usage<class_OS_get_static_memory_peak_usage>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_static_memory_usage<class_OS_get_static_memory_usage>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_system_dir<class_OS_get_system_dir>` **(** :ref:`SystemDir<enum_OS_SystemDir>` dir **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_system_time_msecs<class_OS_get_system_time_msecs>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_system_time_secs<class_OS_get_system_time_secs>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_ticks_msec<class_OS_get_ticks_msec>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_ticks_usec<class_OS_get_ticks_usec>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Dictionary<class_Dictionary>` | :ref:`get_time<class_OS_get_time>` **(** :ref:`bool<class_bool>` utc=false **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Dictionary<class_Dictionary>` | :ref:`get_time_zone_info<class_OS_get_time_zone_info>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_unique_id<class_OS_get_unique_id>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_unix_time<class_OS_get_unix_time>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_unix_time_from_datetime<class_OS_get_unix_time_from_datetime>` **(** :ref:`Dictionary<class_Dictionary>` datetime **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_user_data_dir<class_OS_get_user_data_dir>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_video_driver_count<class_OS_get_video_driver_count>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_video_driver_name<class_OS_get_video_driver_name>` **(** :ref:`int<class_int>` driver **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_virtual_keyboard_height<class_OS_get_virtual_keyboard_height>` **(** **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Rect2<class_Rect2>` | :ref:`get_window_safe_area<class_OS_get_window_safe_area>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`has_environment<class_OS_has_environment>` **(** :ref:`String<class_String>` environment **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`has_feature<class_OS_has_feature>` **(** :ref:`String<class_String>` tag_name **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`has_touchscreen_ui_hint<class_OS_has_touchscreen_ui_hint>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`has_virtual_keyboard<class_OS_has_virtual_keyboard>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`hide_virtual_keyboard<class_OS_hide_virtual_keyboard>` **(** **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`is_debug_build<class_OS_is_debug_build>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`is_ok_left_and_cancel_right<class_OS_is_ok_left_and_cancel_right>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`is_scancode_unicode<class_OS_is_scancode_unicode>` **(** :ref:`int<class_int>` code **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`is_stdout_verbose<class_OS_is_stdout_verbose>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`is_userfs_persistent<class_OS_is_userfs_persistent>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`is_window_always_on_top<class_OS_is_window_always_on_top>` **(** **)** const |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`kill<class_OS_kill>` **(** :ref:`int<class_int>` pid **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`move_window_to_foreground<class_OS_move_window_to_foreground>` **(** **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`native_video_is_playing<class_OS_native_video_is_playing>` **(** **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`native_video_pause<class_OS_native_video_pause>` **(** **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`native_video_play<class_OS_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_native_video_stop>` **(** **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`native_video_unpause<class_OS_native_video_unpause>` **(** **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`open_midi_inputs<class_OS_open_midi_inputs>` **(** **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`print_all_resources<class_OS_print_all_resources>` **(** :ref:`String<class_String>` tofile="" **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`print_all_textures_by_size<class_OS_print_all_textures_by_size>` **(** **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`print_resources_by_type<class_OS_print_resources_by_type>` **(** :ref:`PoolStringArray<class_PoolStringArray>` types **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`print_resources_in_use<class_OS_print_resources_in_use>` **(** :ref:`bool<class_bool>` short=false **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`request_attention<class_OS_request_attention>` **(** **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_icon<class_OS_set_icon>` **(** :ref:`Image<class_Image>` icon **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_ime_active<class_OS_set_ime_active>` **(** :ref:`bool<class_bool>` active **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_ime_position<class_OS_set_ime_position>` **(** :ref:`Vector2<class_Vector2>` position **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`set_thread_name<class_OS_set_thread_name>` **(** :ref:`String<class_String>` name **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_use_file_access_save_and_swap<class_OS_set_use_file_access_save_and_swap>` **(** :ref:`bool<class_bool>` enabled **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_window_always_on_top<class_OS_set_window_always_on_top>` **(** :ref:`bool<class_bool>` enabled **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_window_title<class_OS_set_window_title>` **(** :ref:`String<class_String>` title **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`shell_open<class_OS_shell_open>` **(** :ref:`String<class_String>` uri **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`show_virtual_keyboard<class_OS_show_virtual_keyboard>` **(** :ref:`String<class_String>` existing_text="" **)** |
- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Enumerations
- ------------
- .. _enum_OS_Weekday:
- 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:
- 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:
- 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:
- 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:
- 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: mouse grabbing, mouse cursors, clipboard, video mode, date and time, timers, environment variables, execution of binaries, command line, etc.
- Property Descriptions
- ---------------------
- .. _class_OS_clipboard:
- - :ref:`String<class_String>` **clipboard**
- +----------+----------------------+
- | *Setter* | set_clipboard(value) |
- +----------+----------------------+
- | *Getter* | get_clipboard() |
- +----------+----------------------+
- The clipboard from the host OS. Might be unavailable on some platforms.
- .. _class_OS_current_screen:
- - :ref:`int<class_int>` **current_screen**
- +----------+---------------------------+
- | *Setter* | set_current_screen(value) |
- +----------+---------------------------+
- | *Getter* | get_current_screen() |
- +----------+---------------------------+
- The current screen index (starting from 0).
- .. _class_OS_exit_code:
- - :ref:`int<class_int>` **exit_code**
- +----------+----------------------+
- | *Setter* | set_exit_code(value) |
- +----------+----------------------+
- | *Getter* | get_exit_code() |
- +----------+----------------------+
- The exit code passed to the OS when the main loop exits.
- .. _class_OS_keep_screen_on:
- - :ref:`bool<class_bool>` **keep_screen_on**
- +----------+---------------------------+
- | *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_low_processor_usage_mode:
- - :ref:`bool<class_bool>` **low_processor_usage_mode**
- +----------+-------------------------------------+
- | *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_screen_orientation:
- - _OS.ScreenOrientation **screen_orientation**
- +----------+-------------------------------+
- | *Setter* | set_screen_orientation(value) |
- +----------+-------------------------------+
- | *Getter* | get_screen_orientation() |
- +----------+-------------------------------+
- The current screen orientation.
- .. _class_OS_vsync_enabled:
- - :ref:`bool<class_bool>` **vsync_enabled**
- +----------+----------------------+
- | *Setter* | set_use_vsync(value) |
- +----------+----------------------+
- | *Getter* | is_vsync_enabled() |
- +----------+----------------------+
- If ``true``, vertical synchronization (Vsync) is enabled.
- .. _class_OS_window_borderless:
- - :ref:`bool<class_bool>` **window_borderless**
- +----------+------------------------------+
- | *Setter* | set_borderless_window(value) |
- +----------+------------------------------+
- | *Getter* | get_borderless_window() |
- +----------+------------------------------+
- If ``true``, removes the window frame.
- .. _class_OS_window_fullscreen:
- - :ref:`bool<class_bool>` **window_fullscreen**
- +----------+------------------------------+
- | *Setter* | set_window_fullscreen(value) |
- +----------+------------------------------+
- | *Getter* | is_window_fullscreen() |
- +----------+------------------------------+
- If ``true``, the window is fullscreen.
- .. _class_OS_window_maximized:
- - :ref:`bool<class_bool>` **window_maximized**
- +----------+-----------------------------+
- | *Setter* | set_window_maximized(value) |
- +----------+-----------------------------+
- | *Getter* | is_window_maximized() |
- +----------+-----------------------------+
- If ``true``, the window is maximized.
- .. _class_OS_window_minimized:
- - :ref:`bool<class_bool>` **window_minimized**
- +----------+-----------------------------+
- | *Setter* | set_window_minimized(value) |
- +----------+-----------------------------+
- | *Getter* | is_window_minimized() |
- +----------+-----------------------------+
- If ``true``, the window is minimized.
- .. _class_OS_window_per_pixel_transparency_enabled:
- - :ref:`bool<class_bool>` **window_per_pixel_transparency_enabled**
- +----------+--------------------------------------------------+
- | *Setter* | set_window_per_pixel_transparency_enabled(value) |
- +----------+--------------------------------------------------+
- | *Getter* | get_window_per_pixel_transparency_enabled() |
- +----------+--------------------------------------------------+
- .. _class_OS_window_position:
- - :ref:`Vector2<class_Vector2>` **window_position**
- +----------+----------------------------+
- | *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_window_resizable:
- - :ref:`bool<class_bool>` **window_resizable**
- +----------+-----------------------------+
- | *Setter* | set_window_resizable(value) |
- +----------+-----------------------------+
- | *Getter* | is_window_resizable() |
- +----------+-----------------------------+
- If ``true``, the window is resizable by the user.
- .. _class_OS_window_size:
- - :ref:`Vector2<class_Vector2>` **window_size**
- +----------+------------------------+
- | *Setter* | set_window_size(value) |
- +----------+------------------------+
- | *Getter* | get_window_size() |
- +----------+------------------------+
- The size of the window (without counting window manager decorations).
- Method Descriptions
- -------------------
- .. _class_OS_alert:
- - void **alert** **(** :ref:`String<class_String>` text, :ref:`String<class_String>` title="Alert!" **)**
- Displays a modal dialog box utilizing the host OS.
- .. _class_OS_can_draw:
- - :ref:`bool<class_bool>` **can_draw** **(** **)** const
- Returns ``true`` if the host OS allows drawing.
- .. _class_OS_can_use_threads:
- - :ref:`bool<class_bool>` **can_use_threads** **(** **)** const
- Returns ``true`` if the current host platform is using multiple threads.
- .. _class_OS_center_window:
- - void **center_window** **(** **)**
- Centers the window on the screen if in windowed mode.
- .. _class_OS_close_midi_inputs:
- - void **close_midi_inputs** **(** **)**
- .. _class_OS_delay_msec:
- - void **delay_msec** **(** :ref:`int<class_int>` msec **)** const
- Delay execution of the current thread by given milliseconds.
- .. _class_OS_delay_usec:
- - void **delay_usec** **(** :ref:`int<class_int>` usec **)** const
- Delay execution of the current thread by given microseconds.
- .. _class_OS_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_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_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=[ ] **)**
- 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 behaviour based on whether the ``blocking`` mode is enabled.
- When ``blocking`` is enabled, 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.
- When ``blocking`` is disabled, 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 -2 (no process ID information is available in blocking mode). 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_kill>`). If the process forking (non-blocking) or opening (blocking) fails, the method will return -1.
- Example of blocking mode and retrieving the shell output:
- ::
- var output = []
- 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_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_get_audio_driver_count:
- - :ref:`int<class_int>` **get_audio_driver_count** **(** **)** const
- Returns the total number of available audio drivers.
- .. _class_OS_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_get_cmdline_args:
- - :ref:`PoolStringArray<class_PoolStringArray>` **get_cmdline_args** **(** **)**
- Returns the command line arguments passed to the engine.
- .. _class_OS_get_connected_midi_inputs:
- - :ref:`PoolStringArray<class_PoolStringArray>` **get_connected_midi_inputs** **(** **)**
- .. _class_OS_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_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_get_datetime_from_unix_time:
- - :ref:`Dictionary<class_Dictionary>` **get_datetime_from_unix_time** **(** :ref:`int<class_int>` unix_time_val **)** const
- Get a dictionary of time values when given epoch time.
- Dictionary Time values will be a union of values from :ref:`get_time<class_OS_get_time>` and :ref:`get_date<class_OS_get_date>` dictionaries (with the exception of dst = day light standard time, as it cannot be determined from epoch).
- .. _class_OS_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_get_environment:
- - :ref:`String<class_String>` **get_environment** **(** :ref:`String<class_String>` environment **)** const
- Returns an environment variable.
- .. _class_OS_get_executable_path:
- - :ref:`String<class_String>` **get_executable_path** **(** **)** const
- Returns the path to the current engine executable.
- .. _class_OS_get_ime_selection:
- - :ref:`Vector2<class_Vector2>` **get_ime_selection** **(** **)** const
- Returns IME selection range.
- .. _class_OS_get_ime_text:
- - :ref:`String<class_String>` **get_ime_text** **(** **)** const
- Returns IME intermediate text.
- .. _class_OS_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_get_locale:
- - :ref:`String<class_String>` **get_locale** **(** **)** const
- Returns the host OS locale.
- .. _class_OS_get_model_name:
- - :ref:`String<class_String>` **get_model_name** **(** **)** const
- Returns the model name of the current device.
- .. _class_OS_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_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_get_power_seconds_left:
- - :ref:`int<class_int>` **get_power_seconds_left** **(** **)**
- Returns the time in seconds before the device runs out of battery.
- .. _class_OS_get_power_state:
- - :ref:`PowerState<enum_OS_PowerState>` **get_power_state** **(** **)**
- Returns the current state of the device regarding battery and power. See ``POWERSTATE_*`` constants.
- .. _class_OS_get_process_id:
- - :ref:`int<class_int>` **get_process_id** **(** **)** const
- Returns the game process ID
- .. _class_OS_get_processor_count:
- - :ref:`int<class_int>` **get_processor_count** **(** **)** const
- Returns the number of cores available in the host machine.
- .. _class_OS_get_real_window_size:
- - :ref:`Vector2<class_Vector2>` **get_real_window_size** **(** **)** const
- Returns the window size including decorations like window borders.
- .. _class_OS_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_get_screen_count:
- - :ref:`int<class_int>` **get_screen_count** **(** **)** const
- Returns the number of displays attached to the host machine.
- .. _class_OS_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.
- 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_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 no screen index is provided, the current screen will be used.
- .. _class_OS_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.
- .. _class_OS_get_splash_tick_msec:
- - :ref:`int<class_int>` **get_splash_tick_msec** **(** **)** const
- .. _class_OS_get_static_memory_peak_usage:
- - :ref:`int<class_int>` **get_static_memory_peak_usage** **(** **)** const
- Returns the max amount of static memory used (only works in debug).
- .. _class_OS_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_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 OS.SystemDir.
- .. _class_OS_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_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_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_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_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_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_get_unique_id:
- - :ref:`String<class_String>` **get_unique_id** **(** **)** const
- Returns a string that is unique to the device.
- Returns empty string on HTML5 and UWP which are not supported yet.
- .. _class_OS_get_unix_time:
- - :ref:`int<class_int>` **get_unix_time** **(** **)** const
- Returns the current unix epoch timestamp.
- .. _class_OS_get_unix_time_from_datetime:
- - :ref:`int<class_int>` **get_unix_time_from_datetime** **(** :ref:`Dictionary<class_Dictionary>` datetime **)** const
- Get 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_get_datetime_from_unix_time>` directly into this function. Daylight savings time (dst), if present, is ignored.
- .. _class_OS_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.
- If the project name is empty, ``user://`` falls back to ``res://``.
- .. _class_OS_get_video_driver_count:
- - :ref:`int<class_int>` **get_video_driver_count** **(** **)** const
- .. _class_OS_get_video_driver_name:
- - :ref:`String<class_String>` **get_video_driver_name** **(** :ref:`int<class_int>` driver **)** const
- .. _class_OS_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 it is currently hidden.
- .. _class_OS_get_window_safe_area:
- - :ref:`Rect2<class_Rect2>` **get_window_safe_area** **(** **)** const
- .. _class_OS_has_environment:
- - :ref:`bool<class_bool>` **has_environment** **(** :ref:`String<class_String>` environment **)** const
- Returns ``true`` if an environment variable exists.
- .. _class_OS_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. See feature tags documentation.
- .. _class_OS_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_has_virtual_keyboard:
- - :ref:`bool<class_bool>` **has_virtual_keyboard** **(** **)** const
- Returns ``true`` if the platform has a virtual keyboard, ``false`` otherwise.
- .. _class_OS_hide_virtual_keyboard:
- - void **hide_virtual_keyboard** **(** **)**
- Hides the virtual keyboard if it is shown, does nothing otherwise.
- .. _class_OS_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_is_ok_left_and_cancel_right:
- - :ref:`bool<class_bool>` **is_ok_left_and_cancel_right** **(** **)** const
- Returns ``true`` if the "Okay" button should appear on the left and "Cancel" on the right.
- .. _class_OS_is_scancode_unicode:
- - :ref:`bool<class_bool>` **is_scancode_unicode** **(** :ref:`int<class_int>` code **)** const
- Returns ``true`` if the input code has a unicode character.
- .. _class_OS_is_stdout_verbose:
- - :ref:`bool<class_bool>` **is_stdout_verbose** **(** **)** const
- Returns ``true`` if the engine was executed with -v (verbose stdout).
- .. _class_OS_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_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_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_execute>` in non-blocking mode.
- Note that this method can also be used to kill processes that were not spawned by the game.
- .. _class_OS_move_window_to_foreground:
- - void **move_window_to_foreground** **(** **)**
- Moves the window to the front.
- .. _class_OS_native_video_is_playing:
- - :ref:`bool<class_bool>` **native_video_is_playing** **(** **)**
- Returns ``true`` if native video is playing.
- .. _class_OS_native_video_pause:
- - void **native_video_pause** **(** **)**
- Pauses native video playback.
- .. _class_OS_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_native_video_stop:
- - void **native_video_stop** **(** **)**
- Stops native video playback.
- .. _class_OS_native_video_unpause:
- - void **native_video_unpause** **(** **)**
- Resumes native video playback.
- .. _class_OS_open_midi_inputs:
- - void **open_midi_inputs** **(** **)**
- .. _class_OS_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.
- .. _class_OS_print_all_textures_by_size:
- - void **print_all_textures_by_size** **(** **)**
- Shows the list of loaded textures sorted by size in memory.
- .. _class_OS_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_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_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_set_icon:
- - void **set_icon** **(** :ref:`Image<class_Image>` icon **)**
- Sets the game's icon.
- .. _class_OS_set_ime_active:
- - void **set_ime_active** **(** :ref:`bool<class_bool>` active **)**
- Sets whether IME input mode should be enabled.
- .. _class_OS_set_ime_position:
- - void **set_ime_position** **(** :ref:`Vector2<class_Vector2>` position **)**
- Sets position of IME suggestion list popup (in window coordinates).
- .. _class_OS_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_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_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_set_window_title:
- - void **set_window_title** **(** :ref:`String<class_String>` title **)**
- Sets the window title to the specified string.
- .. _class_OS_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 downloads folders of the user.
- ``OS.shell_open("http://godotengine.org")`` opens the default web browser on the official Godot website.
- .. _class_OS_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).
|
