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.

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

Remove use of "right click" descriptions in API methods #102

Closed
ChloeDawn opened this issue Jan 16, 2021 · 1 comment
Closed

Remove use of "right click" descriptions in API methods #102

ChloeDawn opened this issue Jan 16, 2021 · 1 comment
Assignees
Labels
type: enhancement New feature or request

Comments

@ChloeDawn
Copy link

Please describe the new feature or change.

Rename canRightClickEquip to canEquipFromHotbar and playRightClickEquipSound to playHotbarEquipSound (or similar, TBC).

Please describe why you want this feature.
The implication that the player is right-clicking is (presumably) based upon common Forge events such as PlayerInteractEvent.RightClickItem, however, these names are bad, because the player isn't always right-clicking in these contexts - right-clicking is just the default keybinding for "use". I don't think new APIs should be using this legacy terminology going forward.

@ChloeDawn ChloeDawn added the type: enhancement New feature or request label Jan 16, 2021
@TheIllusiveC4
Copy link
Owner

You bring up a good point. I'll add in new renamed methods (which will also address your other issue about additional context) for the current API version and deprecate the existing ones, with eventual removal when appropriate, to avoid continued use of the misleading terminology.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants