Nicholas Huelin
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
Aaron Franke
0ce49800ac
Use mouse and joypad enums instead of plain integers
...
Also MIDIMessage
2021-06-20 11:54:24 -04:00
Michael Alexsander Silva Dias
0ff4095b36
Better format arguments in variant parser
2021-06-18 00:06:40 -03:00
Aaron Franke
98aa3b669e
Add MOUSE_MODE_CONFINED_HIDDEN
...
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2021-06-03 11:44:28 -04:00
Aaron Franke
a5324787c8
Rename some more global enums (Key, Joy, MIDI)
2021-03-23 07:13:23 -04:00
Paul Joannon
8455e901f3
class reference proofreading
2021-03-19 13:21:20 +01:00
Marcus Brummer
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
Marcus Brummer
d1798b235c
Document different unit of measurement for sensor data on iOS and Android
2021-03-16 23:06:40 +01:00
Rémi Verschelde
0d1d719178
doc: Sync classref with current source
...
And fix various bogus bindings following previous PRs.
2021-02-19 14:39:14 +01:00
Rémi Verschelde
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
HaSa1002
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
Rémi Verschelde
59fdfc77e8
doc: Sync classref with current source
2020-11-23 23:44:44 +01:00
Aaron Franke
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
Aaron Franke
439be614f4
Link to demos from within the class reference
2020-10-01 23:57:21 -04:00
Hugo Locurcio
c4903a603b
Add link titles for all links in the class reference
...
This makes them display in a nicer way in the editor help.
(The title will display instead of the full URL.)
2020-08-31 14:22:07 +02:00
Rémi Verschelde
6ae83b64ef
Merge pull request #41521 from Calinou/doc-accelerometer-platforms
...
Document supported platforms for `Input.get_accelerometer()` and related
2020-08-29 13:04:20 +02:00
Hugo Locurcio
eee704e6f6
Document supported platforms for Input.get_accelerometer()
and related
...
This closes #41303 .
2020-08-29 02:16:43 +02:00
Michael Alexsander
4f13a7f47f
State how 'MOUSE_MODE_CAPTURED' actually works in the 'Input' docs
2020-08-28 17:19:19 -03:00
Marcel Admiraal
e7fee711b3
Update game controller enums.
2020-05-13 10:33:32 +01:00
Rémi Verschelde
fdf58a5858
Rename InputFilter back to Input
...
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-04-28 15:19:49 +02:00
Rémi Verschelde
eaaee63b62
doc: Update classref with node renames
...
A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:23:02 +02:00
Hugo Locurcio
30961c60ab
Improve the Input.set_use_accumulated_input()
documentation
2020-03-12 14:10:10 +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
fea37cfb52
doc: Sync classref with StringName/Callable changes
2020-02-22 14:59:09 +01:00
clayjohn
57e27683ba
Update docs to version 4.0
2020-01-31 17:15:41 -08:00
Rémi Verschelde
4cee1cda5e
Merge pull request #35589 from akien-mga/doc-drop-category-property
...
doc: Drop unused 'category' property from header
2020-01-26 16:34:13 +01:00
Rémi Verschelde
09ced94dd4
doc: Do not expose Variant::NIL as a type in the class reference
...
Fix signals Variant arguments incorrectly listed as Nil.
Fixes #12520 .
2020-01-26 16:08:11 +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
Rémi Verschelde
ba177ccaec
doc: Misc updates for AnimationNode* and others
...
- 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`.
2020-01-23 12:37:33 +01:00
Rémi Verschelde
4eff13d768
doc: Markup fixes for enums and constants
2019-12-06 23:09:20 +01:00
Chris Bradfield
72b43d5ed6
[DOC] Fill in various missing method/member descriptions.
2019-10-06 16:26:15 -07:00
Rémi Verschelde
fdc2463a1b
Merge pull request #32150 from luzpaz/typos
...
Fix misc. source comment typos
2019-09-20 17:09:05 +02:00
luz.paz
91ecd7b6a6
Fix misc. source comment typos
...
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-19 14:36:52 -04:00
Hugo Locurcio
40dd544994
Mention more caveats for custom mouse cursors in the documentation
...
See #32147 and #32148 .
2019-09-15 21:14:40 +02:00
Rémi Verschelde
1a4dbd9ee2
Merge pull request #31437 from volzhs/vibrate-mobile
...
Support vibration for Android and iOS
2019-08-21 21:10:22 +02:00
volzhs
4061e5bb75
Support vibration for Android and iOS
2019-08-21 23:38:53 +09:00
Tomasz Chabora
b950867df8
Clarify usage of action_press
2019-08-17 23:20:06 +02:00
Rémi Verschelde
14e3d29f0c
Merge pull request #30890 from KoBeWi/how_to_action
...
Clarify is_action_pressed() for multiple assigned buttons
2019-07-30 00:07:49 +02:00
Guilherme Felipe
508761e0cd
Fix set_default_cursor_shape always sending motion event
2019-07-29 14:00:37 -03:00
Tomasz Chabora
7e329a7251
Clarify is_action_pressed() for multiple assigned buttons
2019-07-28 15:37:08 +02:00
Hugo Locurcio
f4e99e2e39
doc: Mention Input.MOUSE_MODE_CAPTURED
is raw on Windows and Linux
2019-07-11 01:21:41 +02:00
Rémi Verschelde
b9aa13e591
doc: Remove hardcoded default values from descriptions
...
They are now generated automatically by doctool.
2019-06-30 13:58:07 +02:00
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
bc82781f7d
doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks
2019-06-27 13:49:36 +02:00
Sean Heffernan
426bcc9941
Change "Return" to "Returns" where necessary in XML documentation
...
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-05-23 21:11:24 -07:00
Rémi Verschelde
ab4705a807
Merge pull request #28125 from KoBeWi/code_true_code
...
Consistently wrap booleans in [code]
2019-04-22 11:59:16 +02:00
Rémi Verschelde
268b520703
doc: Sync classref with current source
2019-04-19 11:21:09 +02:00
Rémi Verschelde
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
Tomasz Chabora
b0846f60c9
Consistently wrap booleans in [code]
2019-04-17 17:13:00 +02:00
Rémi Verschelde
63d3a42f82
Merge pull request #27465 from neikeq/road-to-lang-agnostic-docs-is-going-to-be-tough
...
EditorHelp: Improve enum ref resolving and add constant ref support
2019-04-05 15:19:21 +02:00
Rémi Verschelde
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
Ignacio Etcheverry
c8aa85189a
EditorHelp, makerst: Improve enum ref resolving and constant ref support
...
Enum reference resolving will now search in the @GlobalScope if no class is specified and the enum cannot be resolved in the current class.
Added support for constant references in EditorHelp, e.g.: [constant KEY_ENTER] or [constant Control.FOCUS_CLICK]. It supports enum constants (the enum name must not be included).
2019-03-29 23:40:31 +01:00
Rémi Verschelde
8f5d9b6391
doc: Sync classref with current source
2019-03-07 10:54:42 +01:00
Davide Baldo
b98263013a
Fixed the default value for Input.action_press() from commit 8c45282
2018-11-17 20:45:24 +00:00
Rémi Verschelde
072aaf98e8
doc: Sync classref with current source
2018-11-13 11:06:50 +01:00
Davide Baldo
1b0c7515ff
Allow to specify a custom strength when calling Input.action_press(), this allows virtual axis, mainly for mobile.
2018-11-10 10:25:59 +00:00
Rémi Verschelde
5f8af252e8
doc: Use HTTPS for docs.godotengine.org and point to latest branch
...
Fixes #23509 .
2018-11-05 08:46:27 +01:00
M. Huri
b46ba24e3b
Repaired mistyped of 'its' on several files.
2018-10-25 07:19:21 +07:00
Guilherme Felipe
5016ef6fe0
[Docs] Add doc for Input::get_action_strength
2018-10-05 09:54:00 -03:00
Rémi Verschelde
876456754d
Merge pull request #21421 from YeldhamDev/mult_view_changes
...
Small improvements to the Spatial Editor's multiple viewport mode
2018-10-02 11:22:49 +02:00
aBARICHELLO
6e0de76746
Add Input buttons and axes missing descriptions
2018-10-01 18:57:19 -03:00
Guilherme Felipe
04aef23585
Fix set_custom_mouse_cursor changing to incorrect cursor shape
...
[Docs] Add class ref for Input::set_default_cursor_shape
2018-09-13 15:13:57 -03:00
Carl Scarlett
91aa940b42
added clarification about Input.get_accelerometer only working when project is exported
2018-09-10 17:20:17 +08:00
Guilherme Felipe
e5470cfa70
Fix custom cursor hotspot
...
Cursor hotspot must be inside image on Linux. Adding validation for all
platforms for consistency.
2018-09-03 09:57:07 -03:00
Michael Alexsander Silva Dias
7d13f6ad30
Small improvements to the Spatial Editor's multiple viewport mode
2018-08-25 17:43:27 -03:00
robojumper
98b59cf2a3
Add support for tutorial links to makerst.py
...
Also change the <tutorials> structure to make use of individual <link> tags
2018-06-12 17:40:24 +02:00
Rémi Verschelde
3d9deda8b3
Sync classref with current source
2018-05-12 09:38:00 +02:00
Guilherme Felipe
50a0220d2d
Reset the cursor with Input.set_custom_mouse_cursor(null)
2018-05-10 20:02:12 -03:00
Rémi Verschelde
cb7fe2c793
doc: Sync classref with current source
2018-04-10 10:12:42 +02:00
Pieter-Jan Briers
11aa330a6f
Improve Input.is_action_just_* docs.
...
More clarification.
2018-03-18 13:41:25 +01:00
Max Hilbrunner
22cb4a1cf9
[DOCS] Input
2018-03-13 20:12:10 +01: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
Rémi Verschelde
3c7a39b40c
doc: Update version string in header
2018-02-19 10:46:33 +01: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
Rémi Verschelde
9f479f096c
Fix typos in code and docs with codespell
...
Using v1.11.0 from https://github.com/lucasdemarchi/codespell
2018-01-18 22:01:42 +01:00
Rémi Verschelde
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +01:00
Rémi Verschelde
8d03cafd7c
doc: Sync classref with current source
2018-01-03 13:45:03 +01:00
Guilherme Silva
a392dbdbe3
Add implementation for custom hardware cursor
2017-12-17 13:40:29 -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
e7701bb2de
doc: Rename "@Global Scope" to "@GlobalScope"
...
Spaces in filenames are evil.
2017-11-15 20:41:16 +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
Olli Markkanen
9876bad05c
[DOCS] Improve docs for is_action_just_pressed and is_action_just_released ( #12081 )
2017-10-14 11:30:41 +02: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
letheed
5ad9be4c24
Rename pos to position in user facing methods and variables
...
Rename user facing methods and variables as well as the corresponding
C++ methods according to the folloming changes:
* pos -> position
* rot -> rotation
* loc -> location
C++ variables are left as is.
2017-09-20 13:11:10 +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