summaryrefslogtreecommitdiff
path: root/doc/classes/Input.xml
AgeCommit message (Collapse)Author
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-30Add Input documentation for `exact_match`Raul Santos
2021-07-22Fix miscellaneous doc typos and inconsistenciesNicholas Huelin
This pull request fixes an assortment of typos, improves conciseness, and enhances clarity.
2021-06-20Use mouse and joypad enums instead of plain integersAaron Franke
Also MIDIMessage
2021-06-18Better format arguments in variant parserMichael Alexsander Silva Dias
2021-06-03Add MOUSE_MODE_CONFINED_HIDDENAaron Franke
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2021-03-23Rename some more global enums (Key, Joy, MIDI)Aaron Franke
2021-03-19class reference proofreadingPaul Joannon
2021-03-17Converted sensor acceleration units to m/s^2 on iOS and UWPMarcus Brummer
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-16Document different unit of measurement for sensor data on iOS and AndroidMarcus Brummer
2021-02-19doc: Sync classref with current sourceRémi Verschelde
And fix various bogus bindings following previous PRs.
2020-11-27doc: Mention iOS support for Input gravity/gyroscope sensorsRémi Verschelde
It has been implemented for iOS a long time ago already with #7127.
2020-11-25Docs: Port Code Examples to C# (F, G, H, I, J, K, L)HaSa1002
Includes: * File * Geometry2D * HashingContext * HTTPClient * HTTPRequest * Image * Input * int * ItemList * JSONParseResult * KinematicBody2D * LineEdit Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2020-11-23doc: Sync classref with current sourceRémi Verschelde
2020-11-11Allow getting Input axis/vector values by specifying multiple actionsAaron Franke
For get_vector, use raw values and handle deadzones appropriately
2020-10-01Link to demos from within the class referenceAaron Franke
2020-08-31Add link titles for all links in the class referenceHugo Locurcio
This makes them display in a nicer way in the editor help. (The title will display instead of the full URL.)
2020-08-29Merge pull request #41521 from Calinou/doc-accelerometer-platformsRémi Verschelde
Document supported platforms for `Input.get_accelerometer()` and related
2020-08-29Document supported platforms for `Input.get_accelerometer()` and relatedHugo Locurcio
This closes #41303.
2020-08-28State how 'MOUSE_MODE_CAPTURED' actually works in the 'Input' docsMichael Alexsander
2020-05-13Update game controller enums.Marcel Admiraal
2020-04-28Rename InputFilter back to InputRémi Verschelde
It changed name as part of the DisplayServer and input refactoring in #37317, with the rationale that input no longer goes through the main loop, so the previous Input singleton now only does filtering. But the gains in consistency are quite limited in the renaming, and it breaks compatibility for all scripts and tutorials that access the Input singleton via the scripting language. A temporary option was suggested to keep the scripting singleton named `Input` even if its type is `InputFilter`, but that adds inconsistency and breaks C#. Fixes godotengine/godot-proposals#639. Fixes #37319. Fixes #37690.
2020-03-30doc: Update classref with node renamesRémi Verschelde
A few extra renames for classes which were missed in last week's PRs.
2020-03-12Improve the `Input.set_use_accumulated_input()` documentationHugo Locurcio
2020-02-25Rename `scancode` to `keycode`.bruvzg
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-22doc: Sync classref with StringName/Callable changesRémi Verschelde
2020-01-31Update docs to version 4.0clayjohn
2020-01-26Merge pull request #35589 from akien-mga/doc-drop-category-propertyRémi Verschelde
doc: Drop unused 'category' property from header
2020-01-26doc: Do not expose Variant::NIL as a type in the class referenceRémi Verschelde
Fix signals Variant arguments incorrectly listed as Nil. Fixes #12520.
2020-01-26doc: Drop unused 'category' property from headerRémi Verschelde
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-23doc: Misc updates for AnimationNode* and othersRémi Verschelde
- Add some missing descriptions. - Add links to tutorials for ARVR and AnimationTree. - Style fixes. - Engine changes: * Make `AnimationNodeTransition.input_<number>` properties internal so that they don't appear in the docs. They still appear in the inspector based on the actual number of inputs requested. * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D particles in `ParticlesMaterial`, and thus only relevant for `CPUParticles3D`.
2019-12-06doc: Markup fixes for enums and constantsRémi Verschelde
2019-10-06[DOC] Fill in various missing method/member descriptions.Chris Bradfield
2019-09-20Merge pull request #32150 from luzpaz/typosRémi Verschelde
Fix misc. source comment typos
2019-09-19Fix misc. source comment typosluz.paz
Found using `codespell -q 3 -S ./thirdparty,*.po -L ang,ba,cas,dof,doubleclick,fave,hist,leapyear,lod,nd,numer,ois,paket,seeked,sinc,switchs,te,uint -D ~/Projects/codespell/codespell_lib/data/dictionary.txt `
2019-09-15Mention more caveats for custom mouse cursors in the documentationHugo Locurcio
See #32147 and #32148.
2019-08-21Merge pull request #31437 from volzhs/vibrate-mobileRémi Verschelde
Support vibration for Android and iOS
2019-08-21Support vibration for Android and iOSvolzhs
2019-08-17Clarify usage of action_pressTomasz Chabora
2019-07-30Merge pull request #30890 from KoBeWi/how_to_actionRémi Verschelde
Clarify is_action_pressed() for multiple assigned buttons
2019-07-29Fix set_default_cursor_shape always sending motion eventGuilherme Felipe
2019-07-28Clarify is_action_pressed() for multiple assigned buttonsTomasz Chabora
2019-07-11doc: Mention `Input.MOUSE_MODE_CAPTURED` is raw on Windows and LinuxHugo Locurcio
2019-06-30doc: Remove hardcoded default values from descriptionsRémi Verschelde
They are now generated automatically by doctool.
2019-06-27Proofread and improve the whole class referenceHugo Locurcio
- 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-27doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinksRémi Verschelde
2019-05-23Change "Return" to "Returns" where necessary in XML documentationSean Heffernan
In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867
2019-04-22Merge pull request #28125 from KoBeWi/code_true_codeRémi Verschelde
Consistently wrap booleans in [code]
2019-04-19doc: Sync classref with current sourceRémi Verschelde
2019-04-19doc: Drop unused <demos> tagRémi Verschelde