Package org.bukkit.entity

Interface Damageable

All Superinterfaces:
Audience, CommandSender, Entity, HoverEventSource<HoverEvent.ShowEntity>, Metadatable, Nameable, Permissible, PersistentDataHolder, PersistentDataViewHolder, Pointered, ServerOperator, Sound.Emitter
All Known Subinterfaces:
AbstractHorse, AbstractSkeleton, AbstractVillager, Ageable, Allay, Ambient, Animals, Armadillo, ArmorStand, Axolotl, Bat, Bee, Blaze, Bogged, Breedable, Breeze, Camel, Cat, CaveSpider, ChestedHorse, Chicken, Cod, CollarColorable, ComplexLivingEntity, Cow, Creaking, CreakingTransient, Creature, Creeper, Dolphin, Donkey, Drowned, ElderGuardian, EnderDragon, EnderDragonPart, Enderman, Endermite, Enemy, Evoker, Fish, Flying, Fox, Frog, Ghast, Giant, GlowSquid, Goat, Golem, Guardian, Hoglin, Horse, HumanEntity, Husk, Illager, Illusioner, IronGolem, LivingEntity, Llama, MagmaCube, Mob, Monster, Mule, MushroomCow, NPC, Ocelot, Panda, Parrot, Phantom, Pig, Piglin, PiglinAbstract, PiglinBrute, PigZombie, Pillager, Player, PolarBear, PufferFish, Rabbit, Raider, RangedEntity, Ravager, Salmon, SchoolableFish, Sheep, Shulker, Silverfish, Skeleton, SkeletonHorse, Slime, Sniffer, Snowman, Spellcaster, Spider, Squid, Steerable, Stray, Strider, Tadpole, Tameable, TraderLlama, TropicalFish, Turtle, Vex, Villager, Vindicator, WanderingTrader, Warden, WaterMob, Witch, Wither, WitherSkeleton, Wolf, Zoglin, Zombie, ZombieHorse, ZombieVillager
public interface Damageable extends Entity
Represents an Entity that has health and can take damage.

  • Method Details

    • damage

      void damage(double amount)
      Deals the given amount of damage to this entity.
      Parameters:
      amount - Amount of damage to deal

    • damage

      void damage(double amount, @Nullable @Nullable Entity source)
      Deals the given amount of damage to this entity from a specified Entity.
      Parameters:
      amount - amount of damage to deal
      source - entity to which the damage should be attributed

    • damage

      @Experimental void damage(double amount, @NotNull @NotNull DamageSource damageSource)
      Deals the given amount of damage to this entity from a specified DamageSource.
      Parameters:
      amount - amount of damage to deal
      damageSource - source to which the damage should be attributed

    • getHealth

      double getHealth()
      Gets the entity's health from 0 to getMaxHealth(), where 0 is dead.
      Returns:
      Health represented from 0 to max

    • 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()

    • heal

      default void heal(double amount)
      Heal this entity by the given amount. This will call EntityRegainHealthEvent.
      Parameters:
      amount - heal amount

    • heal

      void heal(double amount, @NotNull EntityRegainHealthEvent.RegainReason reason)
      Heal this entity by the given amount. This will call EntityRegainHealthEvent.
      Parameters:
      amount - heal amount
      reason - heal reason

    • getAbsorptionAmount

      double getAbsorptionAmount()
      Gets the entity's absorption amount.
      Returns:
      absorption amount from 0

    • setAbsorptionAmount

      void setAbsorptionAmount(double amount)
      Sets the entity's absorption amount.

      Note: The amount is capped to the value of Attribute.MAX_ABSORPTION. The effect of this method on that attribute is currently unspecified and subject to change.

      Parameters:
      amount - new absorption amount from 0
      Throws:
      IllegalArgumentException - thrown if health is < 0 or non-finite.

    • getMaxHealth

      @Deprecated double getMaxHealth()
      Deprecated.
      use Attribute.MAX_HEALTH.
      Gets the maximum health this entity has.
      Returns:
      Maximum health

    • setMaxHealth

      @Deprecated void setMaxHealth(double health)
      Deprecated.
      use Attribute.MAX_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

      @Deprecated void resetMaxHealth()
      Deprecated.
      use Attribute.MAX_HEALTH.
      Resets the max health to the original amount.