Upstream/Paper
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2024-12-27 11:27:35 +01:00
Code Issues Projects Releases Wiki Activity

Add enchantWithLevels API

Browse Source 
Deprecate upstream's newer and poorly implemented similar
API.
This commit is contained in:
Jason Penilla 2022-03-16 20:35:13 -07:00
parent ffdfd64ea5
commit a0b5bad27f
2 changed files with 45 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
paper-api/src/main/java/org/bukkit/inventory/ItemFactory.java
View File

@ -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
}

18
paper-api/src/main/java/org/bukkit/inventory/ItemStack.java
View File

@ -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) {