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

Clarify behavior of InputEvent.is_match and Shortcut.matches_event #97106

Merged
merged 1 commit into from
Sep 17, 2024
Merged

Clarify behavior of InputEvent.is_match and Shortcut.matches_event #97106

merged 1 commit into from
Sep 17, 2024
+2 −1

Conversation

SkylerGoh-dev
Copy link
Contributor

  • Shortcut: Clarifies how matches_event() method compares events
  • InputEvent: Clarifies is_match() method does not consider event states

Fixes #97048

@SkylerGoh-dev SkylerGoh-dev requested a review from a team as a code owner September 17, 2024 10:24
@AThousandShips AThousandShips added enhancement documentation cherrypick:4.2 Considered for cherry-picking into a future 4.2.x release cherrypick:4.3 Considered for cherry-picking into a future 4.3.x release labels Sep 17, 2024
@SkylerGoh-dev SkylerGoh-dev marked this pull request as draft September 17, 2024 10:26
@AThousandShips AThousandShips added this to the 4.x milestone Sep 17, 2024
@SkylerGoh-dev SkylerGoh-dev marked this pull request as ready for review September 17, 2024 10:26
AThousandShips
AThousandShips reviewed Sep 17, 2024
View reviewed changes
doc/classes/Shortcut.xml Outdated Show resolved Hide resolved
doc/classes/InputEvent.xml Outdated Show resolved Hide resolved
@AThousandShips AThousandShips requested a review from a team September 17, 2024 10:28
AThousandShips
AThousandShips approved these changes Sep 17, 2024
View reviewed changes
Copy link
Member

@AThousandShips AThousandShips left a comment

Choose a reason for hiding this comment

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

This looks good to me
Once you've fixed the last detail from me please squash your commits into one, see here

doc/classes/InputEvent.xml Outdated Show resolved Hide resolved
@AThousandShips AThousandShips requested a review from a team September 17, 2024 10:39
Sauermann
Sauermann approved these changes Sep 17, 2024
View reviewed changes
Copy link
Contributor

@Sauermann Sauermann left a comment

Choose a reason for hiding this comment

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

The new description matches the implementation.

@AThousandShips AThousandShips changed the title Added clarifications to Shortcut.xml and InputEvent.xml Clarify behavior of InputEvent.is_match and Shortcut.matches_event Sep 17, 2024
@AThousandShips

This comment was marked as resolved.

Sign in to view
@SkylerGoh-dev
Clarify behavior of InputEvent.is_match and Shortcut.matches_event
4f4fd1a 
- Shortcut: Clarifies how matches_event() method compares events
- InputEvent: Clarifies is_match() method does not consider event states
@SkylerGoh-dev SkylerGoh-dev force-pushed the Add-further-clarification-to-Shortcut-and-InputEvent.is_match()-method-documentation branch from 30a4c55 to 4f4fd1a Compare September 17, 2024 11:13
@akien-mga akien-mga modified the milestones: 4.x, 4.4 Sep 17, 2024
@akien-mga akien-mga merged commit ac78975 into godotengine:master Sep 17, 2024
20 checks passed
@akien-mga
Copy link
Member

Thanks! And congrats for your first merged Godot contribution 🎉

@SkylerGoh-dev
Copy link
Contributor Author

Thank you!

@jss2a98aj jss2a98aj mentioned this pull request Nov 14, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AThousandShips AThousandShips AThousandShips approved these changes

@Sauermann Sauermann Sauermann approved these changes

Assignees
No one assigned
Labels
cherrypick:4.2 Considered for cherry-picking into a future 4.2.x release cherrypick:4.3 Considered for cherry-picking into a future 4.3.x release documentation enhancement
Projects
None yet
Milestone
4.4
Development

Successfully merging this pull request may close these issues.

Shortcut matches_event ignores pressed flag
4 participants
@SkylerGoh-dev @AThousandShips @akien-mga @Sauermann