Entity (SpongeAPI 7.4.0 API)

All Superinterfaces:

CompositeValueStore<DataHolder,DataManipulator<?,?>>, DataHolder, DataSerializable, Identifiable, Locatable, PropertyHolder, Translatable, ValueContainer<DataHolder>

All Known Subinterfaces:

Aerial, Ageable, Agent, Ambient, Animal, Aquatic, AreaEffectCloud, ArmorStand, Arrow, Bat, Blaze, Boat, Boss, CaveSpider, ChestMinecart, Chicken, CommandBlockMinecart, ComplexLiving, ComplexLivingPart, ContainerMinecart<M>, Cow, Creature, Creeper, DamagingProjectile, Donkey, DragonFireball, Egg, EnderCrystal, EnderDragon, EnderDragonPart, Enderman, Endermite, EnderPearl, EntityTargetingProjectile, Evoker, ExperienceOrb, Explosive, EyeOfEnder, FallingBlock, Fireball, Firework, FishHook, FurnaceMinecart, FusedExplosive, Ghast, Giant, Golem, Guardian, Hanging, HopperMinecart, Horse, Hostile, Human, Humanoid, Husk, Illusioner, IronGolem, Item, ItemFrame, LargeFireball, LeashHitch, Lightning, Living, Llama, LlamaSpit, MagmaCube, Minecart, MobSpawnerMinecart, Monster, Mooshroom, Mule, Ocelot, Painting, Parrot, Pig, Player, PolarBear, PrimedTNT, Projectile, Rabbit, Ranger, RideableHorse, RideableMinecart, Sheep, Shulker, ShulkerBullet, Silverfish, Skeleton, SkeletonHorse, Slime, SmallFireball, Snowball, SnowGolem, SpectralArrow, Spider, Squid, Stray, ThrownExpBottle, ThrownPotion, TippedArrow, TNTMinecart, Vex, Villager, Vindicator, WeatherEffect, WhiteSkeleton, Witch, Wither, WitherSkeleton, WitherSkull, Wolf, Zombie, ZombieHorse, ZombiePigman, ZombieVillager
```
public interface Entity
extends Identifiable, Locatable, DataHolder, Translatable
```
An entity is a Minecraft entity.
Examples of entities include:
- Zombies
- Sheep
- Players
- Dropped items
- Dropped experience points
- etc.
Blocks and items (when they are in inventories) are not entities.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`boolean`	`addPassenger(Entity entity)` Sets the passenger entity (the entity that rides this one).
`boolean`	`addTag(String tag)` Adds a tag for this entity.
`default boolean`	`canSee(Entity entity)` Returns whether this entity can see the provided `Entity`.
`void`	`clearPassengers()` Removes all currently riding passengers from this entity.
`EntityArchetype`	`createArchetype()` Creates a new `EntityArchetype` for use with `Schematic`s and placing the archetype in multiple locations.
`EntitySnapshot`	`createSnapshot()` Creates a `EntitySnapshot` containing the `EntityType` and data of this entity.
`boolean`	`damage(double damage, DamageSource damageSource)` Damages this `Entity` with the given `DamageSource`.
`Entity`	`getBaseVehicle()` Gets the entity vehicle that is the base of what ever stack the current entity is a part of.
`Optional<AABB>`	`getBoundingBox()` Gets the entity's bounding box, usually for collisions and interaction.
`Optional<UUID>`	`getCreator()` Gets the `UUID`, if available, of the user who created this `Entity`.
`default Collection<Entity>`	`getNearbyEntities(double distance)` Gets the nearby entities within the desired distance.
`default Collection<Entity>`	`getNearbyEntities(Predicate<Entity> predicate)` Gets the nearby entities that satisfy the desired predicate.
`Optional<UUID>`	`getNotifier()` Gets the `UUID`, if available, of the user who last notified this `Entity`.
`List<Entity>`	`getPassengers()` Gets the entity passenger that rides this entity, if available.
`Random`	`getRandom()` Gets the Random Number Generator (RNG) for this entity.
`com.flowpowered.math.vector.Vector3d`	`getRotation()` Gets the rotation.
`com.flowpowered.math.vector.Vector3d`	`getScale()` Gets the entity scale.
`Collection<String>`	`getTags()` Gets all the tags stored for this entity.
`Transform<World>`	`getTransform()` Returns the entity transform as a new copy.
`EntityType`	`getType()` Gets the type of entity.
`Optional<Entity>`	`getVehicle()` Gets the entity vehicle that this entity is riding, if available.
`default com.flowpowered.math.vector.Vector3d`	`getVelocity()` Gets the `Vector3d` representation of this entity's current velocity.
`default Value<Boolean>`	`gravity()` Returns whether this entity has gravity.
`boolean`	`hasPassenger(Entity entity)` Checks if the given entity is a passenger.
`boolean`	`hasTag(String tag)` Returns whether this entity has the given tag.
`boolean`	`isLoaded()` Returns whether this entity is still loaded in a world/chunk.
`boolean`	`isOnGround()` Returns whether this entity is on the ground (not in the air) or not.
`boolean`	`isRemoved()` Returns whether this entity has been removed.
`void`	`remove()` Mark this entity for removal in the very near future, preferably within one game tick.
`void`	`removePassenger(Entity entity)` Removes the given entity as a passenger.
`boolean`	`removeTag(String tag)` Removes a tag for this entity.
`void`	`setCreator(UUID uuid)` Sets the `UUID` of the user who created this `Entity`.
`boolean`	`setLocation(Location<World> location)` Sets the location of this entity.
`boolean`	`setLocationAndRotation(Location<World> location, com.flowpowered.math.vector.Vector3d rotation)` Moves the entity to the specified location, and sets the rotation.
`boolean`	`setLocationAndRotation(Location<World> location, com.flowpowered.math.vector.Vector3d rotation, EnumSet<RelativePositions> relativePositions)` Moves the entity to the specified location, and sets the rotation.
`default boolean`	`setLocationAndRotationSafely(Location<World> location, com.flowpowered.math.vector.Vector3d rotation)` Sets the location using a safe one from `TeleportHelper.getSafeLocation(Location)` and the rotation of this entity.
`default boolean`	`setLocationAndRotationSafely(Location<World> location, com.flowpowered.math.vector.Vector3d rotation, EnumSet<RelativePositions> relativePositions)` Sets the location using a safe one from `TeleportHelper.getSafeLocation(Location)` and the rotation of this entity.
`default boolean`	`setLocationSafely(Location<World> location)` Sets the location of this entity using a safe one from `TeleportHelper.getSafeLocation(Location)`.
`void`	`setNotifier(UUID uuid)` Sets the `UUID` of the user who last notified this `Entity`.
`void`	`setRotation(com.flowpowered.math.vector.Vector3d rotation)` Sets the rotation of this entity.
`void`	`setScale(com.flowpowered.math.vector.Vector3d scale)` Sets the entity scale.
`boolean`	`setTransform(Transform<World> transform)` Sets the entity transform.
`default boolean`	`setTransformSafely(Transform<World> transform)` Sets the transformation of this entity using a safe location from `TeleportHelper.getSafeLocation(Location)`.
`boolean`	`setVehicle(Entity entity)` Sets the vehicle entity (the entity that is ridden by this one).
`default DataTransactionResult`	`setVelocity(com.flowpowered.math.vector.Vector3d vector3d)` Sets the velocity for this entity.
`default boolean`	`transferToWorld(String worldName, com.flowpowered.math.vector.Vector3d position)` Sets the location of this entity to a new position in a world which does not have to be loaded (but must at least be enabled).
`default boolean`	`transferToWorld(UUID uuid, com.flowpowered.math.vector.Vector3d position)` Sets the location of this entity to a new position in a world which does not have to be loaded (but must at least be enabled).
`default boolean`	`transferToWorld(World world)` Sets the `Location` of this entity to the `World`'s spawn point.
`boolean`	`transferToWorld(World world, com.flowpowered.math.vector.Vector3d position)` Sets the `Location` of this entity to a new position in a world.

Methods inherited from interface org.spongepowered.api.util.Identifiable
getUniqueId

Methods inherited from interface org.spongepowered.api.world.Locatable
getLocation, getWorld

Methods inherited from interface org.spongepowered.api.data.DataHolder
setRawData, validateRawData

Methods inherited from interface org.spongepowered.api.data.DataSerializable
getContentVersion, toContainer

Methods inherited from interface org.spongepowered.api.data.property.PropertyHolder
getApplicableProperties, getProperty

Methods inherited from interface org.spongepowered.api.data.value.mutable.CompositeValueStore
copyFrom, copyFrom, get, getContainers, getOrCreate, offer, offer, offer, offer, offer, offer, remove, remove, remove, require, supports, transform, tryOffer, tryOffer, tryOffer, tryOffer, undo

Methods inherited from interface org.spongepowered.api.data.value.ValueContainer
copy, get, getKeys, getOrElse, getOrNull, getValue, getValues, require, supports, supports

Methods inherited from interface org.spongepowered.api.text.translation.Translatable
getTranslation

- Method Detail
  - getType
```
EntityType getType()
```
    Gets the type of entity.
    
    Returns:
    
    The type of entity
  - createSnapshot
```
EntitySnapshot createSnapshot()
```
    Creates a EntitySnapshot containing the EntityType and data of this entity.
    
    Returns:
    
    The snapshot
  - getRandom
