Package io.papermc.paper.event.entity
Class EntityEffectTickEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.entity.EntityEvent
io.papermc.paper.event.entity.EntityEffectTickEvent
- All Implemented Interfaces:
Cancellable
An event that is triggered when an entity receives a potion effect instantly
or when the potion effect is applied on each tick (e.g. every 25 ticks for Poison level 1).
For example, this event may be called when an entity regenerates health or takes poison damage as a result of a potion effect.
-
Nested Class Summary
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
ConstructorDescriptionEntityEffectTickEvent
(LivingEntity entity, PotionEffectType type, int amplifier) -
Method Summary
Modifier and TypeMethodDescriptionint
Gets the amplifier level of the potion effect associated with this event.Returns the Entity involved in this eventstatic HandlerList
getType()
Gets the type of the potion effect associated with this event.boolean
Gets the cancellation state of this event.void
setCancelled
(boolean cancel) Sets the cancellation state of this event.Methods inherited from class org.bukkit.event.entity.EntityEvent
getEntityType
Methods inherited from class org.bukkit.event.Event
callEvent, getEventContext, getEventName, isAsynchronous, isSupportInterrupt
-
Constructor Details
-
EntityEffectTickEvent
-
-
Method Details
-
getEntity
Description copied from class:EntityEvent
Returns the Entity involved in this event- Overrides:
getEntity
in classEntityEvent
- Returns:
- Entity who is involved in this event
-
getType
Gets the type of the potion effect associated with this event.- Returns:
- the
PotionEffectType
of the effect
-
getAmplifier
public int getAmplifier()Gets the amplifier level of the potion effect associated with this event.- Returns:
- the amplifier level of the potion effect
-
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
-