Package org.bukkit.potion

Class PotionEffectType

java.lang.Object

org.bukkit.potion.PotionEffectType

All Implemented Interfaces:

FeatureDependant, Keyed, Translatable, Keyed, Translatable

Direct Known Subclasses:

PotionEffectTypeWrapper

public abstract class PotionEffectType
extends Object
implements Keyed, Translatable, Translatable, FeatureDependant

Represents a type of potion and its effect on an entity.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PotionEffectType.Category	Category of PotionEffectTypes

Field Summary

Fields

Modifier and Type	Field	Description
static final PotionEffectType	ABSORPTION	Increases the maximum health of an entity with health that cannot be regenerated, but is refilled every 30 seconds.
static final PotionEffectType	BAD_OMEN	Triggers an ominous event when the player enters a village or trial chambers. oof.
static final PotionEffectType	BLINDNESS	Blinds an entity.
static final PotionEffectType	CONDUIT_POWER	Effects granted by a nearby conduit.
static final PotionEffectType	DARKNESS	Causes the player's vision to dim occasionally.
static final PotionEffectType	DOLPHINS_GRACE	Increses underwater movement speed. Squee'ek uh'k kk'kkkk squeek eee'eek.
static final PotionEffectType	FIRE_RESISTANCE	Stops fire damage.
static final PotionEffectType	GLOWING	Outlines the entity so that it can be seen from afar.
static final PotionEffectType	HASTE	Increases dig speed.
static final PotionEffectType	HEALTH_BOOST	Increases the maximum health of an entity.
static final PotionEffectType	HERO_OF_THE_VILLAGE	Reduces the cost of villager trades. \o/.
static final PotionEffectType	HUNGER	Increases hunger.
static final PotionEffectType	INFESTED	Chance of spawning silverfish when hurt.
static final PotionEffectType	INSTANT_DAMAGE	Hurts an entity.
static final PotionEffectType	INSTANT_HEALTH	Heals an entity.
static final PotionEffectType	INVISIBILITY	Grants invisibility.
static final PotionEffectType	JUMP_BOOST	Increases jump height.
static final PotionEffectType	LEVITATION	Causes the entity to float into the air.
static final PotionEffectType	LUCK	Loot table luck.
static final PotionEffectType	MINING_FATIGUE	Decreases dig speed.
static final PotionEffectType	NAUSEA	Warps vision on the client.
static final PotionEffectType	NIGHT_VISION	Allows an entity to see in the dark.
static final PotionEffectType	OOZING	Causes slimes to spawn upon death.
static final PotionEffectType	POISON	Deals damage to an entity over time.
static final PotionEffectType	RAID_OMEN	Triggers a raid when a player enters a village.
static final PotionEffectType	REGENERATION	Regenerates health.
static final PotionEffectType	RESISTANCE	Decreases damage dealt to an entity.
static final PotionEffectType	SATURATION	Increases the food level of an entity each tick.
static final PotionEffectType	SLOW_FALLING	Slows entity fall rate.
static final PotionEffectType	SLOWNESS	Decreases movement speed.
static final PotionEffectType	SPEED	Increases movement speed.
static final PotionEffectType	STRENGTH	Increases damage dealt.
static final PotionEffectType	TRIAL_OMEN	Causes trial spawners to become ominous.
static final PotionEffectType	UNLUCK	Loot table unluck.
static final PotionEffectType	WATER_BREATHING	Allows breathing underwater.
static final PotionEffectType	WEAKNESS	Decreases damage dealt by an entity.
static final PotionEffectType	WEAVING	Creates cobwebs upon death.
static final PotionEffectType	WIND_CHARGED	Emits a wind burst upon death.
static final PotionEffectType	WITHER	Deals damage to an entity over time and gives the health to the shooter.

Constructor Summary

Constructors

Constructor	Description
PotionEffectType()

Method Summary

