Package 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, CMObject, Contingent, Decayable, Drink, Environmental, Expireable, ItemCollection, ItemPossessor, LiquidHolder, Modifiable, MsgListener, Physical, PhysicalAgent, Places, StatsAffecting, Tickable, Room, java.lang.Cloneable, java.lang.Comparable<CMObject>

Direct Known Subclasses:

IndoorWaterSurface, SaltWaterSurface, WaterSurfaceColumn, WaterThinSurface

public class WaterSurface
extends StdRoom
implements Drink

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.core.interfaces.ItemPossessor

ItemPossessor.Expire, ItemPossessor.Find, ItemPossessor.Move

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Locales.interfaces.Room

Room.VariationCode

Field Summary

Fields

Modifier and Type	Field	Description
protected int	liquidType

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

idConverter

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_VOID, CLIMASK_WET, CLIMASK_WINDY, CLIMATE_DESCS, NUM_CLIMATES, placeComparator

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

DOMAIN_INDOOR_MAP, DOMAIN_INDOORS_AIR, DOMAIN_INDOORS_CAVE, DOMAIN_INDOORS_CAVE_SEAPORT, DOMAIN_INDOORS_DESCS, DOMAIN_INDOORS_MAGIC, DOMAIN_INDOORS_METAL, DOMAIN_INDOORS_SEAPORT, 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 class com.planet_ink.coffee_mud.Locales.StdRoom

_roomID, affectPhyStats, affects, amDestroyed, atmosphere, basePhyStats, behaviors, cachedImageName, climask, combatTurnMobIndex, contents, description, displayText, doors, exits, expirationDate, gridParent, inhabitants, lastResourceTime, me, mobility, myArea, myResource, name, phyStats, rawImageName, roomRecoverMarker, scripts, skyedYet, STDCODES, tickStatus, xtraValues

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_BALLISTICK, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, TICKID_EVENT, 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_SHORTERMASK, TICKID_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Constructor Summary

Constructors

Constructor	Description
WaterSurface()

Method Summary

