Class EntityCollideWithEntityEvent

java.lang.Object

org.bukkit.event.Event

io.papermc.paper.event.entity.EntityCollideWithEntityEvent

All Implemented Interfaces:

Cancellable

public class EntityCollideWithEntityEvent
extends Event
implements Cancellable

Fired when two entities collide with each other. If cancelled, the entities won't get pushed away from each other.

Note that even if cancelled, the client may still run its own collision unless disabled via player teams.

Nested Class Summary

Nested classes/interfaces inherited from class Event

Event.Result

Constructor Summary

Constructors

Constructor	Description
EntityCollideWithEntityEvent(@NotNull Entity entity1, @NotNull Entity entity2)

Method Summary

Modifier and Type	Method	Description
@NotNull List<Entity>	getEntities()	Returns the entities involved in this event
static @NotNull HandlerList	getHandlerList()
@NotNull HandlerList	getHandlers()
boolean	isCancelled()	Gets the cancellation state of this event.
void	setCancelled(boolean cancel)	Sets the cancellation state of this event.

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

EntityCollideWithEntityEvent

@Internal
public EntityCollideWithEntityEvent(@NotNull
 @NotNull Entity entity1,
 @NotNull
 @NotNull Entity entity2)

Method Details

getEntities

@NotNull
public @NotNull List<Entity> getEntities()

Returns the entities involved in this event

Returns:

entities that are involved in this event

getHandlers

@NotNull
public @NotNull HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

@NotNull
public static @NotNull HandlerList getHandlerList()

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