de.gurkenlabs.litiengine.environment

Class Environment

java.lang.Object

de.gurkenlabs.litiengine.environment.Environment

All Implemented Interfaces:

IEnvironment, IRenderable, IInitializable

public class Environment
extends java.lang.Object
implements IEnvironment

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.List<ICombatEntity>	findCombatEntities(java.awt.Shape shape)
java.util.List<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.List<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)
IEntity	get(int mapId)
IEntity	get(java.lang.String name)
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<T> clss, java.lang.String... tags)
java.util.Collection<IEntity>	getByTag(java.lang.String... tags)
<T extends IEntity> java.util.Collection<T>	getByType(java.lang.Class<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(RenderType renderType)
java.util.Map<java.lang.String,java.util.List<IEntity>>	getEntitiesByTag()
LightSource	getLightSource(int mapId)
LightSource	getLightSource(java.lang.String name)
java.util.Collection<LightSource>	getLightSources()
int	getLocalMapId() Negative map ids are only used locally.
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.List<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	unload()

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)

Specified by:

addRenderListener in interface IEnvironment

removeRenderListener

public void removeRenderListener(EnvironmentRenderListener listener)

Specified by:

removeRenderListener in interface IEnvironment

addListener

public void addListener(EnvironmentListener listener)

Specified by:

addListener in interface IEnvironment

removeListener

public void removeListener(EnvironmentListener listener)

Specified by:

removeListener in interface IEnvironment

addEntityListener

public void addEntityListener(EnvironmentEntityListener listener)

Specified by:

addEntityListener in interface IEnvironment

removeEntityListener

public void removeEntityListener(EnvironmentEntityListener listener)

Specified by:

removeEntityListener in interface IEnvironment

add

public void add(IEntity entity)

Description copied from interface: IEnvironment

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.

Specified by:

add in interface IEnvironment

Parameters:

entity - The entity to add to the environment.

add

public void add(IRenderable renderable,
                RenderType renderType)

Specified by:

add in interface IEnvironment

build

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

Specified by:

build in interface IEnvironment

build

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

Specified by:

build in interface IEnvironment

clear

public void clear()

Specified by:

clear in interface IEnvironment

findCombatEntities

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

Specified by:

findCombatEntities in interface IEnvironment

findCombatEntities

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

Description copied from interface: IEnvironment

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

Specified by:

findCombatEntities in interface IEnvironment

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.List<IEntity> findEntities(java.awt.Shape shape)

Specified by:

findEntities in interface IEnvironment

get

public IEntity get(int mapId)

Specified by:

get in interface IEnvironment

get

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

Specified by:

get in interface IEnvironment

get

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

Specified by:

get in interface IEnvironment

get

public IEntity get(java.lang.String name)

Specified by:

get in interface IEnvironment

get

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

Specified by:

get in interface IEnvironment

getByTag

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

Specified by:

getByTag in interface IEnvironment

getByTag

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

Specified by:

getByTag in interface IEnvironment

getAmbientLight

public AmbientLight getAmbientLight()

Specified by:

getAmbientLight in interface IEnvironment

getAreas

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

Specified by:

getAreas in interface IEnvironment

getArea

public MapArea getArea(int mapId)

Specified by:

getArea in interface IEnvironment

getArea

public MapArea getArea(java.lang.String name)

Specified by:

getArea in interface IEnvironment

getCenter

public java.awt.geom.Point2D getCenter()

Specified by:

getCenter in interface IEnvironment

getEmitters

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

Specified by:

getEmitters in interface IEnvironment

getEmitter

public Emitter getEmitter(int mapId)

Specified by:

getEmitter in interface IEnvironment

getEmitter

public Emitter getEmitter(java.lang.String name)

Specified by:

getEmitter in interface IEnvironment

getCollisionBoxes

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

Specified by:

getCollisionBoxes in interface IEnvironment

getCollisionBox

public CollisionBox getCollisionBox(int mapId)

Specified by:

getCollisionBox in interface IEnvironment

getCollisionBox

public CollisionBox getCollisionBox(java.lang.String name)

Specified by:

getCollisionBox in interface IEnvironment

getCombatEntities

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

Specified by:

getCombatEntities in interface IEnvironment

getCombatEntity

public ICombatEntity getCombatEntity(int mapId)

Specified by:

getCombatEntity in interface IEnvironment

getCombatEntity

public ICombatEntity getCombatEntity(java.lang.String name)

