Entity (Cloudburst 0.0.1-SNAPSHOT API)

All Superinterfaces:

Metadatable

All Known Subinterfaces:

AreaEffectCloud, ArmorStand, Arrow, Bat, Blaze, Boat, Cat, CaveSpider, ChestMinecart, Chicken, Cod, CommandBlockMinecart, Cow, Creeper, DeprecatedVillager, DeprecatedZombieVillager, Dolphin, Donkey, DragonFireball, DroppedItem, Drowned, Egg, ElderGuardian, EnderCrystal, EnderDragon, Enderman, Endermite, EnderPearl, EvocationFang, EvocationIllager, ExperienceOrb, EyeOfEnderSignal, FallingBlock, Fireball, FireworksRocket, FishingHook, Ghast, Guardian, HopperMinecart, Horse, Husk, IronGolem, LeashKnot, LightningBolt, LingeringPotion, Llama, LlamaSpit, MagmaCube, Minecart, Mooshroom, Mule, Ocelot, Painting, Panda, Parrot, Phantom, Pig, Pillager, PolarBear, PrimedTnt, Projectile, Pufferfish, Rabbit, Ravager, Rideable, Salmon, Sheep, Shulker, ShulkerBullet, Silverfish, Skeleton, SkeletonHorse, Slime, SmallFireball, Snowball, SnowGolem, Spider, SplashPotion, Squid, Stray, ThrownTrident, TntMinecart, TropicalFish, Turtle, Vex, Villager, Vindicator, WanderingTrader, Witch, Wither, WitherSkeleton, WitherSkull, Wolf, XpBottle, Zombie, ZombieHorse, ZombiePigman, ZombieVillager

All Known Implementing Classes:

