mirror of
https://github.com/PaperMC/Paper.git
synced 2024-11-24 19:56:25 +00:00
101 lines
5.5 KiB
Diff
101 lines
5.5 KiB
Diff
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
|
|
From: Jason Penilla <11360596+jpenilla@users.noreply.github.com>
|
|
Date: Wed, 16 Mar 2022 20:35:13 -0700
|
|
Subject: [PATCH] Add enchantWithLevels API
|
|
|
|
Deprecate upstream's newer and poorly implemented similar
|
|
API.
|
|
|
|
diff --git a/src/main/java/org/bukkit/inventory/ItemFactory.java b/src/main/java/org/bukkit/inventory/ItemFactory.java
|
|
index 579a9037b656bef9fb65c6da03611e981492074a..e1986aea72bb1f1ba2ea76f3ba53f274b6aac899 100644
|
|
--- a/src/main/java/org/bukkit/inventory/ItemFactory.java
|
|
+++ b/src/main/java/org/bukkit/inventory/ItemFactory.java
|
|
@@ -170,8 +170,11 @@ public interface ItemFactory {
|
|
* @param level the level to use, which is the level in the enchantment table
|
|
* @param allowTreasures allows treasure enchants, e.g. mending, if true.
|
|
* @return a new ItemStack containing the result of the Enchantment
|
|
+ * @deprecated use {@link #enchantWithLevels(ItemStack, int, boolean, java.util.Random)}. This method's implementation is poorly
|
|
+ * designed and was originally broken.
|
|
*/
|
|
@NotNull
|
|
+ @Deprecated(since = "1.19.3") // Paper
|
|
ItemStack enchantItem(@NotNull final Entity entity, @NotNull final ItemStack item, final int level, final boolean allowTreasures);
|
|
|
|
/**
|
|
@@ -184,8 +187,11 @@ public interface ItemFactory {
|
|
* @param level the level to use, which is the level in the enchantment table
|
|
* @param allowTreasures allow the treasure enchants, e.g. mending, if true.
|
|
* @return a new ItemStack containing the result of the Enchantment
|
|
+ * @deprecated use {@link #enchantWithLevels(ItemStack, int, boolean, java.util.Random)}. This method's implementation is poorly
|
|
+ * designed and was originally broken.
|
|
*/
|
|
@NotNull
|
|
+ @Deprecated(since = "1.19.3") // Paper
|
|
ItemStack enchantItem(@NotNull final World world, @NotNull final ItemStack item, final int level, final boolean allowTreasures);
|
|
|
|
/**
|
|
@@ -197,8 +203,11 @@ public interface ItemFactory {
|
|
* @param level the level to use, which is the level in the enchantment table
|
|
* @param allowTreasures allow treasure enchantments, e.g. mending, if true.
|
|
* @return a new ItemStack containing the result of the Enchantment
|
|
+ * @deprecated use {@link #enchantWithLevels(ItemStack, int, boolean, java.util.Random)}. This method's implementation is poorly
|
|
+ * designed and was originally broken.
|
|
*/
|
|
@NotNull
|
|
+ @Deprecated(since = "1.19.3") // Paper
|
|
ItemStack enchantItem(@NotNull final ItemStack item, final int level, final boolean allowTreasures);
|
|
|
|
// Paper start - Adventure
|
|
@@ -311,4 +320,22 @@ public interface ItemFactory {
|
|
@Deprecated
|
|
net.md_5.bungee.api.chat.hover.content.Content hoverContentOf(@NotNull org.bukkit.entity.Entity entity, @NotNull net.md_5.bungee.api.chat.BaseComponent[] customName);
|
|
// Paper end - bungee hover events
|
|
+
|
|
+ // Paper start - enchantWithLevels API
|
|
+ /**
|
|
+ * Randomly enchants a copy of the provided {@link ItemStack} using the given experience levels.
|
|
+ *
|
|
+ * <p>If the provided ItemStack is already enchanted, the existing enchants will be removed before enchanting.</p>
|
|
+ *
|
|
+ * <p>Levels must be in range {@code [1, 30]}.</p>
|
|
+ *
|
|
+ * @param itemStack ItemStack to enchant
|
|
+ * @param levels levels to use for enchanting
|
|
+ * @param allowTreasure whether to allow enchantments where {@link org.bukkit.enchantments.Enchantment#isTreasure()} returns true
|
|
+ * @param random {@link java.util.Random} instance to use for enchanting
|
|
+ * @return enchanted copy of the provided ItemStack
|
|
+ * @throws IllegalArgumentException on bad arguments
|
|
+ */
|
|
+ @NotNull ItemStack enchantWithLevels(@NotNull ItemStack itemStack, @org.jetbrains.annotations.Range(from = 1, to = 30) int levels, boolean allowTreasure, @NotNull java.util.Random random);
|
|
+ // Paper end - enchantWithLevels API
|
|
}
|
|
diff --git a/src/main/java/org/bukkit/inventory/ItemStack.java b/src/main/java/org/bukkit/inventory/ItemStack.java
|
|
index 1d1731776af5f59cd9e6bd07cb3b9fab5073ef66..9b2a62dc3da6718a3e8b39b4fb8bee3781e800cb 100644
|
|
--- a/src/main/java/org/bukkit/inventory/ItemStack.java
|
|
+++ b/src/main/java/org/bukkit/inventory/ItemStack.java
|
|
@@ -678,6 +678,24 @@ public class ItemStack implements Cloneable, ConfigurationSerializable, Translat
|
|
}
|
|
|
|
// Paper start
|
|
+ /**
|
|
+ * Randomly enchants a copy of this {@link ItemStack} using the given experience levels.
|
|
+ *
|
|
+ * <p>If this ItemStack is already enchanted, the existing enchants will be removed before enchanting.</p>
|
|
+ *
|
|
+ * <p>Levels must be in range {@code [1, 30]}.</p>
|
|
+ *
|
|
+ * @param levels levels to use for enchanting
|
|
+ * @param allowTreasure whether to allow enchantments where {@link org.bukkit.enchantments.Enchantment#isTreasure()} returns true
|
|
+ * @param random {@link java.util.Random} instance to use for enchanting
|
|
+ * @return enchanted copy of the provided ItemStack
|
|
+ * @throws IllegalArgumentException on bad arguments
|
|
+ */
|
|
+ @NotNull
|
|
+ public ItemStack enchantWithLevels(final @org.jetbrains.annotations.Range(from = 1, to = 30) int levels, final boolean allowTreasure, final @NotNull java.util.Random random) {
|
|
+ return Bukkit.getServer().getItemFactory().enchantWithLevels(this, levels, allowTreasure, random);
|
|
+ }
|
|
+
|
|
@NotNull
|
|
@Override
|
|
public net.kyori.adventure.text.event.HoverEvent<net.kyori.adventure.text.event.HoverEvent.ShowItem> asHoverEvent(final @NotNull java.util.function.UnaryOperator<net.kyori.adventure.text.event.HoverEvent.ShowItem> op) {
|