com.planet_ink.coffee_mud.Items.MiscMagic
Class GenMultiPotion

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.MiscMagic.GenMultiPotion

All Implemented Interfaces:

Behavable, CMModifiable, CMObject, Decayable, Drink, Environmental, MsgListener, Rider, StatsAffecting, Tickable, Container, Item, MiscMagic, Potion, SpellHolder, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class GenMultiPotion
extends GenDrink
implements Potion

Field Summary

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, baseEnvStats, baseGoldValue, behaviors, CODES, databaseID, description, destroyed, displayText, dispossessionTime, envStats, imageName, material, miscText, myContainer, myUses, myWornCode, name, owner, properWornBitmap, riding, scripts, secretIdentity, tickStatus, wornLogicalAnd, xtraValues

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

IN_INVENTORY, WORN_ABOUT_BODY, WORN_ARMS, WORN_BACK, WORN_CODES, WORN_DEPENDENCYGRID, WORN_DESCS, 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_ORDER, WORN_RIGHT_FINGER, WORN_RIGHT_WRIST, WORN_TORSO, WORN_WAIST, WORN_WEIGHT_POINTS, WORN_WEIGHTS, WORN_WIELD, WORNREQ_ANY, WORNREQ_UNWORNONLY, WORNREQ_WORNONLY

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

IN_INVENTORY, WORN_ABOUT_BODY, WORN_ARMS, WORN_BACK, WORN_CODES, WORN_DEPENDENCYGRID, WORN_DESCS, 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_ORDER, WORN_RIGHT_FINGER, WORN_RIGHT_WRIST, WORN_TORSO, WORN_WAIST, WORN_WEIGHT_POINTS, WORN_WEIGHTS, WORN_WIELD, WORNREQ_ANY, WORNREQ_UNWORNONLY, WORNREQ_WORNONLY

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

GenMultiPotion()

Method Summary

void	drinkIfAble(MOB mob)
void	executeMsg(Environmental myHost, CMMsg msg) The general message event handler for the object.
java.lang.String	getSpellList()
java.util.Vector	getSpells()
java.lang.String	ID() The CoffeeMud Java Class ID shared by all instances of this object.
boolean	isDrunk()
boolean	isGeneric() Whether the fields of this item are set in code, or set by builders.
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.lang.String	secretIdentity() This method returns the calculated and expanded description of the properties of the item as would be discovered through the Identify spell.
void	setDrunk(boolean isTrue)
void	setReadableText(java.lang.String text) Changes the text that is written on the item.
void	setSpellList(java.lang.String list)
int	value() The default value of the item, represented in the base CoffeeMud currency.

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

getCodeNum, getStat, getStatCodes, keyName, readableText, sameAs, setKeyName, setLiquidType, setMiscText, 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

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

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

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

abilityImbuesMagic, addBehavior, addEffect, addNonUninvokableEffect, addScript, affectCharState, affectCharStats, affectEnvStats, alreadyWornMsg, amDestroyed, amWearingAt, baseEnvStats, baseGoldValue, canWear, canWearComplete, cloneEffects, cloneFix, compareProperLocations, compareTo, container, copyOf, databaseID, delBehavior, delEffect, delScript, description, destroy, displayText, envStats, expirationDate, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchScript, finalize, fitsOn, getSaveStatIndex, getTickStatus, image, initializeClass, isStat, material, maxRange, minRange, miscTextFormat, name, Name, newInstance, numBehaviors, numberOfItems, numEffects, numScripts, owner, rawImage, rawLogicalAnd, rawProperLocationBitmap, rawSecretIdentity, rawWornCode, recoverEnvStats, recursiveWeight, removeFromOwnerContainer, riding, savable, setBaseEnvStats, setBaseValue, setContainer, setDatabaseID, setDescription, setDisplayText, setExpirationDate, setImage, setMaterial, setName, setOwner, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setRiding, setSecretIdentity, setUsesRemaining, stopTicking, subjectToWearAndTear, tackOns, ultimateContainer, unWear, usesRemaining, wearAt, wearEvenIfImpossible, wearIfPossible, whereCantWear