```
Random getRandom()
```
    Gets the Random Number Generator (RNG) for this entity.
    
    Returns:
    
    The RNG
  - setLocation
```
boolean setLocation(Location<World> location)
```
    Sets the location of this entity. This is equivalent to a teleport, and also moves this entity's passengers.
    
    Parameters:
    
    location - The location to set
    
    Returns:
    
    True if location was set successfully, false if location couldn't be set due to MoveEntityEvent.Teleport being cancelled.
  - setLocationSafely
```
default boolean setLocationSafely(Location<World> location)
```
    Sets the location of this entity using a safe one from TeleportHelper.getSafeLocation(Location). This is equivalent to a teleport and also moves this entity's passengers.
    
    Parameters:
    
    location - The location to set
    
    Returns:
    
    True if location was set successfully, false if location couldn't be set as no safe location was found or MoveEntityEvent.Teleport was cancelled.
  - getRotation
```
com.flowpowered.math.vector.Vector3d getRotation()
```
    Gets the rotation.
    The format of the rotation is represented by:
    
    x -> pitch, y -> yaw, z -> roll
    
    Returns:
    
    The rotation
  - setRotation
```
void setRotation(com.flowpowered.math.vector.Vector3d rotation)
```
    Sets the rotation of this entity.
    The format of the rotation is represented by:
    
    x -> pitch, y -> yaw, z -> roll
    
    Parameters:
    
    rotation - The rotation to set the entity to
  - setLocationAndRotation
```
boolean setLocationAndRotation(Location<World> location,
                               com.flowpowered.math.vector.Vector3d rotation)
```
    Moves the entity to the specified location, and sets the rotation.
    The format of the rotation is represented by:
    
    x -> pitch, y -> yaw, z -> roll
    
    Parameters:
    
    location - The location to set
    
    rotation - The rotation to set
    
    Returns:
    
    True if location was set successfully, false if location couldn't be set due to MoveEntityEvent.Teleport being cancelled
  - setLocationAndRotation
```
boolean setLocationAndRotation(Location<World> location,
                               com.flowpowered.math.vector.Vector3d rotation,
                               EnumSet<RelativePositions> relativePositions)
```
    Moves the entity to the specified location, and sets the rotation. RelativePositions listed inside the EnumSet are considered relative.
    The format of the rotation is represented by:
    
    x -> pitch, y -> yaw, z -> roll
    
    Parameters:
    
    location - The location to set
    
    rotation - The rotation to set
    
    relativePositions - The coordinates to set relatively
    
    Returns:
    
    True if location was set successfully, false if location couldn't be set due to MoveEntityEvent.Teleport being cancelled
  - setLocationAndRotationSafely
