WorldMap

All Superinterfaces:

java.lang.Cloneable, CMLibrary, CMObject, java.lang.Comparable<CMObject>

All Known Implementing Classes:

CMMap
```
public interface WorldMap
extends CMLibrary
```
The main container for all of the worlds areas and rooms, along with cross-references and various indexed objects associated with it.

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static interface`	`WorldMap.LocatedPair`	Helper class for world searches, as it returns both the thing Found, as well as the room in which it was found.

Field Summary

Fields
Modifier and Type Field Description

static long ROOM_EXPIRATION_MILLIS
The number of milliseconds before a thin room expires.
- Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject
  idConverter

Fields
Modifier and Type	Field	Description
`static long`	`ROOM_EXPIRATION_MILLIS`	The number of milliseconds before a thin room expires.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`addArea(Area newOne)`	Adds the given area to the world map list.
`void`	`addGlobalHandler(MsgListener E, int category)`	Add a listener to the Global Alternative message passing system.
`Area`	`areaLocation(CMObject E)`	Returns the Area in which the given object exists in, or is attached to.
`java.util.Enumeration<Area>`	`areas()`	Returns an enumeration of all world map areas.
`java.util.Enumeration<Area>`	`areasPlusShips()`	Returns an enumeration of all map areas, including all areas inside ships, caravans, etc.
`java.lang.String`	`createNewExit(Room from, Room room, int direction)`	Attempts to create a pair of Open exits from the from room to the room room.
`java.util.Enumeration<Deity>`	`deities()`	Returns an enumeration of all the Deity-derived registered objects in the game.
`MOB`	`deity()`	Returns the first available deity, creating one from scratch if necessary.
`void`	`delArea(Area oneToDel)`	Deletes the given area from the world map list.
`void`	`delGlobalHandler(MsgListener E, int category)`	Remove a listener from the Global Alternative message passing system.
`void`	`destroyAreaObject(Area theOne)`	Empties all the rooms in the given area, destroys all the content, and destroys the area itself, removing it from the world map.
`void`	`destroyRoomObject(Room deadRoom)`	Removes the given room from the map, clears it, and deletes any incoming exits.
`void`	`emptyAreaAndDestroyRooms(Area A)`	This method removes any area effects, and then empties and destroys every room in the area.
`void`	`emptyRoom(Room room, Room toRoom, boolean clearPlayers)`	Empties the given room of mobs and items, optionally moving stuff to another room.
`Area`	`findArea(java.lang.String calledThis)`	Given a partial area name, this will return area from the map that either matches the string, or partially matches it.
`Area`	`findAreaStartsWith(java.lang.String calledThis)`	Given an area name prefix, this will return the area from the map that either matches the string, or whose name starts with it.
`Room`	`findConnectingRoom(Room room)`	Returns a room that is connected to, and preferably links back, to the given room.
`Area`	`findRoomIDArea(java.lang.String roomID)`	Given a room ID, this will return the area to which the room it matches belongs.
`Boardable`	`findShip(java.lang.String s, boolean exactOnly)`	Searches the list of existing registered boardables, such as sailing ships, space ships, castles, and caravans.
`java.lang.String`	`getApproximateExtendedRoomID(Room room)`	All proper rooms, rooms savable to the database, have a unique room ID.
`Area`	`getArea(java.lang.String calledThis)`	Given an area name, this will return the area from the map whose name matches this one.
`Room`	`getCachedRoom(java.lang.String roomID)`	Given a room ID, this will return the room on the map that matches, it.
`java.util.Map<java.lang.String,TimeClock>`	`getClockCache()`	Returns the world-wide clock/timezone cache.
`Area`	`getDefaultParentArea()`	If the coffeemud.ini file defines a default parent area to which all newly created areas should be automatically added, this will return that area.
`Deity`	`getDeity(java.lang.String calledThis)`	Returns the world deity of the given name, if it exists.
`java.lang.String`	`getDescriptiveExtendedRoomID(Room room)`	Similar to the approximate version, this will return a reference to the nearest room, along with which direction its in relative to the given room.
`int`	`getExitDir(Room from, Exit to)`	Given a room and an exit, this will return which direction code is being used.
`java.lang.String`	`getExtendedRoomID(Room R)`	If the given room has a proper room id, this will return it.
`java.lang.String`	`getExtendedTwinRoomIDs(Room R1, Room R2)`	Returns the extended room IDs of both the given rooms, in a deterministic ordering, with an underscore between them -- nothing else.
`MOB`	`getFactoryMOB(Room R)`	If a mob is needed as a msg host/source, and it doesn't matter the name or level, then this is the method for you.
`MOB`	`getFactoryMOBInAnyRoom()`	If a mob is needed as a msg host/source, and it doesn't matter the name, level, room, or anything, then this is the method for you.
`Area`	`getFirstArea()`	Returns the first area in the world map.
`CMFile.CMVFSDir`	`getMapRoot(CMFile.CMVFSDir root)`	Generates a fake VFS file tree for the database game world map.
`Area`	`getModelArea(Area A)`	Normally just returns the given area.
`Area`	`getRandomArea()`	Returns a random area from the world map.
`Room`	`getRandomRoom()`	Returns a random room from a random area on the map.
`Room`	`getRoom(Room room)`	Because rooms can expire, but their references remain, this method exists to check for a destroyed condition and, if the room is destroyed, this will check for a replacement, and de-cache it if possible.
`Room`	`getRoom(java.lang.String roomID)`	Given a room ID, this will return the room on the map that matches this room id.
`Room`	`getRoom(java.util.Enumeration<Room> roomSet, java.lang.String roomID)`	Enumerates through the given room set, returning the room with the given room ID.
`Room`	`getRoomAllHosts(java.lang.String roomID)`	Given a room ID, this will return the room on the map that matches, it.
`int`	`getRoomDir(Room from, Room to)`	Given a room and a target room, this will return which direction code is being used.
`Room`	`getSafeRoomToMovePropertyTo(Room room, PrivateProperty I)`	Returns the parent room of the given private property, if it is a boardable, or the given room if not.
`Boardable`	`getShip(java.lang.String calledThis)`	Checks the list of existing registered boardables, such as sailing ships, space ships, castles, and caravans.
`Area`	`getStartArea(Environmental E)`	Attempts to return the start/orig area for the given mob or item or room or whatever.
`Room`	`getStartRoom(Environmental E)`	Attempts to return the start/orig room for the given mob or item or room or whatever.
`Area`	`getTargetArea(Room from, Exit to)`	Given a room and an exit, this will return which area it will lead to.
`Room`	`getTargetRoom(Room from, Exit to)`	Given a room and an exit, this will return which room it will lead to.
`boolean`	`hasASky(Room room)`	Returns whether the given room might have a sky, due to being outdoors but not being underwater.
`boolean`	`isClearableRoom(Room room)`	Sends any mobs or players in the given room to their start room, and returns whether any players, private property, or player corpses remain.
`java.util.Enumeration<Area>`	`mundaneAreas()`	Returns an enumeration of all areas which are not also space objects, meaning they are mundane and normal game areas.
`int`	`numAreas()`	Returns the number of areas on the map list, not including ships or other item-internal-areas.
`int`	`numRooms()`	Returns the sum of all the proper rooms in every area in all the world.
`int`	`numShips()`	Returns the number of registered boardables, such as sailing ships, space ships, castles, and caravans.
`void`	`obliterateMapArea(Area theOne)`	Empties all the rooms in the given area, destroys all the content, and destroys the area itself, removing it from the world map.
`void`	`obliterateMapRoom(Room deadRoom)`	Removes the given room from the map, clears it, and deletes any incoming exits.
`void`	`registerWorldObjectDestroyed(Area area, Room room, CMObject o)`	When a map object is permanently destroyed, this method is called to give the world map manager a chance to remove tracking for it.
`void`	`registerWorldObjectLoaded(Area area, Room room, CMObject o)`	When a map object is permanently added to the map, such as during map load, this method is called to give the world map manager a chance to keep track of it.
`void`	`renamedArea(Area theA)`	Whenever the given area is renamed, this method should be called, which will cause the areas to be re-sorted, and the area finder cache clear.
`void`	`renameRooms(Area A, java.lang.String oldName, java.util.List<Room> allMyDamnRooms)`	This will take an area that was recently renamed, and an optional list of all its existing rooms, and rename the rooms to reflect the new name, updating the database along the way.
`void`	`resetArea(Area area)`	Resets the given area by resetting all the cached rooms in it.
`void`	`resetRoom(Room room)`	Resets the contents of the given room to stock, without clearing grid rooms.
`void`	`resetRoom(Room room, boolean rebuildGrids)`	Resets the contents of the given room to stock, clearing any grids if necessary.
`java.util.Enumeration<java.lang.String>`	`roomIDs()`	Returns an enumeration of all proper room ids in every area in the world.
`Room`	`roomLocation(Environmental E)`	Returns the Room in which the given object exists in, or is attached to.
`java.util.Enumeration<Room>`	`rooms()`	Returns an enumeration of every CACHED proper room in every area, including 'filled' proper rooms, which also includes ships and similar areas.
`java.util.Enumeration<Room>`	`roomsFilled()`	Returns an enumeration of every CACHED room in every area, including 'filled' rooms, which includes skys and underwater rooms, which also includes ships and similar areas.
`java.util.Enumeration<WorldMap.LocatedPair>`	`scriptHosts(Area area)`	Returns an enumeration of all objects scripted upon creation in the world, or in the given area (non-metro).
`boolean`	`sendGlobalMessage(MOB host, int category, CMMsg msg)`	Send a message to all relevant listeners in the Global Alternative message passing system.
`java.util.Enumeration<Boardable>`	`ships()`	Returns an enumeration of all registered boardables, such as sailing ships, space ships, castles, and caravans.
`java.util.Enumeration<Room>`	`shipsRoomEnumerator(Area inA)`	Returns an enumerator of all rooms contained in a registered boardable, such as a sailing ship, space ship, castle, or caravan, which is also in the given Area.
`java.util.Enumeration<Area>`	`topAreas()`	Returns an enumeration of all areas which do NOT have any parent areas, thus being the 'top' areas.
`java.util.Enumeration<Item>`	`worldEveryItems()`	Returns a JIT enumeration of every CACHED item in every room on the map, well as every mob in every room on the map, as it presently exists at the time the Next method is called.
`java.util.Enumeration<MOB>`	`worldMobs()`	Returns a JIT enumeration of every CACHED mob in every room on the map, as it presently exists at the time the Next method is called.
`java.util.Enumeration<Item>`	`worldRoomItems()`	Returns a JIT enumeration of every CACHED item in every room on the map, as it presently exists at the time the Next method is called.

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary
activate, getServiceClient, L, propertiesLoaded, shutdown

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject
copyOf, ID, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable
compareTo

- Field Detail
  - ROOM_EXPIRATION_MILLIS
```
static final long ROOM_EXPIRATION_MILLIS
```
    The number of milliseconds before a thin room expires.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - numAreas
```
int numAreas()
```
    Returns the number of areas on the map list, not including ships or other item-internal-areas. It does include instances.
    
    Returns:
    
    the number of areas in the world
    
    See Also:
    
    getArea(String), addArea(Area), delArea(Area)
  - addArea
```
void addArea(Area newOne)
```
    Adds the given area to the world map list. Does not do anything to the database. Make sure it has a name first.
    
    Parameters:
    
    newOne - the new area to add to the list
    
    See Also:
    
    getArea(String), delArea(Area), numAreas()
  - delArea
```
void delArea(Area oneToDel)
```
    Deletes the given area from the world map list. Does not destroy the area or its rooms or do anything but remove the area from the list.
    
    Parameters:
    
    oneToDel - the area to remove
    
    See Also:
    
    getArea(String), addArea(Area), numAreas()
  - getArea
```
Area getArea(java.lang.String calledThis)
```
    Given an area name, this will return the area from the map whose name matches this one. Case insensitive, of course.
    
    Parameters:
    
    calledThis - the area name
    
    Returns:
    
    null, or the area object
  - findAreaStartsWith
```
Area findAreaStartsWith(java.lang.String calledThis)
```
    Given an area name prefix, this will return the area from the map that either matches the string, or whose name starts with it. The area finder cache is updated when this is called.
    
    Parameters:
    
    calledThis - the area name, or area name prefix
    
    Returns:
    
    null, or the area found.
    
    See Also:
    
    findArea(String), findAreaStartsWith(String), getArea(String)
  - findArea
```
Area findArea(java.lang.String calledThis)
```
    Given a partial area name, this will return area from the map that either matches the string, or partially matches it. The area finder cache is updated when this is called.
    
    Parameters:
    
    calledThis - the area name, or partial area name
    
    Returns:
    
    null, or the area found.
    
    See Also:
    
    findArea(String), findAreaStartsWith(String), getArea(String)
  - getDefaultParentArea
```
Area getDefaultParentArea()
```
    If the coffeemud.ini file defines a default parent area to which all newly created areas should be automatically added, this will return that area.
    
    Returns:
    
    the global parent area
  - findRoomIDArea
```
Area findRoomIDArea(java.lang.String roomID)
```
    Given a room ID, this will return the area to which the room it matches belongs.
    
    Parameters:
    
    roomID - the room id to get the area for
    
    Returns:
    
    null, or the area the room belongs to
  - areas
```
java.util.Enumeration<Area> areas()
```
    Returns an enumeration of all world map areas.
    
    Returns:
    
    an enumeration of all world map areas.
    
    See Also:
    
    mundaneAreas(), topAreas(), areasPlusShips()
  - mundaneAreas
```
java.util.Enumeration<Area> mundaneAreas()
```
    Returns an enumeration of all areas which are not also space objects, meaning they are mundane and normal game areas.
    
    Returns:
    
    the normal areas
    
    See Also:
    
    areas(), topAreas(), areasPlusShips()
  - topAreas
```
java.util.Enumeration<Area> topAreas()
```
    Returns an enumeration of all areas which do NOT have any parent areas, thus being the 'top' areas.
    
    Returns:
    
    an enumeration of the top-level areas
    
    See Also:
    
    areas(), mundaneAreas(), areasPlusShips()
  - areasPlusShips
```
java.util.Enumeration<Area> areasPlusShips()
```
    Returns an enumeration of all map areas, including all areas inside ships, caravans, etc.
    
    Returns:
    
    an enumeration of all areas, plus the ship areas
    
    See Also:
    
    areas(), mundaneAreas(), topAreas()
  - getModelArea
```
Area getModelArea(Area A)
```
    Normally just returns the given area. But if the area given is an instance child, this will return the area upon which it was based. In any case, you get an area from the world.
    
    Parameters:
    
    A - the area to return the model of
    
    Returns:
    
    the model area, usually just the area you sent
  - getFirstArea
```
Area getFirstArea()
```
    Returns the first area in the world map.
    
    Returns:
    
    the first area
    
    See Also:
    
    getRandomArea()
  - getRandomArea
```
Area getRandomArea()
```
    Returns a random area from the world map.
    
    Returns:
    
    a random area
    
    See Also:
    
    getFirstArea()
  - obliterateMapArea
```
void obliterateMapArea(Area theOne)
```
    Empties all the rooms in the given area, destroys all the content, and destroys the area itself, removing it from the world map. All database records are also deleted.
    
    Parameters:
    
    theOne - the area to obliterate
    
    See Also:
    
    destroyAreaObject(Area)
  - destroyAreaObject
```
void destroyAreaObject(Area theOne)
```
    Empties all the rooms in the given area, destroys all the content, and destroys the area itself, removing it from the world map. Does not affect the database at all.
    
    Parameters:
    
    theOne - the area to destroy
    
    See Also:
    
    obliterateMapArea(Area)
  - renamedArea
```
void renamedArea(Area theA)
```
    Whenever the given area is renamed, this method should be called, which will cause the areas to be re-sorted, and the area finder cache clear.
    
    Parameters:
    
    theA - the area that was renamed
    
    See Also:
    
    renameRooms(Area, String, List)
  - numRooms
```
int numRooms()
```
    Returns the sum of all the proper rooms in every area in all the world.
    
    Returns:
    
    the number of rooms
  - roomIDs
```
java.util.Enumeration<java.lang.String> roomIDs()
```
    Returns an enumeration of all proper room ids in every area in the world.
    
    Returns:
    
    the enumeration of all room ids
  - getExtendedRoomID
```
java.lang.String getExtendedRoomID(Room R)
```
    If the given room has a proper room id, this will return it. If the given room is a child of a grid, it will return the grid-reference unique room id.
    
    Parameters:
    
    R - the room to return a room id for
    
    Returns:
    
    "", or the room id
    
    See Also:
    
    getExtendedRoomID(Room), getExtendedTwinRoomIDs(Room, Room), getDescriptiveExtendedRoomID(Room), getApproximateExtendedRoomID(Room)
  - getDescriptiveExtendedRoomID
```
java.lang.String getDescriptiveExtendedRoomID(Room room)
```
    Similar to the approximate version, this will return a reference to the nearest room, along with which direction its in relative to the given room.
    
    Parameters:
    
    room - the room to find a descriptive reference to
    
    Returns:
    
    the descriptive extended room id
    
    See Also:
    
    getExtendedRoomID(Room), getExtendedTwinRoomIDs(Room, Room), getApproximateExtendedRoomID(Room)
  - getExtendedTwinRoomIDs
```
java.lang.String getExtendedTwinRoomIDs(Room R1,
                                        Room R2)
