Package org.bukkit.potion

Class PotionEffect

java.lang.Object

org.bukkit.potion.PotionEffect

All Implemented Interfaces:

ConfigurationSerializable

public class PotionEffect
extends Object
implements ConfigurationSerializable

Represents a potion effect, that can be added to a LivingEntity. A potion effect has a duration that it will last for, an amplifier that will enhance its effects, and a PotionEffectType, that represents its effect on an entity.

Constructor Summary

Constructors

Constructor	Description
PotionEffect(@NotNull Map<String,Object> map)	Constructor for deserialization.
PotionEffect(@NotNull PotionEffectType type, int duration, int amplifier)	Creates a potion effect.
PotionEffect(@NotNull PotionEffectType type, int duration, int amplifier, boolean ambient)	Creates a potion effect.
PotionEffect(@NotNull PotionEffectType type, int duration, int amplifier, boolean ambient, boolean particles)	Creates a potion effect with no defined color.
PotionEffect(@NotNull PotionEffectType type, int duration, int amplifier, boolean ambient, boolean particles, boolean icon)	Creates a potion effect.

Method Summary

Modifier and Type	Method	Description
boolean	apply(@NotNull LivingEntity entity)	Attempts to add the effect represented by this object to the given LivingEntity.
boolean	equals(Object obj)
int	getAmplifier()	Returns the amplifier of this effect.
@Nullable Color	getColor()	Deprecated. color is not part of potion effects
int	getDuration()	Returns the duration (in ticks) that this effect will run for when applied to a LivingEntity.
@NotNull PotionEffectType	getType()	Returns the PotionEffectType of this effect.
int	hashCode()
boolean	hasIcon()
boolean	hasParticles()
boolean	isAmbient()	Makes potion effect produce more, translucent, particles.
@NotNull Map<String,Object>	serialize()	Creates a Map representation of this class.
String	toString()
@NotNull PotionEffect	withAmbient(boolean ambient)
@NotNull PotionEffect	withAmplifier(int amplifier)
@NotNull PotionEffect	withDuration(int duration)
@NotNull PotionEffect	withIcon(boolean icon)
@NotNull PotionEffect	withParticles(boolean particles)
@NotNull PotionEffect	withType(@NotNull PotionEffectType type)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PotionEffect

public PotionEffect(@NotNull
                    @NotNull PotionEffectType type,
                    int duration,
                    int amplifier,
                    boolean ambient,
                    boolean particles,
                    boolean icon)

Creates a potion effect.

Parameters:

type - effect type

duration - measured in ticks, see getDuration()

amplifier - the amplifier, see getAmplifier()

ambient - the ambient status, see isAmbient()

particles - the particle status, see hasParticles()

icon - the icon status, see hasIcon()

PotionEffect

public PotionEffect(@NotNull
                    @NotNull PotionEffectType type,
                    int duration,
                    int amplifier,
                    boolean ambient,
                    boolean particles)

Creates a potion effect with no defined color.

Parameters:

type - effect type

duration - measured in ticks, see getDuration()

amplifier - the amplifier, see getAmplifier()

ambient - the ambient status, see isAmbient()

particles - the particle status, see hasParticles()

PotionEffect

public PotionEffect(@NotNull
                    @NotNull PotionEffectType type,
                    int duration,
                    int amplifier,
                    boolean ambient)

Creates a potion effect. Assumes that particles are visible

Parameters:

type - effect type

duration - measured in ticks, see getDuration()

amplifier - the amplifier, see getAmplifier()

ambient - the ambient status, see isAmbient()

PotionEffect

public PotionEffect(@NotNull
                    @NotNull PotionEffectType type,
                    int duration,
                    int amplifier)

Creates a potion effect. Assumes ambient is true.

Parameters:

type - Effect type

duration - measured in ticks

amplifier - the amplifier for the effect

See Also:

PotionEffect(PotionEffectType, int, int, boolean)

PotionEffect

public PotionEffect(@NotNull
                    @NotNull Map<String,Object> map)

Constructor for deserialization.

Parameters:

map - the map to deserialize from

Method Detail

withType

@NotNull
public @NotNull PotionEffect withType(@NotNull
                                      @NotNull PotionEffectType type)

withDuration

@NotNull
public @NotNull PotionEffect withDuration(int duration)

withAmplifier

@NotNull
public @NotNull PotionEffect withAmplifier(int amplifier)

withAmbient

@NotNull
public @NotNull PotionEffect withAmbient(boolean ambient)

withParticles

@NotNull
public @NotNull PotionEffect withParticles(boolean particles)

withIcon

@NotNull
public @NotNull PotionEffect withIcon(boolean icon)

serialize

@NotNull
public @NotNull Map<String,Object> serialize()

Description copied from interface: ConfigurationSerializable

Creates a Map representation of this class.

This class must provide a method to restore this class, as defined in the ConfigurationSerializable interface javadocs.

Specified by:

serialize in interface ConfigurationSerializable

Returns:

Map containing the current state of this class

apply

public boolean apply(@NotNull
                     @NotNull LivingEntity entity)

Attempts to add the effect represented by this object to the given LivingEntity.

Parameters:

entity - The entity to add this effect to

Returns:

Whether the effect could be added

See Also:

LivingEntity.addPotionEffect(PotionEffect)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getAmplifier

public int getAmplifier()

Returns the amplifier of this effect. A higher amplifier means the potion effect happens more often over its duration and in some cases has more effect on its target.

Returns:

The effect amplifier

getDuration

public int getDuration()

Returns the duration (in ticks) that this effect will run for when applied to a LivingEntity.

Returns:

The duration of the effect

getType

@NotNull
public @NotNull PotionEffectType getType()

Returns the PotionEffectType of this effect.

Returns:

The potion type of this effect

isAmbient

public boolean isAmbient()

Makes potion effect produce more, translucent, particles.

Returns:

if this effect is ambient

hasParticles

public boolean hasParticles()

Returns:

whether this effect has particles or not

getColor

@Deprecated
@Nullable
@Contract("-> null")
public @Nullable Color getColor()

Deprecated.

color is not part of potion effects

Returns:

color of this potion's particles. May be null if the potion has no particles or defined color.

hasIcon

public boolean hasIcon()

Returns:

whether this effect has an icon or not

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object