PaperMC/patches/api/0281-More-Enchantment-API.patch
Nassim Jahnke 2641c02193
Updated Upstream (Bukkit/CraftBukkit)
Upstream has released updates that appear to apply and compile correctly.
This update has not been tested by PaperMC and as with ANY update, please do your own testing

Bukkit Changes:
69fa4695 Add some missing deprecation annotations
f850da2e Update Maven plugins/versions
8d8400db Use regular compiler seeing as ECJ doesn't support Java 21 JRE
c29e1688 Revert "BUILDTOOLS-676: Downgrade Maven compiler version"
07bce714 SPIGOT-7355: More field renames and fixes
6a8ea764 Fix bad merge in penultimate commit
50a7920c Fix imports in previous commit
83640dd1 PR-995: Add required feature to MinecraftExperimental for easy lookups
fc1f96cf BUILDTOOLS-676: Downgrade Maven compiler version

CraftBukkit Changes:
90f1059ba Fix item placement
661afb43c SPIGOT-7633: Clearer error message for missing particle data
807b465b3 SPIGOT-7634: Armadillo updates infrequently
590cf09a8 Fix unit tests always seeing Mojang server as unavailable
7c7ac5eb2 SPIGOT-7636: Fix clearing ItemMeta
4a72905cf SPIGOT-7635: Fix Player#transfer and cookie methods
ebb50e136 Fix incorrect Vault implementation
b33fed8b7 Update Maven plugins/versions
6f00f0608 SPIGOT-7632: Control middle clicking chest does not copy contents
db821f405 Use regular compiler seeing as ECJ doesn't support Java 21 JRE
8a2976737 Revert "BUILDTOOLS-676: Downgrade Maven compiler version"
0297f87bb SPIGOT-7355: More field renames and fixes
2d03bdf6a SPIGOT-7629: Fix loading banner patterns
e77951fac Fix equality of deserialized display names
c66f3e4fd SPIGOT-7631: Fix deserialisation of BlockStateMeta
9c2c7be8d SPIGOT-7630: Fix crash saving unticked leashed entities
8c1e7c841 PR-1384: Disable certain PlayerProfile tests, if Mojang's services or internet are not available
ced93d572 SPIGOT-7626: sendSignChange() has no effect
c77362cae SPIGOT-7625: ItemStack with lore cannot be serialized in 1.20.5
ff2004387 SPIGOT-7620: Fix server crash when hoppers transfer items to double chests
8b4abeb03 BUILDTOOLS-676: Downgrade Maven compiler version
2024-04-25 23:23:57 +02:00

189 lines
7.3 KiB
Diff

