CMMap

java.lang.Object
- com.planet_ink.coffee_mud.Libraries.StdLibrary
- - com.planet_ink.coffee_mud.Libraries.CMMap

All Implemented Interfaces:

CMObject, Tickable, CMLibrary, WorldMap, java.lang.Cloneable, java.lang.Comparable<CMObject>
```
public class CMMap
extends StdLibrary
implements WorldMap
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

class CMMap.AreasRoomsEnumerator

class CMMap.RoomItemsEnumerator

class CMMap.RoomMobsEnumerator
- Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.WorldMap
  WorldMap.LocatedPair

Nested Classes
Modifier and Type	Class	Description
`class`	`CMMap.AreasRoomsEnumerator`
`class`	`CMMap.RoomItemsEnumerator`
`class`	`CMMap.RoomMobsEnumerator`

Field Summary

Fields
Modifier and Type	Field	Description
`protected static java.util.Comparator<Area>`	`areaComparator`
`protected CMNSortSVec<Area>`	`areasList`
`protected java.util.Map<java.lang.String,TimeClock>`	`clockCache`
`protected static char[]`	`cmfsFilenameifyChars`
`protected CMNSortSVec<Deity>`	`deitiesList`
`protected static MOB`	`deityStandIn`
`java.util.Map<java.lang.Integer,java.util.List<java.lang.ref.WeakReference<MsgListener>>>`	`globalHandlers`
`protected long`	`lastVReset`
`CMMsg`	`resetMsg`
`protected java.util.Map<java.lang.String,java.lang.Object>`	`SCRIPT_HOST_SEMAPHORES`
`java.util.Map<java.lang.String,SLinkedList<WorldMap.LocatedPair>>`	`scriptHostMap`
`protected java.util.List<Boardable>`	`shipList`

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

Fields inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary
isDebugging, name, serviceClient, tickStatus

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable
STATUS_AFFECT, STATUS_ALIVE, STATUS_BEHAVIOR, STATUS_CLASS, STATUS_DEAD, STATUS_END, STATUS_FIGHT, STATUS_MISC, STATUS_MISC2, STATUS_MISC3, STATUS_MISC4, STATUS_MISC5, STATUS_MISC6, STATUS_MISC7, STATUS_NOT, STATUS_OTHER, STATUS_RACE, STATUS_REBIRTH, STATUS_SCRIPT, STATUS_START, STATUS_WEATHER, TICKID_AREA, TICKID_BALLISTICK, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, TICKID_EVENT, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MISCELLANEOUS, TICKID_MOB, TICKID_PROPERTY_SPECIAL, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SHORTERMASK, TICKID_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Fields inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.WorldMap
ROOM_EXPIRATION_MILLIS

Constructor Summary

Constructors
Constructor Description

CMMap()

Constructors
Constructor	Description
`CMMap()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`activate()`	Activates the library.
`void`	`addArea(Area newOne)`	Adds the given area to the world map list.
`protected void`	`addDeity(Deity newOne)`
`void`	`addGlobalHandler(MsgListener E, int category)`	Add a listener to the Global Alternative message passing system.
`protected void`	`addMapStatFiles(java.util.List<CMFile.CMVFSFile> rootFiles, Room R, Environmental E, CMFile.CMVFSDir root)`
`protected void`	`addScriptHost(Area area, Room room, PhysicalAgent host)`
`protected void`	`addShip(Boardable newOne)`
`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.
`protected void`	`cleanScriptHosts(SLinkedList<WorldMap.LocatedPair> hosts, PhysicalAgent oneToDel, boolean fullCleaning)`
`protected java.lang.String`	`cmfsFilenameify(java.lang.String str)`
`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.
`protected void`	`delDeity(Deity oneToDel)`
`void`	`delGlobalHandler(MsgListener E, int category)`	Remove a listener from the Global Alternative message passing system.
`protected void`	`delScriptHost(Area area, PhysicalAgent oneToDel)`
`protected void`	`delShip(Boardable oneToDel)`
`void`	`destroyAreaObject(Area A)`	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 area)`	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.
`protected PairVector<MOB,java.lang.String>`	`getAllPlayersHere(Area area, boolean includeLocalFollowers)`
`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.
`protected java.util.Map<java.lang.String,Area>`	`getAreaFinder()`
`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.
`protected int`	`getGlobalIndex(java.util.List<Environmental> list, java.lang.String name)`
`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.
`protected Room`	`getRoom(java.util.Enumeration<Room> roomSet, java.lang.String roomID, boolean cachedOnly)`
`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.
`protected java.lang.Object`	`getScriptHostSemaphore(Area area)`
`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.
`java.lang.String`	`ID()`	The CoffeeMud Java Class ID shared by all instances of this object.
`protected boolean`	`isAQualifyingScriptHost(PhysicalAgent host)`
`protected boolean`	`isAScriptHost(Area area, PhysicalAgent host)`
`protected boolean`	`isAScriptHost(SLinkedList<WorldMap.LocatedPair> hosts, PhysicalAgent host)`
`boolean`	`isClearableRoom(Room R)`	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`	`numDeities()`
`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.
`protected void`	`obliterateArea(Area A, boolean includeDB)`
`void`	`obliterateMapArea(Area A)`	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.
`protected void`	`obliterateRoom(Room deadRoom, java.util.List<Room> linkInRooms, boolean includeDB)`
`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.
`void`	`roomMaintSweep()`
`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<Area>`	`shipAreaEnumerator(Area inA)`
`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.
`boolean`	`shutdown()`	Shuts down the library.
`boolean`	`tick(Tickable ticking, int tickID)`	this is the method which is called periodically by the threading engine.
`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
getServiceClient, L, propertiesLoaded

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

Methods inherited from interface java.lang.Comparable
compareTo

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary
checkDatabase, compareTo, copyOf, getServiceClient, getTickStatus, initializeClass, L, name, newInstance, propertiesLoaded, setThreadStatus

- Field Detail
  - deityStandIn
```
protected static MOB deityStandIn
```
  - lastVReset
```
protected long lastVReset
```
  - areasList
```
protected CMNSortSVec<Area> areasList
```
  - deitiesList
```
protected CMNSortSVec<Deity> deitiesList
```
  - shipList
```
protected java.util.List<Boardable> shipList
```
  - SCRIPT_HOST_SEMAPHORES
```
protected java.util.Map<java.lang.String,java.lang.Object> SCRIPT_HOST_SEMAPHORES
```
  - clockCache
```
protected java.util.Map<java.lang.String,TimeClock> clockCache
```
  - areaComparator
```
protected static final java.util.Comparator<Area> areaComparator
```
  - globalHandlers
```
public java.util.Map<java.lang.Integer,java.util.List<java.lang.ref.WeakReference<MsgListener>>> globalHandlers
```
  - scriptHostMap
```
public java.util.Map<java.lang.String,SLinkedList<WorldMap.LocatedPair>> scriptHostMap
```
  - resetMsg
```
public CMMsg resetMsg
```
  - cmfsFilenameifyChars
```
protected static final char[] cmfsFilenameifyChars
```
- 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, Tech. 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
  - getGlobalIndex
```
protected int getGlobalIndex(java.util.List<Environmental> list,
                             java.lang.String name)
