Description

TheOS class wraps the most common functionalities for communicating with the host operating system, such as the video driver, delays, environment variables, execution of binaries, command line, etc.

Note: In Godot 4,OS functions related to window management, clipboard, and TTS were moved to theDisplayServer singleton (and theWindow class). Functions related to time were removed and are only available in theTime class.

Tutorials

• Operating System Testing Demo

Properties

Methods

Enumerations

enumRenderingDriver:🔗

RenderingDriverRENDERING_DRIVER_VULKAN =0

The Vulkan rendering driver. It requires Vulkan 1.0 support and automatically uses features from Vulkan 1.1 and 1.2 if available.

RenderingDriverRENDERING_DRIVER_OPENGL3 =1

The OpenGL 3 rendering driver. It uses OpenGL 3.3 Core Profile on desktop platforms, OpenGL ES 3.0 on mobile devices, and WebGL 2.0 on Web.

RenderingDriverRENDERING_DRIVER_D3D12 =2

The Direct3D 12 rendering driver.

RenderingDriverRENDERING_DRIVER_METAL =3

The Metal rendering driver.

enumSystemDir:🔗

SystemDirSYSTEM_DIR_DESKTOP =0

Refers to the Desktop directory path.

SystemDirSYSTEM_DIR_DCIM =1

Refers to the DCIM (Digital Camera Images) directory path.

SystemDirSYSTEM_DIR_DOCUMENTS =2

Refers to the Documents directory path.

SystemDirSYSTEM_DIR_DOWNLOADS =3

Refers to the Downloads directory path.

SystemDirSYSTEM_DIR_MOVIES =4

Refers to the Movies (or Videos) directory path.

SystemDirSYSTEM_DIR_MUSIC =5

Refers to the Music directory path.

SystemDirSYSTEM_DIR_PICTURES =6

Refers to the Pictures directory path.

SystemDirSYSTEM_DIR_RINGTONES =7

Refers to the Ringtones directory path.

enumStdHandleType:🔗

StdHandleTypeSTD_HANDLE_INVALID =0

Standard I/O device is invalid. No data can be received from or sent to these standard I/O devices.

StdHandleTypeSTD_HANDLE_CONSOLE =1

Standard I/O device is a console. This typically occurs when Godot is run from a terminal with no redirection. This is also used for all standard I/O devices when running Godot from the editor, at least on desktop platforms.

StdHandleTypeSTD_HANDLE_FILE =2

Standard I/O device is a regular file. This typically occurs with redirection from a terminal, e.g.godot>stdout.txt,godot<stdin.txt orgodot>stdout_stderr.txt2>&1.

StdHandleTypeSTD_HANDLE_PIPE =3

Standard I/O device is a FIFO/pipe. This typically occurs with pipe usage from a terminal, e.g.echo"Hello"|godot.

StdHandleTypeSTD_HANDLE_UNKNOWN =4

Standard I/O device type is unknown.

Property Descriptions

booldelta_smoothing =true🔗

• voidset_delta_smoothing(value:bool)

• boolis_delta_smoothing_enabled()

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

Note: On start-up, this is the same asProjectSettings.application/run/delta_smoothing.

boollow_processor_usage_mode =false🔗

• voidset_low_processor_usage_mode(value:bool)

• boolis_in_low_processor_usage_mode()

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

Note: On start-up, this is the same asProjectSettings.application/run/low_processor_mode.

intlow_processor_usage_mode_sleep_usec =6900🔗

• voidset_low_processor_usage_mode_sleep_usec(value:int)

• intget_low_processor_usage_mode_sleep_usec()

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

Note: On start-up, this is the same asProjectSettings.application/run/low_processor_mode_sleep_usec.

Method Descriptions

voidadd_logger(logger:Logger)🔗

Add a custom logger to intercept the internal message stream.

voidalert(text:String, title:String = "Alert!")🔗

Displays a modal dialog box using the host platform's implementation. The engine execution is blocked until the dialog is closed.

voidclose_midi_inputs()🔗

Shuts down the system MIDI driver. Godot will no longer receiveInputEventMIDI. See alsoopen_midi_inputs() andget_connected_midi_inputs().

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

voidcrash(message:String)🔗

Crashes the engine (or the editor if called within a@tool script). See alsokill().

