com.planet_ink.coffee_mud.Libraries
Class CMMap

java.lang.Object
  extended by com.planet_ink.coffee_mud.Libraries.StdLibrary
      extended by com.planet_ink.coffee_mud.Libraries.CMMap
All Implemented Interfaces:
CMObject, CMLibrary, WorldMap, java.lang.Cloneable, java.lang.Comparable<CMObject>, java.lang.Runnable

public class CMMap
extends StdLibrary
implements WorldMap


Nested Class Summary
static class CMMap.AreaEnumerator
           
 
Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.WorldMap
WorldMap.CompleteRoomIDEnumerator, WorldMap.CrossExit
 
Field Summary
 java.util.Vector areasList
           
 java.util.Vector auctionHouseList
           
 java.util.Vector bankList
           
 java.util.Vector deitiesList
           
 java.util.Hashtable globalHandlers
           
 long lastVReset
           
 java.util.Vector postOfficeList
           
 int QUADRANT_WIDTH
           
 CMMsg resetMsg
           
 java.util.Vector sortedAreas
           
 java.util.Vector space
           
 
Fields inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.WorldMap
ROOM_EXPIRATION_MILLIS
 
Constructor Summary
CMMap()
           
 
Method Summary
 boolean activate()
           
 void addArea(Area newOne)
           
 void addAuctionHouse(Auctioneer newOne)
           
 void addBank(Banker newOne)
           
 void addDeity(Deity newOne)
           
 void addGlobalHandler(Environmental E, int category)
           
 void addObjectToSpace(SpaceObject O)
           
 void addPostOffice(PostOffice newOne)
           
 Area areaLocation(java.lang.Object E)
           
 java.util.Enumeration areas()
           
 java.util.Enumeration auctionHouses()
           
 java.util.Iterator bankChains(Area AreaOrNull)
           
 java.util.Enumeration banks()
           
 java.lang.String createNewExit(Room from, Room room, int direction)
           
 java.util.Enumeration deities()
           
 void delArea(Area oneToDel)
           
 void delAuctionHouse(Auctioneer oneToDel)
           
 void delBank(Banker oneToDel)
           
 void delDeity(Deity oneToDel)
           
 void delGlobalHandler(Environmental E, int category)
           
 void delObjectInSpace(SpaceObject O)
           
 void delPostOffice(PostOffice oneToDel)
           
 void emptyRoom(Room room, Room bringBackHere)
           
 boolean explored(Room R, java.util.Vector areas)
           
 Area findArea(java.lang.String calledThis)
           
 Area findAreaStartsWith(java.lang.String calledThis)
           
 Room findConnectingRoom(Room room)
           
 Area getArea(java.lang.String calledThis)
           
 Auctioneer getAuctionHouse(java.lang.String chain, java.lang.String areaNameOrBranch)
           
 Banker getBank(java.lang.String chain, java.lang.String areaNameOrBranch)
           
 Deity getDeity(java.lang.String calledThis)
           
 double[] getDirection(SpaceObject FROM, SpaceObject TO)
           
 long getDistanceFrom(SpaceObject O1, SpaceObject O2)
           
 java.lang.String getExtendedRoomID(Room R)
           
 Area getFirstArea()
           
protected  int getGlobalIndex(java.util.Vector list, java.lang.String name)
           
 PostOffice getPostOffice(java.lang.String chain, java.lang.String areaNameOrBranch)
           
 Area getRandomArea()
           
 Room getRandomRoom()
           
 long getRelativeVelocity(SpaceObject O1, SpaceObject O2)
           
 Room getRoom(java.util.Hashtable hashedRoomSet, java.lang.String areaName, java.lang.String calledThis)
           
 Room getRoom(Room room)
           
 Room getRoom(java.lang.String calledThis)
           
 Room getRoom(java.util.Vector roomSet, java.lang.String calledThis)
           
 int getRoomDir(Room from, Room to)
           
 Area getStartArea(Environmental E)
           
 Room getStartRoom(Environmental E)
           
 ThreadEngine.SupportThread getSupportThread()
           
 MOB god(Room R)
           
 boolean hasASky(Room room)
           
 java.lang.String ID()
          The CoffeeMud Java Class ID shared by all instances of this object.
 boolean isClearableRoom(Room R)
           
 boolean isObjectInSpace(SpaceObject O)
           
 void moveSpaceObject(SpaceObject O)
           
 int numAreas()
           
 int numAuctionHouses()
           
 int numBanks()
           
 int numDeities()
           
 int numPostOffices()
           
 int numRooms()
           
 void obliterateArea(java.lang.String areaName)
           
 void obliterateRoom(Room deadRoom)
           
 java.util.Enumeration postOffices()
           
 void renameRooms(Area A, java.lang.String oldName, java.util.Vector allMyDamnRooms)
           
 void resetArea(Area area)
           
 void resetRoom(Room room)
           
 java.util.Enumeration roomIDs()
           
 Room roomLocation(Environmental E)
           
 java.util.Enumeration rooms()
           
 java.util.Enumeration roomsFilled()
           
 void run()
           
 boolean sendGlobalMessage(MOB host, int category, CMMsg msg)
           
 boolean shutdown()
           
 java.util.Enumeration sortedAreas()
           
 
