com.planet_ink.coffee_mud.Locales
Class StdRoom

java.lang.Object
  com.planet_ink.coffee_mud.Locales.StdRoom

All Implemented Interfaces:

Affectable, Behavable, CMModifiable, CMObject, Environmental, MsgListener, StatsAffecting, Tickable, Room, java.lang.Cloneable, java.lang.Comparable<CMObject>

Direct Known Subclasses:

CaveRoom, CityStreet, ClimbableSurface, Desert, Hills, HotRoom, IceRoom, IndoorInTheAir, IndoorUnderWater, IndoorWaterSurface, InTheAir, Jungle, MagicFreeRoom, MagicShelter, MetalRoom, Mountains, Plains, Road, SewerRoom, ShallowWater, Shore, SpacePort, StdGrid, StdThinGrid, StoneRoom, Swamp, UnderWater, WaterSurface, WoodRoom, Woods

public class StdRoom
extends java.lang.Object
implements Room

Field Summary

protected java.util.Vector	affects
protected boolean	amDestroyed
protected EnvStats	baseEnvStats
protected java.util.Vector	behaviors
protected java.util.Vector	contents
protected byte[]	description
protected java.lang.String	displayText
Room[]	doors
protected EnvStats	envStats
Exit[]	exits
protected long	expirationDate
protected GridLocale	gridParent
protected java.lang.String	imageName
protected java.util.Vector	inhabitants
protected boolean	mobility
protected Area	myArea
protected java.lang.String	myID
protected int	myResource
protected java.lang.String	name
protected long	resourceFound
protected java.util.Vector	scripts
protected boolean	skyedYet
protected long	tickStatus
protected java.lang.String[]	xtraValues

Fields inherited from interface com.planet_ink.coffee_mud.Locales.interfaces.Room

CONDITION_COLD, CONDITION_HOT, CONDITION_NORMAL, CONDITION_WET, DOMAIN_INDOORS_AIR, DOMAIN_INDOORS_CAVE, DOMAIN_INDOORS_MAGIC, DOMAIN_INDOORS_METAL, DOMAIN_INDOORS_STONE, DOMAIN_INDOORS_UNDERWATER, DOMAIN_INDOORS_WATERSURFACE, DOMAIN_INDOORS_WOOD, DOMAIN_OUTDOORS_AIR, DOMAIN_OUTDOORS_CITY, DOMAIN_OUTDOORS_DESERT, DOMAIN_OUTDOORS_HILLS, DOMAIN_OUTDOORS_JUNGLE, DOMAIN_OUTDOORS_MOUNTAINS, DOMAIN_OUTDOORS_PLAINS, DOMAIN_OUTDOORS_ROCKS, DOMAIN_OUTDOORS_SPACEPORT, DOMAIN_OUTDOORS_SWAMP, DOMAIN_OUTDOORS_UNDERWATER, DOMAIN_OUTDOORS_WATERSURFACE, DOMAIN_OUTDOORS_WOODS, indoorDomainDescs, INDOORS, outdoorDomainDescs, variationCodes

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, TICKS_PER_RLMIN, TIME_MILIS_PER_MUDHOUR, TIME_TICK, TIME_TICK_DOUBLE

Constructor Summary

StdRoom()

Method Summary

