Package org.bukkit.potion

Enum Class PotionType

java.lang.Object
java.lang.Enum<PotionType>
org.bukkit.potion.PotionType
All Implemented Interfaces:
Serializable, Comparable<PotionType>, Constable, Keyed
public enum PotionType extends Enum<PotionType> implements Keyed
This enum reflects and matches each potion state that can be obtained from the Creative mode inventory

  • Enum Constant Details

  • Method Details

    • values

      public static PotionType[] 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 PotionType 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

    • getEffectType

      @Nullable @Deprecated public PotionEffectType getEffectType()
      Deprecated.
      Potions can have multiple effects use getPotionEffects()
      Returns:
      the potion effect type of this potion type

    • getPotionEffects

      @NotNull public List<PotionEffect> getPotionEffects()
      Returns:
      a list of all effects this potion type has

    • isInstant

      @Deprecated public boolean isInstant()
      Deprecated.
      PotionType can have multiple effects, some of which can be instant and others not. Use PotionEffectType.isInstant() in combination with getPotionEffects() and PotionEffect.getType()
      Returns:
      if this potion type is instant

    • isUpgradeable

      public boolean isUpgradeable()
      Checks if the potion type has an upgraded state. This refers to whether or not the potion type can be Tier 2, such as Potion of Fire Resistance II.
      Returns:
      true if the potion type can be upgraded;

    • isExtendable

      public boolean isExtendable()
      Checks if the potion type has an extended state. This refers to the extended duration potions
      Returns:
      true if the potion type can be extended

    • getMaxLevel

      public int getMaxLevel()

    • getByEffect

      @Deprecated @Nullable public static PotionType getByEffect(@Nullable PotionEffectType effectType)
      Deprecated.
      Misleading
      Parameters:
      effectType - the effect to get by
      Returns:
      the matching potion type

    • getKey

      @NotNull public NamespacedKey getKey()
      Description copied from interface: Keyed
      Return the namespaced identifier for this object.
      Specified by:
      getKey in interface Keyed
      Returns:
      this object's key