org.bukkit.entity

Interface Entity

All Superinterfaces:

CommandSender, Metadatable, Permissible, ServerOperator

All Known Subinterfaces:

Ageable, Ambient, Animals, AreaEffectCloud, ArmorStand, Arrow, Bat, Blaze, Boat, CaveSpider, Chicken, CommandMinecart, ComplexEntityPart, ComplexLivingEntity, Cow, Creature, Creeper, Damageable, DragonFireball, Egg, EnderCrystal, EnderDragon, EnderDragonPart, Enderman, Endermite, EnderPearl, EnderSignal, ExperienceOrb, Explosive, ExplosiveMinecart, FallingBlock, FallingSand, Fireball, Firework, Fish, FishHook, Flying, Ghast, Giant, Golem, Guardian, Hanging, HopperMinecart, Horse, HumanEntity, IronGolem, Item, ItemFrame, LargeFireball, LeashHitch, LightningStrike, LingeringPotion, LivingEntity, MagmaCube, Minecart, Monster, MushroomCow, NPC, Ocelot, Painting, Pig, PigZombie, Player, PolarBear, PoweredMinecart, PoweredMinecart, Projectile, Rabbit, RideableMinecart, Sheep, Shulker, ShulkerBullet, Silverfish, Skeleton, Slime, SmallFireball, Snowball, Snowman, SpawnerMinecart, SpectralArrow, Spider, SplashPotion, Squid, StorageMinecart, StorageMinecart, ThrownExpBottle, ThrownPotion, TippedArrow, TNTPrimed, Vehicle, Villager, WaterMob, Weather, Witch, Wither, WitherSkull, Wolf, Zombie

public interface Entity
extends Metadatable, CommandSender

Represents a base entity in the world

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Entity.Spigot

Method Summary

Modifier and Type	Method and Description
boolean	addScoreboardTag(java.lang.String tag) Add a tag to this entity.
boolean	eject() Eject any passenger.
java.lang.String	getCustomName() Gets the custom name on a mob.
int	getEntityId() Returns a unique id for this entity
float	getFallDistance() Returns the distance this entity has fallen
int	getFireTicks() Returns the entity's current fire ticks (ticks before the entity stops being on fire).
EntityDamageEvent	getLastDamageCause() Retrieve the last EntityDamageEvent inflicted on this entity.
Location	getLocation() Gets the entity's current position
Location	getLocation(Location loc) Stores the entity's current position in the provided Location object.
int	getMaxFireTicks() Returns the entity's maximum fire ticks.
java.util.List<Entity>	getNearbyEntities(double x, double y, double z) Returns a list of entities within a bounding box centered around this entity
Entity	getPassenger() Gets the primary passenger of a vehicle.
int	getPortalCooldown() Gets the period of time (in ticks) before this entity can use a portal.
java.util.Set<java.lang.String>	getScoreboardTags() Returns a set of tags for this entity.
Server	getServer() Gets the Server that contains this Entity
int	getTicksLived() Gets the amount of ticks this entity has lived for.
EntityType	getType() Get the type of the entity.
java.util.UUID	getUniqueId() Returns a unique and persistent id for this entity
Entity	getVehicle() Get the vehicle that this player is inside.
Vector	getVelocity() Gets this entity's current velocity
World	getWorld() Gets the current world this entity resides in
boolean	hasGravity() Returns whether gravity applies to this entity.
boolean	isCustomNameVisible() Gets whether or not the mob's custom name is displayed client side.
boolean	isDead() Returns true if this entity has been marked for removal.
boolean	isEmpty() Check if a vehicle has passengers.
boolean	isGlowing() Gets whether the entity is glowing or not.
boolean	isInsideVehicle() Returns whether this entity is inside a vehicle.
boolean	isInvulnerable() Gets whether the entity is invulnerable or not.
boolean	isOnGround() Returns true if the entity is supported by a block.
boolean	isSilent() Gets whether the entity is silent or not.
boolean	isValid() Returns false if the entity has died or been despawned for some other reason.
boolean	leaveVehicle() Leave the current vehicle.
void	playEffect(EntityEffect type) Performs the specified EntityEffect for this entity.
void	remove() Mark the entity's removal.
boolean	removeScoreboardTag(java.lang.String tag) Removes a given tag from this entity.
void	setCustomName(java.lang.String name) Sets a custom name on a mob.
void	setCustomNameVisible(boolean flag) Sets whether or not to display the mob's custom name client side.
void	setFallDistance(float distance) Sets the fall distance for this entity
void	setFireTicks(int ticks) Sets the entity's current fire ticks (ticks before the entity stops being on fire).
void	setGlowing(boolean flag) Sets whether the entity has a team colored (default: white) glow.
void	setGravity(boolean gravity) Sets whether gravity applies to this entity.
void	setInvulnerable(boolean flag) Sets whether the entity is invulnerable or not.
void	setLastDamageCause(EntityDamageEvent event) Record the last EntityDamageEvent inflicted on this entity
boolean	setPassenger(Entity passenger) Set the passenger of a vehicle.
void	setPortalCooldown(int cooldown) Sets the period of time (in ticks) before this entity can use a portal.
void	setSilent(boolean flag) Sets whether the entity is silent or not.
void	setTicksLived(int value) Sets the amount of ticks this entity has lived for.
void	setVelocity(Vector velocity) Sets this entity's velocity
Entity.Spigot	spigot()
boolean	teleport(Entity destination) Teleports this entity to the target Entity.
boolean	teleport(Entity destination, PlayerTeleportEvent.TeleportCause cause) Teleports this entity to the target Entity.
boolean	teleport(Location location) Teleports this entity to the given location.
boolean	teleport(Location location, PlayerTeleportEvent.TeleportCause cause) Teleports this entity to the given location.