```
    Returns the extended room IDs of both the given rooms, in a deterministic ordering, with an underscore between them -- nothing else.
    
    Parameters:
    
    R1 - the first room
    
    R2 - the second room
    
    Returns:
    
    the pair of rooms ids in one string
    
    See Also:
    
    getExtendedRoomID(Room), getDescriptiveExtendedRoomID(Room), getApproximateExtendedRoomID(Room)
  - getApproximateExtendedRoomID
```
java.lang.String getApproximateExtendedRoomID(Room room)
```
    All proper rooms, rooms savable to the database, have a unique room ID. Derived rooms however, such as grid rooms, skies, underwater rooms, and others will not. Most grid rooms have a derivative (extended) identifier id that is tied to a proper room grid parent. However, temporary rooms can get tricky, which is why this method exists to return the nearest room that does have an extended id.
    
    Parameters:
    
    room - the room to find the nearest id for.
    
    Returns:
    
    "" or an approximately located room id
    
    See Also:
    
    getExtendedRoomID(Room), getExtendedTwinRoomIDs(Room, Room), getDescriptiveExtendedRoomID(Room)
  - getRoom
```
Room getRoom(Room room)
```
    Because rooms can expire, but their references remain, this method exists to check for a destroyed condition and, if the room is destroyed, this will check for a replacement, and de-cache it if possible.
    
    Parameters:
    
    room - the room that may or may not be expired
    
    Returns:
    
    the given room, or its replacement
    
    See Also:
    
    getRoom(String), getRoom(Enumeration, String), getCachedRoom(String), getRoomAllHosts(String)
  - getRoom
```
Room getRoom(java.lang.String roomID)
```
    Given a room ID, this will return the room on the map that matches this room id.
    
    Parameters:
    
    roomID - the room id to get the room for
    
    Returns:
    
    null, or the room if found.
    
    See Also:
    
    getRoom(Room), getRoom(Enumeration, String), getCachedRoom(String), getRoomAllHosts(String)
  - getRoom
```
Room getRoom(java.util.Enumeration<Room> roomSet,
             java.lang.String roomID)
