Package org.bukkit.event.entity
Class PlayerLeashEntityEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.entity.PlayerLeashEntityEvent
- All Implemented Interfaces:
Cancellable
Called immediately prior to a creature being leashed by a player.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionReturns the entity being leashed.getHand()
Returns the hand used by the player to leash the entity.static @NotNull HandlerList
Returns the entity that is holding the leash.Returns the player involved in this eventboolean
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.Event
callEvent, getEventName, isAsynchronous
-
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
-
getHand
Returns the hand used by the player to leash the entity.- Returns:
- the hand
-
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
-