LivingEntity (Glowkit 1.12.2-R6.0-SNAPSHOT API)

All Superinterfaces:

Attributable, CommandSender, Damageable, Entity, Metadatable, Nameable, Permissible, ProjectileSource, ServerOperator

All Known Subinterfaces:

AbstractHorse, Ageable, Ambient, Animals, ArmorStand, Bat, Blaze, CaveSpider, ChestedHorse, Chicken, ComplexLivingEntity, Cow, Creature, Creeper, Donkey, ElderGuardian, EnderDragon, Enderman, Endermite, Evoker, Flying, Ghast, Giant, Golem, Guardian, Horse, HumanEntity, Husk, Illager, Illusioner, IronGolem, Llama, MagmaCube, Monster, Mule, MushroomCow, NPC, Ocelot, Parrot, Pig, PigZombie, Player, PolarBear, Rabbit, RangedEntity, SentientNPC, Sheep, Shulker, Silverfish, Skeleton, SkeletonHorse, Slime, Snowman, Spellcaster, Spider, Squid, Stray, Vex, Villager, Vindicator, WaterMob, Witch, Wither, WitherSkeleton, Wolf, Zombie, ZombieHorse, ZombieVillager
```
public interface LivingEntity
extends Attributable, Entity, Damageable, ProjectileSource
```
Represents a living entity, such as a monster or player

Nested Class Summary
- Nested classes/interfaces inherited from interface org.bukkit.entity.Entity
  Entity.Spigot

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`addPotionEffect(PotionEffect effect)` Adds the given `PotionEffect` to the living entity.
`boolean`	`addPotionEffect(PotionEffect effect, boolean force)` Adds the given `PotionEffect` to the living entity.
`boolean`	`addPotionEffects(Collection<PotionEffect> effects)` Attempts to add all of the given `PotionEffect` to the living entity.
`ItemStack`	`getActiveItem()` Get's the item being actively "used" or consumed.
`Collection<PotionEffect>`	`getActivePotionEffects()` Returns all currently active `PotionEffect`s on the living entity.
`int`	`getArrowsStuck()` Get the number of arrows stuck in this entity
`boolean`	`getCanPickupItems()` Gets if the living entity can pick up items.
`EntityEquipment`	`getEquipment()` Gets the inventory with the equipment worn by the living entity.
`double`	`getEyeHeight()` Gets the height of the living entity's eyes above its Location.
`double`	`getEyeHeight(boolean ignorePose)` Gets the height of the living entity's eyes above its Location.
`Location`	`getEyeLocation()` Get a Location detailing the current eye position of the living entity.
`int`	`getHandRaisedTime()` Get how long the players hands have been raised (Charging Bow attack, using a potion, etc)
`int`	`getItemUseRemainingTime()` Get's remaining time a player needs to keep hands raised with an item to finish using it.
`Player`	`getKiller()` Gets the player identified as the killer of the living entity.
`double`	`getLastDamage()` Returns the living entity's last damage taken in the current no damage ticks time.
`List<Block>`	`getLastTwoTargetBlocks(Set<Material> transparent, int maxDistance)` Gets the last two blocks along the living entity's line of sight.
`Entity`	`getLeashHolder()` Gets the entity that is currently leading this entity.
`List<Block>`	`getLineOfSight(Set<Material> transparent, int maxDistance)` Gets all blocks along the living entity's line of sight.
`int`	`getMaximumAir()` Returns the maximum amount of air the living entity can have, in ticks.
`int`	`getMaximumNoDamageTicks()` Returns the living entity's current maximum no damage ticks.
`int`	`getNoDamageTicks()` Returns the living entity's current no damage ticks.
`PotionEffect`	`getPotionEffect(PotionEffectType type)` Returns the active `PotionEffect` of the specified type.
`int`	`getRemainingAir()` Returns the amount of air that the living entity has remaining, in ticks.
`boolean`	`getRemoveWhenFarAway()` Returns if the living entity despawns when away from players or not.
`int`	`getShieldBlockingDelay()` Get the delay (in ticks) before blocking is effective for this entity
`Block`	`getTargetBlock(Set<Material> transparent, int maxDistance)` Gets the block that the living entity has targeted.
`boolean`	`hasAI()` Checks whether an entity has AI.
`boolean`	`hasLineOfSight(Entity other)` Checks whether the living entity has block line of sight to another.
`boolean`	`hasPotionEffect(PotionEffectType type)` Returns whether the living entity already has an existing effect of the given `PotionEffectType` applied to it.
`boolean`	`isCollidable()` Gets if this entity is subject to collisions with other entities.
`boolean`	`isGliding()` Checks to see if an entity is gliding, such as using an Elytra.
`boolean`	`isHandRaised()` Whether or not this entity is using or charging an attack (Bow pulled back, drinking potion, eating food)
`boolean`	`isLeashed()` Returns whether the entity is currently leashed.
`void`	`playAnimation(EntityAnimation animation)` Plays an animation for this entity to nearby clients.
`void`	`removePotionEffect(PotionEffectType type)` Removes any effects present of the given `PotionEffectType`.
`void`	`setAI(boolean ai)` Sets whether an entity will have AI.
`void`	`setArrowsStuck(int arrows)` Set the number of arrows stuck in this entity
`void`	`setCanPickupItems(boolean pickup)` Sets whether or not the living entity can pick up items.
`void`	`setCollidable(boolean collidable)` Set if this entity will be subject to collisions other entities.
`void`	`setGliding(boolean gliding)` Makes entity start or stop gliding.
`void`	`setKiller(Player killer)` Sets the player identified as the killer of the living entity.
`void`	`setLastDamage(double damage)` Sets the damage dealt within the current no damage ticks time period.
`boolean`	`setLeashHolder(Entity holder)` Sets the leash on this entity to be held by the supplied entity.
`void`	`setMaximumAir(int ticks)` Sets the maximum amount of air the living entity can have, in ticks.
`void`	`setMaximumNoDamageTicks(int ticks)` Sets the living entity's current maximum no damage ticks.
`void`	`setNoDamageTicks(int ticks)` Sets the living entity's current no damage ticks.
`void`	`setRemainingAir(int ticks)` Sets the amount of air that the living entity has remaining, in ticks.
`void`	`setRemoveWhenFarAway(boolean remove)` Sets whether or not the living entity despawns when away from players or not.
`void`	`setShieldBlockingDelay(int delay)` Set the delay (in ticks) before blocking is effective for this entity

