summaryrefslogtreecommitdiff
path: root/doc/classes/OS.xml
AgeCommit message (Collapse)Author
2020-01-26doc: Drop unused 'category' property from headerRémi Verschelde
We already removed it from the online docs with #35132. Currently it can only be "Built-In Types" (Variant types) or "Core" (everything else), which is of limited use. We might also want to consider dropping it from `ClassDB` altogether in Godot 4.0.
2020-01-25Document how to get a human-readable string from an InputEventKeyHugo Locurcio
2020-01-23Make `OS.execute()` blocking by default if not specifiedHugo Locurcio
This makes `OS.execute()` calls quicker to set up when calling programs in a blocking fashion.
2020-01-13Revert "Enable Vsync via Compositor by default"Rémi Verschelde
This reverts commit 9600fd5dde1f85b7dd2dd8558d52ff86b18651e7. Add comment warning about possible implications of using this option. Fixes #35038.
2020-01-10Improve the `OS.is_debug_build()` documentationHugo Locurcio
2020-01-09Enable Vsync via Compositor by defaultHugo Locurcio
This feature was added in #33414 but it was disabled by default. Now that it got some testing, it's probably safe to enable it by default.
2020-01-06Merge pull request #33967 from Calinou/add-os-is-window-focusedRémi Verschelde
Add an `OS.is_window_focused()` getter
2020-01-03Add a shorthand for setting the exit code using `SceneTree::quit()`Hugo Locurcio
This reduces the amount of code required to exit a process with a non-zero exit code. This pattern is also found in most other programming languages.
2019-12-29Print a warning message if `OS.exit_code` is set to a non-portable valueHugo Locurcio
This also improves the related documentation.
2019-12-04Added support for vertical syncing via the Windows OS compositor (DWM.)TerminalJack
2019-12-03[ci skip] OS class documentations, adds platform compatibility notes.bruvzg
2019-11-28Add an `OS.is_window_focused()` getterHugo Locurcio
This makes it possible to know whether the window is focused at a given time, without having to track the focus state manually using `NOTIFICATION_WM_FOCUS_IN` and `NOTIFICATION_WM_FOCUS_OUT`. This partially addresses #33928.
2019-11-08Expose the `OS.low_processor_usage_mode_sleep_usec` propertyHugo Locurcio
This makes it possible to change it at runtime in projects.
2019-10-31Added documentation for the OS class MIDI functions.Derwent Ready (drentsoft)
2019-10-26doc: Sync classref with current sourceRémi Verschelde
2019-10-22Add request permission automatically at androidCagdas
2019-10-08Improve the OS `get_screen_*` methods' documentationHugo Locurcio
2019-09-26Added an exit code to the blocking mode of OS::executeRuslan Mullayanov
Updated documentation accordingly. Fixes #31881.
2019-09-24Merge pull request #32286 from Calinou/doc-improve-os-shell-openRémi Verschelde
Improve the `OS.shell_open()` documentation
2019-09-23Improve the `OS.shell_open()` documentationHugo Locurcio
This adds a `mailto:` example to `OS.shell_open()`.
2019-09-22Mention performance caveats of `OS.set_window_title()`Hugo Locurcio
See #32254.
2019-08-26[macOS] Add methods to modify global and dock menus. Add ability to open ↵bruvzg
multiple editor/project manager instances, recent/favourite project list to project manager dock menu and opened scene list to editor dock menu.
2019-07-09Clarify what %APPDATA% expands to in Windowshbina085
Linux users should be familiar with "~" so I think it might be unnecessary. Also changed the file separator in the description to use Windows' instead.
2019-06-30doc: Enforce default values for OS propertiesRémi Verschelde
Otherwise we end up fetching values from the current OS instance when running doctool, so they would change based on the system or even simply due to changes to the system clipboard.
2019-06-30doc: Remove null default values that can't be determinedRémi Verschelde
Applying #30187.
2019-06-30doc: Add default values to all propertiesRémi Verschelde
Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29Added descriptions to OS.get_splash_tick_msec() and OS.get_window_safe_area()unknown
2019-06-27Proofread and improve the whole class referenceHugo Locurcio
- Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-27doc: Fix scoped hyperlinks to same-class enums/methodsRémi Verschelde
The class name does not need to be specified when it is the current class.
2019-06-26doc: Proofread and complete various nodesRémi Verschelde
All 100% completed: MainLoop, Node, Object, Path, Performance, Reference, Resource, SceneState, SceneTree, UndoRedo. Also fixed some en_GB occurrences as the reference spelling is en_US.
2019-06-24Remove references to mouse stuff from OSaustinried
There is nothing in `OS` about mouse grabbing or mouse cursors, that's in `Input`, so I'm cleaning up those references.
2019-06-18doc: Sync classref with current sourceRémi Verschelde
Fix a few bugs.
2019-06-17Merge pull request #29752 from bruvzg/window_size_limitsRémi Verschelde
Add ability to limit maximum/minimum window size.
2019-06-15Add ability to limit maximum/minimum window size.bruvzg
2019-06-14Changes to OS.has_feature() docs:Ken Paulson
- Added link to the Feature Tags documentation - Added note that tag names are case-sensitive
2019-06-12Merge pull request #29465 from bruvzg/per_pixel_transp_imprRémi Verschelde
Removes redundant "splash" setting, improves per pixel transparency documentation.
2019-06-04[macOS] Fixes unicode input with IME mode inactive, Improves IME mode ↵bruvzg
documentation.
2019-06-04Removes redundant "display/window/per_pixel_transparency/splash" setting, ↵bruvzg
improves per pixel transparency documentation.
2019-05-28doc: Sync classref with current sourceRémi Verschelde
2019-05-24Add native window/taskbar icon support for Windows and macOS.bruvzg
Co-authored-by: Markus Törnqvist <mjt@nysv.org>
2019-04-19doc: Drop unused <demos> tagRémi Verschelde
2019-04-01doc: Bump version to 3.2Rémi Verschelde
2019-03-10doc: Fix style for vararg in makerstRémi Verschelde
2019-03-08Request Android record permission when neededDESKTOP-3H3MR3A\eloisa
2019-02-16Expose OS::get_current_video_driver to scripting languagesRémi Verschelde
2019-01-07doc: Fix wrong references found by Sphinx and new makerst.pyRémi Verschelde
2019-01-07doc: Fix wrong references found by new makerst.pyRémi Verschelde
Thanks @PJB3005
2018-12-27doc: Sync classref with current sourceRémi Verschelde
Fix various code formatting issues and argument names.
2018-12-20doc: Add missing commas after "If true/false"Rémi Verschelde
2018-12-20Added OS.get_system_time_msecs()volzhs