com.planet_ink.coffee_mud.Items.interfaces
Interface Coins

All Superinterfaces:

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

All Known Implementing Classes:

GenCoins, StdCoins

public interface Coins
extends Item

Coins are an item that represent a single coin, or a stack of dollar bills. It is a collection of currency, of a total value that can be represented in the Base Value system.

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.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_BEAMWEAPON, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, 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_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

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

java.lang.String	getCurrency() Returns the currency that this stack of money belongs to.
double	getDenomination() Returns the denomination value of this currency, in base values.
long	getNumberOfCoins() Returns the number of units of currency in the stack
double	getTotalValue() Returns the total value of this stack of currency in base value.
boolean	putCoinsBack() This method will inspect the current owner of this item for other items of identical currency and denomination.
void	setCurrency(java.lang.String named) Sets the currency that this stack of money belongs to.
void	setDenomination(double valuePerCoin) Sets the denomination value of this currency, in base values.
void	setNumberOfCoins(long number) Sets the number of units of currency in the stack

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

description, displayText, name

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

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

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

getTickStatus, name, 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.MsgListener

executeMsg, okMessage

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, ID, 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, delAllEffects, delEffect, eachEffect, effects, fetchEffect, fetchEffect, numEffects, phyStats, recoverPhyStats, setBasePhyStats

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

addBehavior, addScript, behaviors, delAllBehaviors, delAllScripts, delBehavior, delScript, eachBehavior, eachScript, 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

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

getNumberOfCoins

long getNumberOfCoins()

Returns the number of units of currency in the stack

Returns:

the number of units of currency in the stack

See Also:

setNumberOfCoins(long)

setNumberOfCoins

void setNumberOfCoins(long number)

Sets the number of units of currency in the stack

Parameters:

number - the number of units of currency in the stack

See Also:

getNumberOfCoins()

putCoinsBack

boolean putCoinsBack()

This method will inspect the current owner of this item for other items of identical currency and denomination. If any are found, it will add its numberOfCoins to THAT stack, and destroy itself. Otherwise it will do nothing

Returns:

true if this item was destroyed due to a combining, false otherwise

See Also:

getNumberOfCoins()

getDenomination

double getDenomination()

Returns the denomination value of this currency, in base values. A penny, for example, would be a denomination of 0.01, when the dollar is "base". That said, 1.0 and higher is a more common response.

Returns:

the denomination value of this currency

See Also:

setDenomination(double)

setDenomination

void setDenomination(double valuePerCoin)

Sets the denomination value of this currency, in base values. A penny, for example, would be a denomination of 0.01, when the dollar is "base". That said, 1.0 and higher is a more common response.

Parameters:

valuePerCoin - the denomination value of this currency

See Also:

getDenomination()

getTotalValue

double getTotalValue()

Returns the total value of this stack of currency in base value. It is the same as getNumberOfCoins() * getDenomination()

Returns:

the total value of this stack of currency

See Also:

getNumberOfCoins(), getDenomination()

getCurrency

java.lang.String getCurrency()

Returns the currency that this stack of money belongs to. It's a coded ID that defines a set of valid denominations, abbreviations, and so forth. Values are things like GOLDSTANDARD, DOLLARS, etc..

Returns:

the currency that this stack of money belongs to

setCurrency

void setCurrency(java.lang.String named)

Sets the currency that this stack of money belongs to. It's a coded ID that defines a set of valid denominations, abbreviations, and so forth. Values are things like GOLDSTANDARD, DOLLARS, etc..

Parameters:

named - the currency that this stack of money belongs to