Class PlayerLeashEntityEvent

java.lang.Object
org.bukkit.event.Event
org.bukkit.event.entity.PlayerLeashEntityEvent
All Implemented Interfaces:
Cancellable

public class PlayerLeashEntityEvent extends Event implements Cancellable
Called immediately prior to a creature being leashed by a player.
  • Constructor Details

    • PlayerLeashEntityEvent

      public PlayerLeashEntityEvent(@NotNull Entity what, @NotNull Entity leashHolder, @NotNull Player leasher, @NotNull EquipmentSlot hand)
    • PlayerLeashEntityEvent

      @Deprecated public PlayerLeashEntityEvent(@NotNull Entity what, @NotNull Entity leashHolder, @NotNull Player leasher)
      Deprecated.
  • Method Details

    • getLeashHolder

      @NotNull public Entity getLeashHolder()
      Returns the entity that is holding the leash.
      Returns:
      The leash holder
    • getEntity

      @NotNull public Entity getEntity()
      Returns the entity being leashed.
      Returns:
      The entity
    • getPlayer

      @NotNull public final Player getPlayer()
      Returns the player involved in this event
      Returns:
      Player who is involved in this event
    • getHand

      @NotNull public EquipmentSlot getHand()
      Returns the hand used by the player to leash the entity.
      Returns:
      the hand
    • getHandlers

      @NotNull public HandlerList getHandlers()
      Specified by:
      getHandlers in class Event
    • getHandlerList

      @NotNull public static 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