godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2025-12-31 17:49:03 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
2.1
godot-docs/classes/class_os.rst
Rémi Verschelde 53517d1d21 classref: Sync with current 2.1 source
2017-09-06 14:47:12 +02:00

912 lines
77 KiB
ReStructuredText
Raw Permalink Blame History

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_OS:
OS
==
**Inherits:** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Operating System functions.
Member Functions
----------------
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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:`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:`StringArray<class_stringarray>` arguments, :ref:`bool<class_bool>` blocking, :ref:`Array<class_array>` output=Array() **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`find_scancode_from_string<class_OS_find_scancode_from_string>` **(** :ref:`String<class_string>` string **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_borderless_window<class_OS_get_borderless_window>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_clipboard<class_OS_get_clipboard>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringArray<class_stringarray>` | :ref:`get_cmdline_args<class_OS_get_cmdline_args>` **(** **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_current_screen<class_OS_get_current_screen>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_custom_level<class_OS_get_custom_level>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_data_dir<class_OS_get_data_dir>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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:`Dictionary<class_dictionary>` | :ref:`get_engine_version<class_OS_get_engine_version>` **(** **)** 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:`int<class_int>` | :ref:`get_exit_code<class_OS_get_exit_code>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_frames_drawn<class_OS_get_frames_drawn>` **(** **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_frames_per_second<class_OS_get_frames_per_second>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_fullscreen_mode_list<class_OS_get_fullscreen_mode_list>` **(** :ref:`int<class_int>` screen=0 **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_iterations_per_second<class_OS_get_iterations_per_second>` **(** **)** 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:`Object<class_object>` | :ref:`get_main_loop<class_OS_get_main_loop>` **(** **)** 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_process_ID<class_OS_get_process_ID>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_processor_count<class_OS_get_processor_count>` **(** **)** 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=0 **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_screen_orientation<class_OS_get_screen_orientation>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_screen_position<class_OS_get_screen_position>` **(** :ref:`int<class_int>` screen=0 **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_screen_size<class_OS_get_screen_size>` **(** :ref:`int<class_int>` screen=0 **)** 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:`int<class_int>` dir **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_system_time_secs<class_OS_get_system_time_secs>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_target_fps<class_OS_get_target_fps>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_ticks_msec<class_OS_get_ticks_msec>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_dictionary>` | :ref:`get_time<class_OS_get_time>` **(** :ref:`bool<class_bool>` utc=false **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_time_scale<class_OS_get_time_scale>` **(** **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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:`Vector2<class_vector2>` | :ref:`get_video_mode_size<class_OS_get_video_mode_size>` **(** :ref:`int<class_int>` screen=0 **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_window_position<class_OS_get_window_position>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_window_size<class_OS_get_window_size>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_environment<class_OS_has_environment>` **(** :ref:`String<class_string>` environment **)** 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_in_low_processor_usage_mode<class_OS_is_in_low_processor_usage_mode>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_keep_screen_on<class_OS_is_keep_screen_on>` **(** **)** 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_video_mode_fullscreen<class_OS_is_video_mode_fullscreen>` **(** :ref:`int<class_int>` screen=0 **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_video_mode_resizable<class_OS_is_video_mode_resizable>` **(** :ref:`int<class_int>` screen=0 **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_vsync_enabled<class_OS_is_vsync_enabled>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_window_fullscreen<class_OS_is_window_fullscreen>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_window_maximized<class_OS_is_window_maximized>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_window_minimized<class_OS_is_window_minimized>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_window_resizable<class_OS_is_window_resizable>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`kill<class_OS_kill>` **(** :ref:`int<class_int>` pid **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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:`int<class_int>` | :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:`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:`StringArray<class_stringarray>` 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_borderless_window<class_OS_set_borderless_window>` **(** :ref:`bool<class_bool>` borderless **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_clipboard<class_OS_set_clipboard>` **(** :ref:`String<class_string>` clipboard **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_current_screen<class_OS_set_current_screen>` **(** :ref:`int<class_int>` screen **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_exit_code<class_OS_set_exit_code>` **(** :ref:`int<class_int>` code **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_icon<class_OS_set_icon>` **(** :ref:`Image<class_image>` icon **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_iterations_per_second<class_OS_set_iterations_per_second>` **(** :ref:`int<class_int>` iterations_per_second **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_keep_screen_on<class_OS_set_keep_screen_on>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_low_processor_usage_mode<class_OS_set_low_processor_usage_mode>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_screen_orientation<class_OS_set_screen_orientation>` **(** :ref:`int<class_int>` orientation **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_target_fps<class_OS_set_target_fps>` **(** :ref:`int<class_int>` target_fps **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`set_thread_name<class_OS_set_thread_name>` **(** :ref:`String<class_string>` name **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_time_scale<class_OS_set_time_scale>` **(** :ref:`float<class_float>` time_scale **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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_use_vsync<class_OS_set_use_vsync>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_video_mode<class_OS_set_video_mode>` **(** :ref:`Vector2<class_vector2>` size, :ref:`bool<class_bool>` fullscreen, :ref:`bool<class_bool>` resizable, :ref:`int<class_int>` screen=0 **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_window_fullscreen<class_OS_set_window_fullscreen>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_window_maximized<class_OS_set_window_maximized>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_window_minimized<class_OS_set_window_minimized>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_window_position<class_OS_set_window_position>` **(** :ref:`Vector2<class_vector2>` position **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_window_resizable<class_OS_set_window_resizable>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_window_size<class_OS_set_window_size>` **(** :ref:`Vector2<class_vector2>` size **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_window_title<class_OS_set_window_title>` **(** :ref:`String<class_string>` title **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :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="" **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
- **DAY_SUNDAY** = **0**
- **DAY_MONDAY** = **1**
- **DAY_TUESDAY** = **2**
- **DAY_WEDNESDAY** = **3**
- **DAY_THURSDAY** = **4**
- **DAY_FRIDAY** = **5**
- **DAY_SATURDAY** = **6**
- **MONTH_JANUARY** = **1**
- **MONTH_FEBRUARY** = **2**
- **MONTH_MARCH** = **3**
- **MONTH_APRIL** = **4**
- **MONTH_MAY** = **5**
- **MONTH_JUNE** = **6**
- **MONTH_JULY** = **7**
- **MONTH_AUGUST** = **8**
- **MONTH_SEPTEMBER** = **9**
- **MONTH_OCTOBER** = **10**
- **MONTH_NOVEMBER** = **11**
- **MONTH_DECEMBER** = **12**
- **SCREEN_ORIENTATION_LANDSCAPE** = **0**
- **SCREEN_ORIENTATION_PORTRAIT** = **1**
- **SCREEN_ORIENTATION_REVERSE_LANDSCAPE** = **2**
- **SCREEN_ORIENTATION_REVERSE_PORTRAIT** = **3**
- **SCREEN_ORIENTATION_SENSOR_LANDSCAPE** = **4**
- **SCREEN_ORIENTATION_SENSOR_PORTRAIT** = **5**
- **SCREEN_ORIENTATION_SENSOR** = **6**
- **SYSTEM_DIR_DESKTOP** = **0**
- **SYSTEM_DIR_DCIM** = **1**
- **SYSTEM_DIR_DOCUMENTS** = **2**
- **SYSTEM_DIR_DOWNLOADS** = **3**
- **SYSTEM_DIR_MOVIES** = **4**
- **SYSTEM_DIR_MUSIC** = **5**
- **SYSTEM_DIR_PICTURES** = **6**
- **SYSTEM_DIR_RINGTONES** = **7**
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.
Member Function Description
---------------------------
.. _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
Return true if the host OS allows drawing.
.. _class_OS_can_use_threads:
- :ref:`bool<class_bool>` **can_use_threads** **(** **)** const
Returns if the current host platform is using multiple threads.
.. _class_OS_delay_msec:
- void **delay_msec** **(** :ref:`int<class_int>` msec **)** const
Delay executing of the current thread by given milliseconds.
.. _class_OS_delay_usec:
- void **delay_usec** **(** :ref:`int<class_int>` usec **)** const
Delay executing 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:`StringArray<class_stringarray>` arguments, :ref:`bool<class_bool>` blocking, :ref:`Array<class_array>` output=Array() **)**
Execute the binary file in given path, optionally blocking until it returns. A process ID is returned.
.. _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_borderless_window:
- :ref:`bool<class_bool>` **get_borderless_window** **(** **)** const
Returns true if the current window is borderless.
.. _class_OS_get_clipboard:
- :ref:`String<class_string>` **get_clipboard** **(** **)** const
Get clipboard from the host OS.
.. _class_OS_get_cmdline_args:
- :ref:`StringArray<class_stringarray>` **get_cmdline_args** **(** **)**
Return the commandline passed to the engine.
.. _class_OS_get_current_screen:
- :ref:`int<class_int>` **get_current_screen** **(** **)** const
Returns the current screen index (0 padded).
.. _class_OS_get_custom_level:
- :ref:`String<class_string>` **get_custom_level** **(** **)** const
Returns the value of the commandline argument "-level".
.. _class_OS_get_data_dir:
- :ref:`String<class_string>` **get_data_dir** **(** **)** const
Return the absolute directory path of user data path(user://).
.. _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
Return the total amount of dynamic memory used (only works in debug).
.. _class_OS_get_engine_version:
- :ref:`Dictionary<class_dictionary>` **get_engine_version** **(** **)** const
Returns the current engine version information in a Dictionary.
"major" - Holds the major version number as a String
"minor" - Holds the minor version number as a String
"patch" - Holds the patch version number as a String
"status" - Holds the status (e.g. "beta", "rc1", "rc2", ... "stable") as a String
"revision" - Holds the revision (e.g. "custom-build") as a String
"string" - major + minor + patch + status + revision in a single String
.. _class_OS_get_environment:
- :ref:`String<class_string>` **get_environment** **(** :ref:`String<class_string>` environment **)** const
Return an environment variable.
.. _class_OS_get_executable_path:
- :ref:`String<class_string>` **get_executable_path** **(** **)** const
Return the path to the current engine executable.
.. _class_OS_get_exit_code:
- :ref:`int<class_int>` **get_exit_code** **(** **)** const
.. _class_OS_get_frames_drawn:
- :ref:`int<class_int>` **get_frames_drawn** **(** **)**
Return the total amount of frames drawn.
.. _class_OS_get_frames_per_second:
- :ref:`float<class_float>` **get_frames_per_second** **(** **)** const
Returns the frames per second of the running game.
.. _class_OS_get_fullscreen_mode_list:
- :ref:`Array<class_array>` **get_fullscreen_mode_list** **(** :ref:`int<class_int>` screen=0 **)** const
Return the list of fullscreen modes.
.. _class_OS_get_iterations_per_second:
- :ref:`int<class_int>` **get_iterations_per_second** **(** **)** const
Return the amount of fixed iterations per second (for fixed process and physics).
.. _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" or "ERROR"
.. _class_OS_get_locale:
- :ref:`String<class_string>` **get_locale** **(** **)** const
Return the host OS locale.
.. _class_OS_get_main_loop:
- :ref:`Object<class_object>` **get_main_loop** **(** **)** const
Return the main loop object (see :ref:`MainLoop<class_mainloop>`).
.. _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
Return the name of the host OS. Possible values are: "Android", "BlackBerry 10", "Flash", "Haiku", "iOS", "HTML5", "OSX", "Server", "Windows", "WinRT", "X11"
.. _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_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=0 **)** 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_orientation:
- :ref:`int<class_int>` **get_screen_orientation** **(** **)** const
Returns the current screen orientation, the return value will be one of the SCREEN_ORIENTATION constants in this class.
.. _class_OS_get_screen_position:
- :ref:`Vector2<class_vector2>` **get_screen_position** **(** :ref:`int<class_int>` screen=0 **)** const
.. _class_OS_get_screen_size:
- :ref:`Vector2<class_vector2>` **get_screen_size** **(** :ref:`int<class_int>` screen=0 **)** 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
Return 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
.. _class_OS_get_system_dir:
- :ref:`String<class_string>` **get_system_dir** **(** :ref:`int<class_int>` dir **)** const
.. _class_OS_get_system_time_secs:
- :ref:`int<class_int>` **get_system_time_secs** **(** **)** const
.. _class_OS_get_target_fps:
- :ref:`float<class_float>` **get_target_fps** **(** **)** const
.. _class_OS_get_ticks_msec:
- :ref:`int<class_int>` **get_ticks_msec** **(** **)** const
Return the amount of time passed in milliseconds 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_scale:
- :ref:`float<class_float>` **get_time_scale** **(** **)**
.. _class_OS_get_time_zone_info:
- :ref:`Dictionary<class_dictionary>` **get_time_zone_info** **(** **)** const
.. _class_OS_get_unique_ID:
- :ref:`String<class_string>` **get_unique_ID** **(** **)** const
.. _class_OS_get_unix_time:
- :ref:`int<class_int>` **get_unix_time** **(** **)** const
Return the current unix 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_video_mode_size:
- :ref:`Vector2<class_vector2>` **get_video_mode_size** **(** :ref:`int<class_int>` screen=0 **)** const
Return the current video mode size.
.. _class_OS_get_window_position:
- :ref:`Vector2<class_vector2>` **get_window_position** **(** **)** const
Returns 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_get_window_size:
- :ref:`Vector2<class_vector2>` **get_window_size** **(** **)** const
Returns the size of the window (without counting window manager decorations).
.. _class_OS_has_environment:
- :ref:`bool<class_bool>` **has_environment** **(** :ref:`String<class_string>` environment **)** const
Return true if an environment variable exists.
.. _class_OS_has_touchscreen_ui_hint:
- :ref:`bool<class_bool>` **has_touchscreen_ui_hint** **(** **)** const
.. _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
.. _class_OS_is_in_low_processor_usage_mode:
- :ref:`bool<class_bool>` **is_in_low_processor_usage_mode** **(** **)** const
Return true if low cpu usage mode is enabled.
.. _class_OS_is_keep_screen_on:
- :ref:`bool<class_bool>` **is_keep_screen_on** **(** **)** const
Returns whether the screen is being kept on or not.
.. _class_OS_is_ok_left_and_cancel_right:
- :ref:`bool<class_bool>` **is_ok_left_and_cancel_right** **(** **)** const
.. _class_OS_is_scancode_unicode:
- :ref:`bool<class_bool>` **is_scancode_unicode** **(** :ref:`int<class_int>` code **)** const
.. _class_OS_is_stdout_verbose:
- :ref:`bool<class_bool>` **is_stdout_verbose** **(** **)** const
Return true if the engine was executed with -v (verbose stdout).
.. _class_OS_is_video_mode_fullscreen:
- :ref:`bool<class_bool>` **is_video_mode_fullscreen** **(** :ref:`int<class_int>` screen=0 **)** const
Return true if the current video mode is fullscreen.
.. _class_OS_is_video_mode_resizable:
- :ref:`bool<class_bool>` **is_video_mode_resizable** **(** :ref:`int<class_int>` screen=0 **)** const
Return true if the window is resizable.
.. _class_OS_is_vsync_enabled:
- :ref:`bool<class_bool>` **is_vsync_enabled** **(** **)** const
.. _class_OS_is_window_fullscreen:
- :ref:`bool<class_bool>` **is_window_fullscreen** **(** **)** const
Returns whether the window is in fullscreen mode or not.
.. _class_OS_is_window_maximized:
- :ref:`bool<class_bool>` **is_window_maximized** **(** **)** const
Return true if the window is maximized.
.. _class_OS_is_window_minimized:
- :ref:`bool<class_bool>` **is_window_minimized** **(** **)** const
Return true if the window is minimized.
.. _class_OS_is_window_resizable:
- :ref:`bool<class_bool>` **is_window_resizable** **(** **)** const
Returns whether the window is resizable or not.
.. _class_OS_kill:
- :ref:`int<class_int>` **kill** **(** :ref:`int<class_int>` pid **)**
Kill a process ID (this method can be used to kill processes that were not spawned by the game).
.. _class_OS_native_video_is_playing:
- :ref:`bool<class_bool>` **native_video_is_playing** **(** **)**
.. _class_OS_native_video_pause:
- void **native_video_pause** **(** **)**
.. _class_OS_native_video_play:
- :ref:`int<class_int>` **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 **)**
.. _class_OS_native_video_stop:
- void **native_video_stop** **(** **)**
.. _class_OS_native_video_unpause:
- void **native_video_unpause** **(** **)**
.. _class_OS_print_all_resources:
- void **print_all_resources** **(** :ref:`String<class_string>` tofile="" **)**
.. _class_OS_print_all_textures_by_size:
- void **print_all_textures_by_size** **(** **)**
.. _class_OS_print_resources_by_type:
- void **print_resources_by_type** **(** :ref:`StringArray<class_stringarray>` types **)**
.. _class_OS_print_resources_in_use:
- void **print_resources_in_use** **(** :ref:`bool<class_bool>` short=false **)**
.. _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_borderless_window:
- void **set_borderless_window** **(** :ref:`bool<class_bool>` borderless **)**
.. _class_OS_set_clipboard:
- void **set_clipboard** **(** :ref:`String<class_string>` clipboard **)**
Set clipboard to the OS.
.. _class_OS_set_current_screen:
- void **set_current_screen** **(** :ref:`int<class_int>` screen **)**
.. _class_OS_set_exit_code:
- void **set_exit_code** **(** :ref:`int<class_int>` code **)**
.. _class_OS_set_icon:
- void **set_icon** **(** :ref:`Image<class_image>` icon **)**
.. _class_OS_set_iterations_per_second:
- void **set_iterations_per_second** **(** :ref:`int<class_int>` iterations_per_second **)**
Set the amount of fixed iterations per second (for fixed process and physics).
.. _class_OS_set_keep_screen_on:
- void **set_keep_screen_on** **(** :ref:`bool<class_bool>` enabled **)**
Set keep screen on if true, or goes to sleep by device setting if false. (for Android/iOS)
.. _class_OS_set_low_processor_usage_mode:
- void **set_low_processor_usage_mode** **(** :ref:`bool<class_bool>` enable **)**
Set to true to enable the low cpu usage mode. In this mode, the screen only redraws when there are changes, and a considerable sleep time is inserted between frames. This way, editors using the engine UI only use very little cpu.
.. _class_OS_set_screen_orientation:
- void **set_screen_orientation** **(** :ref:`int<class_int>` orientation **)**
Sets the current screen orientation, the argument value must be one of the SCREEN_ORIENTATION constants in this class.
.. _class_OS_set_target_fps:
- void **set_target_fps** **(** :ref:`int<class_int>` target_fps **)**
.. _class_OS_set_thread_name:
- :ref:`int<class_int>` **set_thread_name** **(** :ref:`String<class_string>` name **)**
.. _class_OS_set_time_scale:
- void **set_time_scale** **(** :ref:`float<class_float>` time_scale **)**
Speeds up or slows down the physics by changing the delta variable. (delta \* time_scale)
.. _class_OS_set_use_file_access_save_and_swap:
- void **set_use_file_access_save_and_swap** **(** :ref:`bool<class_bool>` enabled **)**
.. _class_OS_set_use_vsync:
- void **set_use_vsync** **(** :ref:`bool<class_bool>` enable **)**
.. _class_OS_set_video_mode:
- void **set_video_mode** **(** :ref:`Vector2<class_vector2>` size, :ref:`bool<class_bool>` fullscreen, :ref:`bool<class_bool>` resizable, :ref:`int<class_int>` screen=0 **)**
Change the video mode.
.. _class_OS_set_window_fullscreen:
- void **set_window_fullscreen** **(** :ref:`bool<class_bool>` enabled **)**
Sets window fullscreen mode to the *enabled* argument, *enabled* is a toggle for the fullscreen mode, calling the function with *enabled* true when the screen is not on fullscreen mode will cause the screen to go to fullscreen mode, calling the function with *enabled* false when the screen is in fullscreen mode will cause the window to exit the fullscreen mode.
.. _class_OS_set_window_maximized:
- void **set_window_maximized** **(** :ref:`bool<class_bool>` enabled **)**
Set the window size to maximized.
.. _class_OS_set_window_minimized:
- void **set_window_minimized** **(** :ref:`bool<class_bool>` enabled **)**
Set whether the window is minimized.
.. _class_OS_set_window_position:
- void **set_window_position** **(** :ref:`Vector2<class_vector2>` position **)**
Sets the position of the window to the specified position (this function could be restricted by the window manager, meaning that there could be some unreachable areas of the screen).
.. _class_OS_set_window_resizable:
- void **set_window_resizable** **(** :ref:`bool<class_bool>` enabled **)**
Set the window resizable state, if the window is not resizable it will preserve the dimensions specified in the project settings.
.. _class_OS_set_window_size:
- void **set_window_size** **(** :ref:`Vector2<class_vector2>` size **)**
Sets the window size to the specified size.
.. _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:`int<class_int>` **shell_open** **(** :ref:`String<class_string>` uri **)**
.. _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).
Reference in New Issue View Git Blame Copy Permalink