Modifier and Type	Method	Description
abstract @NotNull PotionEffect	createEffect(int duration, int amplifier)	Creates a PotionEffect from this PotionEffectType, applying duration modifiers and checks.
abstract double	getAttributeModifierAmount(Attribute attribute, int effectAmplifier)	Gets the true modifier amount based on the effect amplifier.
static @Nullable PotionEffectType	getById(int id)	Gets the effect type specified by the unique id.
static @Nullable PotionEffectType	getByKey(@Nullable NamespacedKey key)	Deprecated. only for backwards compatibility, use Registry.get(NamespacedKey) instead.
static @Nullable PotionEffectType	getByName(@NotNull String name)	Deprecated. only for backwards compatibility, use Registry.get(NamespacedKey) instead.
abstract @NotNull PotionEffectTypeCategory	getCategory()	Returns the category of this effect type.
abstract @NotNull Color	getColor()	Returns the color of this effect type.
abstract double	getDurationModifier()	Deprecated. unused, always 1.0
abstract Map<Attribute,AttributeModifier>	getEffectAttributes()	Gets the effect attributes in an immutable map.
abstract PotionEffectType.Category	getEffectCategory()	Gets the category of this effect
abstract int	getId()	Deprecated, for removal: This API element is subject to removal in a future version. use Keyed.key()
abstract @NotNull String	getName()	Deprecated. only for backwards compatibility, use Keyed.getKey() instead.
abstract boolean	isInstant()	Returns whether the effect of this type happens once, immediately.
static @NotNull PotionEffectType[]	values()	Deprecated. use Iterable.iterator().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.papermc.paper.world.flag.FeatureDependant

requiredFeatures

Methods inherited from interface org.bukkit.Keyed

getKey, key

Methods inherited from interface net.kyori.adventure.translation.Translatable

translationKey

Methods inherited from interface org.bukkit.Translatable

getTranslationKey

Field Details

SPEED

public static final PotionEffectType SPEED

Increases movement speed.

SLOWNESS

public static final PotionEffectType SLOWNESS

Decreases movement speed.

HASTE

public static final PotionEffectType HASTE

Increases dig speed.

MINING_FATIGUE

public static final PotionEffectType MINING_FATIGUE

Decreases dig speed.

STRENGTH

public static final PotionEffectType STRENGTH

Increases damage dealt.

INSTANT_HEALTH

public static final PotionEffectType INSTANT_HEALTH

Heals an entity.

INSTANT_DAMAGE

public static final PotionEffectType INSTANT_DAMAGE

Hurts an entity.

JUMP_BOOST

public static final PotionEffectType JUMP_BOOST

Increases jump height.

NAUSEA

public static final PotionEffectType NAUSEA

Warps vision on the client.

REGENERATION

public static final PotionEffectType REGENERATION

Regenerates health.

RESISTANCE

public static final PotionEffectType RESISTANCE

Decreases damage dealt to an entity.

FIRE_RESISTANCE

public static final PotionEffectType FIRE_RESISTANCE

Stops fire damage.

WATER_BREATHING

public static final PotionEffectType WATER_BREATHING

Allows breathing underwater.

INVISIBILITY

public static final PotionEffectType INVISIBILITY

Grants invisibility.

BLINDNESS

public static final PotionEffectType BLINDNESS

Blinds an entity.

NIGHT_VISION

public static final PotionEffectType NIGHT_VISION

Allows an entity to see in the dark.

HUNGER

public static final PotionEffectType HUNGER

Increases hunger.

WEAKNESS

public static final PotionEffectType WEAKNESS

Decreases damage dealt by an entity.

POISON

public static final PotionEffectType POISON

Deals damage to an entity over time.

WITHER

public static final PotionEffectType WITHER

Deals damage to an entity over time and gives the health to the shooter.

HEALTH_BOOST

public static final PotionEffectType HEALTH_BOOST

Increases the maximum health of an entity.

ABSORPTION

public static final PotionEffectType ABSORPTION

Increases the maximum health of an entity with health that cannot be regenerated, but is refilled every 30 seconds.

SATURATION

public static final PotionEffectType SATURATION

Increases the food level of an entity each tick.

GLOWING

public static final PotionEffectType GLOWING

Outlines the entity so that it can be seen from afar.

LEVITATION

public static final PotionEffectType LEVITATION

Causes the entity to float into the air.

LUCK

public static final PotionEffectType LUCK

Loot table luck.

UNLUCK

public static final PotionEffectType UNLUCK

Loot table unluck.

SLOW_FALLING

public static final PotionEffectType SLOW_FALLING

Slows entity fall rate.

CONDUIT_POWER

public static final PotionEffectType CONDUIT_POWER

Effects granted by a nearby conduit. Includes enhanced underwater abilities.

DOLPHINS_GRACE

public static final PotionEffectType DOLPHINS_GRACE

Increses underwater movement speed.
Squee'ek uh'k kk'kkkk squeek eee'eek.

BAD_OMEN

public static final PotionEffectType BAD_OMEN

