Package io.papermc.paper.event.entity

Class EntityPushedByEntityAttackEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.entity.EntityEvent

io.papermc.paper.event.entity.EntityKnockbackEvent

io.papermc.paper.event.entity.EntityPushedByEntityAttackEvent

All Implemented Interfaces:

Cancellable

Direct Known Subclasses:

EntityKnockbackByEntityEvent

@NullMarked
public class EntityPushedByEntityAttackEvent
extends EntityKnockbackEvent
implements Cancellable

Fired when an entity is pushed by another entity's attack. The acceleration vector can be modified. If this event is cancelled, the entity will not get pushed.

Note: Some entities might trigger this multiple times on the same entity as multiple acceleration calculations are done.

Nested Class Summary

Nested classes/interfaces inherited from class io.papermc.paper.event.entity.EntityKnockbackEvent

EntityKnockbackEvent.Cause

Nested classes/interfaces inherited from class org.bukkit.event.Event

Event.Result

Field Summary

Fields inherited from class io.papermc.paper.event.entity.EntityKnockbackEvent

knockback

Fields inherited from class org.bukkit.event.entity.EntityEvent

entity

Constructor Summary

Constructors

Constructor	Description
EntityPushedByEntityAttackEvent(Entity entity, EntityKnockbackEvent.Cause cause, Entity pushedBy, Vector knockback)

Method Summary

Modifier and Type	Method	Description
Vector	getAcceleration()	Deprecated, for removal: This API element is subject to removal in a future version. use EntityKnockbackEvent.getKnockback()
Entity	getPushedBy()	Gets the entity which pushed the affected entity.
boolean	isCancelled()	Gets the cancellation state of this event.
void	setAcceleration(Vector acceleration)	Deprecated, for removal: This API element is subject to removal in a future version. use EntityKnockbackEvent.setKnockback(Vector)
void	setCancelled(boolean cancel)	Sets the cancellation state of this event.

Methods inherited from class io.papermc.paper.event.entity.EntityKnockbackEvent

getCause, getHandlerList, getHandlers, getKnockback, setKnockback

Methods inherited from class org.bukkit.event.entity.EntityEvent

getEntity, getEntityType

Methods inherited from class org.bukkit.event.Event

callEvent, getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

EntityPushedByEntityAttackEvent

@Internal
public EntityPushedByEntityAttackEvent(Entity entity,
 EntityKnockbackEvent.Cause cause,
 Entity pushedBy,
 Vector knockback)

Method Details

getPushedBy

public Entity getPushedBy()

Gets the entity which pushed the affected entity.

Returns:

the pushing entity

getAcceleration

@Deprecated(since="1.20.6",
            forRemoval=true)
public Vector getAcceleration()

Deprecated, for removal: This API element is subject to removal in a future version.

use EntityKnockbackEvent.getKnockback()

Gets the acceleration that will be applied to the affected entity.

Returns:

the acceleration vector

setAcceleration

@Deprecated(since="1.20.6",
            forRemoval=true)
public void setAcceleration(Vector acceleration)

Deprecated, for removal: This API element is subject to removal in a future version.

use EntityKnockbackEvent.setKnockback(Vector)

Sets the relative acceleration that will be applied to the affected entity.

Parameters:

acceleration - the new acceleration vector

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

Overrides:

isCancelled in class EntityKnockbackEvent

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

Overrides:

setCancelled in class EntityKnockbackEvent

Parameters:

cancel - true if you wish to cancel this event