com.planet_ink.coffee_mud.Items.interfaces
Interface Potion

All Superinterfaces:

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

All Known Implementing Classes:

GenMultiPotion, GenPotion, StdPotion

public interface Potion
extends Drink, MiscMagic, SpellHolder

A potion is an item that bestows some magic upong the drinker.

Nested Class Summary

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

Wearable.CODES

Field Summary

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_USUAL_NAMES, DEFAULT_WORN_WEIGHT_POINTS, DEFAULT_WORN_WEIGHTS, FILTER_ANY, FILTER_MOBINVONLY, FILTER_ROOMONLY, 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

Method Summary

void	drinkIfAble(MOB owner, Physical drinkerTarget) Causes the potion to betow its effects upon the "drinkerTarget" at the behest of the owner mob.
boolean	isDrunk() Gets whether the potion has been drunk.
void	setDrunk(boolean isTrue) Sets whether the potion has been drunk.

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

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

getSpellList, getSpells, setSpellList

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

baseGoldValue, container, material, numberOfItems, owner, rawSecretIdentity, recursiveWeight, removeFromOwnerContainer, secretIdentity, setBaseValue, setContainer, setMaterial, 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.CMObject

copyOf, ID, initializeClass, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

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

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

Method Detail

isDrunk

boolean isDrunk()

Gets whether the potion has been drunk.

Returns:

true if the potion has been drunk, false otherwise.

See Also:

setDrunk(boolean)

setDrunk

void setDrunk(boolean isTrue)

Sets whether the potion has been drunk.

Parameters:

isTrue - true if the potion has been drunk, false otherwise.

See Also:

isDrunk()

drinkIfAble

void drinkIfAble(MOB owner,
                 Physical drinkerTarget)

Causes the potion to betow its effects upon the "drinkerTarget" at the behest of the owner mob. The two are different because one person can make another person drink, if they must.

Parameters:

owner - the holder of the potion

drinkerTarget - the one drinking the potion