Andy Maloney
4dda62f591
Fix spelling & grammar in comments, docs, and messages
2020-07-21 15:17:23 -04:00
Andrii Doroshenko (Xrayez)
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
Rémi Verschelde
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
Rémi Verschelde
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
Emmanuel Leblond
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
Rémi Verschelde
0b8cb945cf
doc: Sync classref with current source
2020-05-20 15:29:37 +02:00
bruvzg
d0b5174b6a
[Windows] Add tablet driver selection.
2020-05-20 09:37:32 +03:00
Hugo Locurcio
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
Rémi Verschelde
e5033d3952
doc: Sync classref with DisplayServer/Window changes
2020-03-31 11:56:58 +02:00
Rémi Verschelde
471271b727
doc: Sync classref with current source
2020-03-09 10:13:45 +01:00
bruvzg
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
Rémi Verschelde
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
Rémi Verschelde
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
Rémi Verschelde
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
muiroc
e51c6a0d28
Allow per pixel transparency in javascript platform
2020-02-10 14:27:30 +01:00
clayjohn
57e27683ba
Update docs to version 4.0
2020-01-31 17:15:41 -08: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
Rémi Verschelde
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
Poommetee Ketson
2c22c9dcfb
[DOCS] clarify that OS.get_user_data_dir needs project name
...
[ci skip]
2018-02-24 17:15:06 +07:00
Rémi Verschelde
fee29570d0
doc: Sync classref with current source
2018-02-19 10:47:16 +01:00
Rémi Verschelde
3c7a39b40c
doc: Update version string in header
2018-02-19 10:46:33 +01:00
geequlim
5980bef672
OSX: implement OS.get_unique_id
...
Update the documentations for OS.get_unique_id()
2018-02-01 23:29:39 +08:00
Rémi Verschelde
d516aab8fa
doc: Sync with current source
...
Also enhance RigidBody docs as per https://github.com/godotengine/godot-docs/pull/1018
and fix the version tag in all files (not really stable yet, but it makes no sense
to hardcode rc3 at this stage).
2018-01-25 08:50:56 +01:00
Todd Ross
b57dcf446e
clarify OS.execute usage, add examples
2018-01-20 18:36:00 -06:00
Rémi Verschelde
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +01:00
Bojidar Marinov
ad79c70300
Update docs
...
[ci skip]
2018-01-12 00:58:22 +02:00
Rémi Verschelde
7dfba3cda9
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
Rémi Verschelde
bc75fae579
doc: Update header version for 3.0-beta
2017-11-24 09:16:52 +01:00
Rémi Verschelde
15ada56d73
doc: Sync classref with current source
2017-11-24 09:16:27 +01:00
Rémi Verschelde
73049d115e
Rename OS::get_data_dir to OS::get_user_data_dir
...
Will be needed to avoid confusion with system data path (XDG_DATA_HOME)
and editor data dir in upcoming refactoring.
2017-11-17 20:55:09 +01:00
Rémi Verschelde
967bfb0c4a
doc: Remove revision.module_config from version string
...
It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}",
limits unnecessary diffs.
2017-11-15 20:41:16 +01:00
Max Hilbrunner
a897be5a04
[DOCS] OS.get_unique_string().
2017-11-08 05:18:41 +01:00
N0hbdy
f3fc07272c
Add Colemak keybindings to editor for osx
2017-10-30 22:51:02 +01:00
Rémi Verschelde
b1f2c31a36
doc: Sync classref with current source
...
Ensure that s/fixed_process/physics_process/ is handled properly.
[ci skip]
2017-10-11 23:55:04 +02:00
David Saltares
ee513aba44
[DOCS] - Completes the docs for the OS class
2017-10-10 20:51:58 +01:00
Nathan Lovato
d08f7ee7bf
Merge pull request #11793 from NathanWarden/updated_os_doc
...
Updated some documentation for the OS class.
2017-10-03 18:52:43 +02:00
Nathan Warden
0b3a49ef18
Updated some documentation for the OS class.
2017-10-03 09:30:04 -05:00
Leon Krause
7b23665e72
Add OS::is_userfs_persistent to check user:// persistence
...
Allows starting HTML5 export when IndexedDB is not available.
2017-10-02 21:07:05 +02:00
Rémi Verschelde
574a5714dc
doc: Sync classref and escape comparators
...
[ci skip]
2017-09-17 18:57:17 +02:00
Rémi Verschelde
62cb43bb8d
doc: Sync classref with current source
...
[ci skip]
2017-09-16 01:46:29 +02:00
Juan Linietsky
4f929a0fdf
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will
...
recognize them.
2017-09-12 17:45:41 -03:00