Bukkit-API  1.7.9-R0.2
The inofficial Bukkit-API
org.bukkit.event.entity.PlayerLeashEntityEvent Class Reference
Inheritance diagram for org.bukkit.event.entity.PlayerLeashEntityEvent:
org.bukkit.event.Event org.bukkit.event.Cancellable

Public Member Functions

 PlayerLeashEntityEvent (Entity what, Entity leashHolder, Player leasher)
 
Entity getLeashHolder ()
 
Entity getEntity ()
 
final Player getPlayer ()
 
HandlerList getHandlers ()
 
boolean isCancelled ()
 
void setCancelled (boolean cancel)
 
- Public Member Functions inherited from org.bukkit.event.Event
 Event ()
 
 Event (boolean isAsync)
 
String getEventName ()
 
abstract HandlerList getHandlers ()
 
final boolean isAsynchronous ()
 

Static Public Member Functions

static HandlerList getHandlerList ()
 

Detailed Description

Called immediately prior to a creature being leashed by a player.

Definition at line 12 of file PlayerLeashEntityEvent.java.

Member Function Documentation

Entity org.bukkit.event.entity.PlayerLeashEntityEvent.getEntity ( )

Returns the entity being leashed.

Returns
The entity

Definition at line 39 of file PlayerLeashEntityEvent.java.

39  {
40  return entity;
41  }
Entity org.bukkit.event.entity.PlayerLeashEntityEvent.getLeashHolder ( )

Returns the entity that is holding the leash.

Returns
The leash holder

Definition at line 30 of file PlayerLeashEntityEvent.java.

30  {
31  return leashHolder;
32  }
final Player org.bukkit.event.entity.PlayerLeashEntityEvent.getPlayer ( )

Returns the player involved in this event

Returns
Player who is involved in this event

Definition at line 48 of file PlayerLeashEntityEvent.java.

48  {
49  return player;
50  }
boolean org.bukkit.event.entity.PlayerLeashEntityEvent.isCancelled ( )

Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins

Returns
true if this event is cancelled

Implements org.bukkit.event.Cancellable.

Definition at line 61 of file PlayerLeashEntityEvent.java.

61  {
62  return this.cancelled;
63  }
void org.bukkit.event.entity.PlayerLeashEntityEvent.setCancelled ( boolean  cancel)

Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

Parameters
canceltrue if you wish to cancel this event

Implements org.bukkit.event.Cancellable.

Definition at line 65 of file PlayerLeashEntityEvent.java.

65  {
66  this.cancelled = cancel;
67  }

The documentation for this class was generated from the following file: