Add new Lidded API, deprecating existing bukkit Lidded API. Adds PlayerLiddedOpenEvent #11814
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
- adds `/test_lidded_new <blockpos> query` to get the api's view of the block - adds `/test_lidded_new <blockpos> set <lidmode>` to change it. - adds `/test_lidded_old <blockpos> <is_open | close | toggle>` to use the implementation of the old api on top of the new api. - adds `LiddedTestListener` to test `PlayerLiddedOpenEvent`, which makes any lidded blocks open quietly (ie cancel the event), if done while holding any wool in your main hand. since it's not the easiest thing to test in-game without some api consumer/activator a seconds player might be useful to inspect state while it is open/closed with multiple people.
|
Fixed #11364 with new api |
456dev
commented
Dec 25, 2024
| /** | ||
| * @deprecated Incomplete api. Use {@link io.papermc.paper.block.Lidded} instead. | ||
| */ | ||
| @Deprecated // Paper - Deprecate Bukkit's Lidded API |
There was a problem hiding this comment.
TODO: remove this lone // paper comment
Suggested change
| @Deprecated // Paper - Deprecate Bukkit's Lidded API | |
| @Deprecated |
456dev
commented
Dec 25, 2024
| * Cancelling this event prevents the player from being considered in other {@link Lidded} methods: | ||
| * they will not contribute to the {@link Lidded#getTrueLidState()} and {@link Lidded#getEffectiveLidState()}. | ||
| * <p> | ||
| * This event is called twice for double chests, once for each half. |
There was a problem hiding this comment.
todo: fix global implementation for double chests.
iirc as well as this double-fire behaviour, modifying the state of the non-dominant half doesnt play a sound, but still keeps the animation open seperately.
456dev
commented
Dec 25, 2024
| LidState getEffectiveLidState(); | ||
|
|
||
| /** | ||
| * Gets how the lid would be without any lidded mode, based on players interacting with the block. |
There was a problem hiding this comment.
TODO: replace with smth like
Suggested change
| * Gets how the lid would be without any lidded mode, based on players interacting with the block. | |
| * Gets how the lid would be with {@link LidMode.DEFAULT} | |
| * I.E. based on players interacting with the block. |
456dev
commented
Dec 25, 2024
|
|
||
| import org.jspecify.annotations.NullMarked; | ||
|
|
||
| @NullMarked |
There was a problem hiding this comment.
Is this actually needed, since its a very simple enum?
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.
replaces #11379, pre hard-fork pr
minimal changes from previous pr, mostly some variable renames + //paper comments, to be in-line with the new guidelines.
previous description below:
Featuring
This also deprecates Bukkits api because of the confusing and outright incorrect javadocs (so those now accurately represent the behaviour)
Testable with the included testplugin commands.
I'm not 100% sure if the PaperLidded interface is the best way of doing this, but it is working
Also, let me know if the naming needs to change.