org.bukkit.event.entity
Class PlayerLeashEntityEvent

java.lang.Object
  extended by org.bukkit.event.Event
      extended by 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
 
Nested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
 
Constructor Summary
PlayerLeashEntityEvent(Entity what, Entity leashHolder, Player leasher)
           
 
Method Summary
 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 event
 boolean isCancelled()
          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
getEventName, isAsynchronous
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PlayerLeashEntityEvent

public PlayerLeashEntityEvent(Entity what,
                              Entity leashHolder,
                              Player leasher)
Method Detail

getLeashHolder

public Entity getLeashHolder()
Returns the entity that is holding the leash.

Returns:
The leash holder

getEntity

public Entity getEntity()
Returns the entity being leashed.

Returns:
The entity

getPlayer

public final Player getPlayer()
Returns the player involved in this event

Returns:
Player who is involved in this event

getHandlers

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

getHandlerList

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


Copyright © 2013. All Rights Reserved.