org.spongepowered.api.world.extent

Interface EntityUniverse

All Known Subinterfaces:

Chunk, Extent, World

public interface EntityUniverse

A container of Entity instances.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EntityUniverse.EntityHit The result of an intersection between a ray and an entity.

Method Summary

Modifier and Type	Method and Description
Optional<Entity>	createEntity(DataContainer entityContainer) Create an entity instance at the given position.
Optional<Entity>	createEntity(DataContainer entityContainer, com.flowpowered.math.vector.Vector3d position) Create an entity instance at the given position.
Entity	createEntity(EntityType type, com.flowpowered.math.vector.Vector3d position) Create an entity instance at the given position.
default Entity	createEntity(EntityType type, com.flowpowered.math.vector.Vector3i position) Create an entity instance at the given position.
Entity	createEntityNaturally(EntityType type, com.flowpowered.math.vector.Vector3d position) Create an entity instance at the given position with the default equipment.
default Entity	createEntityNaturally(EntityType type, com.flowpowered.math.vector.Vector3i position) Create an entity instance at the given position with the default equipment.
Collection<Entity>	getEntities() Return a collection of entities contained within this universe, possibly only returning entities only in loaded areas.
Collection<Entity>	getEntities(Predicate<Entity> filter) Return a collection of entities contained within this universe, possibly only returning entities only in loaded areas.
Optional<Entity>	getEntity(UUID uuid) Gets the entity whose UUID matches the provided id, possibly returning no entity if the entity is not loaded or non-existent.
default Set<Entity>	getIntersectingEntities(AABB box) Gets all the entities that intersect the bounding box, in no particular order.
Set<Entity>	getIntersectingEntities(AABB box, Predicate<Entity> filter) Gets all the entities that intersect the bounding box, in no particular order, as long as the pass the given filter test.
default Set<EntityUniverse.EntityHit>	getIntersectingEntities(Entity looker, double distance) Gets all the entities that are in the line of sight of the given entity, up to a given distance.
default Set<EntityUniverse.EntityHit>	getIntersectingEntities(Entity looker, double distance, Predicate<EntityUniverse.EntityHit> filter) Gets all the entities that are in the line of sight of the given entity, up to a given distance.
default Set<EntityUniverse.EntityHit>	getIntersectingEntities(com.flowpowered.math.vector.Vector3d start, com.flowpowered.math.vector.Vector3d end) Gets all the entities that intersect the ray (by their bounding box) The ray is defined by its start and end point.
default Set<EntityUniverse.EntityHit>	getIntersectingEntities(com.flowpowered.math.vector.Vector3d start, com.flowpowered.math.vector.Vector3d direction, double distance) Gets all the entities that intersect the ray (by their bounding box) The ray is defined by its start, direction and distance.
Set<EntityUniverse.EntityHit>	getIntersectingEntities(com.flowpowered.math.vector.Vector3d start, com.flowpowered.math.vector.Vector3d direction, double distance, Predicate<EntityUniverse.EntityHit> filter) Gets all the entities that intersect the ray (by their bounding box) The ray is defined by its start, direction and distance.
Set<EntityUniverse.EntityHit>	getIntersectingEntities(com.flowpowered.math.vector.Vector3d start, com.flowpowered.math.vector.Vector3d end, Predicate<EntityUniverse.EntityHit> filter) Gets all the entities that intersect the ray (by their bounding box) The ray is defined by its start and end point.
default Collection<Entity>	getNearbyEntities(com.flowpowered.math.vector.Vector3d location, double distance) Return a collection of entities contained within distance blocks of the specified location.
Optional<Entity>	restoreSnapshot(EntitySnapshot snapshot, com.flowpowered.math.vector.Vector3d position) Creates and restores an Entity from the provided EntitySnapshot at the provided Vector3d position.
Collection<Entity>	spawnEntities(Iterable<? extends Entity> entities) Similar to spawnEntity(Entity) except where multiple entities can be attempted to be spawned.
boolean	spawnEntity(Entity entity) Spawns an Entity using the already set properties (extent, position, rotation) and applicable DataManipulators for spawning the entity.

Method Detail

getEntity

Optional<Entity> getEntity(UUID uuid)

Gets the entity whose UUID matches the provided id, possibly returning no entity if the entity is not loaded or non-existent.

For world implementations, only some parts of the world is usually loaded, so this method may return no entity if the entity is not loaded.

Parameters:

uuid - The unique id

Returns:

An entity, if available

getEntities

Collection<Entity> getEntities()

Return a collection of entities contained within this universe, possibly only returning entities only in loaded areas.

For world implementations, only some parts of the world is usually loaded, so this method will only return entities within those loaded parts.

Returns:

A collection of entities

getEntities

Collection<Entity> getEntities(Predicate<Entity> filter)