Methods inherited from interface org.bukkit.attribute.Attributable
getAttribute

Methods inherited from interface org.bukkit.entity.Damageable
damage, damage, damage, damage, getHealth, getMaxHealth, resetMaxHealth, setHealth, setMaxHealth

Methods inherited from interface org.bukkit.entity.Entity
addPassenger, addScoreboardTag, eject, fromMobSpawner, getChunk, getEntityId, getFallDistance, getFireTicks, getHeight, getLastDamageCause, getLocation, getLocation, getMaxFireTicks, getNearbyEntities, getOrigin, getPassenger, getPassengers, getPistonMoveReaction, getPortalCooldown, getScoreboardTags, getServer, getTicksLived, getType, getUniqueId, getVehicle, getVelocity, getWidth, getWorld, hasGravity, isCustomNameVisible, isDead, isEmpty, isGlowing, isInsideVehicle, isInvulnerable, isOnGround, isSilent, isValid, leaveVehicle, playEffect, remove, removePassenger, removeScoreboardTag, setCustomNameVisible, setFallDistance, setFireTicks, setGlowing, setGravity, setInvulnerable, setLastDamageCause, setPassenger, setPortalCooldown, setSilent, setTicksLived, setVelocity, spigot, teleport, teleport, teleport, teleport

Methods inherited from interface org.bukkit.metadata.Metadatable
getMetadata, hasMetadata, removeMetadata, setMetadata

Methods inherited from interface org.bukkit.command.CommandSender
getName, sendMessage, sendMessage, sendMessage, sendMessage

Methods inherited from interface org.bukkit.permissions.Permissible
addAttachment, addAttachment, addAttachment, addAttachment, getEffectivePermissions, hasPermission, hasPermission, isPermissionSet, isPermissionSet, recalculatePermissions, removeAttachment

Methods inherited from interface org.bukkit.permissions.ServerOperator
isOp, setOp

Methods inherited from interface org.bukkit.Nameable
getCustomName, setCustomName

Methods inherited from interface org.bukkit.projectiles.ProjectileSource
launchProjectile, launchProjectile

- Method Detail
  - getEyeHeight
```
double getEyeHeight()
```
    Gets the height of the living entity's eyes above its Location.
    
    Returns:
    
    height of the living entity's eyes above its location
  - getEyeHeight
