OSSingleton

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.

@GodotBaseClass

struct OSSingleton {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(OSSingleton other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static OSSingleton _new();

enum VideoDriver;

enum SystemDir;

enum ScreenOrientation;

enum PowerState;

enum HandleType;

enum Constants;

void alert(String text, String title);

bool canDraw();

bool canUseThreads();

void centerWindow();

void closeMidiInputs();

void delayMsec(long msec);

void delayUsec(long usec);

void dumpMemoryToFile(String file);

void dumpResourcesToFile(String file);

long execute(String path, PoolStringArray arguments, bool blocking, Array output, bool read_stderr);

long findScancodeFromString(String string);

long getAudioDriverCount();

String getAudioDriverName(long driver);

bool getBorderlessWindow();

String getClipboard();

PoolStringArray getCmdlineArgs();

PoolStringArray getConnectedMidiInputs();

long getCurrentScreen();

String getCurrentTabletDriver();

OS.VideoDriver getCurrentVideoDriver();

Dictionary getDate(bool utc);

Dictionary getDatetime(bool utc);

Dictionary getDatetimeFromUnixTime(long unix_time_val);

long getDynamicMemoryUsage();

String getEnvironment(String variable);

String getExecutablePath();

long getExitCode();

PoolStringArray getGrantedPermissions();

Vector2 getImeSelection();

String getImeText();

String getLatinKeyboardVariant();

String getLocale();

long getLowProcessorUsageModeSleepUsec();

Vector2 getMaxWindowSize();

Vector2 getMinWindowSize();

String getModelName();

String getName();

long getNativeHandle(long handle_type);

long getPowerPercentLeft();

long getPowerSecondsLeft();

OS.PowerState getPowerState();

long getProcessId();

long getProcessorCount();

Vector2 getRealWindowSize();

String getScancodeString(long code);

long getScreenCount();

long getScreenDpi(long screen);

double getScreenMaxScale();

OS.ScreenOrientation getScreenOrientation();

Vector2 getScreenPosition(long screen);

double getScreenScale(long screen);

Vector2 getScreenSize(long screen);

long getSplashTickMsec();

long getStaticMemoryPeakUsage();

long getStaticMemoryUsage();

String getSystemDir(long dir);

long getSystemTimeMsecs();

long getSystemTimeSecs();

long getTabletDriverCount();

String getTabletDriverName(long idx);

long getThreadCallerId();

long getTicksMsec();

long getTicksUsec();

Dictionary getTime(bool utc);

Dictionary getTimeZoneInfo();

String getUniqueId();

long getUnixTime();

long getUnixTimeFromDatetime(Dictionary datetime);

String getUserDataDir();

long getVideoDriverCount();

String getVideoDriverName(long driver);

long getVirtualKeyboardHeight();

bool getWindowPerPixelTransparencyEnabled();

Vector2 getWindowPosition();

Rect2 getWindowSafeArea();

Vector2 getWindowSize();

void globalMenuAddItem(String menu, String label, VariantArg2 id, VariantArg3 meta);

void globalMenuAddSeparator(String menu);

void globalMenuClear(String menu);

void globalMenuRemoveItem(String menu, long idx);

bool hasEnvironment(String variable);

bool hasFeature(String tag_name);

bool hasTouchscreenUiHint();

bool hasVirtualKeyboard();

void hideVirtualKeyboard();

bool isDebugBuild();

bool isInLowProcessorUsageMode();

bool isKeepScreenOn();

bool isOkLeftAndCancelRight();

bool isScancodeUnicode(long code);

bool isStdoutVerbose();

bool isUserfsPersistent();

bool isVsyncEnabled();

bool isVsyncViaCompositorEnabled();

bool isWindowAlwaysOnTop();

bool isWindowFocused();

bool isWindowFullscreen();

bool isWindowMaximized();

bool isWindowMinimized();

bool isWindowResizable();

long keyboardGetCurrentLayout();

long keyboardGetLayoutCount();

String keyboardGetLayoutLanguage(long index);

String keyboardGetLayoutName(long index);

void keyboardSetCurrentLayout(long index);

GodotError kill(long pid);

void moveWindowToForeground();

bool nativeVideoIsPlaying();

void nativeVideoPause();

GodotError nativeVideoPlay(String path, double volume, String audio_track, String subtitle_track);

void nativeVideoStop();

void nativeVideoUnpause();

void openMidiInputs();

void printAllResources(String tofile);

void printAllTexturesBySize();

void printResourcesByType(PoolStringArray types);

void printResourcesInUse(bool _short);

void requestAttention();

bool requestPermission(String name);

bool requestPermissions();

void setBorderlessWindow(bool borderless);

void setClipboard(String clipboard);

void setCurrentScreen(long screen);

void setCurrentTabletDriver(String name);

bool setEnvironment(String variable, String value);

void setExitCode(long code);

void setIcon(Image icon);

void setImeActive(bool active);

void setImePosition(Vector2 position);

void setKeepScreenOn(bool enabled);

void setLowProcessorUsageMode(bool enable);

void setLowProcessorUsageModeSleepUsec(long usec);

void setMaxWindowSize(Vector2 size);

void setMinWindowSize(Vector2 size);

void setNativeIcon(String filename);

void setScreenOrientation(long orientation);

GodotError setThreadName(String name);

void setUseFileAccessSaveAndSwap(bool enabled);

void setUseVsync(bool enable);

void setVsyncViaCompositor(bool enable);

void setWindowAlwaysOnTop(bool enabled);

void setWindowFullscreen(bool enabled);

void setWindowMaximized(bool enabled);

void setWindowMinimized(bool enabled);

void setWindowMousePassthrough(PoolVector2Array region);

void setWindowPerPixelTransparencyEnabled(bool enabled);

void setWindowPosition(Vector2 position);

void setWindowResizable(bool enabled);

void setWindowSize(Vector2 size);

void setWindowTitle(String title);

GodotError shellOpen(String uri);

void showVirtualKeyboard(String existing_text, bool multiline);

String clipboard [@property getter];

String clipboard [@property setter];

long currentScreen [@property getter];

long currentScreen [@property setter];

long exitCode [@property getter];

long exitCode [@property setter];

bool keepScreenOn [@property getter];

bool keepScreenOn [@property setter];

bool lowProcessorUsageMode [@property getter];

bool lowProcessorUsageMode [@property setter];

long lowProcessorUsageModeSleepUsec [@property getter];

long lowProcessorUsageModeSleepUsec [@property setter];

Vector2 maxWindowSize [@property getter];

Vector2 maxWindowSize [@property setter];

Vector2 minWindowSize [@property getter];

Vector2 minWindowSize [@property setter];

OS.ScreenOrientation screenOrientation [@property getter];

long screenOrientation [@property setter];

String tabletDriver [@property getter];

String tabletDriver [@property setter];

bool vsyncEnabled [@property getter];

bool vsyncEnabled [@property setter];

bool vsyncViaCompositor [@property getter];

bool vsyncViaCompositor [@property setter];

bool windowBorderless [@property getter];

bool windowBorderless [@property setter];

bool windowFullscreen [@property getter];

bool windowFullscreen [@property setter];

bool windowMaximized [@property getter];

bool windowMaximized [@property setter];

bool windowMinimized [@property getter];

bool windowMinimized [@property setter];

bool windowPerPixelTransparencyEnabled [@property getter];

bool windowPerPixelTransparencyEnabled [@property setter];

Vector2 windowPosition [@property getter];

Vector2 windowPosition [@property setter];

bool windowResizable [@property getter];

bool windowResizable [@property setter];

Vector2 windowSize [@property getter];

Vector2 windowSize [@property setter];

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Enums

Constants enum Constants
HandleType enum HandleType
Month enum Month
PowerState enum PowerState
ScreenOrientation enum ScreenOrientation
SystemDir enum SystemDir
VideoDriver enum VideoDriver
Weekday enum Weekday

Functions

alert void alert(String text, String title): Displays a modal dialog box using the host OS' facilities. Execution is blocked until the dialog is closed.
canDraw bool canDraw(): Returns true if the host OS allows drawing.
canUseThreads bool canUseThreads(): Returns true if the current host platform is using multiple threads.
centerWindow void centerWindow(): Centers the window on the screen if in windowed mode.
closeMidiInputs void closeMidiInputs(): Shuts down system MIDI driver. Note: This method is implemented on Linux, macOS and Windows.
delayMsec void delayMsec(long msec): Delay execution of the current thread by msec milliseconds. msec must be greater than or equal to 0. Otherwise, delayMsec will do nothing and will print an error message.
delayUsec void delayUsec(long usec): Delay execution of the current thread by usec microseconds. usec must be greater than or equal to 0. Otherwise, delayUsec will do nothing and will print an error message.
dumpMemoryToFile void dumpMemoryToFile(String file): Dumps the memory allocation ringlist to a file (only works in debug). Entry format per line: "Address - Size - Description".
dumpResourcesToFile void dumpResourcesToFile(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.
execute long execute(String path, PoolStringArray arguments, bool blocking, Array output, bool read_stderr): Execute the file at the given path with the arguments passed as an array of strings. Platform path resolution will take place. The resolved file must exist and be executable. The arguments are used in the given order and separated by a space, so OS.execute("ping", $(D "-w", "3", "godotengine.org"), false) will resolve to ping -w 3 godotengine.org in the system's shell. This method has slightly different behavior based on whether the blocking mode is enabled. If blocking is true, the Godot thread will pause its execution while waiting for the process to terminate. The shell output of the process will be written to the output array as a single string. When the process terminates, the Godot thread will resume execution. If blocking is false, the Godot thread will continue while the new process runs. It is not possible to retrieve the shell output in non-blocking mode, so output will be empty. The return value also depends on the blocking mode. When blocking, the method will return 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 with kill). 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:
findScancodeFromString long findScancodeFromString(String string): Returns the scancode of the given string (e.g. "Escape").
getAudioDriverCount long getAudioDriverCount(): Returns the total number of available audio drivers.
getAudioDriverName String getAudioDriverName(long driver): Returns the audio driver name for the given index.
getBorderlessWindow bool getBorderlessWindow()
getClipboard String getClipboard()
getCmdlineArgs PoolStringArray getCmdlineArgs(): Returns the command-line arguments passed to the engine. Command-line arguments can be written in any form, including both --key value 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 the getEnvironment method. You can set editor/main_run_args in the Project Settings 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:
getConnectedMidiInputs PoolStringArray getConnectedMidiInputs(): Returns an array of MIDI device names. The returned array will be empty if the system MIDI driver has not previously been initialised with openMidiInputs. Note: This method is implemented on Linux, macOS and Windows.
getCurrentScreen long getCurrentScreen()
getCurrentTabletDriver String getCurrentTabletDriver()
getCurrentVideoDriver OS.VideoDriver getCurrentVideoDriver(): Returns the currently used video driver, using one of the values from videodriver.
getDate Dictionary getDate(bool utc): Returns current date as a dictionary of keys: year, month, day, weekday, dst (Daylight Savings Time).
getDatetime Dictionary getDatetime(bool utc): Returns current datetime as a dictionary of keys: year, month, day, weekday, dst (Daylight Savings Time), hour, minute, second.
getDatetimeFromUnixTime Dictionary getDatetimeFromUnixTime(long unix_time_val): Gets a dictionary of time values corresponding to the given UNIX epoch time (in seconds). The returned Dictionary's values will be the same as getDatetime, with the exception of Daylight Savings Time as it cannot be determined from the epoch.
getDynamicMemoryUsage long getDynamicMemoryUsage(): Returns the total amount of dynamic memory used (only works in debug).
getEnvironment String getEnvironment(String variable): Returns the value of an environment variable. Returns an empty string if the environment variable doesn't exist. Note: Double-check the casing of variable. Environment variable names are case-sensitive on all platforms except Windows.
getExecutablePath String getExecutablePath(): Returns the path to the current engine executable.
getExitCode long getExitCode()
getGrantedPermissions PoolStringArray getGrantedPermissions(): 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.
getImeSelection Vector2 getImeSelection(): Returns the IME cursor position (the currently-edited portion of the string) relative to the characters in the composition string. constant 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.
getImeText String getImeText(): Returns the IME intermediate composition string. constant 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.
getLatinKeyboardVariant String getLatinKeyboardVariant(): 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.
getLocale String getLocale(): Returns the host OS locale.
getLowProcessorUsageModeSleepUsec long getLowProcessorUsageModeSleepUsec()
getMaxWindowSize Vector2 getMaxWindowSize()
getMinWindowSize Vector2 getMinWindowSize()
getModelName String getModelName(): Returns the model name of the current device. Note: This method is implemented on Android and iOS. Returns "GenericDevice" on unsupported platforms.
getName String getName(): Returns the name of the host OS. Possible values are: "Android", "iOS", "HTML5", "OSX", "Server", "Windows", "UWP", "X11".
getNativeHandle long getNativeHandle(long 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).
getPowerPercentLeft long getPowerPercentLeft(): 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.
getPowerSecondsLeft long getPowerSecondsLeft(): 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.
getPowerState OS.PowerState getPowerState(): Returns the current state of the device regarding battery and power. See powerstate constants. Note: This method is implemented on Linux, macOS and Windows.
getProcessId long getProcessId(): Returns the project's process ID. Note: This method is implemented on Android, iOS, Linux, macOS and Windows.
getProcessorCount long getProcessorCount(): Returns the number of threads available on the host machine.
getRealWindowSize Vector2 getRealWindowSize(): Returns the window size including decorations like window borders.
getScancodeString String getScancodeString(long code): Returns the given scancode as a string (e.g. Return values: "Escape", "Shift+Escape"). See also InputEventKey.scancode and InputEventKey.getScancodeWithModifiers.
getScreenCount long getScreenCount(): Returns the number of displays attached to the host machine.
getScreenDpi long getScreenDpi(long screen): Returns the dots per inch density of the specified screen. If screen is /code-1/code (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:
getScreenMaxScale double getScreenMaxScale(): Return the greatest scale factor of all screens. Note: On macOS returned value is 2.0 if there is at least one hiDPI (Retina) screen in the system, and 1.0 in all other cases. Note: This method is implemented on macOS.
getScreenOrientation OS.ScreenOrientation getScreenOrientation()
getScreenPosition Vector2 getScreenPosition(long screen): Returns the position of the specified screen by index. If screen is /code-1/code (the default value), the current screen will be used.
getScreenScale double getScreenScale(long screen): Return the scale factor of the specified screen by index. If screen is /code-1/code (the default value), the current screen will be used. Note: On macOS returned value is 2.0 for hiDPI (Retina) screen, and 1.0 for all other cases. Note: This method is implemented on macOS.
getScreenSize Vector2 getScreenSize(long screen): Returns the dimensions in pixels of the specified screen. If screen is /code-1/code (the default value), the current screen will be used.
getSplashTickMsec long getSplashTickMsec(): Returns the amount of time in milliseconds it took for the boot logo to appear.
getStaticMemoryPeakUsage long getStaticMemoryPeakUsage(): Returns the maximum amount of static memory used (only works in debug).
getStaticMemoryUsage long getStaticMemoryUsage(): Returns the amount of static memory being used by the program in bytes.
getSystemDir String getSystemDir(long dir): Returns the actual path to commonly used folders across different platforms. Available locations are specified in systemdir. 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.
getSystemTimeMsecs long getSystemTimeMsecs(): Returns the epoch time of the operating system in milliseconds.
getSystemTimeSecs long getSystemTimeSecs(): Returns the epoch time of the operating system in seconds.
getTabletDriverCount long getTabletDriverCount(): Returns the total number of available tablet drivers. Note: This method is implemented on Windows.
getTabletDriverName String getTabletDriverName(long idx): Returns the tablet driver name for the given index. Note: This method is implemented on Windows.
getThreadCallerId long getThreadCallerId(): 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.
getTicksMsec long getTicksMsec(): Returns the amount of time passed in milliseconds since the engine started.
getTicksUsec long getTicksUsec(): Returns the amount of time passed in microseconds since the engine started.
getTime Dictionary getTime(bool utc): Returns current time as a dictionary of keys: hour, minute, second.
getTimeZoneInfo Dictionary getTimeZoneInfo(): Returns the current time zone as a dictionary with the keys: bias and name.
getUniqueId String getUniqueId(): 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 by getUniqueId for security purposes. Note: Returns an empty string on HTML5 and UWP, as this method isn't implemented on those platforms yet.
getUnixTime long getUnixTime(): 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 use getTicksUsec or getTicksMsec for precise time calculation instead, since they are guaranteed to be monotonic (i.e. never decrease).
getUnixTimeFromDatetime long getUnixTimeFromDatetime(Dictionary datetime): 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 empty 0 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 from getDatetimeFromUnixTime directly into this function. Daylight Savings Time (dst), if present, is ignored.
getUserDataDir String getUserDataDir(): Returns the absolute directory path where user data is written (user://). On Linux, this is ~/.local/share/godot/app_userdata/$(D project_name), or ~/.local/share/$(D custom_name) if use_custom_user_dir is set. On macOS, this is ~/Library/Application Support/Godot/app_userdata/$(D project_name), or ~/Library/Application Support/$(D custom_name) if use_custom_user_dir is set. On Windows, this is %APPDATA%\Godot\app_userdata\$(D project_name), or %APPDATA%\$(D custom_name) if use_custom_user_dir is set. %APPDATA% expands to %USERPROFILE%\AppData\Roaming. If the project name is empty, user:// falls back to res://.
getVideoDriverCount long getVideoDriverCount(): Returns the number of video drivers supported on the current platform.
getVideoDriverName String getVideoDriverName(long driver): Returns the name of the video driver matching the given driver index. This index is a value from videodriver, and you can use getCurrentVideoDriver to get the current backend's index.
getVirtualKeyboardHeight long getVirtualKeyboardHeight(): Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or if it is currently hidden.
getWindowPerPixelTransparencyEnabled bool getWindowPerPixelTransparencyEnabled()
getWindowPosition Vector2 getWindowPosition()
getWindowSafeArea Rect2 getWindowSafeArea(): Returns unobscured area of the window where interactive controls should be rendered.
getWindowSize Vector2 getWindowSize()
globalMenuAddItem void globalMenuAddItem(String menu, String label, VariantArg2 id, VariantArg3 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.
globalMenuAddSeparator void globalMenuAddSeparator(String menu): Add a separator between items. Separators also occupy an index. Note: This method is implemented on macOS.
globalMenuClear void globalMenuClear(String menu): Clear the global menu, in effect removing all items. Note: This method is implemented on macOS.
globalMenuRemoveItem void globalMenuRemoveItem(String menu, long 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.
hasEnvironment bool hasEnvironment(String variable): Returns true if the environment variable with the name variable exists. Note: Double-check the casing of variable. Environment variable names are case-sensitive on all platforms except Windows.
hasFeature bool hasFeature(String tag_name): Returns true 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 the url=https://docs.godotengine.org/en/3.3/getting_started/workflow/export/feature_tags.htmlFeature Tags/url documentation for more details. Note: Tag names are case-sensitive.
hasTouchscreenUiHint bool hasTouchscreenUiHint(): Returns true if the device has a touchscreen or emulates one.
hasVirtualKeyboard bool hasVirtualKeyboard(): Returns true if the platform has a virtual keyboard, false otherwise.
hideVirtualKeyboard void hideVirtualKeyboard(): Hides the virtual keyboard if it is shown, does nothing otherwise.
isDebugBuild bool isDebugBuild(): Returns true if the Godot binary used to run the project is a debug export template, or when running in the editor. Returns false if the Godot binary used to run the project is a release export template. To check whether the Godot binary used to run the project is an export template (debug or release), use OS.has_feature("standalone") instead.
isInLowProcessorUsageMode bool isInLowProcessorUsageMode()
isKeepScreenOn bool isKeepScreenOn()
isOkLeftAndCancelRight bool isOkLeftAndCancelRight(): Returns true if the OK button should appear on the left and Cancel on the right.
isScancodeUnicode bool isScancodeUnicode(long code): Returns true if the input scancode corresponds to a Unicode character.
isStdoutVerbose bool isStdoutVerbose(): Returns true if the engine was executed with -v (verbose stdout).
isUserfsPersistent bool isUserfsPersistent(): If true, the user:// file system is persistent, so that its state is the same after a player quits and starts the game again. Relevant to the HTML5 platform, where this persistence may be unavailable.
isVsyncEnabled bool isVsyncEnabled()
isVsyncViaCompositorEnabled bool isVsyncViaCompositorEnabled()
isWindowAlwaysOnTop bool isWindowAlwaysOnTop(): Returns true if the window should always be on top of other windows.
isWindowFocused bool isWindowFocused(): Returns true if the window is currently focused. Note: Only implemented on desktop platforms. On other platforms, it will always return true.
isWindowFullscreen bool isWindowFullscreen()
isWindowMaximized bool isWindowMaximized()
isWindowMinimized bool isWindowMinimized()
isWindowResizable bool isWindowResizable()
keyboardGetCurrentLayout long keyboardGetCurrentLayout(): Returns active keyboard layout index. Note: This method is implemented on Linux, macOS and Windows.
keyboardGetLayoutCount long keyboardGetLayoutCount(): Returns the number of keyboard layouts. Note: This method is implemented on Linux, macOS and Windows.
keyboardGetLayoutLanguage String keyboardGetLayoutLanguage(long index): Returns the ISO-639/BCP-47 language code of the keyboard layout at position index. Note: This method is implemented on Linux, macOS and Windows.
keyboardGetLayoutName String keyboardGetLayoutName(long index): Returns the localized name of the keyboard layout at position index. Note: This method is implemented on Linux, macOS and Windows.
keyboardSetCurrentLayout void keyboardSetCurrentLayout(long index): Sets active keyboard layout. Note: This method is implemented on Linux, macOS and Windows.
kill GodotError kill(long pid): Kill (terminate) the process identified by the given process ID (pid), e.g. the one returned by execute 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.
moveWindowToForeground void moveWindowToForeground(): Moves the window to the front. Note: This method is implemented on Linux, macOS and Windows.
nativeVideoIsPlaying bool nativeVideoIsPlaying(): Returns true if native video is playing. Note: This method is implemented on Android and iOS.
nativeVideoPause void nativeVideoPause(): Pauses native video playback. Note: This method is implemented on Android and iOS.
nativeVideoPlay GodotError nativeVideoPlay(String path, double 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 implemented on Android and iOS, and the current Android implementation does not support the volume, audio_track and subtitle_track options.
nativeVideoStop void nativeVideoStop(): Stops native video playback. Note: This method is implemented on Android and iOS.
nativeVideoUnpause void nativeVideoUnpause(): Resumes native video playback. Note: This method is implemented on Android and iOS.
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(typeof(null) n)
opEquals bool opEquals(OSSingleton other)
openMidiInputs void openMidiInputs(): Initialises the singleton for the system MIDI driver. Note: This method is implemented on Linux, macOS and Windows.
printAllResources void printAllResources(String tofile): Shows all resources in the game. Optionally, the list can be written to a file by specifying a file path in tofile.
printAllTexturesBySize void printAllTexturesBySize(): Shows the list of loaded textures sorted by size in memory.
printResourcesByType void printResourcesByType(PoolStringArray types): Shows the number of resources loaded by the game of the given types.
printResourcesInUse void printResourcesInUse(bool _short): Shows all resources currently used by the game.
requestAttention void requestAttention(): 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.
requestPermission bool requestPermission(String name): At the moment this function is only used by AudioDriverOpenSL to request permission for RECORD_AUDIO on Android.
requestPermissions bool requestPermissions(): 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.
setBorderlessWindow void setBorderlessWindow(bool borderless)
setClipboard void setClipboard(String clipboard)
setCurrentScreen void setCurrentScreen(long screen)
setCurrentTabletDriver void setCurrentTabletDriver(String name)
setEnvironment bool setEnvironment(String variable, String value): Sets the value of the environment variable variable to value. The environment variable will be set for the Godot process and any process executed with execute after running setEnvironment. The environment variable will not persist to processes run after the Godot process was terminated. Note: Double-check the casing of variable. Environment variable names are case-sensitive on all platforms except Windows.
setExitCode void setExitCode(long code)
setIcon void setIcon(Image icon): Sets the game's icon using an Image 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.
setImeActive void setImeActive(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 using getImeSelection and getImeText functions. Completed composition string is committed when input is finished. Note: This method is implemented on Linux, macOS and Windows.
setImePosition void setImePosition(Vector2 position): Sets position of IME suggestion list popup (in window coordinates). Note: This method is implemented on Linux, macOS and Windows.
setKeepScreenOn void setKeepScreenOn(bool enabled)
setLowProcessorUsageMode void setLowProcessorUsageMode(bool enable)
setLowProcessorUsageModeSleepUsec void setLowProcessorUsageModeSleepUsec(long usec)
setMaxWindowSize void setMaxWindowSize(Vector2 size)
setMinWindowSize void setMinWindowSize(Vector2 size)
setNativeIcon void setNativeIcon(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.
setScreenOrientation void setScreenOrientation(long orientation)
setThreadName GodotError setThreadName(String name): Sets the name of the current thread.
setUseFileAccessSaveAndSwap void setUseFileAccessSaveAndSwap(bool enabled): Enables backup saves if enabled is true.
setUseVsync void setUseVsync(bool enable)
setVsyncViaCompositor void setVsyncViaCompositor(bool enable)
setWindowAlwaysOnTop void setWindowAlwaysOnTop(bool enabled): Sets whether the window should always be on top. Note: This method is implemented on Linux, macOS and Windows.
setWindowFullscreen void setWindowFullscreen(bool enabled)
setWindowMaximized void setWindowMaximized(bool enabled)
setWindowMinimized void setWindowMinimized(bool enabled)
setWindowMousePassthrough void setWindowMousePassthrough(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).
setWindowPerPixelTransparencyEnabled void setWindowPerPixelTransparencyEnabled(bool enabled)
setWindowPosition void setWindowPosition(Vector2 position)
setWindowResizable void setWindowResizable(bool enabled)
setWindowSize void setWindowSize(Vector2 size)
setWindowTitle void setWindowTitle(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.
shellOpen GodotError shellOpen(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 to example@example.com. See url=https://blog.escapecreative.com/customizing-mailto-links/Customizing mailto: Links/url for a list of fields that can be added. Use ProjectSettings.globalizePath to convert a res:// or user:// path into a system path for use with this method. Note: This method is implemented on Android, iOS, HTML5, Linux, macOS and Windows.
showVirtualKeyboard void showVirtualKeyboard(String existing_text, bool multiline): Shows the virtual keyboard if the platform has one. The existing_text parameter is useful for implementing your own LineEdit or TextEdit, as it tells the virtual keyboard what text has already been typed (the virtual keyboard uses it for auto-correct and predictions). The multiline parameter needs to be set to true to be able to enter multiple lines of text, as in TextEdit. Note: This method is implemented on Android, iOS and UWP.
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

clipboard String clipboard [@property getter]
String clipboard [@property setter]: The clipboard from the host OS. Might be unavailable on some platforms.
currentScreen long currentScreen [@property getter]
long currentScreen [@property setter]: The current screen index (starting from 0).
exitCode long exitCode [@property getter]
long exitCode [@property setter]: The exit code passed to the OS when the main loop exits. By convention, an exit code of 0 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 using SceneTree.quit with an exit_code argument passed.
keepScreenOn bool keepScreenOn [@property getter]
bool keepScreenOn [@property setter]: If true, the engine tries to keep the screen on while the game is running. Useful on mobile.
lowProcessorUsageMode bool lowProcessorUsageMode [@property getter]
bool lowProcessorUsageMode [@property setter]: If true, the engine optimizes for low processor usage by only refreshing the screen if needed. Can improve battery consumption on mobile.
lowProcessorUsageModeSleepUsec long lowProcessorUsageModeSleepUsec [@property getter]
long lowProcessorUsageModeSleepUsec [@property setter]: The amount of sleeping between frames when the low-processor usage mode is enabled (in microseconds). Higher values will result in lower CPU usage.
maxWindowSize Vector2 maxWindowSize [@property getter]
Vector2 maxWindowSize [@property setter]: 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.
minWindowSize Vector2 minWindowSize [@property getter]
Vector2 minWindowSize [@property setter]: The minimum 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.
screenOrientation OS.ScreenOrientation screenOrientation [@property getter]
long screenOrientation [@property setter]: The current screen orientation.
tabletDriver String tabletDriver [@property getter]
String tabletDriver [@property setter]: The current tablet driver in use.
vsyncEnabled bool vsyncEnabled [@property getter]
bool vsyncEnabled [@property setter]: If true, vertical synchronization (Vsync) is enabled.
vsyncViaCompositor bool vsyncViaCompositor [@property getter]
bool vsyncViaCompositor [@property setter]: If true and vsync_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.
windowBorderless bool windowBorderless [@property getter]
bool windowBorderless [@property setter]: If true, removes the window frame. Note: Setting window_borderless to false disables per-pixel transparency.
windowFullscreen bool windowFullscreen [@property getter]
bool windowFullscreen [@property setter]: If true, the window is fullscreen.
windowMaximized bool windowMaximized [@property getter]
bool windowMaximized [@property setter]: If true, the window is maximized.
windowMinimized bool windowMinimized [@property getter]
bool windowMinimized [@property setter]: If true, the window is minimized.
windowPerPixelTransparencyEnabled bool windowPerPixelTransparencyEnabled [@property setter]: If true, the window background is transparent and window frame is removed. Use get_tree().get_root().set_transparent_background(true) to disable main viewport background rendering. Note: This property has no effect if Project > Project Settings > Display > Window > Per-pixel transparency > Allowed setting is disabled. Note: This property is implemented on HTML5, Linux, macOS and Windows.
windowPerPixelTransparencyEnabled bool windowPerPixelTransparencyEnabled [@property getter]: If true, the window background is transparent and window frame is removed. Use get_tree().get_root().set_transparent_background(true) to disable main viewport background rendering. Note: This property has no effect if Project > Project Settings > Display > Window > Per-pixel transparency > Allowed setting is disabled. Note: This property is implemented on HTML5, Linux, macOS and Windows.
windowPosition Vector2 windowPosition [@property getter]
Vector2 windowPosition [@property setter]: 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.
windowResizable bool windowResizable [@property getter]
bool windowResizable [@property setter]: If true, the window is resizable by the user.
windowSize Vector2 windowSize [@property getter]
Vector2 windowSize [@property setter]: The size of the window (without counting window manager decorations).

Static functions

_new OSSingleton _new(): Construct a new instance of OSSingleton. Note: use memnew!OSSingleton instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(ToRef) as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

godot os properties

OS

structs

OSSingleton