org.bukkit.event.player
Class PlayerUnleashEntityEvent

java.lang.Object
  extended by org.bukkit.event.Event
      extended by org.bukkit.event.entity.EntityEvent
          extended by org.bukkit.event.entity.EntityUnleashEvent
              extended by org.bukkit.event.player.PlayerUnleashEntityEvent
All Implemented Interfaces:
Cancellable

public class PlayerUnleashEntityEvent
extends EntityUnleashEvent
implements Cancellable

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


Nested Class Summary
 
Nested classes/interfaces inherited from class org.bukkit.event.entity.EntityUnleashEvent
EntityUnleashEvent.UnleashReason
 
Nested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
 
Field Summary
 
Fields inherited from class org.bukkit.event.entity.EntityEvent
entity
 
Constructor Summary
PlayerUnleashEntityEvent(Entity entity, Player player)
           
 
Method Summary
 Player getPlayer()
          Returns the player who is unleashing the entity.
 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.entity.EntityUnleashEvent
getHandlerList, getHandlers, getReason
 
Methods inherited from class org.bukkit.event.entity.EntityEvent
getEntity, getEntityType
 
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

PlayerUnleashEntityEvent

public PlayerUnleashEntityEvent(Entity entity,
                                Player player)
Method Detail

getPlayer

public Player getPlayer()
Returns the player who is unleashing the entity.

Returns:
The player

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 © 2014. All rights reserved.