Class PlayerTrackEntityEvent

java.lang.Object
org.bukkit.event.Event
org.bukkit.event.player.PlayerEvent
io.papermc.paper.event.player.PlayerTrackEntityEvent
All Implemented Interfaces:
Cancellable
@NullMarked 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. Teleporting entities in the world at the point in time this event is called yields an undefined tracker behavior and should be avoided.

Since:
1.19.2

  • Constructor Details

    • PlayerTrackEntityEvent

      @Internal public PlayerTrackEntityEvent(Player player, Entity entity)

  • Method Details

    • getEntity

      public Entity getEntity()
      Gets the entity that will be tracked
      Returns:
      the entity tracked
      Since:
      1.19.2

    • 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
      Since:
      1.20.1

    • 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
      Since:
      1.20.1

    • getHandlerList

      public static HandlerList getHandlerList()
      Since:
      1.19.2

    • getHandlers

      public HandlerList getHandlers()
      Specified by:
      getHandlers in class Event
      Since:
      1.19.2