Animal, BaseEntity, EntityAbstractMinecart, EntityAreaEffectCloud, EntityArmorStand, EntityArrow, EntityBat, EntityBlaze, EntityBoat, EntityCat, EntityCaveSpider, EntityChestMinecart, EntityChicken, EntityCod, EntityCommandBlockMinecart, EntityCow, EntityCreature, EntityCreeper, EntityDeprecatedVillager, EntityDeprecatedZombieVillager, EntityDolphin, EntityDonkey, EntityDragonFireball, EntityDroppedItem, EntityDrowned, EntityEgg, EntityElderGuardian, EntityEnderCrystal, EntityEnderDragon, EntityEnderman, EntityEndermite, EntityEnderPearl, EntityEvocationFang, EntityEvocationIllager, EntityExperienceOrb, EntityEyeOfEnderSignal, EntityFallingBlock, EntityFireball, EntityFireworksRocket, EntityFishingHook, EntityGhast, EntityGuardian, EntityHopperMinecart, EntityHorse, EntityHostile, EntityHusk, EntityIronGolem, EntityLeashKnot, EntityLightningBolt, EntityLingeringPotion, EntityLiving, EntityLlama, EntityLlamaSpit, EntityMagmaCube, EntityMinecart, EntityMooshroom, EntityMule, EntityOcelot, EntityPainting, EntityPanda, EntityParrot, EntityPhantom, EntityPig, EntityPillager, EntityPolarBear, EntityPrimedTnt, EntityProjectile, EntityPufferfish, EntityRabbit, EntityRavager, EntitySalmon, EntitySheep, EntityShulker, EntityShulkerBullet, EntitySilverfish, EntitySkeleton, EntitySkeletonHorse, EntitySlime, EntitySmallFireball, EntitySnowball, EntitySnowGolem, EntitySpider, EntitySplashPotion, EntitySquid, EntityStray, EntityTameable, EntityThrownTrident, EntityTntMinecart, EntityTropicalFish, EntityTurtle, EntityVehicle, EntityVex, EntityVillager, EntityVindicator, EntityWanderingTrader, EntityWaterAnimal, EntityWitch, EntityWither, EntityWitherSkeleton, EntityWitherSkull, EntityWolf, EntityXpBottle, EntityZombie, EntityZombieHorse, EntityZombiePigman, EntityZombieVillager, HangingEntity, Human, Player, UnknownEntity
```
public interface Entity
extends Metadatable
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`addEffect(Effect effect)`
`boolean`	`attack(EntityDamageEvent source)`
`default boolean`	`attack(float damage)`
`boolean`	`canBeMovedByCurrents()`
`boolean`	`canCollide()`
`boolean`	`canCollideWith(Entity entity)`
`boolean`	`canPassThrough()`
`boolean`	`canTriggerPressurePlate()` Whether the entity can active pressure plates.
`void`	`close()`
`void`	`despawnFrom(Player player)`
`void`	`despawnFromAll()`
`boolean`	`dismount(Entity vehicle)`
`void`	`extinguish()`
`void`	`fall(float fallDistance)`
`float`	`getAbsorption()`
`AxisAlignedBB`	`getBoundingBox()`
`SyncedEntityData`	`getData()`
`Direction`	`getDirection()`
`com.nukkitx.math.vector.Vector2f`	`getDirectionPlane()`
`com.nukkitx.math.vector.Vector3f`	`getDirectionVector()`
`float`	`getDrag()`
`Effect`	`getEffect(int effectId)`
`it.unimi.dsi.fastutil.shorts.Short2ObjectMap<Effect>`	`getEffects()`
`float`	`getEyeHeight()`
`int`	`getFireTicks()`
`float`	`getGravity()`
`float`	`getHealth()`
`float`	`getHeight()`
`float`	`getHighestPosition()`
`Direction`	`getHorizontalDirection()`
`EntityDamageEvent`	`getLastDamageCause()`
`float`	`getLength()`
`Level`	`getLevel()`
`Location`	`getLocation()`
`int`	`getMaxHealth()`
`com.nukkitx.math.vector.Vector3f`	`getMotion()`
`String`	`getName()`
`String`	`getNameTag()`
`int`	`getNoDamageTicks()`
`Entity`	`getOwner()`
`List<Entity>`	`getPassengers()`
`float`	`getPitch()`
`com.nukkitx.math.vector.Vector3f`	`getPosition()`
`long`	`getRuntimeId()`
`float`	`getScale()`
`com.nukkitx.math.vector.Vector3f`	`getSeatPosition()`
`Server`	`getServer()`
`com.nukkitx.nbt.NbtMap`	`getTag()`
`EntityType<?>`	`getType()`
`long`	`getUniqueId()`
`Entity`	`getVehicle()`
`Set<Player>`	`getViewers()`
`float`	`getWidth()`
`float`	`getX()`
`float`	`getY()`
`float`	`getYaw()`
`float`	`getZ()`
`boolean`	`hasControllingPassenger()`
`boolean`	`hasEffect(int effectId)`
`boolean`	`hasNameTag()`
`void`	`heal(EntityRegainHealthEvent source)`
`default void`	`heal(float amount)`
`default boolean`	`isAlive()`
`boolean`	`isClosed()`
`boolean`	`isControlling(Entity entity)`
`boolean`	`isNameTagVisible()`
`default boolean`	`isOnFire()`
`boolean`	`isOnGround()`
`boolean`	`isPassenger(Entity entity)`
`default boolean`	`isUndead()`
`void`	`kill()`
`void`	`loadAdditionalData(com.nukkitx.nbt.NbtMap tag)`
`default boolean`	`mount(Entity entity)`
`boolean`	`mount(Entity vehicle, com.nukkitx.protocol.bedrock.data.entity.EntityLinkData.Type mode)` Enter into a vehicle
`void`	`onDismount(Entity passenger)`
`void`	`onEntityCollision(Entity entity)`
`boolean`	`onInteract(Player player, Item item, com.nukkitx.math.vector.Vector3f clickedPos)`
`void`	`onMount(Entity passenger)`
`void`	`onStruckByLightning(LightningBolt lightningBolt)`
`boolean`	`onUpdate(int currentTick)`
`void`	`removeAllEffects()`
`void`	`removeEffect(int effectId)`
`void`	`resetFallDistance()`
`void`	`saveAdditionalData(com.nukkitx.nbt.NbtMapBuilder tag)`
`void`	`setAbsorption(float absorption)`
`void`	`setHealth(float health)`
`void`	`setHighestPosition(float highestPosition)`
`void`	`setMaxHealth(int maxHealth)`
`boolean`	`setMotion(com.nukkitx.math.vector.Vector3f motion)`
`void`	`setNameTag(String name)`
`void`	`setNoDamageTicks(int noDamageTicks)`
`void`	`setOnFire(int seconds)`
`void`	`setOnGround(boolean onGround)`
`void`	`setOwner(Entity entity)`
`boolean`	`setPosition(com.nukkitx.math.vector.Vector3f pos)`
`boolean`	`setPositionAndRotation(com.nukkitx.math.vector.Vector3f pos, float yaw, float pitch)`
`void`	`setRotation(float yaw, float pitch)`
`void`	`setScale(float scale)`
`void`	`setSeatPosition(com.nukkitx.math.vector.Vector3f pos)`
`void`	`spawnTo(Player player)`
`void`	`spawnToAll()`
`default boolean`	`teleport(Location location)`
`boolean`	`teleport(Location location, PlayerTeleportEvent.TeleportCause cause)`
`default boolean`	`teleport(com.nukkitx.math.vector.Vector3f pos)`
`boolean`	`teleport(com.nukkitx.math.vector.Vector3f pos, PlayerTeleportEvent.TeleportCause cause)`

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

Method Detail

getType
```
EntityType<?> getType()
```

getLevel
```
Level getLevel()
```

getServer
```
Server getServer()
```

getUniqueId
```
long getUniqueId()
```

getRuntimeId
```
long getRuntimeId()
```

getHeight
```
float getHeight()
```

getEyeHeight
```
float getEyeHeight()
```

getWidth
```
float getWidth()
```

getLength
```
float getLength()
```

loadAdditionalData

void loadAdditionalData(com.nukkitx.nbt.NbtMap tag)

saveAdditionalData

void saveAdditionalData(com.nukkitx.nbt.NbtMapBuilder tag)

canCollide
```
boolean canCollide()
```

onEntityCollision
```
void onEntityCollision(Entity entity)
```

getGravity
```
float getGravity()
```

getDrag
```
float getDrag()
```

hasNameTag
```
boolean hasNameTag()
```

getNameTag
```
String getNameTag()
```

setNameTag
```
void setNameTag(String name)
```

isNameTagVisible
```
boolean isNameTagVisible()
```

getScale
```
float getScale()
```

setScale
```
void setScale(float scale)
```

getPassengers
```
List<Entity> getPassengers()
```

isPassenger
```
boolean isPassenger(Entity entity)
```

isControlling
```
boolean isControlling(Entity entity)
```

hasControllingPassenger
```
boolean hasControllingPassenger()
```

getSeatPosition

com.nukkitx.math.vector.Vector3f getSeatPosition()

setSeatPosition

void setSeatPosition(com.nukkitx.math.vector.Vector3f pos)

getVehicle
```
Entity getVehicle()
```

mount
```
default boolean mount(Entity entity)
```

mount
```
boolean mount(Entity vehicle,
              com.nukkitx.protocol.bedrock.data.entity.EntityLinkData.Type mode)