```
default boolean setLocationAndRotationSafely(Location<World> location,
                                             com.flowpowered.math.vector.Vector3d rotation)
```
    Sets the location using a safe one from TeleportHelper.getSafeLocation(Location) and the rotation of this entity.
    The format of the rotation is represented by:
    
    x -> pitch, y -> yaw, z -> roll
    
    Parameters:
    
    location - The location to set
    
    rotation - The rotation to set
    
    Returns:
    
    True if location was set successfully, false if either location couldn't be set as no safe location was found or MoveEntityEvent.Teleport was cancelled
  - setLocationAndRotationSafely
```
default boolean setLocationAndRotationSafely(Location<World> location,
                                             com.flowpowered.math.vector.Vector3d rotation,
                                             EnumSet<RelativePositions> relativePositions)
```
    Sets the location using a safe one from TeleportHelper.getSafeLocation(Location) and the rotation of this entity. RelativePositions listed inside the EnumSet are considered relative.
    The format of the rotation is represented by:
    
    x -> pitch, y -> yaw, z -> roll
    
    Parameters:
    
    location - The location to set
    
    rotation - The rotation to set
    
    relativePositions - The coordinates to set relatively
    
    Returns:
    
    True if location was set successfully, false if either location couldn't be set as no safe location was found or MoveEntityEvent.Teleport was cancelled
  - getScale
```
com.flowpowered.math.vector.Vector3d getScale()
```
    Gets the entity scale. Not currently used. Returns Vector3d.ONE.
    
    Returns:
    
    The entity scale
  - setScale
```
void setScale(com.flowpowered.math.vector.Vector3d scale)
```
    Sets the entity scale. Not currently used. Does nothing.
    
    Parameters:
    
    scale - The scale
  - getTransform
```
Transform<World> getTransform()
```
    Returns the entity transform as a new copy. Combines the position, rotation and scale.
    
    Returns:
    
    The transform as a new copy
  - setTransform
```
boolean setTransform(Transform<World> transform)
```
    Sets the entity transform. Sets the position, rotation and scale at once.
    
    Parameters:
    
    transform - The transform to set
    
    Returns:
    
    True if the transform was set successfully, false if the transform couldn't be set due to MoveEntityEvent.Teleport being cancelled.
  - setTransformSafely
```
default boolean setTransformSafely(Transform<World> transform)
```
    Sets the transformation of this entity using a safe location from TeleportHelper.getSafeLocation(Location).
    
    Parameters:
    
    transform - The transform to set
    
    Returns:
    
    True if the transform was set successfully, or false if either the transform couldn't be set as no safe location was found or MoveEntityEvent.Teleport was cancelled
  - transferToWorld
```
default boolean transferToWorld(World world)
```
    Sets the Location of this entity to the World's spawn point.
    This is equivalent to setting the location via TargetedLocationData.
    
    Parameters:
    
    world - The world to transfer to
    
    Returns:
    
    Whether the transfer was successful, returns false if the action is cancelled or not possible (eg. because the entity has been removed)
  - transferToWorld
```
boolean transferToWorld(World world,
                        com.flowpowered.math.vector.Vector3d position)
```
    Sets the Location of this entity to a new position in a world.
    This is equivalent to setting the location via TargetedLocationData.
    
    Parameters:
    
    world - The world to transfer to
    
    position - The position in the target world
    
    Returns:
    
    Whether the transfer was successful, returns false if the action is cancelled or not possible (eg. because the entity has been removed)
  - transferToWorld
```
default boolean transferToWorld(String worldName,
                                com.flowpowered.math.vector.Vector3d position)
```
    Sets the location of this entity to a new position in a world which does not have to be loaded (but must at least be enabled).
    If the target world is loaded then this is equivalent to setting the location via TargetedLocationData.
    
    If the target world is unloaded but is enabled according to its WorldArchetype.isEnabled() then this will first load the world before transferring the entity to that world.
    
    If the target world is unloaded and not enabled then the transfer will fail.
    
    Parameters:
    
    worldName - The name of the world to transfer to
    
    position - The position in the target world
    
    Returns:
    
    True if the teleport was successful
  - transferToWorld
