com.planet_ink.coffee_mud.Locales
Class Woods

java.lang.Object
  extended by com.planet_ink.coffee_mud.Locales.StdRoom
      extended by com.planet_ink.coffee_mud.Locales.Woods
All Implemented Interfaces:
Affectable, Behavable, CMObject, Contingent, Environmental, ItemCollection, ItemPossessor, Modifiable, MsgListener, Physical, PhysicalAgent, Places, StatsAffecting, Tickable, Room, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class Woods
extends StdRoom


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Locales.interfaces.Room
Room.VariationCode
 
Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.core.interfaces.ItemPossessor
ItemPossessor.Expire, ItemPossessor.Find, ItemPossessor.Move
 
Field Summary
static java.lang.Integer[] resourceList
           
static java.util.List<java.lang.Integer> roomResources
           
 
Fields inherited from class com.planet_ink.coffee_mud.Locales.StdRoom
affectPhyStats, affects, amDestroyed, atmosphere, basePhyStats, behaviors, cachedImageName, climask, combatTurnMobIndex, contents, description, displayText, doors, exits, expirationDate, gridParent, inhabitants, lastResourceTime, me, mobility, myArea, myID, myResource, name, phyStats, rawImageName, roomRecoverMarker, scripts, skyedYet, STDCODES, tickStatus, xtraValues
 
Fields inherited from interface com.planet_ink.coffee_mud.Locales.interfaces.Room
DOMAIN_INDOOR_MAP, DOMAIN_INDOORS_AIR, DOMAIN_INDOORS_CAVE, DOMAIN_INDOORS_DESCS, DOMAIN_INDOORS_MAGIC, DOMAIN_INDOORS_METAL, DOMAIN_INDOORS_STONE, DOMAIN_INDOORS_UNDERWATER, DOMAIN_INDOORS_WATERSURFACE, DOMAIN_INDOORS_WOOD, DOMAIN_OUTDOOR_DESCS, DOMAIN_OUTDOOR_MAP, 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_SEAPORT, DOMAIN_OUTDOORS_SPACEPORT, DOMAIN_OUTDOORS_SWAMP, DOMAIN_OUTDOORS_UNDERWATER, DOMAIN_OUTDOORS_WATERSURFACE, DOMAIN_OUTDOORS_WOODS, FILTER_ROOMONLY, INDOORS
 
Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.Places
ALL_CLIMATE_MASK, ATMOSPHERE_INHERIT, CLIMASK_COLD, CLIMASK_DRY, CLIMASK_HOT, CLIMASK_INHERIT, CLIMASK_NORMAL, CLIMASK_WET, CLIMASK_WINDY, CLIMATE_DESCS, NUM_CLIMATES
 
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_BEAMWEAPON, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, 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_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET
 
Constructor Summary
Woods()
           
 
Method Summary
 int domainType()
          Returns the domain-code for this room, which tells you something about its physical makeup, such as whether it is outdoor, if it's in the woods or surrounded by stone, that sort of thing.
 void executeMsg(Environmental myHost, CMMsg msg)
          The general message event handler for the object.
 java.lang.String ID()
          The CoffeeMud Java Class ID shared by all instances of this object.
 java.util.List<java.lang.Integer> resourceChoices()
          Returns a list of all resource codes for potentially gatherable resources in this room.
 
Methods inherited from class com.planet_ink.coffee_mud.Locales.StdRoom
addBehavior, addEffect, addInhabitant, addItem, addItem, addNonUninvokableEffect, addScript, affectCharState, affectCharStats, affectPhyStats, amDestroyed, basePhyStats, baseThirst, behaviors, bringMobHere, clearSky, cloneFix, compareTo, copyOf, delAllBehaviors, delAllEffects, delAllInhabitants, delAllItems, delAllScripts, delBehavior, delEffect, delInhabitant, delItem, delScript, description, description, destroy, displayText, displayText, eachBehavior, eachEffect, eachInhabitant, eachItem, eachScript, effects, expirationDate, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchExit, fetchFromMOBRoomFavorsItems, fetchFromMOBRoomFavorsMOBs, fetchFromMOBRoomItemExit, fetchFromRoomFavorExits, fetchFromRoomFavorItems, fetchFromRoomFavorMOBs, fetchInhabitant, fetchInhabitant, fetchInhabitantExact, fetchInhabitants, fetchRandomInhabitant, fetchScript, findItem, findItem, findItems, findItems, getArea, getAtmosphere, getAtmosphereCode, getClimateType, getClimateTypeCode, getCodeNum, getCombatTurnMobIndex, getContextName, getExitInDir, getGridParent, getItem, getMobility, getPairedExit, getRandomItem, getRawExit, getReverseExit, getRoomInDir, getSaveStatIndex, getSky, getStat, getStatCodes, getTickStatus, giveASky, image, inhabitants, initializeClass, insertItemUpTop, isContent, isGeneric, isHere, isInhabitant, isSavable, isStat, items, L, maxRange, minRange, miscTextFormat, moveItemTo, moveItemTo, myResource, name, Name, name, newInstance, numBehaviors, numEffects, numInhabitants, numItems, numPCInhabitants, numScripts, okMessage, parseVaries, parseVariesCodes, phyStats, pointsPerMove, prepareRoomInDir, rawDoors, rawImage, recoverPhyStats, recoverRoomStats, roomID, sameAs, scripts, send, sendAndExec, sendOthers, sendTrailermsgs, setArea, setAtmosphere, setBasePhyStats, setClimateType, setCombatTurnMobIndex, setDescription, setDisplayText, setExpirationDate, setGridParent, setImage, setMiscText, setName, setRawExit, setResource, setRoomID, setSavable, setStat, show, show, show, show, show, showHappens, showHappens, showOthers, showOthers, showSource, showSource, startItemRejuv, text, thirstPerRound, tick, toggleMobility
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

resourceList

public static final java.lang.Integer[] resourceList

roomResources

public static final java.util.List<java.lang.Integer> roomResources
Constructor Detail

Woods

public Woods()
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 StdRoom
Returns:
the name of this class

domainType

public int domainType()
Description copied from interface: Room
Returns the domain-code for this room, which tells you something about its physical makeup, such as whether it is outdoor, if it's in the woods or surrounded by stone, that sort of thing.

Specified by:
domainType in interface Room
Overrides:
domainType in class StdRoom
Returns:
the domain-code for this room
See Also:
Room.INDOORS, Room.DOMAIN_INDOORS_CAVE, Room.DOMAIN_INDOORS_DESCS, Room.DOMAIN_OUTDOORS_CITY, Room.DOMAIN_OUTDOOR_DESCS

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 StdRoom
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

resourceChoices

public java.util.List<java.lang.Integer> resourceChoices()
Description copied from interface: Room
Returns a list of all resource codes for potentially gatherable resources in this room. This list is alterable for a given Room/Locale java class. Changes to any instance will affect the entire class.

Specified by:
resourceChoices in interface Room
Overrides:
resourceChoices in class StdRoom
Returns:
the list of all possible resource codes for the current gatherable resources in this room
See Also:
RawMaterial, RawMaterial.CODES, Room.myResource(), Room.setResource(int)