diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 3a96a36f1b1..b855f725d74 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -40,6 +40,7 @@ + Centers the window on the screen if in windowed mode. @@ -48,7 +49,7 @@ - Delay executing of the current thread by given milliseconds. + Delay execution of the current thread by given milliseconds. @@ -57,7 +58,7 @@ - Delay executing of the current thread by given microseconds. + Delay execution of the current thread by given microseconds. @@ -67,7 +68,7 @@ Dumps the memory allocation ringlist to a file (only works in debug). - Entry format per line: "Address - Size - Description" + Entry format per line: "Address - Size - Description". @@ -77,7 +78,7 @@ Dumps all used resources to file (only works in debug). - Entry format per line: "Resource Type : Resource Location" + Entry format per line: "Resource Type : Resource Location". At the end of the file is a statistic of all used Resource Types. @@ -116,6 +117,22 @@ 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. + + @@ -242,6 +259,7 @@ + Returns the window size including decorations like window borders. @@ -365,7 +383,7 @@ - Return the current unix timestamp. + Returns the current unix epoch timestamp. @@ -394,6 +412,7 @@ + Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or it is currently hidden. @@ -411,6 +430,7 @@ + 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. @@ -473,6 +493,13 @@ 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. + + @@ -601,6 +628,15 @@ Enables backup saves if [code]enabled[/code] is [code]true[/code]. + + + + + + + Sets whether the window should always be on top. + + @@ -639,27 +675,31 @@ 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] removes the window frame. - If [code]true[/code], the window is fullscreen. + If [code]true[/code] the window is fullscreen. - If [code]true[/code], the window is maximized. + If [code]true[/code] the window is maximized. - If [code]true[/code], the window is minimized. + 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. @@ -673,82 +713,121 @@ + 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.