Package me.arcademadness.omni_dungeon.environment

Interface EnvironmentView

All Known Subinterfaces:

EnvironmentControl

All Known Implementing Classes:

Environment

public interface EnvironmentView

Provides a read-only view of the game environment.

EnvironmentView exposes the current state of the environment, including the map, entities, and services such as collision and movement handling. It also provides methods to spawn or despawn entities at specific locations.

For full control of the environment (updating state or adding/removing entities), see EnvironmentControl.

Method Summary

Modifier and Type	Method	Description
void	despawn(Entity entity)	Despawns an entity from the environment.
CollisionService	getCollisionService()	Returns the collision service responsible for handling entity collisions.
List<Entity>	getEntities()	Returns a list of entities currently present in the environment.
EventBus	getEventBus()	Returns the event bus used for broadcasting and listening to game events.
TileMap	getMap()	Returns the tile map representing the environment's layout.
MovementService	getMovementService()	Returns the movement service responsible for moving entities in the environment.
void	spawn(Entity entity, Location location)	Spawns an entity at the specified location in the environment.

Method Details

getMap

TileMap getMap()

Returns the tile map representing the environment's layout.

Returns:

the TileMap of the environment

See Also:

• EnvironmentControl

getEntities

List<Entity> getEntities()

Returns a list of entities currently present in the environment.

Returns:

a List of Entity objects

See Also:

• EnvironmentControl.addEntity(Entity)
• EnvironmentControl.removeEntity(Entity)

getCollisionService

CollisionService getCollisionService()

Returns the collision service responsible for handling entity collisions.

Returns:

the CollisionService for the environment

getMovementService

MovementService getMovementService()

Returns the movement service responsible for moving entities in the environment.

Returns:

the MovementService for the environment

getEventBus

EventBus getEventBus()

Returns the event bus used for broadcasting and listening to game events.

Returns:

the EventBus of the environment

spawn

void spawn(Entity entity,
 Location location)

Spawns an entity at the specified location in the environment.

After spawning, the entity will appear in getEntities().

Parameters:

entity - the Entity to spawn

location - the Location at which to spawn the entity

See Also:

• EnvironmentControl.addEntity(Entity)

despawn

void despawn(Entity entity)

Despawns an entity from the environment.

After despawning, the entity will no longer appear in getEntities().

Parameters:

entity - the Entity to remove

See Also:

• EnvironmentControl.removeEntity(Entity)