```
double getEyeHeight(boolean ignorePose)
```
    Gets the height of the living entity's eyes above its Location.
    
    Parameters:
    
    ignorePose - if set to true, the effects of pose changes, eg sneaking and gliding will be ignored
    
    Returns:
    
    height of the living entity's eyes above its location
  - getEyeLocation
```
Location getEyeLocation()
```
    Get a Location detailing the current eye position of the living entity.
    
    Returns:
    
    a location at the eyes of the living entity
  - getLineOfSight
```
List<Block> getLineOfSight(Set<Material> transparent,
                           int maxDistance)
```
    Gets all blocks along the living entity's line of sight.
    This list contains all blocks from the living entity's eye position to target inclusive.
    
    Parameters:
    
    transparent - HashSet containing all transparent block Materials (set to null for only air)
    
    maxDistance - this is the maximum distance to scan (may be limited by server by at least 100 blocks, no less)
    
    Returns:
    
    list containing all blocks along the living entity's line of sight
  - getTargetBlock
```
Block getTargetBlock(Set<Material> transparent,
                     int maxDistance)
```
    Gets the block that the living entity has targeted.
    
    Parameters:
    
    transparent - HashSet containing all transparent block Materials (set to null for only air)
    
    maxDistance - this is the maximum distance to scan (may be limited by server by at least 100 blocks, no less)
    
    Returns:
    
    block that the living entity has targeted
  - getLastTwoTargetBlocks
```
List<Block> getLastTwoTargetBlocks(Set<Material> transparent,
                                   int maxDistance)
```
    Gets the last two blocks along the living entity's line of sight.
    The target block will be the last block in the list.
    
    Parameters:
    
    transparent - HashSet containing all transparent block Materials (set to null for only air)
    
    maxDistance - this is the maximum distance to scan. This may be further limited by the server, but never to less than 100 blocks
    
    Returns:
    
    list containing the last 2 blocks along the living entity's line of sight
  - getRemainingAir
```
int getRemainingAir()
```
    Returns the amount of air that the living entity has remaining, in ticks.
    
    Returns:
    
    amount of air remaining
  - setRemainingAir
```
void setRemainingAir(int ticks)
```
    Sets the amount of air that the living entity has remaining, in ticks.
    
    Parameters:
    
    ticks - amount of air remaining
  - getMaximumAir
```
int getMaximumAir()
```
    Returns the maximum amount of air the living entity can have, in ticks.
    
    Returns:
    
    maximum amount of air
  - setMaximumAir
```
void setMaximumAir(int ticks)
```
    Sets the maximum amount of air the living entity can have, in ticks.
    
    Parameters:
    
    ticks - maximum amount of air
  - getMaximumNoDamageTicks
```
int getMaximumNoDamageTicks()
```
    Returns the living entity's current maximum no damage ticks.
    This is the maximum duration in which the living entity will not take damage.
    
    Returns:
    
    maximum no damage ticks
  - setMaximumNoDamageTicks
```
void setMaximumNoDamageTicks(int ticks)
```
    Sets the living entity's current maximum no damage ticks.
    
    Parameters:
    
    ticks - maximum amount of no damage ticks
  - getLastDamage
```
double getLastDamage()
```
    Returns the living entity's last damage taken in the current no damage ticks time.
    Only damage higher than this amount will further damage the living entity.
    
    Returns:
    
    damage taken since the last no damage ticks time period
  - setLastDamage
```
void setLastDamage(double damage)
```
    Sets the damage dealt within the current no damage ticks time period.
    
    Parameters:
    
    damage - amount of damage
  - getNoDamageTicks
```
int getNoDamageTicks()
```
    Returns the living entity's current no damage ticks.
    
    Returns:
    
    amount of no damage ticks
  - setNoDamageTicks
```
void setNoDamageTicks(int ticks)
```
    Sets the living entity's current no damage ticks.
    
    Parameters:
    
    ticks - amount of no damage ticks
  - getKiller
```
Player getKiller()
```
    Gets the player identified as the killer of the living entity.
    May be null.
    
    Returns:
    
    killer player, or null if none found
  - setKiller
```
void setKiller(@Nullable
               Player killer)
```
    Sets the player identified as the killer of the living entity.
    
    Parameters:
    
    killer - player
  - addPotionEffect
