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, Horse, 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 _INVALID_damage(int amount)
          Deprecated. 
 void _INVALID_damage(int amount, Entity source)
          Deprecated. 
 int _INVALID_getHealth()
          Deprecated. 
 int _INVALID_getMaxHealth()
          Deprecated. 
 void _INVALID_setHealth(int health)
          Deprecated. 
 void _INVALID_setMaxHealth(int health)
          Deprecated. 
 void damage(double amount)
          Deals the given amount of damage to this entity.
 void damage(double amount, Entity source)
          Deals the given amount of damage to this entity, from a specified entity.
 double getHealth()
          Gets the entity's health from 0 to getMaxHealth(), where 0 is dead.
 double getMaxHealth()
          Gets the maximum health this entity has.
 void resetMaxHealth()
          Resets the max health to the original amount.
 void setHealth(double health)
          Sets the entity's health from 0 to getMaxHealth(), where 0 is dead.
 void setMaxHealth(double 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(double amount)
Deals the given amount of damage to this entity.

Parameters:
amount - Amount of damage to deal

_INVALID_damage

@Deprecated
void _INVALID_damage(int amount)
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.


damage

void damage(double 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

_INVALID_damage

@Deprecated
void _INVALID_damage(int amount,
                                Entity source)
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.


getHealth

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

Returns:
Health represented from 0 to max

_INVALID_getHealth

@Deprecated
int _INVALID_getHealth()
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.


setHealth

void setHealth(double 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()

_INVALID_setHealth

@Deprecated
void _INVALID_setHealth(int health)
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.


getMaxHealth

double getMaxHealth()
Gets the maximum health this entity has.

Returns:
Maximum health

_INVALID_getMaxHealth

@Deprecated
int _INVALID_getMaxHealth()
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.


setMaxHealth

void setMaxHealth(double 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

_INVALID_setMaxHealth

@Deprecated
void _INVALID_setMaxHealth(int health)
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.


resetMaxHealth

void resetMaxHealth()
Resets the max health to the original amount.



Copyright © 2013. All Rights Reserved.