com.planet_ink.coffee_mud.Libraries.interfaces
Interface WorldMap

All Superinterfaces:
java.lang.Cloneable, CMLibrary, CMObject, java.lang.Comparable<CMObject>, java.lang.Runnable
All Known Implementing Classes:
CMMap

public interface WorldMap
extends CMLibrary, java.lang.Runnable


Nested Class Summary
static class WorldMap.CompleteRoomIDEnumerator
           
static class WorldMap.CrossExit
           
static class WorldMap.LocatedPair
           
static class WorldMap.MapCacheEntry
           
 
Field Summary
static long ROOM_EXPIRATION_MILLIS
           
 
Method Summary
 void addArea(Area newOne)
           
 void addGlobalHandler(MsgListener E, int category)
           
 void addObjectToSpace(SpaceObject O)
           
 Area areaLocation(CMObject E)
           
 java.util.Enumeration<Area> areas()
           
 java.util.Enumeration<Auctioneer> auctionHouses()
           
 java.util.Iterator<java.lang.String> bankChains(Area AreaOrNull)
           
 java.util.Enumeration<Banker> banks()
           
 java.lang.String createNewExit(Room from, Room room, int direction)
           
 java.util.Enumeration<Deity> deities()
           
 MOB deity()
           
 void delArea(Area oneToDel)
           
 void delGlobalHandler(MsgListener E, int category)
           
 void delObjectInSpace(SpaceObject O)
           
 void emptyArea(Area A)
           
 void emptyRoom(Room room, Room bringBackHere)
           
 boolean explored(Room R)
           
 Area findArea(java.lang.String calledThis)
           
 Room findAreaRoomLiberally(MOB mob, Area A, java.lang.String cmd, java.lang.String srchWhatAERIPMVK, int timePct)
           
 java.util.List<Room> findAreaRoomsLiberally(MOB mob, Area A, java.lang.String cmd, java.lang.String srchWhatAERIPMVK, int timePct)
           
 Area findAreaStartsWith(java.lang.String calledThis)
           
 Room findConnectingRoom(Room room)
           
 MOB findFirstInhabitant(java.util.Enumeration<Room> rooms, MOB mob, java.lang.String srchStr, int timePct)
           
 Item findFirstInventory(java.util.Enumeration<Room> rooms, MOB mob, java.lang.String srchStr, int timePct)
           
 Room findFirstRoom(java.util.Enumeration<Room> rooms, MOB mob, java.lang.String srchStr, boolean displayOnly, int timePct)
           
 Item findFirstRoomItem(java.util.Enumeration<Room> rooms, MOB mob, java.lang.String srchStr, boolean anyItems, int timePct)
           
 Environmental findFirstShopStock(java.util.Enumeration<Room> rooms, MOB mob, java.lang.String srchStr, int timePct)
           
 Environmental findFirstShopStocker(java.util.Enumeration<Room> rooms, MOB mob, java.lang.String srchStr, int timePct)
           
 java.util.List<MOB> findInhabitants(java.util.Enumeration<Room> rooms, MOB mob, java.lang.String srchStr, int timePct)
           
 java.util.List<Item> findInventory(java.util.Enumeration<Room> rooms, MOB mob, java.lang.String srchStr, int timePct)
           
 java.util.List<Item> findRoomItems(java.util.Enumeration<Room> rooms, MOB mob, java.lang.String srchStr, boolean anyItems, int timePct)
           
 java.util.List<Room> findRooms(java.util.Enumeration<Room> rooms, MOB mob, java.lang.String srchStr, boolean displayOnly, int timePct)
           
 java.util.List<Environmental> findShopStock(java.util.Enumeration<Room> rooms, MOB mob, java.lang.String srchStr, int timePct)
           
 java.util.List<Environmental> findShopStockers(java.util.Enumeration<Room> rooms, MOB mob, java.lang.String srchStr, int timePct)
           
 Room findWorldRoomLiberally(MOB mob, java.lang.String cmd, java.lang.String srchWhatAERIPMVK, int timePct, long maxMillis)
           
 java.util.List<Room> findWorldRoomsLiberally(MOB mob, java.lang.String cmd, java.lang.String srchWhatAERIPMVK, int timePct, long maxMillis)
           
 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)
           
 int getExitDir(Room from, Exit to)
           
 java.lang.String getExtendedRoomID(Room R)
           
 Area getFirstArea()
           
 PostOffice getPostOffice(java.lang.String chain, java.lang.String areaNameOrBranch)
           
 Area getRandomArea()
           
 Room getRandomRoom()
           
 long getRelativeVelocity(SpaceObject O1, SpaceObject O2)
           
 Room getRoom(java.util.Enumeration<Room> roomSet, java.lang.String calledThis)
           
 Room getRoom(java.util.Map<java.lang.String,Room> hashedRoomSet, java.lang.String areaName, java.lang.String calledThis)
           
 Room getRoom(Room room)
           
 Room getRoom(java.lang.String calledThis)
           
 int getRoomDir(Room from, Room to)
           
 Area getStartArea(Environmental E)
           
 Room getStartRoom(Environmental E)
           
 boolean hasASky(Room room)
           
 boolean isClearableRoom(Room room)
           
 boolean isObjectInSpace(SpaceObject O)
           
 MOB mobCreated()
           
 MOB mobCreated(Room R)
           
 void moveSpaceObject(SpaceObject O)
           
 int numAreas()
           
 int numRooms()
           
 void obliterateArea(java.lang.String areaName)
           
 void obliterateRoom(Room deadRoom)
           
 java.util.Enumeration<PostOffice> postOffices()
           
 void registerWorldObjectDestroyed(Area area, Room room, CMObject o)
           
 void registerWorldObjectLoaded(Area area, Room room, CMObject o)
           
 void renameRooms(Area A, java.lang.String oldName, java.util.List<Room> allMyDamnRooms)
           
 void resetArea(Area area)
           
 void resetRoom(Room room)
           
 void resetRoom(Room room, boolean rebuildGrids)
           
 java.util.Enumeration<java.lang.String> roomIDs()
           
 Room roomLocation(Environmental E)
           
 java.util.Enumeration<Room> rooms()
           
 java.util.Enumeration<Room> roomsFilled()
           
 java.util.Enumeration<WorldMap.LocatedPair> scriptHosts(Area area)
           
 boolean sendGlobalMessage(MOB host, int category, CMMsg msg)
           
 java.util.Enumeration<Area> sortedAreas()
           
 
Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary
activate, getSupportThread, propertiesLoaded, shutdown
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject
copyOf, ID, initializeClass, newInstance
 
