pl.isangeles.senlin.data.area

Class Area

java.lang.Object

pl.isangeles.senlin.data.area.Area

All Implemented Interfaces:

ObjectiveTarget, SaveElement

public class Area
extends java.lang.Object
implements SaveElement, ObjectiveTarget

Class for game world areas

Author:

Isangeles

Constructor Summary

Constructors

Constructor and Description
Area(java.lang.String id, org.newdawn.slick.tiled.TiledMap map, java.lang.String mapFileName) Empty area constructor
Area(java.lang.String id, org.newdawn.slick.tiled.TiledMap map, java.lang.String mapFileName, java.util.Collection<Character> npcs, java.util.List<TargetableObject> objects, java.util.List<Exit> exits, java.util.Map<java.lang.String,java.lang.String> idleMusic, java.util.Map<java.lang.String,java.lang.String> combatMusic) Area constructor

Method Summary

Modifier and Type	Method and Description
void	addMusic(AudioPlayer player) Adds all music tracks for this scenario to specified audio player
java.util.Collection<Character>	getCharacters() Returns all characters in area
java.util.Collection<Character>	getCharactersExcept(Character exceptChar) Returns all characters except specified character
java.util.Collection<Character>	getCharactersExcept(java.lang.String exceptCharSerialId) Returns all characters except specified character
java.util.List<Exit>	getExits() Returns area exits
java.lang.String	getId() Returns area ID
org.newdawn.slick.tiled.TiledMap	getMap() Returns area map
java.lang.String	getMapName() Returns map file name
Size	getMapSize() Returns area map size
java.util.List<Character>	getNearbyCharacters(Character character) Returns all nearby characters in area
java.util.Collection<Character>	getNpcs() Returns all characters without players in NEW collection
java.util.List<TargetableObject>	getObjects() Returns area objects
org.w3c.dom.Element	getSave(org.w3c.dom.Document doc) Parses object to XML document element
boolean	hasMusic() Checks if this area has any music tracks
boolean	isMovable(int x, int y) Checks if specified xy positions are 'moveable' on game world map
void	setCharacters(java.util.Collection<Character> characters) Sets specified list as this area NPCs list
void	setObjects(java.util.List<TargetableObject> objects) Sets specified list as this area objects list

Methods inherited from class java.lang.Object

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

Constructor Detail

Area

public Area(java.lang.String id,
            org.newdawn.slick.tiled.TiledMap map,
            java.lang.String mapFileName)

Empty area constructor

Parameters:

id - Area ID

map - Area map

mapFileName - Name of area map file

Area

public Area(java.lang.String id,
            org.newdawn.slick.tiled.TiledMap map,
            java.lang.String mapFileName,
            java.util.Collection<Character> npcs,
            java.util.List<TargetableObject> objects,
            java.util.List<Exit> exits,
            java.util.Map<java.lang.String,java.lang.String> idleMusic,
            java.util.Map<java.lang.String,java.lang.String> combatMusic)

Area constructor

Parameters:

npcs - List with NPCs

objects - List with objects

exits - List exits

Method Detail

getId

public java.lang.String getId()

Returns area ID

Specified by:

getId in interface ObjectiveTarget

Returns:

String with area ID

getMap

public org.newdawn.slick.tiled.TiledMap getMap()

Returns area map

Returns:

Tiled map of this area

getMapName

public java.lang.String getMapName()

Returns map file name

Returns:

String with map file name

getMapSize

public Size getMapSize()

Returns area map size

Returns:

Tuple with width and height of this area map

getNpcs

public java.util.Collection<Character> getNpcs()

Returns all characters without players in NEW collection

Returns:

Collection with game characters

getCharacters

public java.util.Collection<Character> getCharacters()

Returns all characters in area

Returns:

Collection with game characters

getCharactersExcept

public java.util.Collection<Character> getCharactersExcept(Character exceptChar)

Returns all characters except specified character

Parameters:

exceptChar - Character to retain from area characters

Returns:

Collection with all area characters except specified character

getCharactersExcept

public java.util.Collection<Character> getCharactersExcept(java.lang.String exceptCharSerialId)

Returns all characters except specified character

Parameters:

exceptChar - Character to retain from area characters

Returns:

Collection with all area characters except specified character

getObjects

public java.util.List<TargetableObject> getObjects()

Returns area objects

Returns:

List with simple game objects

getExits

public java.util.List<Exit> getExits()

Returns area exits

Returns:

List with exits

getNearbyCharacters

public java.util.List<Character> getNearbyCharacters(Character character)

Returns all nearby characters in area

Parameters:

character - A character around which to look for other nearby characters

Returns:

List with all nearby characters

hasMusic

public boolean hasMusic()

Checks if this area has any music tracks

Returns:

True if this area has its own music, false otherwise

setCharacters

public void setCharacters(java.util.Collection<Character> characters)

Sets specified list as this area NPCs list

Parameters:

charcters - List with game characters for this area

setObjects

public void setObjects(java.util.List<TargetableObject> objects)

Sets specified list as this area objects list

Parameters:

objects - List with simple game objects for this area

addMusic

public void addMusic(AudioPlayer player)

Adds all music tracks for this scenario to specified audio player

Parameters:

player - Audio player

Throws:

java.io.IOException

org.newdawn.slick.SlickException

isMovable

public boolean isMovable(int x,
                         int y)

Checks if specified xy positions are 'moveable' on game world map

Parameters:

x - Position on x axis

y - Position on y axis

Returns:

True if position are moveable, false otherwise

getSave

public org.w3c.dom.Element getSave(org.w3c.dom.Document doc)

Description copied from interface: SaveElement

Parses object to XML document element

Specified by:

getSave in interface SaveElement

Parameters:

doc - XML document for save game

Returns:

XML document element