org.bukkit.event.entity
Class EntityRegainHealthEvent

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

public class EntityRegainHealthEvent
extends EntityEvent
implements Cancellable

Stores data for health-regain events


Nested Class Summary
static class EntityRegainHealthEvent.RegainReason
          An enum to specify the type of health regaining that is occurring
 
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
EntityRegainHealthEvent(Entity entity, int amount, EntityRegainHealthEvent.RegainReason regainReason)
           
 
Method Summary
 int getAmount()
          Gets the amount of regained health
static HandlerList getHandlerList()
           
 HandlerList getHandlers()
           
 EntityRegainHealthEvent.RegainReason getRegainReason()
          Gets the reason for why the entity is regaining health
 boolean isCancelled()
          Gets the cancellation state of this event.
 void setAmount(int amount)
          Sets the amount of regained health
 void setCancelled(boolean cancel)
          Sets the cancellation state of this event.
 
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

EntityRegainHealthEvent

public EntityRegainHealthEvent(Entity entity,
                               int amount,
                               EntityRegainHealthEvent.RegainReason regainReason)
Method Detail

getAmount

public int getAmount()
Gets the amount of regained health

Returns:
The amount of health regained

setAmount

public void setAmount(int amount)
Sets the amount of regained health

Parameters:
amount - the amount of health the entity will regain

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

getRegainReason

public EntityRegainHealthEvent.RegainReason getRegainReason()
Gets the reason for why the entity is regaining health

Returns:
A RegainReason detailing the reason for the entity regaining health

getHandlers

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

getHandlerList

public static HandlerList getHandlerList()


Copyright © 2013. All Rights Reserved.