summaryrefslogtreecommitdiff
path: root/doc/classes/OS.xml
AgeCommit message (Collapse)Author
2023-05-12Improve RenderingServer, RenderingDevice, ShaderGlobalsOverride documentationHugo Locurcio
This brings the overall class reference completion percentage from 87% to 92%. (cherry picked from commit 5056c427d32218e85ad79d51788fa7583d48e293)
2023-05-12Improve some descriptions in the OS docsMichael Alexsander
(cherry picked from commit 6db12c5e50017940df7921e37c9a85eb376881ed)
2023-05-12Fixed various typos across the docsUltraBIF
(cherry picked from commit 8106d33d0f13825b4459898ca20282ba5b543897)
2023-04-03Remove reference to clipboard in OS class docskyace65
(cherry picked from commit a65d99b541578c52beb177ff7290dd68940a3807)
2023-03-14Document using `String.uri_encode()` with `OS.shell_open()`Hugo Locurcio
(cherry picked from commit 81ac3c3e7157a290c02548e7ad6adf50fd6e5118)
2023-02-01More codespell fixes, do more changes from previous ignore listRémi Verschelde
2023-01-28Update name of `template` feature tag in the class referenceHugo Locurcio
2023-01-23Convert en_GB spelling to en_US with codespellRémi Verschelde
2023-01-16OS: Add `unset_environment`, better validate inputRémi Verschelde
Instead of returning an undocumented boolean error code, we do the validation checks that should ensure a successful result. Based on: - https://linux.die.net/man/3/setenv - https://learn.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-setenvironmentvariable
2023-01-12Merge pull request #70714 from Calinou/doc-os-stdinRémi Verschelde
Improve documentation for `OS.read_string_from_stdin()`
2023-01-11Improve documentation for `OS.read_string_from_stdin()`Hugo Locurcio
This makes it clearer that calls to this method are blocking. The unused method parameter was also removed.
2022-12-26Remove duplicate Month and Weekday enumsAaron Franke
Well, they were duplicately-exposed, but triplicately-defined.
2022-12-04Use system fonts as fallback and improve system font handling.bruvzg
Add support for font weight and stretch selection when using system fonts. Add function to get system fallback font from a font name, style, text, and language code. Implement system font support for Android. Use system fonts as a last resort fallback.
2022-11-28Merge pull request #68532 from ↵Rémi Verschelde
Calinou/cmdline-user-args-add-alternative-separator Allow `++` as an alternative separator to `--` for user CLI arguments
2022-11-14fix "unknown document" classref linksHana
2022-11-11Allow `++` as an alternative separator to `--` for user CLI argumentsHugo Locurcio
This is required when using `startx` to start a Godot project, as `--` is used by `startx` for its own arguments (and there is no way to escape it).
2022-11-02Style: Misc docs and comment style and language fixesRémi Verschelde
- Removed empty paragraphs in XML. - Consistently use bold style for "Example:", on a new line. - Fix usage of `[code]` when hyperlinks could be used (`[member]`, `[constant]`). - Fix invalid usage of backticks for inline code in BBCode. - Fix some American/British English spelling inconsistencies. - Other minor fixes spotted along the way, including typo fixes with codespell. - Don't specify `@GlobalScope` for `enum` and `constant`.
2022-10-30Merge pull request #67923 from Calinou/doc-displayserverMax Hilbrunner
Document the DisplayServer class
2022-10-27Fix OS.get_video_adapter_driver_info crashzCubed3
2022-10-27Document the DisplayServer classHugo Locurcio
This also adds a link to the Command line tutorial on pages that reference command line arguments, as the page covers some general usage tips for CLI arguments (especially on macOS).
2022-10-11Merge pull request #67244 from RandomShaper/split_render_further_2Rémi Verschelde
Polish rendering driver refactor further (take 2)
2022-10-11Polish rendering driver refactor further (take 2)Pedro J. Estébanez
2022-10-11Merge pull request #66102 from MJacred/feature/getvideoadapterdriverinfoRémi Verschelde
Fetch video adapter driver name and version from OS
2022-10-11Fetch video adapter driver name and version from OS on Linux/*BSD and WindowsMJacred
2022-10-04Remove reference in OS to date and time functionsAndrew Woodward
Since they moved to Time
2022-10-03Merge pull request #66803 from akien-mga/core-remove-NO_THREADSRémi Verschelde
Remove `NO_THREADS` fallback code, Godot 4 requires thread support
2022-10-03Merge pull request #65751 from Faless/os/4.x_expose_read_from_stdinRémi Verschelde
2022-10-03Remove NO_THREADS fallback code, Godot 4 requires thread supportRémi Verschelde
This also removes `OS::can_use_threads` from the public API since it's always true.
2022-09-29Fix missing "s" at the end of word in `OS.move_to_trash()` descriptionVictor Karp
Change "Do not use it for files in res:// as it will not work in exported project." to "[...] projects."
2022-09-19Add new C# code blocks to class ref pagesPaul Joannon
- AStarGrid2D - Engine - Font - Node - OS - Tweens
2022-09-19Replace File/Directory with FileAccess/DirAccesskobewi
2022-09-16Add get_distribution_name() and get_version() to OSMJacred
supports: LinuxBSD, Windows, macOS, iOS, Android, UWP Co-authored-by: bruvzg
2022-09-13[OS] Expose get_stdin_string to Scripting.Fabio Alessandrelli
Exposed as read_string_from_stdin so it's clear it's not retrieving a property. The method is kept with the block parameter, but a note is added to the docs specifying that is not implemented on any platform (should we just remove it?).
2022-08-29Merge pull request #65031 from akien-mga/os-drop-obsolete-resource-debuggingRémi Verschelde
2022-08-29Drop obsolete resource usage debug methods from OS classRémi Verschelde
These methods exist since the dawn of (open source) Godot and have hardly been updated over time, so they barely work and I'm fairly sure nobody is using them. (See #46505 for details.) While some of the functionality they aimed to provide might be useful for optimization work and introspection, this should likely be redesigned from scratch with a cleaner and more modern interface (e.g. exposed via the Performance singleton, or ResourceLoader, and a better API overall).
2022-08-29[Web] Rename JavaScript platform to Web.Fabio Alessandrelli
Also rename export name from "HTML5" to "Web".
2022-08-18Remove unimplemented `OS.dump_memory_to_file()` methodHugo Locurcio
This method never did anything in Godot since 3.0, since its code was commented out. The last time the method had an implementation was in Godot 2.1.x.
2022-08-15[doc] Use "param" instead of "code" to refer to parameters (5)Andy Maloney
2022-08-08Rename the argument tag to param in XML documentationYuri Sizov
2022-08-01Expose the "restart on exit" OS functionalityHugo Locurcio
This can be used to restart a project with specific command line arguments applied. This can work in tandem with `OS.get_cmdline_args()` to restart with the same command line arguments as used to originally run the project. Example use cases: - Restart to apply an user setting change that requires a restart to work. - Restart with a Godot command line argument to change the video driver, audio driver, etc.
2022-08-01Add support for command-line user arguments.Juan Linietsky
Implements the standard Unix double dash (--) commandline argument: * Arguments after a double dash (--) are ignored by Godot and stored for the user. * User can access them via `OS.get_cmdline_user_args()` Example: `godot.exe scene_to_run.tscn --fullscreen -- --start-level 2`
2022-07-26Implement support for loading system fonts on Linux, macOS / iOS and Windows.bruvzg
2022-06-19Merge pull request #60798 from Calinou/doc-os-cmdline-argsRémi Verschelde
2022-06-13Improve description of move_to_trash()kobewi
2022-06-08i18n: Misc fixes translation stringsRémi Verschelde
Adds some translator comments to solve some questions raised on Weblate.
2022-05-05Handle CLI arguments without a value in `OS.get_cmdline_args()` exampleHugo Locurcio
Command lines such as `--host --address 127.0.0.1` are now parsed as `{"host": "", "address": "127.0.0.1"}`.
2022-05-03Add OS::is_process_running function.mdavisprog
Adds the is_process_running function to the native OS class and exposes it to script. This is implemented on Windows and Unix platforms. A stub is provided for other platforms that do not support this function. Documentation is updated to reflect new API function.
2022-04-27Expose move_to_trash()kobewi
2022-04-22improve OS.get_name classref, misc/scripts fixes, remove trailing quoteNathan Franke
2022-02-15Add an `OS.get_processor_name()` methodHugo Locurcio
This method can be used to get the CPU model name. It can be used in conjunction with `RenderingServer.get_video_adapter_name()` and `RenderingServer.get_video_adapter_vendor()` for annotating benchmarks and automatic graphics quality configuration.