de.gurkenlabs.litiengine.environment

Interface IEnvironment

All Superinterfaces:

IInitializable, IRenderable

All Known Implementing Classes:

Environment

public interface IEnvironment
extends IInitializable, IRenderable

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... tag)
java.util.Collection<IEntity>	getByTag(java.lang.String... tag)
<T extends IEntity> java.util.Collection<T>	getByType(java.lang.Class<T> clss)
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() 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.List<java.lang.String>	getUsedTags()
boolean	isLoaded()
void	load()
java.util.Collection<IEntity>	load(IMapObject mapObject)
void	loadFromMap(int mapId)
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	unload()

Methods inherited from interface de.gurkenlabs.litiengine.IInitializable

init

Methods inherited from interface de.gurkenlabs.litiengine.graphics.IRenderable

render

Method Detail

addRenderListener

void addRenderListener(RenderType renderType,
                       EnvironmentRenderListener listener)

removeRenderListener

void removeRenderListener(EnvironmentRenderListener listener)

addListener

void addListener(EnvironmentListener listener)

removeListener

void removeListener(EnvironmentListener listener)

addEntityListener

void addEntityListener(EnvironmentEntityListener listener)

removeEntityListener

void removeEntityListener(EnvironmentEntityListener listener)

add

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.

Parameters:

entity - The entity to add to the environment.

add

void add(IRenderable renderable,
         RenderType renderType)

clear

void clear()

build

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

build

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

findCombatEntities

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

findCombatEntities

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.

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

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

get

IEntity get(int mapId)

get

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

get

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

get

IEntity get(java.lang.String name)

get

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

getByTag

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

getByTag

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

getEntitiesByTag

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

getAmbientLight

AmbientLight getAmbientLight()

getStaticShadowLayer

StaticShadowLayer getStaticShadowLayer()

getArea

MapArea getArea(int mapId)

getArea

MapArea getArea(java.lang.String name)

getAreas

java.util.Collection<MapArea> getAreas()

getCenter

java.awt.geom.Point2D getCenter()

getEmitters

java.util.Collection<Emitter> getEmitters()

getEmitter

Emitter getEmitter(int mapId)

getEmitter

Emitter getEmitter(java.lang.String name)

getCollisionBoxes

java.util.Collection<CollisionBox> getCollisionBoxes()

getCollisionBox

CollisionBox getCollisionBox(int mapId)

getCollisionBox

CollisionBox getCollisionBox(java.lang.String name)

getStaticShadows

java.util.Collection<StaticShadow> getStaticShadows()

getStaticShadow

StaticShadow getStaticShadow(int mapId)

getStaticShadow

StaticShadow getStaticShadow(java.lang.String name)

getCombatEntities

java.util.Collection<ICombatEntity> getCombatEntities()

getProps

java.util.Collection<Prop> getProps()

getProp

Prop getProp(int mapId)

getProp

Prop getProp(java.lang.String name)

getCombatEntity

ICombatEntity getCombatEntity(int mapId)

getCombatEntity

ICombatEntity getCombatEntity(java.lang.String name)

getEntities

java.util.Collection<IEntity> getEntities()

getEntities

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

getByType

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

getLightSource

LightSource getLightSource(int mapId)

getLightSource

LightSource getLightSource(java.lang.String name)

getLightSources

java.util.Collection<LightSource> getLightSources()

getLocalMapId

int getLocalMapId()

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

Returns:

The next unique local map id.

getMap

IMap getMap()

getMobileEntities

java.util.Collection<IMobileEntity> getMobileEntities()

getMobileEntity

IMobileEntity getMobileEntity(int mapId)

getMobileEntity

IMobileEntity getMobileEntity(java.lang.String name)

getNextMapId

int getNextMapId()

Gets the next unique global map id.

Returns:

The next unique global map id.

getSpawnpoint

Spawnpoint getSpawnpoint(int mapId)

getSpawnpoint

Spawnpoint getSpawnpoint(java.lang.String name)

getSpawnPoints

java.util.Collection<Spawnpoint> getSpawnPoints()

getCreature

Creature getCreature(int mapId)

getCreature

Creature getCreature(java.lang.String name)

getCreatures

java.util.Collection<Creature> getCreatures()

getUsedTags

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

getTrigger

Trigger getTrigger(int mapId)

getTrigger

Trigger getTrigger(java.lang.String name)

getTriggers

java.util.Collection<Trigger> getTriggers()

getRenderables

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

isLoaded

boolean isLoaded()

load

void load()

loadFromMap

void loadFromMap(int mapId)

reloadFromMap

void reloadFromMap(int mapId)

load

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

remove

void remove(IEntity entity)

remove

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

remove

void remove(int mapId)

remove

void remove(java.lang.String name)

removeRenderable

void removeRenderable(IRenderable renderable)

unload

void unload()