Modifier and Type	Method	Description
int	amountTakenToFillMe(LiquidHolder 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()	If this room has attached temporary rooms, such as a sky in an outdoor room, or underwater rooms in the ocean, this method will empty all of those rooms of their content, and then destroy those rooms.
boolean	containsLiquid()	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	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.
protected void	fixUnderwater()
java.util.List<Room>	getSky()	If this room requires attached temporary rooms, such as a sky in an outdoor room, or underwater rooms in the ocean, this method will return any existing one, or an empty list if none exist yet.
void	giveASky(int depth)	If this room requires attached temporary rooms, such as a sky in an outdoor room, or underwater rooms in the ocean, this method will create those rooms at the given left of depth.
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
protected boolean	IsUnderWaterFatClass(Room thatSea)
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.List<java.lang.Integer>	resourceChoices()	Returns a list of all resource codes for potentially gatherable resources in this room.
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 int	UnderWaterDomainType()
protected java.lang.String	UnderWaterLocaleID()

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

copyOf, initializeClass, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Contingent

amDestroyed, destroy, isSavable, setSavable

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Environmental

description, displayText, image, isGeneric, L, maxRange, minRange, miscTextFormat, Name, rawImage, sameAs, setDescription, setDisplayText, setImage, setMiscText, setName, text

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Expireable

expirationDate, setExpirationDate

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Modifiable

getSaveStatIndex, getStat, getStatCodes, isStat, setStat

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.StatsAffecting

affectCharState, affectCharStats, affectPhyStats

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, 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, genericName, getArea, getAtmosphere, getAtmosphereCode, getClimateType, getClimateTypeCode, getCodeNum, getCombatTurnMobIndex, getContextName, getExitInDir, getGridParent, getItem, getMobility, getMovementCost, getPairedExit, getRandomItem, getRawDoor, getRawExit, getReverseDir, getReverseExit, getRoomInDir, getRoomSize, getSaveStatIndex, getStat, getStatCodes, getTickStatus, image, inhabitants, initializeClass, insertItemUpTop, isContent, isGeneric, isHere, isInhabitant, isSavable, isStat, items, itemsRecursive, L, maxRange, minRange, miscTextFormat, moveItemTo, moveItemTo, myResource, name, name, Name, newInstance, numBehaviors, numEffects, numInhabitants, numItems, numPCInhabitants, numScripts, 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, setMovementCost, setName, setRawDoor, setRawExit, setResource, setRoomID, setRoomSize, setSavable, setStat, show, show, show, show, show, showHappens, showHappens, showOthers, showOthers, showSource, showSource, startItemRejuv, text, thirstPerRound, tick, toggleMobility

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable

getTickStatus, name, tick

Field Detail

liquidType

protected int liquidType

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

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()

UnderWaterDomainType

protected int UnderWaterDomainType()

IsUnderWaterFatClass

protected boolean IsUnderWaterFatClass(Room thatSea)

getSky

public java.util.List<Room> getSky()

Description copied from interface: Room

If this room requires attached temporary rooms, such as a sky in an outdoor room, or underwater rooms in the ocean, this method will return any existing one, or an empty list if none exist yet.

Specified by:

getSky in interface Room

Overrides:

getSky in class StdRoom

Returns:

the sky rooms

See Also:

Room.clearSky(), Room.getSky()

giveASky

public void giveASky(int depth)

Description copied from interface: Room

If this room requires attached temporary rooms, such as a sky in an outdoor room, or underwater rooms in the ocean, this method will create those rooms at the given left of depth.

Specified by:

giveASky in interface Room

Overrides:

giveASky in class StdRoom

Parameters:

depth - the diameter of the sky or underwater to create

See Also:

Room.clearSky(), Room.getSky()

clearSky

public void clearSky()

Description copied from interface: Room

If this room has attached temporary rooms, such as a sky in an outdoor room, or underwater rooms in the ocean, this method will empty all of those rooms of their content, and then destroy those rooms.

Specified by:

clearSky in interface Room

Overrides:

clearSky in class StdRoom

See Also:

Room.giveASky(int), Room.getSky()

fixUnderwater

protected void fixUnderwater()

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()

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

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

Specified by:

liquidHeld in interface LiquidHolder

Returns:

total liquid contained herein.

liquidRemaining

public int liquidRemaining()

Description copied from interface: LiquidHolder

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

Specified by:

liquidRemaining in interface LiquidHolder

Returns:

amount of liquid remaining in this liquid container.

See Also:

LiquidHolder.liquidHeld()

liquidType

public int liquidType()

Description copied from interface: LiquidHolder

The material type of the liquid in this container. Although a class implementing the LiquidHolder 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 LiquidHolder

Returns:

the type of liquid contained herein

See Also:

RawMaterial

setLiquidType

public void setLiquidType(int newLiquidType)

Description copied from interface: LiquidHolder

Sets the material type of the liquid in this container. Although a class implementing the LiquidHolder 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 LiquidHolder

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

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

Specified by:

setLiquidHeld in interface LiquidHolder

Parameters:

amount - total liquid contained herein.

setLiquidRemaining

public void setLiquidRemaining(int amount)

Description copied from interface: LiquidHolder

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

Specified by:

setLiquidRemaining in interface LiquidHolder

Parameters:

amount - amount of liquid remaining in this liquid container.

See Also:

LiquidHolder.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.

containsLiquid

public boolean containsLiquid()

Description copied from interface: LiquidHolder

Whether this liquid container still contains any liquid.

Specified by:

containsLiquid in interface LiquidHolder

Returns:

whether any liquid is left.

amountTakenToFillMe

public int amountTakenToFillMe(LiquidHolder theSource)

Description copied from interface: LiquidHolder

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 LiquidHolder

Parameters:

theSource - the liquid source to fill up from

Returns:

the amount to take from the liquid source

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)