forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix incorrect doc about GamepadAxis::RightZ/LeftZ (#18114)

Browse Source 
# Objective

Documentation correction.

# Reasoning
The `GamepadAxis::RightZ` and `LeftZ` do not map to the trigger buttons
on a gamepad. They are in fact for the twisting/yaw of a flight Joystick
and throttle lever respectively. I confirmed this with two gamepads that
has analog triggers (Logitech F710, 8bitdo ultimate BT controller) and a
HOTAS joystick (Saitek X52).
This commit is contained in:
Kim Simmons 2025-03-02 20:18:01 +01:00 committed by GitHub
parent 36cb64b382
commit ff1ae62e1c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
crates/bevy_input/src/gamepad.rs
View File

@ -635,16 +635,16 @@ pub enum GamepadAxis {
LeftStickX, LeftStickX,
/// The vertical value of the left stick. /// The vertical value of the left stick.
LeftStickY, LeftStickY,
/// The value of the left `Z` button. /// Generally the throttle axis of a HOTAS setup.
/// Refer to [`GamepadButton::LeftTrigger2`] for the analog trigger on a gamepad controller.
LeftZ, LeftZ,
/// The horizontal value of the right stick. /// The horizontal value of the right stick.
RightStickX, RightStickX,
/// The vertical value of the right stick. /// The vertical value of the right stick.
RightStickY, RightStickY,
/// The value of the right `Z` button. /// The yaw of the main joystick, not supported on common gamepads.
/// Refer to [`GamepadButton::RightTrigger2`] for the analog trigger on a gamepad controller.
RightZ, RightZ,
/// Non-standard support for other axis types (i.e. HOTAS sliders, potentiometers, etc). /// Non-standard support for other axis types (i.e. HOTAS sliders, potentiometers, etc).
Other(u8), Other(u8),
} }