8455e901f3
class reference proofreading
2021-03-19 13:21:20 +01:00
1e820b3d9d
[46188] fix: get unix from datetime when empty dict
2021-03-12 09:27:21 +01:00
60d2c1fd47
Remove GDScript bindings for OS.get/set_exit_code, SceneTree.quit(<exit_code>) should be used instead
2021-02-25 18:34:50 +01:00
355803db1b
Improve the `OS.get_environment()`/`OS.set_environment()` documentation
2021-02-25 15:38:51 +01:00
4c8f5b998f
Expose set_environment to GDScript
2021-02-25 23:36:14 +11:00
76f1f9b3c5
Don't allow negative values for `OS.delay_usec()`/`OS.delay_msec()`
...
This closes #46190 .
2021-02-18 23:01:45 +01:00
3e0262509f
Move tablet driver API from OS to DisplayServer.
2021-02-18 17:12:24 +02:00
fb01d057af
doc: Sync classref with current source
2021-01-28 11:26:37 +01:00
d6765c8d8b
Merge pull request #44732 from Calinou/os-add-get-thread-caller-id
...
Add an `OS.get_thread_caller_id()` method
2021-01-26 15:54:25 +01:00
2a74b388d0
Split OS::execute into two methods
...
1. execute(): Executes a command and returns the results.
2. create_process(): Creates a new process and returns the new process' id.
2021-01-09 10:03:23 +00:00
35b046ddf7
Add an `OS.get_thread_caller_id()` method
...
This can be used to print thread IDs in logs. This can make it easier
to debug multi-threaded applications.
Co-authored-by: Khaos <khaos@khaos-coders.org>
2020-12-27 16:54:18 +01:00
49741d9464
Add important note about OS.get_unixtime.
...
Should NEVER be used for precise time computations since its return
values are not guaranteed to be monotonic.
2020-12-13 13:56:45 +01:00
37d0d757d6
Merge pull request #40708 from bruvzg/improve_os_locale
...
Improve `OS::get_locale()` and documentation.
2020-12-10 11:49:00 +01:00
a3df26e554
Docs: Port Code Examples to C# (M, N, O, P, R)
...
Includes:
* MarginContainer
* NavigationPolygon
* Node
* NodePath
* OS
* PackedByteArray
* PackedScene
* PacketPeerUDP
* PCKPacker
* Performance
* PhysicsShapeQueryParameters2D
* PhysicsShapeQueryParameters3D
* PrimitiveMesh
* ProjectSettings
Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2020-11-09 10:05:53 +01:00
439be614f4
Link to demos from within the class reference
2020-10-01 23:57:21 -04:00
819c3524a5
OS: Remove unused get_splash_tick_msec
...
It was added in 3e20391bf6
2020-09-24 15:40:30 +02:00
f797e1c078
Improve `OS::get_locale()` on macOS and Windows, replace "-" with "_" and use system macros instead of bitwise AND. Add locale format info to the documentation.
2020-08-11 13:19:19 +03:00
932b75e247
doc: Sync classref with current source
2020-07-28 01:08:44 +02:00
a5fb445121
Merge pull request #40450 from asmaloney/spelling
...
Fix spelling & grammar in comments, docs, and messages
2020-07-21 22:14:04 +02:00
4dda62f591
Fix spelling & grammar in comments, docs, and messages
2020-07-21 15:17:23 -04:00
df80e259cd
Document the process of parsing command-line arguments
...
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2020-07-20 12:09:46 +03:00
efcc508ee5
Move Haiku platform port to external repository
...
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-20 17:59:41 +02:00
ba0db95909
DocData: Skip language-specific ClassDoc without methods/constants
...
Removes the useless `@C#`, `@NativeScript` and `@VisualScript` entries.
2020-06-17 15:09:07 +02:00
c6de3872f9
Remove OS.get_system_time_secs/get_system_time_msecs and change OS.get_unix_time return type to double
2020-05-31 14:19:31 +02:00
0b8cb945cf
doc: Sync classref with current source
2020-05-20 15:29:37 +02:00
d0b5174b6a
[Windows] Add tablet driver selection.
2020-05-20 09:37:32 +03:00
d46e411b44
Warn when trying to open `res://` or `user://` with `OS.shell_open()`
...
`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-04-28 19:37:09 +02:00
e5033d3952
doc: Sync classref with DisplayServer/Window changes
2020-03-31 11:56:58 +02:00
471271b727
doc: Sync classref with current source
2020-03-09 10:13:45 +01:00
1af06d3d46
Rename `scancode` to `keycode`.
...
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-25 12:30:33 +02:00
213a85521d
doc: Sync classref with current source
...
Handle removal of Pool*Array types and other recent changes.
2020-02-18 14:02:02 +01:00
3dea5fd631
Remove incomplete battery status/power API
...
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-14 13:43:32 +01:00
386968ea97
Remove obsolete GLES3 backend
...
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-13 10:36:44 +01:00
e51c6a0d28
Allow per pixel transparency in javascript platform
2020-02-10 14:27:30 +01:00
57e27683ba
Update docs to version 4.0
2020-01-31 17:15:41 -08:00
2d20fc39aa
doc: Drop unused 'category' property from header
...
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-26 16:02:39 +01:00
7a0c37c3f5
Document how to get a human-readable string from an InputEventKey
2020-01-25 20:13:18 +01:00
90a1f8d8a7
Make `OS.execute()` blocking by default if not specified
...
This makes `OS.execute()` calls quicker to set up when calling programs
in a blocking fashion.
2020-01-23 01:26:32 +01:00
ab97f78fa5
Revert "Enable Vsync via Compositor by default"
...
This reverts commit 9600fd5ddeFixes #35038 .
2020-01-13 09:33:27 +01:00
74ae1ca616
Improve the `OS.is_debug_build()` documentation
2020-01-10 15:26:47 +01:00
9600fd5dde
Enable Vsync via Compositor by default
...
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-09 22:22:11 +01:00
8454804972
Merge pull request #33967 from Calinou/add-os-is-window-focused
...
Add an `OS.is_window_focused()` getter
2020-01-06 11:39:18 +01:00
cc626acf45
Add a shorthand for setting the exit code using `SceneTree::quit()`
...
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.
2020-01-03 11:41:46 +01:00
d441a6aefa
Print a warning message if `OS.exit_code` is set to a non-portable value
...
This also improves the related documentation.
2019-12-29 16:56:22 +01:00
e1dda5195c
Added support for vertical syncing via the Windows OS compositor (DWM.)
2019-12-04 11:14:21 +01:00
0aebba2388
[ci skip] OS class documentations, adds platform compatibility notes.
2019-12-03 18:14:14 +02:00
21a3923410
Add an `OS.is_window_focused()` getter
...
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-28 16:42:51 +01:00
e6d53ba75f
Expose the `OS.low_processor_usage_mode_sleep_usec` property
...
This makes it possible to change it at runtime in projects.
2019-11-08 18:53:25 +01:00
1e07ab8564
Added documentation for the OS class MIDI functions.
2019-10-31 16:52:55 +00:00
aa0fa6b14f
doc: Sync classref with current source
2019-10-26 16:40:41 +02:00
0088385556
Add request permission automatically at android
2019-10-22 22:52:13 +03:00
5c2bb56979
Improve the OS `get_screen_*` methods' documentation
2019-10-08 15:43:01 +02:00
b4c927b514
Added an exit code to the blocking mode of OS::execute
...
Updated documentation accordingly.
Fixes #31881 .
2019-09-26 08:12:07 +02:00
5c0de2c249
Merge pull request #32286 from Calinou/doc-improve-os-shell-open
...
Improve the `OS.shell_open()` documentation
2019-09-24 10:29:04 +02:00
5d676682b4
Improve the `OS.shell_open()` documentation
...
This adds a `mailto:` example to `OS.shell_open()`.
2019-09-23 18:37:47 +02:00
c99d80b414
Mention performance caveats of `OS.set_window_title()`
...
See #32254 .
2019-09-22 19:01:34 +02:00
db6d4352ea
[macOS] Add methods to modify global and dock menus. Add ability to open multiple editor/project manager instances, recent/favourite project list to project manager dock menu and opened scene list to editor dock menu.
2019-08-26 16:45:49 +03:00
5f68ae93b5
Clarify what %APPDATA% expands to in Windows
...
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-07-09 04:42:42 -04:00
0db138a621
doc: Enforce default values for OS properties
...
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-30 13:58:07 +02:00
a78373ddc2
doc: Remove null default values that can't be determined
...
Applying #30187 .
2019-06-30 13:58:07 +02:00
c6cea6e9b3
doc: Add default values to all properties
...
Thanks to @bojidar-bg's impressive work in #29380 .
2019-06-30 13:58:07 +02:00
f2fd5dfb91
Added descriptions to OS.get_splash_tick_msec() and OS.get_window_safe_area()
2019-06-29 17:21:25 +05:30
f7f6115f76
Proofread and improve the whole class reference
...
- 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-27 22:30:19 +02:00
71d53637b5
doc: Fix scoped hyperlinks to same-class enums/methods
...
The class name does not need to be specified when it is the current class.
2019-06-27 11:44:37 +02:00
867dda1124
doc: Proofread and complete various nodes
...
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-26 23:05:51 +02:00
9eeead4be3
Remove references to mouse stuff from OS
...
There is nothing in `OS` about mouse grabbing or mouse cursors, that's in `Input`, so I'm cleaning up those references.
2019-06-24 19:28:49 -07:00
054ac5c8f5
doc: Sync classref with current source
...
Fix a few bugs.
2019-06-18 15:07:31 +02:00
0d61fc2c0f
Merge pull request #29752 from bruvzg/window_size_limits
...
Add ability to limit maximum/minimum window size.
2019-06-17 11:58:00 +02:00
b924fb97d6
Add ability to limit maximum/minimum window size.
2019-06-15 09:49:11 +03:00
349e924cad
Changes to OS.has_feature() docs:
...
- Added link to the Feature Tags documentation
- Added note that tag names are case-sensitive
2019-06-14 16:35:54 +02:00
0e6cac8ab8
Merge pull request #29465 from bruvzg/per_pixel_transp_impr
...
Removes redundant "splash" setting, improves per pixel transparency documentation.
2019-06-12 12:50:17 +02:00
8ff72987c0
[macOS] Fixes unicode input with IME mode inactive, Improves IME mode documentation.
2019-06-04 11:29:00 +03:00
54863b20e6
Removes redundant "display/window/per_pixel_transparency/splash" setting, improves per pixel transparency documentation.
2019-06-04 11:21:29 +03:00
3a365c1fc0
doc: Sync classref with current source
2019-05-28 18:08:13 +02:00
2b9ed68d6a
Add native window/taskbar icon support for Windows and macOS.
...
Co-authored-by: Markus Törnqvist <mjt@nysv.org>
2019-05-24 14:23:57 +03:00
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
61771ad39b
doc: Fix style for vararg in makerst
2019-03-10 11:31:27 +01:00
b22cf46fdb
Request Android record permission when needed
2019-03-08 12:38:36 -03:00
7a79eee523
Expose OS::get_current_video_driver to scripting languages
2019-02-16 14:41:07 +01:00
a15620c83e
doc: Fix wrong references found by Sphinx and new makerst.py
2019-01-07 12:15:01 +01:00
26fddb77be
doc: Fix wrong references found by new makerst.py
...
Thanks @PJB3005
2019-01-07 10:06:12 +01:00
2e39e38c10
doc: Sync classref with current source
...
Fix various code formatting issues and argument names.
2018-12-27 11:10:18 +01:00
6cdcde7114
doc: Add missing commas after "If true/false"
2018-12-20 13:47:12 +01:00
84d060c768
Added OS.get_system_time_msecs()
2018-12-20 18:50:50 +09:00
d030c17d5e
doc: Sync classref with current source
2018-12-13 15:12:25 +01:00
4554c682e6
Changes IME input to use notification instead of callback, exposes IME methods to gdscript/gdnative.
2018-11-23 14:07:48 +02:00
4de0cbba15
Expose OS::move_window_to_foreground
2018-11-07 11:51:15 -03:00
d952126caf
Fix warnings in Android platform
...
Fixes the following Clang 7 warnings:
```
platform/android/os_android.h:240:16: warning: 'OS_Android::native_video_play' hides overloaded virtual function [-Woverloaded-virtual]
platform/android/os_android.h:241:15: warning: 'OS_Android::native_video_is_playing' hides overloaded virtual function [-Woverloaded-virtual]
platform/android/audio_driver_opensl.cpp:104:3: warning: suggest braces around initialization of subobject [-Wmissing-braces]
platform/android/audio_driver_opensl.cpp:129:10: warning: unused variable 'numOutputs' [-Wunused-variable]
platform/android/audio_driver_opensl.cpp:130:11: warning: unused variable 'deviceID' [-Wunused-variable]
platform/android/java_glue.cpp:795:10: warning: unused variable 'clsio' [-Wunused-variable]
platform/android/java_glue.cpp:890:12: warning: unused variable 'gob' [-Wunused-variable]
platform/android/java_glue.cpp:592:13: warning: unused variable 'resized' [-Wunused-variable]
platform/android/java_glue.cpp:593:13: warning: unused variable 'resized_reload' [-Wunused-variable]
modules/mobile_vr/mobile_vr_interface.cpp:401:8: warning: unused variable 'aspect_ratio' [-Wunused-variable]
drivers/unix/dir_access_unix.cpp:394:2: warning: THIS IS BROKEN [-W#warnings]
```
2018-10-03 15:17:00 +02:00
9108b5fba5
doc: Fix OS.execute example (cf. #22412 )
2018-09-27 09:34:08 +02:00
5267099a87
doc: Sync classref with current source
2018-08-29 22:25:11 +02:00
391e46830f
doc: Sync classref with current source
...
Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
4705dc4f00
Expose OS.get_ticks_usec()
2018-06-18 21:03:55 +02:00
7927eb6013
doc: Remove extraneous empty lines in descriptions
2018-06-15 08:54:06 +02:00
f392650be2
Improve return value of OS.execute in blocking/non-blocking variants
...
Initialized the PID to -2, which will be the value returns in blocking-
mode where the PID is not available. (-1 was already taken to signify an
execution failure).
OS::execute will now properly return a non-OK error code when it fails
to execute the target file.
The documentation was rewritten to be very clear about the differences
between blocking and non-blocking mode.
Fixes #19056 .
2018-05-30 12:55:17 +02:00
3d9deda8b3
Sync classref with current source
2018-05-12 09:38:00 +02:00
72aa87758a
Update classref and docs, fix missing parameters' name
2018-04-11 10:20:22 +07:00
66714a3d29
[DOCS] OS
2018-04-10 17:30:34 +02:00
cb7fe2c793
doc: Sync classref with current source
2018-04-10 10:12:42 +02:00
3fa77b3172
doc: Remove status from hardcoded version string
...
It has no practical use case and just generates noise for each alpha, beta, etc.
2018-02-27 13:40:49 +01:00
Paul Joannon
Aitor Cereceto
Emmanuel Leblond
Hugo Locurcio
Bastiaan Olij
bruvzg
Rémi Verschelde
Rémi Verschelde
Marcel Admiraal
Fabio Alessandrelli
HaSa1002
Aaron Franke
Andy Maloney
Andrii Doroshenko (Xrayez)
muiroc
clayjohn
TerminalJack
Derwent Ready (drentsoft)
Cagdas
Ruslan Mullayanov
hbina085
unknown
austinried
Ken Paulson
DESKTOP-3H3MR3A\eloisa
volzhs
Marc Gilleron
Poommetee Ketson
Max Hilbrunner