Hugo Locurcio
21ad630e11
Expose OS data directory getter methods
...
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-19 09:28:53 +02:00
Marcel Admiraal
6d63ccba31
Add OS.get_external_data_dir() to get Android external directory
2021-06-10 16:48:37 +01:00
Rémi Verschelde
fd4475f652
OS: Better validation of invalid input for get_unix_time_from_datetime
...
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 .
(cherry picked from commit 62efa30ed2
)
2021-06-01 12:52:18 +02:00
Rémi Verschelde
eb78f80f03
Fix typos with codespell
...
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-20 12:56:56 +02:00
Hugo Locurcio
8b06085249
Implement the `%command%` placeholder in the Main Run Args setting
...
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.
(cherry picked from commit ce4aa07276
)
2021-05-09 17:47:38 +02:00
Hugo Locurcio
cb2cb46907
Document caveats of `OS.get_unique_id()`
...
(cherry picked from commit 7350f90c57
)
2021-05-09 17:14:36 +02:00
Rémi Verschelde
e96f0ea1d7
Android: Remove non-functional native video OS methods
...
Those methods are only properly implemented for iOS.
Supersedes #43811 .
2021-05-07 16:42:17 +02:00
Rémi Verschelde
c3272997cd
doc: Update classref headers with 3.4 version
2021-04-26 13:15:29 +02:00
Rémi Verschelde
015973df04
doc: Make all tutorial links point to 3.3 branch of docs
2021-03-26 10:43:43 +01:00
kobewi
e8e69b2d50
Clarify that get_unix_time() returns seconds
...
(cherry picked from commit 6e4a8b7f37
)
2021-03-26 09:23:12 +01:00
Rémi Verschelde
1aba997d75
doc: Sync classref with 3.3 version bump
2021-03-23 13:40:34 +01:00
Aitor Cereceto
7e5020b2fa
[46188] fix: get unix from datetime when empty dict
...
(cherry picked from commit 1e820b3d9d
)
2021-03-12 10:17:41 +01:00
Hugo Locurcio
b2725cb4b9
Improve the `OS.get_environment()`/`OS.set_environment()` documentation
...
(cherry picked from commit 355803db1b
)
2021-02-25 22:38:07 +01:00
Bastiaan Olij
e9ce9a8422
Expose set_environment to GDScript
2021-02-25 22:07:38 +11:00
Hugo Locurcio
9f236d48e6
Don't allow negative values for `OS.delay_usec()`/`OS.delay_msec()`
...
This closes #46190 .
(cherry picked from commit 76f1f9b3c5
)
2021-02-19 15:52:54 +01:00
Hugo Locurcio
eb0ca31ac1
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>
(cherry picked from commit 35b046ddf7
)
2021-01-26 22:10:30 +01:00
Fabio Alessandrelli
53988c7de3
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.
(cherry picked from commit 49741d9464
)
2020-12-29 16:01:59 +01:00
Rémi Verschelde
04fb41a0f3
Merge pull request #42531 from BastiaanOlij/add_get_native_handle
...
Add get native handle
2020-10-20 13:27:07 +02:00
Bastiaan Olij
1ea7358405
Add get_native_handle to OS
2020-10-20 20:23:37 +11:00
Rémi Verschelde
4287af5148
doc: Make docs.godotengine.org links point to 3.2 branch
2020-10-19 16:10:01 +02:00
Aaron Franke
069ed4ec63
Link to demos from within the class reference
...
(cherry picked from commit 439be614f4
)
2020-10-19 16:10:01 +02:00
bruvzg
610728c9f1
[3.2] Fix `get_screen_dpi` on macOS for non fractional display scales and update documentation.
2020-10-01 22:55:54 +03:00
Rémi Verschelde
4ad74609ce
Merge pull request #40205 from bruvzg/click-through-3
...
[3.2] Add mouse event pass-through support for window.
2020-10-01 13:58:24 +02:00
Rémi Verschelde
c8859f0463
Fix typos with codespell
...
Using codespell 1.17.1.
Method:
```
$ cat > ../godot-word-whitelist.txt << EOF
ang
curvelinear
dof
doubleclick
fave
findn
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
```
2020-09-18 14:09:51 +02:00
bruvzg
e51fed9d1b
[3.2] Add window click-through support.
2020-09-17 12:36:01 +03:00
Rémi Verschelde
e82e9588fd
doc: Sync classref with current source
2020-07-28 11:50:39 +02:00
Rémi Verschelde
a2edf04fd2
Merge pull request #40469 from nekomatata/virtual-keyboard-enter-fixes-3.2
...
[3.2] Fix Return key events in LineEdit & TextEdit on Android
2020-07-26 20:26:02 +02:00
Andrii Doroshenko (Xrayez)
6416df8e34
Document the process of parsing command-line arguments
...
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
(cherry picked from commit df80e259cd
)
2020-07-24 10:31:57 +02:00
PouleyKetchoupp
c0b394572f
Fix Return key events in LineEdit & TextEdit on Android
...
Depending on the device implementation, editor actions could be
received with different action ids or not at all for multi-line.
Added a parameter to virtual keyboards to properly handle single-line
and multi-line cases in all situations.
Single-line:
Input type set to text without multiline to make sure actions are sent.
IME options are set to DONE action to force action id consistency.
Multi-line:
Input type set to text and multiline to make sure enter triggers new lines.
Actions are disabled by the multiline flag, so '\n' characters are
handled in text changed callbacks.
2020-07-17 18:25:40 +02:00
bruvzg
e9ab41b71d
[macOS, 3.2] Implement seamless display scaling.
2020-07-07 22:54:33 +03:00
Rémi Verschelde
8ac13e50cf
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.
(cherry picked from commit efcc508ee5
)
2020-06-21 21:42:26 +02:00
bruvzg
2256946f79
[3.2] Add keyboard layout enumeration / set / get functions (macOS, Windows, Linux/X11).
2020-06-13 11:01:49 +03:00
Rémi Verschelde
acb83db1d1
doc: Sync classref with current source
2020-05-25 17:00:22 +02:00
bruvzg
71b2abbfa3
[Windows, 3.2] Add tablet driver selection.
2020-05-20 09:36:56 +03:00
Hugo Locurcio
6fb6107e6a
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.
(cherry picked from commit d46e411b44
)
2020-05-01 10:56:58 +02:00
muiroc
50727d7b22
Allow per pixel transparency in javascript platform
...
(cherry picked from commit e51c6a0d28
)
2020-02-14 16:07:03 +01:00
Rémi Verschelde
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
Hugo Locurcio
7a0c37c3f5
Document how to get a human-readable string from an InputEventKey
2020-01-25 20:13:18 +01:00
Hugo Locurcio
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
Rémi Verschelde
ab97f78fa5
Revert "Enable Vsync via Compositor by default"
...
This reverts commit 9600fd5dde
.
Add comment warning about possible implications of using this option.
Fixes #35038 .
2020-01-13 09:33:27 +01:00
Hugo Locurcio
74ae1ca616
Improve the `OS.is_debug_build()` documentation
2020-01-10 15:26:47 +01:00
Hugo Locurcio
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
Rémi Verschelde
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
Hugo Locurcio
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
Hugo Locurcio
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
TerminalJack
e1dda5195c
Added support for vertical syncing via the Windows OS compositor (DWM.)
2019-12-04 11:14:21 +01:00
bruvzg
0aebba2388
[ci skip] OS class documentations, adds platform compatibility notes.
2019-12-03 18:14:14 +02:00
Hugo Locurcio
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
Hugo Locurcio
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
Derwent Ready (drentsoft)
1e07ab8564
Added documentation for the OS class MIDI functions.
2019-10-31 16:52:55 +00:00
Rémi Verschelde
aa0fa6b14f
doc: Sync classref with current source
2019-10-26 16:40:41 +02:00
Cagdas
0088385556
Add request permission automatically at android
2019-10-22 22:52:13 +03:00
Hugo Locurcio
5c2bb56979
Improve the OS `get_screen_*` methods' documentation
2019-10-08 15:43:01 +02:00
Ruslan Mullayanov
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
Rémi Verschelde
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
Hugo Locurcio
5d676682b4
Improve the `OS.shell_open()` documentation
...
This adds a `mailto:` example to `OS.shell_open()`.
2019-09-23 18:37:47 +02:00
Hugo Locurcio
c99d80b414
Mention performance caveats of `OS.set_window_title()`
...
See #32254 .
2019-09-22 19:01:34 +02:00
bruvzg
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
hbina085
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
Rémi Verschelde
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
Rémi Verschelde
a78373ddc2
doc: Remove null default values that can't be determined
...
Applying #30187 .
2019-06-30 13:58:07 +02:00
Rémi Verschelde
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
unknown
f2fd5dfb91
Added descriptions to OS.get_splash_tick_msec() and OS.get_window_safe_area()
2019-06-29 17:21:25 +05:30
Hugo Locurcio
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
Rémi Verschelde
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
Rémi Verschelde
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
austinried
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
Rémi Verschelde
054ac5c8f5
doc: Sync classref with current source
...
Fix a few bugs.
2019-06-18 15:07:31 +02:00
Rémi Verschelde
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
bruvzg
b924fb97d6
Add ability to limit maximum/minimum window size.
2019-06-15 09:49:11 +03:00
Ken Paulson
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
Rémi Verschelde
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
bruvzg
8ff72987c0
[macOS] Fixes unicode input with IME mode inactive, Improves IME mode documentation.
2019-06-04 11:29:00 +03:00
bruvzg
54863b20e6
Removes redundant "display/window/per_pixel_transparency/splash" setting, improves per pixel transparency documentation.
2019-06-04 11:21:29 +03:00
Rémi Verschelde
3a365c1fc0
doc: Sync classref with current source
2019-05-28 18:08:13 +02:00
bruvzg
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
Rémi Verschelde
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
Rémi Verschelde
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
Rémi Verschelde
61771ad39b
doc: Fix style for vararg in makerst
2019-03-10 11:31:27 +01:00
DESKTOP-3H3MR3A\eloisa
b22cf46fdb
Request Android record permission when needed
2019-03-08 12:38:36 -03:00
Rémi Verschelde
7a79eee523
Expose OS::get_current_video_driver to scripting languages
2019-02-16 14:41:07 +01:00
Rémi Verschelde
a15620c83e
doc: Fix wrong references found by Sphinx and new makerst.py
2019-01-07 12:15:01 +01:00
Rémi Verschelde
26fddb77be
doc: Fix wrong references found by new makerst.py
...
Thanks @PJB3005
2019-01-07 10:06:12 +01:00
Rémi Verschelde
2e39e38c10
doc: Sync classref with current source
...
Fix various code formatting issues and argument names.
2018-12-27 11:10:18 +01:00
Rémi Verschelde
6cdcde7114
doc: Add missing commas after "If true/false"
2018-12-20 13:47:12 +01:00
volzhs
84d060c768
Added OS.get_system_time_msecs()
2018-12-20 18:50:50 +09:00
Rémi Verschelde
d030c17d5e
doc: Sync classref with current source
2018-12-13 15:12:25 +01:00
bruvzg
4554c682e6
Changes IME input to use notification instead of callback, exposes IME methods to gdscript/gdnative.
2018-11-23 14:07:48 +02:00
Marcelo Fernandez
4de0cbba15
Expose OS::move_window_to_foreground
2018-11-07 11:51:15 -03:00
Rémi Verschelde
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
Rémi Verschelde
9108b5fba5
doc: Fix OS.execute example (cf. #22412 )
2018-09-27 09:34:08 +02:00
Rémi Verschelde
5267099a87
doc: Sync classref with current source
2018-08-29 22:25:11 +02:00
Rémi Verschelde
391e46830f
doc: Sync classref with current source
...
Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
Marc Gilleron
4705dc4f00
Expose OS.get_ticks_usec()
2018-06-18 21:03:55 +02:00
Rémi Verschelde
7927eb6013
doc: Remove extraneous empty lines in descriptions
2018-06-15 08:54:06 +02:00
Rémi Verschelde
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
Rémi Verschelde
3d9deda8b3
Sync classref with current source
2018-05-12 09:38:00 +02:00
Poommetee Ketson
72aa87758a
Update classref and docs, fix missing parameters' name
2018-04-11 10:20:22 +07:00
Max Hilbrunner
66714a3d29
[DOCS] OS
2018-04-10 17:30:34 +02:00
Rémi Verschelde
cb7fe2c793
doc: Sync classref with current source
2018-04-10 10:12:42 +02:00