Class Environment

Method Details

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

  Adds the specified environment rendered listener to receive events when this instance renders the specified renderType.

  Parameters:

  renderType - The type that defines to which render process this listener should be attached.

  listener - The listener to add.

• removeListener

  public void removeListener​(EnvironmentRenderedListener listener)

  Removes the specified environment rendered listener.

  Parameters:

  listener - The listener to remove.

• addListener

  public void addListener​(EnvironmentListener listener)

  Adds the specified environment listener to receive events about the basic environment life-cycle.

  Parameters:

  listener - The listener to add.

• removeListener

  public void removeListener​(EnvironmentListener listener)

  Removes the environment listener.

  Parameters:

  listener - The listener to remove.

• addEntityListener

  public void addEntityListener​(EnvironmentEntityListener listener)

  Adds the specified environment entity listener to receive events about entities on this environment.

  Parameters:

  listener - The listener to add.

• removeEntityListener

  public void removeEntityListener​(EnvironmentEntityListener listener)

  Removes the environment entity listener listener.

  Parameters:

  listener - The listener to remove.

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

  Adds entities by the specified blueprint to this environment at the defined location.

  Parameters:

  blueprint - The blueprint, defining the map object to load the entities from.

  x - The x-coordinate of the location at which to spawn the entities.

  y - The y-coordinate of the location at which to spawn the entities.

  Returns:

  A collection with all added entities.

• build

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

  Adds entities by the specified blueprint to this environment at the defined location.

  Parameters:

  blueprint - The blueprint, defining the map object to load the entities from.

  location - The location at which to spawn the entities.

  Returns:

  A collection with all added entities.

• clear

  public void clear()

  Clears all loaded entities and renderable instances from this environment.

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

  Attempts to find all combat entities whose hitBox intersects with the specified shape.

  Parameters:

  shape - The shape to check intersection for.

  Returns:

  A collection of all combat entities that intersect the specified 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 collection of all combat entities that intersect the specified Shape.

• findEntities

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

  Attempts to find all entities whose bounding box intersects with the specified shape.

  Parameters:

  shape - The shape to check intersection for.

  Returns:

  A collection of all entities that intersect the specified Shape.

• get

  public IEntity get​(int mapId)

  Gets the entity with the specified map ID from this environment.

  Parameters:

  mapId - The map ID of the entity.

  Returns:

  The entity with the specified map ID or null if no entity could be found.

• get

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

  Gets all entities with the specified map IDs from this 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)

  Gets the strongly typed entity with the specified map ID from this environment.

  Type Parameters:

  T - The type of the entity.

  Parameters:

  clss - The class instance defining the type of the entity.

  mapId - The map ID of the entity.

  Returns:

  The strongly typed entity with the specified map ID or null if no entity could be found or if the defined type doesn't match.

• get

  public IEntity get​(java.lang.String name)

  Gets the entity with the specified name from this environment.

  Parameters:

  name - The name of the entity.

  Returns:

  The entity with the specified name or null if no entity could be found or if the defined type doesn't match.

• get

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

  Gets the strongly typed entity with the specified name from this environment.

  Type Parameters:

  T - The type of the entity.

  Parameters:

  clss - The class instance defining the type of the entity.

  name - The name of the entity.

  Returns:

  The strongly typed entity with the specified name or null if no entity could be found or if the defined type doesn't match.

• getByTag

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

  Gets a distinct collection of all entities with any of the specified tags.

  Parameters:

  tags - The tags to search for.

  Returns:

  All entities with any of the specified tags.

• getByTag

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

  Gets a distinct and strongly named collection of all entities with any of the specified tags.

  Type Parameters:

  T - The type of the entity.

  Parameters:

  clss - The class instance defining the type of the entity.

  tags - The tags to search for.

  Returns:

  All entities with any of the specified tags.

• getAmbientLight

  public AmbientLight getAmbientLight()

  Gets the ambient light instance of this environment.

  Returns:

  The ambient light instance of this environment.

  See Also:

  getStaticShadowLayer()

• getStaticShadowLayer

  public StaticShadowLayer getStaticShadowLayer()

  Gets the static shadow lighting layer of this environment.

  Returns:

  The static shadow lighting layer of this environment.

  See Also:

  getAmbientLight()

• getAllMapIDs

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

  Gets an immutable collection with all assigned map IDs on this 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 this environment.

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

  Returns:

  An immutable collection with all MapArea entities.

  See Also:

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

