de.adom.jade.world
Class Settlement

java.lang.Object
  extended by de.adom.jade.kernel.GUIDCarrier
      extended by de.adom.jade.world.Location
          extended by de.adom.jade.world.Settlement
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
HumanVillage

public abstract class Settlement
extends Location

Marks a (more or less) civilized settlement.

See Also:
Serialized Form

Constructor Summary
Settlement(java.lang.String unknownName, java.lang.String unknownDescription, java.lang.String knownName, java.lang.String knownDescription)
          Creates a new settlement.
 
Method Summary
 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, createMap, 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

Settlement

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

Parameters:
complexID - the ID of this complex
unknownName - the name of the settlement in its unknown state
unknownDescription - the description of the settlement in its unknown state
knownName - the name of the settlement in its known state
knownDescription - the description of the settlement in its known state
Method Detail

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()

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()

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()