From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001 From: Jake Potrebic <jake.m.potrebic@gmail.com> Date: Fri, 19 Jul 2024 08:43:01 -0700 Subject: [PATCH] Add even more Enchantment API In a separate patch because it uses RegistryKeySet which is after the previous "more enchant api" patch. diff --git a/src/main/java/org/bukkit/enchantments/Enchantment.java b/src/main/java/org/bukkit/enchantments/Enchantment.java index fa20a0f13bb91955e2928b46c99ddaf0c4418d15..a824ac90e78d3d7f90b01397270e54422d88e8b9 100644 --- a/src/main/java/org/bukkit/enchantments/Enchantment.java +++ b/src/main/java/org/bukkit/enchantments/Enchantment.java @@ -432,6 +432,56 @@ public abstract class Enchantment implements Keyed, Translatable, net.kyori.adve public abstract java.util.Set<org.bukkit.inventory.EquipmentSlotGroup> getActiveSlotGroups(); // Paper end - more Enchantment API + // Paper start - even more Enchantment API + /** + * Provides the description of this enchantment entry as displayed to the client, e.g. "Sharpness" for the sharpness + * enchantment. + * + * @return the description component. + */ + public abstract net.kyori.adventure.text.@NotNull Component description(); + + /** + * Provides the registry key set referencing the items this enchantment is supported on. + * + * @return the registry key set. + */ + @org.jetbrains.annotations.ApiStatus.Experimental + public abstract io.papermc.paper.registry.set.@NotNull RegistryKeySet<org.bukkit.inventory.ItemType> getSupportedItems(); + + /** + * Provides the registry key set referencing the item types this enchantment can be applied to when + * enchanting in an enchantment table. + * <p> + * If this value is {@code null}, {@link #getSupportedItems()} will be sourced instead in the context of an enchantment table. + * Additionally, the tag {@link io.papermc.paper.registry.keys.tags.EnchantmentTagKeys#IN_ENCHANTING_TABLE} defines + * which enchantments can even show up in an enchantment table. + * + * @return the registry key set. + */ + @org.jetbrains.annotations.ApiStatus.Experimental + public abstract io.papermc.paper.registry.set.@Nullable RegistryKeySet<org.bukkit.inventory.ItemType> getPrimaryItems(); + + /** + * Provides the weight of this enchantment used by the weighted random when selecting enchantments. + * + * @return the weight value. + * @see <a href="https://minecraft.wiki/w/Enchanting">https://minecraft.wiki/w/Enchanting</a> for examplary weights. + */ + public abstract int getWeight(); + + /** + * Provides the registry key set of enchantments that this enchantment is exclusive with. + * <p> + * Exclusive enchantments prohibit the application of this enchantment to an item if they are already present on + * said item. + * + * @return a registry set of enchantments exclusive to this one. + */ + @org.jetbrains.annotations.ApiStatus.Experimental + public abstract io.papermc.paper.registry.set.@NotNull RegistryKeySet<Enchantment> getExclusiveWith(); + // Paper end - even more Enchantment API + // Paper start - mark translation key as deprecated /** * @deprecated this method assumes that the enchantments description