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, RegistryAware

public enum PotionType
extends Enum<PotionType>
implements Keyed, RegistryAware

This enum reflects and matches each potion state that can be obtained from the Creative mode inventory

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PotionType.InternalPotionData	Deprecated. Do not use, interface will get removed, and the plugin won't run

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AWKWARD
FIRE_RESISTANCE
HARMING
HEALING
INFESTED
INVISIBILITY
LEAPING
LONG_FIRE_RESISTANCE
LONG_INVISIBILITY
LONG_LEAPING
LONG_NIGHT_VISION
LONG_POISON
LONG_REGENERATION
LONG_SLOW_FALLING
LONG_SLOWNESS
LONG_STRENGTH
LONG_SWIFTNESS
LONG_TURTLE_MASTER
LONG_WATER_BREATHING
LONG_WEAKNESS
LUCK
MUNDANE
NIGHT_VISION
OOZING
POISON
REGENERATION
SLOW_FALLING
SLOWNESS
STRENGTH
STRONG_HARMING
STRONG_HEALING
STRONG_LEAPING
STRONG_POISON
STRONG_REGENERATION
STRONG_SLOWNESS
STRONG_STRENGTH
STRONG_SWIFTNESS
STRONG_TURTLE_MASTER
SWIFTNESS
THICK
TURTLE_MASTER
WATER
WATER_BREATHING
WEAKNESS
WEAVING
WIND_CHARGED

Method Summary

Modifier and Type	Method	Description
static PotionType	getByEffect(PotionEffectType effectType)	Deprecated. Misleading
PotionEffectType	getEffectType()	Deprecated. Potions can have multiple effects use getPotionEffects()
NamespacedKey	getKey()	Deprecated. A key might not always be present, use getKeyOrThrow() instead.
NamespacedKey	getKeyOrNull()	Gets the key of this instance if it is registered otherwise returns null.
NamespacedKey	getKeyOrThrow()	Gets the key of this instance if it is registered otherwise throws an error.
int	getMaxLevel()
List<PotionEffect>	getPotionEffects()
boolean	isExtendable()	Checks if the potion type has an extended state.
boolean	isInstant()	Deprecated. PotionType can have multiple effects, some of which can be instant and others not.
boolean	isRegistered()	Returns whether this instance is register in a registry and therefore has a key or not.
boolean	isUpgradeable()	Checks if the potion type has an upgraded state.
static PotionType	valueOf(String name)	Returns 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.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

WATER

public static final PotionType WATER

MUNDANE

public static final PotionType MUNDANE

THICK

public static final PotionType THICK

AWKWARD

public static final PotionType AWKWARD

NIGHT_VISION

public static final PotionType NIGHT_VISION

LONG_NIGHT_VISION

public static final PotionType LONG_NIGHT_VISION

INVISIBILITY

public static final PotionType INVISIBILITY

LONG_INVISIBILITY

public static final PotionType LONG_INVISIBILITY

LEAPING

public static final PotionType LEAPING

LONG_LEAPING

public static final PotionType LONG_LEAPING

STRONG_LEAPING

public static final PotionType STRONG_LEAPING

FIRE_RESISTANCE

public static final PotionType FIRE_RESISTANCE

LONG_FIRE_RESISTANCE

public static final PotionType LONG_FIRE_RESISTANCE

SWIFTNESS

public static final PotionType SWIFTNESS

LONG_SWIFTNESS

public static final PotionType LONG_SWIFTNESS

STRONG_SWIFTNESS

public static final PotionType STRONG_SWIFTNESS

SLOWNESS

public static final PotionType SLOWNESS

LONG_SLOWNESS

public static final PotionType LONG_SLOWNESS

STRONG_SLOWNESS

public static final PotionType STRONG_SLOWNESS

WATER_BREATHING

public static final PotionType WATER_BREATHING

LONG_WATER_BREATHING

public static final PotionType LONG_WATER_BREATHING

HEALING

public static final PotionType HEALING

STRONG_HEALING

public static final PotionType STRONG_HEALING

HARMING

public static final PotionType HARMING

STRONG_HARMING

public static final PotionType STRONG_HARMING

POISON

public static final PotionType POISON

LONG_POISON

public static final PotionType LONG_POISON

STRONG_POISON

public static final PotionType STRONG_POISON

REGENERATION

public static final PotionType REGENERATION

LONG_REGENERATION

public static final PotionType LONG_REGENERATION

STRONG_REGENERATION

public static final PotionType STRONG_REGENERATION

STRENGTH

public static final PotionType STRENGTH

LONG_STRENGTH

public static final PotionType LONG_STRENGTH

STRONG_STRENGTH

public static final PotionType STRONG_STRENGTH

WEAKNESS

public static final PotionType WEAKNESS

LONG_WEAKNESS

public static final PotionType LONG_WEAKNESS

LUCK

public static final PotionType LUCK

TURTLE_MASTER

public static final PotionType TURTLE_MASTER

LONG_TURTLE_MASTER

public static final PotionType LONG_TURTLE_MASTER

STRONG_TURTLE_MASTER

public static final PotionType STRONG_TURTLE_MASTER

SLOW_FALLING

public static final PotionType SLOW_FALLING

LONG_SLOW_FALLING

public static final PotionType LONG_SLOW_FALLING

WIND_CHARGED

public static final PotionType WIND_CHARGED

WEAVING

public static final PotionType WEAVING

OOZING

public static final PotionType OOZING

INFESTED

public static final PotionType INFESTED

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(since="1.20.2")
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(since="1.20.2")
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()

getKeyOrThrow

@NotNull
public NamespacedKey getKeyOrThrow()

Description copied from interface: RegistryAware

Gets the key of this instance if it is registered otherwise throws an error.
This is a convenience method and plugins should always check RegistryAware.isRegistered() before using this method.

Specified by:

getKeyOrThrow in interface RegistryAware

Returns:

the key with which this instance is registered.

See Also:

• RegistryAware.isRegistered()
• RegistryAware.getKeyOrNull()
• Registry

getKeyOrNull

@Nullable
public NamespacedKey getKeyOrNull()

Description copied from interface: RegistryAware

Gets the key of this instance if it is registered otherwise returns null.

Specified by:

getKeyOrNull in interface RegistryAware

Returns:

the key with which this instance is registered or null if not registered.

See Also:

• RegistryAware.getKeyOrThrow()
• Registry

isRegistered

public boolean isRegistered()

Description copied from interface: RegistryAware

Returns whether this instance is register in a registry and therefore has a key or not.

Specified by:

isRegistered in interface RegistryAware

Returns:

true, if this instance is registered. Otherwise, false.

See Also:

• RegistryAware.getKeyOrThrow()
• Registry

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

getKey

@NotNull
@Deprecated(since="1.21.4")
public NamespacedKey getKey()

Deprecated.

A key might not always be present, use getKeyOrThrow() instead.

Return the namespaced identifier for this object.

Specified by:

getKey in interface Keyed

Returns:

this object's key

See Also:

• getKeyOrThrow()
• isRegistered()