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
Paul Joannon
596169d7df
class reference proofreading
...
(cherry picked from commit 8455e901f3
)
2021-03-26 09:49:07 +01:00
Rémi Verschelde
1aba997d75
doc: Sync classref with 3.3 version bump
2021-03-23 13:40:34 +01:00
Marcus Brummer
9926425ce9
Document different unit of measurement for sensor data on iOS and Android
...
(cherry picked from commit d1798b235c
)
2021-03-17 15:17:02 +01:00
Rémi Verschelde
dbb69f8f49
doc: Mention iOS support for Input gravity/gyroscope sensors
...
It has been implemented for iOS a long time ago already with #7127 .
(cherry picked from commit 2d0fda3ca2
)
2020-12-01 09:00:48 +01: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
Hugo Locurcio
96ad9dc4c6
Document supported platforms for `Input.get_accelerometer()` and related
...
This closes #41303 .
(cherry picked from commit eee704e6f6
)
2020-08-31 15:29:41 +02:00
Michael Alexsander
d7065106ef
State how 'MOUSE_MODE_CAPTURED' actually works in the 'Input' docs
...
(cherry picked from commit 4f13a7f47f
)
2020-08-31 15:29:41 +02:00
Hugo Locurcio
b5f1f7dfde
Improve the `Input.set_use_accumulated_input()` documentation
...
(cherry picked from commit 30961c60ab
)
2020-03-25 11:38:53 +01: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