Methods inherited from class java.lang.Object

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

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

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

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

decayTime, setDecayTime

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

amWearingAt, baseGoldValue, canWear, compareProperLocations, container, databaseID, fitsOn, material, numberOfItems, owner, rawLogicalAnd, rawProperLocationBitmap, rawSecretIdentity, rawWornCode, readableText, recursiveWeight, removeFromOwnerContainer, setBaseValue, setContainer, setDatabaseID, setMaterial, setOwner, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setSecretIdentity, setUsesRemaining, stopTicking, subjectToWearAndTear, ultimateContainer, unWear, usesRemaining, wearAt, wearEvenIfImpossible, wearIfPossible, whereCantWear

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

riding, setRiding

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

amWearingAt, baseGoldValue, canWear, compareProperLocations, container, databaseID, fitsOn, material, numberOfItems, owner, rawLogicalAnd, rawProperLocationBitmap, rawSecretIdentity, rawWornCode, readableText, recursiveWeight, removeFromOwnerContainer, setBaseValue, setContainer, setDatabaseID, setMaterial, setOwner, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setSecretIdentity, setUsesRemaining, stopTicking, subjectToWearAndTear, ultimateContainer, unWear, usesRemaining, wearAt, wearEvenIfImpossible, wearIfPossible, whereCantWear

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

riding, setRiding

Constructor Detail

GenMultiPotion

public GenMultiPotion()

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

isGeneric

public boolean isGeneric()

Description copied from interface: Environmental

Whether the fields of this item are set in code, or set by builders. Generic means that they are set by builders, in which case XML is returned by the text() method containing all of the values for all the fields.

Specified by:

isGeneric in interface Environmental

Overrides:

isGeneric in class GenDrink

Returns:

whether this item is modifiable by builders

See Also:

Environmental.text()

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 GenDrink

Returns:

the type of liquid contained herein

See Also:

RawMaterial

isDrunk

public boolean isDrunk()

Specified by:

isDrunk in interface Potion

setDrunk

public void setDrunk(boolean isTrue)

Specified by:

setDrunk in interface Potion

secretIdentity

public java.lang.String secretIdentity()

Description copied from interface: Item

This method returns the calculated and expanded description of the properties of the item as would be discovered through the Identify spell. It starts with its rawSecretIdentity() and adds to it any strings which the Ability objects contained in the Items effects list would generate. An empty string means the item has no secret properties per se.

Specified by:

secretIdentity in interface Item

Overrides:

secretIdentity in class StdItem

Returns:

a displayable string describing the secret properties of the item.

value

public int value()

Description copied from interface: Item

The default value of the item, represented in the base CoffeeMud currency. This method starts with baseGoldValue, which is a user-entered value, and adjusts according to magical enhancements and the condition of the item.

Specified by:

value in interface Item

Overrides:

value in class StdItem

Returns:

the adjusted value of the item in the base currency.

getSpellList

public java.lang.String getSpellList()

Specified by:

getSpellList in interface SpellHolder

setSpellList

public void setSpellList(java.lang.String list)

Specified by:

setSpellList in interface SpellHolder

getSpells

public java.util.Vector getSpells()

Specified by:

getSpells in interface SpellHolder

setReadableText

public void setReadableText(java.lang.String text)

Description copied from interface: Item

Changes the text that is written on the item. This method does NOT set the IS_READABLE flag on the envStats().sensesMask flag. This flag is defined in the EnvStats interface

Specified by:

setReadableText in interface Item

Overrides:

setReadableText in class GenDrink

Parameters:

text - what is written on the item. Empty string means nothing.

See Also:

EnvStats

drinkIfAble

public void drinkIfAble(MOB mob)

Specified by:

drinkIfAble in interface Potion

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 StdDrink

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 StdDrink

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