summaryrefslogtreecommitdiff
path: root/doc/classes/OS.xml
AgeCommit message (Collapse)Author
2020-11-09Docs: Port Code Examples to C# (M, N, O, P, R)HaSa1002
Includes: * MarginContainer * NavigationPolygon * Node * NodePath * OS * PackedByteArray * PackedScene * PacketPeerUDP * PCKPacker * Performance * PhysicsShapeQueryParameters2D * PhysicsShapeQueryParameters3D * PrimitiveMesh * ProjectSettings Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2020-10-01Link to demos from within the class referenceAaron Franke
2020-09-24OS: Remove unused get_splash_tick_msecRémi Verschelde
It was added in 3e20391bf607dc7c452b056854aed4a8c99ba0f6 but it doesn't seem particularly useful, and it was only implemented for the custom splash branch and not the default one, so it could return an uninitialized int.
2020-07-28doc: Sync classref with current sourceRémi Verschelde
2020-07-21Merge pull request #40450 from asmaloney/spellingRémi Verschelde
Fix spelling & grammar in comments, docs, and messages
2020-07-21Fix spelling & grammar in comments, docs, and messagesAndy Maloney
2020-07-20Document the process of parsing command-line argumentsAndrii Doroshenko (Xrayez)
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2020-06-20Move Haiku platform port to external repositoryRémi Verschelde
The Haiku port now resides at: https://github.com/godotengine/godot-haiku-platform While we're happy to support as many Free and Open Source platforms as we can, we need to put the main focus on the platforms that we can reasonably maintain, and for Haiku we have been lacking maintainers ever since the port was first merged in 2015. The Haiku code has not been compiling and much less working at least since the release of Godot 3.0, and while some attempts have been made at fixing things, it's still not functional today in the `3.2` branch (and much less in `master`, understandably). Having it in an external repository should hopefully enable Haiku contributors to fix issues in their own time, and possibly tag versions compatible with past Godot releases once they are ready.
2020-06-17DocData: Skip language-specific ClassDoc without methods/constantsRémi Verschelde
Removes the useless `@C#`, `@NativeScript` and `@VisualScript` entries.
2020-05-31Remove OS.get_system_time_secs/get_system_time_msecs and change ↵Emmanuel Leblond
OS.get_unix_time return type to double
2020-05-20doc: Sync classref with current sourceRémi Verschelde
2020-05-20[Windows] Add tablet driver selection.bruvzg
2020-04-28Warn when trying to open `res://` or `user://` with `OS.shell_open()`Hugo Locurcio
`OS.shell_open()` will pass on the path directly to the OS' shell handler (which can handle file paths or URLs). It can't handle Godot-specific paths, so these need to be converted with `ProjectSettings.globalize_path()` first.
2020-03-31doc: Sync classref with DisplayServer/Window changesRémi Verschelde
2020-03-09doc: Sync classref with current sourceRémi Verschelde
2020-02-25Rename `scancode` to `keycode`.bruvzg
Add `physical_keycode` (keyboard layout independent keycodes) to InputEventKey and InputMap. Fix non-latin keyboard layout keycodes on Linux/X11 (fallback to physical keycodes).
2020-02-18doc: Sync classref with current sourceRémi Verschelde
Handle removal of Pool*Array types and other recent changes.
2020-02-14Remove incomplete battery status/power APIRémi Verschelde
It was initially implemented in #5871 for Godot 3.0, but never really completed or thoroughly tested for most platforms. It then stayed in limbo and nobody seems really keen to finish it, so it's better to remove it in 4.0, and re-add eventually (possibly with a different API) if there's demand and an implementation confirmed working on all platforms. Closes #8770.
2020-02-13Remove obsolete GLES3 backendRémi Verschelde
Due to the port to Vulkan and complete redesign of the rendering backend, the `drivers/gles3` code is no longer usable in this state and is not planned to be ported to the new architecture. The GLES2 backend is kept (while still disabled and non-working) as it will eventually be ported to serve as the low-end renderer for Godot 4.0. Some GLES3 features might be selectively ported to the updated GLES2 backend if there's a need for them, and extensions we can use for that. So long, OpenGL driver bugs!
2020-02-10Allow per pixel transparency in javascript platformmuiroc
2020-01-31Update docs to version 4.0clayjohn
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.
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-26 22:32:28 +0000