de.gurkenlabs.litiengine.environment

Class Environment

java.lang.Object

de.gurkenlabs.litiengine.environment.Environment

All Implemented Interfaces:

IRenderable

public final class Environment
extends java.lang.Object
implements IRenderable

Constructor Summary

Constructors

Constructor and Description
Environment(IMap map)
Environment(java.lang.String mapPath)

Method Summary

Modifier and Type	Method and Description
void	add(IEntity entity) Adds the specified entity to the environment container.
void	add(IRenderable renderable, RenderType renderType)
void	addEntityListener(EnvironmentEntityListener listener)
void	addListener(EnvironmentListener listener)
void	addRenderListener(RenderType renderType, EnvironmentRenderListener listener)
java.util.Collection<IEntity>	build(Blueprint blueprint, double x, double y)
java.util.Collection<IEntity>	build(Blueprint blueprint, java.awt.geom.Point2D location)
void	clear()
java.util.Collection<ICombatEntity>	findCombatEntities(java.awt.Shape shape)
java.util.Collection<ICombatEntity>	findCombatEntities(java.awt.Shape shape, java.util.function.Predicate<ICombatEntity> condition) Searches for all combat entities whose hitBox intersect the specified shape.
java.util.Collection<IEntity>	findEntities(java.awt.Shape shape)
<T extends IEntity> T	get(java.lang.Class<T> clss, int mapId)
<T extends IEntity> T	get(java.lang.Class<T> clss, java.lang.String name)
java.util.List<IEntity>	get(int... mapIds) Finds the entities in the environment with the specified map IDs.
IEntity	get(int mapId)
IEntity	get(java.lang.String name)
java.util.Collection<java.lang.Integer>	getAllMapIDs()
AmbientLight	getAmbientLight()
MapArea	getArea(int mapId)
MapArea	getArea(java.lang.String name)
java.util.Collection<MapArea>	getAreas()
<T extends IEntity> java.util.Collection<T>	getByTag(java.lang.Class<? extends T> clss, java.lang.String... tags)
java.util.Collection<IEntity>	getByTag(java.lang.String... tags)
<T> java.util.Collection<T>	getByType(java.lang.Class<? extends T> cls)
java.awt.geom.Point2D	getCenter()
CollisionBox	getCollisionBox(int mapId)
CollisionBox	getCollisionBox(java.lang.String name)
java.util.Collection<CollisionBox>	getCollisionBoxes()
java.util.Collection<ICombatEntity>	getCombatEntities()
ICombatEntity	getCombatEntity(int mapId)
ICombatEntity	getCombatEntity(java.lang.String name)
Creature	getCreature(int mapId)
Creature	getCreature(java.lang.String name)
java.util.Collection<Creature>	getCreatures()
Emitter	getEmitter(int mapId)
Emitter	getEmitter(java.lang.String name)
java.util.Collection<Emitter>	getEmitters()
java.util.Collection<IEntity>	getEntities()
java.util.Collection<IEntity>	getEntities(IMapObjectLayer layer) Gets the entities that are bound to the specified layer.
java.util.Collection<IEntity>	getEntities(RenderType renderType) Gets the entities with the specified render type that are not bound to layers.
java.util.Collection<IEntity>	getEntitiesByLayer(int layerId) Gets the entities that are bound to layer with the specified layer ID.
java.util.Collection<IEntity>	getEntitiesByLayer(java.lang.String name) Gets the entities that are bound to layer with the specified name.
java.util.Map<java.lang.String,java.util.Collection<IEntity>>	getEntitiesByTag()
int	getGravity()
LightSource	getLightSource(int mapId)
LightSource	getLightSource(java.lang.String name)
java.util.Collection<LightSource>	getLightSources()
int	getLocalMapId() Gets the next unique local map id.
IMap	getMap()
java.util.Collection<IMobileEntity>	getMobileEntities()
IMobileEntity	getMobileEntity(int mapId)
IMobileEntity	getMobileEntity(java.lang.String name)
int	getNextMapId() Gets the next unique global map id.
Prop	getProp(int mapId)
Prop	getProp(java.lang.String name)
java.util.Collection<Prop>	getProps()
java.util.Collection<IRenderable>	getRenderables(RenderType renderType)
Spawnpoint	getSpawnpoint(int mapId)
Spawnpoint	getSpawnpoint(java.lang.String name)
java.util.Collection<Spawnpoint>	getSpawnPoints()
StaticShadow	getStaticShadow(int mapId)
StaticShadow	getStaticShadow(java.lang.String name)
StaticShadowLayer	getStaticShadowLayer()
java.util.Collection<StaticShadow>	getStaticShadows()
Trigger	getTrigger(int mapId)
Trigger	getTrigger(java.lang.String name)
java.util.Collection<Trigger>	getTriggers()
java.util.Collection<java.lang.String>	getUsedTags()
void	init()
boolean	isLoaded()
void	load()
java.util.Collection<IEntity>	load(IMapObject mapObject)
void	loadFromMap(int mapId)
static <T extends IEntity> void	registerCustomEntityType(java.lang.Class<T> entityType) Registers a custom IEntity implementation to support being loaded from an IMap instance.
static <T extends IEntity> void	registerCustomEntityType(java.lang.String mapObjectType, java.lang.Class<T> entityType) Registers a custom IEntity implementation to support being loaded from an IMap instance.
static void	registerMapObjectLoader(IMapObjectLoader mapObjectLoader) Registers a custom loader instance that is responsible for loading and initializing entities of the defined MapObjectType.
void	reloadFromMap(int mapId)
<T extends IEntity> void	remove(java.util.Collection<T> entities)
void	remove(IEntity entity)
void	remove(int mapId)
void	remove(java.lang.String name)
void	removeEntityListener(EnvironmentEntityListener listener)
void	removeListener(EnvironmentListener listener)
void	removeRenderable(IRenderable renderable)
void	removeRenderListener(EnvironmentRenderListener listener)
void	render(java.awt.Graphics2D g)
void	renderLayer(java.awt.Graphics2D g, IMapObjectLayer layer)
void	setGravity(int gravity)
void	unload()
void	updateLighting()
void	updateLighting(IEntity entity)
void	updateLighting(java.awt.geom.Rectangle2D section)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Environment

