Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface MoneyLibrary

All Superinterfaces:

java.lang.Cloneable, CMLibrary, CMObject, java.lang.Comparable<CMObject>

All Known Implementing Classes:

BeanCounter

public interface MoneyLibrary
extends CMLibrary

This library manages the official list of all currencies used in the game, including the built-in default currencies: "" (DEFAULT), GOLD, COPPER, CREDIT, DOLLAR, and VICTORY This also manages the creation and distribution of actual money items in the known currencies.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MoneyLibrary.DebtItem	Interface for an object referencing a debt from one to another, denominated in base currency, and carrying a due date and interest rate.
static interface	MoneyLibrary.MoneyDefinition	Interface for an object referencing an entire currency system, including all of its denominations.
static interface	MoneyLibrary.MoneyDenomination	Interface for an object referencing a single denomination of a specific currency.

Field Summary

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

idConverter

Method Summary

Modifier and Type	Method	Description
java.lang.String	abbreviatedPrice(MOB shopkeeper, double absoluteAmount)	Given a mob to get a currency from and a total money value, this will return a very brief representation of the money in a single denomination of the currency that best matches.
java.lang.String	abbreviatedPrice(java.lang.String currency, double absoluteAmount)	Given a currency and a total money value, this will return a very brief representation of the money in a single denomination of the currency that best matches.
double	abbreviatedRePrice(MOB shopkeeper, double absoluteAmount)	Given a mob to get a currency from and a total money value, this will return final value of the given value after finding a single denomination of the currency that best matches.
double	abbreviatedRePrice(java.lang.String currency, double absoluteAmount)	Given a currency and a total money value, this will return the final value of the given value after finding a single denomination of the currency that best matches.
void	addMoney(ItemCollection IP, double deltaValue)	Adds the given amount of money to the given holders items in their native currency.
void	addMoney(ItemCollection IP, int deltaValue)	Adds the given amount of money to the given holders items in their native currency.
void	addMoney(ItemCollection IP, Container container, java.lang.String currency, double deltaValue)	Adds the given amount of money, in the given currency, to the given holders items, in the given container.
void	addMoney(ItemCollection IP, Container container, java.lang.String currency, int deltaValue)	Adds the given amount of money, in the given currency, to the given holders items, in the given container.
void	addMoney(ItemCollection IP, java.lang.String currency, double deltaValue)	Adds the given amount of money, in the given currency, to the given holders items.
void	addMoney(ItemCollection IP, java.lang.String currency, int deltaValue)	Adds the given amount of money, in the given currency, to the given holders items.
void	addToBankLedger(java.lang.String bankName, java.lang.String owner, java.lang.String explanation)	Adds a new record to the bank account ledger, which is an accounting of deposits and withdrawls.
void	adjustDebt(java.lang.String name, java.lang.String owedTo, double adjustAmt, java.lang.String reason, double interest, long due)	Adds or alters a debt record between the given debtor, and lender.
void	clearInventoryMoney(MOB mob, java.lang.String currency)	Removes all item money from the given mob, of the given currency.
void	clearZeroMoney(MOB mob, java.lang.String currency)	Removes all money from the given mob, item and npc numeric of the given currency.
MoneyLibrary.MoneyDefinition	createCurrencySet(java.lang.String currency)	Creates and registers a new currency definition.
void	delAllDebt(java.lang.String name, java.lang.String owedTo)	Deletes a particular debt record.
void	dropMoney(Room R, Container container, java.lang.String currency, double absoluteValue)	Adds the amount of money items to the given room, in the given container, of the given currency, and the given total absolute value.
java.util.List<java.lang.String>	getAllCurrencies()	Returns the list of all known currency names.
java.util.Set<java.lang.String>	getBankAccountChains(java.lang.String owner)	Returns the set of all bank chains that have accounts for the given bank account owner.
Pair<java.lang.String,java.lang.Double>	getBankBalance(java.lang.String bankName, java.lang.String owner, java.lang.String optionalCurrency)	For the given bank chain and given bank account owner name, and optionally a currency, this will return the found currency and bank balance.
java.lang.String	getBankChainCurrency(java.lang.String bankChain)	Given a bank chain, which may deal in many currencies due to having branches in many areas, this method will return the chains most popular currency.
double	getBestDenomination(java.lang.String currency, double absoluteValue)	Given a currency and a total money value in that currency, this will return the denomination which will most evenly divide into the given value.
double	getBestDenomination(java.lang.String currency, int numberOfCoins, double absoluteValue)	Given a currency, a total money value, and a number of currency coins, this will find the denomination that is closest to the total money value in that given number of coins
double[]	getBestDenominations(java.lang.String currency, double absoluteValue)	Given a currency and a total money value in that currency, this will return the denominations whose combination will produce the total value evenly.
java.lang.String	getConvertableDescription(java.lang.String currency, double denomination)	Given a currency, returns the string "Equal to" followed by the conversion of the given duration into the lowest denomination in the currency.
java.lang.String	getCurrency(CMObject E)	Returns the currency code/name most applicable to the given object.
MoneyLibrary.MoneyDefinition	getCurrencySet(java.lang.String currency)	Returns the official MoneyDefinition object for the given currency.
java.util.List<MoneyLibrary.DebtItem>	getDebt(java.lang.String name)	Returns all debt records owed by the given debtor.
java.util.List<MoneyLibrary.DebtItem>	getDebt(java.lang.String name, java.lang.String owedTo)	Returns all debt records between the given debtor and the given lender.
java.util.List<MoneyLibrary.DebtItem>	getDebtOwed(java.lang.String owedTo)	Returns all debt records owed to the given lender.
double	getDebtOwed(java.lang.String name, java.lang.String owedTo)	Returns total debt amount owed between the given debtor and the given lender.
MoneyLibrary.MoneyDenomination	getDenomination(java.lang.String currency, java.lang.String name)	Returns the denomination of the given currency and given abbreviation or name.
int	getDenominationIndex(java.lang.String currency, double value)	Returns the ordinal index of the given denomination value in the given currency definitions list of denominations.
java.lang.String	getDenominationName(MOB mob, double denomination)	Returns the name of the denomination that matches the given mobs currency, and the given denomination value
java.lang.String	getDenominationName(java.lang.String currency)	Returns the name of the lowest denomination in the given currency.
java.lang.String	getDenominationName(java.lang.String currency, double denomination)	Returns the name of the denomination that matches the given currency and the given denomination value.
java.lang.String	getDenominationName(java.lang.String currency, double denomination, long number)	Returns the amount and name of the denomination that matches the given currency and the given denomination value, in the given amount.
java.util.List<java.lang.String>	getDenominationNameSet(java.lang.String currency)	Returns the names of all the denominations in the given currency.
java.lang.String	getDenominationShortCode(java.lang.String currency, double denomination)	Given a currency and a denomination value, this will return the short code/char of the denomination.
double	getLowestDenomination(java.lang.String currency)	Returns the value of the lowest denomination in the given currency.
int	getMoney(MOB mob)	If the given mob/room is an npc with native parameter-value money set, this will return that value.
java.util.List<Coins>	getMoneyItems(ItemCollection IP, Item container, java.lang.String currency)	Scans the given mob/room and returns any money items in the given currency and given container.
java.util.List<Coins>	getMoneyItems(ItemCollection IP, java.lang.String currency)	/** Scans the given mob and returns any money items in the given currency and NOT in a container.
long	getNumberOfCoins(MOB mob, java.lang.String currency, double denomination)	Returns the number of coins that the given mob has in the given currency and the given denomination.
double	getTotalAbsoluteNativeValue(MOB mob)	Returns the accumulated total value of the money on the given mob, in that mobs native currency.
double	getTotalAbsoluteShopKeepersValue(MOB mob, MOB shopkeeper)	Returns the accumulated total value of the money on the given mob, in the given shopkeepers native currency.
double	getTotalAbsoluteValue(ItemCollection IP, Item container, java.lang.String currency)	Returns the accumulated total value of the money of the given currency, in the given container, on the given mob/room.
double	getTotalAbsoluteValue(ItemCollection IP, java.lang.String currency)	Returns the accumulated total value of the money of the given currency, on the given mob/room.
double	getTotalAbsoluteValueAllCurrencies(ItemCollection IP)	Returns the accumulated total value of the money on the given holder, counting all currencies.
void	giveSomeoneMoney(MOB recipient, double absoluteValue)	Generates a visible message of the given recipient receiving the given amount of money in their native currency from themselves.
void	giveSomeoneMoney(MOB banker, MOB customer, double absoluteValue)	Generates a visible message of the given recipient receiving the given amount of money in the banker's currency from the given banker/giver.
void	giveSomeoneMoney(MOB banker, MOB customer, java.lang.String currency, double absoluteValue)	Generates a visible message of the given recipient receiving the given amount of money in the given currency from the given banker/giver.
void	giveSomeoneMoney(MOB recipient, java.lang.String currency, double absoluteValue)	Generates a visible message of the given recipient receiving the given amount of money in the given currency from themselves.
boolean	isCurrencyMatch(java.lang.String curr1, java.lang.String curr2)	Because a currency code could include an entire definition, or maybe just the name/code itself, this method exists to resolve those differences and compare just the codes
double	lowestAbbreviatedDenomination(java.lang.String currency)	Returns the lowest denomination in the given currency that has an abbreviation char/code.
double	lowestAbbreviatedDenomination(java.lang.String currency, double absoluteAmount)	Given a currency type and an absolute value, this will return the lowest denomination that best divides into the given absolute amount AND which has a abbreviation char/code.
java.util.List<Coins>	makeAllCurrency(java.lang.String currency, double absoluteValue)	This great workhorse generates the individual denomination coins necessary to properly represent the given absolute value in the given currency.
Coins	makeBestCurrency(MOB mob, double absoluteValue)	Given a mob to derive a currency from, this will find the denomination in that currency which is capable to generating a stack of money closest to the given value.
Coins	makeBestCurrency(MOB mob, double absoluteValue, ItemCollection owner, Container container)	Given a mob to derive a currency from, this will find the denomination in that currency which is capable to generating a stack of money closest to the given value.
Coins	makeBestCurrency(java.lang.String currency, double absoluteValue)	Given a currency type, this will find the denomination in that currency which is capable to generating a stack of money closest to the given value.
Coins	makeBestCurrency(java.lang.String currency, double absoluteValue, ItemCollection owner, Container container)	Given a currency type, this will find the denomination in that currency which is capable to generating a stack of money closest to the given value.
Coins	makeCurrency(java.lang.String currency, double denomination, long numberOfCoins)	Generates an individual currency item of the given type, denomination, and number, as an item stack of currency item.
boolean	modifyBankGold(java.lang.String bankName, java.lang.String owner, java.lang.String explanation, java.lang.String currency, double deltaAmount)	Modifies the amount of money in the bank account of the given account name owner and the given bank name.
boolean	modifyLocalBankGold(Area A, java.lang.String owner, java.lang.String explanation, double deltaAmount)	Starting with the given area, and proceeding to parent areas, this will attempt to alter the amount of money in any bank chains account associated with the given account name owner.
boolean	modifyThisAreaBankGold(Area A, java.util.Set<java.lang.String> triedBanks, java.lang.String owner, java.lang.String explanation, double deltaAmount)	Loops through all bank chains in the given area and attempts to find an account for the given account name owner and modify the amount of money in the bank account.
java.lang.String	nameCurrencyLong(MOB mob, double absoluteValue)	Given a mob whose currency to use, this will split the given amount of value into denominations of that currency and return a string with the number and denoms, comma delimited, necessary to produce the value.
java.lang.String	nameCurrencyLong(MOB mob, int absoluteValue)	Given a mob whose currency to use, this will split the given amount of value into denominations of that currency and return a string with the number and denoms, comma delimited, necessary to produce the value.
java.lang.String	nameCurrencyLong(java.lang.String currency, double absoluteValue)	Given a currency, this will split the given amount of value into denominations and return a string with the number and denoms, comma delimited, necessary to produce the value.
java.lang.String	nameCurrencyShort(MOB mob, double absoluteValue)	Given a mob to get a currency, this will determine the denomination in that currency closest to the given total value, and return a string denoting that denomination and the amount, in x.xx form, of that denomination.
java.lang.String	nameCurrencyShort(MOB mob, int absoluteValue)	Given a mob to get a currency, this will determine the denomination in that currency closest to the given total value, and return a string denoting that denomination and the amount, in x.xx form, of that denomination.
java.lang.String	nameCurrencyShort(java.lang.String currency, double absoluteValue)	Given a particular currency, this will determine the denomination in that currency closest to the given total value, and return a string denoting that denomination and the amount, in x.xx form, of that denomination.
boolean	putCoinsBack(Coins C, ItemCollection coll)	When a Coins item is dropped into a new collection, this method will seek out a similar denominated pile and update it, thus destroying the given coins, and return true, otherwise it does nothing and returns false.
void	removeMoney(Room R, Container container, java.lang.String currency, double absoluteValue)	Removes the amount of money items from the given room, in the given container, of the given currency, and the given total absolute value.
void	setMoney(MOB mob, double absoluteAmount)	Sets the total amount of money the given mob has in their native currency to the given absolute value.
void	setMoney(MOB mob, int amount)	Called only on npcs saved to the database, and primarily for legacy use, this method destroys any money items and sets the npc money property to the given absolute value.
void	setMoney(MOB mob, java.lang.String currency, double absoluteAmount)	Sets the total amount of money the given mob has in the given currency to the given absolute value.
void	subtractMoney(ItemCollection IP, double positiveDeltaAmount)	Removes the given total amount of money from the given mob/room.
void	subtractMoney(ItemCollection IP, double denomination, double positiveDeltaAmount)	Removes the given total amount of money from the given IP, in their native currency and the given denomination of that currency.
void	subtractMoney(ItemCollection IP, Container container, java.lang.String currency, double positiveDeltaAmount)	Removes the given total amount of money from the given IP, in the given currency and the given container of that currency.
void	subtractMoney(ItemCollection IP, java.lang.String currency, double positiveDeltaAmount)	Removes the given total amount of money from the given IP, in the given currency.
void	subtractMoney(ItemCollection IP, java.lang.String currency, double denomination, double positiveDeltaAmount)	Removes the given total amount of money from the given IP, in the given currency and the given denomination of that currency.
void	subtractMoneyGiveChange(MOB banker, MOB mob, double positiveDeltaAmount)	This strange method takes away all the money from the given mob, of the bankers native currency, and then has the given banker hand money back to the mob equal to the total money minus the given amount.
void	subtractMoneyGiveChange(MOB banker, MOB mob, int positiveDeltaAmount)	This strange method takes away all the money from the given mob, of the bankers native currency, and then has the given banker hand money back to the mob equal to the total money minus the given amount.
void	subtractMoneyGiveChange(MOB banker, MOB mob, java.lang.String currency, double positiveDeltaAmount)	This strange method takes away all the money from the given mob, of the given currency, and then has the given banker hand money back to the mob equal to the total money minus the given amount.
void	unloadCurrencySet(java.lang.String currency)	Unregisters the given currency

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary

activate, getServiceClient, L, propertiesLoaded, shutdown

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

copyOf, ID, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

unloadCurrencySet

void unloadCurrencySet(java.lang.String currency)

Unregisters the given currency

Parameters:

currency - the currency to kill

createCurrencySet

MoneyLibrary.MoneyDefinition createCurrencySet(java.lang.String currency)

Creates and registers a new currency definition. This will be an encoded form like: NAME=DEFINITION DEFINITION=DENOMINATION,DENOMINATION,etc DENOMINATION=AMOUNT FULL_NAME (ABBREVIATION) AMOUNT=amount of base value for the denomination FULL_NAME=full name of the denomination with (s) ABBRECIATION=short code char of the denom

Parameters:

currency - the encoded currency definition

Returns:

null, or the definition of the currency

getCurrencySet

MoneyLibrary.MoneyDefinition getCurrencySet(java.lang.String currency)

Returns the official MoneyDefinition object for the given currency.

Parameters:

currency - the currency

Returns:

the definition of the currency

getAllCurrencies

java.util.List<java.lang.String> getAllCurrencies()

Returns the list of all known currency names. This could change over time.

Returns:

the list of all known currencies

abbreviatedRePrice

double abbreviatedRePrice(MOB shopkeeper,
                          double absoluteAmount)

Given a mob to get a currency from and a total money value, this will return final value of the given value after finding a single denomination of the currency that best matches.

Parameters:

shopkeeper - the mob to get a currency from to use

absoluteAmount - the total amount of value to use

Returns:

the best total value when converting to a single denomination

See Also:

lowestAbbreviatedDenomination(String, double), abbreviatedPrice(MOB, double), abbreviatedPrice(String, double), abbreviatedRePrice(MOB, double), abbreviatedRePrice(String, double)

abbreviatedRePrice

double abbreviatedRePrice(java.lang.String currency,
                          double absoluteAmount)

Given a currency and a total money value, this will return the final value of the given value after finding a single denomination of the currency that best matches.

Parameters:

currency - the currency to use

absoluteAmount - the total amount of value to use

Returns:

the best total value when converting to a single denomination

See Also:

lowestAbbreviatedDenomination(String, double), abbreviatedPrice(MOB, double), abbreviatedPrice(String, double), abbreviatedRePrice(MOB, double), abbreviatedRePrice(String, double)

abbreviatedPrice

java.lang.String abbreviatedPrice(MOB shopkeeper,
                                  double absoluteAmount)

Given a mob to get a currency from and a total money value, this will return a very brief representation of the money in a single denomination of the currency that best matches.

Parameters:

shopkeeper - the mob to get a currency from to use

absoluteAmount - the total amount of value to name

Returns:

the best tiny price to show in a single denomination

See Also:

lowestAbbreviatedDenomination(String, double), abbreviatedPrice(MOB, double), abbreviatedPrice(String, double), abbreviatedRePrice(MOB, double), abbreviatedRePrice(String, double)

abbreviatedPrice

java.lang.String abbreviatedPrice(java.lang.String currency,
                                  double absoluteAmount)

Given a currency and a total money value, this will return a very brief representation of the money in a single denomination of the currency that best matches.

Parameters:

currency - the currency to use

absoluteAmount - the total amount of value to name

Returns:

the best tiny price to show in a single denomination

See Also:

lowestAbbreviatedDenomination(String, double), abbreviatedPrice(MOB, double), abbreviatedPrice(String, double), abbreviatedRePrice(MOB, double), abbreviatedRePrice(String, double)

getDenominationIndex

int getDenominationIndex(java.lang.String currency,
                         double value)

Returns the ordinal index of the given denomination value in the given currency definitions list of denominations.

Parameters:

currency - the currency to use

value - the denomination value

Returns:

-1, or the index of the denom value

getDenominationNameSet

java.util.List<java.lang.String> getDenominationNameSet(java.lang.String currency)

Returns the names of all the denominations in the given currency.

Parameters:

currency - the currency to get denominations for

Returns:

the list of all denomination names

getLowestDenomination

double getLowestDenomination(java.lang.String currency)

Returns the value of the lowest denomination in the given currency.

Parameters:

currency - the currency to use

Returns:

the lowest denomination value in the currency

See Also:

lowestAbbreviatedDenomination(String, double), lowestAbbreviatedDenomination(String)

lowestAbbreviatedDenomination

double lowestAbbreviatedDenomination(java.lang.String currency)

Returns the lowest denomination in the given currency that has an abbreviation char/code.

Parameters:

currency - the currency to find a denomination for

Returns:

the lowest denomination with an abbreviation char

See Also:

lowestAbbreviatedDenomination(String, double), getLowestDenomination(String)

getDenomination

MoneyLibrary.MoneyDenomination getDenomination(java.lang.String currency,
                                               java.lang.String name)

Returns the denomination of the given currency and given abbreviation or name.

Parameters:

currency - the currency

name - the abbreviation or name

Returns:

null, or the denomination

lowestAbbreviatedDenomination

double lowestAbbreviatedDenomination(java.lang.String currency,
                                     double absoluteAmount)

Given a currency type and an absolute value, this will return the lowest denomination that best divides into the given absolute amount AND which has a abbreviation char/code.

Parameters:

currency - the currency type

absoluteAmount - the total amount to divide into

Returns:

the lowest denomination to use that is abbreviated

See Also:

lowestAbbreviatedDenomination(String), getLowestDenomination(String), getDenominationName(String)

getDenominationShortCode

java.lang.String getDenominationShortCode(java.lang.String currency,
                                          double denomination)

Given a currency and a denomination value, this will return the short code/char of the denomination.

Parameters:

currency - the currency to use

denomination - the denomination value

Returns:

the name of the denominations short code

See Also:

getDenominationName(String, double)

getDenominationName

java.lang.String getDenominationName(java.lang.String currency)

Returns the name of the lowest denomination in the given currency.

Parameters:

currency - the currency to use

Returns:

the name of the lowest denomination in that currency

See Also:

getDenominationName(String, double, long), getDenominationName(String, double), getDenominationName(MOB, double), getLowestDenomination(String)

getDenominationName

java.lang.String getDenominationName(java.lang.String currency,
                                     double denomination,
                                     long number)

Returns the amount and name of the denomination that matches the given currency and the given denomination value, in the given amount. This handles plurals!

Parameters:

currency - the currency type to use

denomination - the denomination value to match

number - the amount of the denomination to name

Returns:

the amount and name of the denomination

See Also:

getDenominationName(String), getDenominationName(String, double), getDenominationName(MOB, double)

getDenominationName

java.lang.String getDenominationName(java.lang.String currency,
                                     double denomination)

Returns the name of the denomination that matches the given currency and the given denomination value.

Parameters:

currency - the currency type to use

denomination - the denomination value to match

Returns:

the name of the denomination

See Also:

getDenominationName(String), getDenominationName(String, double, long), getDenominationName(MOB, double), getDenominationShortCode(String, double)

getDenominationName

java.lang.String getDenominationName(MOB mob,
                                     double denomination)

Returns the name of the denomination that matches the given mobs currency, and the given denomination value

Parameters:

mob - the mob to get a currency from

denomination - the denomination value to match

Returns:

the name of the denomination

See Also:

getDenominationName(String), getDenominationName(String, double, long), getDenominationName(String, double)

getBestDenomination

double getBestDenomination(java.lang.String currency,
                           double absoluteValue)

Given a currency and a total money value in that currency, this will return the denomination which will most evenly divide into the given value.

Parameters:

currency - the currency to get denominations from

absoluteValue - the total value to parse out

Returns:

the best denomination to use to represent the given value

See Also:

getBestDenomination(String, int, double), getBestDenominations(String, double)

getBestDenomination

double getBestDenomination(java.lang.String currency,
                           int numberOfCoins,
                           double absoluteValue)

Given a currency, a total money value, and a number of currency coins, this will find the denomination that is closest to the total money value in that given number of coins

Parameters:

currency - the currency to use

numberOfCoins - the number of coins that MUST be used

absoluteValue - the total value to get cloest to

Returns:

the denomination value that matches best

See Also:

getBestDenomination(String, double), getBestDenominations(String, double)

getBestDenominations

double[] getBestDenominations(java.lang.String currency,
                              double absoluteValue)

Given a currency and a total money value in that currency, this will return the denominations whose combination will produce the total value evenly.

Parameters:

currency - the currency to get denominations from

absoluteValue - the total value to parse out

Returns:

the set of denominations that will make up the value

See Also:

getBestDenomination(String, double), getBestDenomination(String, int, double)

getConvertableDescription

java.lang.String getConvertableDescription(java.lang.String currency,
                                           double denomination)

Given a currency, returns the string "Equal to" followed by the conversion of the given duration into the lowest denomination in the currency. If the given denomination is already the lowest, it returns ""

Parameters:

currency - the currency to get a conversion for

denomination - the denomination to get a conversion to lowest for

Returns:

the conversion Equal to string

nameCurrencyShort

java.lang.String nameCurrencyShort(MOB mob,
                                   double absoluteValue)

Given a mob to get a currency, this will determine the denomination in that currency closest to the given total value, and return a string denoting that denomination and the amount, in x.xx form, of that denomination. This is for display purposes only.

Parameters:

mob - the mob from whom to get a currency to use

absoluteValue - the total value to show

Returns:

the close denomination with of a short form of the value

See Also:

nameCurrencyLong(String, double), nameCurrencyShort(String, double), nameCurrencyShort(MOB, int)

nameCurrencyShort

java.lang.String nameCurrencyShort(MOB mob,
                                   int absoluteValue)

Given a mob to get a currency, this will determine the denomination in that currency closest to the given total value, and return a string denoting that denomination and the amount, in x.xx form, of that denomination. This is for display purposes only.

Parameters:

mob - the mob from which to get the currency to use

absoluteValue - the total value to show

Returns:

the close denomination with of a short form of the value

See Also:

nameCurrencyLong(String, double), nameCurrencyShort(String, double), nameCurrencyShort(MOB, double)

nameCurrencyShort

java.lang.String nameCurrencyShort(java.lang.String currency,
                                   double absoluteValue)

Given a particular currency, this will determine the denomination in that currency closest to the given total value, and return a string denoting that denomination and the amount, in x.xx form, of that denomination. This is for display purposes only.

Parameters:

currency - the currency to use

absoluteValue - the total value to show

Returns:

the close denomination with of a short form of the value

See Also:

nameCurrencyLong(String, double), nameCurrencyShort(MOB, double), nameCurrencyShort(MOB, int)

nameCurrencyLong

java.lang.String nameCurrencyLong(MOB mob,
                                  double absoluteValue)

Given a mob whose currency to use, this will split the given amount of value into denominations of that currency and return a string with the number and denoms, comma delimited, necessary to produce the value.

Parameters:

mob - the mob whose currency to use

absoluteValue - the total value of the money

Returns:

the long form of all the denominations to make up the value

See Also:

nameCurrencyLong(MOB, int), nameCurrencyLong(String, double), nameCurrencyShort(String, double)

nameCurrencyLong

java.lang.String nameCurrencyLong(MOB mob,
                                  int absoluteValue)

Given a mob whose currency to use, this will split the given amount of value into denominations of that currency and return a string with the number and denoms, comma delimited, necessary to produce the value.

Parameters:

mob - the mob whose currency to use

absoluteValue - the total value of the money

Returns:

the long form of all the denominations to make up the value

See Also:

nameCurrencyLong(MOB, double), nameCurrencyLong(String, double), nameCurrencyShort(String, double)

nameCurrencyLong

java.lang.String nameCurrencyLong(java.lang.String currency,
                                  double absoluteValue)

Given a currency, this will split the given amount of value into denominations and return a string with the number and denoms, comma delimited, necessary to produce the value.

Parameters:

currency - the currency to use

absoluteValue - the total value of the money

Returns:

the long form of all the denominations to make up the value

See Also:

nameCurrencyLong(MOB, double), nameCurrencyLong(MOB, int), nameCurrencyShort(String, double)

makeBestCurrency

Coins makeBestCurrency(MOB mob,
                       double absoluteValue,
                       ItemCollection owner,
                       Container container)

Given a mob to derive a currency from, this will find the denomination in that currency which is capable to generating a stack of money closest to the given value. It will then give that money to the given owner in the given container.

Parameters:

mob - the mob from whom to get a currency to use

absoluteValue - the amount to approximate

owner - the new owner of the returned item

container - the container to put the item in

Returns:

the stack of currency whose value is closest to the value

See Also:

makeBestCurrency(MOB, double), makeBestCurrency(String, double), makeBestCurrency(String, double, ItemCollection, Container), makeAllCurrency(String, double), makeCurrency(String, double, long)

makeBestCurrency

Coins makeBestCurrency(java.lang.String currency,
                       double absoluteValue,
                       ItemCollection owner,
                       Container container)

Given a currency type, this will find the denomination in that currency which is capable to generating a stack of money closest to the given value. It will then give that money to the given owner in the given container.

Parameters:

currency - the currency to use

absoluteValue - the amount to approximate

owner - the new owner of the returned item

container - the container to put the item in

Returns:

the stack of currency whose value is closest to the value

See Also:

makeBestCurrency(MOB, double), makeBestCurrency(String, double), makeBestCurrency(MOB, double, ItemCollection, Container), makeAllCurrency(String, double), makeCurrency(String, double, long)

makeBestCurrency

Coins makeBestCurrency(MOB mob,
                       double absoluteValue)

Given a mob to derive a currency from, this will find the denomination in that currency which is capable to generating a stack of money closest to the given value.

Parameters:

mob - the mob to get the native currency from

absoluteValue - the amount to approximate

Returns:

the stack of currency whose value is closest to the value

See Also:

makeBestCurrency(String, double), makeBestCurrency(MOB, double, ItemCollection, Container), makeBestCurrency(String, double, ItemCollection, Container), makeAllCurrency(String, double), makeCurrency(String, double, long)

makeBestCurrency

Coins makeBestCurrency(java.lang.String currency,
                       double absoluteValue)

Given a currency type, this will find the denomination in that currency which is capable to generating a stack of money closest to the given value.

Parameters:

currency - the currency to use

absoluteValue - the amount to approximate

Returns:

the stack of currency whose value is closest to the value

See Also:

makeBestCurrency(MOB, double), makeBestCurrency(MOB, double, ItemCollection, Container), makeBestCurrency(String, double, ItemCollection, Container), makeAllCurrency(String, double), makeCurrency(String, double, long)

makeCurrency

Coins makeCurrency(java.lang.String currency,
                   double denomination,
                   long numberOfCoins)

Generates an individual currency item of the given type, denomination, and number, as an item stack of currency item.

Parameters:

currency - the currency of the money

denomination - the denomination of that money

numberOfCoins - the number of coins of that denomination in the stack

Returns:

the currency item representing the currency stack

See Also:

makeAllCurrency(String, double), makeBestCurrency(String, double)

makeAllCurrency

java.util.List<Coins> makeAllCurrency(java.lang.String currency,
                                      double absoluteValue)

This great workhorse generates the individual denomination coins necessary to properly represent the given absolute value in the given currency.

Parameters:

currency - the currency to make the money in

absoluteValue - the absolute value of all the money to make combined

Returns:

individual denomination coin items that add up to the value

See Also:

makeCurrency(String, double, long), makeBestCurrency(String, double)

addMoney

void addMoney(ItemCollection IP,
              int deltaValue)

Adds the given amount of money to the given holders items in their native currency.

Parameters:

IP - the holder to have more money

deltaValue - the amount of total value to add

See Also:

addMoney(ItemCollection, double), addMoney(ItemCollection, String, double), addMoney(ItemCollection, String, int), addMoney(ItemCollection, Container, String, double), addMoney(ItemCollection, Container, String, int)

addMoney

void addMoney(ItemCollection IP,
              double deltaValue)

Adds the given amount of money to the given holders items in their native currency.

Parameters:

IP - the mob to have more money

deltaValue - the amount of total value to add

See Also:

addMoney(ItemCollection, int), addMoney(ItemCollection, String, double), addMoney(ItemCollection, String, int), addMoney(ItemCollection, Container, String, double), addMoney(ItemCollection, Container, String, int)

addMoney

void addMoney(ItemCollection IP,
              java.lang.String currency,
              int deltaValue)

Adds the given amount of money, in the given currency, to the given holders items.

Parameters:

IP - the mob to have more money

currency - the currency of the money to make

deltaValue - the amount of total value to add

See Also:

addMoney(ItemCollection, double), addMoney(ItemCollection, int), addMoney(ItemCollection, String, double), addMoney(ItemCollection, Container, String, double), addMoney(ItemCollection, Container, String, int)

addMoney

void addMoney(ItemCollection IP,
              java.lang.String currency,
              double deltaValue)

Adds the given amount of money, in the given currency, to the given holders items.

Parameters:

IP - the mob to have more money

currency - the currency of the money to make

deltaValue - the amount of total value to add

See Also:

addMoney(ItemCollection, double), addMoney(ItemCollection, int), addMoney(ItemCollection, String, int), addMoney(ItemCollection, Container, String, double), addMoney(ItemCollection, Container, String, int)

addMoney

void addMoney(ItemCollection IP,
              Container container,
              java.lang.String currency,
              int deltaValue)

Adds the given amount of money, in the given currency, to the given holders items, in the given container.

Parameters:

IP - the mob to have more money

container - null, or the container to put the money in

currency - the currency of the money to make

deltaValue - the amount of total value to add

See Also:

addMoney(ItemCollection, double), addMoney(ItemCollection, int), addMoney(ItemCollection, String, double), addMoney(ItemCollection, String, int), addMoney(ItemCollection, Container, String, double)

addMoney

void addMoney(ItemCollection IP,
              Container container,
              java.lang.String currency,
              double deltaValue)

Adds the given amount of money, in the given currency, to the given holders items, in the given container.

Parameters:

IP - the mob to have more money

container - null, or the container to put the money in

currency - the currency of the money to make

deltaValue - the amount of total value to add

See Also:

addMoney(ItemCollection, double), addMoney(ItemCollection, int), addMoney(ItemCollection, String, double), addMoney(ItemCollection, String, int), addMoney(ItemCollection, Container, String, int)

giveSomeoneMoney

void giveSomeoneMoney(MOB recipient,
                      double absoluteValue)

Generates a visible message of the given recipient receiving the given amount of money in their native currency from themselves. Yea, it's weird.

Parameters:

recipient - the recipient of the money

absoluteValue - the absolute amount of the money to give

See Also:

giveSomeoneMoney(MOB, MOB, double), giveSomeoneMoney(MOB, String, double), giveSomeoneMoney(MOB, MOB, String, double)

giveSomeoneMoney

void giveSomeoneMoney(MOB recipient,
                      java.lang.String currency,
                      double absoluteValue)

Generates a visible message of the given recipient receiving the given amount of money in the given currency from themselves. Yea, it's weird.

Parameters:

recipient - the recipient of the money

currency - the currency the money is in

absoluteValue - the absolute amount of the money to give

See Also:

giveSomeoneMoney(MOB, double), giveSomeoneMoney(MOB, MOB, double), giveSomeoneMoney(MOB, MOB, String, double)

giveSomeoneMoney

void giveSomeoneMoney(MOB banker,
                      MOB customer,
                      double absoluteValue)

Generates a visible message of the given recipient receiving the given amount of money in the banker's currency from the given banker/giver. The money is created, given to the banker, who gives it to the recipient.

Parameters:

banker - the giver of the money

customer - the recipient of the money

absoluteValue - the absolute amount of the money to give

See Also:

giveSomeoneMoney(MOB, double), giveSomeoneMoney(MOB, String, double), giveSomeoneMoney(MOB, MOB, String, double)

giveSomeoneMoney

void giveSomeoneMoney(MOB banker,
                      MOB customer,
                      java.lang.String currency,
                      double absoluteValue)

Generates a visible message of the given recipient receiving the given amount of money in the given currency from the given banker/giver. The money is created, given to the banker, who gives it to the recipient.

Parameters:

banker - the giver of the money

customer - the recipient of the money

currency - the currency the money is in

absoluteValue - the absolute amount of the money to give

See Also:

giveSomeoneMoney(MOB, double), giveSomeoneMoney(MOB, MOB, double), giveSomeoneMoney(MOB, String, double)

addToBankLedger

void addToBankLedger(java.lang.String bankName,
                     java.lang.String owner,
                     java.lang.String explanation)

Adds a new record to the bank account ledger, which is an accounting of deposits and withdrawls.

Parameters:

bankName - the bank chain name

owner - the account owner name (a player usually)

explanation - a brief explanation of what happened

See Also:

getBankAccountChains(String), getBankBalance(String, String, String), modifyBankGold(String, String, String, String, double), modifyThisAreaBankGold(Area, Set, String, String, double), modifyLocalBankGold(Area, String, String, double), getBankChainCurrency(String)

getBankAccountChains

java.util.Set<java.lang.String> getBankAccountChains(java.lang.String owner)

Returns the set of all bank chains that have accounts for the given bank account owner.

Parameters:

owner - the bank account owner, typically a player

Returns:

a set of all bank chains found, could be empty

See Also:

addToBankLedger(String, String, String), getBankBalance(String, String, String), modifyBankGold(String, String, String, String, double), modifyThisAreaBankGold(Area, Set, String, String, double), modifyLocalBankGold(Area, String, String, double), getBankChainCurrency(String)

getBankBalance

Pair<java.lang.String,java.lang.Double> getBankBalance(java.lang.String bankName,
                                                       java.lang.String owner,
                                                       java.lang.String optionalCurrency)

For the given bank chain and given bank account owner name, and optionally a currency, this will return the found currency and bank balance.

Parameters:

bankName - the bank chain name

owner - the account owner name (usually a player)

optionalCurrency - null, or a currency to ensure is returned

Returns:

NULL, or the currency and total amount of the bank balance

See Also:

addToBankLedger(String, String, String), getBankAccountChains(String), modifyBankGold(String, String, String, String, double), modifyThisAreaBankGold(Area, Set, String, String, double), modifyLocalBankGold(Area, String, String, double), getBankChainCurrency(String)

modifyBankGold

boolean modifyBankGold(java.lang.String bankName,
                       java.lang.String owner,
                       java.lang.String explanation,
                       java.lang.String currency,
                       double deltaAmount)

Modifies the amount of money in the bank account of the given account name owner and the given bank name.

Parameters:

bankName - the name of the bank chain

owner - the account name (player) to alter money in

explanation - the reason for the change, for the ledger

currency - the currency to use

deltaAmount - an amount to change local money by

Returns:

true if money was successfully changed at a chain here

See Also:

addToBankLedger(String, String, String), getBankAccountChains(String), getBankBalance(String, String, String), modifyThisAreaBankGold(Area, Set, String, String, double), modifyLocalBankGold(Area, String, String, double), getBankChainCurrency(String)

modifyThisAreaBankGold

boolean modifyThisAreaBankGold(Area A,
                               java.util.Set<java.lang.String> triedBanks,
                               java.lang.String owner,
                               java.lang.String explanation,
                               double deltaAmount)

Loops through all bank chains in the given area and attempts to find an account for the given account name owner and modify the amount of money in the bank account.

Parameters:

A - null or the area to find chains in

triedBanks - set of bank chains already tried (don't try again)

owner - the account name (player) to alter money in

explanation - the reason for the change, for the ledger

deltaAmount - an amount to change local money by

Returns:

true if money was successfully changed at a chain here

See Also:

addToBankLedger(String, String, String), getBankAccountChains(String), getBankBalance(String, String, String), modifyBankGold(String, String, String, String, double), modifyLocalBankGold(Area, String, String, double), getBankChainCurrency(String)

modifyLocalBankGold

boolean modifyLocalBankGold(Area A,
                            java.lang.String owner,
                            java.lang.String explanation,
                            double deltaAmount)

Starting with the given area, and proceeding to parent areas, this will attempt to alter the amount of money in any bank chains account associated with the given account name owner. If no chains associated with the area are found, it will end up just taking any chain it can find.

Parameters:

A - the area to start finding chains in

owner - the account name (player) to alter money in

explanation - the reason for the change, for the ledger

deltaAmount - an amount to change local money by

Returns:

true if money was successfully changed somewhere

See Also:

addToBankLedger(String, String, String), getBankAccountChains(String), getBankBalance(String, String, String), modifyBankGold(String, String, String, String, double), modifyThisAreaBankGold(Area, Set, String, String, double), getBankChainCurrency(String)

getBankChainCurrency

java.lang.String getBankChainCurrency(java.lang.String bankChain)

Given a bank chain, which may deal in many currencies due to having branches in many areas, this method will return the chains most popular currency.

Parameters:

bankChain - the bank chain name

Returns:

null, or a currency

See Also:

addToBankLedger(String, String, String), getBankAccountChains(String), getBankBalance(String, String, String), modifyBankGold(String, String, String, String, double), modifyThisAreaBankGold(Area, Set, String, String, double), modifyLocalBankGold(Area, String, String, double)

subtractMoneyGiveChange

void subtractMoneyGiveChange(MOB banker,
                             MOB mob,
                             int positiveDeltaAmount)

This strange method takes away all the money from the given mob, of the bankers native currency, and then has the given banker hand money back to the mob equal to the total money minus the given amount.

Parameters:

banker - the banker who gives change

mob - the mob losing their money, but maybe getting some back

positiveDeltaAmount - the amount to NOT give back

See Also:

subtractMoneyGiveChange(MOB, MOB, int), subtractMoneyGiveChange(MOB, MOB, double), subtractMoneyGiveChange(MOB, MOB, String, double)

subtractMoneyGiveChange

void subtractMoneyGiveChange(MOB banker,
                             MOB mob,
                             double positiveDeltaAmount)

This strange method takes away all the money from the given mob, of the bankers native currency, and then has the given banker hand money back to the mob equal to the total money minus the given amount.

Parameters:

banker - the banker who gives change

mob - the mob losing their money, but maybe getting some back

positiveDeltaAmount - the amount to NOT give back

See Also:

subtractMoneyGiveChange(MOB, MOB, int), subtractMoneyGiveChange(MOB, MOB, double), subtractMoneyGiveChange(MOB, MOB, String, double)

subtractMoneyGiveChange

void subtractMoneyGiveChange(MOB banker,
                             MOB mob,
                             java.lang.String currency,
                             double positiveDeltaAmount)

This strange method takes away all the money from the given mob, of the given currency, and then has the given banker hand money back to the mob equal to the total money minus the given amount.

Parameters:

banker - the banker who gives change

mob - the mob losing their money, but maybe getting some back

currency - the currency of the money to lose

positiveDeltaAmount - the amount to NOT give back

See Also:

subtractMoneyGiveChange(MOB, MOB, int), subtractMoneyGiveChange(MOB, MOB, double), subtractMoneyGiveChange(MOB, MOB, String, double)

subtractMoney

void subtractMoney(ItemCollection IP,
                   double positiveDeltaAmount)

Removes the given total amount of money from the given mob/room. This deals in currency items.

Parameters:

IP - the mob/room/item holder losing money

positiveDeltaAmount - the total value to remove

See Also:

subtractMoney(ItemCollection, double, double), subtractMoney(ItemCollection, String, double), subtractMoney(ItemCollection, Container, String, double), subtractMoney(ItemCollection, String, double, double)

subtractMoney

void subtractMoney(ItemCollection IP,
                   java.lang.String currency,
                   double positiveDeltaAmount)

Removes the given total amount of money from the given IP, in the given currency. This deals in currency items.

Parameters:

IP - the mob/room/item holder losing money

currency - the type of currency to remove

positiveDeltaAmount - the total value to remove

See Also:

subtractMoney(ItemCollection, double), subtractMoney(ItemCollection, double, double), subtractMoney(ItemCollection, Container, String, double), subtractMoney(ItemCollection, String, double, double)

subtractMoney

void subtractMoney(ItemCollection IP,
                   Container container,
                   java.lang.String currency,
                   double positiveDeltaAmount)

Removes the given total amount of money from the given IP, in the given currency and the given container of that currency. This deals in currency items.

Parameters:

IP - the mob/room/item holder losing money

container - null, or the container with the money in it

currency - the type of currency to remove

positiveDeltaAmount - the total value to remove

See Also:

subtractMoney(ItemCollection, double), subtractMoney(ItemCollection, double, double), subtractMoney(ItemCollection, String, double), subtractMoney(ItemCollection, String, double, double)

subtractMoney

void subtractMoney(ItemCollection IP,
                   double denomination,
                   double positiveDeltaAmount)

Removes the given total amount of money from the given IP, in their native currency and the given denomination of that currency. This deals in currency items.

Parameters:

IP - the mob/room/item holder losing money

denomination - the denomination of the currency to remove

positiveDeltaAmount - the total value to remove

See Also:

subtractMoney(ItemCollection, double), subtractMoney(ItemCollection, String, double), subtractMoney(ItemCollection, Container, String, double), subtractMoney(ItemCollection, String, double, double)

subtractMoney

void subtractMoney(ItemCollection IP,
                   java.lang.String currency,
                   double denomination,
                   double positiveDeltaAmount)

Removes the given total amount of money from the given IP, in the given currency and the given denomination of that currency. This deals in currency items.

Parameters:

IP - the mob/room/item holder losing money

currency - the type of currency to remove

denomination - the denomination of the currency to remove

positiveDeltaAmount - the total value to remove

See Also:

subtractMoney(ItemCollection, double), subtractMoney(ItemCollection, double, double), subtractMoney(ItemCollection, String, double), subtractMoney(ItemCollection, Container, String, double)

putCoinsBack

boolean putCoinsBack(Coins C,
                     ItemCollection coll)

When a Coins item is dropped into a new collection, this method will seek out a similar denominated pile and update it, thus destroying the given coins, and return true, otherwise it does nothing and returns false.

Parameters:

C - the coins already dropped

coll - the collection that might have a dup

Returns:

true if the coins were destroyed, false otherwise

getMoney

int getMoney(MOB mob)

If the given mob/room is an npc with native parameter-value money set, this will return that value. Otherwise, the total absolute value of all currency items on the given mob are counted up, rounded to an int, and returned.

Parameters:

mob - the mob whose money to get

Returns:

the amount of money in absolute value

setMoney

void setMoney(MOB mob,
              double absoluteAmount)

Sets the total amount of money the given mob has in their native currency to the given absolute value.

Parameters:

mob - the mob to have their money set

absoluteAmount - the amount for the mob to have

See Also:

setMoney(MOB, int), setMoney(MOB, String, double)

setMoney

void setMoney(MOB mob,
              java.lang.String currency,
              double absoluteAmount)

Sets the total amount of money the given mob has in the given currency to the given absolute value.

Parameters:

mob - the mob to have their money set

currency - the required currency to set

absoluteAmount - the amount for the mob to have

See Also:

setMoney(MOB, double), setMoney(MOB, int)

setMoney

void setMoney(MOB mob,
              int amount)

Called only on npcs saved to the database, and primarily for legacy use, this method destroys any money items and sets the npc money property to the given absolute value. The currency is determined by the start room of the npc.

Parameters:

mob - the npc to have their money set

amount - the amount of their currency to set it to

See Also:

setMoney(MOB, double), setMoney(MOB, String, double)

clearZeroMoney

void clearZeroMoney(MOB mob,
                    java.lang.String currency)

Removes all money from the given mob, item and npc numeric of the given currency.

Parameters:

mob - the mob to make poor

currency - null, or the currency items to kill

See Also:

clearInventoryMoney(MOB, String)

clearInventoryMoney

void clearInventoryMoney(MOB mob,
                         java.lang.String currency)

Removes all item money from the given mob, of the given currency.

Parameters:

mob - the mob to make poor

currency - null, or the currency to kill

See Also:

clearZeroMoney(MOB, String)

dropMoney

void dropMoney(Room R,
               Container container,
               java.lang.String currency,
               double absoluteValue)

Adds the amount of money items to the given room, in the given container, of the given currency, and the given total absolute value.

Parameters:

R - the room to add value to

container - null, or the container the money must be put in

currency - the currency of the value to add

absoluteValue - the total value of the currency items to add

See Also:

removeMoney(Room, Container, String, double)

removeMoney

void removeMoney(Room R,
                 Container container,
                 java.lang.String currency,
                 double absoluteValue)

Removes the amount of money items from the given room, in the given container, of the given currency, and the given total absolute value. It does this by just deleting all the relevant currency and re-adding what wasn't removed.

Parameters:

R - the room to remove value from

container - null, or the container the money must be in

currency - null, or the currency of the value to remove

absoluteValue - the total value of the currency items to remove

See Also:

dropMoney(Room, Container, String, double)

getMoneyItems

java.util.List<Coins> getMoneyItems(ItemCollection IP,
                                    java.lang.String currency)

/** Scans the given mob and returns any money items in the given currency and NOT in a container.

Parameters:

IP - the mob/room to scan

currency - null, or the currency the money must be in

Returns:

a list of the coin items found

See Also:

getMoney(MOB), getMoneyItems(ItemCollection, Item, String)

getMoneyItems

java.util.List<Coins> getMoneyItems(ItemCollection IP,
                                    Item container,
                                    java.lang.String currency)

Scans the given mob/room and returns any money items in the given currency and given container.

Parameters:

IP - the mob/room to scan

container - null, or the container the money must be in

currency - null, or the currency the money must be in

Returns:

a list of the coin items found

See Also:

getMoney(MOB), getMoneyItems(ItemCollection, String)

isCurrencyMatch

boolean isCurrencyMatch(java.lang.String curr1,
                        java.lang.String curr2)

Because a currency code could include an entire definition, or maybe just the name/code itself, this method exists to resolve those differences and compare just the codes

Parameters:

curr1 - the first currency code or definition

curr2 - the second currency code or definition

Returns:

true if they are the same, false otherwise

getCurrency

java.lang.String getCurrency(CMObject E)

Returns the currency code/name most applicable to the given object. This could be a mob, shopkeeper, room, or area.

Parameters:

E - the object to find a currency for

Returns:

the currency code/name

getNumberOfCoins

long getNumberOfCoins(MOB mob,
                      java.lang.String currency,
                      double denomination)

Returns the number of coins that the given mob has in the given currency and the given denomination.

Parameters:

mob - the mob to count the money of

currency - null for all, or the currency of the money to count

denomination - the denomination of the money to count

Returns:

the number of coins found

getTotalAbsoluteValue

double getTotalAbsoluteValue(ItemCollection IP,
                             Item container,
                             java.lang.String currency)

Returns the accumulated total value of the money of the given currency, in the given container, on the given mob/room.

Parameters:

IP - the money holder to count the money of

container - null, or the container that the currency must be in

currency - null for all, or the current type to filter the money through

Returns:

the absolute money value

See Also:

getTotalAbsoluteNativeValue(MOB), getTotalAbsoluteShopKeepersValue(MOB, MOB), getTotalAbsoluteValue(ItemCollection, String), getTotalAbsoluteValueAllCurrencies(ItemCollection)

getTotalAbsoluteValue

double getTotalAbsoluteValue(ItemCollection IP,
                             java.lang.String currency)

Returns the accumulated total value of the money of the given currency, on the given mob/room.

Parameters:

IP - the money holder to count the money of

currency - null for all, or the current type to filter the money through

Returns:

the absolute money value

See Also:

getTotalAbsoluteNativeValue(MOB), getTotalAbsoluteShopKeepersValue(MOB, MOB), getTotalAbsoluteValue(ItemCollection, Item, String), getTotalAbsoluteValueAllCurrencies(ItemCollection)

getTotalAbsoluteNativeValue

double getTotalAbsoluteNativeValue(MOB mob)

Returns the accumulated total value of the money on the given mob, in that mobs native currency.

Parameters:

mob - the mob to count the money of

Returns:

the absolute money value

See Also:

getTotalAbsoluteShopKeepersValue(MOB, MOB), getTotalAbsoluteValue(ItemCollection, String), getTotalAbsoluteValue(ItemCollection, Item, String), getTotalAbsoluteValueAllCurrencies(ItemCollection)

getTotalAbsoluteShopKeepersValue

double getTotalAbsoluteShopKeepersValue(MOB mob,
                                        MOB shopkeeper)

Returns the accumulated total value of the money on the given mob, in the given shopkeepers native currency.

Parameters:

mob - the mob to count the money of

shopkeeper - the shopkeeper to get the currency type from

Returns:

the absolute money value

See Also:

getTotalAbsoluteNativeValue(MOB), getTotalAbsoluteValue(ItemCollection, String), getTotalAbsoluteValue(ItemCollection, Item, String), getTotalAbsoluteValueAllCurrencies(ItemCollection)

getTotalAbsoluteValueAllCurrencies

double getTotalAbsoluteValueAllCurrencies(ItemCollection IP)

Returns the accumulated total value of the money on the given holder, counting all currencies.

Parameters:

IP - the holder to count the money of

Returns:

the absolute money value

See Also:

getTotalAbsoluteNativeValue(MOB), getTotalAbsoluteShopKeepersValue(MOB, MOB), getTotalAbsoluteValue(ItemCollection, String), getTotalAbsoluteValue(ItemCollection, Item, String)

getDebt

java.util.List<MoneyLibrary.DebtItem> getDebt(java.lang.String name)

Returns all debt records owed by the given debtor.

Parameters:

name - the debtor, usually a player name

Returns:

all debt records

See Also:

MoneyLibrary.DebtItem, getDebt(String, String), getDebtOwed(String), getDebtOwed(String, String), adjustDebt(String, String, double, String, double, long), delAllDebt(String, String)

getDebt

java.util.List<MoneyLibrary.DebtItem> getDebt(java.lang.String name,
                                              java.lang.String owedTo)

Returns all debt records between the given debtor and the given lender. There could be multiple because they could have different due dates.

Parameters:

name - the debtor, usually a player name

owedTo - the money lender, usually a bank chain

Returns:

all debt records

See Also:

MoneyLibrary.DebtItem, getDebt(String), getDebtOwed(String, String), getDebtOwed(String), adjustDebt(String, String, double, String, double, long), delAllDebt(String, String)

getDebtOwed

java.util.List<MoneyLibrary.DebtItem> getDebtOwed(java.lang.String owedTo)

Returns all debt records owed to the given lender.

Parameters:

owedTo - the money lender, usually a bank chain

Returns:

all debt records

See Also:

MoneyLibrary.DebtItem, getDebt(String), getDebt(String, String), getDebtOwed(String, String), adjustDebt(String, String, double, String, double, long), delAllDebt(String, String)

getDebtOwed

double getDebtOwed(java.lang.String name,
                   java.lang.String owedTo)

Returns total debt amount owed between the given debtor and the given lender. There could be multiple because they could have different due dates.

Parameters:

name - the debtor, usually a player name

owedTo - the money lender, usually a bank chain

Returns:

total amount owed, in base currency

See Also:

getDebt(String), getDebt(String, String), getDebtOwed(String), adjustDebt(String, String, double, String, double, long), delAllDebt(String, String)

adjustDebt

void adjustDebt(java.lang.String name,
                java.lang.String owedTo,
                double adjustAmt,
                java.lang.String reason,
                double interest,
                long due)

Adds or alters a debt record between the given debtor, and lender.

Parameters:

name - the debtor, usually a player name

owedTo - the money lender, usually a bank chain

adjustAmt - the amount to add/remove to the debt

reason - the short debt description, like "Bank Loan"

interest - the interest rate to charge on new loans/mudmonth

due - the real life due datestamp in milliseconds

See Also:

getDebt(String), getDebt(String, String), getDebtOwed(String), getDebtOwed(String, String), delAllDebt(String, String)

delAllDebt

void delAllDebt(java.lang.String name,
                java.lang.String owedTo)

Deletes a particular debt record.

Parameters:

name - the debtor, usually a player name

owedTo - the money lender, usually a bank chain

See Also:

getDebt(String), getDebt(String, String), getDebtOwed(String), getDebtOwed(String, String), adjustDebt(String, String, double, String, double, long)