```
  - renamedArea
```
public void renamedArea(Area theA)
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    renamedArea in interface WorldMap
    
    Parameters:
    
    theA - the area that was renamed
    
    See Also:
    
    WorldMap.renameRooms(Area, String, List)
  - numAreas
```
public int numAreas()
```
    Description copied from interface: WorldMap
    
    Returns the number of areas on the map list, not including ships or other item-internal-areas. It does include instances.
    
    Specified by:
    
    numAreas in interface WorldMap
    
    Returns:
    
    the number of areas in the world
    
    See Also:
    
    WorldMap.getArea(String), WorldMap.addArea(Area), WorldMap.delArea(Area)
  - addArea
```
public void addArea(Area newOne)
```
    Description copied from interface: WorldMap
    
    Adds the given area to the world map list. Does not do anything to the database. Make sure it has a name first.
    
    Specified by:
    
    addArea in interface WorldMap
    
    Parameters:
    
    newOne - the new area to add to the list
    
    See Also:
    
    WorldMap.getArea(String), WorldMap.delArea(Area), WorldMap.numAreas()
  - delArea
```
public void delArea(Area oneToDel)
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    delArea in interface WorldMap
    
    Parameters:
    
    oneToDel - the area to remove
    
    See Also:
    
    WorldMap.getArea(String), WorldMap.addArea(Area), WorldMap.numAreas()
  - getClockCache
```
public java.util.Map<java.lang.String,TimeClock> getClockCache()
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    getClockCache in interface WorldMap
    
    Returns:
    
    the world-wide clock cache
  - getModelArea
```
public Area getModelArea(Area A)
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    getModelArea in interface WorldMap
    
    Parameters:
    
    A - the area to return the model of
    
    Returns:
    
    the model area, usually just the area you sent
  - getAreaFinder
```
protected java.util.Map<java.lang.String,Area> getAreaFinder()
```
  - getArea
```
public Area getArea(java.lang.String calledThis)
```
    Description copied from interface: WorldMap
    
    Given an area name, this will return the area from the map whose name matches this one. Case insensitive, of course.
    
    Specified by:
    
    getArea in interface WorldMap
    
    Parameters:
    
    calledThis - the area name
    
    Returns:
    
    null, or the area object
  - findAreaStartsWith
```
public Area findAreaStartsWith(java.lang.String calledThis)
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    findAreaStartsWith in interface WorldMap
    
    Parameters:
    
    calledThis - the area name, or area name prefix
    
    Returns:
    
    null, or the area found.
    
    See Also:
    
    WorldMap.findArea(String), WorldMap.findAreaStartsWith(String), WorldMap.getArea(String)
  - findArea
