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

Public Member Functions

 PlayerUnleashEntityEvent (Entity entity, Player player)
 
Player getPlayer ()
 
boolean isCancelled ()
 
void setCancelled (boolean cancel)
 
- Public Member Functions inherited from org.bukkit.event.entity.EntityUnleashEvent
 EntityUnleashEvent (Entity entity, UnleashReason reason)
 
UnleashReason getReason ()
 
HandlerList getHandlers ()
 
- Public Member Functions inherited from org.bukkit.event.entity.EntityEvent
 EntityEvent (final Entity what)
 
Entity getEntity ()
 
EntityType getEntityType ()
 
- Public Member Functions inherited from org.bukkit.event.Event
 Event ()
 
 Event (boolean isAsync)
 
String getEventName ()
 
abstract HandlerList getHandlers ()
 
final boolean isAsynchronous ()
 

Additional Inherited Members

- Static Public Member Functions inherited from org.bukkit.event.entity.EntityUnleashEvent
static HandlerList getHandlerList ()
 
- Protected Attributes inherited from org.bukkit.event.entity.EntityEvent
Entity entity
 

Detailed Description

Called prior to an entity being unleashed due to a player's action.

Definition at line 11 of file PlayerUnleashEntityEvent.java.

Member Function Documentation

Player org.bukkit.event.player.PlayerUnleashEntityEvent.getPlayer ( )

Returns the player who is unleashing the entity.

Returns
The player

Definition at line 25 of file PlayerUnleashEntityEvent.java.

25  {
26  return player;
27  }
boolean org.bukkit.event.player.PlayerUnleashEntityEvent.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 29 of file PlayerUnleashEntityEvent.java.

29  {
30  return cancelled;
31  }
void org.bukkit.event.player.PlayerUnleashEntityEvent.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 33 of file PlayerUnleashEntityEvent.java.

33  {
34  this.cancelled = cancel;
35  }

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