Description¶

Operating System functions. OS wraps the most common functionality to communicate with the host operating system, such as the clipboard, video driver, date and time, timers, environment variables, execution of binaries, command line, etc.

Tutorials¶

• OS Test Demo

Properties¶

Methods¶

Enumerations¶

enumVideoDriver:

• VIDEO_DRIVER_GLES2 =1 --- The GLES2 rendering backend. It uses OpenGL ES 2.0 on mobile devices, OpenGL 2.1 on desktop platforms and WebGL 1.0 on the web.

• VIDEO_DRIVER_GLES3 =0 --- The GLES3 rendering backend. It uses OpenGL ES 3.0 on mobile devices, OpenGL 3.3 on desktop platforms and WebGL 2.0 on the web.

enumWeekday:

• 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.

enumMonth:

• 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.

enumHandleType:

• APPLICATION_HANDLE =0 --- Application handle:

• Windows:HINSTANCE of the application

• MacOS:NSApplication* of the application (not yet implemented)

• Android:JNIEnv* of the application (not yet implemented)

• DISPLAY_HANDLE =1 --- Display handle:

• Linux:X11::Display* for the display

• WINDOW_HANDLE =2 --- Window handle:

• Windows:HWND of the main window

• Linux:X11::Window* of the main window

• MacOS:NSWindow* of the main window (not yet implemented)

• Android:jObject the main android activity (not yet implemented)

• WINDOW_VIEW =3 --- Window view:

• Windows:HDC of the main window drawing context

• MacOS:NSView* of the main windows view (not yet implemented)

• OPENGL_CONTEXT =4 --- OpenGL Context:

• Windows:HGLRC

• Linux:X11::GLXContext

• MacOS:NSOpenGLContext* (not yet implemented)

enumScreenOrientation:

• 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.

enumSystemDir:

• 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.

enumPowerState:

• 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.

Property Descriptions¶

• Stringclipboard

The clipboard from the host OS. Might be unavailable on some platforms.

• intcurrent_screen

The current screen index (starting from 0).

• booldelta_smoothing

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

• intexit_code

The exit code passed to the OS when the main loop exits. By convention, an exit code of0 indicates success whereas a non-zero exit code indicates an error. For portability reasons, the exit code should be set between 0 and 125 (inclusive).

Note: This value will be ignored if usingSceneTree.quit with anexit_code argument passed.

• boolkeep_screen_on

Iftrue, the engine tries to keep the screen on while the game is running. Useful on mobile.

• boollow_processor_usage_mode

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

• intlow_processor_usage_mode_sleep_usec

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

• Vector2max_window_size

The maximum size of the window (without counting window manager decorations). Does not affect fullscreen mode. Set to(0,0) to reset to the system default value.

• Vector2min_window_size

The minimum size of the window in pixels (without counting window manager decorations). Does not affect fullscreen mode. Set to(0,0) to reset to the system's default value.

Note: By default, the project window has a minimum size ofVector2(64,64). This prevents issues that can arise when the window is resized to a near-zero size.

• ScreenOrientationscreen_orientation

The current screen orientation.

• Stringtablet_driver

The current tablet driver in use.

• boolvsync_enabled

Iftrue, vertical synchronization (Vsync) is enabled.

• boolvsync_via_compositor

Iftrue andvsync_enabled is true, the operating system's window compositor will be used for vsync when the compositor is enabled and the game is in windowed mode.

Note: This option is experimental and meant to alleviate stutter experienced by some users. However, some users have experienced a Vsync framerate halving (e.g. from 60 FPS to 30 FPS) when using it.

Note: This property is only implemented on Windows.

• boolwindow_borderless

Iftrue, removes the window frame.

Note: Settingwindow_borderless tofalse disables per-pixel transparency.

• boolwindow_fullscreen

Iftrue, the window is fullscreen.

• boolwindow_maximized

Iftrue, the window is maximized.

• boolwindow_minimized

Iftrue, the window is minimized.

• boolwindow_per_pixel_transparency_enabled

Iftrue, the window background is transparent and the window frame is removed.

Useget_tree().get_root().set_transparent_background(true) to disable main viewport background rendering.

Note: This property has no effect ifProjectSettings.display/window/per_pixel_transparency/allowed setting is disabled.