```
Enter into a vehicle

Parameters:

vehicle - vehicle to mount

mode - mode

Returns:

whether or not the mount was successful

dismount
```
boolean dismount(Entity vehicle)
```

onMount
```
void onMount(Entity passenger)
```

onDismount
```
void onDismount(Entity passenger)
```

getEffects

it.unimi.dsi.fastutil.shorts.Short2ObjectMap<Effect> getEffects()

removeAllEffects
```
void removeAllEffects()
```

getEffect
```
Effect getEffect(int effectId)
```

removeEffect
```
void removeEffect(int effectId)
```

hasEffect
```
boolean hasEffect(int effectId)
```

addEffect
```
void addEffect(Effect effect)
```

getName
```
String getName()
```

spawnTo
```
void spawnTo(Player player)
```

spawnToAll
```
void spawnToAll()
```

despawnFrom
```
void despawnFrom(Player player)
```

despawnFromAll
```
void despawnFromAll()
```

getViewers
```
Set<Player> getViewers()
```

attack
```
default boolean attack(float damage)
```

attack

boolean attack(EntityDamageEvent source)

heal
```
default void heal(float amount)
```

heal

void heal(EntityRegainHealthEvent source)

getHealth
```
float getHealth()
```

setHealth
```
void setHealth(float health)
```

getMaxHealth
```
int getMaxHealth()
```

setMaxHealth
```
void setMaxHealth(int maxHealth)
```

isAlive
```
default boolean isAlive()
```

getLastDamageCause
```
EntityDamageEvent getLastDamageCause()
```

canCollideWith
```
boolean canCollideWith(Entity entity)
```

getDirection
```
Direction getDirection()
```

getDirectionVector

com.nukkitx.math.vector.Vector3f getDirectionVector()

getDirectionPlane

com.nukkitx.math.vector.Vector2f getDirectionPlane()

getHorizontalDirection
```
Direction getHorizontalDirection()
```

onUpdate
```
boolean onUpdate(int currentTick)
```

getAbsorption
```
float getAbsorption()
```

setAbsorption
```
void setAbsorption(float absorption)
```

isOnFire
```
default boolean isOnFire()
```

setOnFire

void setOnFire(@Nonnegative
               int seconds)

getFireTicks
```
@Nonnegative
int getFireTicks()
```

extinguish
```
void extinguish()
```

getNoDamageTicks
```
int getNoDamageTicks()
```

setNoDamageTicks

void setNoDamageTicks(int noDamageTicks)

getHighestPosition
```
float getHighestPosition()
```

setHighestPosition

void setHighestPosition(float highestPosition)

resetFallDistance
```
void resetFallDistance()
```

getBoundingBox
```
AxisAlignedBB getBoundingBox()
```

fall
```
void fall(float fallDistance)
```

onStruckByLightning

void onStruckByLightning(LightningBolt lightningBolt)

onInteract

boolean onInteract(Player player,
                   Item item,
                   com.nukkitx.math.vector.Vector3f clickedPos)

getX
```
float getX()
```

getY
```
float getY()
```

getZ
```
float getZ()
```

getPosition

com.nukkitx.math.vector.Vector3f getPosition()

setPosition

boolean setPosition(com.nukkitx.math.vector.Vector3f pos)

getLocation
```
Location getLocation()
```

getMotion

com.nukkitx.math.vector.Vector3f getMotion()

setMotion

boolean setMotion(com.nukkitx.math.vector.Vector3f motion)

setRotation

void setRotation(float yaw,
                 float pitch)

setPositionAndRotation

boolean setPositionAndRotation(com.nukkitx.math.vector.Vector3f pos,
                               float yaw,
                               float pitch)

getPitch
```
float getPitch()
```

getYaw
```
float getYaw()
```

canBeMovedByCurrents
```
boolean canBeMovedByCurrents()
```

canTriggerPressurePlate
```
boolean canTriggerPressurePlate()
```
Whether the entity can active pressure plates. Used for Bats only.

Returns:

triggers pressure plate

canPassThrough
```
boolean canPassThrough()
```

isOnGround
```
boolean isOnGround()
```

setOnGround
```
void setOnGround(boolean onGround)
```

isUndead
```
default boolean isUndead()
```

kill
```
void kill()
```

teleport

default boolean teleport(com.nukkitx.math.vector.Vector3f pos)

teleport

boolean teleport(com.nukkitx.math.vector.Vector3f pos,
                 PlayerTeleportEvent.TeleportCause cause)

teleport

default boolean teleport(Location location)

teleport

boolean teleport(Location location,
                 PlayerTeleportEvent.TeleportCause cause)

getOwner
```
@Nullable
Entity getOwner()
```

setOwner

void setOwner(@Nullable
              Entity entity)

getData
```
SyncedEntityData getData()
```

getTag
```
com.nukkitx.nbt.NbtMap getTag()
```

isClosed
```
boolean isClosed()
```

close
```
void close()
```

Interface Entity

Method Summary

Methods inherited from interface org.cloudburstmc.server.metadata.Metadatable

Method Detail

getType

getLevel

getServer

getUniqueId

getRuntimeId

getHeight

getEyeHeight

getWidth

getLength

loadAdditionalData

saveAdditionalData

canCollide

onEntityCollision

getGravity

getDrag

hasNameTag

getNameTag

setNameTag

isNameTagVisible

getScale

setScale

getPassengers

isPassenger

isControlling

hasControllingPassenger

getSeatPosition

setSeatPosition

getVehicle

mount

mount

dismount

onMount

onDismount

getEffects

removeAllEffects

getEffect

removeEffect

hasEffect

addEffect

getName

spawnTo

spawnToAll

despawnFrom

despawnFromAll

getViewers

attack

attack

heal

heal

getHealth

setHealth

getMaxHealth

setMaxHealth

isAlive

getLastDamageCause

canCollideWith

getDirection

getDirectionVector

getDirectionPlane

getHorizontalDirection

onUpdate

getAbsorption

setAbsorption

isOnFire

setOnFire

getFireTicks

extinguish

getNoDamageTicks

setNoDamageTicks

getHighestPosition

setHighestPosition

resetFallDistance

getBoundingBox

fall

onStruckByLightning

onInteract