Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.planet_ink.coffee_mud.Locales.interfaces
Interface Room

All Superinterfaces:
Affectable, Behavable, java.lang.Cloneable, CMModifiable, CMObject, java.lang.Comparable<CMObject>, Environmental, MsgListener, StatsAffecting, Tickable
All Known Subinterfaces:
GridLocale
All Known Implementing Classes:
CaveMaze, CaveRoom, CaveSurface, CityStreet, ClimbableLedge, ClimbableSurface, Desert, DesertGrid, DesertMaze, DesertThinGrid, EndlessOcean, EndlessSky, EndlessThinOcean, EndlessThinSky, FrozenMountains, FrozenPlains, GreatLake, GreatThinLake, Hills, HillsGrid, HillsThinGrid, HotRoom, IceRoom, IndoorInTheAir, IndoorShallowWater, IndoorUnderWater, IndoorWaterSurface, InTheAir, Jungle, JungleGrid, JungleThinGrid, LargeCaveRoom, LargeStoneRoom, LargeWoodRoom, MagicFreeRoom, MagicShelter, MetalRoom, Mountains, MountainsGrid, MountainsMaze, MountainsThinGrid, MountainSurface, MountainSurfaceGrid, MountainSurfaceThinGrid, OverTheLedge, Plains, PlainsGrid, PlainsThinGrid, Road, RoadGrid, RoadThinGrid, SaltWaterSurface, SaltWaterThinSurface, SewerMaze, SewerRoom, ShallowWater, Shore, SpacePort, StdGrid, StdMaze, StdRoom, StdThinGrid, StoneGrid, StoneMaze, StoneRoom, StoneThinGrid, Swamp, SwampGrid, SwampThinGrid, ThinRoom, TreeSurface, UnderSaltWater, UnderSaltWaterGrid, UnderSaltWaterMaze, UnderSaltWaterThinGrid, UnderWater, UnderWaterGrid, UnderWaterMaze, UnderWaterThinGrid, WaterSurface, WaterThinSurface, WetCaveMaze, WetCaveRoom, WoodRoom, WoodRoomGrid, WoodRoomMaze, WoodRoomThinGrid, Woods, WoodsGrid, WoodsMaze, WoodsThinGrid
public interface Room
extends Environmental, Affectable, Behavable

Field Summary
static int CONDITION_COLD
           
static int CONDITION_HOT
           
static int CONDITION_NORMAL
           
static int CONDITION_WET
           
static int DOMAIN_INDOORS_AIR
           
static int DOMAIN_INDOORS_CAVE
           
static int DOMAIN_INDOORS_MAGIC
           
static int DOMAIN_INDOORS_METAL
           
static int DOMAIN_INDOORS_STONE
           
static int DOMAIN_INDOORS_UNDERWATER
           
static int DOMAIN_INDOORS_WATERSURFACE
           
static int DOMAIN_INDOORS_WOOD
           
static int DOMAIN_OUTDOORS_AIR
           
static int DOMAIN_OUTDOORS_CITY
           
static int DOMAIN_OUTDOORS_DESERT
           
static int DOMAIN_OUTDOORS_HILLS
           
static int DOMAIN_OUTDOORS_JUNGLE
           
static int DOMAIN_OUTDOORS_MOUNTAINS
           
static int DOMAIN_OUTDOORS_PLAINS
           
static int DOMAIN_OUTDOORS_ROCKS
           
static int DOMAIN_OUTDOORS_SPACEPORT
           
static int DOMAIN_OUTDOORS_SWAMP
           
static int DOMAIN_OUTDOORS_UNDERWATER
           
static int DOMAIN_OUTDOORS_WATERSURFACE
           
static int DOMAIN_OUTDOORS_WOODS
           
static java.lang.String[] indoorDomainDescs
           
static int INDOORS
           
static java.lang.String[] outdoorDomainDescs
           
static java.lang.String[][] 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
 
