From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001 From: Jake Potrebic Date: Fri, 12 Mar 2021 17:09:40 -0800 Subject: [PATCH] Item Rarity API diff --git a/src/main/java/io/papermc/paper/inventory/ItemRarity.java b/src/main/java/io/papermc/paper/inventory/ItemRarity.java new file mode 100644 index 0000000000000000000000000000000000000000..74ef8395cc040ce488c2acaa416db20272cc2734 --- /dev/null +++ b/src/main/java/io/papermc/paper/inventory/ItemRarity.java @@ -0,0 +1,28 @@ +package io.papermc.paper.inventory; + +import net.kyori.adventure.text.format.NamedTextColor; +import net.kyori.adventure.text.format.TextColor; +import org.jetbrains.annotations.NotNull; + +public enum ItemRarity { + + COMMON(NamedTextColor.WHITE), + UNCOMMON(NamedTextColor.YELLOW), + RARE(NamedTextColor.AQUA), + EPIC(NamedTextColor.LIGHT_PURPLE); + + TextColor color; + + ItemRarity(TextColor color) { + this.color = color; + } + + /** + * Gets the color formatting associated with the rarity. + * @return + */ + @NotNull + public TextColor getColor() { + return color; + } +} diff --git a/src/main/java/org/bukkit/Material.java b/src/main/java/org/bukkit/Material.java index 5ff032f73d88dd91163ff3e6c89dcd0d1507228c..a9bcb123526da0881728070d36aea37612db8cf2 100644 --- a/src/main/java/org/bukkit/Material.java +++ b/src/main/java/org/bukkit/Material.java @@ -4003,6 +4003,17 @@ public enum Material implements Keyed { public String getTranslationKey() { return Bukkit.getUnsafe().getTranslationKey(this); } + + /** + * Returns the item rarity for the item. The Material MUST be an Item not a block. + * Use {@link #isItem()} before this. + * + * @return the item rarity + */ + @NotNull + public io.papermc.paper.inventory.ItemRarity getItemRarity() { + return Bukkit.getUnsafe().getItemRarity(this); + } // Paper end /** diff --git a/src/main/java/org/bukkit/UnsafeValues.java b/src/main/java/org/bukkit/UnsafeValues.java index 84eda68281c6c6968d95b1313a33696c3a9980d4..bcd10b2c9255d778b678310febf1937301d01a50 100644 --- a/src/main/java/org/bukkit/UnsafeValues.java +++ b/src/main/java/org/bukkit/UnsafeValues.java @@ -137,5 +137,22 @@ public interface UnsafeValues { * Use this when sending custom packets, so that there are no collisions on the client or server. */ public int nextEntityId(); + + /** + * Gets the item rarity of a material. The material MUST be an item. + * Use {@link Material#isItem()} before this. + * + * @param material the material to get the rarity of + * @return the item rarity + */ + public io.papermc.paper.inventory.ItemRarity getItemRarity(Material material); + + /** + * Gets the item rarity of the itemstack. The rarity can change based on enchantements. + * + * @param itemStack the itemstack to get the rarity of + * @return the itemstack rarity + */ + public io.papermc.paper.inventory.ItemRarity getItemStackRarity(ItemStack itemStack); // Paper end } diff --git a/src/main/java/org/bukkit/inventory/ItemStack.java b/src/main/java/org/bukkit/inventory/ItemStack.java index bd96c06aca1fc18807e65c34f399ce2ebe891816..f72d3d62d61755bbaf1950ebcb228ce95d1faf58 100644 --- a/src/main/java/org/bukkit/inventory/ItemStack.java +++ b/src/main/java/org/bukkit/inventory/ItemStack.java @@ -863,5 +863,15 @@ public class ItemStack implements Cloneable, ConfigurationSerializable, net.kyor public String getTranslationKey() { return Bukkit.getUnsafe().getTranslationKey(this); } + + /** + * Gets the item rarity of the itemstack. The rarity can change based on enchantements. + * + * @return the itemstack rarity + */ + @NotNull + public io.papermc.paper.inventory.ItemRarity getRarity() { + return Bukkit.getUnsafe().getItemStackRarity(this); + } // Paper end }