Package net.egartley.beyondorigins.core.abstracts

Class Map

java.lang.Object

net.egartley.beyondorigins.core.abstracts.Map

All Implemented Interfaces:

Tickable

Direct Known Subclasses:

DebugMap, TestBattleMap

public abstract class Map
extends java.lang.Object
implements Tickable

Collection of "sectors" that make up a map, which is like a level or world

Field Summary

Fields

Modifier and Type	Field	Description
java.lang.String	id	Identifier for the map
MapSector	sector	The current sector
java.util.ArrayList<MapSector>	sectors	Collection of the map's sectors

Constructor Summary

Constructors

Constructor	Description
Map(java.lang.String id)	Creates a new map

Method Summary

Modifier and Type	Method	Description
void	changeSector(MapSector to, MapSector from)	Moves from one sector to another
abstract void	onPlayerEnter()	Called when the player enters the map
abstract void	onPlayerLeave()	Called when the player leaves the map
abstract void	onSectorChange(MapSectorChangeEvent event)	Called when the current sector changes
abstract void	render(org.newdawn.slick.Graphics graphics)	Renders the map's contents
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.egartley.beyondorigins.core.interfaces.Tickable

tick

Field Detail

id

public java.lang.String id

Identifier for the map

sectors

public java.util.ArrayList<MapSector> sectors

Collection of the map's sectors

sector

public MapSector sector

The current sector

Constructor Detail

Map

public Map(java.lang.String id)

Creates a new map

Parameters:

id - Name or identifier for the map

Method Detail

render

public abstract void render(org.newdawn.slick.Graphics graphics)

Renders the map's contents

Parameters:

graphics - The graphics to use

onPlayerEnter

public abstract void onPlayerEnter()

Called when the player enters the map

onPlayerLeave

public abstract void onPlayerLeave()

Called when the player leaves the map

onSectorChange

public abstract void onSectorChange(MapSectorChangeEvent event)

Called when the current sector changes

See Also:

changeSector(MapSector, MapSector)

changeSector

public void changeSector(MapSector to,
                         MapSector from)

Moves from one sector to another

Parameters:

to - Where the player is going

from - Where the player is coming from (null if initially entering the map)

See Also:

onSectorChange(MapSectorChangeEvent), MapSector.onPlayerEnter(MapSector), MapSector.onPlayerLeave(MapSector)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object