Package io.papermc.paper.event.player

Class PlayerTrackEntityEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.player.PlayerEvent

io.papermc.paper.event.player.PlayerTrackEntityEvent

All Implemented Interfaces:

Cancellable

public class PlayerTrackEntityEvent
extends PlayerEvent
implements Cancellable

Is called when a Player tracks an Entity.

If cancelled entity is not shown to the player and interaction in both directions is not possible.

Adding or removing entities from the world at the point in time this event is called is completely unsupported and should be avoided.

Nested Class Summary

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

Event.Result

Field Summary

Fields inherited from class org.bukkit.event.player.PlayerEvent

player

Constructor Summary

Constructors

Constructor	Description
PlayerTrackEntityEvent(@NotNull Player player, @NotNull Entity entity)

Method Summary

Modifier and Type	Method	Description
@NotNull Entity	getEntity()	Gets the entity that will be tracked
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 org.bukkit.event.player.PlayerEvent

getPlayer

Methods inherited from class org.bukkit.event.Event

asynchronous, callEvent, getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

PlayerTrackEntityEvent

public PlayerTrackEntityEvent(@NotNull
 @NotNull Player player,
 @NotNull
 @NotNull Entity entity)

Method Details

getHandlerList

@NotNull
public static @NotNull HandlerList getHandlerList()

getHandlers

@NotNull
public @NotNull HandlerList getHandlers()

Specified by:

getHandlers in class Event

getEntity

@NotNull
public @NotNull Entity getEntity()

Gets the entity that will be tracked

Returns:

the entity tracked

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