```
default boolean transferToWorld(UUID uuid,
                                com.flowpowered.math.vector.Vector3d position)
```
    Sets the location of this entity to a new position in a world which does not have to be loaded (but must at least be enabled).
    If the target world is loaded then this is equivalent to setting the location via TargetedLocationData.
    
    If the target world is unloaded but is enabled according to its WorldArchetype.isEnabled() then this will first load the world before transferring the entity to that world.
    
    If the target world is unloaded and not enabled then the transfer will fail.
    
    Parameters:
    
    uuid - The UUID of the target world to transfer to
    
    position - The position in the target world
    
    Returns:
    
    True if the teleport was successful
  - getBoundingBox
```
Optional<AABB> getBoundingBox()
```
    Gets the entity's bounding box, usually for collisions and interaction. The box has an offset matching the entity's positions. That is to say, it is absolutely positioned and not relative to the entity.
    
    Returns:
    
    The axis aligned bounding box
  - getPassengers
```
List<Entity> getPassengers()
```
    Gets the entity passenger that rides this entity, if available.
    
    Returns:
    
    The passenger entity, if it exists
  - hasPassenger
```
boolean hasPassenger(Entity entity)
```
    Checks if the given entity is a passenger.
    
    Parameters:
    
    entity - The entity passenger
    
    Returns:
    
    If it is a passenger
  - addPassenger
```
boolean addPassenger(Entity entity)
```
    Sets the passenger entity (the entity that rides this one).
    
    Parameters:
    
    entity - The entity passenger, or null to eject
    
    Returns:
    
    If adding the passenger succeeded
  - removePassenger
```
void removePassenger(Entity entity)
```
    Removes the given entity as a passenger.
    
    Parameters:
    
    entity - The entity to remove as passenger
  - clearPassengers
```
void clearPassengers()
```
    Removes all currently riding passengers from this entity.
  - getVehicle
```
Optional<Entity> getVehicle()
```
    Gets the entity vehicle that this entity is riding, if available.
    
    Returns:
    
    The vehicle entity, if it exists
  - setVehicle
```
boolean setVehicle(@Nullable
                   Entity entity)
```
    Sets the vehicle entity (the entity that is ridden by this one).
    
    Parameters:
    
    entity - The entity vehicle, or null to dismount
    
    Returns:
    
    True if the set was successful
  - getBaseVehicle
```
Entity getBaseVehicle()
```
    Gets the entity vehicle that is the base of what ever stack the current entity is a part of. This can be the current entity, if it is not riding any vehicle.
    The returned entity can never ride another entity, that would make the ridden entity the base of the stack.
    
    Returns:
    
    The vehicle entity, if available
  - getVelocity
```
default com.flowpowered.math.vector.Vector3d getVelocity()
```
    Gets the Vector3d representation of this entity's current velocity.
    
    Returns:
    
    The current velocity
  - setVelocity
```
default DataTransactionResult setVelocity(com.flowpowered.math.vector.Vector3d vector3d)
```
    Sets the velocity for this entity.
    
    Parameters:
    
    vector3d - The vector 3d velocity
    
    Returns:
    
    The resulting data transaction result
  - isOnGround
```
boolean isOnGround()
```
    Returns whether this entity is on the ground (not in the air) or not.
    
    Returns:
    
    Whether this entity is on the ground or not
  - isRemoved
```
boolean isRemoved()
```
    Returns whether this entity has been removed.
    
    Returns:
    
    True if this entity has been removed
  - isLoaded
```
boolean isLoaded()
```
    Returns whether this entity is still loaded in a world/chunk.
    
    Returns:
    
    True if this entity is still loaded
  - remove
```
void remove()
```
    Mark this entity for removal in the very near future, preferably within one game tick.
  - damage
```
boolean damage(double damage,
               DamageSource damageSource)
```
    Damages this Entity with the given DamageSource.
    
    Parameters:
    
    damage - The damage to deal
    
    damageSource - The cause of the damage
    
    Returns:
    
    True if damaging the entity was successful
  - getNearbyEntities