void	addBehavior(Behavior to) Manipulation of Behavior objects, which includes movement, speech, spellcasting, etc, etc.
void	addEffect(Ability to) Add a new effect to this object, whether permanent or temporary.
void	addInhabitant(MOB mob)
void	addItem(Item item)
void	addItemRefuse(Item item, int expireMins)
void	addNonUninvokableEffect(Ability to) Same as addEffect(Ability), but will set the Ability object as never being able to be uninvoked.
void	addScript(ScriptingEngine S) Manipulation of the scripts list
void	affectCharState(MOB affectedMob, CharState affectableMaxState) This method is called by the recoverCharState() method on other MOB objects.
void	affectCharStats(MOB affectedMob, CharStats affectableStats) This method is called by the recoverCharStats() method on other MOB objects.
void	affectEnvStats(Environmental affected, EnvStats affectableStats) This method is called by the recoverEnvStats() method on other Environmental objects.
boolean	amDestroyed() Whether the destroy() method has been previousy called on this object.
EnvStats	baseEnvStats() Object containing a set of base, unmodified, mostly numeric fields.
protected int	baseThirst()
void	bringItemHere(Item item, int expireMins, boolean andRiders)
void	bringMobHere(MOB mob, boolean andFollowers)
void	clearSky()
protected void	cloneFix(Room E)
int	compareTo(CMObject o)
CMObject	copyOf() Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.
void	delBehavior(Behavior to) Delete a behavior from this object.
void	delEffect(Ability to) Delete an effect from this object, whether permanent or temporary.
void	delInhabitant(MOB mob)
void	delItem(Item item)
void	delScript(ScriptingEngine S) Remove a running script from this object.
java.lang.String	description() The basic description of this object, as shown when the item is directly LOOKed at.
void	destroy() Utterly and permanently destroy this object, not only removing it from the map, but causing this object to be collected as garbage by Java.
java.lang.String	displayText() Gets the raw string used to show what this object looks like in the room.
int	domainConditions()
int	domainType()
EnvStats	envStats() Object containing a set of current, modified, usable, mostly numeric fields.
void	executeMsg(Environmental myHost, CMMsg msg) The general message event handler for the object.
long	expirationDate() If this object expires, it should have a timestamp saying when it expires, in real time.
Item	fetchAnyItem(java.lang.String itemID)
Behavior	fetchBehavior(int index) Returns a behavior object on this object.
Behavior	fetchBehavior(java.lang.String ID) Returns a behavior object listed on this object.
Ability	fetchEffect(int index) Returns an ability object listed as an effect on this object.
Ability	fetchEffect(java.lang.String ID) Returns an ability object listed as an effect on this object.
Environmental	fetchFromMOBRoomFavorsItems(MOB mob, Item goodLocation, java.lang.String thingName, int wornReqCode)
Environmental	fetchFromMOBRoomItemExit(MOB mob, Item goodLocation, java.lang.String thingName, int wornReqCode)
Environmental	fetchFromRoomFavorItems(Item goodLocation, java.lang.String thingName, int wornReqCode)
Environmental	fetchFromRoomFavorMOBs(Item goodLocation, java.lang.String thingName, int wornReqCode)
MOB	fetchInhabitant(int i)
MOB	fetchInhabitant(java.lang.String inhabitantID)
Item	fetchItem(int i)
Item	fetchItem(Item goodLocation, java.lang.String itemID)
MOB	fetchPCInhabitant(int which)
ScriptingEngine	fetchScript(int x) Retreive one of the enumerated scripts running on this object
protected void	finalize()
Area	getArea()
protected int	getCodeNum(java.lang.String code)
java.lang.String	getContextName(Environmental E)
Exit	getExitInDir(int direction)
GridLocale	getGridParent()
boolean	getMobility()
Exit	getPairedExit(int direction)
Exit	getRawExit(int dir)
Exit	getReverseExit(int direction)
Room	getRoomInDir(int direction)
int	getSaveStatIndex() Returns the index into the stat codes array where extra savable fields begins.
java.lang.String	getStat(java.lang.String code) An alternative means of retreiving the values of those fields on this object which are modifiable at run-time by builders.
java.lang.String[]	getStatCodes() Returns an array of the string names of those fields which are modifiable on this object at run-time by builders.
long	getTickStatus() A coded status for this object during the period where its tick method is being called.
void	giveASky(int depth)
protected java.util.Vector	herbTwistChart()
java.lang.String	ID() The CoffeeMud Java Class ID shared by all instances of this object.
java.lang.String	image() Returns the fully qualified and determined name of the image file displayed for this object when MXP is used.
void	initializeClass() Called ONCE after all objects are loaded, but before the map is read in during initialization.
boolean	isContent(Item item)
boolean	isGeneric() Whether the fields of this item are set in code, or set by builders.
boolean	isHere(Environmental E)
boolean	isInhabitant(MOB mob)
boolean	isSameRoom(java.lang.Object O)
boolean	isStat(java.lang.String code) An alternative means of retreiving the values of those fields on this object which are modifiable at run-time by builders.
int	maxRange() the maximum range of this object, if applicable.
int	minRange() the minimum range of this object, if applicable.
java.lang.String	miscTextFormat() Unimplemented as of yet, but will hold a string telling the system what the proper format of any miscText data.
int	myResource()
java.lang.String	name() The displayable name of this object.
java.lang.String	Name() The raw unmodified name of this object as stored in the database.
CMObject	newInstance() Returns a new instance of this class.
int	numBehaviors() The number of behaviors this object has.
int	numEffects() Returns the number of ability objects listed as effects on this object.
int	numInhabitants()
int	numItems()
int	numPCInhabitants()
int	numScripts() Return the number of scripts running on this object
boolean	okMessage(Environmental myHost, CMMsg msg) The general message event previewer for the object.
protected java.lang.String	parseVaries(java.lang.String text)
protected java.lang.String	parseVariesCodes(java.lang.String text)
int	pointsPerMove(MOB mob)
Room	prepareRoomInDir(Room R, int direction)
Room[]	rawDoors()
java.lang.String	rawImage() Returns the raw name of the image file to display for this object when MXP is used.
protected void	reallyReallySend(MOB source, CMMsg msg)
protected void	reallySend(MOB source, CMMsg msg, int depth)
void	recoverEnvStats() This method copies the baseEnvStats() object into the envStats() object, then makes repeated calls to all surrounding objects with affectEnvStats(Environmental,EnvStats) method.
void	recoverRoomStats()
void	resetVectors()
java.util.Vector	resourceChoices()
java.lang.String	roomDescription()
java.lang.String	roomID()
java.lang.String	roomTitle()
boolean	sameAs(Environmental E) Whether this object instance is functionally identical to the object passed in.
boolean	savable() Whether, if this object is in a room, whether it is appropriate to save this object to the database as a permanent feature of its container.
void	send(MOB source, CMMsg msg)
void	sendOthers(MOB source, CMMsg msg)
void	setArea(Area newArea)
void	setBaseEnvStats(EnvStats newBaseEnvStats) Re-sets the object containing a set of base, unmodified, mostly numeric fields.
void	setDescription(java.lang.String newDescription) Sets the basic description of this object, as shown when the item is directly LOOKed at.
void	setDisplayText(java.lang.String newDisplayText) Sets the raw string used to show what this object looks like in the room.
void	setExpirationDate(long time) If this object expires, it should have a timestamp saying when it expires, in real time.
void	setGridParent(GridLocale room)
void	setImage(java.lang.String newImage) Sets the raw name of the image file to display for this object when MXP is used.
void	setMiscText(java.lang.String newMiscText) 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.
void	setName(java.lang.String newName) Sets the raw unmodified name of this object as stored in the database.
void	setRawExit(int direction, Environmental to)
void	setResource(int resourceCode)
void	setRoomID(java.lang.String newID)
void	setStat(java.lang.String code, java.lang.String val) An alternative means of setting the values of those fields on this object which are modifiable at run-time by builders.
boolean	show(MOB source, Environmental target, Environmental tool, int srcCode, int tarCode, int othCode, java.lang.String allMessage)
boolean	show(MOB source, Environmental target, Environmental tool, int allCode, java.lang.String allMessage)
boolean	show(MOB source, Environmental target, Environmental tool, int srcCode, java.lang.String srcMessage, int tarCode, java.lang.String tarMessage, int othCode, java.lang.String othMessage)
boolean	show(MOB source, Environmental target, Environmental tool, int allCode, java.lang.String srcMessage, java.lang.String tarMessage, java.lang.String othMessage)
boolean	show(MOB source, Environmental target, int allCode, java.lang.String allMessage)
void	showHappens(int allCode, Environmental like, java.lang.String allMessage)
void	showHappens(int allCode, java.lang.String allMessage)
boolean	showOthers(MOB source, Environmental target, Environmental tool, int allCode, java.lang.String allMessage)
boolean	showOthers(MOB source, Environmental target, int allCode, java.lang.String allMessage)
boolean	showSource(MOB source, Environmental target, Environmental tool, int allCode, java.lang.String allMessage)
boolean	showSource(MOB source, Environmental target, int allCode, java.lang.String allMessage)
void	startItemRejuv()
java.lang.String	text() 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.
int	thirstPerRound(MOB mob)
boolean	tick(Tickable ticking, int tickID) this is the method which is called periodically by the threading engine.
void	toggleMobility(boolean onoff)

