com.planet_ink.coffee_mud.Items.Basic
Class StdMap

java.lang.Object
  com.planet_ink.coffee_mud.Items.Basic.StdItem
      com.planet_ink.coffee_mud.Items.Basic.StdMap

All Implemented Interfaces:

Affectable, Behavable, CMObject, Contingent, DBIdentifiable, Environmental, Modifiable, MsgListener, Physical, PhysicalAgent, Readable, Rider, StatsAffecting, Tickable, Item, RoomMap, Wearable, java.lang.Cloneable, java.lang.Comparable<CMObject>

Direct Known Subclasses:

GenMap

public class StdMap
extends StdItem
implements RoomMap

Nested Class Summary

protected static class

StdMap.MapRoom

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Wearable

Wearable.CODES

Field Summary

static int	CLUSTERSIZE
protected int	oldLevel

Fields inherited from class com.planet_ink.coffee_mud.Items.Basic.StdItem

affects, baseGoldValue, basePhyStats, behaviors, cachedImageName, CODES, databaseID, description, destroyed, displayText, dispossessionTime, material, miscText, myContainer, myUses, myWornCode, name, owner, phyStats, properWornBitmap, rawImageName, riding, scripts, secretIdentity, tickStatus, wornLogicalAnd, xtraValues

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_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_EMAIL, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MOB, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SPELL_AFFECT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET, TICKMASK_SOLITARY

Fields inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Wearable

DEFAULT_WORN_CODES, DEFAULT_WORN_DEPENDENCYGRID, DEFAULT_WORN_DESCS, DEFAULT_WORN_ORDER, DEFAULT_WORN_WEIGHT_POINTS, DEFAULT_WORN_WEIGHTS, FILTER_ANY, FILTER_UNWORNONLY, FILTER_WORNONLY, HIGHEST_WORN_CODE, IN_INVENTORY, WORN_ABOUT_BODY, WORN_ARMS, WORN_BACK, WORN_EARS, WORN_EYES, WORN_FEET, WORN_FLOATING_NEARBY, WORN_HANDS, WORN_HEAD, WORN_HELD, WORN_LEFT_FINGER, WORN_LEFT_WRIST, WORN_LEGS, WORN_MOUTH, WORN_NECK, WORN_RIGHT_FINGER, WORN_RIGHT_WRIST, WORN_TORSO, WORN_WAIST, WORN_WIELD

Constructor Summary

StdMap()

Method Summary

boolean	anythingThatDirection(StdMap.MapRoom room, int direction)
void	clearTheSkys(java.util.Hashtable mapRooms)
char	dirChar(int dirCode, StdMap.MapRoom[][] grid, int x, int y, char wall)
void	doMapArea()
void	executeMsg(Environmental myHost, CMMsg msg) The general message event handler for the object.
void	findEmptyCluster(java.util.Hashtable processed, java.util.Vector XY)
java.lang.StringBuffer[][]	finishMapMaking(int width)
java.lang.String	getMapArea()
java.lang.StringBuffer[][]	getMyMappedRoom(int width)
StdMap.MapRoom	getProcessedRoomAt(java.util.Hashtable processed, int x, int y)
StdMap.MapRoom	getRoom(java.util.Hashtable allRooms, Room droom)
java.lang.String	ID() The CoffeeMud Java Class ID shared by all instances of this object.
boolean	isEmptyCluster(java.util.Hashtable processed, int x, int y)
java.util.Hashtable	makeMapRooms(int width)
boolean	okToPlace(StdMap.MapRoom room)
boolean	okToPlace(StdMap.MapRoom room, Exit exit)
void	placeRoom(StdMap.MapRoom room, java.util.Hashtable areaMap, int favoredX, int favoredY, java.util.Hashtable processed, boolean doNotDefer, boolean passTwo, int depth)
void	placeRooms(java.util.Hashtable areaMap)
StdMap.MapRoom[][]	rebuildGrid(java.util.Hashtable areaMap)
void	setMapArea(java.lang.String mapName)
void	setMiscText(java.lang.String newText) For objects which have false for their isGeneric method, this is used to set any internally coded strings to change the nature or behavior of the object.

Methods inherited from class com.planet_ink.coffee_mud.Items.Basic.StdItem

abilityImbuesMagic, addBehavior, addEffect, addNonUninvokableEffect, addScript, affectCharState, affectCharStats, affectPhyStats, alreadyWornMsg, amDestroyed, amWearingAt, baseGoldValue, basePhyStats, behaviors, canSaveDatabaseID, canWear, canWearComplete, cloneFix, compareProperLocations, compareTo, container, copyOf, databaseID, delBehavior, delEffect, delScript, description, destroy, displayText, effects, expirationDate, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchScript, fitsOn, getCodeNum, getSaveStatIndex, getStat, getStatCodes, getTickStatus, image, initializeClass, isGeneric, isReadable, isSavable, isStat, material, maxRange, minRange, miscTextFormat, name, Name, newInstance, numBehaviors, numberOfItems, numEffects, numScripts, okMessage, owner, phyStats, rawImage, rawLogicalAnd, rawProperLocationBitmap, rawSecretIdentity, rawWornCode, readableText, recoverPhyStats, recursiveWeight, removeFromOwnerContainer, riding, sameAs, scripts, secretIdentity, setBasePhyStats, setBaseValue, setContainer, setDatabaseID, setDescription, setDisplayText, setExpirationDate, setImage, setMaterial, setName, setOwner, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setReadable, setReadableText, setRiding, setSavable, setSecretIdentity, setStat, setUsesRemaining, stopTicking, subjectToWearAndTear, tackOns, text, tick, ultimateContainer, unWear, usesRemaining, value, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWear

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Item

