Package com.cryptomorin.xseries

Enum Class XPotion

java.lang.Object

java.lang.Enum<XPotion>

com.cryptomorin.xseries.XPotion

All Implemented Interfaces:

XBase<XPotion,org.bukkit.potion.PotionEffectType>, Serializable, Comparable<XPotion>, Constable

public enum XPotion
extends Enum<XPotion>
implements XBase<XPotion,org.bukkit.potion.PotionEffectType>

Potion type support for multiple aliases. Uses EssentialsX potion list for aliases.

Duration: The duration of the effect in ticks. Values 0 or lower are treated as 1. Optional, and defaults to 1 tick.
Amplifier: The amplifier of the effect, with level I having value 0. Optional, and defaults to level I.

There are two types of classes that we should distinguish between each other. A Potion is an ItemStack (with meta PotionMeta) that can have one or multiple PotionEffectTypes.

• PotionEffectType: These are all the available Minecraft effects. Some of these effects cannot be gained in form of potions.
• PotionType: A potion type doesn't only contain information about a PotionEffectType but also its amplifier and duration.
  • A PotionType with enhanced amplifier (level 2 amplifier) starts with the prefix STRONG (using XMaterial.GLOWSTONE within a BrewingStand). These potions cannot have extended duration.
  • A PotionType with extended duration (base duration multiplied by 2.666) starts with the prefix LONG (using XMaterial.REDSTONE within a BrewingStand). These potions cannot be enhanced.
  • PotionType.AWKWARD A potion with no effects (using XMaterial.NETHER_WART within a BrewingStand)
  • PotionType.MUNDANE Created when using XMaterial.GLOWSTONE on an PotionType.AWKWARD potion within a BrewingStand.
  • PotionType.THICK Created when using XMaterial.REDSTONE on an PotionType.AWKWARD potion within a BrewingStand.
  • PotionType.TURTLE_MASTER There is no PotionEffectType for this potion type because it's a combination of PotionEffectType.SLOWNESS and PotionEffectType.RESISTANCE, not a completely different PotionEffectType of itself.
• PotionEffect is a custom type of PotionType (with custom amplifier and duration) that is not defined by Vanilla potions.

With that being said, this class is mainly a PotionEffectType mapping. However, it does provide a few utilities for PotionType and maps them when possible.

EssentialsX Potions: https://github.com/EssentialsX/Essentials/blob/2.x/Essentials/src/com/earth2me/essentials/Potions.java Status Effect: https://minecraft.wiki/w/Status_effect Potions: https://minecraft.wiki/w/Potion

Version:

5.0.0

Author:

Crypto Morin

See Also:

• PotionEffect
• PotionEffectType
• PotionType

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XPotion.Effect	For now, this merely acts as a chance wrapper for potion effects.

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ABSORPTION
BAD_OMEN
BLINDNESS
CONDUIT_POWER
DARKNESS
DOLPHINS_GRACE
FIRE_RESISTANCE
GLOWING
HASTE
HEALTH_BOOST
HERO_OF_THE_VILLAGE
HUNGER
INFESTED
INSTANT_DAMAGE
INSTANT_HEALTH
INVISIBILITY
JUMP_BOOST
LEVITATION
LUCK
MINING_FATIGUE
NAUSEA
NIGHT_VISION
OOZING
POISON
RAID_OMEN
REGENERATION
RESISTANCE
SATURATION
SLOW_FALLING
SLOWNESS
SPEED
STRENGTH
TRIAL_OMEN
UNLUCK
WATER_BREATHING
WEAKNESS
WEAVING
WIND_CHARGED
WITHER

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<XPotion>	DEBUFFS	Deprecated. Use XTag.DEBUFFS instead.
static final XRegistry<XPotion,org.bukkit.potion.PotionEffectType>	REGISTRY
static final XPotion[]	VALUES	Cached list of values() to avoid allocating memory for calling the method every time.

Method Summary