Methods inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary
compareTo, copyOf, initializeClass, newInstance
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject
copyOf, initializeClass, newInstance
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Field Detail

areasList

public java.util.Vector areasList

deitiesList

public java.util.Vector deitiesList

postOfficeList

public java.util.Vector postOfficeList

auctionHouseList

public java.util.Vector auctionHouseList

bankList

public java.util.Vector bankList

QUADRANT_WIDTH

public final int QUADRANT_WIDTH
See Also:
Constant Field Values

space

public java.util.Vector space

globalHandlers

public java.util.Hashtable globalHandlers

sortedAreas

public java.util.Vector sortedAreas

lastVReset

public long lastVReset

resetMsg

public CMMsg resetMsg
Constructor Detail

CMMap

public CMMap()
Method Detail

ID

public java.lang.String ID()
Description copied from interface: CMObject
The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, MiscTech. The name is typically identical to the class name.

Specified by:
ID in interface CMObject
Overrides:
ID in class StdLibrary
Returns:
the name of this class

getSupportThread

public ThreadEngine.SupportThread getSupportThread()
Specified by:
getSupportThread in interface CMLibrary
Overrides:
getSupportThread in class StdLibrary

getGlobalIndex

protected int getGlobalIndex(java.util.Vector list,
                             java.lang.String name)

numAreas

public int numAreas()
Specified by:
numAreas in interface WorldMap

addArea

public void addArea(Area newOne)
Specified by:
addArea in interface WorldMap

delArea

public void delArea(Area oneToDel)
Specified by:
delArea in interface WorldMap

sortedAreas

public java.util.Enumeration sortedAreas()
Specified by:
sortedAreas in interface WorldMap

getArea

public Area getArea(java.lang.String calledThis)
Specified by:
getArea in interface WorldMap

findAreaStartsWith

public Area findAreaStartsWith(java.lang.String calledThis)
Specified by:
findAreaStartsWith in interface WorldMap

findArea

public Area findArea(java.lang.String calledThis)
Specified by:
findArea in interface WorldMap

areas

public java.util.Enumeration areas()
Specified by:
areas in interface WorldMap

roomIDs

public java.util.Enumeration roomIDs()
Specified by:
roomIDs in interface WorldMap

getFirstArea

public Area getFirstArea()
Specified by:
getFirstArea in interface WorldMap

getRandomArea

public Area getRandomArea()
Specified by:
getRandomArea in interface WorldMap

addGlobalHandler

public void addGlobalHandler(Environmental E,
                             int category)
Specified by:
addGlobalHandler in interface WorldMap

delGlobalHandler

public void delGlobalHandler(Environmental E,
                             int category)
Specified by:
delGlobalHandler in interface WorldMap

god

public MOB god(Room R)
Specified by:
god in interface WorldMap

isObjectInSpace

public boolean isObjectInSpace(SpaceObject O)
Specified by:
isObjectInSpace in interface WorldMap

delObjectInSpace

public void delObjectInSpace(SpaceObject O)
Specified by:
delObjectInSpace in interface WorldMap

addObjectToSpace

public void addObjectToSpace(SpaceObject O)
Specified by:
addObjectToSpace in interface WorldMap

getDistanceFrom

public long getDistanceFrom(SpaceObject O1,
                            SpaceObject O2)
Specified by:
getDistanceFrom in interface WorldMap

getDirection

public double[] getDirection(SpaceObject FROM,
                             SpaceObject TO)
Specified by:
getDirection in interface WorldMap

moveSpaceObject

public void moveSpaceObject(SpaceObject O)
Specified by:
moveSpaceObject in interface WorldMap

getRelativeVelocity

public long getRelativeVelocity(SpaceObject O1,
                                SpaceObject O2)
Specified by:
getRelativeVelocity in interface WorldMap

createNewExit

public java.lang.String createNewExit(Room from,
                                      Room room,
                                      int direction)
Specified by:
createNewExit in interface WorldMap

numRooms

public int numRooms()
Specified by:
numRooms in interface WorldMap

sendGlobalMessage

public boolean sendGlobalMessage(MOB host,
                                 int category,
                                 CMMsg msg)
Specified by:
sendGlobalMessage in interface WorldMap

getExtendedRoomID

public java.lang.String getExtendedRoomID(Room R)
Specified by:
getExtendedRoomID in interface WorldMap

getRoom

public Room getRoom(java.util.Vector roomSet,
                    java.lang.String calledThis)
Specified by:
getRoom in interface WorldMap

getRoom

public Room getRoom(java.util.Hashtable hashedRoomSet,
                    java.lang.String areaName,
                    java.lang.String calledThis)
Specified by:
getRoom in interface WorldMap

getRoom

