package org.bukkit.entity; import org.bukkit.Location; import org.bukkit.EntityEffect; import org.bukkit.Nameable; import org.bukkit.Server; import org.bukkit.World; import org.bukkit.block.BlockFace; import org.bukkit.event.entity.EntityDamageEvent; import org.bukkit.material.Directional; import org.bukkit.metadata.Metadatable; import org.bukkit.util.BoundingBox; import org.bukkit.util.Vector; import java.util.List; import java.util.Set; import java.util.UUID; import org.bukkit.block.PistonMoveReaction; import org.bukkit.command.CommandSender; import org.bukkit.event.player.PlayerTeleportEvent.TeleportCause; /** * Represents a base entity in the world */ public interface Entity extends Metadatable, CommandSender, Nameable { /** * Gets the entity's current position * * @return a new copy of Location containing the position of this entity */ public Location getLocation(); /** * Stores the entity's current position in the provided Location object. *
* If the provided Location is null this method does nothing and returns * null. * * @param loc the location to copy into * @return The Location object provided or null */ public Location getLocation(Location loc); /** * Sets this entity's velocity * * @param velocity New velocity to travel with */ public void setVelocity(Vector velocity); /** * Gets this entity's current velocity * * @return Current traveling velocity of this entity */ public Vector getVelocity(); /** * Gets the entity's height * * @return height of entity */ public double getHeight(); /** * Gets the entity's width * * @return width of entity */ public double getWidth(); /** * Gets the entity's current bounding box. *
* The returned bounding box reflects the entity's current location and
* size.
*
* @return the entity's current bounding box
*/
public BoundingBox getBoundingBox();
/**
* 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.
*
* @return True if entity is on ground.
*/
public boolean isOnGround();
/**
* Gets the current world this entity resides in
*
* @return World
*/
public World getWorld();
/**
* Teleports this entity to the given location. If this entity is riding a
* vehicle, it will be dismounted prior to teleportation.
*
* @param location New location to teleport this entity to
* @return
* By default all entities are persistent. An entity will also not get
* persisted, if it is riding an entity that is not persistent.
*
* The persistent flag on players controls whether or not to save their
* playerdata file when they quit. If a player is directly or indirectly
* riding a non-persistent entity, the vehicle at the root and all its
* passengers won't get persisted.
*
* This should not be confused with
* {@link LivingEntity#setRemoveWhenFarAway(boolean)} which controls
* despawning of living entities.
*
* @return true if this entity is persistent
* @deprecated draft API
*/
@Deprecated
public boolean isPersistent();
/**
* Sets whether or not the entity gets persisted.
*
* @param persistent the persistence status
* @see #isPersistent()
* @deprecated draft API
*/
@Deprecated
public void setPersistent(boolean persistent);
/**
* Gets the primary passenger of a vehicle. For vehicles that could have
* multiple passengers, this will only return the primary passenger.
*
* @return an entity
* @deprecated entities may have multiple passengers, use
* {@link #getPassengers()}
*/
@Deprecated
public Entity getPassenger();
/**
* Set the passenger of a vehicle.
*
* @param passenger The new passenger.
* @return false if it could not be done for whatever reason
* @deprecated entities may have multiple passengers, use
* {@link #getPassengers()}
*/
@Deprecated
public boolean setPassenger(Entity passenger);
/**
* Gets a list of passengers of this vehicle.
*
* The returned list will not be directly linked to the entity's current
* passengers, and no guarantees are made as to its mutability.
*
* @return list of entities corresponding to current passengers.
*/
public List
* This is the equivalent to "age" in entities.
*
* @return Age of entity
*/
public int getTicksLived();
/**
* 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.
*
* @param value Age of entity
*/
public void setTicksLived(int value);
/**
* Performs the specified {@link EntityEffect} for this entity.
*
* This will be viewable to all players near the entity.
*
* If the effect is not applicable to this class of entity, it will not play.
*
* @param type Effect to play.
*/
public void playEffect(EntityEffect type);
/**
* Get the type of the entity.
*
* @return The entity type.
*/
public EntityType getType();
/**
* Returns whether this entity is inside a vehicle.
*
* @return True if the entity is in a vehicle.
*/
public boolean isInsideVehicle();
/**
* 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.
*
* @return True if the entity was in a vehicle.
*/
public boolean leaveVehicle();
/**
* Get the vehicle that this player is inside. If there is no vehicle,
* null will be returned.
*
* @return The current vehicle.
*/
public Entity getVehicle();
/**
* 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.
*
* @param flag custom name or not
*/
public void setCustomNameVisible(boolean flag);
/**
* 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.
*
* @return if the custom name is displayed
*/
public boolean isCustomNameVisible();
/**
* Sets whether the entity has a team colored (default: white) glow.
*
* @param flag if the entity is glowing
*/
void setGlowing(boolean flag);
/**
* Gets whether the entity is glowing or not.
*
* @return whether the entity is glowing
*/
boolean isGlowing();
/**
* Sets whether the entity is invulnerable or not.
*
* When an entity is invulnerable it can only be damaged by players in
* creative mode.
*
* @param flag if the entity is invulnerable
*/
public void setInvulnerable(boolean flag);
/**
* Gets whether the entity is invulnerable or not.
*
* @return whether the entity is
*/
public boolean isInvulnerable();
/**
* Gets whether the entity is silent or not.
*
* @return whether the entity is silent.
*/
public boolean isSilent();
/**
* Sets whether the entity is silent or not.
*
* When an entity is silent it will not produce any sound.
*
* @param flag if the entity is silent
*/
public void setSilent(boolean flag);
/**
* Returns whether gravity applies to this entity.
*
* @return whether gravity applies
*/
boolean hasGravity();
/**
* Sets whether gravity applies to this entity.
*
* @param gravity whether gravity should apply
*/
void setGravity(boolean gravity);
/**
* Gets the period of time (in ticks) before this entity can use a portal.
*
* @return portal cooldown ticks
*/
int getPortalCooldown();
/**
* Sets the period of time (in ticks) before this entity can use a portal.
*
* @param cooldown portal cooldown ticks
*/
void setPortalCooldown(int cooldown);
/**
* Returns a set of tags for this entity.
* true
if the teleport was successful
*/
public 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.
*
* @param location New location to teleport this entity to
* @param cause The cause of this teleportation
* @return true
if the teleport was successful
*/
public boolean teleport(Location location, TeleportCause cause);
/**
* Teleports this entity to the target Entity. If this entity is riding a
* vehicle, it will be dismounted prior to teleportation.
*
* @param destination Entity to teleport this entity to
* @return true
if the teleport was successful
*/
public 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.
*
* @param destination Entity to teleport this entity to
* @param cause The cause of this teleportation
* @return true
if the teleport was successful
*/
public boolean teleport(Entity destination, TeleportCause cause);
/**
* Returns a list of entities within a bounding box centered around this
* entity
*
* @param x 1/2 the size of the box along x axis
* @param y 1/2 the size of the box along y axis
* @param z 1/2 the size of the box along z axis
* @return {@code List
* Entities can have no more than 1024 tags.
*
* @return a set of tags for this entity
*/
Set
* Entities can have no more than 1024 tags.
*
* @param tag the tag to add
* @return true if the tag was successfully added
*/
boolean addScoreboardTag(String tag);
/**
* Removes a given tag from this entity.
*
* @param tag the tag to remove
* @return true if the tag was successfully removed
*/
boolean removeScoreboardTag(String tag);
/**
* Returns the reaction of the entity when moved by a piston.
*
* @return reaction
*/
PistonMoveReaction getPistonMoveReaction();
/**
* Get the closest cardinal {@link BlockFace} direction an entity is
* currently facing.
*
* This will not return any non-cardinal directions such as
* {@link BlockFace#UP} or {@link BlockFace#DOWN}.
*
* {@link Hanging} entities will override this call and thus their behavior
* may be different.
*
* @return the entity's current cardinal facing.
* @see Hanging
* @see Directional#getFacing()
*/
BlockFace getFacing();
}