Package io.papermc.paper.event.entity
Class EntityKnockbackEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.entity.EntityEvent
io.papermc.paper.event.entity.EntityKnockbackEvent
- All Implemented Interfaces:
Cancellable
- Direct Known Subclasses:
EntityPushedByEntityAttackEvent
Called when an entity receives knockback.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
An enum to specify the cause of the knockback.Nested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
-
Field Summary
FieldsFields inherited from class org.bukkit.event.entity.EntityEvent
entity
-
Constructor Summary
ConstructorsConstructorDescriptionEntityKnockbackEvent
(@NonNull Entity entity, @NonNull EntityKnockbackEvent.Cause cause, @NonNull Vector knockback) -
Method Summary
Modifier and TypeMethodDescription@NonNull EntityKnockbackEvent.Cause
getCause()
Gets the cause of the knockback.static @NonNull HandlerList
@NonNull HandlerList
@NonNull Vector
Gets the knockback force that will be applied to the entity.boolean
Gets the cancellation state of this event.void
setCancelled
(boolean cancel) Sets the cancellation state of this event.void
setKnockback
(@NonNull Vector knockback) Sets the knockback force that will be applied to the entity.Methods inherited from class org.bukkit.event.entity.EntityEvent
getEntity, getEntityType
Methods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Field Details
-
knockback
-
-
Constructor Details
-
EntityKnockbackEvent
@Internal public EntityKnockbackEvent(@NonNull Entity entity, @NonNull EntityKnockbackEvent.Cause cause, @NonNull Vector knockback)
-
-
Method Details
-
getCause
Gets the cause of the knockback.- Returns:
- the cause of the knockback
-
getKnockback
Gets the knockback force that will be applied to the entity.
This value is read-only, changes made to it will not have any effect on the final knockback received. UsesetKnockback(Vector)
to make changes.- Returns:
- the knockback
-
setKnockback
Sets the knockback force that will be applied to the entity.- Parameters:
knockback
- the knockback
-
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
-