Adding PredicateChoice to Paper API (updated version) #12017
Conversation
CPieter
changed the title
paper-server/patches/sources/net/minecraft/world/item/crafting/Ingredient.java.patch
Outdated
Show resolved
Hide resolved
paper-server/src/main/java/org/bukkit/craftbukkit/inventory/CraftRecipe.java
Outdated
Show resolved
Hide resolved
|
Hi and welcome to the Paper PR world (well this more a thing can say a Paper Team Member xd) The paper comments currently just apply to code in patches, its not required in the api,craftbukkit,paper classes. |
|
I just noticed there is already a PredicateRecipeChoice for potions, with the addition of the PredicateChoice this could be a bit confusing. Maybe it should be renamed to something more clear like a PotionRecipeChoice/PotionPredicateChoice? |
well rename sounds a little breaking i think, maybe this new PredicateChoice can be named ItemPredicateChoice (? or add an extension of RecipeChoice for Potion and move things to that for make clear the diff... but not really sure. |
marked stackPredicate field in Ingredient as Nullable
Renamed field predicate to stackPredicate
Since PredicateRecipeChoice isn't public, delete it, and make Here's a great example of what I talked about in my review, suggesting to keep implementation types out of the "api" because we can now just delete PredicateRecipeChoice entirely. |
Added static constructor methods for MaterialChoice and ExactChoice to the RecipeChoice interface. Deprecated old constructors.
Changed if to else-if, to prevent PredicateChoice recipe book examples from being added as exactIngredient
There was a problem hiding this comment.
Looks good, just a few more things. I also opened the PR adding the future alternative to MaterialChoice. Will merge mine in after yours
| public PredicateChoiceImpl(Predicate<ItemStack> stackPredicate, ItemStack exampleStack) { | ||
| Preconditions.checkArgument(stackPredicate != null, "The item predicate cannot be null"); | ||
| Preconditions.checkArgument(exampleStack != null, "The example stack cannot be null"); | ||
| Preconditions.checkArgument(!exampleStack.isEmpty(), "Cannot have empty/air example stack"); | ||
|
|
||
| this.stackPredicate = stackPredicate; | ||
| this.exampleStack = exampleStack.clone(); | ||
| } |
There was a problem hiding this comment.
| public PredicateChoiceImpl(Predicate<ItemStack> stackPredicate, ItemStack exampleStack) { | |
| Preconditions.checkArgument(stackPredicate != null, "The item predicate cannot be null"); | |
| Preconditions.checkArgument(exampleStack != null, "The example stack cannot be null"); | |
| Preconditions.checkArgument(!exampleStack.isEmpty(), "Cannot have empty/air example stack"); | |
| this.stackPredicate = stackPredicate; | |
| this.exampleStack = exampleStack.clone(); | |
| } | |
| public PredicateChoiceImpl { | |
| Preconditions.checkArgument(stackPredicate != null, "The item predicate cannot be null"); | |
| Preconditions.checkArgument(exampleStack != null, "The example stack cannot be null"); | |
| Preconditions.checkArgument(!exampleStack.isEmpty(), "Cannot have empty/air example stack"); | |
| exampleStack = exampleStack.clone() | |
| } |
can use a fancy record compact constructor here since its just preconditions
| @NullMarked | ||
| sealed interface PredicateChoice extends RecipeChoice permits PredicateChoiceImpl { | ||
|
|
||
| Predicate<ItemStack> getPredicate(); |
There was a problem hiding this comment.
Not sure we have to expose this, since it is a predicate itself. An empty interface is fine. To your point about maybe not needing interfaces, I think it's good to have even an empty one so you can at least know what type of choice it is. otherwise it's a little annoying to figure out.
There was a problem hiding this comment.
You also have to handle the conversion in the other direction. When it converts from an nms ingredient to a bukkit RecipeChoice. Check if the predicate is set and create one there. It's just below the method you changed.
| @Deprecated | ||
| public MaterialChoice(@NotNull Tag<Material> choices) { | ||
| this(new ArrayList<>(java.util.Objects.requireNonNull(choices, "Cannot create a material choice with null tag").getValues())); // Paper - delegate to list ctor to make sure all checks are called | ||
| } | ||
|
|
||
| @Deprecated |
There was a problem hiding this comment.
Lets not deprecate since we don't have the alternative in, and Material isn't deprecated yet.
| /** | ||
| * @deprecated Use {@link RecipeChoice#exactChoice(ItemStack...)} instead | ||
| */ | ||
| public ExactChoice(@NotNull ItemStack stack) { | ||
| this(Arrays.asList(stack)); | ||
| } | ||
|
|
||
| /** | ||
| * @deprecated Use {@link RecipeChoice#exactChoice(ItemStack...)} instead | ||
| */ | ||
| public ExactChoice(@NotNull ItemStack... stacks) { | ||
| this(Arrays.asList(stacks)); | ||
| } | ||
|
|
||
| /** | ||
| * @deprecated Use {@link RecipeChoice#exactChoice(List)} instead | ||
| */ | ||
| public ExactChoice(@NotNull List<ItemStack> choices) { |
There was a problem hiding this comment.
add @Deprecated(since = "1.21.4", forRemoval = true) to all of these.
| * Cannot be empty or contain empty/air stacks. | ||
| * @return a new ExactChoice. | ||
| */ | ||
| static @NotNull ExactChoice exactChoice(@NotNull ItemStack... stacks) { |
There was a problem hiding this comment.
Lets avoid upstream's mistake. For situations where it's not valid to pass 0 values, and you want a varargs parameter, you can do smth like.
| static @NotNull ExactChoice exactChoice(@NotNull ItemStack... stacks) { | |
| static @NotNull ExactChoice exactChoice(@NotNull ItemStack first, ItemStack... others) { |
That forces them to supply at least one value, and optionally anymore
This PR is an updated version of derverdox's PredicateChoice PR #9996. Since the branch in the old PR was quite outdated I reïmplemented the changes in a new branch, but most of the changes remain the same. Credit of the code should go to derverdox and Machine-Maker.
The feature seems to work fine from my testing but I'm unfamiliar with the Paper API so I please let me know if I missed something.