```
default Collection<Entity> getNearbyEntities(double distance)
```
    Gets the nearby entities within the desired distance.
    
    Parameters:
    
    distance - The distance
    
    Returns:
    
    The collection of nearby entities
    
    See Also:
    
    EntityUniverse.getNearbyEntities(Vector3d, double)
  - getNearbyEntities
```
default Collection<Entity> getNearbyEntities(Predicate<Entity> predicate)
```
    Gets the nearby entities that satisfy the desired predicate.
    
    Parameters:
    
    predicate - The predicate to use
    
    Returns:
    
    The collection of entities
    
    See Also:
    
    EntityUniverse.getEntities(Predicate)
  - getCreator
```
Optional<UUID> getCreator()
```
    Gets the UUID, if available, of the user who created this Entity.
    
    Returns:
    
    The UUID if one exists
  - getNotifier
```
Optional<UUID> getNotifier()
```
    Gets the UUID, if available, of the user who last notified this Entity.
    
    Returns:
    
    The UUID if one exists
  - setCreator
```
void setCreator(@Nullable
                UUID uuid)
```
    Sets the UUID of the user who created this Entity.
    
    Parameters:
    
    uuid - The UUID to set as creator
  - setNotifier
```
void setNotifier(@Nullable
                 UUID uuid)
```
    Sets the UUID of the user who last notified this Entity.
    
    Parameters:
    
    uuid - The UUID to set as notifier
  - canSee
```
default boolean canSee(Entity entity)
```
    Returns whether this entity can see the provided Entity.
    
    Parameters:
    
    entity - The entity to check visibility for
    
    Returns:
    
    true if this entity can see the provided entity
  - createArchetype
```
EntityArchetype createArchetype()
```
    Creates a new EntityArchetype for use with Schematics and placing the archetype in multiple locations.
    
    Returns:
    
    The created archetype for re-creating this entity
  - gravity
```
default Value<Boolean> gravity()
```
    Returns whether this entity has gravity.
    
    Returns:
    
    True if this entity has gravity
  - getTags
```
Collection<String> getTags()
```
    Gets all the tags stored for this entity.
    
    Returns:
    
    This entity's tags
  - addTag
```
boolean addTag(String tag)
```
    Adds a tag for this entity.
    
    Returns:
    
    Whether the tag is effectively in the set
  - removeTag
```
boolean removeTag(String tag)
```
    Removes a tag for this entity.
    
    Returns:
    
    Whether the tag has effectively been removed
  - hasTag
```
boolean hasTag(String tag)
```
    Returns whether this entity has the given tag.
    
    Returns:
    
    True if this entity has the given tag.

Interface Entity

Method Summary

Methods inherited from interface org.spongepowered.api.util.Identifiable

Methods inherited from interface org.spongepowered.api.world.Locatable

Methods inherited from interface org.spongepowered.api.data.DataHolder

Methods inherited from interface org.spongepowered.api.data.DataSerializable

Methods inherited from interface org.spongepowered.api.data.property.PropertyHolder

Methods inherited from interface org.spongepowered.api.data.value.mutable.CompositeValueStore

Methods inherited from interface org.spongepowered.api.data.value.ValueContainer

Methods inherited from interface org.spongepowered.api.text.translation.Translatable

Method Detail

getType

createSnapshot

getRandom

setLocation

setLocationSafely

getRotation

setRotation

setLocationAndRotation

setLocationAndRotation

setLocationAndRotationSafely

setLocationAndRotationSafely

getScale

setScale

getTransform

setTransform

setTransformSafely

transferToWorld

transferToWorld

transferToWorld

transferToWorld

getBoundingBox

getPassengers

hasPassenger

addPassenger

removePassenger

clearPassengers

getVehicle

setVehicle

getBaseVehicle

getVelocity

setVelocity

isOnGround

isRemoved

isLoaded

remove

damage

getNearbyEntities

getNearbyEntities

getCreator

getNotifier

setCreator

setNotifier

canSee

createArchetype

gravity

getTags

addTag

removeTag

hasTag