```
public Area findArea(java.lang.String calledThis)
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    findArea in interface WorldMap
    
    Parameters:
    
    calledThis - the area name, or partial area name
    
    Returns:
    
    null, or the area found.
    
    See Also:
    
    WorldMap.findArea(String), WorldMap.findAreaStartsWith(String), WorldMap.getArea(String)
  - areas
```
public java.util.Enumeration<Area> areas()
```
    Description copied from interface: WorldMap
    
    Returns an enumeration of all world map areas.
    
    Specified by:
    
    areas in interface WorldMap
    
    Returns:
    
    an enumeration of all world map areas.
    
    See Also:
    
    WorldMap.mundaneAreas(), WorldMap.topAreas(), WorldMap.areasPlusShips()
  - areasPlusShips
```
public java.util.Enumeration<Area> areasPlusShips()
```
    Description copied from interface: WorldMap
    
    Returns an enumeration of all map areas, including all areas inside ships, caravans, etc.
    
    Specified by:
    
    areasPlusShips in interface WorldMap
    
    Returns:
    
    an enumeration of all areas, plus the ship areas
    
    See Also:
    
    WorldMap.areas(), WorldMap.mundaneAreas(), WorldMap.topAreas()
  - mundaneAreas
```
public java.util.Enumeration<Area> mundaneAreas()
```
    Description copied from interface: WorldMap
    
    Returns an enumeration of all areas which are not also space objects, meaning they are mundane and normal game areas.
    
    Specified by:
    
    mundaneAreas in interface WorldMap
    
    Returns:
    
    the normal areas
    
    See Also:
    
    WorldMap.areas(), WorldMap.topAreas(), WorldMap.areasPlusShips()
  - topAreas
```
public java.util.Enumeration<Area> topAreas()
```
    Description copied from interface: WorldMap
    
    Returns an enumeration of all areas which do NOT have any parent areas, thus being the 'top' areas.
    
    Specified by:
    
    topAreas in interface WorldMap
    
    Returns:
    
    an enumeration of the top-level areas
    
    See Also:
    
    WorldMap.areas(), WorldMap.mundaneAreas(), WorldMap.areasPlusShips()
  - roomIDs
```
public java.util.Enumeration<java.lang.String> roomIDs()
```
    Description copied from interface: WorldMap
    
    Returns an enumeration of all proper room ids in every area in the world.
    
    Specified by:
    
    roomIDs in interface WorldMap
    
    Returns:
    
    the enumeration of all room ids
  - getFirstArea
```
public Area getFirstArea()
```
    Description copied from interface: WorldMap
    
    Returns the first area in the world map.
    
    Specified by:
    
    getFirstArea in interface WorldMap
    
    Returns:
    
    the first area
    
    See Also:
    
    WorldMap.getRandomArea()
  - getDefaultParentArea
```
public Area getDefaultParentArea()
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    getDefaultParentArea in interface WorldMap
    
    Returns:
    
    the global parent area
  - getRandomArea
```
public Area getRandomArea()
```
    Description copied from interface: WorldMap
    
    Returns a random area from the world map.
    
    Specified by:
    
    getRandomArea in interface WorldMap
    
    Returns:
    
    a random area
    
    See Also:
    
    WorldMap.getFirstArea()
  - addGlobalHandler