Methods inherited from interface org.bukkit.metadata.Metadatable

getMetadata, hasMetadata, removeMetadata, setMetadata

Methods inherited from interface org.bukkit.command.CommandSender

getName, 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

Method Detail

getLocation

Location getLocation()

Gets the entity's current position

Returns:

a new copy of Location containing the position of this entity

getLocation

Location getLocation(Location loc)

Stores the entity's current position in the provided Location object.

If the provided Location is null this method does nothing and returns null.

Parameters:

loc - the location to copy into

Returns:

The Location object provided or null

setVelocity

void setVelocity(Vector velocity)

Sets this entity's velocity

Parameters:

velocity - New velocity to travel with

getVelocity

Vector getVelocity()

Gets this entity's current velocity

Returns:

Current travelling velocity of this entity

isOnGround

boolean isOnGround()

Returns true if the entity is supported by a block. This value is a state updated by the server and is not recalculated unless the entity moves.

Returns:

True if entity is on ground.

getWorld

World getWorld()

Gets the current world this entity resides in

Returns:

World

teleport

boolean teleport(Location location)

Teleports this entity to the given location. If this entity is riding a vehicle, it will be dismounted prior to teleportation.

Parameters:

location - New location to teleport this entity to

Returns:

true if the teleport was successful

teleport

boolean teleport(Location location,
                 PlayerTeleportEvent.TeleportCause cause)

Teleports this entity to the given location. If this entity is riding a vehicle, it will be dismounted prior to teleportation.

Parameters:

location - New location to teleport this entity to

cause - The cause of this teleportation

Returns:

true if the teleport was successful

teleport

boolean teleport(Entity destination)

Teleports this entity to the target Entity. If this entity is riding a vehicle, it will be dismounted prior to teleportation.

Parameters:

destination - Entity to teleport this entity to

Returns:

true if the teleport was successful

teleport

boolean teleport(Entity destination,
                 PlayerTeleportEvent.TeleportCause cause)

Teleports this entity to the target Entity. If this entity is riding a vehicle, it will be dismounted prior to teleportation.

Parameters:

destination - Entity to teleport this entity to

cause - The cause of this teleportation

Returns:

true if the teleport was successful

getNearbyEntities

java.util.List<Entity> getNearbyEntities(double x,
                                         double y,
                                         double z)

Returns a list of entities within a bounding box centered around this entity

Parameters:

x - 1/2 the size of the box along x axis

y - 1/2 the size of the box along y axis

z - 1/2 the size of the box along z axis

Returns:

List<Entity> List of entities nearby

getEntityId

int getEntityId()

Returns a unique id for this entity

Returns:

Entity id

getFireTicks

int getFireTicks()

Returns the entity's current fire ticks (ticks before the entity stops being on fire).

Returns:

int fireTicks

getMaxFireTicks

int getMaxFireTicks()

Returns the entity's maximum fire ticks.

Returns:

int maxFireTicks

setFireTicks

void setFireTicks(int ticks)

Sets the entity's current fire ticks (ticks before the entity stops being on fire).

Parameters:

ticks - Current ticks remaining

remove

void remove()

Mark the entity's removal.

isDead

boolean isDead()

Returns true if this entity has been marked for removal.

Returns:

True if it is dead.

isValid

boolean isValid()

Returns false if the entity has died or been despawned for some other reason.

Returns:

True if valid.

getServer

Server getServer()

Gets the Server that contains this Entity

Specified by:

getServer in interface CommandSender

Returns:

Server instance running this Entity

getPassenger

Entity getPassenger()

Gets the primary passenger of a vehicle. For vehicles that could have multiple passengers, this will only return the primary passenger.

Returns:

an entity

setPassenger

boolean setPassenger(Entity passenger)

Set the passenger of a vehicle.

Parameters:

passenger - The new passenger.

Returns:

false if it could not be done for whatever reason

isEmpty

boolean isEmpty()

Check if a vehicle has passengers.

Returns:

True if the vehicle has no passengers.

eject

boolean eject()

Eject any passenger.

Returns:

True if there was a passenger.