• getAreas

  public java.util.Collection<MapArea> getAreas​(java.lang.String tag)

  Gets an immutable collection containing all MapArea entities with the specified tag.

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

  Parameters:

  tag - The tag that the MapArea entities have to provide to be returned.

  Returns:

  An immutable collection with all MapArea entities with the specified tag.

  See Also:

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

• getArea

  public MapArea getArea​(int mapId)

  Gets the MapArea with the specified map ID from this 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 this 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 this environment.

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

  Returns:

  An immutable collection with all Emitter entities.

  See Also:

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

• getEmitters

  public java.util.Collection<Emitter> getEmitters​(java.lang.String tag)

  Gets an immutable collection containing all Emitter entities with the specified tag.

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

  Parameters:

  tag - The tag that the Emitter entities have to provide to be returned.

  Returns:

  An immutable collection with all Emitter entities with the specified tag.

  See Also:

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

• getEmitter

  public Emitter getEmitter​(int mapId)

  Gets the Emitter with the specified map ID from this 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 this 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 this environment.

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

  Returns:

  An immutable collection with all CollisionBox entities.

  See Also:

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

• getCollisionBoxes

  public java.util.Collection<CollisionBox> getCollisionBoxes​(java.lang.String tag)

  Gets an immutable collection containing all CollisionBox entities with the specified tag.

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

  Parameters:

  tag - The tag that the CollisionBox entities have to provide to be returned.

  Returns:

  An immutable collection with all CollisionBox entities with the specified tag.

  See Also:

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

• getCollisionBox

  public CollisionBox getCollisionBox​(int mapId)

  Gets the CollisionBox with the specified map ID from this 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 this 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 this environment.

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

  Returns:

  An immutable collection with all ICombatEntity entities.

  See Also:

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

• getCombatEntities

  public java.util.Collection<ICombatEntity> getCombatEntities​(java.lang.String tag)

  Gets an immutable collection containing all ICombatEntity entities with the specified tag.

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

  Parameters:

  tag - The tag that the ICombatEntity entities have to provide to be returned.

  Returns:

  An immutable collection with all ICombatEntity entities with the specified tag.

  See Also:

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

• getCombatEntity

  public ICombatEntity getCombatEntity​(int mapId)

  Gets the ICombatEntity with the specified map ID from this 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 this 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 this environment.

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

  Returns:

  An immutable collection with all entities.

  See Also:

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

• getEntities

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

  Gets all entities of the specified type on this environment.

  Type Parameters:

  T - The type of the entity.

  Parameters:

  cls - The class instance defining the type of the entity.

  Returns:

  All entities of the specified type.

• getEntities

  public <T> java.util.Collection<T> getEntities​(java.lang.Class<? extends T> cls, java.lang.String tag)

  Gets all entities of the specified type on this environment.

  Type Parameters:

  T - The type of the entity.

  Parameters:

  cls - The class instance defining the type of the entity.

  tag - A tag that decides whether the defined entity should be included in the result.

  Returns:

  All entities of the specified type.

• getEntities

  public <T> java.util.Collection<T> getEntities​(java.lang.Class<? extends T> cls, java.util.function.Predicate<T> pred)

  Gets all entities of the specified type on this environment.

  Type Parameters:

  T - The type of the entity.

  Parameters:

  cls - The class instance defining the type of the entity.

  pred - A predicate that decides whether the defined entity should be included in the result.

  Returns:

  All entities of the specified type.

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

  DON'T USE THIS! THIS IS FOR ENGINE INTERNAL PURPOSES ONLY!.

  Returns:

  A map with all entities by tags.

• getLightSources

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

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

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

  Returns:

  An immutable collection with all LightSource entities.

  See Also:

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

• getLightSources

  public java.util.Collection<LightSource> getLightSources​(java.lang.String tag)

  Gets an immutable collection containing all LightSource entities with the specified tag.

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

  Parameters:

  tag - The tag that the LightSource entities have to provide to be returned.

  Returns:

  An immutable collection with all LightSource entities with the specified tag.

  See Also:

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

• getLightSource

  public LightSource getLightSource​(int mapId)

  Gets the LightSource with the specified map ID from this 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 this 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 static 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()

  Gets the map on which this environment is based upon.

  Returns:

  The map of this environment.

