com.planet_ink.coffee_mud.Items.Basic
Class GenLiquidResource

java.lang.Object
  com.planet_ink.coffee_mud.Items.Basic.StdItem
      com.planet_ink.coffee_mud.Items.Basic.StdContainer
          com.planet_ink.coffee_mud.Items.Basic.StdDrink
              com.planet_ink.coffee_mud.Items.Basic.GenDrink
                  com.planet_ink.coffee_mud.Items.Basic.GenLiquidResource

All Implemented Interfaces:

Affectable, Behavable, CMObject, Contingent, DBIdentifiable, Decayable, Drink, Environmental, Modifiable, MsgListener, Physical, PhysicalAgent, Readable, Rider, StatsAffecting, Tickable, Container, Item, RawMaterial, Wearable, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class GenLiquidResource
extends GenDrink
implements RawMaterial, Drink

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Items.interfaces.RawMaterial

RawMaterial.CODES

Field Summary

protected java.lang.String	domainSource
protected static Ability	rot

Fields inherited from class com.planet_ink.coffee_mud.Items.Basic.GenDrink

readableText

Fields inherited from class com.planet_ink.coffee_mud.Items.Basic.StdDrink

amountOfLiquidHeld, amountOfLiquidRemaining, amountOfThirstQuenched, decayTime, disappearsAfterDrinking, liquidType

Fields inherited from class com.planet_ink.coffee_mud.Items.Basic.StdContainer

capacity, containType, hasALid, hasALock, isLocked, isOpen

Fields inherited from class com.planet_ink.coffee_mud.Items.Basic.StdItem

affects, baseGoldValue, basePhyStats, behaviors, cachedImageName, CODES, databaseID, description, destroyed, displayText, dispossessionTime, material, miscText, myContainer, myUses, myWornCode, name, owner, phyStats, properWornBitmap, rawImageName, riding, scripts, secretIdentity, tickStatus, wornLogicalAnd, xtraValues

Fields inherited from interface com.planet_ink.coffee_mud.Items.interfaces.RawMaterial

