Class EntityPotionEffectEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.entity.EntityEvent

org.bukkit.event.entity.EntityPotionEffectEvent

All Implemented Interfaces:

Cancellable

@NullMarked
public class EntityPotionEffectEvent
extends EntityEvent
implements Cancellable

Called when a potion effect is modified on an entity.

If the event is cancelled, no change will be made on the entity.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EntityPotionEffectEvent.Action	An enum to specify the action to be performed.
static enum	EntityPotionEffectEvent.Cause	An enum to specify the cause why an effect was changed.

Nested classes/interfaces inherited from class Event

Event.Result

Field Summary

Fields inherited from class EntityEvent

entity

Constructor Summary

Constructors

Constructor	Description
EntityPotionEffectEvent(LivingEntity livingEntity, @Nullable PotionEffect oldEffect, @Nullable PotionEffect newEffect, @Nullable Entity entitySource, EntityPotionEffectEvent.Cause cause, EntityPotionEffectEvent.Action action, boolean override)

Method Summary

Modifier and Type	Method	Description
EntityPotionEffectEvent.Action	getAction()	Gets the action which will be performed on the potion effect type.
EntityPotionEffectEvent.Cause	getCause()	Gets the cause why the effect has changed.
LivingEntity	getEntity()	Returns the Entity involved in this event
static HandlerList	getHandlerList()
HandlerList	getHandlers()
PotionEffectType	getModifiedType()	Gets the modified potion effect type.
@Nullable PotionEffect	getNewEffect()	Gets new potion effect of the changed type to be applied.
@Nullable PotionEffect	getOldEffect()	Gets the old potion effect of the changed type, which will be removed.
@Nullable Entity	getSource()	Gets the entity which caused the effect to change (Not applicable for EntityPotionEffectEvent.Action.REMOVED).
boolean	isCancelled()	Gets the cancellation state of this event.
boolean	isOverride()	Returns if the new potion effect will override the old potion effect (Only applicable for EntityPotionEffectEvent.Action.CHANGED).
void	setCancelled(boolean cancel)	Sets the cancellation state of this event.
void	setOverride(boolean override)	Sets if the new potion effect will override the old potion effect (Only applicable for EntityPotionEffectEvent.Action.CHANGED).

Methods inherited from class EntityEvent

getEntityType

Methods inherited from class Event

callEvent, getEventName, isAsynchronous

Methods inherited from class Object

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

Constructor Details

EntityPotionEffectEvent

@Internal
public EntityPotionEffectEvent(LivingEntity livingEntity,
 @Nullable PotionEffect oldEffect,
 @Nullable PotionEffect newEffect,
 @Nullable Entity entitySource,
 EntityPotionEffectEvent.Cause cause,
 EntityPotionEffectEvent.Action action,
 boolean override)

Method Details

getEntity

public LivingEntity getEntity()

Description copied from class: EntityEvent

Returns the Entity involved in this event

Overrides:

getEntity in class EntityEvent

Returns:

Entity who is involved in this event

getOldEffect

public @Nullable PotionEffect getOldEffect()

Gets the old potion effect of the changed type, which will be removed.

Returns:

The old potion effect or null if the entity did not have the changed effect type.

getNewEffect

public @Nullable PotionEffect getNewEffect()

Gets new potion effect of the changed type to be applied.

Returns:

The new potion effect or null if the effect of the changed type will be removed.

getSource

public @Nullable Entity getSource()

Gets the entity which caused the effect to change (Not applicable for EntityPotionEffectEvent.Action.REMOVED).

Returns:

The entity which caused the effect to change or null

getCause

public EntityPotionEffectEvent.Cause getCause()

Gets the cause why the effect has changed.

Returns:

A Cause value why the effect has changed.

getAction

public EntityPotionEffectEvent.Action getAction()

Gets the action which will be performed on the potion effect type.

Returns:

An action to be performed on the potion effect type.

getModifiedType

public PotionEffectType getModifiedType()

Gets the modified potion effect type.

Returns:

The effect type which will be modified on the entity.

isOverride

public boolean isOverride()

Returns if the new potion effect will override the old potion effect (Only applicable for EntityPotionEffectEvent.Action.CHANGED).

Returns:

If the new effect will override the old one.

setOverride

public void setOverride(boolean override)

Sets if the new potion effect will override the old potion effect (Only applicable for EntityPotionEffectEvent.Action.CHANGED).

Parameters:

override - If the new effect will override the old one.

isCancelled

public boolean isCancelled()

Description copied from interface: Cancellable

Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins

Specified by:

isCancelled in interface Cancellable

Returns:

true if this event is cancelled

setCancelled

public void setCancelled(boolean cancel)

Description copied from interface: Cancellable

Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancel - true if you wish to cancel this event

getHandlers

public HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

public static HandlerList getHandlerList()