Refactor EffPlaySound to be more readable and resistant to versioning issues. #7022
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Asleeepp
reviewed
Sep 1, 2024
Co-authored-by: Asleepp <119438940+Asleeepp@users.noreply.github.com>
UnderscoreTud
approved these changes
Sep 1, 2024
TheLimeGlass
approved these changes
Sep 1, 2024
src/main/java/ch/njol/skript/bukkitutil/sounds/AdventureSoundUtils.java
Outdated
Show resolved
Hide resolved
src/main/java/ch/njol/skript/bukkitutil/sounds/SoundReceiver.java
Outdated
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The current state of EffPlaySound relies on a lot of nested FunctionalInterfaces with static methods that makes it quite hard to follow, read, and debug. Issues with differing version support has resulted in two bugs so far, one that has caused an inability to use entity emitters on 1.18 despite the API existing, since the current impl isn't flexible enough to allow it.
This PR re-introduces that feature by refactoring EffPlaySound to use an adapter pattern to unify Player and World playSound methods. It also moves sound validation, among other things, outside of the player loop which should both improve performance and fix an issue where the sound expression was being evaluated once for each player.
I have done manual testing on 1.17, 1.18, and 1.21, though I think junit tests should be implemented via mocking, if feasible. I have not yet looked into that. I would also appreciate any users with existing sound-heavy code to test this PR's nightly out if they can (click Checks -> Java 21 CI -> download from Artifacts).
Target Minecraft Versions: any
Requirements: none
Related Issues: #7016, #6907, #6910