Methods inherited from interface java.lang.Comparable
compareTo
 
Methods inherited from interface java.lang.Runnable
run
 

Field Detail

ROOM_EXPIRATION_MILLIS

static final long ROOM_EXPIRATION_MILLIS
See Also:
Constant Field Values
Method Detail

numAreas

int numAreas()

addArea

void addArea(Area newOne)

delArea

void delArea(Area oneToDel)

getArea

Area getArea(java.lang.String calledThis)

findAreaStartsWith

Area findAreaStartsWith(java.lang.String calledThis)

findArea

Area findArea(java.lang.String calledThis)

areas

java.util.Enumeration<Area> areas()

sortedAreas

java.util.Enumeration<Area> sortedAreas()

getFirstArea

Area getFirstArea()

getRandomArea

Area getRandomArea()

obliterateArea

void obliterateArea(java.lang.String areaName)

numRooms

int numRooms()

roomIDs

java.util.Enumeration<java.lang.String> roomIDs()

getExtendedRoomID

java.lang.String getExtendedRoomID(Room R)

getRoom

Room getRoom(Room room)

getRoom

Room getRoom(java.lang.String calledThis)

getRoom

Room getRoom(java.util.Enumeration<Room> roomSet,
             java.lang.String calledThis)

getRoom

Room getRoom(java.util.Map<java.lang.String,Room> hashedRoomSet,
             java.lang.String areaName,
             java.lang.String calledThis)

rooms

java.util.Enumeration<Room> rooms()

roomsFilled

java.util.Enumeration<Room> roomsFilled()

getRandomRoom

Room getRandomRoom()

renameRooms

void renameRooms(Area A,
                 java.lang.String oldName,
                 java.util.List<Room> allMyDamnRooms)

obliterateRoom

void obliterateRoom(Room deadRoom)

findConnectingRoom

Room findConnectingRoom(Room room)

getRoomDir

int getRoomDir(Room from,
               Room to)

getExitDir

int getExitDir(Room from,
               Exit to)

findWorldRoomsLiberally

java.util.List<Room> findWorldRoomsLiberally(MOB mob,
                                             java.lang.String cmd,
                                             java.lang.String srchWhatAERIPMVK,
                                             int timePct,
                                             long maxMillis)

findWorldRoomLiberally

Room findWorldRoomLiberally(MOB mob,
                            java.lang.String cmd,
                            java.lang.String srchWhatAERIPMVK,
                            int timePct,
                            long maxMillis)

findAreaRoomsLiberally

java.util.List<Room> findAreaRoomsLiberally(MOB mob,
                                            Area A,
                                            java.lang.String cmd,
                                            java.lang.String srchWhatAERIPMVK,
                                            int timePct)

findAreaRoomLiberally

Room findAreaRoomLiberally(MOB mob,
                           Area A,
                           java.lang.String cmd,
                           java.lang.String srchWhatAERIPMVK,
                           int timePct)

findRooms

java.util.List<Room> findRooms(java.util.Enumeration<Room> rooms,
                               MOB mob,
                               java.lang.String srchStr,
                               boolean displayOnly,
                               int timePct)

findFirstRoom