Note: This method shouldonly be used for testing the system's crash handler, not for any other purpose. For general error reporting, use (in order of preference)@GDScript.assert(),@GlobalScope.push_error(), oralert().

intcreate_instance(arguments:PackedStringArray)🔗

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

If the process is successfully created, this method returns the new process' ID, which you can use to monitor the process (and potentially terminate it withkill()). If the process cannot be created, this method returns-1.

Seecreate_process() if you wish to run a different process.

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

intcreate_process(path:String, arguments:PackedStringArray, open_console:bool = false)🔗

Creates a new process that runs independently of Godot. It will not terminate when Godot terminates. The path specified inpath must exist and be an executable file or macOS.app bundle. The path is resolved based on the current platform. Thearguments are used in the given order and separated by a space.

On Windows, ifopen_console istrue and the process is a console app, a new terminal window will be opened.

If the process is successfully created, this method returns its process ID, which you can use to monitor the process (and potentially terminate it withkill()). Otherwise, this method returns-1.

Example: Run another instance of the project:

varpid=OS.create_process(OS.get_executable_path(),[])

varpid=OS.CreateProcess(OS.GetExecutablePath(),[]);

Seeexecute() if you wish to run an external command and retrieve the results.

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

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

voiddelay_msec(msec:int)const🔗

Delays execution of the current thread bymsec milliseconds.msec must be greater than or equal to0. Otherwise,delay_msec() does nothing and prints an error message.

Note:delay_msec() is ablocking way to delay code execution. To delay code execution in a non-blocking way, you may useSceneTree.create_timer(). Awaiting withSceneTreeTimer delays the execution of code placed below theawait 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(usec:int)const🔗

Delays execution of the current thread byusec microseconds.usec must be greater than or equal to0. Otherwise,delay_usec() does nothing and prints an error message.

Note:delay_usec() is ablocking way to delay code execution. To delay code execution in a non-blocking way, you may useSceneTree.create_timer(). Awaiting with aSceneTreeTimer delays the execution of code placed below theawait 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).

intexecute(path:String, arguments:PackedStringArray, output:Array = [], read_stderr:bool = false, open_console:bool = false)🔗

Executes the given process in ablocking way. The file specified inpath must exist and be executable. The system path resolution will be used. Thearguments are used in the given order, separated by spaces, and wrapped in quotes.

If anoutput array is provided, the complete shell output of the process is appended tooutput as a singleString element. Ifread_stderr istrue, the output to the standard error stream is also appended to the array.

On Windows, ifopen_console istrue and the process is a console app, a new terminal window is opened.

This method returns the exit code of the command, or-1 if the process fails to execute.

Note: The main thread will be blocked until the executed command terminates. UseThread to create a separate thread that will not block the main thread, or usecreate_process() to create a completely independent process.

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

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

Godot.Collections.Arrayoutput=[];intexitCode=OS.Execute("ls",["-l","/tmp"],output);

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

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

Godot.Collections.Arrayoutput=[];OS.Execute("CMD.exe",["/C","cd %TEMP% && dir"],output);

Note: This method is implemented on Android, 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.

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

Note: On Android, system commands such asdumpsys can only be run on a rooted device.

Dictionaryexecute_with_pipe(path:String, arguments:PackedStringArray, blocking:bool = true)🔗

Creates a new process that runs independently of Godot with redirected IO. It will not terminate when Godot terminates. The path specified inpath must exist and be an executable file or macOS.app bundle. The path is resolved based on the current platform. Thearguments are used in the given order and separated by a space.

Ifblocking isfalse, created pipes work in non-blocking mode, i.e. read and write operations will return immediately. UseFileAccess.get_error() to check if the last read/write operation was successful.

If the process cannot be created, this method returns an emptyDictionary. Otherwise, this method returns aDictionary with the following keys:

• "stdio" -FileAccess to access the process stdin and stdout pipes (read/write).

• "stderr" -FileAccess to access the process stderr pipe (read only).

• "pid" - Process ID as anint, which you can use to monitor the process (and potentially terminate it withkill()).

Note: This method is implemented on Android, 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.

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

Keyfind_keycode_from_string(string:String)const🔗

Finds the keycode for the given string. The returned values are equivalent to theKey constants.