Return a collection of entities contained within this universe, possibly only returning entities only in loaded areas. The returned entities are filtered by the given Predicate before being returned.

For world implementations, only some parts of the world is usually loaded, so this method will only return entities within those loaded parts.

Parameters:

filter - The filter to apply to the returned entities

Returns:

A collection of filtered entities

getNearbyEntities

default Collection<Entity> getNearbyEntities(com.flowpowered.math.vector.Vector3d location,
                                             double distance)

Return a collection of entities contained within distance blocks of the specified location. This uses a sphere to test distances.

For world implementations, only some parts of the world is usually loaded, so this method will only return entities within those loaded parts.

Parameters:

location - The location at the center of the search radius

distance - The search radius

Returns:

A collection of nearby entities

createEntity

Entity createEntity(EntityType type,
                    com.flowpowered.math.vector.Vector3d position)
             throws IllegalArgumentException,
                    IllegalStateException

Create an entity instance at the given position.

Creating an entity does not spawn the entity into the world. An entity created means the entity can be spawned at the given location. If Optional.empty() was returned, the entity is not able to spawn at the given location. Furthermore, this allows for the Entity to be customized further prior to traditional "ticking" and processing by core systems.

Parameters:

type - The type

position - The position

Returns:

An entity, if one was created

Throws:

IllegalArgumentException - If the position or entity type is not valid to create

IllegalStateException - If a constructor cannot be found

createEntity

default Entity createEntity(EntityType type,
                            com.flowpowered.math.vector.Vector3i position)
                     throws IllegalArgumentException,
                            IllegalStateException

Create an entity instance at the given position.

Creating an entity does not spawn the entity into the world. An entity created means the entity can be spawned at the given location. If Optional.empty() was returned, the entity is not able to spawn at the given location. Furthermore, this allows for the Entity to be customized further prior to traditional "ticking" and processing by core systems.

Parameters:

type - The type

position - The position

Returns:

An entity, if one was created

Throws:

IllegalArgumentException - If the position or entity type is not valid to create

IllegalStateException - If a constructor cannot be found

createEntity

Optional<Entity> createEntity(DataContainer entityContainer)

Create an entity instance at the given position.

Creating an entity does not spawn the entity into the world. An entity created means the entity can be spawned at the given location. If Optional.empty() was returned, the entity is not able to spawn at the given location. Furthermore, this allows for the Entity to be customized further prior to traditional "ticking" and processing by core systems.

Parameters:

entityContainer - The data container of the entity

Returns:

An entity, if one was created

createEntity

Optional<Entity> createEntity(DataContainer entityContainer,
                              com.flowpowered.math.vector.Vector3d position)

Create an entity instance at the given position.

Creating an entity does not spawn the entity into the world. An entity created means the entity can be spawned at the given location. If Optional.empty() was returned, the entity is not able to spawn at the given location. Furthermore, this allows for the Entity to be customized further prior to traditional "ticking" and processing by core systems.

Parameters:

entityContainer - The data container of the entity

position - The position of the entity to spawn at

Returns:

An entity, if one was created

createEntityNaturally

Entity createEntityNaturally(EntityType type,
                             com.flowpowered.math.vector.Vector3d position)
                      throws IllegalArgumentException,
                             IllegalStateException

Create an entity instance at the given position with the default equipment.

Creating an entity does not spawn the entity into the world. An entity created means the entity can be spawned at the given location. If Optional.empty() was returned, the entity is not able to spawn at the given location. Furthermore, this allows for the Entity to be customized further prior to traditional "ticking" and processing by core systems.

Parameters:

type - The type

position - The position

Returns:

An entity, if one was created

Throws:

IllegalArgumentException - If the position or entity type is not valid to create

IllegalStateException - If a constructor cannot be found

createEntityNaturally

default Entity createEntityNaturally(EntityType type,
                                     com.flowpowered.math.vector.Vector3i position)
                              throws IllegalArgumentException,
                                     IllegalStateException

Create an entity instance at the given position with the default equipment.

Creating an entity does not spawn the entity into the world. An entity created means the entity can be spawned at the given location. If Optional.empty() was returned, the entity is not able to spawn at the given location. Furthermore, this allows for the Entity to be customized further prior to traditional "ticking" and processing by core systems.

Parameters:

type - The type

position - The position

Returns:

An entity, if one was created

Throws:

IllegalArgumentException - If the position or entity type is not valid to create

IllegalStateException - If a constructor cannot be found

restoreSnapshot

Optional<Entity> restoreSnapshot(EntitySnapshot snapshot,
                                 com.flowpowered.math.vector.Vector3d position)

Creates and restores an Entity from the provided EntitySnapshot at the provided Vector3d position.

Creating an entity does not spawn the entity into the world. An entity created means the entity can be spawned at the given location. If Optional.empty() was returned, the entity is not able to spawn at the given location. Furthermore, this allows for the Entity to be customized further prior to traditional "ticking" and processing by core systems.