Methods inherited from class java.lang.Object

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

Field Detail

myID

protected java.lang.String myID

name

protected java.lang.String name

displayText

protected java.lang.String displayText

imageName

protected java.lang.String imageName

description

protected byte[] description

myArea

protected Area myArea

envStats

protected EnvStats envStats

baseEnvStats

protected EnvStats baseEnvStats

exits

public Exit[] exits

doors

public Room[] doors

xtraValues

protected java.lang.String[] xtraValues

affects

protected java.util.Vector affects

behaviors

protected java.util.Vector behaviors

scripts

protected java.util.Vector scripts

contents

protected java.util.Vector contents

inhabitants

protected java.util.Vector inhabitants

mobility

protected boolean mobility

gridParent

protected GridLocale gridParent

tickStatus

protected long tickStatus

expirationDate

protected long expirationDate

myResource

protected int myResource

resourceFound

protected long resourceFound

amDestroyed

protected boolean amDestroyed

skyedYet

protected boolean skyedYet

Constructor Detail

StdRoom

public StdRoom()

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

Returns:

the name of this class

finalize

protected void finalize()

Overrides:

finalize in class java.lang.Object

initializeClass

public void initializeClass()

Description copied from interface: CMObject

Called ONCE after all objects are loaded, but before the map is read in during initialization.

