4596894c8e
Clarify the types InputEvent.is_action_type() will return true for
2025-08-12 19:15:46 +02:00
cec5c89f9d
Merge pull request #107143 from Mickeon/documentation-miscellaneous-oddities-part-5
...
Fix miscellaneous oddities around the class reference (part 5)
2025-06-13 15:53:47 +02:00
15bdac4e9e
Clarify requirement for action match in InputEvent.is_action_pressed
2025-06-07 00:23:32 +02:00
3613306bba
Fix miscellaneous oddities around the class reference (part 5)
2025-06-06 15:21:25 +02:00
4f4fd1a05c
Clarify behavior of InputEvent.is_match and Shortcut.matches_event
...
- Shortcut: Clarifies how matches_event() method compares events
- InputEvent: Clarifies is_match() method does not consider event states
2024-09-17 04:12:34 -07:00
4097cfa17b
Add "repeat" keyword alias for InputEvent "echo" in the class reference
...
"echo" is an uncommon term and the action is most commonly referred
to as a "repeated" key press.
This also improves the documentation related to echo behavior.
2024-06-24 19:23:18 +02:00
c83718624f
Update links to outdated asset library demos
...
Update links to outdated asset library demos
Co-authored-by: Max Hilbrunner <m.hilbrunner@gmail.com >
2024-04-07 16:59:43 +02:00
6818e50adc
Expose DEVICE_ID_EMULATION constant in InputEvent
...
This also improves the documentation related to emulated InputEvents.
2024-03-16 19:16:40 +01:00
81064cc239
Doctool: Remove version attribute from XML header
...
We don't use that info for anything, and it generates unnecessary diffs
every time we bump the minor version (and CI failures if we forget to
sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 10:08:21 +02:00
346f1ab86b
Bump version to 4.2-dev
...
Keep on waitin'
2023-07-05 22:07:03 +02:00
04562662d3
Overhaul the top sections of the class reference (Core classes)
2023-05-19 07:04:48 +02:00
250749fa79
Augment the InputEvent class with a CANCELED state
...
The `InputEvent` class currently supports the `pressed` and `released` states, which given the binary nature, is represented by a `bool` field.
This commit introduced the `CANCELED` state, which signals that an ongoing input event has been canceled.
To represent all the states, the `InputEventState` enum is added and the `InputEvent` logic is refactored accordingly.
2023-05-15 11:48:25 -07:00
1c1524a651
Bump version to 4.1-dev
...
Can't stop, won't stop, they said, huh?
2023-03-01 01:44:37 +01:00
d6c4e40feb
Clarify return value for InputEvent.is_echo()
2023-02-19 00:28:46 +01: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
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
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
6c1bd4d227
Replace Godot docs URL with $DOCS_URL in XML class reference
2021-11-15 13:02:21 +01:00
d54f2ad7ca
Don't generate empty doc sections and reduce code duplication
2021-09-20 20:59:33 -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
4effadc0ba
Merge pull request #48696 from madmiraal/fix-48692
...
Fix `InputMap.action_erase_event()` failing to erase events correctly.
2021-06-20 00:29:42 +02:00
0ff4095b36
Better format arguments in variant parser
2021-06-18 00:06:40 -03:00
7104229a85
Fix InputMap.action_erase_event() failing to erase events correctly.
2021-05-19 11:43:02 +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
439be614f4
Link to demos from within the class reference
2020-10-01 23:57:21 -04:00
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
fea37cfb52
doc: Sync classref with StringName/Callable changes
2020-02-22 14:59:09 +01:00
57e27683ba
Update docs to version 4.0
2020-01-31 17:15:41 -08:00
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
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
9ae73f7bb5
Document how to distinguish emulated mouse events from physical ones
...
Mouse events emulated from a touchscreen will always have a device ID
of -1.
2019-12-30 15:30:34 +01:00
9d4e596c69
doc: Sync classref with current source
...
Fix incomplete binding.
2019-11-08 16:00:01 +01:00
2046d7b87a
Added missing InputEvent documentation
2019-07-18 12:03:28 +02:00
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
bc82781f7d
doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks
2019-06-27 13:49:36 +02:00
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
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
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
d80bc5cbba
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass]
...
Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-29 23:47:35 +01:00
8f5d9b6391
doc: Sync classref with current source
2019-03-07 10:54:42 +01:00
5f8af252e8
doc: Use HTTPS for docs.godotengine.org and point to latest branch
...
Fixes #23509 .
2018-11-05 08:46:27 +01:00
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
3d9deda8b3
Sync classref with current source
2018-05-12 09:38:00 +02:00
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
3c7a39b40c
doc: Update version string in header
2018-02-19 10:46:33 +01:00
f2e3825616
doc: Fix references to online tutorials after godotengine/godot-docs#1015
2018-01-25 09:03:59 +01:00
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