Modifier and Type	Method	Description
static void	addEffects(@NotNull org.bukkit.entity.LivingEntity entity, @Nullable List<String> effects)	Add a list of potion effects to an entity from a string list, usually from config.
static @NotNull org.bukkit.inventory.ItemStack	buildItemWithEffects(@NotNull org.bukkit.Material type, @Nullable org.bukkit.Color color, @Nullable org.bukkit.potion.PotionEffect... effects)	Builds an item with the given type, color and effects.
@Nullable org.bukkit.potion.PotionEffect	buildPotionEffect(int duration, int amplifier)	Builds a potion effect with the given duration and amplifier.
static boolean	canHaveEffects(@Nullable org.bukkit.Material material)	Checks if a material can have potion effects.
@Nullable org.bukkit.potion.PotionEffectType	get()
String[]	getNames()
@Nullable org.bukkit.potion.PotionEffectType	getPotionEffectType()	Parses the potion effect type.
@Nullable org.bukkit.potion.PotionType	getPotionType()	Gets the PotionType from this PotionEffectType.
static @NotNull Optional<XPotion>	matchXPotion(@NotNull String potion)	Deprecated. Use of(String) instead.
static @NotNull XPotion	matchXPotion(@NotNull org.bukkit.potion.PotionEffectType type)	Deprecated. Use of(PotionEffectType) instead.
static XPotion	matchXPotion(@NotNull org.bukkit.potion.PotionType type)	Deprecated. Use of(PotionType) instead.
static Optional<XPotion>	of(@NotNull String potion)
static @NotNull XPotion	of(@NotNull org.bukkit.potion.PotionEffectType type)	Parses the XPotion for this potion effect.
static @NotNull XPotion	of(@NotNull org.bukkit.potion.PotionType potion)
static @Nullable XPotion.Effect	parseEffect(@Nullable String potion)	Parse a PotionEffect from a string, usually from config.
static List<XPotion.Effect>	parseEffects(@Nullable List<String> effectsString)
static @NotNull org.bukkit.entity.ThrownPotion	throwPotion(@NotNull org.bukkit.entity.LivingEntity entity, @Nullable org.bukkit.Color color, @Nullable org.bukkit.potion.PotionEffect... effects)	Throws a splash potion from the target entity.
String	toString()	In most cases you should be using Enum.name() instead.
static XPotion	valueOf(String name)	Returns the enum constant of this class with the specified name.
static XPotion[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.cryptomorin.xseries.base.XBase

friendlyName, getMetadata, isSupported, name, or

Enum Constant Details

ABSORPTION

public static final XPotion ABSORPTION

BAD_OMEN

public static final XPotion BAD_OMEN

BLINDNESS

public static final XPotion BLINDNESS

CONDUIT_POWER

public static final XPotion CONDUIT_POWER

DARKNESS

public static final XPotion DARKNESS

DOLPHINS_GRACE

public static final XPotion DOLPHINS_GRACE

FIRE_RESISTANCE

public static final XPotion FIRE_RESISTANCE

GLOWING

public static final XPotion GLOWING

HASTE

public static final XPotion HASTE

HEALTH_BOOST

public static final XPotion HEALTH_BOOST

HERO_OF_THE_VILLAGE

public static final XPotion HERO_OF_THE_VILLAGE

HUNGER

public static final XPotion HUNGER

INFESTED

public static final XPotion INFESTED

INSTANT_DAMAGE

public static final XPotion INSTANT_DAMAGE

INSTANT_HEALTH

public static final XPotion INSTANT_HEALTH

INVISIBILITY

public static final XPotion INVISIBILITY

JUMP_BOOST

public static final XPotion JUMP_BOOST

LEVITATION

public static final XPotion LEVITATION

LUCK

public static final XPotion LUCK

MINING_FATIGUE

public static final XPotion MINING_FATIGUE

NAUSEA

public static final XPotion NAUSEA

NIGHT_VISION

public static final XPotion NIGHT_VISION

OOZING

public static final XPotion OOZING

POISON

public static final XPotion POISON

RAID_OMEN

public static final XPotion RAID_OMEN

REGENERATION

public static final XPotion REGENERATION

RESISTANCE

public static final XPotion RESISTANCE

SATURATION

public static final XPotion SATURATION

SLOWNESS

public static final XPotion SLOWNESS

SLOW_FALLING

public static final XPotion SLOW_FALLING

SPEED

public static final XPotion SPEED

STRENGTH

public static final XPotion STRENGTH

TRIAL_OMEN

public static final XPotion TRIAL_OMEN

UNLUCK

public static final XPotion UNLUCK

WATER_BREATHING

public static final XPotion WATER_BREATHING

WEAKNESS

public static final XPotion WEAKNESS

WEAVING

public static final XPotion WEAVING

WIND_CHARGED

public static final XPotion WIND_CHARGED

WITHER

public static final XPotion WITHER

Field Details

VALUES

public static final XPotion[] VALUES

Cached list of values() to avoid allocating memory for calling the method every time.

Since:

1.0.0

DEBUFFS

@Deprecated
public static final Set<XPotion> DEBUFFS

Deprecated.

Use XTag.DEBUFFS instead.

An unmodifiable set of "bad" potion effects.

Since:

1.1.0

REGISTRY

public static final XRegistry<XPotion,org.bukkit.potion.PotionEffectType> REGISTRY

Method Details

values

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

matchXPotion

@NotNull
@Deprecated
public static @NotNull Optional<XPotion> matchXPotion(@NotNull
 @NotNull String potion)

Deprecated.

Use of(String) instead.

Parses a potion effect type from the given string. Supports type IDs.

Parameters:

potion - the type of the type's ID of the potion effect type.

Returns:

a potion effect type.

Since:

1.0.0

of

@NotNull
public static @NotNull XPotion of(@NotNull
 @NotNull org.bukkit.potion.PotionType potion)

of

public static Optional<XPotion> of(@NotNull
 @NotNull String potion)

matchXPotion

@Deprecated
public static XPotion matchXPotion(@NotNull
 @NotNull org.bukkit.potion.PotionType type)

Deprecated.

Use of(PotionType) instead.

matchXPotion

@NotNull
@Deprecated
public static @NotNull XPotion matchXPotion(@NotNull
 @NotNull org.bukkit.potion.PotionEffectType type)

Deprecated.

Use of(PotionEffectType) instead.

Parses the XPotion for this potion effect.

Parameters:

type - the potion effect type.

Returns:

the XPotion of this potion effect.

Throws:

IllegalArgumentException - may be thrown as an unexpected exception.

Since:

1.0.0

of

@NotNull
public static @NotNull XPotion of(@NotNull
 @NotNull org.bukkit.potion.PotionEffectType type)

Parses the XPotion for this potion effect.

Parameters:

type - the potion effect type.

Returns:

the XPotion of this potion effect.

Throws:

IllegalArgumentException - may be thrown as an unexpected exception.

Since:

1.0.0

parseEffect

@Nullable
public static @Nullable XPotion.Effect parseEffect(@Nullable
 @Nullable String potion)

Parse a PotionEffect from a string, usually from config. Supports potion type IDs.
Format: Potion, Duration (in seconds), Amplifier (level) [%chance]

     WEAKNESS, 30, 1
     SLOWNESS, 200, 10
     1, 10000, 100, %50
 

The last argument can also include a chance (written in percent) which if not met, returns null.

Parameters:

potion - the potion string to parse.

Returns:

a potion effect, or null if the potion type is wrong.

Since:

1.0.0

See Also:

• buildPotionEffect(int, int)

addEffects

public static void addEffects(@NotNull
 @NotNull org.bukkit.entity.LivingEntity entity,
 @Nullable
 @Nullable List<String> effects)

Add a list of potion effects to an entity from a string list, usually from config.

Parameters:

entity - the entity to add potion effects to.

effects - the list of potion effects to parse and add to the entity.

Since:

1.0.0

See Also:

• parseEffect(String)

parseEffects

public static List<XPotion.Effect> parseEffects(@Nullable
 @Nullable List<String> effectsString)

Parameters:

effectsString - a list of effects with a format following parseEffect(String)

Returns:

a list of parsed effets.

Since:

3.0.0

throwPotion

@NotNull
public static @NotNull org.bukkit.entity.ThrownPotion throwPotion(@NotNull
 @NotNull org.bukkit.entity.LivingEntity entity,
 @Nullable
 @Nullable org.bukkit.Color color,
 @Nullable
 @Nullable org.bukkit.potion.PotionEffect... effects)

Throws a splash potion from the target entity. This method is only compatible for 1.9+

Parameters:

entity - the entity to throw the potion from.

color - the color of the potion's bottle.

effects - the effects of the potion.

Returns:

a thrown splash potion.

Since:

1.0.0

buildItemWithEffects

@NotNull
public static @NotNull org.bukkit.inventory.ItemStack buildItemWithEffects(@NotNull
 @NotNull org.bukkit.Material type,
 @Nullable
 @Nullable org.bukkit.Color color,
 @Nullable
 @Nullable org.bukkit.potion.PotionEffect... effects)

Builds an item with the given type, color and effects. This method is only compatible for 1.9+

The item type must be one of the following:

     Material.POTION
     Material.SPLASH_POTION
     Material.LINGERING_POTION
     Material.TIPPED_ARROW
 

Parameters:

type - the type of the potion.

color - the color of the potion's bottle.

effects - the effects of the potion.

Returns:

an item with the specified effects.

Since:

1.0.0

canHaveEffects

public static boolean canHaveEffects(@Nullable
 @Nullable org.bukkit.Material material)

Checks if a material can have potion effects. This method does not check for LEGACY materials. You should avoid using them or use XMaterial instead.

Parameters:

material - the material to check.

Returns:

true if the material is a potion, otherwise false.

Since:

1.0.0

getPotionEffectType

@Nullable
public @Nullable org.bukkit.potion.PotionEffectType getPotionEffectType()

Parses the potion effect type.

Returns:

the parsed potion effect type.

Since:

1.0.0

See Also:

• getPotionType()

getNames

public String[] getNames()

Specified by:

getNames in interface XBase<XPotion,org.bukkit.potion.PotionEffectType>

get

@Nullable
public @Nullable org.bukkit.potion.PotionEffectType get()

Specified by:

get in interface XBase<XPotion,org.bukkit.potion.PotionEffectType>

getPotionType

@Nullable
public @Nullable org.bukkit.potion.PotionType getPotionType()

Gets the PotionType from this PotionEffectType. Usually for potion items.

Returns:

a potion type for potions.

Since:

1.0.0

See Also:

• getPotionEffectType()

buildPotionEffect

@Nullable
public @Nullable org.bukkit.potion.PotionEffect buildPotionEffect(int duration,
 int amplifier)

Builds a potion effect with the given duration and amplifier.

Parameters:

duration - the duration of the potion effect in ticks.

amplifier - the level of the potion effect (starting from 1).

Returns:

a potion effect.

Since:

1.0.0

See Also:

• parseEffect(String)

toString

public String toString()

In most cases you should be using Enum.name() instead.

Overrides:

toString in class Enum<XPotion>

Returns:

a friendly readable string name.