summaryrefslogtreecommitdiff
path: root/doc/classes/OS.xml
AgeCommit message (Collapse)Author
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.
2022-02-15Add an XML schema for documentationHugo Locurcio
This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-01-27Minor typo fixups to Windows console changesMax Hilbrunner
2022-01-17[Documentation] Add instruction how to execute built-in commands of various ↵bruvzg
shells.
2022-01-17Merge pull request #56012 from bruvzg/wt🤎4Rémi Verschelde
2021-12-26State that get static memory usage only works in debugskyace65
2021-12-18[Windows] Improve console handling and execute/create_process.bruvzg
Always build with the GUI subsystem. Redirect stdout and stderr output to the parent process console. Use CreateProcessW for blocking `execute` calls with piped stdout and stderr (prevent console windows for popping up when used with the GUI subsystem build, and have more consistent behavior with `create_process`). Add `open_console` argument to the `execute` and `create_process` to open a new console window. Remove `interface/editor/hide_console_window` editor setting. Remove `Toggle System Console` menu option. Remove `set_console_visible` and `is_console_visible` functions.
2021-12-15Fix OS.get_name and OS.get_user_data_dir documentationNathan Franke
2021-12-03Add an `OS.crash()` method for testing system crash handlerHugo Locurcio
This makes it possible to test the system's crash handler without having to modify engine code or exploit an engine bug.
2021-11-20Merge pull request #54932 from briansemrau/expose-main-thread-idRémi Verschelde
2021-11-15Replace Godot docs URL with `$DOCS_URL` in XML class referenceRémi Verschelde
2021-11-12Expose Thread::get_main_id in core bindingsBrian Semrau
2021-11-12Use "enum class" for input enumsAaron Franke
2021-11-01[macOS] Add `create_instance` function to spawn editor copies.bruvzg
[macOS] Modify `create_project` function to detect and run app bundles using NSWorkspace to ensure app window is registered and activated correctly.
2021-10-31Use OpenGL 3.3 core profile instead of compatibility profileClay John
- Rename OpenGL to GLES3 in the source code per community feedback. - The renderer is still exposed as "OpenGL 3" to the user. - Hide renderer selection dropdown until OpenGL support is more mature. - The renderer can still be changed in the Project Settings or using the `--rendering-driver opengl` command line argument. - Remove commented out exporter code. - Remove some OpenGL/DisplayServer-related debugging prints.
2021-10-30Rename GLES2 driver to OpenGL to prepare for the upgrade to GLES3Hugo Locurcio
- Use lowercase driver names for the `--rendering-driver` command line argument.
2021-10-22Replace remaining usages of yield with new await keywordDuroxxigar
2021-10-01Implement TextServer GDExtension interface, remove TextServer GDNative ↵bruvzg
interface.
2021-09-27[macOS, sandbox] Add export option to embed and sign helper executables.bruvzg
2021-09-21Merge pull request #52877 from Calinou/add-print-verboseRémi Verschelde
Add `print_verbose()` built-in function to print in verbose mode only
2021-09-21Add `print_verbose()` built-in function to print in verbose mode onlyHugo Locurcio
This can be used as a shorthand for: if OS.is_stdout_verbose(): print("...") Unlike `print_debug()`, this works in release builds too and can be toggled off in debug builds.
2021-09-21Document how to delay code execution in a non-blocking mannerHugo Locurcio
2021-09-16Implement `OS::get_locale_language()` helper methodRémi Verschelde
This method extracts the 2 or 3-letter language code from `OS::get_locale()`, making it easier for users to identify the "main" language code for users that might have different OS locales due to different OS or region, but should be matched to the same translation (e.g. "generic" Spanish). Fixes #40703.
2021-08-16Add partial support for Android scoped storage.ne0fhyk
This is done by providing API access to app specific directories which don't have any limitations and allows us to bump the target sdk version to 30. In addition, we're also bumping the min sdk version to 19 as version 18 is no longer supported by Google Play Services and only account of 0.3% of Android devices.
2021-07-30doc: Use self-closing tags for `return` and `argument`Rémi Verschelde
For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-23Merge pull request #50747 from bruvzg/move_alert_to_osRémi Verschelde
Move `alert` function from `DisplayServer` to `OS`.
2021-07-23Fix doc typosNicholas Huelin
This pull request fixes an assortment of typos and improves conciseness in `Animation`, `Area2D`, `Array`, `ArrayMesh`, `Control`, `Directory`, `EditorPlugin`, `Engine`, and `OS`.
2021-07-22Move `alert` function from `DisplayServer` to `OS`.bruvzg
2021-07-22Fix msec documentation description typoDistrikt64
2021-06-19Expose OS data directory getter methodsHugo Locurcio
This can be used by editor plugins and non-game applications to store data in the correct directories according to the XDG Base Directory specification.
2021-06-18Better format arguments in variant parserMichael Alexsander Silva Dias
2021-06-11Add Time singletonAaron Franke
2021-06-10Add OS.get_external_data_dir() to get Android external directoryMarcel Admiraal
2021-05-24OS: Better validation of invalid input for get_unix_time_from_datetimeRémi Verschelde
Default missing keys to Unix time 0 (1970-01-01 at 00:00:00 UTC). Abort if year <= 0, this is not supported by the current algorithm. Prevents an infinite loop further down. Fixes #49022.
2021-05-20Fix typos with codespellRémi Verschelde
Using codespell 2.0.0. Method: ``` $ cat > ../godot-word-whitelist.txt << EOF ang curvelinear dof doubleclick fave findn GIRD leapyear lod merchantibility nd numer ois ony que seeked synching te uint unselect webp EOF $ codespell -w -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po" $ git diff // undo unwanted changes ```
2021-05-09Document caveats of `OS.get_unique_id()`Hugo Locurcio
2021-05-07Implement the `%command%` placeholder in the Main Run Args settingHugo Locurcio
This can be used to tell Godot to run an executable that will run Godot rather than running Godot directly. This is useful to make Godot start on the dedicated GPU when using a NVIDIA Optimus setup on Linux: `prime-run %command%` The `editor/run/main_run_args` setting declaration was moved to make it visible in the ProjectSettings documentation.