-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
Clarify the usage of controller echo events #11950
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Nintorch
wants to merge
1
commit into
godotengine:master
Choose a base branch
from
Nintorch:joypad-echo-events
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+22
−10
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -208,16 +208,28 @@ average deadzone value from all of the actions in the vector. | |||||||||||||||||||||||||||||
| "Echo" events | ||||||||||||||||||||||||||||||
| ~~~~~~~~~~~~~ | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| Unlike keyboard input, holding down a controller button such as a D-pad | ||||||||||||||||||||||||||||||
| direction will **not** generate repeated input events at fixed intervals (also | ||||||||||||||||||||||||||||||
| known as "echo" events). This is because the operating system never sends "echo" | ||||||||||||||||||||||||||||||
| events for controller input in the first place. | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| If you want controller buttons to send echo events, you will have to generate | ||||||||||||||||||||||||||||||
| :ref:`class_InputEvent` objects by code and parse them using | ||||||||||||||||||||||||||||||
| :ref:`Input.parse_input_event() <class_Input_method_parse_input_event>` | ||||||||||||||||||||||||||||||
| at regular intervals. This can be accomplished | ||||||||||||||||||||||||||||||
| with the help of a :ref:`class_Timer` node. | ||||||||||||||||||||||||||||||
| Unlike keyboard input, holding down a controller button such as a D-pad direction or | ||||||||||||||||||||||||||||||
| moving a controller axis over a specified deadzone will **not** by default | ||||||||||||||||||||||||||||||
| generate repeated input events at fixed intervals (also known as "echo" events). | ||||||||||||||||||||||||||||||
| This is because the operating system never sends "echo" events for controller input | ||||||||||||||||||||||||||||||
| in the first place, and in Godot controller echo events are sent by the engine code. | ||||||||||||||||||||||||||||||
|
Comment on lines
+211
to
+215
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Explain why echo events are sometimes desired:
Suggested change
|
||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| If you want controller buttons to send echo events, set | ||||||||||||||||||||||||||||||
| :ref:`ProjectSettings.input_devices/joypads/joypad_echo_events/send<class_ProjectSettings_property_input_devices/joypads/joypad_echo_events/send>` to ``true``. | ||||||||||||||||||||||||||||||
| If you want controller axes to send echo events, make sure | ||||||||||||||||||||||||||||||
| :ref:`ProjectSettings.input_devices/joypads/joypad_echo_events/axis_echo_events/send<class_ProjectSettings_property_input_devices/joypads/joypad_echo_events/axis_echo_events/send>` | ||||||||||||||||||||||||||||||
| is set to ``true``. | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| To control the amount of time of pressing the joypad buttons or keeping the joypad axes over the deadzone | ||||||||||||||||||||||||||||||
| required for the engine to start sending echo events, modify | ||||||||||||||||||||||||||||||
| :ref:`ProjectSettings.input_devices/joypads/joypad_echo_events/wait_time<class_ProjectSettings_property_input_devices/joypads/joypad_echo_events/wait_time>`. | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| To control the number of times per second joypad echo events should be sent by the engine after the user | ||||||||||||||||||||||||||||||
| has pressed the buttons or kept the axes over the deadzone for long enough, modify | ||||||||||||||||||||||||||||||
| :ref:`ProjectSettings.input_devices/joypads/joypad_echo_events/count_per_second<class_ProjectSettings_property_input_devices/joypads/joypad_echo_events/count_per_second>`. | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| To control the deadzone that is used by the engine to determine if joypad axis echo events should be sent, | ||||||||||||||||||||||||||||||
| modify :ref:`ProjectSettings.input_devices/joypads/joypad_echo_events/axis_echo_events/deadzone<class_ProjectSettings_property_input_devices/joypads/joypad_echo_events/axis_echo_events/deadzone>`. | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| Window focus | ||||||||||||||||||||||||||||||
| ~~~~~~~~~~~~ | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Although now that I think about it, this will conflict with the way the main project setting is set up for new projects:
We'll have to discuss it, maybe we can disable this project setting for newly created projects too.