```
boolean addPotionEffect(PotionEffect effect)
```
    Adds the given PotionEffect to the living entity.
    Only one potion effect can be present for a given PotionEffectType.
    
    Parameters:
    
    effect - PotionEffect to be added
    
    Returns:
    
    whether the effect could be added
  - addPotionEffect
```
boolean addPotionEffect(PotionEffect effect,
                        boolean force)
```
    Adds the given PotionEffect to the living entity.
    Only one potion effect can be present for a given PotionEffectType.
    
    Parameters:
    
    effect - PotionEffect to be added
    
    force - whether conflicting effects should be removed
    
    Returns:
    
    whether the effect could be added
  - addPotionEffects
```
boolean addPotionEffects(Collection<PotionEffect> effects)
```
    Attempts to add all of the given PotionEffect to the living entity.
    
    Parameters:
    
    effects - the effects to add
    
    Returns:
    
    whether all of the effects could be added
  - hasPotionEffect
```
boolean hasPotionEffect(PotionEffectType type)
```
    Returns whether the living entity already has an existing effect of the given PotionEffectType applied to it.
    
    Parameters:
    
    type - the potion type to check
    
    Returns:
    
    whether the living entity has this potion effect active on them
  - getPotionEffect
```
PotionEffect getPotionEffect(PotionEffectType type)
```
    Returns the active PotionEffect of the specified type.
    If the effect is not present on the entity then null will be returned.
    
    Parameters:
    
    type - the potion type to check
    
    Returns:
    
    the effect active on this entity, or null if not active.
  - removePotionEffect
```
void removePotionEffect(PotionEffectType type)
```
    Removes any effects present of the given PotionEffectType.
    
    Parameters:
    
    type - the potion type to remove
  - getActivePotionEffects
```
Collection<PotionEffect> getActivePotionEffects()
```
    Returns all currently active PotionEffects on the living entity.
    
    Returns:
    
    a collection of PotionEffects
  - hasLineOfSight
```
boolean hasLineOfSight(Entity other)
```
    Checks whether the living entity has block line of sight to another.
    This uses the same algorithm that hostile mobs use to find the closest player.
    
    Parameters:
    
    other - the entity to determine line of sight to
    
    Returns:
    
    true if there is a line of sight, false if not
  - getRemoveWhenFarAway
```
boolean getRemoveWhenFarAway()
```
    Returns if the living entity despawns when away from players or not.
    By default, animals are not removed while other mobs are.
    
    Returns:
    
    true if the living entity is removed when away from players
  - setRemoveWhenFarAway
```
void setRemoveWhenFarAway(boolean remove)
```
    Sets whether or not the living entity despawns when away from players or not.
    
    Parameters:
    
    remove - the removal status
  - getEquipment
```
EntityEquipment getEquipment()
```
    Gets the inventory with the equipment worn by the living entity.
    
    Returns:
    
    the living entity's inventory
  - setCanPickupItems
```
void setCanPickupItems(boolean pickup)
```
    Sets whether or not the living entity can pick up items.
    
    Parameters:
    
    pickup - whether or not the living entity can pick up items
  - getCanPickupItems
```
boolean getCanPickupItems()
```
    Gets if the living entity can pick up items.
    
    Returns:
    
    whether or not the living entity can pick up items
  - isLeashed
```
boolean isLeashed()
```
    Returns whether the entity is currently leashed.
    
    Returns:
    
    whether the entity is leashed
  - getLeashHolder
```
Entity getLeashHolder()
               throws IllegalStateException
```
    Gets the entity that is currently leading this entity.
    
    Returns:
    
    the entity holding the leash
    
    Throws:
    
    IllegalStateException - if not currently leashed
  - setLeashHolder
```
boolean setLeashHolder(Entity holder)
```
    Sets the leash on this entity to be held by the supplied entity.
    This method has no effect on EnderDragons, Withers, Players, or Bats. Non-living entities excluding leashes will not persist as leash holders.
    
    Parameters:
    
    holder - the entity to leash this entity to
    
    Returns:
    
    whether the operation was successful
  - isGliding
```
boolean isGliding()
```
    Checks to see if an entity is gliding, such as using an Elytra.
    
    Returns:
    
    True if this entity is gliding.
  - setGliding
```
void setGliding(boolean gliding)
```
    Makes entity start or stop gliding. This will work even if an Elytra is not equipped, but will be reverted by the server immediately after unless an event-cancelling mechanism is put in place.
    
    Parameters:
    
    gliding - True if the entity is gliding.
  - setAI