```
    Enumerates through the given room set, returning the room with the given room ID. If a room set is null, the entire map is checked.
    
    Parameters:
    
    roomSet - an enumeration of rooms to check
    
    roomID - the room ID of the room to get
    
    Returns:
    
    null, or the room from the set
    
    See Also:
    
    getRoom(Room), getRoom(String), getCachedRoom(String), getRoomAllHosts(String)
  - getCachedRoom
```
Room getCachedRoom(java.lang.String roomID)
```
    Given a room ID, this will return the room on the map that matches, it. It will only match cached rooms, esp from thin areas.
    
    Parameters:
    
    roomID - the room ID to get
    
    Returns:
    
    null, or the room from the map
    
    See Also:
    
    getRoom(Room), getRoom(String), getRoom(Enumeration, String), getCachedRoom(String), getRoomAllHosts(String)
  - getRoomAllHosts
```
Room getRoomAllHosts(java.lang.String roomID)
```
    Given a room ID, this will return the room on the map that matches, it. This will include ALL maps on every host in this mud. This will de-cache any rooms from thin areas.
    
    Parameters:
    
    roomID - the room ID to get
    
    Returns:
    
    null, or the room from the map
    
    See Also:
    
    getRoom(Room), getRoom(String), getRoom(Enumeration, String), getCachedRoom(String)
  - rooms
```
java.util.Enumeration<Room> rooms()
```
    Returns an enumeration of every CACHED proper room in every area, including 'filled' proper rooms, which also includes ships and similar areas.
    
    Returns:
    
    the enumeration of all the cached proper rooms
    
    See Also:
    
    roomsFilled()
  - roomsFilled
```
java.util.Enumeration<Room> roomsFilled()
```
    Returns an enumeration of every CACHED room in every area, including 'filled' rooms, which includes skys and underwater rooms, which also includes ships and similar areas.
    
    Returns:
    
    the enumeration of all the cached rooms
    
    See Also:
    
    rooms()
  - worldMobs
```
java.util.Enumeration<MOB> worldMobs()
```
    Returns a JIT enumeration of every CACHED mob in every room on the map, as it presently exists at the time the Next method is called.
    
    Returns:
    
    the enumeration of all the mobs
    
    See Also:
    
    worldEveryItems(), worldRoomItems()
  - worldRoomItems
```
java.util.Enumeration<Item> worldRoomItems()
```
    Returns a JIT enumeration of every CACHED item in every room on the map, as it presently exists at the time the Next method is called.
    
    Returns:
    
    the enumeration of all the items
    
    See Also:
    
    worldEveryItems(), worldMobs()
  - worldEveryItems
```
java.util.Enumeration<Item> worldEveryItems()
```
    Returns a JIT enumeration of every CACHED item in every room on the map, well as every mob in every room on the map, as it presently exists at the time the Next method is called.
    
    Returns:
    
    the enumeration of all the items
    
    See Also:
    
    worldEveryItems(), worldMobs()
  - getRandomRoom
```
Room getRandomRoom()
```
    Returns a random room from a random area on the map. Just for fun -- typically for temporary mobs.
    
    Returns:
    
    a random cached room from the map
  - renameRooms
```
void renameRooms(Area A,
                 java.lang.String oldName,
                 java.util.List<Room> allMyDamnRooms)