```
public void addGlobalHandler(MsgListener E,
                             int category)
```
    Description copied from interface: WorldMap
    
    Add a listener to the Global Alternative message passing system.
    
    Specified by:
    
    addGlobalHandler in interface WorldMap
    
    Parameters:
    
    E - the message listener for the global message
    
    category - the CMMsg TYP code (CMMsg
    
    See Also:
    
    WorldMap.delGlobalHandler(MsgListener, int), WorldMap.sendGlobalMessage(MOB, int, CMMsg)
  - delGlobalHandler
```
public void delGlobalHandler(MsgListener E,
                             int category)
```
    Description copied from interface: WorldMap
    
    Remove a listener from the Global Alternative message passing system.
    
    Specified by:
    
    delGlobalHandler in interface WorldMap
    
    Parameters:
    
    E - the message listener for the global message
    
    category - the CMMsg TYP code (CMMsg
    
    See Also:
    
    WorldMap.addGlobalHandler(MsgListener, int), WorldMap.sendGlobalMessage(MOB, int, CMMsg)
  - deity
```
public MOB deity()
```
    Description copied from interface: WorldMap
    
    Returns the first available deity, creating one from scratch if necessary.
    
    Specified by:
    
    deity in interface WorldMap
    
    Returns:
    
    a deity
    
    See Also:
    
    Deity, WorldMap.deities(), WorldMap.getDeity(String)
  - getFactoryMOBInAnyRoom
```
public MOB getFactoryMOBInAnyRoom()
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    getFactoryMOBInAnyRoom in interface WorldMap
    
    Returns:
    
    a mob, which you should destroy after use
    
    See Also:
    
    WorldMap.getFactoryMOB(Room)
  - getFactoryMOB
```
public MOB getFactoryMOB(Room R)
```
    Description copied from interface: WorldMap
    
    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).
    
    Specified by:
    
    getFactoryMOB in interface WorldMap
    
    Parameters:
    
    R - the room to put the temporary mob in
    
    Returns:
    
    a mob, which you should destroy after use
    
    See Also:
    
    WorldMap.getFactoryMOBInAnyRoom()
  - createNewExit
```
public java.lang.String createNewExit(Room from,
                                      Room room,
                                      int direction)
```
    Description copied from interface: WorldMap
    
    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!
    
    Specified by:
    
    createNewExit in interface WorldMap
    
    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.
  - numRooms
```
public int numRooms()
```
    Description copied from interface: WorldMap
    
    Returns the sum of all the proper rooms in every area in all the world.
    
    Specified by:
    
    numRooms in interface WorldMap
    
    Returns:
    
    the number of rooms
  - sendGlobalMessage
```
public boolean sendGlobalMessage(MOB host,
                                 int category,
                                 CMMsg msg)
```
    Description copied from interface: WorldMap
    
    Send a message to all relevant listeners in the Global Alternative message passing system.
    
    Specified by:
    
    sendGlobalMessage in interface WorldMap
    
    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:
    
    WorldMap.addGlobalHandler(MsgListener, int), WorldMap.delGlobalHandler(MsgListener, int)
  - getExtendedRoomID
```
public java.lang.String getExtendedRoomID(Room R)
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    getExtendedRoomID in interface WorldMap
    
    Parameters:
    
    R - the room to return a room id for
    
    Returns:
    
    "", or the room id
    
    See Also:
    
    WorldMap.getExtendedRoomID(Room), WorldMap.getExtendedTwinRoomIDs(Room, Room), WorldMap.getDescriptiveExtendedRoomID(Room), WorldMap.getApproximateExtendedRoomID(Room)
  - getDescriptiveExtendedRoomID
```
public java.lang.String getDescriptiveExtendedRoomID(Room room)
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    getDescriptiveExtendedRoomID in interface WorldMap
    
    Parameters:
    
    room - the room to find a descriptive reference to
    
    Returns:
    
    the descriptive extended room id
    
    See Also:
    
    WorldMap.getExtendedRoomID(Room), WorldMap.getExtendedTwinRoomIDs(Room, Room), WorldMap.getApproximateExtendedRoomID(Room)
  - getApproximateExtendedRoomID
```
public java.lang.String getApproximateExtendedRoomID(Room room)
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    getApproximateExtendedRoomID in interface WorldMap
    
    Parameters:
    
    room - the room to find the nearest id for.
    
    Returns:
    
    "" or an approximately located room id
    
    See Also:
    
    WorldMap.getExtendedRoomID(Room), WorldMap.getExtendedTwinRoomIDs(Room, Room), WorldMap.getDescriptiveExtendedRoomID(Room)
  - getExtendedTwinRoomIDs
```
public java.lang.String getExtendedTwinRoomIDs(Room R1,
                                               Room R2)
```
    Description copied from interface: WorldMap
    
    Returns the extended room IDs of both the given rooms, in a deterministic ordering, with an underscore between them -- nothing else.
    
    Specified by:
    
    getExtendedTwinRoomIDs in interface WorldMap
    
    Parameters:
    
    R1 - the first room
    
    R2 - the second room
    
    Returns:
    
    the pair of rooms ids in one string
    
    See Also:
    
    WorldMap.getExtendedRoomID(Room), WorldMap.getDescriptiveExtendedRoomID(Room), WorldMap.getApproximateExtendedRoomID(Room)
  - findRoomIDArea
```
public Area findRoomIDArea(java.lang.String roomID)
```
    Description copied from interface: WorldMap
    
    Given a room ID, this will return the area to which the room it matches belongs.
    
    Specified by:
    
    findRoomIDArea in interface WorldMap
    
    Parameters:
    
    roomID - the room id to get the area for
    
    Returns:
    
    null, or the area the room belongs to
  - getRoom
```
protected Room getRoom(java.util.Enumeration<Room> roomSet,
                       java.lang.String roomID,
                       boolean cachedOnly)
```
  - getRoom
```
public Room getRoom(java.util.Enumeration<Room> roomSet,
                    java.lang.String roomID)
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    getRoom in interface WorldMap
    
    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:
    
    WorldMap.getRoom(Room), WorldMap.getRoom(String), WorldMap.getCachedRoom(String), WorldMap.getRoomAllHosts(String)
  - getRoom
```
public Room getRoom(Room room)
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    getRoom in interface WorldMap
    
    Parameters:
    
    room - the room that may or may not be expired
    
    Returns:
    
    the given room, or its replacement
    
    See Also:
    
    WorldMap.getRoom(String), WorldMap.getRoom(Enumeration, String), WorldMap.getCachedRoom(String), WorldMap.getRoomAllHosts(String)
  - getRoom
```
public Room getRoom(java.lang.String roomID)
```
    Description copied from interface: WorldMap
    
    Given a room ID, this will return the room on the map that matches this room id.
    
    Specified by:
    
    getRoom in interface WorldMap
    
    Parameters:
    
    roomID - the room id to get the room for
    
    Returns:
    
    null, or the room if found.
    
    See Also:
    
    WorldMap.getRoom(Room), WorldMap.getRoom(Enumeration, String), WorldMap.getCachedRoom(String), WorldMap.getRoomAllHosts(String)
  - getCachedRoom
```
public Room getCachedRoom(java.lang.String roomID)
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    getCachedRoom in interface WorldMap
    
    Parameters:
    
    roomID - the room ID to get
    
    Returns:
    
    null, or the room from the map
    
    See Also:
    
    WorldMap.getRoom(Room), WorldMap.getRoom(String), WorldMap.getRoom(Enumeration, String), WorldMap.getCachedRoom(String), WorldMap.getRoomAllHosts(String)
  - getRoomAllHosts
```
public Room getRoomAllHosts(java.lang.String roomID)
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    getRoomAllHosts in interface WorldMap
    
    Parameters:
    
    roomID - the room ID to get
    
    Returns:
    
    null, or the room from the map
    
    See Also:
    
    WorldMap.getRoom(Room), WorldMap.getRoom(String), WorldMap.getRoom(Enumeration, String), WorldMap.getCachedRoom(String)
  - rooms
```
public java.util.Enumeration<Room> rooms()
```
    Description copied from interface: WorldMap
    
    Returns an enumeration of every CACHED proper room in every area, including 'filled' proper rooms, which also includes ships and similar areas.
    
    Specified by:
    
    rooms in interface WorldMap
    
    Returns:
    
    the enumeration of all the cached proper rooms
    
    See Also:
    
    WorldMap.roomsFilled()
  - roomsFilled
```
public java.util.Enumeration<Room> roomsFilled()
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    roomsFilled in interface WorldMap
    
    Returns:
    
    the enumeration of all the cached rooms
    
    See Also:
    
    WorldMap.rooms()
  - worldMobs
```
public java.util.Enumeration<MOB> worldMobs()
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    worldMobs in interface WorldMap
    
    Returns:
    
    the enumeration of all the mobs
    
    See Also:
    
    WorldMap.worldEveryItems(), WorldMap.worldRoomItems()
  - worldRoomItems
```
public java.util.Enumeration<Item> worldRoomItems()
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    worldRoomItems in interface WorldMap
    
    Returns:
    
    the enumeration of all the items
    
    See Also:
    
    WorldMap.worldEveryItems(), WorldMap.worldMobs()
  - worldEveryItems
```
public java.util.Enumeration<Item> worldEveryItems()
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    worldEveryItems in interface WorldMap
    
    Returns:
    
    the enumeration of all the items
    
    See Also:
    
    WorldMap.worldEveryItems(), WorldMap.worldMobs()
  - getRandomRoom
```
public Room getRandomRoom()
```
    Description copied from interface: WorldMap
    
    Returns a random room from a random area on the map. Just for fun -- typically for temporary mobs.
    
    Specified by:
    
    getRandomRoom in interface WorldMap
    
    Returns:
    
    a random cached room from the map
  - numDeities
```
public int numDeities()
```
  - addDeity
```
protected void addDeity(Deity newOne)
```
  - delDeity
```
protected void delDeity(Deity oneToDel)
```
  - getDeity
```
public Deity getDeity(java.lang.String calledThis)
```
    Description copied from interface: WorldMap
    
    Returns the world deity of the given name, if it exists.
    
    Specified by:
    
    getDeity in interface WorldMap
    
    Parameters:
    
    calledThis - the name of the deity to get.
    
    Returns:
    
    null, or the deity object found
    
    See Also:
    
    Deity, WorldMap.deities(), WorldMap.deity()
  - deities
```
public java.util.Enumeration<Deity> deities()
```
    Description copied from interface: WorldMap
    
    Returns an enumeration of all the Deity-derived registered objects in the game.
    
    Specified by:
    
    deities in interface WorldMap
    
    Returns:
    
    all the deities
    
    See Also:
    
    Deity, WorldMap.deity(), WorldMap.getDeity(String)
  - numShips
```
public int numShips()
```
    Description copied from interface: WorldMap
    
    Returns the number of registered boardables, such as sailing ships, space ships, castles, and caravans.
    
    Specified by:
    
    numShips in interface WorldMap
    
    Returns:
    
    the number of registered boardables
    
    See Also:
    
    WorldMap.getShip(String), WorldMap.findShip(String, boolean), WorldMap.ships(), WorldMap.shipsRoomEnumerator(Area), WorldMap.numShips()
  - addShip
```
protected void addShip(Boardable newOne)
```
  - delShip
```
protected void delShip(Boardable oneToDel)
```
  - getShip
```
public Boardable getShip(java.lang.String calledThis)
```
    Description copied from interface: WorldMap
    
    Checks the list of existing registered boardables, such as sailing ships, space ships, castles, and caravans. It returns the exact matching named boardable.
    
    Specified by:
    
    getShip in interface WorldMap
    
    Parameters:
    
    calledThis - the name of the boardable
    
    Returns:
    
    the boardable found, or null
    
    See Also:
    
    WorldMap.findShip(String, boolean), WorldMap.ships(), WorldMap.shipsRoomEnumerator(Area), WorldMap.numShips()
  - findShip
```
public Boardable findShip(java.lang.String s,
                          boolean exactOnly)
```
    Description copied from interface: WorldMap
    
    Searches the list of existing registered boardables, such as sailing ships, space ships, castles, and caravans. It returns the first one found.
    
    Specified by:
    
    findShip in interface WorldMap
    
    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:
    
    WorldMap.getShip(String), WorldMap.ships(), WorldMap.shipsRoomEnumerator(Area), WorldMap.numShips()
  - ships
```
public java.util.Enumeration<Boardable> ships()
```
    Description copied from interface: WorldMap
    
    Returns an enumeration of all registered boardables, such as sailing ships, space ships, castles, and caravans.
    
    Specified by:
    
    ships in interface WorldMap
    
    Returns:
    
    the enumeration of existing boardables
    
    See Also:
    
    WorldMap.getShip(String), WorldMap.findShip(String, boolean), WorldMap.shipsRoomEnumerator(Area), WorldMap.numShips()
  - shipsRoomEnumerator
```
public java.util.Enumeration<Room> shipsRoomEnumerator(Area inA)
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    shipsRoomEnumerator in interface WorldMap
    
    Parameters:
    
    inA - the area containing a ship, possibly
    
    Returns:
    
    the boardable rooms enumerator
    
    See Also:
    
    WorldMap.getShip(String), WorldMap.findShip(String, boolean), WorldMap.ships(), WorldMap.numShips()
  - shipAreaEnumerator
```
public java.util.Enumeration<Area> shipAreaEnumerator(Area inA)
```
  - renameRooms
```
public void renameRooms(Area A,
                        java.lang.String oldName,
                        java.util.List<Room> allMyDamnRooms)
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    renameRooms in interface WorldMap
    
    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:
    
    WorldMap.renamedArea(Area)
  - getRoomDir
```
public int getRoomDir(Room from,
                      Room to)
```
    Description copied from interface: WorldMap
    
    Given a room and a target room, this will return which direction code is being used.
    
    Specified by:
    
    getRoomDir in interface WorldMap
    
    Parameters:
    
    from - the initial room
    
    to - the room being target
    
    Returns:
    
    the direction code from the from room to the target
    
    See Also:
    
    Directions, WorldMap.getTargetArea(Room, Exit), WorldMap.getTargetRoom(Room, Exit), WorldMap.getExitDir(Room, Exit)
  - getTargetArea
```
public Area getTargetArea(Room from,
                          Exit to)
```
    Description copied from interface: WorldMap
    
    Given a room and an exit, this will return which area it will lead to.
    
    Specified by:
    
    getTargetArea in interface WorldMap
    
    Parameters:
    
    from - the initial room
    
    to - the exit being used
    
    Returns:
    
    the area it leads to, or null
    
    See Also:
    
    WorldMap.getTargetRoom(Room, Exit), WorldMap.getRoomDir(Room, Room), WorldMap.getExitDir(Room, Exit)
  - getTargetRoom
```
public Room getTargetRoom(Room from,
                          Exit to)
```
    Description copied from interface: WorldMap
    
    Given a room and an exit, this will return which room it will lead to.
    
    Specified by:
    
    getTargetRoom in interface WorldMap
    
    Parameters:
    
    from - the initial room
    
    to - the exit being used
    
    Returns:
    
    the room it leads to, or null
    
    See Also:
    
    WorldMap.getTargetArea(Room, Exit), WorldMap.getRoomDir(Room, Room), WorldMap.getExitDir(Room, Exit)
  - getExitDir
```
public int getExitDir(Room from,
                      Exit to)
```
    Description copied from interface: WorldMap
    
    Given a room and an exit, this will return which direction code is being used.
    
    Specified by:
    
    getExitDir in interface WorldMap
    
    Parameters:
    
    from - the initial room
    
    to - the exit being used
    
    Returns:
    
    the direction code
    
    See Also:
    
    Directions, WorldMap.getTargetArea(Room, Exit), WorldMap.getTargetRoom(Room, Exit), WorldMap.getRoomDir(Room, Room)
  - findConnectingRoom
```
public Room findConnectingRoom(Room room)
```
    Description copied from interface: WorldMap
    
    Returns a room that is connected to, and preferably links back, to the given room. This can include skys, and might prefer them.
    
    Specified by:
    
    findConnectingRoom in interface WorldMap
    
    Parameters:
    
    room - the room to look at exits from
    
    Returns:
    
    a connecting room
  - isClearableRoom
```
public boolean isClearableRoom(Room R)
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    isClearableRoom in interface WorldMap
    
    Parameters:
    
    R - the room to clear/check.
    
    Returns:
    
    true if the room is ready to be cleared, false otherwise
  - obliterateMapRoom
```
public void obliterateMapRoom(Room deadRoom)
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    obliterateMapRoom in interface WorldMap
    
    Parameters:
    
    deadRoom - the room to remove from the map
    
    See Also:
    
    WorldMap.destroyRoomObject(Room), WorldMap.obliterateMapArea(Area)
  - destroyRoomObject
```
public void destroyRoomObject(Room deadRoom)
```
    Description copied from interface: WorldMap
    
    Removes the given room from the map, clears it, and deletes any incoming exits. Does not affect the DB.
    
    Specified by:
    
    destroyRoomObject in interface WorldMap
    
    Parameters:
    
    deadRoom - the room to remove from the map
    
    See Also:
    
    WorldMap.obliterateMapRoom(Room), WorldMap.destroyAreaObject(Area)
  - obliterateRoom
```
protected void obliterateRoom(Room deadRoom,
                              java.util.List<Room> linkInRooms,
                              boolean includeDB)
```
  - emptyAreaAndDestroyRooms
```
public void emptyAreaAndDestroyRooms(Area area)
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    emptyAreaAndDestroyRooms in interface WorldMap
    
    Parameters:
    
    area - the area to empty
  - roomLocation
```
public Room roomLocation(Environmental E)
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    roomLocation in interface WorldMap
    
    Parameters:
    
    E - the game object whose room location you are curious about
    
    Returns:
    
    null, or the room that the object is in
  - getStartArea
```
public Area getStartArea(Environmental E)
```
    Description copied from interface: WorldMap
    
    Attempts to return the start/orig area for the given mob or item or room or whatever.
    
    Specified by:
    
    getStartArea in interface WorldMap
    
    Parameters:
    
    E - the object to get a start area for
    
    Returns:
    
    the start area, or the area its in
  - getStartRoom
```
public Room getStartRoom(Environmental E)
```
    Description copied from interface: WorldMap
    
    Attempts to return the start/orig room for the given mob or item or room or whatever.
    
    Specified by:
    
    getStartRoom in interface WorldMap
    
    Parameters:
    
    E - the object to get a start room for
    
    Returns:
    
    the start room, or the area its in
  - areaLocation
```
public Area areaLocation(CMObject E)
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    areaLocation in interface WorldMap
    
    Parameters:
    
    E - the game object whose area location you are curious about
    
    Returns:
    
    null, or the area that the object is in
  - getSafeRoomToMovePropertyTo
```
public Room getSafeRoomToMovePropertyTo(Room room,
                                        PrivateProperty I)
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    getSafeRoomToMovePropertyTo in interface WorldMap
    
    Parameters:
    
    room - the room that needs moving FROM
    
    I - null, or private property that needs moving
    
    Returns:
    
    a room thats not the given one
  - emptyRoom
```
public void emptyRoom(Room room,
                      Room toRoom,
                      boolean clearPlayers)
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    emptyRoom in interface WorldMap
    
    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
  - obliterateMapArea
```
public void obliterateMapArea(Area A)
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    obliterateMapArea in interface WorldMap
    
    Parameters:
    
    A - the area to obliterate
    
    See Also:
    
    WorldMap.destroyAreaObject(Area)
  - destroyAreaObject
```
public void destroyAreaObject(Area A)
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    destroyAreaObject in interface WorldMap
    
    Parameters:
    
    A - the area to destroy
    
    See Also:
    
    WorldMap.obliterateMapArea(Area)
  - obliterateArea
```
protected void obliterateArea(Area A,
                              boolean includeDB)
```
  - resetRoom
```
public void resetRoom(Room room)
```
    Description copied from interface: WorldMap
    
    Resets the contents of the given room to stock, without clearing grid rooms.
    
    Specified by:
    
    resetRoom in interface WorldMap
    
    Parameters:
    
    room - the room whose content to reset
  - resetRoom
```
public void resetRoom(Room room,
                      boolean rebuildGrids)
```
    Description copied from interface: WorldMap
    
    Resets the contents of the given room to stock, clearing any grids if necessary.
    
    Specified by:
    
    resetRoom in interface WorldMap
    
    Parameters:
    
    room - the room whose content to reset
    
    rebuildGrids - true to also clear and rebuild grids, or false otherwise
  - getAllPlayersHere
```
protected PairVector<MOB,java.lang.String> getAllPlayersHere(Area area,
                                                             boolean includeLocalFollowers)
```
  - resetArea
```
public void resetArea(Area area)
```
    Description copied from interface: WorldMap
    
    Resets the given area by resetting all the cached rooms in it.
    
    Specified by:
    
    resetArea in interface WorldMap
    
    Parameters:
    
    area - the area to reset.
  - hasASky
```
public boolean hasASky(Room room)
```
    Description copied from interface: WorldMap
    
    Returns whether the given room might have a sky, due to being outdoors but not being underwater.
    
    Specified by:
    
    hasASky in interface WorldMap
    
    Parameters:
    
    room - the room to check
    
    Returns:
    
    true if a sky would be appropriate, false otherwise
  - registerWorldObjectDestroyed
```
public void registerWorldObjectDestroyed(Area area,
                                         Room room,
                                         CMObject o)
```
    Description copied from interface: WorldMap
    
    When a map object is permanently destroyed, this method is called to give the world map manager a chance to remove tracking for it.
    
    Specified by:
    
    registerWorldObjectDestroyed in interface WorldMap
    
    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:
    
    WorldMap.registerWorldObjectLoaded(Area, Room, CMObject)
  - registerWorldObjectLoaded
```
public void registerWorldObjectLoaded(Area area,
                                      Room room,
                                      CMObject o)
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    registerWorldObjectLoaded in interface WorldMap
    
    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:
    
    WorldMap.registerWorldObjectDestroyed(Area, Room, CMObject)
  - cleanScriptHosts
```
protected void cleanScriptHosts(SLinkedList<WorldMap.LocatedPair> hosts,
                                PhysicalAgent oneToDel,
                                boolean fullCleaning)
```
  - isAQualifyingScriptHost
```
protected boolean isAQualifyingScriptHost(PhysicalAgent host)
```
  - isAScriptHost
```
protected boolean isAScriptHost(Area area,
                                PhysicalAgent host)
```
  - isAScriptHost
```
protected boolean isAScriptHost(SLinkedList<WorldMap.LocatedPair> hosts,
                                PhysicalAgent host)
```
  - getScriptHostSemaphore
```
protected final java.lang.Object getScriptHostSemaphore(Area area)
```
  - addScriptHost
```
protected void addScriptHost(Area area,
                             Room room,
                             PhysicalAgent host)
```
  - delScriptHost
```
protected void delScriptHost(Area area,
                             PhysicalAgent oneToDel)
```
  - scriptHosts
```
public java.util.Enumeration<WorldMap.LocatedPair> scriptHosts(Area area)
```
    Description copied from interface: WorldMap
    
    Returns an enumeration of all objects scripted upon creation in the world, or in the given area (non-metro).
    
    Specified by:
    
    scriptHosts in interface WorldMap
    
    Parameters:
    
    area - null, or the area to limit returns to
    
    Returns:
    
    an enumeration of the scripted objects
    
    See Also:
    
    WorldMap.LocatedPair.room()
  - activate
```
public boolean activate()
```
    Description copied from interface: CMLibrary
    
    Activates the library. This is called after the mud is booted, but before connections are accepted.
    
    Specified by:
    
    activate in interface CMLibrary
    
    Overrides:
    
    activate in class StdLibrary
    
    Returns:
    
    true if activation was successful, false if you're screwed
    
    See Also:
    
    CMLibrary.shutdown()
  - tick
```
public boolean tick(Tickable ticking,
                    int tickID)
```
    Description copied from interface: Tickable
    
    this is the method which is called periodically by the threading engine. How often it is called depends on the parameters passed to the threadding engine when it is submitted for thread access. Typically the period is once per TIME_TICK period, but that is determined when the object is submitted to the thread engine.
    
    Specified by:
    
    tick in interface Tickable
    
    Overrides:
    
    tick in class StdLibrary
    
    Parameters:
    
    ticking - a reference to this Tickable object
    
    tickID - the TICKID_ constant describing this periodic call, as defined in Tickable
    
    Returns:
    
    true always, unless this object no longer wishes to ever tick again, in which case false
    
    See Also:
    
    Tickable, ServiceEngine, TickableGroup
  - shutdown
```
public boolean shutdown()
```
    Description copied from interface: CMLibrary
    
    Shuts down the library. Called at system shutdown time obviously, but is sometimes called just to reset the library.
    
    Specified by:
    
    shutdown in interface CMLibrary
    
    Overrides:
    
    shutdown in class StdLibrary
    
    Returns:
    
    true if shutdown was successful, false if there's nothing you can do about it
    
    See Also:
    
    CMLibrary.activate()
  - roomMaintSweep
```
public void roomMaintSweep()
```
  - cmfsFilenameify
```
protected java.lang.String cmfsFilenameify(java.lang.String str)
```
  - addMapStatFiles
```
protected void addMapStatFiles(java.util.List<CMFile.CMVFSFile> rootFiles,
                               Room R,
                               Environmental E,
                               CMFile.CMVFSDir root)
```
  - getMapRoot
```
public CMFile.CMVFSDir getMapRoot(CMFile.CMVFSDir root)
```
    Description copied from interface: WorldMap
    
    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.
    
    Specified by:
    
    getMapRoot in interface WorldMap
    
    Parameters:
    
    root - the root directory to add the map directory to
    
    Returns:
    
    the fake VFS map directory

Class CMMap

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.WorldMap

Field Summary

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

Fields inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

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

Fields inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.WorldMap

Constructor Summary

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

Methods inherited from class java.lang.Object

Methods inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

Field Detail

deityStandIn

lastVReset

areasList

deitiesList

shipList

SCRIPT_HOST_SEMAPHORES

clockCache

areaComparator

globalHandlers

scriptHostMap

resetMsg

cmfsFilenameifyChars

Constructor Detail

CMMap

Method Detail

ID

getGlobalIndex

renamedArea

numAreas

addArea

delArea

getClockCache

getModelArea

getAreaFinder

getArea

findAreaStartsWith

findArea

areas

areasPlusShips

mundaneAreas

topAreas

roomIDs

getFirstArea

getDefaultParentArea

getRandomArea

addGlobalHandler

delGlobalHandler

deity

getFactoryMOBInAnyRoom

getFactoryMOB

createNewExit

numRooms

sendGlobalMessage

getExtendedRoomID

getDescriptiveExtendedRoomID

getApproximateExtendedRoomID

getExtendedTwinRoomIDs

findRoomIDArea

getRoom

getRoom

getRoom

getRoom

getCachedRoom

getRoomAllHosts

rooms

roomsFilled

worldMobs

worldRoomItems

worldEveryItems

getRandomRoom

numDeities

addDeity

delDeity

getDeity