public Room getRoom(Room room)
Specified by:
getRoom in interface WorldMap

getRoom

public Room getRoom(java.lang.String calledThis)
Specified by:
getRoom in interface WorldMap

rooms

public java.util.Enumeration rooms()
Specified by:
rooms in interface WorldMap

roomsFilled

public java.util.Enumeration roomsFilled()
Specified by:
roomsFilled in interface WorldMap

getRandomRoom

public Room getRandomRoom()
Specified by:
getRandomRoom in interface WorldMap

numDeities

public int numDeities()
Specified by:
numDeities in interface WorldMap

addDeity

public void addDeity(Deity newOne)
Specified by:
addDeity in interface WorldMap

delDeity

public void delDeity(Deity oneToDel)
Specified by:
delDeity in interface WorldMap

getDeity

public Deity getDeity(java.lang.String calledThis)
Specified by:
getDeity in interface WorldMap

deities

public java.util.Enumeration deities()
Specified by:
deities in interface WorldMap

numPostOffices

public int numPostOffices()
Specified by:
numPostOffices in interface WorldMap

addPostOffice

public void addPostOffice(PostOffice newOne)
Specified by:
addPostOffice in interface WorldMap

delPostOffice

public void delPostOffice(PostOffice oneToDel)
Specified by:
delPostOffice in interface WorldMap

getPostOffice

public PostOffice getPostOffice(java.lang.String chain,
                                java.lang.String areaNameOrBranch)
Specified by:
getPostOffice in interface WorldMap

postOffices

public java.util.Enumeration postOffices()
Specified by:
postOffices in interface WorldMap

auctionHouses

public java.util.Enumeration auctionHouses()
Specified by:
auctionHouses in interface WorldMap

numAuctionHouses

public int numAuctionHouses()
Specified by:
numAuctionHouses in interface WorldMap

addAuctionHouse

public void addAuctionHouse(Auctioneer newOne)
Specified by:
addAuctionHouse in interface WorldMap

delAuctionHouse

public void delAuctionHouse(Auctioneer oneToDel)
Specified by:
delAuctionHouse in interface WorldMap

getAuctionHouse

public Auctioneer getAuctionHouse(java.lang.String chain,
                                  java.lang.String areaNameOrBranch)
Specified by:
getAuctionHouse in interface WorldMap

numBanks

public int numBanks()
Specified by:
numBanks in interface WorldMap

addBank

public void addBank(Banker newOne)
Specified by:
addBank in interface WorldMap

delBank

public void delBank(Banker oneToDel)
Specified by:
delBank in interface WorldMap

getBank

public Banker getBank(java.lang.String chain,
                      java.lang.String areaNameOrBranch)
Specified by:
getBank in interface WorldMap

banks

public java.util.Enumeration banks()
Specified by:
banks in interface WorldMap

bankChains

public java.util.Iterator bankChains(Area AreaOrNull)
Specified by:
bankChains in interface WorldMap

renameRooms

public void renameRooms(Area A,
                        java.lang.String oldName,
                        java.util.Vector allMyDamnRooms)
Specified by:
renameRooms in interface WorldMap

getRoomDir

public int getRoomDir(Room from,
                      Room to)
Specified by:
getRoomDir in interface WorldMap

findConnectingRoom

public Room findConnectingRoom(Room room)
Specified by:
findConnectingRoom in interface WorldMap

isClearableRoom

public boolean isClearableRoom(Room R)
Specified by:
isClearableRoom in interface WorldMap

explored

public boolean explored(Room R,
                        java.util.Vector areas)
Specified by:
explored in interface WorldMap

obliterateRoom

public void obliterateRoom(Room deadRoom)
Specified by:
obliterateRoom in interface WorldMap

roomLocation

public Room roomLocation(Environmental E)
Specified by:
roomLocation in interface WorldMap

getStartArea

public Area getStartArea(Environmental E)
Specified by:
getStartArea in interface WorldMap

getStartRoom

public Room getStartRoom(Environmental E)
Specified by:
getStartRoom in interface WorldMap

areaLocation

public Area areaLocation(java.lang.Object E)
Specified by:
areaLocation in interface WorldMap

emptyRoom

public void emptyRoom(Room room,
                      Room bringBackHere)
Specified by:
emptyRoom in interface WorldMap

obliterateArea

public void obliterateArea(java.lang.String areaName)
Specified by:
obliterateArea in interface WorldMap

resetRoom

public void resetRoom(Room room)
Specified by:
resetRoom in interface WorldMap

resetArea

public void resetArea(Area area)
Specified by:
resetArea in interface WorldMap

hasASky

public boolean hasASky(Room room)
Specified by:
hasASky in interface WorldMap

activate

public boolean activate()
Specified by:
activate in interface CMLibrary
Overrides:
activate in class StdLibrary

shutdown

public boolean shutdown()
Specified by:
shutdown in interface CMLibrary
Overrides:
shutdown in class StdLibrary

run

public void run()
Specified by:
run in interface java.lang.Runnable