From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Jake Potrebic <jake.m.potrebic@gmail.com>
Date: Thu, 6 May 2021 19:58:03 -0700
Subject: [PATCH] More Enchantment API
Co-authored-by: Luis <luisc99@icloud.com>
diff --git a/src/main/java/io/papermc/paper/enchantments/EnchantmentRarity.java b/src/main/java/io/papermc/paper/enchantments/EnchantmentRarity.java
new file mode 100644
index 0000000000000000000000000000000000000000..50c49739cc25679c9d241466e3069c9c232a22c4
--- /dev/null
+++ b/src/main/java/io/papermc/paper/enchantments/EnchantmentRarity.java
@@ -0,0 +1,25 @@
+package io.papermc.paper.enchantments;
+
+@Deprecated(forRemoval = true, since = "As of 1.20.5 enchantments do not have a rarity.")
+public enum EnchantmentRarity {
+
+ COMMON(10),
+ UNCOMMON(5),
+ RARE(2),
+ VERY_RARE(1);
+
+ private final int weight;
+
+ EnchantmentRarity(int weight) {
+ this.weight = weight;
+ }
+
+ /**
+ * Gets the weight for the rarity.
+ *
+ * @return the weight
+ */
+ public int getWeight() {
+ return weight;
+ }
+}
diff --git a/src/main/java/org/bukkit/enchantments/Enchantment.java b/src/main/java/org/bukkit/enchantments/Enchantment.java
index 4e41980dfbb256356231bc9565f6a90ea66aab76..de616cecaeb45018d96685c916532188e369bdd4 100644
--- a/src/main/java/org/bukkit/enchantments/Enchantment.java
+++ b/src/main/java/org/bukkit/enchantments/Enchantment.java
@@ -292,11 +292,7 @@ public abstract class Enchantment implements Keyed, Translatable, net.kyori.adve
* Cursed enchantments are found the same way treasure enchantments are
*
* @return true if the enchantment is cursed
- * @deprecated cursed enchantments are no longer special. Will return true
- * only for {@link Enchantment#BINDING_CURSE} and
- * {@link Enchantment#VANISHING_CURSE}.
*/
- @Deprecated
public abstract boolean isCursed();
/**
@@ -330,6 +326,87 @@ public abstract class Enchantment implements Keyed, Translatable, net.kyori.adve
* @return the name of the enchantment with {@code level} applied
*/
public abstract net.kyori.adventure.text.@NotNull Component displayName(int level);
+
+ /**
+ * Checks if this enchantment can be found in villager trades.
+ *
+ * @return true if the enchantment can be found in trades
+ */
+ public abstract boolean isTradeable();
+
+ /**
+ * Checks if this enchantment can be found in an enchanting table
+ * or use to enchant items generated by loot tables.
+ *
+ * @return true if the enchantment can be found in a table or by loot tables
+ */
+ public abstract boolean isDiscoverable();
+
+ /**
+ * Gets the minimum modified cost of this enchantment at a specific level.
+ * <p>
+ * Note this is not the number of experience levels needed, and does not directly translate to the levels shown in an enchanting table.
+ * This value is used in combination with factors such as tool enchantability to determine a final cost.
+ * See <a href="https://minecraft.wiki/w/Enchanting/Levels">https://minecraft.wiki/w/Enchanting/Levels</a> for more information.
+ * </p>
+ * @param level The level of the enchantment
+ * @return The modified cost of this enchantment
+ */
+ public abstract int getMinModifiedCost(int level);
+
+ /**
+ * Gets the maximum modified cost of this enchantment at a specific level.
+ * <p>
+ * Note this is not the number of experience levels needed, and does not directly translate to the levels shown in an enchanting table.
+ * This value is used in combination with factors such as tool enchantability to determine a final cost.
+ * See <a href="https://minecraft.wiki/w/Enchanting/Levels">https://minecraft.wiki/w/Enchanting/Levels</a> for more information.
+ * </p>
+ * @param level The level of the enchantment
+ * @return The modified cost of this enchantment
+ */
+ public abstract int getMaxModifiedCost(int level);
+
+ /**
+ * Gets the rarity of this enchantment.
+ *
+ * @return the rarity
+ * @deprecated As of 1.20.5 enchantments do not have a rarity.
+ */
+ @NotNull
+ @Deprecated(forRemoval = true, since = "1.20.5")
+ @Contract("-> fail")
+ public abstract io.papermc.paper.enchantments.EnchantmentRarity getRarity();
+
+ /**
+ * Gets the damage increase as a result of the level and entity category specified
+ *
+ * @param level the level of enchantment
+ * @param entityCategory the category of entity
+ * @return the damage increase
+ * @deprecated Use {@link #getDamageIncrease(int, org.bukkit.entity.EntityType)} instead.
+ * Enchantment damage increase is no longer handled via {@link org.bukkit.entity.EntityCategory}s, but
+ * is instead controlled by tags, e.g. {@link org.bukkit.Tag#ENTITY_TYPES_SENSITIVE_TO_BANE_OF_ARTHROPODS}.
+ * As such, a category cannot properly represent all entities defined by the tags.
+ */
+ @Deprecated(forRemoval = true, since = "1.20.5")
+ public abstract float getDamageIncrease(int level, @NotNull org.bukkit.entity.EntityCategory entityCategory);
+
+ /**
+ * Gets the damage increase as a result of the level and entity type specified
+ *
+ * @param level the level of enchantment
+ * @param entityType the type of entity.
+ * @return the damage increase
+ */
+ public abstract float getDamageIncrease(int level, @NotNull org.bukkit.entity.EntityType entityType);
+
+ /**
+ * Gets the equipment slots where this enchantment is considered "active".
+ *
+ * @return the equipment slots
+ */
+ @NotNull
+ public abstract java.util.Set<org.bukkit.inventory.EquipmentSlot> getActiveSlots();
// Paper end
/**
diff --git a/src/main/java/org/bukkit/enchantments/EnchantmentWrapper.java b/src/main/java/org/bukkit/enchantments/EnchantmentWrapper.java
index ac0371285370594d4de1554871b19bbcd2311730..da5d153a3e55a38b767359564001ad8663f9730b 100644
--- a/src/main/java/org/bukkit/enchantments/EnchantmentWrapper.java
+++ b/src/main/java/org/bukkit/enchantments/EnchantmentWrapper.java
@@ -31,5 +31,42 @@ public abstract class EnchantmentWrapper extends Enchantment {
public @NotNull String translationKey() {
return getEnchantment().translationKey();
}
+
+ @Override
+ public boolean isTradeable() {
+ return getEnchantment().isTradeable();
+ }
+
+ @Override
+ public boolean isDiscoverable() {
+ return getEnchantment().isDiscoverable();
+ }
+
+ @Override
+ public int getMinModifiedCost(int level) {
+ return getEnchantment().getMinModifiedCost(level);
+ }
+
+ @Override
+ public int getMaxModifiedCost(int level) {
+ return getEnchantment().getMaxModifiedCost(level);
+ }
+
+ @NotNull
+ @Override
+ public io.papermc.paper.enchantments.EnchantmentRarity getRarity() {
+ return getEnchantment().getRarity();
+ }
+
+ @Override
+ public float getDamageIncrease(int level, @NotNull org.bukkit.entity.EntityCategory entityCategory) {
+ return getEnchantment().getDamageIncrease(level, entityCategory);
+ }
+
+ @NotNull
+ @Override
+ public java.util.Set<org.bukkit.inventory.EquipmentSlot> getActiveSlots() {
+ return getEnchantment().getActiveSlots();
+ }
// Paper end
}