• getMobileEntities

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

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

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

  Returns:

  An immutable collection with all IMobileEntity instances.

  See Also:

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

• getMobileEntities

  public java.util.Collection<IMobileEntity> getMobileEntities​(java.lang.String tag)

  Gets an immutable collection containing all IMobileEntity entities with the specified tag.

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

  Parameters:

  tag - The tag that the IMobileEntity entities have to provide to be returned.

  Returns:

  An immutable collection with all IMobileEntity entities with the specified tag.

  See Also:

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

• getMobileEntity

  public IMobileEntity getMobileEntity​(int mapId)

  Gets the IMobileEntity with the specified map ID from this 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 this 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 this environment.

  To add or remove instances, use the corresponding methods on this 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 this environment.

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

  Returns:

  An immutable collection with all Prop entities.

  See Also:

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

• getProps

  public java.util.Collection<Prop> getProps​(java.lang.String tag)

  Gets an immutable collection containing all Prop entities with the specified tag.

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

  Parameters:

  tag - The tag that the Prop entities have to provide to be returned.

  Returns:

  An immutable collection with all Prop entities with the specified tag.

  See Also:

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

• getProp

  public Prop getProp​(int mapId)

  Gets the Prop with the specified map ID from this 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 this 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 this environment.

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

  Returns:

  An immutable collection with all Creature entities.

  See Also:

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

• getCreatures

  public java.util.Collection<Creature> getCreatures​(java.lang.String tag)

  Gets an immutable collection containing all Creature entities with the specified tag.

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

  Parameters:

  tag - The tag that the Creature entities have to provide to be returned.

  Returns:

  An immutable collection with all Creature entities with the specified tag.

  See Also:

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

• getCreature

  public Creature getCreature​(int mapId)

  Gets the Creature with the specified map ID from this 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 this 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 this environment.

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

  Returns:

  An immutable collection with all Spawnpoint entities.

  See Also:

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

• getSpawnpoints

  public java.util.Collection<Spawnpoint> getSpawnpoints​(java.lang.String tag)

  Gets an immutable collection containing all Spawnpoint entities with the specified tag.

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

  Parameters:

  tag - The tag that the Spawnpoint entities have to provide to be returned.

  Returns:

  An immutable collection with all Spawnpoint entities with the specified tag.

  See Also:

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

• getSpawnpoint

  public Spawnpoint getSpawnpoint​(int mapId)

  Gets the Spawnpoint with the specified map ID from this 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 this 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()

• getSoundSources

  public java.util.Collection<SoundSource> getSoundSources()

  Gets an immutable collection containing all SoundSource entities on this environment.

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

  Returns:

  An immutable collection with all SoundSource entities.

  See Also:

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

• getSoundSources

  public java.util.Collection<SoundSource> getSoundSources​(java.lang.String tag)

  Gets an immutable collection containing all SoundSource entities with the specified tag.

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

  Parameters:

  tag - The tag that the SoundSource entities have to provide to be returned.

  Returns:

  An immutable collection with all SoundSource entities with the specified tag.

  See Also:

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

• getSoundSource

  public SoundSource getSoundSource​(int mapId)

  Gets the SoundSource with the specified map ID from this environment.

  Parameters:

  mapId - The map ID of the entity.

  Returns:

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

  See Also:

  getSpawnpoint(String), getSpawnpoints()

• getSoundSource

  public SoundSource getSoundSource​(java.lang.String name)

  Gets the SoundSource with the specified name from this environment.

  Parameters:

  name - The name of the entity.

  Returns:

  The SoundSource 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 this environment.

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

  Returns:

  An immutable collection with all StaticShadow entities.

  See Also:

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

• getStaticShadows

  public java.util.Collection<StaticShadow> getStaticShadows​(java.lang.String tag)

  Gets an immutable collection containing all StaticShadow entities with the specified tag.

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

  Parameters:

  tag - The tag that the StaticShadow entities have to provide to be returned.

  Returns:

  An immutable collection with all StaticShadow entities with the specified tag.

  See Also:

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

• getStaticShadow

  public StaticShadow getStaticShadow​(int mapId)

  Gets the StaticShadow with the specified map ID from this 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 this 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()

• getTriggers

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

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

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

  Returns:

  An immutable collection with all Trigger entities.

  See Also:

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