DEFAULT_BERRIES, DEFAULT_FISHES, DEFAULT_RESOURCE_DATA, DEFAULT_RESOURCE_DESCS, DEFAULT_RESOURCE_EFFECTS, DEFAULT_RESOURCE_SMELLS, MATERIAL_CLOTH, MATERIAL_CODES, MATERIAL_DESCS, MATERIAL_ENERGY, MATERIAL_FLESH, MATERIAL_GLASS, MATERIAL_LEATHER, MATERIAL_LIQUID, MATERIAL_MASK, MATERIAL_METAL, MATERIAL_MITHRIL, MATERIAL_NOUNDESCS, MATERIAL_PAPER, MATERIAL_PLASTIC, MATERIAL_PRECIOUS, MATERIAL_ROCK, MATERIAL_UNKNOWN, MATERIAL_VEGETATION, MATERIAL_WOODEN, RESOURCE_ADAMANTITE, RESOURCE_ALEXANDRITE, RESOURCE_AMBER, RESOURCE_AMETHYST, RESOURCE_APPLES, RESOURCE_AQUAMARINE, RESOURCE_ASH, RESOURCE_ATLANTEANSTEEL, RESOURCE_BALSA, RESOURCE_BAMBOO, RESOURCE_BANANAS, RESOURCE_BARLEY, RESOURCE_BASALT, RESOURCE_BEANS, RESOURCE_BEECHWOOD, RESOURCE_BEEF, RESOURCE_BERRIES, RESOURCE_BLACKBERRIES, RESOURCE_BLOOD, RESOURCE_BLOODSTONE, RESOURCE_BLUEBERRIES, RESOURCE_BONE, RESOURCE_BOYSENBERRIES, RESOURCE_BRASS, RESOURCE_BREAD, RESOURCE_BRONZE, RESOURCE_CACTUS, RESOURCE_CARP, RESOURCE_CARROTS, RESOURCE_CATFISH, RESOURCE_CEDAR, RESOURCE_CHEESE, RESOURCE_CHERRIES, RESOURCE_CHERRYWOOD, RESOURCE_CHINA, RESOURCE_CLAY, RESOURCE_COAL, RESOURCE_COCOA, RESOURCE_COCONUTS, RESOURCE_COFFEE, RESOURCE_COFFEEBEANS, RESOURCE_COPPER, RESOURCE_CORN, RESOURCE_COTTON, RESOURCE_CRACKER, RESOURCE_CRANBERRIES, RESOURCE_CRYSOBERYL, RESOURCE_CRYSTAL, RESOURCE_DATES, RESOURCE_DIAMOND, RESOURCE_DRAGONBLOOD, RESOURCE_DRAGONMEAT, RESOURCE_DRINKABLE, RESOURCE_DUST, RESOURCE_EBONY, RESOURCE_EGGS, RESOURCE_ELM, RESOURCE_ENERGY, RESOURCE_FEATHERS, RESOURCE_FISH, RESOURCE_FLINT, RESOURCE_FLOWERS, RESOURCE_FRESHWATER, RESOURCE_FRUIT, RESOURCE_FUR, RESOURCE_GARLIC, RESOURCE_GARNET, RESOURCE_GEM, RESOURCE_GLASS, RESOURCE_GOLD, RESOURCE_GRANITE, RESOURCE_GRAPES, RESOURCE_GREENS, RESOURCE_HEMP, RESOURCE_HERBS, RESOURCE_HICKORY, RESOURCE_HIDE, RESOURCE_HONEY, RESOURCE_HOPS, RESOURCE_IRON, RESOURCE_IRONWOOD, RESOURCE_IVORY, RESOURCE_JADE, RESOURCE_LAMPOIL, RESOURCE_LAPIS, RESOURCE_LEAD, RESOURCE_LEATHER, RESOURCE_LEMONS, RESOURCE_LIMES, RESOURCE_LIMESTONE, RESOURCE_LIQUOR, RESOURCE_MAPLE, RESOURCE_MARBLE, RESOURCE_MASK, RESOURCE_MEAT, RESOURCE_MESQUITE, RESOURCE_MILK, RESOURCE_MITHRIL, RESOURCE_MOONSTONE, RESOURCE_MUSHROOMS, RESOURCE_MUTTON, RESOURCE_NOTHING, RESOURCE_NUTS, RESOURCE_OAK, RESOURCE_OBSIDIAN, RESOURCE_OLIVES, RESOURCE_ONIONS, RESOURCE_ONYX, RESOURCE_OPAL, RESOURCE_ORANGES, RESOURCE_PAPER, RESOURCE_PEACHES, RESOURCE_PEARL, RESOURCE_PEPPERS, RESOURCE_PERFUME, RESOURCE_PERIDOT, RESOURCE_PINE, RESOURCE_PINEAPPLES, RESOURCE_PIPEWEED, RESOURCE_PLASTIC, RESOURCE_PLATINUM, RESOURCE_PLUMS, RESOURCE_POISON, RESOURCE_PORK, RESOURCE_POTATOES, RESOURCE_POULTRY, RESOURCE_PUMICE, RESOURCE_QUARTZ, RESOURCE_RASPBERRIES, RESOURCE_REDWOOD, RESOURCE_RICE, RESOURCE_RUBBER, RESOURCE_SALMON, RESOURCE_SALTWATER, RESOURCE_SAND, RESOURCE_SANDSTONE, RESOURCE_SAP, RESOURCE_SCALES, RESOURCE_SEAWEED, RESOURCE_SHALE, RESOURCE_SHRIMP, RESOURCE_SILK, RESOURCE_SILVER, RESOURCE_SMURFBERRIES, RESOURCE_SOAP, RESOURCE_SOAPSTONE, RESOURCE_SPIDERSTEEL, RESOURCE_SPRUCE, RESOURCE_STEEL, RESOURCE_STONE, RESOURCE_STRAWBERRIES, RESOURCE_SUGAR, RESOURCE_SYCAMORE, RESOURCE_TEAK, RESOURCE_TIN, RESOURCE_TOMATOES, RESOURCE_TOPAZ, RESOURCE_TROUT, RESOURCE_TUNA, RESOURCE_TURQUIOSE, RESOURCE_VINE, RESOURCE_WAX, RESOURCE_WHEAT, RESOURCE_WILLOW, RESOURCE_WOOD, RESOURCE_WOOL, RESOURCE_YEW, RESOURCE_ZINC

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