```
    This will take an area that was recently renamed, and an optional list of all its existing rooms, and rename the rooms to reflect the new name, updating the database along the way.
    
    Parameters:
    
    A - the area that WAS renamed
    
    oldName - the previous name of the given area
    
    allMyDamnRooms - null, or the list of existing rooms.
    
    See Also:
    
    renamedArea(Area)
  - obliterateMapRoom
```
void obliterateMapRoom(Room deadRoom)
```
    Removes the given room from the map, clears it, and deletes any incoming exits. Then deletes it, and all internally saved objects from the DB.
    
    Parameters:
    
    deadRoom - the room to remove from the map
    
    See Also:
    
    destroyRoomObject(Room), obliterateMapArea(Area)
  - destroyRoomObject
```
void destroyRoomObject(Room deadRoom)
```
    Removes the given room from the map, clears it, and deletes any incoming exits. Does not affect the DB.
    
    Parameters:
    
    deadRoom - the room to remove from the map
    
    See Also:
    
    obliterateMapRoom(Room), destroyAreaObject(Area)
  - findConnectingRoom
```
Room findConnectingRoom(Room room)
```
    Returns a room that is connected to, and preferably links back, to the given room. This can include skys, and might prefer them.
    
    Parameters:
    
    room - the room to look at exits from
    
    Returns:
    
    a connecting room
  - getRoomDir
```
int getRoomDir(Room from,
               Room to)