print(OS.find_keycode_from_string("C"))# Prints 67 (KEY_C)print(OS.find_keycode_from_string("Escape"))# Prints 4194305 (KEY_ESCAPE)print(OS.find_keycode_from_string("Shift+Tab"))# Prints 37748738 (KEY_MASK_SHIFT | KEY_TAB)print(OS.find_keycode_from_string("Unknown"))# Prints 0 (KEY_NONE)

GD.Print(OS.FindKeycodeFromString("C"));// Prints C (Key.C)GD.Print(OS.FindKeycodeFromString("Escape"));// Prints Escape (Key.Escape)GD.Print(OS.FindKeycodeFromString("Shift+Tab"));// Prints 37748738 (KeyModifierMask.MaskShift | Key.Tab)GD.Print(OS.FindKeycodeFromString("Unknown"));// Prints None (Key.None)

See alsoget_keycode_string().

Stringget_cache_dir()const🔗

Returns theglobal cache data directory according to the operating system's standards.

On the Linux/BSD platform, 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.

PackedStringArrayget_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/run/main_run_args to define command-line arguments to be passed by the editor when running the project.

Example: Parse command-line arguments into aDictionary using the--key=value form for arguments:

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

vararguments=newDictionary<string,string>();foreach(varargumentinOS.GetCmdlineArgs()){if(argument.Contains('=')){string[]keyValue=argument.Split("=");arguments[keyValue[0].TrimPrefix("--")]=keyValue[1];}else{// Options without an argument will be present in the dictionary,// with the value set to an empty string.arguments[argument.TrimPrefix("--")]="";}}

Note: Passing custom user arguments directly is not recommended, as the engine may discard or modify them. Instead, pass the standard UNIX double dash (--) and then the custom arguments, which the engine will ignore by design. These can be read viaget_cmdline_user_args().

PackedStringArrayget_cmdline_user_args()🔗

Returns the command-line user arguments passed to the engine. User arguments are ignored by the engine and reserved for the user. They are passed after the double dash-- argument.++ may be used when-- is intercepted by another program (such asstartx).

# Godot has been executed with the following command:# godot --fullscreen -- --level=2 --hardcoreOS.get_cmdline_args()# Returns ["--fullscreen", "--level=2", "--hardcore"]OS.get_cmdline_user_args()# Returns ["--level=2", "--hardcore"]

To get all passed arguments, useget_cmdline_args().

Stringget_config_dir()const🔗

Returns theglobal user configuration directory according to the operating system's standards.

On the Linux/BSD platform, 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.

PackedStringArrayget_connected_midi_inputs()🔗

Returns an array of connected MIDI device names, if they exist. Returns an empty array if the system MIDI driver has not previously been initialized withopen_midi_inputs(). See alsoclose_midi_inputs().

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

Note: On the Web platform, Web MIDI needs to be supported by the browser.For the time being, it is currently supported by all major browsers, except Safari.

Note: On the Web platform, using MIDI input requires a browser permission to be granted first. This permission request is performed when callingopen_midi_inputs(). The browser will refrain from processing MIDI input until the user accepts the permission request.

Stringget_data_dir()const🔗

Returns theglobal user data directory according to the operating system's standards.

On the Linux/BSD platform, 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.

Stringget_distribution_name()const🔗

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

Returns the same value asget_name() for stock Android ROMs, but attempts to return the custom ROM name for popular Android derivatives such as "LineageOS".

Returns the same value asget_name() for other platforms.

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

PackedByteArrayget_entropy(size:int)🔗

Generates aPackedByteArray of cryptographically secure random bytes with givensize.

Note: Generating large quantities of bytes using this method can result in locking and entropy of lower quality on most platforms. UsingCrypto.generate_random_bytes() is preferred in most cases.

Stringget_environment(variable:String)const🔗

Returns the value of the given environment variable, or an empty string ifvariable doesn't exist.

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

Note: On macOS, applications do not have access to shell environment variables.

Stringget_executable_path()const🔗

Returns the file path to the current engine executable.

Note: On macOS, if you want to launch another instance of Godot, always usecreate_instance() instead of relying on the executable path.

PackedStringArrayget_granted_permissions()const🔗

On Android devices: Returns the list of dangerous permissions that have been granted.

On macOS: Returns the list of granted permissions and user selected folders accessible to the application (sandboxed applications only). Use the native file dialog to request folder access permission.

On iOS, visionOS: Returns the list of granted permissions.

Stringget_keycode_string(code:Key)const🔗

Returns the given keycode as aString.

print(OS.get_keycode_string(KEY_C))# Prints "C"print(OS.get_keycode_string(KEY_ESCAPE))# Prints "Escape"print(OS.get_keycode_string(KEY_MASK_SHIFT|KEY_TAB))# Prints "Shift+Tab"

GD.Print(OS.GetKeycodeString(Key.C));// Prints "C"GD.Print(OS.GetKeycodeString(Key.Escape));// Prints "Escape"GD.Print(OS.GetKeycodeString((Key)KeyModifierMask.MaskShift|Key.Tab));// Prints "Shift+Tab"

See alsofind_keycode_from_string(),InputEventKey.keycode, andInputEventKey.get_keycode_with_modifiers().

Stringget_locale()const🔗

Returns the host OS locale as aString of the formlanguage_Script_COUNTRY_VARIANT@extra. Every substring afterlanguage is optional and may not exist.

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

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

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

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

• extra - semicolon separated list of additional key words. This may include currency, calendar, sort order and numbering system information.

If you want only the language code and not the fully specified locale from the OS, you can useget_locale_language().

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.

intget_main_thread_id()const🔗

Returns the ID of the main thread. Seeget_thread_caller_id().

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

Dictionaryget_memory_info()const🔗

Returns aDictionary containing information about the current memory with the following entries:

• "physical" - total amount of usable physical memory in bytes. This value can be slightly less than the actual physical memory amount, since it does not include memory reserved by the kernel and devices.

• "free" - amount of physical memory, that can be immediately allocated without disk access or other costly operations, in bytes. The process might be able to allocate more physical memory, but this action will require moving inactive pages to disk, which can be expensive.

• "available" - amount of memory that can be allocated without extending the swap file(s), in bytes. This value includes both physical memory and swap.

• "stack" - size of the current thread stack in bytes.

Note: Each entry's value may be-1 if it is unknown.

Stringget_model_name()const🔗

Returns the model name of the current device.

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

Stringget_name()const🔗

Returns the name of the host platform.

• On Windows, this is"Windows".

• On macOS, this is"macOS".

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

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

• On Android, this is"Android".

• On iOS, this is"iOS".

• On Web, this is"Web".

Note: Custom builds of the engine may support additional platforms, such as consoles, possibly returning other names.

matchOS.get_name():"Windows":print("Welcome to Windows!")"macOS":print("Welcome to macOS!")"Linux","FreeBSD","NetBSD","OpenBSD","BSD":print("Welcome to Linux/BSD!")"Android":print("Welcome to Android!")"iOS":print("Welcome to iOS!")"Web":print("Welcome to the Web!")

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

Note: On Web platforms, it is still possible to determine the host platform's OS with feature tags. Seehas_feature().

intget_process_exit_code(pid:int)const🔗

Returns the exit code of a spawned process once it has finished running (seeis_process_running()).

Returns-1 if thepid is not a PID of a spawned child process, the process is still running, or the method is not implemented for the current platform.

Note: Returns-1 if thepid is a macOS bundled app process.

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

intget_process_id()const🔗

Returns the number used by the host machine to uniquely identify this application.

Note: On Web, this method always returns0.

intget_processor_count()const🔗

Returns the number oflogical CPU cores available on the host machine. On CPUs with HyperThreading enabled, this number will be greater than the number ofphysical CPU cores.

Stringget_processor_name()const🔗

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

Note: This method is only implemented on Windows, macOS, Linux and iOS. On Android and Web,get_processor_name() returns an empty string.

PackedStringArrayget_restart_on_exit_arguments()const🔗

Returns the list of command line arguments that will be used when the project automatically restarts usingset_restart_on_exit(). See alsois_restart_on_exit_set().

intget_static_memory_peak_usage()const🔗

Returns the maximum amount of static memory used. Only works in debug builds.

intget_static_memory_usage()const🔗

Returns the amount of static memory being used by the program in bytes. Only works in debug builds.

StdHandleTypeget_stderr_type()const🔗

Returns the type of the standard error device.

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

StdHandleTypeget_stdin_type()const🔗

Returns the type of the standard input device.

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

Note: On exported Windows builds, run the console wrapper executable to access the standard input. If you need a single executable with full console support, use a custom build compiled with thewindows_subsystem=console flag.

StdHandleTypeget_stdout_type()const🔗

Returns the type of the standard output device.

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

Stringget_system_ca_certificates()🔗

Returns the list of certification authorities trusted by the operating system as a string of concatenated certificates in PEM format.

Stringget_system_dir(dir:SystemDir, shared_storage:bool = true)const🔗

Returns the path to commonly used folders across different platforms, as defined bydir. See theSystemDir constants for available locations.

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, ifshared_storage istrue. Shared directories have additional restrictions on Android.

Stringget_system_font_path(font_name:String, weight:int = 400, stretch:int = 100, italic:bool = false)const🔗

Returns the path to the system font file withfont_name and style. Returns an empty string if no matching fonts found.

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

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

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

PackedStringArrayget_system_font_path_for_text(font_name:String, text:String, locale:String = "", script:String = "", weight:int = 400, stretch:int = 100, italic:bool = false)const🔗

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

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

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

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

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

PackedStringArrayget_system_fonts()const🔗

Returns the list of font family names available.

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

Stringget_temp_dir()const🔗

Returns theglobal temporary data directory according to the operating system's standards.

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.

Stringget_unique_id()const🔗

Returns a string that is unique to the device.

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

Note: On Web, returns an empty string and generates an error, as this method cannot be implemented for security reasons.

Stringget_user_data_dir()const🔗

Returns the absolute directory path where user data is written (theuser:// directory in Godot). The path depends on the project name andProjectSettings.application/config/use_custom_user_dir.

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

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

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

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

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

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

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

Stringget_version()const🔗

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

• For Windows, the major and minor version are returned, as well as the build number. For example, the returned string may look like10.0.9926 for a build of Windows 10.

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

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

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

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

Stringget_version_alias()const🔗

Returns the branded version used in marketing, followed by the build number (on Windows), the version number (on macOS), or the SDK version and incremental build number (on Android). Examples include11(build22000),Sequoia(15.0.0), and15(SDK35buildabc528-11988f).

This value can then be appended toget_name() to get a full, human-readable operating system name and version combination for the operating system. Windows feature updates such as 24H2 are not contained in the resulting string, but Windows Server is recognized as such (e.g.2025(build26100) for Windows Server 2025).

Note: This method is only supported on Windows, macOS, and Android. On other operating systems, it returns the same value asget_version().

PackedStringArrayget_video_adapter_driver_info()const🔗

Returns the video adapter driver name and version for the user's currently active graphics card, as aPackedStringArray. See alsoRenderingServer.get_video_adapter_api_version().

The first element holds the driver name, such asnvidia,amdgpu, etc.

The second element holds the driver version. For example, on thenvidia driver on a Linux/BSD platform, the version is in the format510.85.02. For Windows, the driver's format is31.0.15.1659.

Note: This method is only supported on Linux/BSD and Windows when not running in headless mode. On other platforms, it returns an empty array.

Note: This method will run slowly the first time it is called in a session; it can take several seconds depending on the operating system and hardware. It is blocking if called on the main thread, so it's recommended to call it on a separate thread usingThread. This allows the engine to keep running while the information is being retrieved. However,get_video_adapter_driver_info() isnot thread-safe, so it should not be called from multiple threads at the same time.

varthread=Thread.new()func_ready():thread.start(func():vardriver_info=OS.get_video_adapter_driver_info()ifnotdriver_info.is_empty():print("Driver:%s%s"%[driver_info[0],driver_info[1]])else:print("Driver: (unknown)"))func_exit_tree():thread.wait_to_finish()

boolhas_environment(variable:String)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(tag_name:String)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.

Note: On the Web platform, one of the following additional tags is defined to indicate the host platform:web_android,web_ios,web_linuxbsd,web_macos, orweb_windows.

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.

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

boolis_keycode_unicode(code:int)const🔗

Returnstrue if the input keycode corresponds to a Unicode character. For a list of codes, see theKey constants.

print(OS.is_keycode_unicode(KEY_G))# Prints trueprint(OS.is_keycode_unicode(KEY_KP_4))# Prints trueprint(OS.is_keycode_unicode(KEY_TAB))# Prints falseprint(OS.is_keycode_unicode(KEY_ESCAPE))# Prints false

GD.Print(OS.IsKeycodeUnicode((long)Key.G));// Prints TrueGD.Print(OS.IsKeycodeUnicode((long)Key.Kp4));// Prints TrueGD.Print(OS.IsKeycodeUnicode((long)Key.Tab));// Prints FalseGD.Print(OS.IsKeycodeUnicode((long)Key.Escape));// Prints False

boolis_process_running(pid:int)const🔗

Returnstrue if the child process ID (pid) is still running orfalse if it has terminated.pid must be a valid ID generated fromcreate_process().

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

boolis_restart_on_exit_set()const🔗

Returnstrue if the project will automatically restart when it exits for any reason,false otherwise. See alsoset_restart_on_exit() andget_restart_on_exit_arguments().

boolis_sandboxed()const🔗

Returnstrue if the application is running in the sandbox.

Note: This method is only implemented on macOS and Linux.

boolis_stdout_verbose()const🔗

Returnstrue if the engine was executed with the--verbose or-v command line argument, or ifProjectSettings.debug/settings/stdout/verbose_stdout istrue. See also@GlobalScope.print_verbose().

boolis_userfs_persistent()const🔗

Returnstrue if theuser:// file system is persistent, that is, its state is the same after a player quits and starts the game again. Relevant to the Web platform, where this persistence may be unavailable.

Errorkill(pid:int)🔗

Kill (terminate) the process identified by the given process ID (pid), such as the ID returned byexecute() in non-blocking mode. See alsocrash().

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

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

Errormove_to_trash(path:String)const🔗

Moves the file or directory at the givenpath to the system's recycle bin. See alsoDirAccess.remove().

The method takes only global paths, so you may need to useProjectSettings.globalize_path(). Do not use it for files inres:// as it will not work in exported projects.

Returns@GlobalScope.FAILED if the file or directory cannot be found, or the system does not support this method.

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

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

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

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

voidopen_midi_inputs()🔗

Initializes the singleton for the system MIDI driver, allowing Godot to receiveInputEventMIDI. See alsoget_connected_midi_inputs() andclose_midi_inputs().

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

Note: On the Web platform, Web MIDI needs to be supported by the browser.For the time being, it is currently supported by all major browsers, except Safari.

Note: On the Web platform, using MIDI input requires a browser permission to be granted first. This permission request is performed when callingopen_midi_inputs(). The browser will refrain from processing MIDI input until the user accepts the permission request.

Erroropen_with_program(program_path:String, paths:PackedStringArray)🔗

Opens one or more files/directories with the specified application. Theprogram_path specifies the path to the application to use for opening the files, andpaths contains an array of file/directory paths to open.

Note: This method is mostly only relevant for macOS, where opening files usingcreate_process() might fail. On other platforms, this falls back to usingcreate_process().

Note: On macOS,program_path should ideally be the path to a.app bundle.

PackedByteArrayread_buffer_from_stdin(buffer_size:int = 1024)🔗

Reads a user input as raw data from the standard input. This operation can beblocking, which causes the window to freeze ifread_buffer_from_stdin() is called on the main thread.

• If standard input is console, this method will block until the program receives a line break in standard input (usually by the user pressingEnter).

• If standard input is pipe, this method will block until a specific amount of data is read or pipe is closed.

• If standard input is a file, this method will read a specific amount of data (or less if end-of-file is reached) and return immediately.

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

Note: On exported Windows builds, run the console wrapper executable to access the terminal. If standard input is console, calling this method without console wrapped will freeze permanently. If standard input is pipe or file, it can be used without console wrapper. If you need a single executable with full console support, use a custom build compiled with thewindows_subsystem=console flag.

Stringread_string_from_stdin(buffer_size:int = 1024)🔗

Reads a user input as a UTF-8 encoded string from the standard input. This operation can beblocking, which causes the window to freeze ifread_string_from_stdin() is called on the main thread.

• If standard input is console, this method will block until the program receives a line break in standard input (usually by the user pressingEnter).

• If standard input is pipe, this method will block until a specific amount of data is read or pipe is closed.

• If standard input is a file, this method will read a specific amount of data (or less if end-of-file is reached) and return immediately.

Note: This method automatically replaces\r\n line breaks with\n and removes them from the end of the string. Useread_buffer_from_stdin() to read the unprocessed data.

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

Note: On exported Windows builds, run the console wrapper executable to access the terminal. If standard input is console, calling this method without console wrapped will freeze permanently. If standard input is pipe or file, it can be used without console wrapper. If you need a single executable with full console support, use a custom build compiled with thewindows_subsystem=console flag.

voidremove_logger(logger:Logger)🔗

Remove a custom logger added byadd_logger().

boolrequest_permission(name:String)🔗

Requests permission from the OS for the givenname. Returnstrue if the permission has already been granted. See alsoMainLoop.on_request_permissions_result.

Thename must be the full permission name. For example:

• OS.request_permission("android.permission.READ_EXTERNAL_STORAGE")

• OS.request_permission("android.permission.POST_NOTIFICATIONS")

• OS.request_permission("macos.permission.RECORD_SCREEN")

• OS.request_permission("appleembedded.permission.AUDIO_RECORD")

Note: On Android, permission must be checked during export.

Note: This method is implemented on Android, macOS, and visionOS platforms.

boolrequest_permissions()🔗

Requestsdangerous permissions from the OS. Returnstrue if permissions have already been granted. See alsoMainLoop.on_request_permissions_result.

Note: Permissions must be checked during export.

Note: This method is only implemented on Android. Normal permissions are automatically granted at install time in Android applications.

voidrevoke_granted_permissions()🔗

On macOS (sandboxed applications only), this function clears list of user selected folders accessible to the application.

voidset_environment(variable:String, value:String)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: Environment variable names are case-sensitive on all platforms except Windows. Thevariable name cannot be empty or include the= character. On Windows, there is a 32767 characters limit for the combined length ofvariable,value, and the= and null terminator characters that will be registered in the environment block.

voidset_restart_on_exit(restart:bool, arguments:PackedStringArray = PackedStringArray())🔗

Ifrestart istrue, restarts the project automatically when it is exited withSceneTree.quit() orNode.NOTIFICATION_WM_CLOSE_REQUEST. Command-linearguments can be supplied. To restart the project with the same command line arguments as originally used to run the project, passget_cmdline_args() as the value forarguments.

This method can be used to apply setting changes that require a restart. See alsois_restart_on_exit_set() andget_restart_on_exit_arguments().

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

Note: If the project process crashes or iskilled by the user (by sendingSIGKILL instead of the usualSIGTERM), the project won't restart automatically.

Errorset_thread_name(name:String)🔗

Assigns the given name to the current thread. Returns@GlobalScope.ERR_UNAVAILABLE if unavailable on the current platform.

voidset_use_file_access_save_and_swap(enabled:bool)🔗

Ifenabled istrue, when opening a file for writing, a temporary file is used in its place. When closed, it is automatically applied to the target file.

This can useful when files may be opened by other applications, such as antiviruses, text editors, or even the Godot editor itself.

Errorshell_open(uri:String)🔗

Requests the OS to open a resource identified byuri 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("C:/Users/name/Downloads") also works on Windows and 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. SeeRFC 2368 - The [code]mailto[/code] URL scheme for a list of fields that can be added.

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

Note: UseString.uri_encode() to encode characters within URLs in a URL-safe, portable way. This is especially required for line breaks. Otherwise,shell_open() may not work correctly in a project exported to the Web platform.

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

Errorshell_show_in_file_manager(file_or_dir_path:String, open_folder:bool = true)🔗

Requests the OS to open the file manager, navigate to the givenfile_or_dir_path and select the target file or folder.

Ifopen_folder istrue andfile_or_dir_path is a valid directory path, the OS will open the file manager and navigate to the target folder without selecting anything.

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

Note: This method is currently only implemented on Windows and macOS. On other platforms, it will fallback toshell_open() with a directory path offile_or_dir_path prefixed withfile://.

voidunset_environment(variable:String)const🔗

Removes the given environment variable from the current environment, if it exists. Thevariable name cannot be empty or include the= character. The environment variable will be removed for the Godot process and any process executed withexecute() after runningunset_environment(). The removal of the environment variable willnot persist to processes run after the Godot process was terminated.

Note: Environment variable names are case-sensitive on all platforms except Windows.