Note: This property is implemented on HTML5, Linux, macOS, Windows, and Android. It can't be changed at runtime for Android. UseProjectSettings.display/window/per_pixel_transparency/enabled to set it at startup instead.

• Vector2window_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.

• boolwindow_resizable

Iftrue, the window is resizable by the user.

• Vector2window_size

The size of the window (without counting window manager decorations).

Method Descriptions¶

• voidalert(String text,String title="Alert!")

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

• boolcan_draw()const

Returnstrue if the host OS allows drawing.

• boolcan_use_threads()const

Returnstrue if the current host platform is using multiple threads.

• voidcenter_window()

Centers the window on the screen if in windowed mode.

• voidclose_midi_inputs()

Shuts down system MIDI driver.

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

• voiddelay_msec(int msec)const

Delays execution of the current thread bymsec milliseconds.msec must be greater than or equal to0. Otherwise,delay_msec will do nothing and will print an error message.

Note:delay_msec is ablocking way to delay code execution. To delay code execution in a non-blocking way, seeSceneTree.create_timer. Yielding withSceneTree.create_timer will delay the execution of code placed below theyield without affecting the rest of the project (or editor, forEditorPlugins andEditorScripts).

Note: Whendelay_msec is called on the main thread, it will freeze the project and will prevent it from redrawing and registering input until the delay has passed. When usingdelay_msec as part of anEditorPlugin orEditorScript, it will freeze the editor but won't freeze the project if it is currently running (since the project is an independent child process).

• voiddelay_usec(int usec)const

Delays execution of the current thread byusec microseconds.usec must be greater than or equal to0. Otherwise,delay_usec will do nothing and will print an error message.

Note:delay_usec is ablocking way to delay code execution. To delay code execution in a non-blocking way, seeSceneTree.create_timer. Yielding withSceneTree.create_timer will delay the execution of code placed below theyield without affecting the rest of the project (or editor, forEditorPlugins andEditorScripts).

Note: Whendelay_usec is called on the main thread, it will freeze the project and will prevent it from redrawing and registering input until the delay has passed. When usingdelay_usec as part of anEditorPlugin orEditorScript, it will freeze the editor but won't freeze the project if it is currently running (since the project is an independent child process).

• voiddump_memory_to_file(String file)

Dumps the memory allocation ringlist to a file (only works in debug).

Entry format per line: "Address - Size - Description".

• voiddump_resources_to_file(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.

• intexecute(String path,PoolStringArray arguments,bool blocking=true,Array output=[ ],bool read_stderr=false)

Execute the file at the given path with the arguments passed as an array of strings. Platform path resolution will take place. The resolved file must exist and be executable.

The arguments are used in the given order and separated by a space, soOS.execute("ping",["-w","3","godotengine.org"],false) will resolve toping-w3godotengine.org in the system's shell.

This method has slightly different behavior based on whether theblocking mode is enabled.

Ifblocking istrue, the Godot thread will pause its execution while waiting for the process to terminate. The shell output of the process will be written to theoutput array as a single string. When the process terminates, the Godot thread will resume execution.

Ifblocking isfalse, the Godot thread will continue while the new process runs. It is not possible to retrieve the shell output in non-blocking mode, sooutput will be empty.

The return value also depends on the blocking mode. When blocking, the method will return an exit code of the process. When non-blocking, the method returns a process ID, which you can use to monitor the process (and potentially terminate it withkill). If the process forking (non-blocking) or opening (blocking) fails, the method will return-1 or another exit code.

Example of blocking mode and retrieving the shell output:

varoutput=[]varexit_code=OS.execute("ls",["-l","/tmp"],true,output)

Example of non-blocking mode, running another instance of the project and storing its process ID:

varpid=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)

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

Note: To execute a Windows command interpreter built-in command, specifycmd.exe inpath,/c as the first argument, and the desired command as the second argument.

Note: To execute a PowerShell built-in command, specifypowershell.exe inpath,-Command as the first argument, and the desired command as the second argument.

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

• intfind_scancode_from_string(String string)const

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

• intget_audio_driver_count()const

Returns the total number of available audio drivers.

• Stringget_audio_driver_name(int driver)const

Returns the audio driver name for the given index.

• Stringget_cache_dir()const