Triggers an ominous event when the player enters a village or trial chambers.
oof.

HERO_OF_THE_VILLAGE

public static final PotionEffectType HERO_OF_THE_VILLAGE

Reduces the cost of villager trades.
\o/.

DARKNESS

public static final PotionEffectType DARKNESS

Causes the player's vision to dim occasionally.

TRIAL_OMEN

public static final PotionEffectType TRIAL_OMEN

Causes trial spawners to become ominous.

RAID_OMEN

public static final PotionEffectType RAID_OMEN

Triggers a raid when a player enters a village.

WIND_CHARGED

public static final PotionEffectType WIND_CHARGED

Emits a wind burst upon death.

WEAVING

public static final PotionEffectType WEAVING

Creates cobwebs upon death.

OOZING

public static final PotionEffectType OOZING

Causes slimes to spawn upon death.

INFESTED

public static final PotionEffectType INFESTED

Chance of spawning silverfish when hurt.

Constructor Details

PotionEffectType

public PotionEffectType()

Method Details

createEffect

@NotNull
public abstract @NotNull PotionEffect createEffect(int duration,
 int amplifier)

Creates a PotionEffect from this PotionEffectType, applying duration modifiers and checks.

Parameters:

duration - time in ticks

amplifier - the effect's amplifier

Returns:

a resulting potion effect

See Also:

• PotionBrewer.createEffect(PotionEffectType, int, int)

isInstant

public abstract boolean isInstant()

Returns whether the effect of this type happens once, immediately.

Returns:

whether this type is normally instant

getCategory

@NotNull
public abstract @NotNull PotionEffectTypeCategory getCategory()

Returns the category of this effect type.

Returns:

the category

getColor

@NotNull
public abstract @NotNull Color getColor()

Returns the color of this effect type.

Returns:

the color

getDurationModifier

@Deprecated
public abstract double getDurationModifier()

Deprecated.

unused, always 1.0

Returns the duration modifier applied to effects of this type.

Returns:

duration modifier

getId

@Deprecated(forRemoval=true,
            since="1.20.2")
public abstract int getId()

Deprecated, for removal: This API element is subject to removal in a future version.

use Keyed.key()

Returns the unique ID of this type.

Returns:

Unique ID

getName

@NotNull
@Deprecated
public abstract @NotNull String getName()

Deprecated.

only for backwards compatibility, use Keyed.getKey() instead.

Returns the name of this effect type.

Returns:

The name of this effect type

getByKey

@Contract("null -> null")
@Nullable
@Deprecated
public static @Nullable PotionEffectType getByKey(@Nullable
 @Nullable NamespacedKey key)

Deprecated.

only for backwards compatibility, use Registry.get(NamespacedKey) instead.

Gets the PotionEffectType at the specified key

Parameters:

key - key to fetch

Returns:

Resulting PotionEffectType, or null if not found

getById

@Internal
@Nullable
public static @Nullable PotionEffectType getById(int id)

Gets the effect type specified by the unique id.

Parameters:

id - Unique ID to fetch

Returns:

Resulting type, or null if not found.

API Note:

Internal Use Only

getByName

@Nullable
@Deprecated
public static @Nullable PotionEffectType getByName(@NotNull
 @NotNull String name)

Deprecated.

only for backwards compatibility, use Registry.get(NamespacedKey) instead.

Gets the effect type specified by the given name.

Parameters:

name - Name of PotionEffectType to fetch

Returns:

Resulting PotionEffectType, or null if not found.

values

@NotNull
@Deprecated
public static @NotNull PotionEffectType[] values()

Deprecated.

use Iterable.iterator().

Returns:

an array of all known PotionEffectTypes.

getEffectAttributes

@NotNull
public abstract Map<Attribute,AttributeModifier> getEffectAttributes()

Gets the effect attributes in an immutable map.

Returns:

the attribute map

getAttributeModifierAmount

public abstract double getAttributeModifierAmount(@NotNull
 Attribute attribute,
 int effectAmplifier)

Gets the true modifier amount based on the effect amplifier.

Parameters:

attribute - the attribute

effectAmplifier - the effect amplifier (0 indexed)

Returns:

the modifier amount

Throws:

IllegalArgumentException - if the supplied attribute is not present in the map from getEffectAttributes()

getEffectCategory

@NotNull
public abstract PotionEffectType.Category getEffectCategory()

Gets the category of this effect

Returns:

the category