Enum Class ItemRarity

java.lang.Object
java.lang.Enum<ItemRarity>
org.bukkit.inventory.ItemRarity
All Implemented Interfaces:
Serializable, Comparable<ItemRarity>, Constable

public enum ItemRarity extends Enum<ItemRarity>
A item's rarity determines the default color of its name. This enum is ordered from least rare to most rare.
  • Enum Constant Details

    • COMMON

      public static final ItemRarity COMMON
      White item name.
    • UNCOMMON

      public static final ItemRarity UNCOMMON
      Yellow item name.
    • RARE

      public static final ItemRarity RARE
      Aqua item name.
    • EPIC

      public static final ItemRarity EPIC
      Light purple item name.
  • Method Details

    • values

      public static ItemRarity[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static ItemRarity valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • color

      public @NotNull TextColor color()
      Gets the color formatting associated with this rarity.
      Returns:
      the color