Parameters:

snapshot - The entity snapshot of the entity

position - The position of the entity to spawn at

Returns:

An entity, if one was created

spawnEntity

boolean spawnEntity(Entity entity)

Spawns an Entity using the already set properties (extent, position, rotation) and applicable DataManipulators for spawning the entity.

The requirements involve that all necessary setup of states and data is already preformed on the entity retrieved from the various createEntity(EntityType,Vector3d) methods. Calling this will make the now-spawned entity able to be processed by various systems.

If the entity was unable to spawn, the entity is not removed, but it should be taken note that there can be many reasons for a failure.

Parameters:

entity - The entity to spawn

Returns:

True if successful, false if not

spawnEntities

Collection<Entity> spawnEntities(Iterable<? extends Entity> entities)

Similar to spawnEntity(Entity) except where multiple entities can be attempted to be spawned.

Parameters:

entities - The created entities you wish to spawn

Returns:

The entities which spawned correctly, or empty if none

getIntersectingEntities

default Set<Entity> getIntersectingEntities(AABB box)

Gets all the entities that intersect the bounding box, in no particular order.

Parameters:

box - The intersection box

Returns:

All the intersecting entities

getIntersectingEntities

Set<Entity> getIntersectingEntities(AABB box,
                                    Predicate<Entity> filter)

Gets all the entities that intersect the bounding box, in no particular order, as long as the pass the given filter test.

Parameters:

box - The intersection box

filter - The filter test

Returns:

All the intersecting entities that pass the filter test

getIntersectingEntities

default Set<EntityUniverse.EntityHit> getIntersectingEntities(com.flowpowered.math.vector.Vector3d start,
                                                              com.flowpowered.math.vector.Vector3d end)

Gets all the entities that intersect the ray (by their bounding box) The ray is defined by its start and end point.

Parameters:

start - The start of the ray

end - The end of the ray

Returns:

The intersecting entities in no particular order, with the associated intersection point and normal

getIntersectingEntities

Set<EntityUniverse.EntityHit> getIntersectingEntities(com.flowpowered.math.vector.Vector3d start,
                                                      com.flowpowered.math.vector.Vector3d end,
                                                      Predicate<EntityUniverse.EntityHit> filter)

Gets all the entities that intersect the ray (by their bounding box) The ray is defined by its start and end point. Only the entities that pass the filter test are added.

Parameters:

start - The start of the ray

end - The end of the ray

filter - The filter test

Returns:

The intersecting entities in no particular order, with the associated intersection point and normal

getIntersectingEntities

default Set<EntityUniverse.EntityHit> getIntersectingEntities(Entity looker,
                                                              double distance)

Gets all the entities that are in the line of sight of the given entity, up to a given distance. This ignores occluders like blocks or other entities. That is to say, the returned entities might not actually be visible.

Parameters:

looker - The looking entity

distance - The distance of the ray (from the start)

Returns:

The intersecting entities in no particular order, with the associated intersection point and normal

getIntersectingEntities

default Set<EntityUniverse.EntityHit> getIntersectingEntities(Entity looker,
                                                              double distance,
                                                              Predicate<EntityUniverse.EntityHit> filter)

Gets all the entities that are in the line of sight of the given entity, up to a given distance. This ignores occluders like blocks or other entities. That is to say, the returned entities might not actually be visible. Only the entities that pass the filter test are added.

Parameters:

looker - The looking entity

distance - The distance of the ray (from the start)

filter - The filter test

Returns:

The intersecting entities in no particular order, with the associated intersection point and normal

getIntersectingEntities

default Set<EntityUniverse.EntityHit> getIntersectingEntities(com.flowpowered.math.vector.Vector3d start,
                                                              com.flowpowered.math.vector.Vector3d direction,
                                                              double distance)

Gets all the entities that intersect the ray (by their bounding box) The ray is defined by its start, direction and distance.

Parameters:

start - The start of the ray

direction - The direction of the ray

distance - The distance of the ray (from the start)

Returns:

The intersecting entities in no particular order, with the associated intersection point and normal

getIntersectingEntities

Set<EntityUniverse.EntityHit> getIntersectingEntities(com.flowpowered.math.vector.Vector3d start,
                                                      com.flowpowered.math.vector.Vector3d direction,
                                                      double distance,
                                                      Predicate<EntityUniverse.EntityHit> filter)

Gets all the entities that intersect the ray (by their bounding box) The ray is defined by its start, direction and distance. Only the entities that pass the filter test are added.

Parameters:

start - The start of the ray

direction - The direction of the ray

distance - The distance of the ray (from the start)

filter - The filter test

Returns:

The intersecting entities in no particular order, with the associated intersection point and normal