Specified by:

getCombatEntity in interface IEnvironment

getEntities

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

Specified by:

getEntities in interface IEnvironment

getEntities

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

Specified by:

getEntities in interface IEnvironment

getEntitiesByTag

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

Specified by:

getEntitiesByTag in interface IEnvironment

getByType

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

Specified by:

getByType in interface IEnvironment

getLightSources

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

Specified by:

getLightSources in interface IEnvironment

getLightSource

public LightSource getLightSource(int mapId)

Specified by:

getLightSource in interface IEnvironment

getLightSource

public LightSource getLightSource(java.lang.String name)

Specified by:

getLightSource in interface IEnvironment

getLocalMapId

public int getLocalMapId()

Negative map ids are only used locally.

Specified by:

getLocalMapId in interface IEnvironment

Returns:

The next unique local map id.

getMap

public IMap getMap()

Specified by:

getMap in interface IEnvironment

getMobileEntities

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

Specified by:

getMobileEntities in interface IEnvironment

getMobileEntity

public IMobileEntity getMobileEntity(int mapId)

Specified by:

getMobileEntity in interface IEnvironment

getMobileEntity

public IMobileEntity getMobileEntity(java.lang.String name)

Specified by:

getMobileEntity in interface IEnvironment

getNextMapId

public int getNextMapId()

Description copied from interface: IEnvironment

Gets the next unique global map id.

Specified by:

getNextMapId in interface IEnvironment

Returns:

The next unique global map id.

getRenderables

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

Specified by:

getRenderables in interface IEnvironment

getProps

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

Specified by:

getProps in interface IEnvironment

getProp

public Prop getProp(int mapId)

Specified by:

getProp in interface IEnvironment

getProp

public Prop getProp(java.lang.String name)

Specified by:

getProp in interface IEnvironment

getCreature

public Creature getCreature(int mapId)

Specified by:

getCreature in interface IEnvironment

getCreature

public Creature getCreature(java.lang.String name)

Specified by:

getCreature in interface IEnvironment

getCreatures

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

Specified by:

getCreatures in interface IEnvironment

getSpawnpoint

public Spawnpoint getSpawnpoint(int mapId)

Specified by:

getSpawnpoint in interface IEnvironment

getSpawnpoint

public Spawnpoint getSpawnpoint(java.lang.String name)

Specified by:

getSpawnpoint in interface IEnvironment

getSpawnPoints

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

Specified by:

getSpawnPoints in interface IEnvironment

getStaticShadows

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

Specified by:

getStaticShadows in interface IEnvironment

getStaticShadow

public StaticShadow getStaticShadow(int mapId)

Specified by:

getStaticShadow in interface IEnvironment

getStaticShadow

public StaticShadow getStaticShadow(java.lang.String name)

Specified by:

getStaticShadow in interface IEnvironment

getStaticShadowLayer

public StaticShadowLayer getStaticShadowLayer()

Specified by:

getStaticShadowLayer in interface IEnvironment

getTrigger

public Trigger getTrigger(int mapId)

Specified by:

getTrigger in interface IEnvironment

getTrigger

public Trigger getTrigger(java.lang.String name)

Specified by:

getTrigger in interface IEnvironment

getTriggers

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

Specified by:

getTriggers in interface IEnvironment

getUsedTags

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

Specified by:

getUsedTags in interface IEnvironment

init

public final void init()

Specified by:

init in interface IInitializable

isLoaded

public boolean isLoaded()

Specified by:

isLoaded in interface IEnvironment

load

public void load()

Specified by:

load in interface IEnvironment

loadFromMap

public void loadFromMap(int mapId)

Specified by:

loadFromMap in interface IEnvironment

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)

Specified by:

reloadFromMap in interface IEnvironment

remove

public void remove(IEntity entity)

Specified by:

remove in interface IEnvironment

remove

public void remove(int mapId)

Specified by:

remove in interface IEnvironment

remove

public void remove(java.lang.String name)

Specified by:

remove in interface IEnvironment

remove

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

Specified by:

remove in interface IEnvironment

removeRenderable

public void removeRenderable(IRenderable renderable)

Specified by:

removeRenderable in interface IEnvironment

render

public void render(java.awt.Graphics2D g)

Specified by:

render in interface IRenderable

unload

public void unload()

Specified by:

unload in interface IEnvironment

load

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

Specified by:

load in interface IEnvironment