Returns theglobal cache data directory according to the operating system's standards. On desktop platforms, this path can be overridden by setting theXDG_CACHE_HOME environment variable before starting the project. SeeFile paths in Godot projects in the documentation for more information. See alsoget_config_dir andget_data_dir.

Not to be confused withget_user_data_dir, which returns theproject-specific user data path.

• PoolStringArrayget_cmdline_args()

Returns the command-line arguments passed to the engine.

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

You can also incorporate environment variables using theget_environment method.

You can setProjectSettings.editor/main_run_args to define command-line arguments to be passed by the editor when running the project.

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

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

• Stringget_config_dir()const

Returns theglobal user configuration directory according to the operating system's standards. On desktop platforms, this path can be overridden by setting theXDG_CONFIG_HOME environment variable before starting the project. SeeFile paths in Godot projects in the documentation for more information. See alsoget_cache_dir andget_data_dir.

Not to be confused withget_user_data_dir, which returns theproject-specific user data path.

• PoolStringArrayget_connected_midi_inputs()

Returns an array of MIDI device names.

The returned array will be empty if the system MIDI driver has not previously been initialised withopen_midi_inputs.

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

• VideoDriverget_current_video_driver()const

Returns the currently used video driver, using one of the values fromVideoDriver.

• Stringget_data_dir()const

Returns theglobal user data directory according to the operating system's standards. On desktop platforms, this path can be overridden by setting theXDG_DATA_HOME environment variable before starting the project. SeeFile paths in Godot projects in the documentation for more information. See alsoget_cache_dir andget_config_dir.

Not to be confused withget_user_data_dir, which returns theproject-specific user data path.

• Dictionaryget_date(bool utc=false)const

Returns current date as a dictionary of keys:year,month,day,weekday,dst (Daylight Savings Time).

• Dictionaryget_datetime(bool utc=false)const

Returns current datetime as a dictionary of keys:year,month,day,weekday,dst (Daylight Savings Time),hour,minute,second.

• Dictionaryget_datetime_from_unix_time(int unix_time_val)const

Gets a dictionary of time values corresponding to the given UNIX epoch time (in seconds).

The returned Dictionary's values will be the same asget_datetime, with the exception of Daylight Savings Time as it cannot be determined from the epoch.

• intget_dynamic_memory_usage()const

Returns the total amount of dynamic memory used (only works in debug).

• Stringget_environment(String variable)const

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

Note: Double-check the casing ofvariable. Environment variable names are case-sensitive on all platforms except Windows.

• Stringget_executable_path()const

Returns the path to the current engine executable.

• PoolStringArrayget_granted_permissions()const

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

Note: This method is implemented on Android.

• Vector2get_ime_selection()const

Returns the IME cursor position (the currently-edited portion of the string) relative to the characters in the composition string.

MainLoop.NOTIFICATION_OS_IME_UPDATE is sent to the application to notify it of changes to the IME cursor position.

Note: This method is implemented on macOS.

• Stringget_ime_text()const

Returns the IME intermediate composition string.

MainLoop.NOTIFICATION_OS_IME_UPDATE is sent to the application to notify it of changes to the IME composition string.

Note: This method is implemented on macOS.

• Stringget_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".

Note: This method is implemented on Linux, macOS and Windows. Returns"QWERTY" on unsupported platforms.

• Stringget_locale()const

Returns the host OS locale as a string of the formlanguage_Script_COUNTRY_VARIANT@extra. If you want only the language code and not the fully specified locale from the OS, you can useget_locale_language.

language - 2 or 3-letterlanguage code, in lower case.

Script - optional, 4-letterscript code, in title case.

COUNTRY - optional, 2 or 3-lettercountry code, in upper case.

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

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

• Stringget_locale_language()const

Returns the host OS locale's 2 or 3-letterlanguage code as a string which should be consistent on all platforms. This is equivalent to extracting thelanguage part of theget_locale string.

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

• Stringget_model_name()const

Returns the model name of the current device.

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

• Stringget_name()const

Returns the name of the host OS. Possible values are:"Android","iOS","HTML5","OSX","Server","Windows","UWP","X11".

• intget_native_handle(HandleType handle_type)

Returns internal structure pointers for use in GDNative plugins.

Note: This method is implemented on Linux and Windows (other OSs will soon be supported).

• intget_power_percent_left()