Fields inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Wearable

DEFAULT_WORN_CODES, DEFAULT_WORN_DEPENDENCYGRID, DEFAULT_WORN_DESCS, DEFAULT_WORN_ORDER, DEFAULT_WORN_WEIGHT_POINTS, DEFAULT_WORN_WEIGHTS, FILTER_ANY, FILTER_UNWORNONLY, FILTER_WORNONLY, HIGHEST_WORN_CODE, IN_INVENTORY, WORN_ABOUT_BODY, WORN_ARMS, WORN_BACK, WORN_EARS, WORN_EYES, WORN_FEET, WORN_FLOATING_NEARBY, WORN_HANDS, WORN_HEAD, WORN_HELD, WORN_LEFT_FINGER, WORN_LEFT_WRIST, WORN_LEGS, WORN_MOUTH, WORN_NECK, WORN_RIGHT_FINGER, WORN_RIGHT_WRIST, WORN_TORSO, WORN_WAIST, WORN_WIELD

Fields inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Container

CONTAIN_ANYTHING, CONTAIN_BODIES, CONTAIN_CAGED, CONTAIN_CLOTHES, CONTAIN_COINS, CONTAIN_DAGGERS, CONTAIN_DESCS, CONTAIN_DRINKABLES, CONTAIN_FOOTWEAR, CONTAIN_KEYS, CONTAIN_LIQUID, CONTAIN_ONEHANDWEAPONS, CONTAIN_OTHERWEAPONS, CONTAIN_READABLES, CONTAIN_SCROLLS, CONTAIN_SMOKEABLES, CONTAIN_SSCOMPONENTS, CONTAIN_SWORDS

Constructor Summary

GenLiquidResource()

Method Summary

