org.bukkit.entity
Interface Damageable

All Superinterfaces:

Entity, Metadatable

All Known Subinterfaces:

Ageable, Ambient, Animals, Bat, Blaze, CaveSpider, Chicken, ComplexLivingEntity, Cow, Creature, Creeper, EnderDragon, EnderDragonPart, Enderman, Flying, Ghast, Giant, Golem, HumanEntity, IronGolem, LivingEntity, MagmaCube, Monster, MushroomCow, NPC, Ocelot, Pig, PigZombie, Player, Sheep, Silverfish, Skeleton, Slime, Snowman, Spider, Squid, Villager, WaterMob, Witch, Wither, Wolf, Zombie

public interface Damageable
extends Entity

Represents an Entity that has health and can take damage.

Method Summary

void	damage(int amount) Deals the given amount of damage to this entity.
void	damage(int amount, Entity source) Deals the given amount of damage to this entity, from a specified entity.
int	getHealth() Gets the entity's health from 0 to getMaxHealth(), where 0 is dead.
int	getMaxHealth() Gets the maximum health this entity has.
void	resetMaxHealth() Resets the max health to the original amount.
void	setHealth(int health) Sets the entity's health from 0 to getMaxHealth(), where 0 is dead.
void	setMaxHealth(int health) Sets the maximum health this entity can have.

Methods inherited from interface org.bukkit.entity.Entity

eject, getEntityId, getFallDistance, getFireTicks, getLastDamageCause, getLocation, getLocation, getMaxFireTicks, getNearbyEntities, getPassenger, getServer, getTicksLived, getType, getUniqueId, getVehicle, getVelocity, getWorld, isDead, isEmpty, isInsideVehicle, isOnGround, isValid, leaveVehicle, playEffect, remove, setFallDistance, setFireTicks, setLastDamageCause, setPassenger, setTicksLived, setVelocity, teleport, teleport, teleport, teleport

Methods inherited from interface org.bukkit.metadata.Metadatable

getMetadata, hasMetadata, removeMetadata, setMetadata

Method Detail

damage

void damage(int amount)

Deals the given amount of damage to this entity.

Parameters:

amount - Amount of damage to deal

damage

void damage(int amount,
            Entity source)

Deals the given amount of damage to this entity, from a specified entity.

Parameters:

amount - Amount of damage to deal

source - Entity which to attribute this damage from

getHealth

int getHealth()

Gets the entity's health from 0 to getMaxHealth(), where 0 is dead.

Returns:

Health represented from 0 to max

setHealth

void setHealth(int health)

Sets the entity's health from 0 to getMaxHealth(), where 0 is dead.

Parameters:

health - New health represented from 0 to max

Throws:

IllegalArgumentException - Thrown if the health is < 0 or > getMaxHealth()

getMaxHealth

int getMaxHealth()

Gets the maximum health this entity has.

Returns:

Maximum health

setMaxHealth

void setMaxHealth(int health)

Sets the maximum health this entity can have.

If the health of the entity is above the value provided it will be set to that value.

Note: An entity with a health bar (Player, EnderDragon, Wither, etc...} will have their bar scaled accordingly.

Parameters:

health - amount of health to set the maximum to

resetMaxHealth

void resetMaxHealth()

Resets the max health to the original amount.