de.adom.jade.world
Class World

java.lang.Object
  extended by de.adom.jade.kernel.GUIDCarrier
      extended by de.adom.jade.world.Location
          extended by de.adom.jade.world.World
All Implemented Interfaces:
java.io.Serializable

public class World
extends Location

Implements a world meta structure.

See Also:
Serialized Form

Constructor Summary
World(java.lang.String unknownName, java.lang.String unknownDescription, java.lang.String knownName, java.lang.String knownDescription)
          Creates a new world.
 
Method Summary
protected  Map createMap()
          Creates a new map for this specific location.
 boolean isDungeon()
          Determines whether the current location is a dungeon.
 boolean isSettlement()
          Determines whether the current location is a settlement.
 boolean isSurfaceWorld()
          Determines whether the current location is the surface world area.
 boolean isWilderness()
          Determines whether the current location is a wilderness area.
 
Methods inherited from class de.adom.jade.world.Location
addConnection, getActorQueue, getComplex, getComplexID, getConnectionAt, getConnectionByID, getConnectionPositions, getConnections, getDescription, getLevel, getLogicalName, getMap, getName, getTickCounter, isKnown, setComplex, setKnown, setMap, updateTicks
 
Methods inherited from class de.adom.jade.kernel.GUIDCarrier
getGUID
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

World

public World(java.lang.String unknownName,
             java.lang.String unknownDescription,
             java.lang.String knownName,
             java.lang.String knownDescription)
Creates a new world. The creation of the actual map is deferred until the player enters the dungeon for the first time.

Parameters:
unknownName - the name of the world in its unknown state
unknownDescription - the description of the world in its unknown state
knownName - the name of the world in its known state
knownDescription - the description of the world in its known state
map - the map of the world
Method Detail

isDungeon

public boolean isDungeon()
Description copied from class: Location
Determines whether the current location is a dungeon.

Specified by:
isDungeon in class Location
Returns:
a flag indicating whether the location is a dungeon
See Also:
Location.isDungeon()

isSettlement

public boolean isSettlement()
Description copied from class: Location
Determines whether the current location is a settlement.

Specified by:
isSettlement in class Location
Returns:
a flag indicating whether the location is a settlement
See Also:
Location.isSettlement()

isWilderness

public boolean isWilderness()
Description copied from class: Location
Determines whether the current location is a wilderness area.

Specified by:
isWilderness in class Location
Returns:
a flag indicating whether the location is a wilderness area
See Also:
Location.isWilderness()

isSurfaceWorld

public boolean isSurfaceWorld()
Description copied from class: Location
Determines whether the current location is the surface world area.

Specified by:
isSurfaceWorld in class Location
Returns:
a flag indicating whether the location is the surface world area
See Also:
Location.isSurfaceWorld()

createMap

protected Map createMap()
Description copied from class: Location
Creates a new map for this specific location.

Specified by:
createMap in class Location
Returns:
the newly created map for this location TODO: Make this method abstract so that derived classes can overload it.
See Also:
Location.createMap()