baseGoldValue, container, material, numberOfItems, owner, rawSecretIdentity, recursiveWeight, removeFromOwnerContainer, secretIdentity, setBaseValue, setContainer, setMaterial, setOwner, setSecretIdentity, setUsesRemaining, stopTicking, subjectToWearAndTear, ultimateContainer, usesRemaining, value

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

riding, setRiding

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

description, displayText, expirationDate, image, isGeneric, maxRange, minRange, miscTextFormat, name, Name, rawImage, sameAs, setDescription, setDisplayText, setExpirationDate, setImage, setName, text

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

getTickStatus, tick

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

affectCharState, affectCharStats, affectPhyStats

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

okMessage

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

amDestroyed, destroy, isSavable, setSavable

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

copyOf, initializeClass, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

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

getSaveStatIndex, getStat, getStatCodes, isStat, setStat

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

addEffect, addNonUninvokableEffect, basePhyStats, delEffect, effects, fetchEffect, fetchEffect, numEffects, phyStats, recoverPhyStats, setBasePhyStats

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

addBehavior, addScript, behaviors, delBehavior, delScript, fetchBehavior, fetchBehavior, fetchScript, numBehaviors, numScripts, scripts

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

canSaveDatabaseID, databaseID, setDatabaseID

Methods inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Wearable

amWearingAt, canWear, compareProperLocations, fitsOn, rawLogicalAnd, rawProperLocationBitmap, rawWornCode, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, unWear, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWear

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

isReadable, readableText, setReadable, setReadableText

Field Detail

oldLevel

protected int oldLevel

CLUSTERSIZE

public static final int CLUSTERSIZE

See Also:

Constant Field Values

Constructor Detail

StdMap

public StdMap()

Method Detail

ID

public java.lang.String ID()

Description copied from interface: CMObject

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

Specified by:

ID in interface CMObject

Overrides:

ID in class StdItem

Returns:

the name of this class

getMapArea

public java.lang.String getMapArea()

Specified by:

getMapArea in interface RoomMap

setMapArea

public void setMapArea(java.lang.String mapName)

Specified by:

setMapArea in interface RoomMap

setMiscText

public void setMiscText(java.lang.String newText)

Description copied from interface: Environmental

For objects which have false for their isGeneric method, this is used to set any internally coded strings to change the nature or behavior of the object. For objects which have true for their isGeneric method, this is used to set and parse the XML which will be used to fill out the fields in this object. Since Ability objects are never Generic, this will always be where parameters are read from an Ability instance.

Specified by:

setMiscText in interface Environmental

Overrides:

setMiscText in class StdItem

Parameters:

newText - either an open internal text string, or XML

doMapArea

public void doMapArea()

Specified by:

doMapArea in interface RoomMap

rebuildGrid

public StdMap.MapRoom[][] rebuildGrid(java.util.Hashtable areaMap)

clearTheSkys

public void clearTheSkys(java.util.Hashtable mapRooms)

makeMapRooms

public java.util.Hashtable makeMapRooms(int width)

finishMapMaking

public java.lang.StringBuffer[][] finishMapMaking(int width)

getMyMappedRoom

public java.lang.StringBuffer[][] getMyMappedRoom(int width)

dirChar

public char dirChar(int dirCode,
                    StdMap.MapRoom[][] grid,
                    int x,
                    int y,
                    char wall)

getProcessedRoomAt

public StdMap.MapRoom getProcessedRoomAt(java.util.Hashtable processed,
                                         int x,
                                         int y)

getRoom

public StdMap.MapRoom getRoom(java.util.Hashtable allRooms,
                              Room droom)

isEmptyCluster

public boolean isEmptyCluster(java.util.Hashtable processed,
                              int x,
                              int y)

findEmptyCluster

public void findEmptyCluster(java.util.Hashtable processed,
                             java.util.Vector XY)

anythingThatDirection

public boolean anythingThatDirection(StdMap.MapRoom room,
                                     int direction)

okToPlace

public boolean okToPlace(StdMap.MapRoom room)

okToPlace

public boolean okToPlace(StdMap.MapRoom room,
                         Exit exit)

placeRooms

public void placeRooms(java.util.Hashtable areaMap)

executeMsg

public void executeMsg(Environmental myHost,
                       CMMsg msg)

Description copied from interface: MsgListener

The general message event handler for the object. Messages passed herein may not necessarily be FOR this object, or from it, but will almost always represent events happening in the same room. The messages have already been through an approval process, so this method is called only to affect the final execution of the meaning of the message. Every game event goes through these methods.

Specified by:

executeMsg in interface MsgListener

Overrides:

executeMsg in class StdItem

Parameters:

myHost - either the initiator of the event, or the host of this object

msg - the CMMsg that needs to be executed

See Also:

CMMsg

placeRoom

public void placeRoom(StdMap.MapRoom room,
                      java.util.Hashtable areaMap,
                      int favoredX,
                      int favoredY,
                      java.util.Hashtable processed,
                      boolean doNotDefer,
                      boolean passTwo,
                      int depth)