Skip to content

Rename Interaction::Clicked -> Interaction::Pressed (#8989)#9027

Merged
mockersf merged 4 commits intobevyengine:mainfrom
atheni42:rename-interaction-clicked-to-pressed
Jul 5, 2023
Merged

Rename Interaction::Clicked -> Interaction::Pressed (#8989)#9027
mockersf merged 4 commits intobevyengine:mainfrom
atheni42:rename-interaction-clicked-to-pressed

Conversation

@atheni42
Copy link
Copy Markdown

@atheni42 atheni42 commented Jul 2, 2023 •
edited
Loading

Objective

Solution

  • Renamed Interaction::Clicked -> Interaction::Pressed
  • Minor changes to comments to keep clarity of terms

Migration Guide

  • Rename all instances of Interaction::Clicked -> Interaction::Pressed

@mockersf mockersf added A-Input Player input via keyboard, mouse, gamepad, and more A-UI Graphical user interfaces, styles, layouts, and widgets S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it labels Jul 2, 2023
MrGVSV
MrGVSV approved these changes Jul 2, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@MrGVSV MrGVSV left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

An alternative would be to use the term Active to match the CSS pseudo-class, but imo I think Pressed is a little clearer.

MrGVSV
MrGVSV reviewed Jul 3, 2023
View reviewed changes
james7132
james7132 approved these changes Jul 4, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@james7132 james7132 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a "Migration Guide" section to the PR description to address the breaking change?

@james7132 james7132 added the M-Migration-Guide A breaking change to Bevy's public API that needs to be noted in a migration guide label Jul 4, 2023
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jul 4, 2023

It looks like your PR is a breaking change, but you didn't provide a migration guide.

Could you add some context on what users should update when this change get released in a new version of Bevy?
It will be used to help writing the migration guide for the version. Putting it after a ## Migration Guide will help it get automatically picked up by our tooling.

@atheni42
Copy link
Copy Markdown
Author

atheni42 commented Jul 5, 2023 •
edited
Loading

Can you add a "Migration Guide" section to the PR description to address the breaking change?

@james7132 Amended the Issue description, that single dot point should be enough I think but let me know if it needs expansion

@mockersf mockersf added this pull request to the merge queue Jul 5, 2023
Merged via the queue into bevyengine:main with commit 7f1d084 Jul 5, 2023
@atheni42 atheni42 deleted the rename-interaction-clicked-to-pressed branch July 5, 2023 09:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@james7132 james7132 james7132 approved these changes

@mockersf mockersf mockersf approved these changes

+1 more reviewer

@MrGVSV MrGVSV MrGVSV approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

A-Input Player input via keyboard, mouse, gamepad, and more A-UI Graphical user interfaces, styles, layouts, and widgets M-Migration-Guide A breaking change to Bevy's public API that needs to be noted in a migration guide S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Rename Interaction::Click

4 participants

@atheni42 @james7132 @mockersf @MrGVSV