Package org.bukkit.event.entity
Class EntityPotionEffectEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.entity.EntityEvent
org.bukkit.event.entity.EntityPotionEffectEvent
- All Implemented Interfaces:
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
Modifier and TypeClassDescriptionstatic enum
An enum to specify the action to be performed.static enum
An enum to specify the cause why an effect was changed.Nested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
-
Field Summary
Fields inherited from class org.bukkit.event.entity.EntityEvent
entity
-
Constructor Summary
ConstructorDescriptionEntityPotionEffectEvent
(@NotNull LivingEntity livingEntity, @Nullable PotionEffect oldEffect, @Nullable PotionEffect newEffect, @NotNull EntityPotionEffectEvent.Cause cause, @NotNull EntityPotionEffectEvent.Action action, boolean override) -
Method Summary
Modifier and TypeMethodDescriptionGets the action which will be performed on the potion effect type.getCause()
Gets the cause why the effect has changed.static @NotNull HandlerList
Gets the modified potion effect type.Gets new potion effect of the changed type to be applied.Gets the old potion effect of the changed type, which will be removed.boolean
Gets the cancellation state of this event.boolean
Returns if the new potion effect will override the old potion effect (Only applicable for the CHANGED Action).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 the CHANGED action).Methods inherited from class org.bukkit.event.entity.EntityEvent
getEntity, getEntityType
Methods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
EntityPotionEffectEvent
@Contract("_, null, null, _, _, _ -> fail") public EntityPotionEffectEvent(@NotNull @NotNull LivingEntity livingEntity, @Nullable @Nullable PotionEffect oldEffect, @Nullable @Nullable PotionEffect newEffect, @NotNull @NotNull EntityPotionEffectEvent.Cause cause, @NotNull @NotNull EntityPotionEffectEvent.Action action, boolean override)
-
-
Method Details
-
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
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.
-
getCause
Gets the cause why the effect has changed.- Returns:
- A Cause value why the effect has changed.
-
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
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 the CHANGED Action).- 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 the CHANGED action).- 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 interfaceCancellable
- 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 interfaceCancellable
- Parameters:
cancel
- true if you wish to cancel this event
-
getHandlers
- Specified by:
getHandlers
in classEvent
-
getHandlerList
-