Returns the amount of battery left in the device as a percentage. Returns-1 if power state is unknown.

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

• intget_power_seconds_left()

Returns an estimate of the time left in seconds before the device runs out of battery. Returns-1 if power state is unknown.

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

• PowerStateget_power_state()

Returns the current state of the device regarding battery and power. SeePowerState constants.

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

• intget_process_id()const

Returns the project's process ID.

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

• intget_processor_count()const

Returns the number of threads available on the host machine.

• Vector2get_real_window_size()const

Returns the window size including decorations like window borders.

• Stringget_scancode_string(int code)const

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

See alsoInputEventKey.scancode andInputEventKey.get_scancode_with_modifiers.

• intget_screen_count()const

Returns the number of displays attached to the host machine.

• intget_screen_dpi(int screen=-1)const

Returns the dots per inch density of the specified screen. Ifscreen is-1 (the default value), the current screen will be used.

Note: On macOS, returned value is inaccurate if fractional display scaling mode is used.

Note: On Android devices, the actual screen densities are grouped into six generalized densities:

ldpi-120dpimdpi-160dpihdpi-240dpixhdpi-320dpixxhdpi-480dpixxxhdpi-640dpi

Note: This method is implemented on Android, Linux, macOS and Windows. Returns72 on unsupported platforms.

• floatget_screen_max_scale()const

Return the greatest scale factor of all screens.

Note: On macOS returned value is2.0 if there is at least one hiDPI (Retina) screen in the system, and1.0 in all other cases.

Note: This method is implemented on macOS.

• Vector2get_screen_position(int screen=-1)const

Returns the position of the specified screen by index. Ifscreen is-1 (the default value), the current screen will be used.

• floatget_screen_scale(int screen=-1)const

Return the scale factor of the specified screen by index. Ifscreen is-1 (the default value), the current screen will be used.

Note: On macOS returned value is2.0 for hiDPI (Retina) screen, and1.0 for all other cases.

Note: This method is implemented on macOS.

• Vector2get_screen_size(int screen=-1)const

Returns the dimensions in pixels of the specified screen. Ifscreen is-1 (the default value), the current screen will be used.

• intget_splash_tick_msec()const

Returns the amount of time in milliseconds it took for the boot logo to appear.

• intget_static_memory_peak_usage()const

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

• intget_static_memory_usage()const

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

• Stringget_system_dir(SystemDir dir,bool shared_storage=true)const

Returns the actual path to commonly used folders across different platforms. Available locations are specified inSystemDir.

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

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

• intget_system_time_msecs()const

Returns the epoch time of the operating system in milliseconds.

• intget_system_time_secs()const

Returns the epoch time of the operating system in seconds.

• intget_tablet_driver_count()const

Returns the total number of available tablet drivers.

Note: This method is implemented on Windows.

• Stringget_tablet_driver_name(int idx)const

Returns the tablet driver name for the given index.

Note: This method is implemented on Windows.

• intget_thread_caller_id()const

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

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

• intget_ticks_msec()const

Returns the amount of time passed in milliseconds since the engine started.

• intget_ticks_usec()const

Returns the amount of time passed in microseconds since the engine started.

• Dictionaryget_time(bool utc=false)const

Returns current time as a dictionary of keys: hour, minute, second.

• Dictionaryget_time_zone_info()const

Returns the current time zone as a dictionary with the keys: bias and name.

• Stringget_unique_id()const

Returns a string that is unique to the device.

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

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

• intget_unix_time()const

Returns the current UNIX epoch timestamp in seconds.

Important: This is the system clock that the user can manually set.Never use this method for precise time calculation since its results are also subject to automatic adjustments by the operating system.Always useget_ticks_usec orget_ticks_msec for precise time calculation instead, since they are guaranteed to be monotonic (i.e. never decrease).

• intget_unix_time_from_datetime(Dictionary datetime)const

Gets an epoch time value from a dictionary of time values.

datetime must be populated with the following keys:year,month,day,hour,minute,second.

If the dictionary is empty0 is returned. If some keys are omitted, they default to the equivalent values for the UNIX epoch timestamp 0 (1970-01-01 at 00:00:00 UTC).

You can pass the output fromget_datetime_from_unix_time directly into this function. Daylight Savings Time (dst), if present, is ignored.

