Package 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, Expireable, 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

Nested Classes

Modifier and Type	Class	Description
protected static class	StdMap.MapRoom

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

Wearable.CODES

Field Summary

Fields

Modifier and Type	Field	Description
static int	CLUSTERSIZE
protected int	oldLevel

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

idConverter

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

_name, affectPhyStats, affects, baseGoldValue, basePhyStats, behaviors, cachedImageName, CODES, databaseID, description, destroyed, displayText, dispossessionTime, material, me, miscText, myContainer, myUses, myWornCode, owner, phyStats, properWornBitmap, rawImageName, riding, scripts, secretIdentity, tickCtr, 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_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.Items.interfaces.Wearable

DEFAULT_WORN_CODES, DEFAULT_WORN_DEPENDENCYGRID, DEFAULT_WORN_DESCS, DEFAULT_WORN_ORDER, DEFAULT_WORN_USUAL_NAMES, DEFAULT_WORN_WEIGHT_POINTS, DEFAULT_WORN_WEIGHTS, FILTER_ANY, FILTER_MOBINVONLY, FILTER_ROOMONLY, 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

Constructors

Constructor	Description
StdMap()

Method Summary

Modifier and Type	Method	Description
boolean	anythingThatDirection(StdMap.MapRoom room, int direction)
void	clearTheSkys(java.util.Hashtable<Room,StdMap.MapRoom> mapRooms)
char	dirChar(int dirCode, StdMap.MapRoom[][] grid, int x, int y, char wall)
void	doMapArea()	Causes the area(s) to be re-mapped.
void	executeMsg(Environmental myHost, CMMsg msg)	The general message event handler for the object.
void	findEmptyCluster(java.util.Map<Room,StdMap.MapRoom> processed, java.util.List<java.lang.Integer> XY)
java.lang.StringBuffer[][]	finishMapMaking(int width)
java.lang.String	genericName()	Returns a generic name for this object, devoid of its particular identifying details.
java.lang.String	getMapArea()	Gets the name(s) of the area(s) being mapped, semicolon delimited.
java.lang.StringBuffer[][]	getMyMappedRoom(int width)
StdMap.MapRoom	getProcessedRoomAt(java.util.Map<Room,StdMap.MapRoom> processed, int x, int y)
StdMap.MapRoom	getRoom(java.util.Map<Room,StdMap.MapRoom> allRooms, Room droom)
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
boolean	isEmptyCluster(java.util.Map<Room,StdMap.MapRoom> processed, int x, int y)
java.util.Hashtable<Room,StdMap.MapRoom>	makeMapRooms(int width)
boolean	okToPlace(StdMap.MapRoom room)
boolean	okToPlace(StdMap.MapRoom room, Exit exit)
void	placeRoom(StdMap.MapRoom room, java.util.Map<Room,StdMap.MapRoom> areaMap, int favoredX, int favoredY, java.util.Map<Room,StdMap.MapRoom> processed, boolean doNotDefer, boolean passTwo, int depth)
void	placeRooms(java.util.Map<Room,StdMap.MapRoom> areaMap)
StdMap.MapRoom[][]	rebuildGrid(java.util.Hashtable<Room,StdMap.MapRoom> areaMap)
void	setMapArea(java.lang.String mapName)	Sets the name(s) of the area(s) being mapped, semicolon delimited.
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 interface com.planet_ink.coffee_mud.core.interfaces.Affectable

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

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

addBehavior, addScript, behaviors, delAllBehaviors, delAllScripts, delBehavior, delScript, eachBehavior, eachScript, fetchBehavior, fetchBehavior, fetchScript, numBehaviors, numScripts, scripts

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.Contingent

amDestroyed, destroy, isSavable, setSavable

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

canSaveDatabaseID, databaseID, setDatabaseID

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

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

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

expirationDate, setExpirationDate

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.Modifiable

getSaveStatIndex, getStat, getStatCodes, isStat, setStat

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

okMessage

Methods inherited from class java.lang.Object

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

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

description, displayText, name

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

isReadable, readableText, setReadable, setReadableText

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.StatsAffecting

affectCharState, affectCharStats, affectPhyStats

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

abilityImbuesMagic, addBehavior, addEffect, addNonUninvokableEffect, addScript, affectCharState, affectCharStats, affectPhyStats, alreadyWornMsg, amBeingWornProperly, amDestroyed, amWearingAt, baseGoldValue, basePhyStats, behaviors, canSaveDatabaseID, canWear, canWearComplete, cloneFix, compareProperLocations, compareTo, container, copyOf, databaseID, delAllBehaviors, delAllEffects, delAllScripts, delBehavior, delEffect, delScript, description, description, destroy, displayText, displayText, eachBehavior, eachEffect, eachScript, effects, expirationDate, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchScript, fitsOn, getSaveStatIndex, getStat, getStatCodes, getTickStatus, I, image, initializeClass, isGeneric, isReadable, isSavable, isStat, L, material, maxRange, minRange, miscTextFormat, name, 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 interface com.planet_ink.coffee_mud.core.interfaces.Tickable

getTickStatus, name, tick

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

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

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, Tech. 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

genericName

public java.lang.String genericName()

Description copied from interface: Physical

Returns a generic name for this object, devoid of its particular identifying details. e.g. for a mob, this would return the age-range and race of this mob, as if it were someone spotted on the street that you didn't know.

Specified by:

genericName in interface Physical

Overrides:

genericName in class StdItem

Returns:

the generic name of this thing

getMapArea

public java.lang.String getMapArea()

Description copied from interface: RoomMap

Gets the name(s) of the area(s) being mapped, semicolon delimited.

Specified by:

getMapArea in interface RoomMap

Returns:

the name(s) of the area(s) being mapped

See Also:

RoomMap.setMapArea(String)

setMapArea

public void setMapArea(java.lang.String mapName)

Description copied from interface: RoomMap

Sets the name(s) of the area(s) being mapped, semicolon delimited.

Specified by:

setMapArea in interface RoomMap

Parameters:

mapName - the name(s) of the area(s) being mapped

See Also:

RoomMap.getMapArea()

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()

Description copied from interface: RoomMap

Causes the area(s) to be re-mapped. Area name(s) must have been set before calling.

Specified by:

doMapArea in interface RoomMap

rebuildGrid

public StdMap.MapRoom[][] rebuildGrid(java.util.Hashtable<Room,StdMap.MapRoom> areaMap)

clearTheSkys

public void clearTheSkys(java.util.Hashtable<Room,StdMap.MapRoom> mapRooms)

makeMapRooms

public java.util.Hashtable<Room,StdMap.MapRoom> 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.Map<Room,StdMap.MapRoom> processed,
                                         int x,
                                         int y)

getRoom

public StdMap.MapRoom getRoom(java.util.Map<Room,StdMap.MapRoom> allRooms,
                              Room droom)

isEmptyCluster

public boolean isEmptyCluster(java.util.Map<Room,StdMap.MapRoom> processed,
                              int x,
                              int y)

findEmptyCluster

public void findEmptyCluster(java.util.Map<Room,StdMap.MapRoom> processed,
                             java.util.List<java.lang.Integer> 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.Map<Room,StdMap.MapRoom> 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.Map<Room,StdMap.MapRoom> areaMap,
                      int favoredX,
                      int favoredY,
                      java.util.Map<Room,StdMap.MapRoom> processed,
                      boolean doNotDefer,
                      boolean passTwo,
                      int depth)