public Environment(IMap map)

Environment

public Environment(java.lang.String mapPath)

Method Detail

addRenderListener

public void addRenderListener(RenderType renderType,
                              EnvironmentRenderListener listener)

removeRenderListener

public void removeRenderListener(EnvironmentRenderListener listener)

addListener

public void addListener(EnvironmentListener listener)

removeListener

public void removeListener(EnvironmentListener listener)

addEntityListener

public void addEntityListener(EnvironmentEntityListener listener)

removeEntityListener

public void removeEntityListener(EnvironmentEntityListener listener)

add

public void add(IEntity entity)

Adds the specified entity to the environment container. This also loads the entity (register entity and controllers for update) if the environment has already been loaded. The entity will not be bound to a layer.

Parameters:

entity - The entity to add to the environment.

updateLighting

public void updateLighting(IEntity entity)

updateLighting

public void updateLighting()

updateLighting

public void updateLighting(java.awt.geom.Rectangle2D section)

add

public void add(IRenderable renderable,
                RenderType renderType)

build

public java.util.Collection<IEntity> build(Blueprint blueprint,
                                           double x,
                                           double y)

build

public java.util.Collection<IEntity> build(Blueprint blueprint,
                                           java.awt.geom.Point2D location)

clear

public void clear()

findCombatEntities

public java.util.Collection<ICombatEntity> findCombatEntities(java.awt.Shape shape)

findCombatEntities

public java.util.Collection<ICombatEntity> findCombatEntities(java.awt.Shape shape,
                                                              java.util.function.Predicate<ICombatEntity> condition)

Searches for all combat entities whose hitBox intersect the specified shape.

Parameters:

shape - The shape to check intersection for.

condition - An additional condition that allows to specify a condition which determines if a ICombatEntity should be considered.

Returns:

A list of all combat entities that intersect the specified Shape.

findEntities

public java.util.Collection<IEntity> findEntities(java.awt.Shape shape)

get

public IEntity get(int mapId)

get

