com.planet_ink.coffee_mud.Locales
Class WaterSurface

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

All Implemented Interfaces:

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

Direct Known Subclasses:

SaltWaterSurface, WaterThinSurface

public class WaterSurface
extends StdRoom
implements Drink

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

WaterSurface()

Method Summary

int	amountTakenToFillMe(Drink theSource) Given the liquid source, the amount of liquid which would need to be taken from the source liquid source to fill up THIS liquid source.
void	clearSky()
boolean	containsDrink() Whether this liquid container still contains any liquid.
long	decayTime() The time, in milliseconds, when this will rot.
boolean	disappearsAfterDrinking() Settable only internally, this method returns whether this entire object is destroyed immediately after it is drank from -- like a potion.
int	domainConditions()
int	domainType()
void	executeMsg(Environmental myHost, CMMsg msg) The general message event handler for the object.
void	giveASky(int depth)
java.lang.String	ID() The CoffeeMud Java Class ID shared by all instances of this object.
static int	isOkWaterSurfaceAffect(Room room, CMMsg msg)
int	liquidHeld() The total amount of liquid possible to be contained in this liquid container.
int	liquidRemaining() The amount of liquid remaining in this liquid container.
int	liquidType() The material type of the liquid in this container.
boolean	okMessage(Environmental myHost, CMMsg msg) The general message event previewer for the object.
java.util.Vector	resourceChoices()
void	setDecayTime(long time) Sets the time, in milliseconds, when this will rot.
void	setLiquidHeld(int amount) Sets the total amount of liquid possible to be contained in this liquid container.
void	setLiquidRemaining(int amount) Sets the amount of liquid remaining in this liquid container.
void	setLiquidType(int newLiquidType) Sets the material type of the liquid in this container.
void	setThirstQuenched(int amount) Set the amount of thirst points quenched every time this item is drank from.
int	thirstQuenched() The amount of thirst points quenched every time this item is drank from.
protected java.lang.String	UnderWaterLocaleID()

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

WaterSurface

public WaterSurface()

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 StdRoom

Returns:

the name of this class

domainType

public int domainType()

Specified by:

domainType in interface Room

Overrides:

domainType in class StdRoom

domainConditions

public int domainConditions()

Specified by:

domainConditions in interface Room

Overrides:

domainConditions in class StdRoom

decayTime

public long decayTime()

Description copied from interface: Decayable

The time, in milliseconds, when this will rot. 0=never

Specified by:

decayTime in interface Decayable

Returns:

the time in milliseconds when this will rot. 0=never

See Also:

Decayable.setDecayTime(long)

setDecayTime

public void setDecayTime(long time)

Description copied from interface: Decayable

Sets the time, in milliseconds, when this will rot. 0=never

Specified by:

setDecayTime in interface Decayable

Parameters:

time - in milliseconds, when this will rot. 0=never

See Also:

Decayable.decayTime()

UnderWaterLocaleID

protected java.lang.String UnderWaterLocaleID()

giveASky

public void giveASky(int depth)

Specified by:

giveASky in interface Room

Overrides:

giveASky in class StdRoom

clearSky

public void clearSky()

Specified by:

clearSky in interface Room

Overrides:

clearSky in class StdRoom

okMessage

public boolean okMessage(Environmental myHost,
                         CMMsg msg)

Description copied from interface: MsgListener

The general message event previewer for the object. Messages passed herein are in a pending state, and may be safely modified or rejected without fear that they might be in the middle of being executed. Messages passed herein may not necessarily be FOR or FROM this object, but will almost always represent events which want to happen in the same rom. This method should always always return true UNLESS this message needs to be canceled, in which case it is necessary to tell the mob initiating the event (CMMsg.source()) why it is being cancelled. Every game event goes through these methods.

Specified by:

okMessage in interface MsgListener

Overrides:

okMessage in class StdRoom

Parameters:

myHost - either the initiator of the event, or the host of this object

msg - the CMMsg that wants to be executed

Returns:

whether this message is allowed to execute

See Also:

CMMsg, CMMsg.source()

isOkWaterSurfaceAffect

public static int isOkWaterSurfaceAffect(Room room,
                                         CMMsg msg)

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

thirstQuenched

public int thirstQuenched()

Description copied from interface: Drink

The amount of thirst points quenched every time this item is drank from.

Specified by:

thirstQuenched in interface Drink

Returns:

amount of thirst quenched

See Also:

CharState

liquidHeld

public int liquidHeld()

Description copied from interface: Drink

The total amount of liquid possible to be contained in this liquid container.

Specified by:

liquidHeld in interface Drink

Returns:

total liquid contained herein.

liquidRemaining

public int liquidRemaining()

Description copied from interface: Drink

The amount of liquid remaining in this liquid container. Will always be less less than liquidHeld();

Specified by:

liquidRemaining in interface Drink

Returns:

amount of liquid remaining in this liquid container.

See Also:

Drink.liquidHeld()

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

Returns:

the type of liquid contained herein

See Also:

RawMaterial

setLiquidType

public void setLiquidType(int newLiquidType)

Description copied from interface: Drink

Sets 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:

setLiquidType in interface Drink

Parameters:

newLiquidType - the type of liquid contained herein

See Also:

RawMaterial

setThirstQuenched

public void setThirstQuenched(int amount)

Description copied from interface: Drink

Set the amount of thirst points quenched every time this item is drank from.

Specified by:

setThirstQuenched in interface Drink

Parameters:

amount - of thirst quenched

See Also:

CharState

setLiquidHeld

public void setLiquidHeld(int amount)

Description copied from interface: Drink

Sets the total amount of liquid possible to be contained in this liquid container.

Specified by:

setLiquidHeld in interface Drink

Parameters:

amount - total liquid contained herein.

setLiquidRemaining

public void setLiquidRemaining(int amount)

Description copied from interface: Drink

Sets the amount of liquid remaining in this liquid container. Will always be less less than liquidHeld();

Specified by:

setLiquidRemaining in interface Drink

Parameters:

amount - amount of liquid remaining in this liquid container.

See Also:

Drink.setLiquidHeld(int)

disappearsAfterDrinking

public boolean disappearsAfterDrinking()

Description copied from interface: Drink

Settable only internally, this method returns whether this entire object is destroyed immediately after it is drank from -- like a potion.

Specified by:

disappearsAfterDrinking in interface Drink

Returns:

Whether the item survives after drinking.

containsDrink

public boolean containsDrink()

Description copied from interface: Drink

Whether this liquid container still contains any liquid.

Specified by:

containsDrink in interface Drink

Returns:

whether any liquid is left.

amountTakenToFillMe

public int amountTakenToFillMe(Drink theSource)

Description copied from interface: Drink

Given the liquid source, the amount of liquid which would need to be taken from the source liquid source to fill up THIS liquid source.

Specified by:

amountTakenToFillMe in interface Drink

Parameters:

theSource - the liquid source to fill up from

Returns:

the amount to take from the liquid source

resourceChoices

public java.util.Vector resourceChoices()

Specified by:

resourceChoices in interface Room

Overrides:

resourceChoices in class StdRoom