```
    Given a room and a target room, this will return which direction code is being used.
    
    Parameters:
    
    from - the initial room
    
    to - the room being target
    
    Returns:
    
    the direction code from the from room to the target
    
    See Also:
    
    Directions, getTargetArea(Room, Exit), getTargetRoom(Room, Exit), getExitDir(Room, Exit)
  - getExitDir
```
int getExitDir(Room from,
               Exit to)
```
    Given a room and an exit, this will return which direction code is being used.
    
    Parameters:
    
    from - the initial room
    
    to - the exit being used
    
    Returns:
    
    the direction code
    
    See Also:
    
    Directions, getTargetArea(Room, Exit), getTargetRoom(Room, Exit), getRoomDir(Room, Room)
  - getTargetArea
```
Area getTargetArea(Room from,
                   Exit to)
```
    Given a room and an exit, this will return which area it will lead to.
    
    Parameters:
    
    from - the initial room
    
    to - the exit being used
    
    Returns:
    
    the area it leads to, or null
    
    See Also:
    
    getTargetRoom(Room, Exit), getRoomDir(Room, Room), getExitDir(Room, Exit)
  - getTargetRoom
```
Room getTargetRoom(Room from,
                   Exit to)
```
    Given a room and an exit, this will return which room it will lead to.
    
    Parameters:
    
    from - the initial room
    
    to - the exit being used
    
    Returns:
    
    the room it leads to, or null
    
    See Also:
    
    getTargetArea(Room, Exit), getRoomDir(Room, Room), getExitDir(Room, Exit)
  - resetArea
```
void resetArea(Area area)
```
    Resets the given area by resetting all the cached rooms in it.
    
    Parameters:
    
    area - the area to reset.
  - resetRoom
```
void resetRoom(Room room)
```
    Resets the contents of the given room to stock, without clearing grid rooms.
    
    Parameters:
    
    room - the room whose content to reset
  - resetRoom
```
void resetRoom(Room room,
               boolean rebuildGrids)