Method Summary
 void addInhabitant(MOB mob)
           
 void addItem(Item item)
           
 void addItemRefuse(Item item, int expireMins)
           
 void bringItemHere(Item item, int expireMins, boolean andRiders)
           
 void bringMobHere(MOB mob, boolean andFollowers)
           
 void clearSky()
           
 void delInhabitant(MOB mob)
           
 void delItem(Item item)
           
 int domainConditions()
           
 int domainType()
           
 Item fetchAnyItem(java.lang.String itemID)
           
 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 i)
           
 Area getArea()
           
 java.lang.String getContextName(Environmental E)
           
 Exit getExitInDir(int direction)
           
 GridLocale getGridParent()
           
 boolean getMobility()
           
 Exit getPairedExit(int direction)
           
 Exit getRawExit(int direction)
           
 Exit getReverseExit(int direction)
           
 Room getRoomInDir(int direction)
           
 void giveASky(int zero)
           
 boolean isContent(Item item)
           
 boolean isHere(Environmental E)
           
 boolean isInhabitant(MOB mob)
           
 boolean isSameRoom(java.lang.Object O)
           
 int myResource()
           
 int numInhabitants()
           
 int numItems()
           
 int numPCInhabitants()
           
 int pointsPerMove(MOB mob)
           
 Room prepareRoomInDir(Room fromRoom, int direction)
           
 Room[] rawDoors()
           
 void recoverRoomStats()
           
 void resetVectors()
           
 java.util.Vector resourceChoices()
           
 java.lang.String roomDescription()
           
 java.lang.String roomID()
           
 java.lang.String roomTitle()
           
 void send(MOB source, CMMsg msg)
           
 void sendOthers(MOB source, CMMsg msg)
           
 void setArea(Area newArea)
           
 void setGridParent(GridLocale room)
           
 void setRawExit(int direction, Environmental E)
           
 void setResource(int resourceCode)
           
 void setRoomID(java.lang.String newRoomID)
           
 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()
           
 int thirstPerRound(MOB mob)
           
 void toggleMobility(boolean onoff)
           
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Environmental
addEffect, addNonUninvokableEffect, amDestroyed, baseEnvStats, delEffect, description, destroy, displayText, envStats, expirationDate, fetchEffect, fetchEffect, image, isGeneric, maxRange, minRange, miscTextFormat, name, Name, numEffects, rawImage, recoverEnvStats, sameAs, savable, setBaseEnvStats, setDescription, setDisplayText, setExpirationDate, setImage, setMiscText, 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.CMObject
copyOf, ID, initializeClass, newInstance
 
Methods inherited from interface java.lang.Comparable
compareTo
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.StatsAffecting
affectCharState, affectCharStats, affectEnvStats
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.MsgListener
executeMsg, okMessage
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMModifiable
getSaveStatIndex, getStat, getStatCodes, isStat, setStat
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Behavable
addBehavior, addScript, delBehavior, delScript, fetchBehavior, fetchBehavior, fetchScript, numBehaviors, numScripts
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Affectable
addEffect, addNonUninvokableEffect, baseEnvStats, delEffect, envStats, fetchEffect, fetchEffect, numEffects, recoverEnvStats, setBaseEnvStats
 

Field Detail

INDOORS

static final int INDOORS
See Also:
Constant Field Values

DOMAIN_OUTDOORS_CITY

static final int DOMAIN_OUTDOORS_CITY
See Also:
Constant Field Values

DOMAIN_OUTDOORS_WOODS

static final int DOMAIN_OUTDOORS_WOODS
See Also:
Constant Field Values

DOMAIN_OUTDOORS_ROCKS

static final int DOMAIN_OUTDOORS_ROCKS
See Also:
Constant Field Values

DOMAIN_OUTDOORS_PLAINS

static final int DOMAIN_OUTDOORS_PLAINS
See Also:
Constant Field Values

DOMAIN_OUTDOORS_UNDERWATER

static final int DOMAIN_OUTDOORS_UNDERWATER
See Also:
Constant Field Values

DOMAIN_OUTDOORS_AIR

static final int DOMAIN_OUTDOORS_AIR
See Also:
Constant Field Values

DOMAIN_OUTDOORS_WATERSURFACE

static final int DOMAIN_OUTDOORS_WATERSURFACE
See Also:
Constant Field Values

DOMAIN_OUTDOORS_JUNGLE

static final int DOMAIN_OUTDOORS_JUNGLE
See Also:
Constant Field Values

DOMAIN_OUTDOORS_SWAMP

static final int DOMAIN_OUTDOORS_SWAMP
See Also:
Constant Field Values

DOMAIN_OUTDOORS_DESERT

static final int DOMAIN_OUTDOORS_DESERT
See Also:
Constant Field Values

DOMAIN_OUTDOORS_HILLS

static final int DOMAIN_OUTDOORS_HILLS
See Also:
Constant Field Values

DOMAIN_OUTDOORS_MOUNTAINS

static final int DOMAIN_OUTDOORS_MOUNTAINS
See Also:
Constant Field Values

DOMAIN_OUTDOORS_SPACEPORT

static final int DOMAIN_OUTDOORS_SPACEPORT
See Also:
Constant Field Values

outdoorDomainDescs

static final java.lang.String[] outdoorDomainDescs

DOMAIN_INDOORS_STONE

static final int DOMAIN_INDOORS_STONE
See Also:
Constant Field Values

DOMAIN_INDOORS_WOOD

static final int DOMAIN_INDOORS_WOOD
See Also:
Constant Field Values

DOMAIN_INDOORS_CAVE

static final int DOMAIN_INDOORS_CAVE
See Also:
Constant Field Values

DOMAIN_INDOORS_MAGIC

static final int DOMAIN_INDOORS_MAGIC
See Also:
Constant Field Values

DOMAIN_INDOORS_UNDERWATER

static final int DOMAIN_INDOORS_UNDERWATER
See Also:
Constant Field Values

DOMAIN_INDOORS_AIR

static final int DOMAIN_INDOORS_AIR
See Also:
Constant Field Values

DOMAIN_INDOORS_WATERSURFACE

static final int DOMAIN_INDOORS_WATERSURFACE
See Also:
Constant Field Values