• Stringget_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] ifuse_custom_user_dir is set.

On macOS, this is~/Library/ApplicationSupport/Godot/app_userdata/[project_name], or~/Library/ApplicationSupport/[custom_name] ifuse_custom_user_dir is set.

On Windows, this is%APPDATA%\Godot\app_userdata\[project_name], or%APPDATA%\[custom_name] ifuse_custom_user_dir is set.%APPDATA% expands to%USERPROFILE%\AppData\Roaming.

If the project name is empty,user:// falls back tores://.

Not to be confused withget_data_dir, which returns theglobal (non-project-specific) user data directory.

• intget_video_driver_count()const

Returns the number of video drivers supported on the current platform.

• Stringget_video_driver_name(VideoDriver driver)const

Returns the name of the video driver matching the givendriver index. This index is a value fromVideoDriver, and you can useget_current_video_driver to get the current backend's index.

• intget_virtual_keyboard_height()

Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or if it is currently hidden.

• Rect2get_window_safe_area()const

Returns unobscured area of the window where interactive controls should be rendered.

• voidglobal_menu_add_item(String menu,String label,Variant id,Variant meta)

Add a new item with text "label" to global menu. Use "_dock" menu to add item to the macOS dock icon menu.

Note: This method is implemented on macOS.

• voidglobal_menu_add_separator(String menu)

Add a separator between items. Separators also occupy an index.

Note: This method is implemented on macOS.

• voidglobal_menu_clear(String menu)

Clear the global menu, in effect removing all items.

Note: This method is implemented on macOS.

• voidglobal_menu_remove_item(String menu,int idx)

Removes the item at index "idx" from the global menu. Note that the indexes of items after the removed item are going to be shifted by one.

Note: This method is implemented on macOS.

• boolhas_environment(String variable)const

Returnstrue if the environment variable with the namevariable exists.

Note: Double-check the casing ofvariable. Environment variable names are case-sensitive on all platforms except Windows.

• boolhas_feature(String tag_name)const

Returnstrue if the feature for the given feature tag is supported in the currently running instance, depending on the platform, build etc. Can be used to check whether you're currently running a debug build, on a certain platform or arch, etc. Refer to theFeature Tags documentation for more details.

Note: Tag names are case-sensitive.

• boolhas_touchscreen_ui_hint()const

Returnstrue if the device has a touchscreen or emulates one.

• boolhas_virtual_keyboard()const

Returnstrue if the platform has a virtual keyboard,false otherwise.

• voidhide_virtual_keyboard()

Hides the virtual keyboard if it is shown, does nothing otherwise.

• boolis_debug_build()const

Returnstrue if the Godot binary used to run the project is adebug export template, or when running in the editor.

Returnsfalse if the Godot binary used to run the project is arelease export template.

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

• boolis_ok_left_and_cancel_right()const

Returnstrue if theOK button should appear on the left andCancel on the right.

• boolis_scancode_unicode(int code)const

Returnstrue if the input scancode corresponds to a Unicode character.

• boolis_stdout_verbose()const

Returnstrue if the engine was executed with-v (verbose stdout).

• boolis_userfs_persistent()const

Iftrue, theuser:// 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.

• boolis_window_always_on_top()const

Returnstrue if the window should always be on top of other windows.

• boolis_window_focused()const

Returnstrue if the window is currently focused.

Note: Only implemented on desktop platforms. On other platforms, it will always returntrue.

• intkeyboard_get_current_layout()const

Returns active keyboard layout index.

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

• intkeyboard_get_layout_count()const

Returns the number of keyboard layouts.

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

• Stringkeyboard_get_layout_language(int index)const

Returns the ISO-639/BCP-47 language code of the keyboard layout at positionindex.

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

• Stringkeyboard_get_layout_name(int index)const

Returns the localized name of the keyboard layout at positionindex.

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

• voidkeyboard_set_current_layout(int index)

Sets active keyboard layout.

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

• Errorkill(int pid)

Kill (terminate) the process identified by the given process ID (pid), e.g. the one returned byexecute in non-blocking mode.

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

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

• voidmove_window_to_foreground()

Moves the window to the front.

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

• boolnative_video_is_playing()

Returnstrue if native video is playing.

Note: This method is only implemented on iOS.

• voidnative_video_pause()