```
    Resets the contents of the given room to stock, clearing any grids if necessary.
    
    Parameters:
    
    room - the room whose content to reset
    
    rebuildGrids - true to also clear and rebuild grids, or false otherwise
  - getStartRoom
```
Room getStartRoom(Environmental E)
```
    Attempts to return the start/orig room for the given mob or item or room or whatever.
    
    Parameters:
    
    E - the object to get a start room for
    
    Returns:
    
    the start room, or the area its in
  - getStartArea
```
Area getStartArea(Environmental E)
```
    Attempts to return the start/orig area for the given mob or item or room or whatever.
    
    Parameters:
    
    E - the object to get a start area for
    
    Returns:
    
    the start area, or the area its in
  - roomLocation
```
Room roomLocation(Environmental E)
```
    Returns the Room in which the given object exists in, or is attached to. Handles almost any kind of object in the game, so long as it can be traced back to a room.
    
    Parameters:
    
    E - the game object whose room location you are curious about
    
    Returns:
    
    null, or the room that the object is in
  - emptyRoom
```
void emptyRoom(Room room,
               Room toRoom,
               boolean clearPlayers)
```
    Empties the given room of mobs and items, optionally moving stuff to another room. If no target junk room is given, you can optionally move players somewhere safe anyway.
    
    Parameters:
    
    room - the room to clear
    
    toRoom - null, or the room to move all mobs/items to
    
    clearPlayers - true to move players anyway, false otherwise
  - emptyAreaAndDestroyRooms
```
void emptyAreaAndDestroyRooms(Area A)
```
    This method removes any area effects, and then empties and destroys every room in the area. Perfect for instances, and other non-permanent areas. Does not actually destroy the area object per-se.
    
    Parameters:
    
    A - the area to empty
  - hasASky
```
boolean hasASky(Room room)
```
    Returns whether the given room might have a sky, due to being outdoors but not being underwater.
    
    Parameters:
    
    room - the room to check
    
    Returns:
    
    true if a sky would be appropriate, false otherwise
  - isClearableRoom
```
boolean isClearableRoom(Room room)
```
    Sends any mobs or players in the given room to their start room, and returns whether any players, private property, or player corpses remain. Also returns false if the room is under a temporary effect.
    
    Parameters:
    
    room - the room to clear/check.
    
    Returns:
    
    true if the room is ready to be cleared, false otherwise
  - createNewExit
```
java.lang.String createNewExit(Room from,
                               Room room,
                               int direction)
