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 EntitygetEntity()Returns the entity being leashed.static HandlerListgetHandlerList()HandlerListgetHandlers()EntitygetLeashHolder()Returns the entity that is holding the leash.PlayergetPlayer()Returns the player involved in this eventbooleanisCancelled()Gets the cancellation state of this event.voidsetCancelled(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:
getHandlersin classEvent
-
getHandlerList
-
isCancelled
public boolean isCancelled()Description copied from interface:CancellableGets 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:
isCancelledin interfaceCancellable- Returns:
- true if this event is cancelled
-
setCancelled
public void setCancelled(boolean cancel)Description copied from interface:CancellableSets 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:
setCancelledin interfaceCancellable- Parameters:
cancel- true if you wish to cancel this event
-