public java.util.List<IEntity> get(int... mapIds)

Finds the entities in the environment with the specified map IDs.

Parameters:

mapIds - The map IDs to search for.

Returns:

A List of entities found, in the order given by the parameters.

get

public <T extends IEntity> T get(java.lang.Class<T> clss,
                                 int mapId)

get

public IEntity get(java.lang.String name)

get

public <T extends IEntity> T get(java.lang.Class<T> clss,
                                 java.lang.String name)

getByTag

public java.util.Collection<IEntity> getByTag(java.lang.String... tags)

getByTag

public <T extends IEntity> java.util.Collection<T> getByTag(java.lang.Class<? extends T> clss,
                                                            java.lang.String... tags)

getAmbientLight

public AmbientLight getAmbientLight()

getAreas

public java.util.Collection<MapArea> getAreas()

getArea

public MapArea getArea(int mapId)

getArea

public MapArea getArea(java.lang.String name)

getCenter

public java.awt.geom.Point2D getCenter()

getEmitters

public java.util.Collection<Emitter> getEmitters()

getEmitter

public Emitter getEmitter(int mapId)

getEmitter

public Emitter getEmitter(java.lang.String name)

getCollisionBoxes

public java.util.Collection<CollisionBox> getCollisionBoxes()

getCollisionBox

public CollisionBox getCollisionBox(int mapId)

getCollisionBox

public CollisionBox getCollisionBox(java.lang.String name)

getCombatEntities

public java.util.Collection<ICombatEntity> getCombatEntities()

getCombatEntity

public ICombatEntity getCombatEntity(int mapId)

getCombatEntity

public ICombatEntity getCombatEntity(java.lang.String name)

getEntities

public java.util.Collection<IEntity> getEntities()

getEntities

public java.util.Collection<IEntity> getEntities(RenderType renderType)

Gets the entities with the specified render type that are not bound to layers.

Entities are unbound from there originating MapObjectLayer if their RenderType differs from the layer's RenderType.

Parameters:

renderType - The render type

Returns:

The miscellaneous entities with the specified render type

See Also:

IEntity.getRenderType(), ILayer.getRenderType()

getEntities

public java.util.Collection<IEntity> getEntities(IMapObjectLayer layer)

Gets the entities that are bound to the specified layer.

Entities are bound to a layer if their RenderType matches the layer's RenderType

Parameters:

layer - The layer that the entities are bound to.

Returns:

The entities that are bound to the specified layer.

See Also:

IEntity.getRenderType(), ILayer.getRenderType()

getEntitiesByLayer

public java.util.Collection<IEntity> getEntitiesByLayer(java.lang.String name)

Gets the entities that are bound to layer with the specified name.

Entities are bound to a layer if their RenderType matches the layer's RenderType

Parameters:

name - The name of the layer

Returns:

The entities that are bound to the specified layer.

See Also:

IEntity.getRenderType(), ILayer.getRenderType(), ILayer.getName()

getEntitiesByLayer

public java.util.Collection<IEntity> getEntitiesByLayer(int layerId)

Gets the entities that are bound to layer with the specified layer ID.

Entities are bound to a layer if their RenderType matches the layer's RenderType

Parameters:

layerId - The id of the layer

Returns:

The entities that are bound to the specified layer.

See Also:

IEntity.getRenderType(), ILayer.getRenderType(), ILayer.getId()

getEntitiesByTag

public java.util.Map<java.lang.String,java.util.Collection<IEntity>> getEntitiesByTag()

getByType

public <T> java.util.Collection<T> getByType(java.lang.Class<? extends T> cls)

getLightSources

public java.util.Collection<LightSource> getLightSources()

getLightSource

public LightSource getLightSource(int mapId)

getLightSource

public LightSource getLightSource(java.lang.String name)

getLocalMapId

public int getLocalMapId()

Gets the next unique local map id. (All local map ids are negative).

Returns:

The next unique local map id.

getMap

public IMap getMap()

getMobileEntities

public java.util.Collection<IMobileEntity> getMobileEntities()

getMobileEntity

public IMobileEntity getMobileEntity(int mapId)

getMobileEntity