```
    Attempts to create a pair of Open exits from the from room to the room room. If any errors are found in the inputs, then a descriptive error is returned. The exits changes ARE SAVED TO THE DB!
    
    Parameters:
    
    from - the from room
    
    room - the to room
    
    direction - the direction from the from to the room room
    
    Returns:
    
    "", or an error message if something went wrong.
  - areaLocation
```
Area areaLocation(CMObject E)
```
    Returns the Area in which the given object exists in, or is attached to. Handles almost any kind of object in the game, so long as it can be traced back to a room or area.
    
    Parameters:
    
    E - the game object whose area location you are curious about
    
    Returns:
    
    null, or the area that the object is in
  - getMapRoot
```
CMFile.CMVFSDir getMapRoot(CMFile.CMVFSDir root)
```
    Generates a fake VFS file tree for the database game world map. The nodes are generated dynamically during browsing, so this call is very efficient.
    
    Parameters:
    
    root - the root directory to add the map directory to
    
    Returns:
    
    the fake VFS map directory
  - registerWorldObjectLoaded
```
void registerWorldObjectLoaded(Area area,
                               Room room,
                               CMObject o)
```
    When a map object is permanently added to the map, such as during map load, this method is called to give the world map manager a chance to keep track of it.
    
    Parameters:
    
    area - the area that the object was loaded into
    
    room - the room that the object was loaded into
    
    o - the object to register as loaded
    
    See Also:
    
    registerWorldObjectDestroyed(Area, Room, CMObject)
  - registerWorldObjectDestroyed
```
void registerWorldObjectDestroyed(Area area,
                                  Room room,
                                  CMObject o)
```
    When a map object is permanently destroyed, this method is called to give the world map manager a chance to remove tracking for it.
    
    Parameters:
    
    area - the area that the object was originally loaded into
    
    room - the room that the object was originally loaded into
    
    o - the object to de-register
    
    See Also:
    
    registerWorldObjectLoaded(Area, Room, CMObject)
  - getShip
```
Boardable getShip(java.lang.String calledThis)
```
    Checks the list of existing registered boardables, such as sailing ships, space ships, castles, and caravans. It returns the exact matching named boardable.
    
    Parameters:
    
    calledThis - the name of the boardable
    
    Returns:
    
    the boardable found, or null
    
    See Also:
    
    findShip(String, boolean), ships(), shipsRoomEnumerator(Area), numShips()
  - findShip
```
Boardable findShip(java.lang.String s,
                   boolean exactOnly)
```
    Searches the list of existing registered boardables, such as sailing ships, space ships, castles, and caravans. It returns the first one found.
    
    Parameters:
    
    s - the name search
    
    exactOnly - true for exact matches only, false for substring matches
    
    Returns:
    
    null, or the first found boardable that matches
    
    See Also:
    
    getShip(String), ships(), shipsRoomEnumerator(Area), numShips()
  - ships
```
java.util.Enumeration<Boardable> ships()
```
    Returns an enumeration of all registered boardables, such as sailing ships, space ships, castles, and caravans.
    
    Returns:
    
    the enumeration of existing boardables
    
    See Also:
    
    getShip(String), findShip(String, boolean), shipsRoomEnumerator(Area), numShips()
  - shipsRoomEnumerator
```
java.util.Enumeration<Room> shipsRoomEnumerator(Area inA)
```
    Returns an enumerator of all rooms contained in a registered boardable, such as a sailing ship, space ship, castle, or caravan, which is also in the given Area.
    
    Parameters:
    
    inA - the area containing a ship, possibly
    
    Returns:
    
    the boardable rooms enumerator
    
    See Also:
    
    getShip(String), findShip(String, boolean), ships(), numShips()
  - numShips
```
int numShips()
```
    Returns the number of registered boardables, such as sailing ships, space ships, castles, and caravans.
    
    Returns:
    
    the number of registered boardables
    
    See Also:
    
    getShip(String), findShip(String, boolean), ships(), shipsRoomEnumerator(Area), numShips()
  - getSafeRoomToMovePropertyTo
```
Room getSafeRoomToMovePropertyTo(Room room,
                                 PrivateProperty I)
