4a991887bf
Silence `Input.vibrate_handheld()` warning as it's already documented
...
The warning causes messages to be spammed if you are calling this
method in a game that runs on both desktop and mobile platforms,
unless you guard all calls to `Input.vibrate_handheld()` with
`OS.has_feature("mobile") or OS.has_feature("web")`.
Since the limitation is already documented (and is obvious enough
given the method's name), the warning message is redundant.
2022-12-16 01:12:20 +01:00
f7c611ab71
Style: Misc docs and comment style and language fixes
...
- 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-11-02 19:01:18 +01:00
0fce78355d
Document the DisplayServer class
...
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-27 18:24:55 +02:00
d20b32186f
[Web] Rename JavaScript platform to Web.
...
Also rename export name from "HTML5" to "Web".
2022-08-29 11:52:00 +02:00
ea2192b99e
[doc] Use "param" instead of "code" to refer to parameters (6)
2022-08-12 12:07:53 -04:00
c5d7115038
Rename the argument tag to param in XML documentation
2022-08-08 22:34:31 +03:00
130e715ab9
HTML5: Add support for `Input.vibrate_handheld()`
2022-07-27 22:54:41 +03:00
00b3822306
Input: Re-enable input accumulation by default
...
I turned it off by mistake in #38697 .
See also #62664 for details on this boolean's complex history :)
2022-07-03 12:16:16 +02:00
ecde7ce834
Merge pull request #61669 from fire-forge/input
...
Make Input `mouse_mode` and `use_accumulated_input` properties
2022-06-04 15:52:34 +02:00
f16c33fff6
Make Input mouse_mode and use_accumulated_input properties
2022-06-03 14:19:38 -05:00
3e53afd52c
Add array element type to `get_connected_joypads`
2022-06-03 20:37:46 +02:00
ffd5362187
Swap the meaning of CURSOR_WAIT and CURSOR_BUSY
2022-05-14 10:13:42 +08:00
74ae1ec545
doc: Update iOS hint for Input.vibrate_handheld after #60397
2022-04-27 09:45:44 +02:00
0494e024d8
Rename warp mouse functions to warp_mouse
2022-03-27 14:12:01 +02:00
ea20049afc
Ensure minimum modifiers are pressed when matching actions
2022-03-20 08:02:54 +00:00
b68dd2e189
Add an XML schema for documentation
...
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-02-15 00:03:31 +01:00
bf0253bab9
Merge pull request #56764 from madmiraal/fix-45592-2
2022-02-03 18:10:30 +01:00
3dc1fad262
Expand description for warp_mouse_position method
...
Add more detail to the description for the warp_mouse_position method, clarifying that the vector is in screen coordinates and relative to an origin at the top of the game window.
2022-02-03 10:11:25 +11:00
5d17fe7d0f
Add `Input.is_anything_pressed` method
2022-01-20 20:55:14 +02:00
5c3600b29f
Fix mouse velocity not changing fast enough
...
- Uses all accumulated movements when calculating velocity
- Discards old accumulated movements
- Sets last mouse velocity to zero when there is no movement
2022-01-13 18:51:34 +00:00
46624388d4
Merge pull request #56322 from madmiraal/fix-42450
2022-01-11 11:33:59 +01:00
d01e22f187
Document keyboard ghosting caveats in Input and InputEvent
...
This also adds recommendations for choosing between
`is_physical_key_pressed()` and `is_key_pressed()`.
2022-01-05 02:55:25 +01:00
3105d9b1f3
Rename speed to velocity when it's a directional Vector
2021-12-29 15:35:26 +00:00
cb2bdcd286
Unexpose joy_connection_changed method
2021-12-06 13:10:17 +01:00
9877d91c4a
Add Input.is_physical_key_pressed method.
2021-11-23 11:14:19 +02:00
6c1bd4d227
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 13:02:21 +01:00
3c0fdcc8ac
Use "enum class" for input enums
2021-11-12 15:37:54 -06:00
6c35e74228
Merge pull request #53812 from RandomShaper/expose_flush_input
2021-10-22 17:20:33 +02:00
6dc3fae201
Expose Input::flush_buffered_events()
2021-10-22 14:28:48 +02:00
9b38e04fff
Exposed setters for sensor values in Input class
2021-10-12 23:26:03 +03:00
294acad796
Merge pull request #53472 from akien-mga/doc-update-tutorial-links
2021-10-06 14:59:36 +02:00
862994a8ef
doc: Update links to latest documentation after content reorganization
2021-10-06 13:48:48 +02:00
92a53f9bd6
Change dragging cursor on Windows
2021-10-06 13:13:42 +02:00
fa3a32a2d6
Use Key enum instead of plain integers
2021-08-10 16:26:55 -05:00
7adf4cc9b5
doc: Use self-closing tags for `return` and `argument`
...
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-30 15:29:52 +02:00
55206ecb76
Add Input documentation for `exact_match`
2021-07-30 15:21:35 +02:00
9787e631aa
Fix miscellaneous doc typos and inconsistencies
...
This pull request fixes an assortment of typos, improves conciseness, and enhances clarity.
2021-07-22 14:01:39 -04:00
0ce49800ac
Use mouse and joypad enums instead of plain integers
...
Also MIDIMessage
2021-06-20 11:54:24 -04:00
0ff4095b36
Better format arguments in variant parser
2021-06-18 00:06:40 -03:00
98aa3b669e
Add MOUSE_MODE_CONFINED_HIDDEN
...
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2021-06-03 11:44:28 -04:00
a5324787c8
Rename some more global enums (Key, Joy, MIDI)
2021-03-23 07:13:23 -04:00
8455e901f3
class reference proofreading
2021-03-19 13:21:20 +01:00
fda2743fef
Converted sensor acceleration units to m/s^2 on iOS and UWP
...
This is beacuse on Android these values are already in m/s^2 while on
iOS and UWP they are in g. This just makes the behaviour consistent on
all platforms.
2021-03-17 14:05:05 +01:00
d1798b235c
Document different unit of measurement for sensor data on iOS and Android
2021-03-16 23:06:40 +01:00
0d1d719178
doc: Sync classref with current source
...
And fix various bogus bindings following previous PRs.
2021-02-19 14:39:14 +01:00
2d0fda3ca2
doc: Mention iOS support for Input gravity/gyroscope sensors
...
It has been implemented for iOS a long time ago already with #7127 .
2020-11-27 12:01:08 +01:00
5a01c2a3b0
Docs: Port Code Examples to C# (F, G, H, I, J, K, L)
...
Includes:
* File
* Geometry2D
* HashingContext
* HTTPClient
* HTTPRequest
* Image
* Input
* int
* ItemList
* JSONParseResult
* KinematicBody2D
* LineEdit
Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2020-11-25 22:15:13 +01:00
59fdfc77e8
doc: Sync classref with current source
2020-11-23 23:44:44 +01:00
4abf189e36
Allow getting Input axis/vector values by specifying multiple actions
...
For get_vector, use raw values and handle deadzones appropriately
2020-11-11 06:02:44 -05:00
439be614f4
Link to demos from within the class reference
2020-10-01 23:57:21 -04:00
Hugo Locurcio
Rémi Verschelde
Fabio Alessandrelli
Andy Maloney
Yuri Sizov
pattlebass
Rémi Verschelde
FireForge
Raul Santos
Haoyu Qiu
Markus Sauermann
Marcel Admiraal
TechnicalSoup
Andrii Doroshenko (Xrayez)
kobewi
bruvzg
Aaron Franke
Pedro J. Estébanez
Дмитрий Сальников
Nicholas Huelin
Michael Alexsander Silva Dias
Paul Joannon
Marcus Brummer
HaSa1002