Skip to content
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.

Sign up for GitHub

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

Jump to bottom

GamepadEventsRaw vs GamepadEvents is confusing and undocumented #5544

Closed
alice-i-cecile opened this issue Aug 1, 2022 · 2 comments
Closed

GamepadEventsRaw vs GamepadEvents is confusing and undocumented #5544

alice-i-cecile opened this issue Aug 1, 2022 · 2 comments
Labels
A-Input Player input via keyboard, mouse, gamepad, and more C-Docs An addition or correction to our documentation

Comments

@alice-i-cecile
Copy link
Member

What problem does this solve or what need does it fill?

When mocking gamepad input, you must send GamepadEventsRaw, or it will not be transformed into Input and Axis data correctly.

However, there are not docs to explain the difference or warn users of this footgun.

What solution would you like?

  1. Add documentation to GamepadEvents and GamepadEventsRaw explaining their purpose.
  2. Add a doc test demonstrating how to use GamepadEventsRaw to mock gamepad input.
@alice-i-cecile alice-i-cecile added C-Bug An unexpected or incorrect behavior C-Docs An addition or correction to our documentation A-Input Player input via keyboard, mouse, gamepad, and more and removed C-Bug An unexpected or incorrect behavior labels Aug 1, 2022
@alice-i-cecile
Copy link
Member Author

I'd like to reconsider this design down the road, or at least give these more descriptive names, but docs should be done first to make that work easier to review.

@ghost ghost self-assigned this Aug 2, 2022
@ghost
Copy link

ghost commented Aug 2, 2022

Going to document the gamepad.rs file since I have already done this in #3692 but didn't make a new PR for it yet.

@ghost ghost mentioned this issue Aug 2, 2022
Closed
bors bot pushed a commit that referenced this issue Aug 5, 2022
Document gamepad.rs (#5548)
4b1a990 
# Objective

- Fixes #5544
- Part of the splitting process of #3692.

## Solution

- Document everything in the `gamepad.rs` file.
- Add a doc example for mocking gamepad input.

---

## Changelog

- Added and updated the documentation inside of the `gamepad.rs` file.
@bors bors bot closed this as completed in 54750de Aug 5, 2022
maccesch pushed a commit to Synphonyte/bevy that referenced this issue Sep 28, 2022
@maccesch
Document gamepad.rs (bevyengine#5548)
fa98842 
# Objective

- Fixes bevyengine#5544
- Part of the splitting process of bevyengine#3692.

## Solution

- Document everything in the `gamepad.rs` file.
- Add a doc example for mocking gamepad input.

---

## Changelog

- Added and updated the documentation inside of the `gamepad.rs` file.
james7132 pushed a commit to james7132/bevy that referenced this issue Oct 28, 2022
@james7132
Document gamepad.rs (bevyengine#5548)
95a51ce 
# Objective

- Fixes bevyengine#5544
- Part of the splitting process of bevyengine#3692.

## Solution

- Document everything in the `gamepad.rs` file.
- Add a doc example for mocking gamepad input.

---

## Changelog

- Added and updated the documentation inside of the `gamepad.rs` file.
ItsDoot pushed a commit to ItsDoot/bevy that referenced this issue Feb 1, 2023
@ItsDoot
Document gamepad.rs (bevyengine#5548)
45f4e89 
# Objective

- Fixes bevyengine#5544
- Part of the splitting process of bevyengine#3692.

## Solution

- Document everything in the `gamepad.rs` file.
- Add a doc example for mocking gamepad input.

---

## Changelog

- Added and updated the documentation inside of the `gamepad.rs` file.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-Input Player input via keyboard, mouse, gamepad, and more C-Docs An addition or correction to our documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Merged by Bors] - Document gamepad.rs
1 participant
@alice-i-cecile