```
    Returns the parent room of the given private property, if it is a boardable, or the given room if not. The parent of a grid, a nearby room, or at least a random one is always returned.
    
    Parameters:
    
    room - the room that needs moving FROM
    
    I - null, or private property that needs moving
    
    Returns:
    
    a room thats not the given one
  - scriptHosts
```
java.util.Enumeration<WorldMap.LocatedPair> scriptHosts(Area area)
```
    Returns an enumeration of all objects scripted upon creation in the world, or in the given area (non-metro).
    
    Parameters:
    
    area - null, or the area to limit returns to
    
    Returns:
    
    an enumeration of the scripted objects
    
    See Also:
    
    WorldMap.LocatedPair.room()
  - deity
```
MOB deity()
```
    Returns the first available deity, creating one from scratch if necessary.
    
    Returns:
    
    a deity
    
    See Also:
    
    Deity, deities(), getDeity(String)
  - getDeity
```
Deity getDeity(java.lang.String calledThis)
```
    Returns the world deity of the given name, if it exists.
    
    Parameters:
    
    calledThis - the name of the deity to get.
    
    Returns:
    
    null, or the deity object found
    
    See Also:
    
    Deity, deities(), deity()
  - deities
```
java.util.Enumeration<Deity> deities()
```
    Returns an enumeration of all the Deity-derived registered objects in the game.
    
    Returns:
    
    all the deities
    
    See Also:
    
    Deity, deity(), getDeity(String)
  - getClockCache
```
java.util.Map<java.lang.String,TimeClock> getClockCache()
```
    Returns the world-wide clock/timezone cache. This map is editable by the caller for submitting new clocks, or referencing existing ones. The key is typically an area name.
    
    Returns:
    
    the world-wide clock cache
  - getFactoryMOBInAnyRoom
```
MOB getFactoryMOBInAnyRoom()
```
    If a mob is needed as a msg host/source, and it doesn't matter the name, level, room, or anything, then this is the method for you.
    
    Returns:
    
    a mob, which you should destroy after use
    
    See Also:
    
    getFactoryMOB(Room)
  - getFactoryMOB
```
MOB getFactoryMOB(Room R)
```
    If a mob is needed as a msg host/source, and it doesn't matter the name or level, then this is the method for you. Just specify the room that the mob will be pointed at (not necc IN).
    
    Parameters:
    
    R - the room to put the temporary mob in
    
    Returns:
    
    a mob, which you should destroy after use
    
    See Also:
    
    getFactoryMOBInAnyRoom()
  - addGlobalHandler
```
void addGlobalHandler(MsgListener E,
                      int category)
```
    Add a listener to the Global Alternative message passing system.
    
    Parameters:
    
    E - the message listener for the global message
    
    category - the CMMsg TYP code (CMMsg
    
    See Also:
    
    delGlobalHandler(MsgListener, int), sendGlobalMessage(MOB, int, CMMsg)
  - delGlobalHandler
```
void delGlobalHandler(MsgListener E,
                      int category)
```
    Remove a listener from the Global Alternative message passing system.
    
    Parameters:
    
    E - the message listener for the global message
    
    category - the CMMsg TYP code (CMMsg
    
    See Also:
    
    addGlobalHandler(MsgListener, int), sendGlobalMessage(MOB, int, CMMsg)
  - sendGlobalMessage
```
boolean sendGlobalMessage(MOB host,
                          int category,
                          CMMsg msg)
```
    Send a message to all relevant listeners in the Global Alternative message passing system.
    
    Parameters:
    
    host - the host/sender of the message
    
    category - the CMMsg TYP code (CMMsg
    
    msg - the actual message to send
    
    Returns:
    
    true if the message was successfully sent
    
    See Also:
    
    addGlobalHandler(MsgListener, int), delGlobalHandler(MsgListener, int)

Interface WorldMap

Nested Class Summary

Field Summary

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

Method Summary

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

Methods inherited from interface java.lang.Comparable

Field Detail

ROOM_EXPIRATION_MILLIS

Method Detail

numAreas

addArea

delArea

getArea

findAreaStartsWith

findArea

getDefaultParentArea

findRoomIDArea

areas

mundaneAreas

topAreas

areasPlusShips

getModelArea

getFirstArea

getRandomArea

obliterateMapArea

destroyAreaObject

renamedArea

numRooms

roomIDs

getExtendedRoomID

getDescriptiveExtendedRoomID

getExtendedTwinRoomIDs

getApproximateExtendedRoomID

getRoom

getRoom

getRoom

getCachedRoom

getRoomAllHosts

rooms

roomsFilled

worldMobs

worldRoomItems

worldEveryItems

getRandomRoom

renameRooms

obliterateMapRoom

destroyRoomObject

findConnectingRoom

getRoomDir

getExitDir

getTargetArea

getTargetRoom

resetArea

resetRoom

resetRoom

getStartRoom

getStartArea

roomLocation

emptyRoom

emptyAreaAndDestroyRooms

hasASky

isClearableRoom

createNewExit

areaLocation

getMapRoot

registerWorldObjectLoaded

registerWorldObjectDestroyed

getShip

findShip

ships

shipsRoomEnumerator

numShips

getSafeRoomToMovePropertyTo

scriptHosts

deity

getDeity

deities

getClockCache