Pauses native video playback.

Note: This method is only implemented on iOS.

• Errornative_video_play(String path,float volume,String audio_track,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 iOS.

• voidnative_video_stop()

Stops native video playback.

Note: This method is implemented on iOS.

• voidnative_video_unpause()

Resumes native video playback.

Note: This method is implemented on iOS.

• voidopen_midi_inputs()

Initialises the singleton for the system MIDI driver.

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

• voidprint_all_resources(String tofile="")

Shows all resources in the game. Optionally, the list can be written to a file by specifying a file path intofile.

• voidprint_all_textures_by_size()

Shows the list of loaded textures sorted by size in memory.

• voidprint_resources_by_type(PoolStringArray types)

Shows the number of resources loaded by the game of the given types.

• voidprint_resources_in_use(bool short=false)

Shows all resources currently used by the game.

• voidrequest_attention()

Request the user attention to the window. It'll flash the taskbar button on Windows or bounce the dock icon on OSX.

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

• boolrequest_permission(String name)

At the moment this function is only used byAudioDriverOpenSL to request permission forRECORD_AUDIO on Android.

• boolrequest_permissions()

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

Note: This method is implemented on Android.

• boolset_environment(String variable,String value)const

Sets the value of the environment variablevariable tovalue. The environment variable will be set for the Godot process and any process executed withexecute after runningset_environment. The environment variable willnot persist to processes run after the Godot process was terminated.

Note: Double-check the casing ofvariable. Environment variable names are case-sensitive on all platforms except Windows.

• voidset_icon(Image icon)

Sets the game's icon using anImage resource.

The same image is used for window caption, taskbar/dock and window selection dialog. Image is scaled as needed.

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

• voidset_ime_active(bool active)

Sets whether IME input mode should be enabled.

If active IME handles key events before the application and creates an composition string and suggestion list.

Application can retrieve the composition status by usingget_ime_selection andget_ime_text functions.

Completed composition string is committed when input is finished.

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

• voidset_ime_position(Vector2 position)

Sets position of IME suggestion list popup (in window coordinates).

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

• voidset_native_icon(String filename)

Sets the game's icon using a multi-size platform-specific icon file (*.ico on Windows and*.icns on macOS).

Appropriate size sub-icons are used for window caption, taskbar/dock and window selection dialog.

Note: This method is implemented on macOS and Windows.

• Errorset_thread_name(String name)

Sets the name of the current thread.

• voidset_use_file_access_save_and_swap(bool enabled)

Enables backup saves ifenabled istrue.

• voidset_window_always_on_top(bool enabled)

Sets whether the window should always be on top.

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

• voidset_window_mouse_passthrough(PoolVector2Array region)

Sets a polygonal region of the window which accepts mouse events. Mouse events outside the region will be passed through.

Passing an empty array will disable passthrough support (all mouse events will be intercepted by the window, which is the default behavior).

# Set region, using Path2D node.OS.set_window_mouse_passthrough($Path2D.curve.get_baked_points())# Set region, using Polygon2D node.OS.set_window_mouse_passthrough($Polygon2D.polygon)# Reset region to default.OS.set_window_mouse_passthrough([])

Note: On Windows, the portion of a window that lies outside the region is not drawn, while on Linux and macOS it is.

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

• voidset_window_title(String title)

Sets the window title to the specified string.

Note: This should be used sporadically. Don't set this every frame, as that will negatively affect performance on some window managers.

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

• Errorshell_open(String uri)

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

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

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

• OS.shell_open("mailto:example@example.com") opens the default email client with the "To" field set toexample@example.com. SeeCustomizing ``mailto:` Links <https://blog.escapecreative.com/customizing-mailto-links/>`__ for a list of fields that can be added.

UseProjectSettings.globalize_path to convert ares:// oruser:// path into a system path for use with this method.

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

• voidshow_virtual_keyboard(String existing_text="",bool multiline=false)

Shows the virtual keyboard if the platform has one.

Theexisting_text parameter is useful for implementing your ownLineEdit orTextEdit, as it tells the virtual keyboard what text has already been typed (the virtual keyboard uses it for auto-correct and predictions).

Themultiline parameter needs to be set totrue to be able to enter multiple lines of text, as inTextEdit.

Note: This method is implemented on Android, iOS and UWP.