Package org.bukkit.event.entity
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.
-
Nested Class Summary
-
Constructor Summary
Constructors Constructor Description PlayerLeashEntityEvent(Entity what, Entity leashHolder, Player leasher)
-
Method Summary
Modifier and Type Method Description Entity
getEntity()
Returns the entity being leashed.static HandlerList
getHandlerList()
HandlerList
getHandlers()
Entity
getLeashHolder()
Returns the entity that is holding the leash.Player
getPlayer()
Returns the player involved in this eventboolean
isCancelled()
Gets the cancellation state of this event.void
setCancelled(boolean cancel)
Sets the cancellation state of this event.
-
Constructor Details
-
Method Details
-
getLeashHolder
Returns the entity that is holding the leash.- Returns:
- The leash holder
-
getEntity
Returns the entity being leashed.- Returns:
- The entity
-
getPlayer
Returns the player involved in this event- Returns:
- Player who is involved in this event
-
getHandlers
- Specified by:
getHandlers
in classEvent
-
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 interfaceCancellable
- 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 interfaceCancellable
- Parameters:
cancel
- true if you wish to cancel this event
-