• getTriggers

  public java.util.Collection<Trigger> getTriggers​(java.lang.String tag)

  Gets an immutable collection containing all Trigger entities with the specified tag.

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

  Parameters:

  tag - The tag that the Trigger entities have to provide to be returned.

  Returns:

  An immutable collection with all Trigger entities with the specified tag.

  See Also:

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

• getTrigger

  public Trigger getTrigger​(int mapId)

  Gets the Trigger with the specified map ID from this 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 this 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()

  Gets the center location of the boundaries defined by the map of this environment.

  Returns:

  The center of this environment.

  See Also:

  getMap()

• init

  public final void init()

  Initializes all entities and lighting layers of this environment.

  See Also:

  EnvironmentListener.initialized(Environment)

• isLoaded

  public boolean isLoaded()

  Determines whether this environment has been loaded.

  Returns:

  True if this environment has been loaded; otherwise false.

  See Also:

  load(), unload()

• load

  public void load()

  Initializes and loads this environment and all its entities.

  See Also:

  init(), EnvironmentListener.loaded(Environment), isLoaded()

• loadFromMap

  public boolean loadFromMap​(int mapId)

  Loads the entities from the map object with the specified map ID from the map of this environment.

  Parameters:

  mapId - The map ID of the map object.

  Returns:

  True if any entity could be loaded; otherwise false.

• reloadFromMap

  public void reloadFromMap​(int mapId)

  Reloads the map object with the specified map ID from the map by first removing any previously loaded entity and then loading it freshly from its map definition.

  Parameters:

  mapId - The map ID of the map object.

  See Also:

  remove(int), loadFromMap(int)

• load

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

  Loads all entities for the specified map object.

  Parameters:

  mapObject - The mapObject to load the entities from.

  Returns:

  A collection of all loaded entities.

  See Also:

  IMapObjectLoader.load(Environment, IMapObject)

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

  Attempts to interact with triggers on this environment.

  Parameters:

  source - The entity that attempts to interacts with triggers.

  condition - The condition that determines whether a trigger can be interacted with.

  Returns:

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

  See Also:

  Trigger.canTrigger(ICollisionEntity)

• remove

  public void remove​(IEntity entity)

  Removes the specified entity from this environment and unloads is.

  Parameters:

  entity - The entity to be removed.

  See Also:

  remove(int), remove(String), removeAll(Iterable), unload(IEntity), EnvironmentEntityListener.entityRemoved(IEntity), IEntity.removed(Environment), EntityListener.removed(IEntity, Environment)

• remove

  public void remove​(int mapId)

  Removes the entity with the specified map ID from this environment and unloads is.

  Parameters:

  mapId - The map ID of the entity to be removed.

  See Also:

  remove(int), remove(String), removeAll(Iterable), unload(IEntity), EnvironmentEntityListener.entityRemoved(IEntity), IEntity.removed(Environment), EntityListener.removed(IEntity, Environment)

• remove

  public void remove​(java.lang.String name)

  Removes the entity with the specified name from this environment and unloads is.

  Parameters:

  name - The name of the entity to be removed.

  See Also:

  remove(int), remove(String), removeAll(Iterable), unload(IEntity), EnvironmentEntityListener.entityRemoved(IEntity), IEntity.removed(Environment), EntityListener.removed(IEntity, Environment)

• removeAll

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

  Removes all specified entities from this environment.

  Type Parameters:

  T - The type of the specified entities

  Parameters:

  entities - The entities to be removed.

  See Also:

  remove(int), remove(String)

• removeAll

  public void removeAll​(IEntity... entities)

  Removes all specified entities from this environment.

  Parameters:

  entities - The entities to be removed.

  See Also:

  remove(int), remove(String)

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

  Gets the gravity defined for this environment.

  Returns:

  The gravity of this environment.

  See Also:

  GameWorld.gravity(), GameWorld.setGravity(int), setGravity(int)

• setGravity

  public void setGravity​(int gravity)

  Sets the gravity for this particular environment.

  This typically only needs to be called explicitly, when the gravity is different than for other environments.

  Parameters:

  gravity - The new gravity for this environment. If 0, no gravity will be applied.

  See Also:

  GameWorld.gravity(), GameWorld.setGravity(int), getGravity()

• unload

  public void unload()

  Unloads all entities of this environment.

  See Also:

  unload(IEntity), EnvironmentListener.unloaded(Environment)

• isRendering

  public boolean isRendering()