```
void setAI(boolean ai)
```
    Sets whether an entity will have AI.
    
    Parameters:
    
    ai - whether the mob will have AI or not.
  - hasAI
```
boolean hasAI()
```
    Checks whether an entity has AI.
    
    Returns:
    
    true if the entity has AI, otherwise false.
  - setCollidable
```
void setCollidable(boolean collidable)
```
    Set if this entity will be subject to collisions other entities.
    Note that collisions are bidirectional, so this method would need to be set to false on both the collidee and the collidant to ensure no collisions take place.
    
    Parameters:
    
    collidable - collision status
  - isCollidable
```
boolean isCollidable()
```
    Gets if this entity is subject to collisions with other entities.
    Please note that this method returns only the custom collidable state, not whether the entity is non-collidable for other reasons such as being dead.
    
    Returns:
    
    collision status
  - getArrowsStuck
```
int getArrowsStuck()
```
    Get the number of arrows stuck in this entity
    
    Returns:
    
    Number of arrows stuck
  - setArrowsStuck
```
void setArrowsStuck(int arrows)
```
    Set the number of arrows stuck in this entity
    
    Parameters:
    
    arrows - Number of arrows to stick in this entity
  - getShieldBlockingDelay
```
int getShieldBlockingDelay()
```
    Get the delay (in ticks) before blocking is effective for this entity
    
    Returns:
    
    Delay in ticks
  - setShieldBlockingDelay
```
void setShieldBlockingDelay(int delay)
```
    Set the delay (in ticks) before blocking is effective for this entity
    
    Parameters:
    
    delay - Delay in ticks
  - getActiveItem
```
ItemStack getActiveItem()
```
    Get's the item being actively "used" or consumed.
    
    Returns:
    
    The item. Will be null if no active item.
  - getItemUseRemainingTime
```
int getItemUseRemainingTime()
```
    Get's remaining time a player needs to keep hands raised with an item to finish using it.
    
    Returns:
    
    Remaining ticks to use the item
  - getHandRaisedTime
```
int getHandRaisedTime()
```
    Get how long the players hands have been raised (Charging Bow attack, using a potion, etc)
    
    Returns:
    
    Get how long the players hands have been raised (Charging Bow attack, using a potion, etc)
  - isHandRaised
```
boolean isHandRaised()
```
    Whether or not this entity is using or charging an attack (Bow pulled back, drinking potion, eating food)
    
    Returns:
    
    Whether or not this entity is using or charging an attack (Bow pulled back, drinking potion, eating food)
  - playAnimation
```
void playAnimation(EntityAnimation animation)
```
    Plays an animation for this entity to nearby clients.
    
    Parameters:
    
    animation - the animation to play

Interface LivingEntity

Nested Class Summary

Nested classes/interfaces inherited from interface org.bukkit.entity.Entity

Method Summary

Methods inherited from interface org.bukkit.attribute.Attributable

Methods inherited from interface org.bukkit.entity.Damageable

Methods inherited from interface org.bukkit.entity.Entity

Methods inherited from interface org.bukkit.metadata.Metadatable

Methods inherited from interface org.bukkit.command.CommandSender

Methods inherited from interface org.bukkit.permissions.Permissible

Methods inherited from interface org.bukkit.permissions.ServerOperator

Methods inherited from interface org.bukkit.Nameable

Methods inherited from interface org.bukkit.projectiles.ProjectileSource

Method Detail

getEyeHeight

getEyeHeight

getEyeLocation

getLineOfSight

getTargetBlock

getLastTwoTargetBlocks

getRemainingAir

setRemainingAir

getMaximumAir

setMaximumAir

getMaximumNoDamageTicks

setMaximumNoDamageTicks

getLastDamage

setLastDamage

getNoDamageTicks

setNoDamageTicks

getKiller

setKiller

addPotionEffect

addPotionEffect

addPotionEffects

hasPotionEffect

getPotionEffect

removePotionEffect

getActivePotionEffects

hasLineOfSight

getRemoveWhenFarAway

setRemoveWhenFarAway

getEquipment

setCanPickupItems

getCanPickupItems

isLeashed

getLeashHolder

setLeashHolder

isGliding

setGliding

setAI

hasAI

setCollidable

isCollidable

getArrowsStuck

setArrowsStuck

getShieldBlockingDelay

setShieldBlockingDelay

getActiveItem

getItemUseRemainingTime

getHandRaisedTime

isHandRaised

playAnimation