Specified by:

initializeClass in interface CMObject

newInstance

public CMObject newInstance()

Description copied from interface: CMObject

Returns a new instance of this class.

Specified by:

newInstance in interface CMObject

Returns:

a new instance of this class

roomID

public java.lang.String roomID()

Specified by:

roomID in interface Room

Name

public java.lang.String Name()

Description copied from interface: Environmental

The raw unmodified name of this object as stored in the database. This is the name set by builders and used as a basis for the name() method.

Specified by:

Name in interface Environmental

Returns:

the raw base name of this object on the map.

See Also:

Environmental.name()

setName

public void setName(java.lang.String newName)

Description copied from interface: Environmental

Sets the raw unmodified name of this object as stored in the database. This is the name set by builders and used as a basis for the name() method.

Specified by:

setName in interface Environmental

Parameters:

newName - the raw base name of this object on the map.

See Also:

Environmental.Name()

name

public java.lang.String name()

Description copied from interface: Environmental

The displayable name of this object. May be modified by envStats() object. Is derived from the Name().

Specified by:

name in interface Environmental

Specified by:

name in interface Tickable

Returns:

the modified final name of this object on the map.

See Also:

Environmental.Name()

image

public java.lang.String image()

Description copied from interface: Environmental

Returns the fully qualified and determined name of the image file displayed for this object when MXP is used. If rawImage() is non-empty, it will return rawImage, and otherwise use the mxp default data file.

Specified by:

image in interface Environmental

Returns:

the name of the mxp image to display for this object.

rawImage

public java.lang.String rawImage()

Description copied from interface: Environmental

Returns the raw name of the image file to display for this object when MXP is used. This is the value set by the builder, and may be returned by image() if it is non-empty.

Specified by:

rawImage in interface Environmental

Returns:

the raw name of the mxp image file

setImage

public void setImage(java.lang.String newImage)

Description copied from interface: Environmental

Sets the raw name of the image file to display for this object when MXP is used. This is the value set by the builder, and may be returned by image() if it is non-empty.

Specified by:

setImage in interface Environmental

Parameters:

newImage - the raw name of the mxp image file

isGeneric

public boolean isGeneric()

Description copied from interface: Environmental

Whether the fields of this item are set in code, or set by builders. Generic means that they are set by builders, in which case XML is returned by the text() method containing all of the values for all the fields.

Specified by:

isGeneric in interface Environmental

Returns:

whether this item is modifiable by builders

See Also:

Environmental.text()

resetVectors

public void resetVectors()

Specified by:

resetVectors in interface Room

cloneFix

protected void cloneFix(Room E)

copyOf

public CMObject copyOf()

Description copied from interface: CMObject

Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.

Specified by:

copyOf in interface CMObject

Returns:

a clone of this object

domainType

public int domainType()

Specified by:

domainType in interface Room

domainConditions

public int domainConditions()

Specified by:

domainConditions in interface Room

expirationDate

public long expirationDate()

Description copied from interface: Environmental

If this object expires, it should have a timestamp saying when it expires, in real time. When it expires, a MSG_EXPIRE message will be sent to it.

Specified by:

expirationDate in interface Environmental

Returns:

the time stamp when this thing expires

See Also:

Environmental.setExpirationDate(long)

setExpirationDate

public void setExpirationDate(long time)

Description copied from interface: Environmental

If this object expires, it should have a timestamp saying when it expires, in real time. When it expires, a MSG_EXPIRE message will be sent to it.

Specified by:

setExpirationDate in interface Environmental

Parameters:

time - the time stamp when this thing expires

See Also:

Environmental.expirationDate()

setRaw