getFallDistance

float getFallDistance()

Returns the distance this entity has fallen

Returns:

The distance.

setFallDistance

void setFallDistance(float distance)

Sets the fall distance for this entity

Parameters:

distance - The new distance.

setLastDamageCause

void setLastDamageCause(EntityDamageEvent event)

Record the last EntityDamageEvent inflicted on this entity

Parameters:

event - a EntityDamageEvent

getLastDamageCause

EntityDamageEvent getLastDamageCause()

Retrieve the last EntityDamageEvent inflicted on this entity. This event may have been cancelled.

Returns:

the last known EntityDamageEvent or null if hitherto unharmed

getUniqueId

java.util.UUID getUniqueId()

Returns a unique and persistent id for this entity

Returns:

unique id

getTicksLived

int getTicksLived()

Gets the amount of ticks this entity has lived for.

This is the equivalent to "age" in entities.

Returns:

Age of entity

setTicksLived

void setTicksLived(int value)

Sets the amount of ticks this entity has lived for.

This is the equivalent to "age" in entities. May not be less than one tick.

Parameters:

value - Age of entity

playEffect

void playEffect(EntityEffect type)

Performs the specified EntityEffect for this entity.

This will be viewable to all players near the entity.

Parameters:

type - Effect to play.

getType

EntityType getType()

Get the type of the entity.

Returns:

The entity type.

isInsideVehicle

boolean isInsideVehicle()

Returns whether this entity is inside a vehicle.

Returns:

True if the entity is in a vehicle.

leaveVehicle

boolean leaveVehicle()

Leave the current vehicle. If the entity is currently in a vehicle (and is removed from it), true will be returned, otherwise false will be returned.

Returns:

True if the entity was in a vehicle.

getVehicle

Entity getVehicle()

Get the vehicle that this player is inside. If there is no vehicle, null will be returned.

Returns:

The current vehicle.

setCustomName

void setCustomName(java.lang.String name)

Sets a custom name on a mob. This name will be used in death messages and can be sent to the client as a nameplate over the mob.

Setting the name to null or an empty string will clear it.

This value has no effect on players, they will always use their real name.

Parameters:

name - the name to set

getCustomName

java.lang.String getCustomName()

Gets the custom name on a mob. If there is no name this method will return null.

This value has no effect on players, they will always use their real name.

Returns:

name of the mob or null

setCustomNameVisible

void setCustomNameVisible(boolean flag)

Sets whether or not to display the mob's custom name client side. The name will be displayed above the mob similarly to a player.

This value has no effect on players, they will always display their name.

Parameters:

flag - custom name or not

isCustomNameVisible

boolean isCustomNameVisible()

Gets whether or not the mob's custom name is displayed client side.

This value has no effect on players, they will always display their name.

Returns:

if the custom name is displayed

setGlowing

void setGlowing(boolean flag)

Sets whether the entity has a team colored (default: white) glow.

Parameters:

flag - if the entity is glowing

isGlowing

boolean isGlowing()

Gets whether the entity is glowing or not.

Returns:

whether the entity is glowing

setInvulnerable

void setInvulnerable(boolean flag)

Sets whether the entity is invulnerable or not.

When an entity is invulnerable it can only be damaged by players in creative mode.

Parameters:

flag - if the entity is invulnerable

isInvulnerable

boolean isInvulnerable()

Gets whether the entity is invulnerable or not.

Returns:

whether the entity is

isSilent

boolean isSilent()

Gets whether the entity is silent or not.

Returns:

whether the entity is silent.

setSilent

void setSilent(boolean flag)

Sets whether the entity is silent or not.

When an entity is silent it will not produce any sound.

Parameters:

flag - if the entity is silent

hasGravity

boolean hasGravity()

Returns whether gravity applies to this entity.

Returns:

whether gravity applies

setGravity

void setGravity(boolean gravity)

Sets whether gravity applies to this entity.

Parameters:

gravity - whether gravity should apply

getPortalCooldown

int getPortalCooldown()

Gets the period of time (in ticks) before this entity can use a portal.

Returns:

portal cooldown ticks

setPortalCooldown

void setPortalCooldown(int cooldown)

Sets the period of time (in ticks) before this entity can use a portal.

Parameters:

cooldown - portal cooldown ticks

getScoreboardTags

java.util.Set<java.lang.String> getScoreboardTags()

Returns a set of tags for this entity.
Entities can have no more than 1024 tags.

Returns:

a set of tags for this entity

addScoreboardTag

boolean addScoreboardTag(java.lang.String tag)

Add a tag to this entity.
Entities can have no more than 1024 tags.

Parameters:

tag - the tag to add

Returns:

true if the tag was successfully added

removeScoreboardTag

boolean removeScoreboardTag(java.lang.String tag)

Removes a given tag from this entity.

Parameters:

tag - the tag to remove

Returns:

true if the tag was successfully removed

spigot

Entity.Spigot spigot()