Package com.csse3200.game.areas

Class GameArea

java.lang.Object

com.csse3200.game.areas.GameArea

All Implemented Interfaces:

com.badlogic.gdx.utils.Disposable

Direct Known Subclasses:

ExtractorMiniGameArea, MapGameArea, ShopArea, SpaceGameArea

public abstract class GameArea
extends Object
implements com.badlogic.gdx.utils.Disposable

Represents an area in the game, such as a level, indoor area, etc. An area has a terrain and other entities to spawn on that terrain.

Support for enabling/disabling game areas could be added by making this a Component instead.

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<com.badlogic.gdx.math.GridPoint2,Entity>	areaEntities
protected Entity	companion
protected EntityPlacementService	entityPlacementService
protected static Entity	player
protected StructurePlacementService	structurePlacementService
protected ArrayList<Entity>	targetables
protected static TerrainComponent	terrain

Constructor Summary

Constructors

Constructor	Description
GameArea()

Method Summary

Modifier and Type	Method	Description
abstract void	create()	Create the game area in the world.
void	dispose()	Dispose of all internal entities in the area
Map<com.badlogic.gdx.math.GridPoint2,Entity>	getAreaEntities()
Entity	getCompanion()
static Entity	getPlayer()
TerrainComponent	getTerrain()
protected void	placeEntityAt(Entity entity, com.badlogic.gdx.math.Vector2 position)	Function to listen for "placeEntityAt" trigger and repond by placing entitiy at specified position.
protected void	registerEntityPlacementService()	Function to register entity placement service using teh approripate listeners.
protected void	registerStructurePlacementService()
protected void	spawnEntity(Entity entity)	Spawn entity at its current position
protected void	spawnEntityAt(Entity entity, com.badlogic.gdx.math.GridPoint2 tilePos, boolean centerX, boolean centerY)	Spawn entity on a given tile.
protected void	spawnEntityAtVector(Entity entity, com.badlogic.gdx.math.Vector2 worldPos)
protected void	spawnExtractor(Entity entity)	Spawn a given extractor at its current position Includes handling the animation of the extractor
protected void	spawnPlayer(com.badlogic.gdx.math.GridPoint2 PLAYER_SPAWN)	Spawns the player entity and adds them to the list of targetable entities

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

terrain

protected static TerrainComponent terrain

areaEntities

protected Map<com.badlogic.gdx.math.GridPoint2,Entity> areaEntities

companion

protected Entity companion

player

protected static Entity player

entityPlacementService

protected EntityPlacementService entityPlacementService

structurePlacementService

protected StructurePlacementService structurePlacementService

targetables

protected ArrayList<Entity> targetables

Constructor Details

GameArea

public GameArea()

Method Details

create

public abstract void create()

Create the game area in the world.

dispose

public void dispose()

Dispose of all internal entities in the area

Specified by:

dispose in interface com.badlogic.gdx.utils.Disposable

getTerrain

public TerrainComponent getTerrain()

getAreaEntities

public Map<com.badlogic.gdx.math.GridPoint2,Entity> getAreaEntities()

registerStructurePlacementService

protected void registerStructurePlacementService()

spawnExtractor

protected void spawnExtractor(Entity entity)

Spawn a given extractor at its current position Includes handling the animation of the extractor

Parameters:

entity - Entity (not yet registered) representing the extractor

registerEntityPlacementService

protected void registerEntityPlacementService()

Function to register entity placement service using teh approripate listeners. This allows entities to be placed after initilisation.

placeEntityAt

protected void placeEntityAt(Entity entity,
 com.badlogic.gdx.math.Vector2 position)

Function to listen for "placeEntityAt" trigger and repond by placing entitiy at specified position.

Parameters:

entity - - Entity to be placed

position - - position for where entity should be placed

spawnEntity

protected void spawnEntity(Entity entity)

Spawn entity at its current position

Parameters:

entity - Entity (not yet registered)

spawnPlayer

protected void spawnPlayer(com.badlogic.gdx.math.GridPoint2 PLAYER_SPAWN)

Spawns the player entity and adds them to the list of targetable entities

spawnEntityAt

protected void spawnEntityAt(Entity entity,
 com.badlogic.gdx.math.GridPoint2 tilePos,
 boolean centerX,
 boolean centerY)

Spawn entity on a given tile. Requires the terrain to be set first.

Parameters:

entity - Entity (not yet registered)

tilePos - tile position to spawn at

centerX - true to center entity X on the tile, false to align the bottom left corner

centerY - true to center entity Y on the tile, false to align the bottom left corner

spawnEntityAtVector

protected void spawnEntityAtVector(Entity entity,
 com.badlogic.gdx.math.Vector2 worldPos)

getCompanion

public Entity getCompanion()

getPlayer

public static Entity getPlayer()