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) Adds the specified instance to be rendered with the defined RenderType whenever the environment's render pipeline is executed.
void	addAll(IEntity... entities) Adds all the specified entities to the environment container.
<T extends IEntity> void	addAll(java.lang.Iterable<T> entities) Adds all the specified entities to the environment container.
void	addEntityListener(EnvironmentEntityListener listener)
void	addListener(EnvironmentListener 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()
boolean	contains(IEntity entity) Determines whether the environment contains the specified entity.
boolean	contains(int mapId) Determines whether the environment contains any entity with the specified map ID.
java.util.Collection<ICombatEntity>	findCombatEntities(java.awt.Shape shape)
java.util.Collection<ICombatEntity>	findCombatEntities(java.awt.Shape shape, java.util.function.Predicate<ICombatEntity> condition) Attempts to find all combat entities whose hitBox intersects with 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) Gets all entities with the specified map IDs from the environment .
IEntity	get(int mapId)
IEntity	get(java.lang.String name)
java.util.Collection<java.lang.Integer>	getAllMapIDs() Gets an immutable collection with all assigned map IDs on the environment.
AmbientLight	getAmbientLight()
MapArea	getArea(int mapId) Gets the MapArea with the specified map ID from the environment.
MapArea	getArea(java.lang.String name) Gets the MapArea with the specified name from the environment.
java.util.Collection<MapArea>	getAreas() Gets an immutable collection containing all MapArea entities on the environment.
<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) Gets the CollisionBox with the specified map ID from the environment.
CollisionBox	getCollisionBox(java.lang.String name) Gets the CollisionBox with the specified name from the environment.
java.util.Collection<CollisionBox>	getCollisionBoxes() Gets an immutable collection containing all CollisionBox entities on the environment.
java.util.Collection<ICombatEntity>	getCombatEntities() Gets an immutable collection containing all ICombatEntity entities on the environment.
ICombatEntity	getCombatEntity(int mapId) Gets the ICombatEntity with the specified map ID from the environment.
ICombatEntity	getCombatEntity(java.lang.String name) Gets the ICombatEntity with the specified name from the environment.
Creature	getCreature(int mapId) Gets the Creature with the specified map ID from the environment.
Creature	getCreature(java.lang.String name) Gets the Creature with the specified name from the environment.
java.util.Collection<Creature>	getCreatures() Gets an immutable collection containing all Creature entities on the environment.
Emitter	getEmitter(int mapId) Gets the Emitter with the specified map ID from the environment.
Emitter	getEmitter(java.lang.String name) Gets the Emitter with the specified name from the environment.
java.util.Collection<Emitter>	getEmitters() Gets an immutable collection containing all Emitter entities on the environment.
java.util.Collection<IEntity>	getEntities() Gets an immutable collection containing all entities on the environment.
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) Gets the LightSource with the specified map ID from the environment.
LightSource	getLightSource(java.lang.String name) Gets the LightSource with the specified name from the environment.
java.util.Collection<LightSource>	getLightSources() Gets an immutable collection containing all LightSource entities on the environment.
int	getLocalMapId() Gets the next unique local map id.
IMap	getMap()
java.util.Collection<IMobileEntity>	getMobileEntities() Gets an immutable collection containing all IMobileEntity instances on the environment.
IMobileEntity	getMobileEntity(int mapId) Gets the IMobileEntity with the specified map ID from the environment.
IMobileEntity	getMobileEntity(java.lang.String name) Gets the IMobileEntity with the specified name from the environment.
int	getNextMapId() Gets the next unique global map id.
Prop	getProp(int mapId) Gets the Prop with the specified map ID from the environment.
Prop	getProp(java.lang.String name) Gets the Prop with the specified name from the environment.
java.util.Collection<Prop>	getProps() Gets an immutable collection containing all Prop entities on the environment.
java.util.Collection<IRenderable>	getRenderables(RenderType renderType) Gets an immutable collection containing all IRenderable instances for the specified render type on the environment.
Spawnpoint	getSpawnpoint(int mapId) Gets the Spawnpoint with the specified map ID from the environment.
Spawnpoint	getSpawnpoint(java.lang.String name) Gets the Spawnpoint with the specified name from the environment.
java.util.Collection<Spawnpoint>	getSpawnPoints() Gets an immutable collection containing all Spawnpoint entities on the environment.
StaticShadow	getStaticShadow(int mapId) Gets the StaticShadow with the specified map ID from the environment.
StaticShadow	getStaticShadow(java.lang.String name) Gets the StaticShadow with the specified name from the environment.
StaticShadowLayer	getStaticShadowLayer()
java.util.Collection<StaticShadow>	getStaticShadows() Gets an immutable collection containing all StaticShadow entities on the environment.
Trigger	getTrigger(int mapId) Gets the Trigger with the specified map ID from the environment.
Trigger	getTrigger(java.lang.String name) Gets the Trigger with the specified name from the environment.
java.util.Collection<Trigger>	getTriggers() Gets an immutable collection containing all Trigger entities on the environment.
java.util.Collection<java.lang.String>	getUsedTags() Gets all tags that are assigned to entities on this environment.
void	init()
Trigger	interact(ICollisionEntity source) Attempts to interact with triggers on this environment.
Trigger	interact(ICollisionEntity source, java.util.function.Predicate<Trigger> condition)
boolean	isLoaded()
void	load()
java.util.Collection<IEntity>	load(IMapObject mapObject)
void	loadFromMap(int mapId)
void	onRendered(RenderType renderType, EnvironmentRenderedListener listener)
static void	registerCustomEntityType(java.lang.Class<? extends IEntity> entityType) Registers a custom IEntity implementation to support being loaded from an IMap instance.
static void	registerCustomEntityType(java.lang.String mapObjectType, java.lang.Class<? extends IEntity> 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)
void	remove(IEntity entity)
void	remove(int mapId)
void	remove(java.lang.String name)
void	removeAll(IEntity... entities)
<T extends IEntity> void	removeAll(java.lang.Iterable<T> entities)
void	removeEntityListener(EnvironmentEntityListener listener)
void	removeListener(EnvironmentListener listener)
void	removeRenderable(IRenderable renderable)
void	removeRenderListener(EnvironmentRenderedListener listener)
void	render(java.awt.Graphics2D g) Renders the visual contents of this instance onto the provided graphics context.
void	setGravity(int gravity)
void	unload()
void	updateLighting() Forces an update on the lighting layers for the entire map.
void	updateLighting(java.awt.geom.Rectangle2D section) Forces an update on the lighting layers for the specified section on the map.

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

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 void registerCustomEntityType(java.lang.String mapObjectType,
                                            java.lang.Class<? extends IEntity> 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.

Custom entity types need to provide at least one constructor that matches the following criteria:

• has 2 parameters: Environment, IMapObject
• has 2 parameters: IMapObject, Environment
• has 1 parameter: IMapObject
• has 1 parameter: Environment
• is empty constructor

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 void registerCustomEntityType(java.lang.Class<? extends IEntity> 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.

Parameters:

entityType - The class type of the custom entity implementation.

See Also:

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

onRendered

public void onRendered(RenderType renderType,
                       EnvironmentRenderedListener listener)

removeRenderListener

public void removeRenderListener(EnvironmentRenderedListener 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 (registers 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.

See Also:

isLoaded(), IEntity.loaded(Environment), EnvironmentEntityListener.entityAdded(IEntity)

addAll

public <T extends IEntity> void addAll(java.lang.Iterable<T> entities)

Adds all the specified entities to the environment container.

Type Parameters:

T - The type of the entity.

Parameters:

entities - The entities to be added to the environment.

See Also:

add(IEntity), addAll(IEntity...), remove(IEntity), removeAll(Iterable)

addAll

public void addAll(IEntity... entities)

Adds all the specified entities to the environment container.

Parameters:

entities - The entities to be added to the environment.

See Also:

add(IEntity), addAll(Iterable), remove(IEntity), removeAll(Iterable)

updateLighting

public void updateLighting()

Forces an update on the lighting layers for the entire map.

See Also:

getStaticShadowLayer(), getAmbientLight(), ColorLayer.updateSection(Rectangle2D)

updateLighting

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

Forces an update on the lighting layers for the specified section on the map.

Parameters:

section - The section for which to update the lighting layers.

See Also:

getStaticShadowLayer(), getAmbientLight(), ColorLayer.updateSection(Rectangle2D)

add

public void add(IRenderable renderable,
                RenderType renderType)

Adds the specified instance to be rendered with the defined RenderType whenever the environment's render pipeline is executed.

This method can be used for any custom rendering that is not related to an entity, a GUI component or the map.

Note that you don't need to explicitly add an Entity if it implements IRenderable. The render engine will inherently call an entity's render method.

Parameters:

renderable - The instance that should be rendered.

renderType - The render type that determines how the instance is processed by the environment's render pipeline.

See Also:

render(Graphics2D), RenderEngine.renderEntity(Graphics2D, IEntity)

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()

contains

public boolean contains(IEntity entity)

Determines whether the environment contains the specified entity.

Parameters:

entity - The entity to check for.

Returns:

True if the environment contains the specified entity; otherwise false.

contains

public boolean contains(int mapId)

Determines whether the environment contains any entity with the specified map ID.

Parameters:

mapId - The map ID of the entity to check for.

Returns:

True if the environment contains an entity with the specified map ID; otherwise false.

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)

Attempts to find all combat entities whose hitBox intersects with 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)

Gets all entities with the specified map IDs from the environment .

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()

getAllMapIDs

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

Gets an immutable collection with all assigned map IDs on the environment.

Returns:

An immutable collection with all map IDs.

getAreas

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

Gets an immutable collection containing all MapArea entities on the environment.

To add or remove entities, use the corresponding methods on the environment.

Returns:

An immutable collection with all MapArea entities.

See Also:

add(IEntity), addAll(Iterable), remove(IEntity), removeAll(Iterable)

getArea

public MapArea getArea(int mapId)

Gets the MapArea with the specified map ID from the environment.

Parameters:

mapId - The map ID of the entity.

Returns:

The MapArea with the specified map ID or null if no entity is found.

See Also:

getArea(String), getAreas()

getArea

public MapArea getArea(java.lang.String name)

Gets the MapArea with the specified name from the environment.

Parameters:

name - The name of the entity.

Returns:

The MapArea with the specified name or null if no entity is found.

See Also:

getArea(int), getAreas()

getEmitters

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

Gets an immutable collection containing all Emitter entities on the environment.

To add or remove entities, use the corresponding methods on the environment.

Returns:

An immutable collection with all Emitter entities.

See Also:

add(IEntity), addAll(Iterable), remove(IEntity), removeAll(Iterable)

getEmitter

public Emitter getEmitter(int mapId)

Gets the Emitter with the specified map ID from the environment.

Parameters:

mapId - The map ID of the entity.

Returns:

The Emitter with the specified map ID or null if no entity is found.

See Also:

getEmitter(String), getEmitters()

getEmitter

public Emitter getEmitter(java.lang.String name)

Gets the Emitter with the specified name from the environment.

Parameters:

name - The name of the entity.

Returns:

The Emitter with the specified name or null if no entity is found.

See Also:

getEmitter(int), getEmitters()

getCollisionBoxes

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

Gets an immutable collection containing all CollisionBox entities on the environment.

To add or remove entities, use the corresponding methods on the environment.

Returns:

An immutable collection with all CollisionBox entities.

See Also:

add(IEntity), addAll(Iterable), remove(IEntity), removeAll(Iterable)

getCollisionBox

public CollisionBox getCollisionBox(int mapId)

Gets the CollisionBox with the specified map ID from the environment.

Parameters:

mapId - The map ID of the entity.

Returns:

The CollisionBox with the specified map ID or null if no entity is found.

See Also:

getCollisionBox(String), getCollisionBoxes()

getCollisionBox

public CollisionBox getCollisionBox(java.lang.String name)

Gets the CollisionBox with the specified name from the environment.

Parameters:

name - The name of the entity.

Returns:

The CollisionBox with the specified name or null if no entity is found.

See Also:

getCollisionBox(int), getCollisionBoxes()

getCombatEntities

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

Gets an immutable collection containing all ICombatEntity entities on the environment.

To add or remove entities, use the corresponding methods on the environment.

Returns:

An immutable collection with all ICombatEntity entities.

See Also:

add(IEntity), addAll(Iterable), remove(IEntity), removeAll(Iterable)

getCombatEntity

public ICombatEntity getCombatEntity(int mapId)

Gets the ICombatEntity with the specified map ID from the environment.

Parameters:

mapId - The map ID of the entity.

Returns:

The ICombatEntity with the specified map ID or null if no entity is found.

See Also:

getCombatEntity(String), getCombatEntities()

getCombatEntity

public ICombatEntity getCombatEntity(java.lang.String name)

Gets the ICombatEntity with the specified name from the environment.

Parameters:

name - The name of the entity.

Returns:

The ICombatEntity with the specified name or null if no entity is found.

See Also:

getCombatEntity(int), getCombatEntities()

getEntities

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

Gets an immutable collection containing all entities on the environment.

To add or remove entities, use the corresponding methods on the environment.

Returns:

An immutable collection with all entities.

See Also:

add(IEntity), addAll(Iterable), remove(IEntity), removeAll(Iterable)

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()

Gets an immutable collection containing all LightSource entities on the environment.

To add or remove entities, use the corresponding methods on the environment.

Returns:

An immutable collection with all LightSource entities.

See Also:

add(IEntity), addAll(Iterable), remove(IEntity), removeAll(Iterable)

getLightSource

public LightSource getLightSource(int mapId)

Gets the LightSource with the specified map ID from the environment.

Parameters:

mapId - The map ID of the entity.

Returns:

The LightSource with the specified map ID or null if no entity is found.

See Also:

getLightSource(String), getLightSources()

getLightSource

public LightSource getLightSource(java.lang.String name)

Gets the LightSource with the specified name from the environment.

Parameters:

name - The name of the entity.

Returns:

The LightSource with the specified name or null if no entity is found.

See Also:

getLightSource(int), getLightSources()

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()

Gets an immutable collection containing all IMobileEntity instances on the environment.

To add or remove entities, use the corresponding methods on the environment.

Returns:

An immutable collection with all IMobileEntity instances.

See Also:

add(IEntity), addAll(Iterable), remove(IEntity), removeAll(Iterable)

getMobileEntity

public IMobileEntity getMobileEntity(int mapId)

Gets the IMobileEntity with the specified map ID from the environment.

Parameters:

mapId - The map ID of the entity.

Returns:

The IMobileEntity with the specified map ID or null if no entity is found.

See Also:

getMobileEntity(String), getMobileEntities()

getMobileEntity

public IMobileEntity getMobileEntity(java.lang.String name)

Gets the IMobileEntity with the specified name from the environment.

Parameters:

name - The name of the entity.

Returns:

The IMobileEntity with the specified name or null if no entity is found.

See Also:

getMobileEntity(int), getMobileEntities()

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)

Gets an immutable collection containing all IRenderable instances for the specified render type on the environment.

To add or remove instances, use the corresponding methods on the environment.

Parameters:

renderType - The render type of the renderable instances.

Returns:

An immutable collection with all IRenderable instances.

See Also:

add(IRenderable, RenderType), removeRenderable(IRenderable)

getProps

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

Gets an immutable collection containing all Prop entities on the environment.

To add or remove entities, use the corresponding methods on the environment.

Returns:

An immutable collection with all Prop entities.

See Also:

add(IEntity), addAll(Iterable), remove(IEntity), removeAll(Iterable)

getProp

public Prop getProp(int mapId)

Gets the Prop with the specified map ID from the environment.

Parameters:

mapId - The map ID of the entity.

Returns:

The Prop with the specified map ID or null if no entity is found.

See Also:

getProp(String), getProps()

getProp

public Prop getProp(java.lang.String name)

Gets the Prop with the specified name from the environment.

Parameters:

name - The name of the entity.

Returns:

The Prop with the specified name or null if no entity is found.

See Also:

getProp(int), getProps()

getCreatures

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

Gets an immutable collection containing all Creature entities on the environment.

To add or remove entities, use the corresponding methods on the environment.

Returns:

An immutable collection with all Creature entities.

See Also:

add(IEntity), addAll(Iterable), remove(IEntity), removeAll(Iterable)

getCreature

public Creature getCreature(int mapId)

Gets the Creature with the specified map ID from the environment.

Parameters:

mapId - The map ID of the entity.

Returns:

The Creature with the specified map ID or null if no entity is found.

See Also:

getCreature(String), getCreatures()

getCreature

public Creature getCreature(java.lang.String name)

Gets the Creature with the specified name from the environment.

Parameters:

name - The name of the entity.

Returns:

The Creature with the specified name or null if no entity is found.

See Also:

getCreature(int), getCreatures()

getSpawnPoints

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

Gets an immutable collection containing all Spawnpoint entities on the environment.

To add or remove entities, use the corresponding methods on the environment.

Returns:

An immutable collection with all Spawnpoint entities.

See Also:

add(IEntity), addAll(Iterable), remove(IEntity), removeAll(Iterable)

getSpawnpoint

public Spawnpoint getSpawnpoint(int mapId)

Gets the Spawnpoint with the specified map ID from the environment.

Parameters:

mapId - The map ID of the entity.

Returns:

The Spawnpoint with the specified map ID or null if no entity is found.

See Also:

getSpawnpoint(String), getSpawnPoints()

getSpawnpoint

public Spawnpoint getSpawnpoint(java.lang.String name)

Gets the Spawnpoint with the specified name from the environment.

Parameters:

name - The name of the entity.

Returns:

The Spawnpoint with the specified name or null if no entity is found.

See Also:

getSpawnpoint(int), getSpawnPoints()

getStaticShadows

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

Gets an immutable collection containing all StaticShadow entities on the environment.

To add or remove entities, use the corresponding methods on the environment.

Returns:

An immutable collection with all StaticShadow entities.

See Also:

add(IEntity), addAll(Iterable), remove(IEntity), removeAll(Iterable)

getStaticShadow

public StaticShadow getStaticShadow(int mapId)

Gets the StaticShadow with the specified map ID from the environment.

Parameters:

mapId - The map ID of the entity.

Returns:

The StaticShadow with the specified map ID or null if no entity is found.

See Also:

getStaticShadow(String), getStaticShadows()

getStaticShadow

public StaticShadow getStaticShadow(java.lang.String name)

Gets the StaticShadow with the specified name from the environment.

Parameters:

name - The name of the entity.

Returns:

The StaticShadow with the specified name or null if no entity is found.

See Also:

getStaticShadow(int), getStaticShadows()

getStaticShadowLayer

public StaticShadowLayer getStaticShadowLayer()

getTriggers

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

Gets an immutable collection containing all Trigger entities on the environment.

To add or remove entities, use the corresponding methods on the environment.

Returns:

An immutable collection with all Trigger entities.

See Also:

add(IEntity), addAll(Iterable), remove(IEntity), removeAll(Iterable)

getTrigger

public Trigger getTrigger(int mapId)

Gets the Trigger with the specified map ID from the environment.

Parameters:

mapId - The map ID of the entity.

Returns:

The Trigger with the specified map ID or null if no entity is found.

See Also:

getTrigger(String), getTriggers()

getTrigger

public Trigger getTrigger(java.lang.String name)

Gets the Trigger with the specified name from the environment.

Parameters:

name - The name of the entity.

Returns:

The Trigger with the specified name or null if no entity is found.

See Also:

getTrigger(int), getTriggers()

getUsedTags

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

Gets all tags that are assigned to entities on this environment.

Returns:

All assigned tags of this environment.

getCenter

public java.awt.geom.Point2D getCenter()

init

public final void init()

isLoaded

public boolean isLoaded()

load

public void load()

loadFromMap

public void loadFromMap(int mapId)

load

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

interact

public Trigger interact(ICollisionEntity source)

Attempts to interact with triggers on this environment.

Parameters:

source - The entity that attempts to interacts with triggers.

Returns:

The trigger that the source entity was able to interact with or null.

interact

public Trigger interact(ICollisionEntity source,
                        java.util.function.Predicate<Trigger> condition)

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)

removeAll

public <T extends IEntity> void removeAll(java.lang.Iterable<T> entities)

removeAll

public void removeAll(IEntity... entities)

removeRenderable

public void removeRenderable(IRenderable renderable)

render

public void render(java.awt.Graphics2D g)

Description copied from interface: IRenderable

Renders the visual contents of this instance onto the provided graphics context.

If an Entity implements this interface, this method will be called right after the entity was rendered from the environment. Allowing for a custom rendering mechanism.

This interface can be implemented in general by anything that should be rendered to the game's screen.

Specified by:

render in interface IRenderable

Parameters:

g - The current graphics object onto which this instance will render its visual contents.

See Also:

RenderEngine.renderEntity(Graphics2D, de.gurkenlabs.litiengine.entities.IEntity)

getGravity

public int getGravity()

setGravity

public void setGravity(int gravity)

unload

public void unload()