org.bukkit.event.entity
Class EntityDamageEvent

java.lang.Object
  org.bukkit.event.Event
      org.bukkit.event.entity.EntityEvent
          org.bukkit.event.entity.EntityDamageEvent

All Implemented Interfaces:

Cancellable

Direct Known Subclasses:

EntityDamageByBlockEvent, EntityDamageByEntityEvent

public class EntityDamageEvent
extends EntityEvent
implements Cancellable

Stores data for damage events

Nested Class Summary

static class

EntityDamageEvent.DamageCause An enum to specify the cause of the damage

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

EntityDamageEvent(Entity damagee, EntityDamageEvent.DamageCause cause, double damage)

EntityDamageEvent(Entity damagee, EntityDamageEvent.DamageCause cause, int damage)
Deprecated.

Method Summary

int	_INVALID_getDamage() Deprecated.
void	_INVALID_setDamage(int damage) Deprecated.
EntityDamageEvent.DamageCause	getCause() Gets the cause of the damage.
double	getDamage() Gets the amount of damage caused by the event
static HandlerList	getHandlerList()
HandlerList	getHandlers()
boolean	isCancelled() Gets the cancellation state of this event.
void	setCancelled(boolean cancel) Sets the cancellation state of this event.
void	setDamage(double damage) Sets the amount of damage caused by the 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

EntityDamageEvent

@Deprecated
public EntityDamageEvent(Entity damagee,
                                    EntityDamageEvent.DamageCause cause,
                                    int damage)

Deprecated.

EntityDamageEvent

public EntityDamageEvent(Entity damagee,
                         EntityDamageEvent.DamageCause cause,
                         double damage)

Method Detail

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

getDamage

public double getDamage()

Gets the amount of damage caused by the event

Returns:

The amount of damage caused by the event

_INVALID_getDamage

@Deprecated
public int _INVALID_getDamage()

Deprecated.

This method exists for legacy reasons to provide backwards compatibility. It will not exist at runtime and should not be used under any circumstances.

setDamage

public void setDamage(double damage)

Sets the amount of damage caused by the event

Parameters:

damage - The amount of damage caused by the event

_INVALID_setDamage

@Deprecated
public void _INVALID_setDamage(int damage)

Deprecated.

This method exists for legacy reasons to provide backwards compatibility. It will not exist at runtime and should not be used under any circumstances.

getCause

public EntityDamageEvent.DamageCause getCause()

Gets the cause of the damage.

Returns:

A DamageCause value detailing the cause of the damage.

getHandlers

public HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

public static HandlerList getHandlerList()