public IMobileEntity getMobileEntity(java.lang.String name)

getNextMapId

public int getNextMapId()

Gets the next unique global map id.

Returns:

The next unique global map id.

getRenderables

public java.util.Collection<IRenderable> getRenderables(RenderType renderType)

getProps

public java.util.Collection<Prop> getProps()

getProp

public Prop getProp(int mapId)

getProp

public Prop getProp(java.lang.String name)

getCreature

public Creature getCreature(int mapId)

getCreature

public Creature getCreature(java.lang.String name)

getCreatures

public java.util.Collection<Creature> getCreatures()

getSpawnpoint

public Spawnpoint getSpawnpoint(int mapId)

getSpawnpoint

public Spawnpoint getSpawnpoint(java.lang.String name)

getSpawnPoints

public java.util.Collection<Spawnpoint> getSpawnPoints()

getStaticShadows

public java.util.Collection<StaticShadow> getStaticShadows()

getStaticShadow

public StaticShadow getStaticShadow(int mapId)

getStaticShadow

public StaticShadow getStaticShadow(java.lang.String name)

getStaticShadowLayer

public StaticShadowLayer getStaticShadowLayer()

getTrigger

public Trigger getTrigger(int mapId)

getTrigger

public Trigger getTrigger(java.lang.String name)

getTriggers

public java.util.Collection<Trigger> getTriggers()

getUsedTags

public java.util.Collection<java.lang.String> getUsedTags()

init

public final void init()

isLoaded

public boolean isLoaded()

load

public void load()

loadFromMap

public void loadFromMap(int mapId)

registerMapObjectLoader

public static void registerMapObjectLoader(IMapObjectLoader mapObjectLoader)

Registers a custom loader instance that is responsible for loading and initializing entities of the defined MapObjectType.

There can only be one loader for a particular type. Calling this method again for the same type will overwrite the previously registered loader.

Parameters:

mapObjectLoader - The MapObjectLoader instance to be registered.

See Also:

IMapObjectLoader.getMapObjectType()

registerCustomEntityType

public static <T extends IEntity> void registerCustomEntityType(java.lang.String mapObjectType,
                                                                java.lang.Class<T> entityType)

Registers a custom IEntity implementation to support being loaded from an IMap instance. Note that the specified class needs to be accessible in a static manner. Inner classes that aren't declared statically are not supported. This is an overload of the registerCustomEntityType(Class) method that allows to explicitly specify the MapObjectType without having to provide an EntityInfo annotation containing this information.

Type Parameters:

T - The type of the custom entity.

Parameters:

mapObjectType - The custom mapobjectType that is used by IMapObjects to determine the target entity implementation.

entityType - The class type of the custom entity implementation.

See Also:

IMapObject.getType(), EntityInfo.customMapObjectType()

registerCustomEntityType

public static <T extends IEntity> void registerCustomEntityType(java.lang.Class<T> entityType)

Registers a custom IEntity implementation to support being loaded from an IMap instance. Note that the specified class needs to be accessible in a static manner. Inner classes that aren't declared statically are not supported. This implementation uses the provided EntityInfo.customMapObjectType() to determine for which type the specified class should be used.

Type Parameters:

T - The type of the custom entity.

Parameters:

entityType - The class type of the custom entity implementation.

See Also:

registerCustomEntityType(String, Class), IMapObject.getType(), EntityInfo.customMapObjectType()

reloadFromMap

public void reloadFromMap(int mapId)

remove

public void remove(IEntity entity)

remove

public void remove(int mapId)

remove

public void remove(java.lang.String name)

remove

public <T extends IEntity> void remove(java.util.Collection<T> entities)

removeRenderable

public void removeRenderable(IRenderable renderable)

render

public void render(java.awt.Graphics2D g)

Specified by:

render in interface IRenderable

getGravity

public int getGravity()

setGravity

public void setGravity(int gravity)

unload

public void unload()

load

public java.util.Collection<IEntity> load(IMapObject mapObject)

renderLayer

public void renderLayer(java.awt.Graphics2D g,
                        IMapObjectLayer layer)

getAllMapIDs

public java.util.Collection<java.lang.Integer> getAllMapIDs()