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:

CombatArea, ForestGameArea, MazeGameArea

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 List<Entity>	areaEntities
protected TerrainComponent	terrain

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	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
abstract List<Entity>	getBosses()
abstract List<Entity>	getEnemies()
abstract List<Entity>	getFriendlyNPCs()
abstract List<Entity>	getMinigameNPCs()
abstract Entity	getPlayer()
abstract void	pauseMusic()
abstract void	playMusic()
void	spawnConvertedNPCs(Entity defeatedEnemy)
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.
void	spawnEntityAtVector(Entity entity, com.badlogic.gdx.math.Vector2 worldPos)	Spawns an entity at a specified world position.
protected void	spawnEntityCenteredAt(Entity entity, com.badlogic.gdx.math.Vector2 worldPos)	Spawns an entity centered at a specified world position.
abstract void	unloadAssets()
void	unlockArea(String area)

Methods inherited from class java.lang.Object

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

Field Details

terrain

protected TerrainComponent terrain

areaEntities

protected List<Entity> areaEntities

Constructor Details

GameArea

protected 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

spawnEntity

protected void spawnEntity(Entity entity)

Spawn entity at its current position

Parameters:

entity - Entity (not yet registered)

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

getPlayer

public abstract Entity getPlayer()

getEnemies

public abstract List<Entity> getEnemies()

getBosses

public abstract List<Entity> getBosses()

getFriendlyNPCs

public abstract List<Entity> getFriendlyNPCs()

getMinigameNPCs

public abstract List<Entity> getMinigameNPCs()

unloadAssets

public abstract void unloadAssets()

pauseMusic

public abstract void pauseMusic()

playMusic

public abstract void playMusic()

unlockArea

public void unlockArea(String area)

spawnEntityAtVector

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

Spawns an entity at a specified world position.

This method sets the position of the given entity to the specified coordinates in the world and then registers the entity into the game world. The entity should not be registered prior to calling this method.

Parameters:

entity - The entity to be spawned (not yet registered).

worldPos - The world position where the entity should be placed.

spawnConvertedNPCs

public void spawnConvertedNPCs(Entity defeatedEnemy)

spawnEntityCenteredAt

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

Spawns an entity centered at a specified world position.

This method sets the position of the given entity to the specified coordinates in the world and then registers the entity into the game world. The entity should not be registered prior to calling this method.

Parameters:

entity - Entity (not yet registered)

worldPos - The world position where the entity should be placed.