Package org.bukkit.potion
Enum Class PotionType
- All Implemented Interfaces:
- Serializable,- Comparable<PotionType>,- Constable,- Keyed,- RegistryAware
This enum reflects and matches each potion state that can be obtained from
 the Creative mode inventory
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionstatic interfaceDeprecated.Do not use, interface will get removed, and the plugin won't runNested classes/interfaces inherited from class java.lang.EnumEnum.EnumDesc<E extends Enum<E>>
- 
Enum Constant SummaryEnum ConstantsEnum ConstantDescription
- 
Method SummaryModifier and TypeMethodDescriptionstatic PotionTypegetByEffect(PotionEffectType effectType) Deprecated.MisleadingDeprecated.Potions can have multiple effects usegetPotionEffects()getKey()Deprecated.A key might not always be present, usegetKeyOrThrow()instead.Gets the key of this instance if it is registered otherwise returnsnull.Gets the key of this instance if it is registered otherwise throws an error.intbooleanChecks if the potion type has an extended state.booleanDeprecated.PotionType can have multiple effects, some of which can be instant and others not.booleanReturns whether this instance is register in a registry and therefore has a key or not.booleanChecks if the potion type has an upgraded state.static PotionTypeReturns the enum constant of this class with the specified name.static PotionType[]values()Returns an array containing the constants of this enum class, in the order they are declared.
- 
Enum Constant Details- 
WATER
- 
MUNDANE
- 
THICK
- 
AWKWARD
- 
NIGHT_VISION
- 
LONG_NIGHT_VISION
- 
INVISIBILITY
- 
LONG_INVISIBILITY
- 
LEAPING
- 
LONG_LEAPING
- 
STRONG_LEAPING
- 
FIRE_RESISTANCE
- 
LONG_FIRE_RESISTANCE
- 
SWIFTNESS
- 
LONG_SWIFTNESS
- 
STRONG_SWIFTNESS
- 
SLOWNESS
- 
LONG_SLOWNESS
- 
STRONG_SLOWNESS
- 
WATER_BREATHING
- 
LONG_WATER_BREATHING
- 
HEALING
- 
STRONG_HEALING
- 
HARMING
- 
STRONG_HARMING
- 
POISON
- 
LONG_POISON
- 
STRONG_POISON
- 
REGENERATION
- 
LONG_REGENERATION
- 
STRONG_REGENERATION
- 
STRENGTH
- 
LONG_STRENGTH
- 
STRONG_STRENGTH
- 
WEAKNESS
- 
LONG_WEAKNESS
- 
LUCK
- 
TURTLE_MASTER
- 
LONG_TURTLE_MASTER
- 
STRONG_TURTLE_MASTER
- 
SLOW_FALLING
- 
LONG_SLOW_FALLING
- 
WIND_CHARGED
- 
WEAVING
- 
OOZING
- 
INFESTED
 
- 
- 
Method Details- 
valuesReturns 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
 
- 
valueOfReturns 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
 
- 
getEffectTypeDeprecated.Potions can have multiple effects usegetPotionEffects()- Returns:
- the potion effect type of this potion type
 
- 
getPotionEffects- Returns:
- a list of all effects this potion type has
 
- 
isInstantDeprecated.PotionType can have multiple effects, some of which can be instant and others not. UsePotionEffectType.isInstant()in combination withgetPotionEffects()andPotionEffect.getType()- Returns:
- if this potion type is instant
 
- 
isUpgradeablepublic 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;
 
- 
isExtendablepublic 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
 
- 
getMaxLevelpublic int getMaxLevel()
- 
getKeyOrThrowDescription copied from interface:RegistryAwareGets the key of this instance if it is registered otherwise throws an error.
 This is a convenience method and plugins should always checkRegistryAware.isRegistered()before using this method.- Specified by:
- getKeyOrThrowin interface- RegistryAware
- Returns:
- the key with which this instance is registered.
- See Also:
 
- 
getKeyOrNullDescription copied from interface:RegistryAwareGets the key of this instance if it is registered otherwise returnsnull.- Specified by:
- getKeyOrNullin interface- RegistryAware
- Returns:
- the key with which this instance is registered or nullif not registered.
- See Also:
 
- 
isRegisteredpublic boolean isRegistered()Description copied from interface:RegistryAwareReturns whether this instance is register in a registry and therefore has a key or not.- Specified by:
- isRegisteredin interface- RegistryAware
- Returns:
- true, if this instance is registered. Otherwise, false.
- See Also:
 
- 
getByEffect@Deprecated(since="1.9") @Nullable public static PotionType getByEffect(@Nullable PotionEffectType effectType) Deprecated.Misleading- Parameters:
- effectType- the effect to get by
- Returns:
- the matching potion type
 
- 
getKeyDeprecated.A key might not always be present, usegetKeyOrThrow()instead.Return the namespaced identifier for this object.
 
-