Package org.bukkit.potion
Enum Class PotionType
- All Implemented Interfaces:
FeatureDependant
,Serializable
,Comparable<PotionType>
,Constable
,Keyed
,Keyed
This enum reflects and matches each potion state that can be obtained from
the Creative mode inventory
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Deprecated.Do not use, interface will get removed, and the plugin won't runNested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescription -
Method Summary
Modifier and TypeMethodDescriptionstatic @Nullable PotionType
getByEffect
(@Nullable PotionEffectType effectType) Deprecated.MisleadingDeprecated.Potions can have multiple effects usegetPotionEffects()
getKey()
Return the namespaced identifier for this object.int
boolean
Checks if the potion type has an extended state.boolean
Deprecated.PotionType can have multiple effects, some of which can be instant and others not.boolean
Checks if the potion type has an upgraded state.static PotionType
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 interface io.papermc.paper.world.flag.FeatureDependant
requiredFeatures
-
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
-
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
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 nameNullPointerException
- if the argument is null
-
getEffectType
Deprecated.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
-
isInstant
Deprecated.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
-
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 @Nullable PotionType getByEffect(@Nullable @Nullable PotionEffectType effectType) Deprecated.Misleading- Parameters:
effectType
- the effect to get by- Returns:
- the matching potion type
-
getKey
Description copied from interface:Keyed
Return the namespaced identifier for this object.
-