java.lang.String	domainSource()
void	executeMsg(Environmental host, 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.
boolean	okMessage(Environmental host, CMMsg msg) The general message event previewer for the object.
void	quickDestroy()
boolean	rebundle()
void	setDomainSource(java.lang.String src)
void	setMaterial(int newValue) Sets the resource code representing the material out of which this item is principally made.

Methods inherited from class com.planet_ink.coffee_mud.Items.Basic.GenDrink

getCodeNum, getStat, getStatCodes, isGeneric, keyName, liquidType, readableText, sameAs, setKeyName, setLiquidType, setMiscText, setReadableText, setStat, text

Methods inherited from class com.planet_ink.coffee_mud.Items.Basic.StdDrink

amountTakenToFillMe, containsDrink, decayTime, disappearsAfterDrinking, liquidHeld, liquidRemaining, setDecayTime, setLiquidHeld, setLiquidRemaining, setThirstQuenched, thirstQuenched, totalDrinkContained

Methods inherited from class com.planet_ink.coffee_mud.Items.Basic.StdContainer

canContain, capacity, containTypes, emptyPlease, getContents, hasALid, hasALock, isInside, isLocked, isOpen, setCapacity, setContainTypes, setLidsNLocks, tick

Methods inherited from class com.planet_ink.coffee_mud.Items.Basic.StdItem

abilityImbuesMagic, addBehavior, addEffect, addNonUninvokableEffect, addScript, affectCharState, affectCharStats, affectPhyStats, alreadyWornMsg, amDestroyed, amWearingAt, baseGoldValue, basePhyStats, behaviors, canSaveDatabaseID, canWear, canWearComplete, cloneFix, compareProperLocations, compareTo, container, copyOf, databaseID, delBehavior, delEffect, delScript, description, destroy, displayText, effects, expirationDate, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchScript, fitsOn, getSaveStatIndex, getTickStatus, image, initializeClass, isReadable, isSavable, isStat, material, maxRange, minRange, miscTextFormat, name, Name, newInstance, numBehaviors, numberOfItems, numEffects, numScripts, owner, phyStats, rawImage, rawLogicalAnd, rawProperLocationBitmap, rawSecretIdentity, rawWornCode, recoverPhyStats, recursiveWeight, removeFromOwnerContainer, riding, scripts, secretIdentity, setBasePhyStats, setBaseValue, setContainer, setDatabaseID, setDescription, setDisplayText, setExpirationDate, setImage, setName, setOwner, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setReadable, setRiding, setSavable, setSecretIdentity, setUsesRemaining, stopTicking, subjectToWearAndTear, tackOns, ultimateContainer, unWear, usesRemaining, value, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWear

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.Items.interfaces.Item

baseGoldValue, container, material, numberOfItems, owner, rawSecretIdentity, recursiveWeight, removeFromOwnerContainer, secretIdentity, setBaseValue, setContainer, setOwner, setSecretIdentity, setUsesRemaining, stopTicking, subjectToWearAndTear, ultimateContainer, usesRemaining, value

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

riding, setRiding

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

description, displayText, expirationDate, image, isGeneric, maxRange, minRange, miscTextFormat, name, Name, rawImage, sameAs, 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.StatsAffecting

affectCharState, affectCharStats, affectPhyStats

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

copyOf, initializeClass, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

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

getSaveStatIndex, getStat, getStatCodes, isStat, setStat

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

addEffect, addNonUninvokableEffect, basePhyStats, delEffect, effects, fetchEffect, fetchEffect, numEffects, phyStats, recoverPhyStats, setBasePhyStats

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

addBehavior, addScript, behaviors, delBehavior, delScript, fetchBehavior, fetchBehavior, fetchScript, numBehaviors, numScripts, scripts

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

canSaveDatabaseID, databaseID, setDatabaseID

Methods inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Wearable

amWearingAt, canWear, compareProperLocations, fitsOn, rawLogicalAnd, rawProperLocationBitmap, rawWornCode, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, unWear, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWear

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

isReadable, readableText, setReadable, setReadableText

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

amountTakenToFillMe, containsDrink, disappearsAfterDrinking, liquidHeld, liquidRemaining, liquidType, setLiquidHeld, setLiquidRemaining, setLiquidType, setThirstQuenched, thirstQuenched

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

decayTime, setDecayTime

Field Detail

rot

protected static Ability rot

domainSource

protected java.lang.String domainSource

Constructor Detail

GenLiquidResource

public GenLiquidResource()

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 GenDrink

Returns:

the name of this class

setMaterial

public void setMaterial(int newValue)

Description copied from interface: Item

Sets the resource code representing the material out of which this item is principally made. The resource codes are composed of an integer where the highest order bits represent the basic material type, and the lower order bits represent the specific material type. These codes are defined in RawMaterial interface.

Specified by:

setMaterial in interface Item

Overrides:

setMaterial in class StdItem

See Also:

RawMaterial

executeMsg

public void executeMsg(Environmental host,
                       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 StdDrink

Parameters:

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

msg - the CMMsg that needs to be executed

See Also:

CMMsg

okMessage

public boolean okMessage(Environmental host,
                         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 StdDrink

Parameters:

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

domainSource

public java.lang.String domainSource()

Specified by:

domainSource in interface RawMaterial

setDomainSource

public void setDomainSource(java.lang.String src)

Specified by:

setDomainSource in interface RawMaterial

rebundle

public boolean rebundle()

Specified by:

rebundle in interface RawMaterial

quickDestroy

public void quickDestroy()

Specified by:

quickDestroy in interface RawMaterial