Room findFirstRoom(java.util.Enumeration<Room> rooms,
                   MOB mob,
                   java.lang.String srchStr,
                   boolean displayOnly,
                   int timePct)

findFirstInhabitant

MOB findFirstInhabitant(java.util.Enumeration<Room> rooms,
                        MOB mob,
                        java.lang.String srchStr,
                        int timePct)

findInhabitants

java.util.List<MOB> findInhabitants(java.util.Enumeration<Room> rooms,
                                    MOB mob,
                                    java.lang.String srchStr,
                                    int timePct)

findRoomItems

java.util.List<Item> findRoomItems(java.util.Enumeration<Room> rooms,
                                   MOB mob,
                                   java.lang.String srchStr,
                                   boolean anyItems,
                                   int timePct)

findFirstRoomItem

Item findFirstRoomItem(java.util.Enumeration<Room> rooms,
                       MOB mob,
                       java.lang.String srchStr,
                       boolean anyItems,
                       int timePct)

findShopStock

java.util.List<Environmental> findShopStock(java.util.Enumeration<Room> rooms,
                                            MOB mob,
                                            java.lang.String srchStr,
                                            int timePct)

findFirstShopStock

Environmental findFirstShopStock(java.util.Enumeration<Room> rooms,
                                 MOB mob,
                                 java.lang.String srchStr,
                                 int timePct)

findShopStockers

java.util.List<Environmental> findShopStockers(java.util.Enumeration<Room> rooms,
                                               MOB mob,
                                               java.lang.String srchStr,
                                               int timePct)

findFirstShopStocker

Environmental findFirstShopStocker(java.util.Enumeration<Room> rooms,
                                   MOB mob,
                                   java.lang.String srchStr,
                                   int timePct)

findInventory

java.util.List<Item> findInventory(java.util.Enumeration<Room> rooms,
                                   MOB mob,
                                   java.lang.String srchStr,
                                   int timePct)

findFirstInventory

Item findFirstInventory(java.util.Enumeration<Room> rooms,
                        MOB mob,
                        java.lang.String srchStr,
                        int timePct)

resetArea

void resetArea(Area area)

resetRoom

void resetRoom(Room room)

resetRoom

void resetRoom(Room room,
               boolean rebuildGrids)

getStartRoom

Room getStartRoom(Environmental E)

getStartArea

Area getStartArea(Environmental E)

roomLocation

Room roomLocation(Environmental E)

emptyRoom

void emptyRoom(Room room,
               Room bringBackHere)

emptyArea

void emptyArea(Area A)

hasASky

boolean hasASky(Room room)

isClearableRoom

boolean isClearableRoom(Room room)

createNewExit

java.lang.String createNewExit(Room from,
                               Room room,
                               int direction)

areaLocation

Area areaLocation(CMObject E)

explored

boolean explored(Room R)

registerWorldObjectLoaded

void registerWorldObjectLoaded(Area area,
                               Room room,
                               CMObject o)

registerWorldObjectDestroyed

void registerWorldObjectDestroyed(Area area,
                                  Room room,
                                  CMObject o)

scriptHosts

java.util.Enumeration<WorldMap.LocatedPair> scriptHosts(Area area)

getDeity

Deity getDeity(java.lang.String calledThis)

deities

java.util.Enumeration<Deity> deities()

getPostOffice

PostOffice getPostOffice(java.lang.String chain,
                         java.lang.String areaNameOrBranch)

postOffices

java.util.Enumeration<PostOffice> postOffices()

getBank

Banker getBank(java.lang.String chain,
               java.lang.String areaNameOrBranch)

banks

java.util.Enumeration<Banker> banks()

bankChains

java.util.Iterator<java.lang.String> bankChains(Area AreaOrNull)

getAuctionHouse

Auctioneer getAuctionHouse(java.lang.String chain,
                           java.lang.String areaNameOrBranch)

auctionHouses

java.util.Enumeration<Auctioneer> auctionHouses()

getRelativeVelocity

long getRelativeVelocity(SpaceObject O1,
                         SpaceObject O2)

isObjectInSpace

boolean isObjectInSpace(SpaceObject O)

delObjectInSpace

void delObjectInSpace(SpaceObject O)

addObjectToSpace

void addObjectToSpace(SpaceObject O)

getDistanceFrom

long getDistanceFrom(SpaceObject O1,
                     SpaceObject O2)

getDirection

double[] getDirection(SpaceObject FROM,
                      SpaceObject TO)

moveSpaceObject

void moveSpaceObject(SpaceObject O)

addGlobalHandler

void addGlobalHandler(MsgListener E,
                      int category)

delGlobalHandler

void delGlobalHandler(MsgListener E,
                      int category)

deity

MOB deity()

mobCreated

MOB mobCreated()

mobCreated

MOB mobCreated(Room R)

sendGlobalMessage

boolean sendGlobalMessage(MOB host,
                          int category,
                          CMMsg msg)