mirror of
https://github.com/PaperMC/Paper.git
synced 2024-12-22 17:07:34 +01:00
63e77b531d
Cost is a property of individual enchantments, and is used by vanilla in combination with environmental aspects like tool enchantability and bookshelf count to determine the final cost of an enchantment as shown in an enchanting table. Having access to the base cost of an enchantment using these vanilla methods can allow plugin developers to determine the "value" of an enchantment, and use it in custom logic where needed. I came across this recently when trying to assign an economic value to enchantments during tool repairing, and noticed these values don't seem to be obtainable under the current API.
172 lines
6.2 KiB
Diff
172 lines
6.2 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..e6a40c1fcea761bd66743b50e3da3d14797d05b0
|
|
--- /dev/null
|
|
+++ b/src/main/java/io/papermc/paper/enchantments/EnchantmentRarity.java
|
|
@@ -0,0 +1,24 @@
|
|
+package io.papermc.paper.enchantments;
|
|
+
|
|
+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 1b6f42ff632b1f3f5034c825e99b72f389a890b4..8183f26545998e076ad93b4e28f3a3ff693d1032 100644
|
|
--- a/src/main/java/org/bukkit/enchantments/Enchantment.java
|
|
+++ b/src/main/java/org/bukkit/enchantments/Enchantment.java
|
|
@@ -273,11 +273,7 @@ public abstract class Enchantment implements Keyed, net.kyori.adventure.translat
|
|
* 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();
|
|
|
|
/**
|
|
@@ -311,6 +307,70 @@ public abstract class Enchantment implements Keyed, net.kyori.adventure.translat
|
|
* @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
|
|
+ */
|
|
+ @NotNull
|
|
+ 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
|
|
+ */
|
|
+ public abstract float getDamageIncrease(int level, @NotNull org.bukkit.entity.EntityCategory entityCategory);
|
|
+
|
|
+ /**
|
|
+ * 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
|
|
|
|
@Override
|
|
diff --git a/src/main/java/org/bukkit/enchantments/EnchantmentWrapper.java b/src/main/java/org/bukkit/enchantments/EnchantmentWrapper.java
|
|
index a39f9c078f42451bd122f3e3729d10ca299bee5f..4a838d6eab5a17d7204dba96a882b6c5a22636fc 100644
|
|
--- a/src/main/java/org/bukkit/enchantments/EnchantmentWrapper.java
|
|
+++ b/src/main/java/org/bukkit/enchantments/EnchantmentWrapper.java
|
|
@@ -74,5 +74,42 @@ public 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
|
|
}
|