Operating System functions.
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.
Displays a modal dialog box utilizing the host OS.
Returns [code]true[/code] if the host OS allows drawing.
Returns [code]true[/code] if the current host platform is using multiple threads.
Centers the window on the screen if in windowed mode.
Delay execution of the current thread by given milliseconds.
Delay execution of the current thread by given microseconds.
Dumps the memory allocation ringlist to a file (only works in debug). Entry format per line: "Address - Size - Description".
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.
Execute the file at the given path with the arguments passed as an array of strings. Platform path resolution will take place. The resolved file must exist and be executable. The arguments are used in the given order and separated by a space, so [code]OS.execute('ping', ['-c', '3', 'godotengine.org'])[/code] will resolve to [code]ping -c 3 godotengine.org[/code] in the system's shell. This method has slightly different behaviour based on whether the [code]blocking[/code] mode is enabled. When [code]blocking[/code] is enabled, the Godot thread will pause its execution while waiting for the process to terminate. The shell output of the process will be written to the [code]output[/code] array as a single string. When the process terminates, the Godot thread will resume execution. When [code]blocking[/code] is disabled, the Godot thread will continue while the new process runs. It is not possible to retrieve the shell output in non-blocking mode, so [code]output[/code] will be empty. The return value also depends on the blocking mode. When blocking, the method will return -2 (no process ID information is available in blocking mode). When non-blocking, the method returns a process ID, which you can use to monitor the process (and potentially terminate it with [method kill]). If the process forking (non-blocking) or opening (blocking) fails, the method will return -1. Example of blocking mode and retrieving the shell output: [codeblock] var output = [] OS.execute('ls', ['-l', '/tmp'], true, output) [/codeblock] Example of non-blocking mode, running another instance of the project and storing its process ID: [codeblock] var pid = OS.execute(OS.get_executable_path(), [], false) [/codeblock] If you wish to access a shell built-in or perform a composite command, a platform-specific shell can be invoked. For example: [codeblock] OS.execute('CMD.exe', ['/C', 'cd %TEMP% && dir'], true, output) [/codeblock]
Returns the scancode of the given string (e.g. "Escape")
Returns the total number of available audio drivers.
Returns the audio driver name for the given index.
Returns the command line arguments passed to the engine.
Returns current date as a dictionary of keys: year, month, day, weekday, dst (daylight savings time).
Returns current datetime as a dictionary of keys: year, month, day, weekday, dst (daylight savings time), hour, minute, second.
Get a dictionary of time values when given epoch time. Dictionary Time values will be a union of values from [method get_time] and [method get_date] dictionaries (with the exception of dst = day light standard time, as it cannot be determined from epoch).
Returns the total amount of dynamic memory used (only works in debug).
Returns an environment variable.
Returns the path to the current engine executable.
Returns the current latin keyboard variant as a String. Possible return values are: "QWERTY", "AZERTY", "QZERTY", "DVORAK", "NEO", "COLEMAK" or "ERROR".
Returns the host OS locale.
Returns the model name of the current device.
Returns the name of the host OS. Possible values are: "Android", "Haiku", "iOS", "HTML5", "OSX", "Server", "Windows", "UWP", "X11".
Returns the amount of battery left in the device as a percentage.
Returns the time in seconds before the device runs out of battery.
Returns the current state of the device regarding battery and power. See [code]POWERSTATE_*[/code] constants.
Returns the game process ID
Returns the number of cores available in the host machine.
Returns the window size including decorations like window borders.
Returns the given scancode as a string (e.g. Return values: "Escape", "Shift+Escape").
Returns the number of displays attached to the host machine.
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
Returns the position of the specified screen by index. If no screen index is provided, the current screen will be used.
Returns the dimensions in pixels of the specified screen.
Returns the max amount of static memory used (only works in debug).
Returns the amount of static memory being used by the program in bytes.
Returns the actual path to commonly used folders across different platforms. Available locations are specified in [OS.SystemDir].
Returns the epoch time of the operating system in seconds.
Returns the amount of time passed in milliseconds since the engine started.
Returns the amount of time passed in microseconds since the engine started.
Returns current time as a dictionary of keys: hour, minute, second.
Returns the current time zone as a dictionary with the keys: bias and name.
Returns a string that is unique to the device. Returns empty string on HTML5 and UWP which are not supported yet.
Returns the current unix epoch timestamp.
Get an epoch time value from a dictionary of time values. [code]datetime[/code] must be populated with the following keys: year, month, day, hour, minute, second. You can pass the output from [method get_datetime_from_unix_time] directly into this function. Daylight savings time (dst), if present, is ignored.
Returns the absolute directory path where user data is written ([code]user://[/code]). On Linux, this is [code]~/.local/share/godot/app_userdata/[project_name][/code], or [code]~/.local/share/[custom_name][/code] if [code]use_custom_user_dir[/code] is set. On macOS, this is [code]~/Library/Application Support/Godot/app_userdata/[project_name][/code], or [code]~/Library/Application Support/[custom_name][/code] if [code]use_custom_user_dir[/code] is set. On Windows, this is [code]%APPDATA%/Godot/app_userdata/[project_name][/code], or [code]%APPDATA%/[custom_name][/code] if [code]use_custom_user_dir[/code] is set. If the project name is empty, [code]user://[/code] falls back to [code]res://[/code].
Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or it is currently hidden.
Returns [code]true[/code] if an environment variable exists.
Returns [code]true[/code] if the feature for the given feature tag is supported in the currently running instance, depending on platform, build etc. Can be used to check whether you're currently running a debug build, on a certain platform or arch, etc. See feature tags documentation.
Returns [code]true[/code] if the device has a touchscreen or emulates one.
Returns [code]true[/code] if the platform has a virtual keyboard, [code]false[/code] otherwise.
Hides the virtual keyboard if it is shown, does nothing otherwise.
Returns [code]true[/code] if the build is a debug build. Returns [code]true[/code] when running in the editor. Returns [code]false[/code] if the build is a release build.
Returns [code]true[/code] if the "Okay" button should appear on the left and "Cancel" on the right.
Returns [code]true[/code] if the input code has a unicode character.
Returns [code]true[/code] if the engine was executed with -v (verbose stdout).
If [code]true[/code], the [code]user://[/code] 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.
Returns [code]true[/code] if the window should always be on top of other windows.
Kill (terminate) the process identified by the given process ID ([code]pid[/code]), e.g. the one returned by [method execute] in non-blocking mode. Note that this method can also be used to kill processes that were not spawned by the game.
Returns [code]true[/code] if native video is playing.
Pauses native video playback.
Plays native video from the specified path, at the given volume and with audio and subtitle tracks.
Stops native video playback.
Resumes native video playback.
Shows all resources in the game. Optionally the list can be written to a file.
Shows the list of loaded textures sorted by size in memory.
Shows the number of resources loaded by the game of the given types.
Shows all resources currently used by the game.
Request the user attention to the window. It'll flash the taskbar button on Windows or bounce the dock icon on OSX.
Sets the game's icon.
Sets the name of the current thread.
Enables backup saves if [code]enabled[/code] is [code]true[/code].
Sets whether the window should always be on top.
Sets the window title to the specified string.
Requests the OS to open a resource with the most appropriate program. For example. [code]OS.shell_open("C:\\Users\name\Downloads")[/code] on Windows opens the file explorer at the downloads folders of the user. [code]OS.shell_open("http://godotengine.org")[/code] opens the default web browser on the official Godot website.
Shows the virtual keyboard if the platform has one. The [i]existing_text[/i] 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).
- The clipboard from the host OS. Might be unavailable on some platforms.
- The current screen index (starting from 0).
- The exit code passed to the OS when the main loop exits.
- If [code]true[/code] the engine tries to keep the screen on while the game is running. Useful on mobile.
- If [code]true[/code] the engine optimizes for low processor usage by only refreshing the screen if needed. Can improve battery consumption on mobile.
- The current screen orientation.
- If [code]true[/code] vertical synchronization (Vsync) is enabled.
- If [code]true[/code] removes the window frame.
- If [code]true[/code] the window is fullscreen.
- If [code]true[/code] the window is maximized.
- If [code]true[/code] the window is minimized.
- 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.
- If [code]true[/code], the window is resizable by the user.
- The size of the window (without counting window manager decorations).
Sunday.
Monday.
Tuesday.
Wednesday.
Thursday.
Friday.
Saturday.
January.
February.
March.
April.
May.
June.
July.
August.
September.
October.
November.
December.
Landscape screen orientation.
Portrait screen orientation.
Reverse landscape screen orientation.
Reverse portrait screen orientation.
Uses landscape or reverse landscape based on the hardware sensor.
Uses portrait or reverse portrait based on the hardware sensor.
Uses most suitable orientation based on the hardware sensor.
Desktop directory path.
DCIM (Digital Camera Images) directory path.
Documents directory path.
Downloads directory path.
Movies directory path.
Music directory path.
Pictures directory path.
Ringtones directory path.
Unknown powerstate.
Unplugged, running on battery.
Plugged in, no battery available.
Plugged in, battery charging.
Plugged in, battery fully charged.