DOMAIN_INDOORS_METAL

static final int DOMAIN_INDOORS_METAL
See Also:
Constant Field Values

indoorDomainDescs

static final java.lang.String[] indoorDomainDescs

CONDITION_NORMAL

static final int CONDITION_NORMAL
See Also:
Constant Field Values

CONDITION_WET

static final int CONDITION_WET
See Also:
Constant Field Values

CONDITION_HOT

static final int CONDITION_HOT
See Also:
Constant Field Values

CONDITION_COLD

static final int CONDITION_COLD
See Also:
Constant Field Values

variationCodes

static final java.lang.String[][] variationCodes
Method Detail

roomID

java.lang.String roomID()

setRoomID

void setRoomID(java.lang.String newRoomID)

domainType

int domainType()

domainConditions

int domainConditions()

myResource

int myResource()

setResource

void setResource(int resourceCode)

resourceChoices

java.util.Vector resourceChoices()

toggleMobility

void toggleMobility(boolean onoff)

getMobility

boolean getMobility()

resetVectors

void resetVectors()

startItemRejuv

void startItemRejuv()

recoverRoomStats

void recoverRoomStats()

clearSky

void clearSky()

giveASky

void giveASky(int zero)

isSameRoom

boolean isSameRoom(java.lang.Object O)

getArea

Area getArea()

setArea

void setArea(Area newArea)

setGridParent

void setGridParent(GridLocale room)

getGridParent

GridLocale getGridParent()

rawDoors

Room[] rawDoors()

setRawExit

void setRawExit(int direction,
                Environmental E)

getRawExit

Exit getRawExit(int direction)

getReverseExit

Exit getReverseExit(int direction)

getPairedExit

Exit getPairedExit(int direction)

getRoomInDir

Room getRoomInDir(int direction)

getExitInDir

Exit getExitInDir(int direction)

prepareRoomInDir

Room prepareRoomInDir(Room fromRoom,
                      int direction)

pointsPerMove

int pointsPerMove(MOB mob)

thirstPerRound

int thirstPerRound(MOB mob)

roomTitle

java.lang.String roomTitle()

roomDescription

java.lang.String roomDescription()

send

void send(MOB source,
          CMMsg msg)

sendOthers

void sendOthers(MOB source,
                CMMsg msg)

showHappens

void showHappens(int allCode,
                 java.lang.String allMessage)

showHappens

void showHappens(int allCode,
                 Environmental like,
                 java.lang.String allMessage)

show

boolean show(MOB source,
             Environmental target,
             int allCode,
             java.lang.String allMessage)

show

boolean show(MOB source,
             Environmental target,
             Environmental tool,
             int allCode,
             java.lang.String allMessage)

show

boolean show(MOB source,
             Environmental target,
             Environmental tool,
             int srcCode,
             int tarCode,
             int othCode,
             java.lang.String allMessage)

show

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)

show

boolean show(MOB source,
             Environmental target,
             Environmental tool,
             int allCode,
             java.lang.String srcMessage,
             java.lang.String tarMessage,
             java.lang.String othMessage)

showOthers

boolean showOthers(MOB source,
                   Environmental target,
                   int allCode,
                   java.lang.String allMessage)

showSource

boolean showSource(MOB source,
                   Environmental target,
                   int allCode,
                   java.lang.String allMessage)

showOthers

boolean showOthers(MOB source,
                   Environmental target,
                   Environmental tool,
                   int allCode,
                   java.lang.String allMessage)

showSource

boolean showSource(MOB source,
                   Environmental target,
                   Environmental tool,
                   int allCode,
                   java.lang.String allMessage)

isHere

boolean isHere(Environmental E)

fetchInhabitant

MOB fetchInhabitant(java.lang.String inhabitantID)

addInhabitant

void addInhabitant(MOB mob)

delInhabitant

void delInhabitant(MOB mob)

numInhabitants

int numInhabitants()

isInhabitant

boolean isInhabitant(MOB mob)

fetchInhabitant

MOB fetchInhabitant(int i)

numPCInhabitants

int numPCInhabitants()

fetchPCInhabitant

MOB fetchPCInhabitant(int i)

bringMobHere

void bringMobHere(MOB mob,
                  boolean andFollowers)

getContextName

java.lang.String getContextName(Environmental E)

addItem

void addItem(Item item)

addItemRefuse

void addItemRefuse(Item item,
                   int expireMins)

delItem

void delItem(Item item)

numItems

int numItems()

isContent

boolean isContent(Item item)

fetchItem

Item fetchItem(Item goodLocation,
               java.lang.String itemID)

fetchItem

Item fetchItem(int i)

fetchAnyItem

Item fetchAnyItem(java.lang.String itemID)

bringItemHere

void bringItemHere(Item item,
                   int expireMins,
                   boolean andRiders)

fetchFromRoomFavorItems

Environmental fetchFromRoomFavorItems(Item goodLocation,
                                      java.lang.String thingName,
                                      int wornReqCode)

fetchFromMOBRoomItemExit

Environmental