com.planet_ink.coffee_mud.Locales
Class SaltWaterSurface

java.lang.Object
  extended by com.planet_ink.coffee_mud.Locales.StdRoom
      extended by com.planet_ink.coffee_mud.Locales.WaterSurface
          extended by com.planet_ink.coffee_mud.Locales.SaltWaterSurface
All Implemented Interfaces:
Affectable, Behavable, CMModifiable, CMObject, Decayable, Drink, Environmental, MsgListener, StatsAffecting, Tickable, Room, java.lang.Cloneable, java.lang.Comparable<CMObject>
Direct Known Subclasses:
SaltWaterThinSurface

public class SaltWaterSurface
extends WaterSurface


Field Summary
 
Fields inherited from class com.planet_ink.coffee_mud.Locales.StdRoom
affects, amDestroyed, baseEnvStats, behaviors, contents, description, displayText, doors, envStats, exits, expirationDate, gridParent, imageName, inhabitants, mobility, myArea, myID, myResource, name, resourceFound, scripts, skyedYet, tickStatus, 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
 
Constructor Summary
SaltWaterSurface()
           
 
Method Summary
 void clearSky()
           
 void giveASky(int depth)
           
 java.lang.String ID()
          The CoffeeMud Java Class ID shared by all instances of this object.
 int liquidType()
          The material type of the liquid in this container.
 java.util.Vector resourceChoices()
           
protected  java.lang.String UnderWaterLocaleID()
           
 
Methods inherited from class com.planet_ink.coffee_mud.Locales.WaterSurface
amountTakenToFillMe, containsDrink, decayTime, disappearsAfterDrinking, domainConditions, domainType, executeMsg, isOkWaterSurfaceAffect, liquidHeld, liquidRemaining, okMessage, setDecayTime, setLiquidHeld, setLiquidRemaining, setLiquidType, setThirstQuenched, thirstQuenched
 
Methods inherited from class com.planet_ink.coffee_mud.Locales.StdRoom
addBehavior, addEffect, addInhabitant, addItem, addItemRefuse, addNonUninvokableEffect, addScript, affectCharState, affectCharStats, affectEnvStats, amDestroyed, baseEnvStats, baseThirst, bringItemHere, bringMobHere, cloneFix, compareTo, copyOf, delBehavior, delEffect, delInhabitant, delItem, delScript, description, destroy, displayText, envStats, expirationDate, fetchAnyItem, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchFromMOBRoomFavorsItems, fetchFromMOBRoomItemExit, fetchFromRoomFavorItems, fetchFromRoomFavorMOBs, fetchInhabitant, fetchInhabitant, fetchItem, fetchItem, fetchPCInhabitant, fetchScript, finalize, getArea, getCodeNum, getContextName, getExitInDir, getGridParent, getMobility, getPairedExit, getRawExit, getReverseExit, getRoomInDir, getSaveStatIndex, getStat, getStatCodes, getTickStatus, herbTwistChart, image, initializeClass, isContent, isGeneric, isHere, isInhabitant, isSameRoom, isStat, maxRange, minRange, miscTextFormat, myResource, name, Name, newInstance, numBehaviors, numEffects, numInhabitants, numItems, numPCInhabitants, numScripts, parseVaries, parseVariesCodes, pointsPerMove, prepareRoomInDir, rawDoors, rawImage, reallyReallySend, reallySend, recoverEnvStats, recoverRoomStats, resetVectors, roomDescription, roomID, roomTitle, sameAs, savable, send, sendOthers, setArea, setBaseEnvStats, setDescription, setDisplayText, setExpirationDate, setGridParent, setImage, setMiscText, setName, setRawExit, setResource, setRoomID, 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, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SaltWaterSurface

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

UnderWaterLocaleID

protected java.lang.String UnderWaterLocaleID()
Overrides:
UnderWaterLocaleID in class WaterSurface

liquidType

public int liquidType()
Description copied from interface: Drink
The material type of the liquid in this container. Although a class implementing the Drink interface can sometimes be a liquid itself (like GenLiquidResource), most often, a Drink interface implementing class is a mob without a material to draw from or an Item having its own non-liquid material (like a leather waterskin containing milk). Either way, this is necessary. The material types are constants in RawMaterial.

Specified by:
liquidType in interface Drink
Overrides:
liquidType in class WaterSurface
Returns:
the type of liquid contained herein
See Also:
RawMaterial

resourceChoices

public java.util.Vector resourceChoices()
Specified by:
resourceChoices in interface Room
Overrides:
resourceChoices in class WaterSurface

giveASky

public void giveASky(int depth)
Specified by:
giveASky in interface Room
Overrides:
giveASky in class WaterSurface

clearSky

public void clearSky()
Specified by:
clearSky in interface Room
Overrides:
clearSky in class WaterSurface