Package com.planet_ink.coffee_mud.core.interfaces

Interface Economics

All Superinterfaces:

java.lang.Cloneable, CMObject, java.lang.Comparable<CMObject>, Contingent, Environmental, Expireable, Modifiable, MsgListener, StatsAffecting, Tickable

All Known Subinterfaces:

Area, Auctioneer, AutoGenArea, Banker, Librarian, PostOffice, ShopKeeper, SubArea

All Known Implementing Classes:

BlackMarketeering, BookLoaning, GenAuctioneer, GenBanker, GenLibrarian, GenPostman, GenShopkeeper, Merchant, Moon, Planet, SlaveMarketeering, StdArea, StdAuctioneer, StdAutoGenInstance, StdBanker, StdBoardableShip, StdGridArea, StdLibrarian, StdPlanet, StdPostman, StdShopKeeper, StdSpaceShip, StdThinArea, StdThinGridArea, StdThinInstance, StdThinPlanet, StdTimeZone, SubThinInstance

public interface Economics
extends Environmental

An interface for objects capable of modifying economic conditions

Field Summary

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

idConverter

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_BALLISTICK, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, TICKID_EVENT, 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_SHORTERMASK, TICKID_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Method Summary

Modifier and Type	Method	Description
Pair<java.lang.Long,TimeClock.TimePeriod>	getFinalBudget()	Returns a description of the buying budget of the shopkeeper.
java.lang.String	getFinalCurrency()	Gets the derived currency for this object, which will be referenced by shopkeepers, bankers, and other mobs.
double[]	getFinalDevalueRate()	Returns a double array describing the percentage in the drop of the price at which this ShopKeeper will buy back items based on the number already in his inventory.
java.lang.String	getFinalIgnoreMask()	Returns the mask used to determine if a customer is ignored by the ShopKeeper.
int	getFinalInvResetRate()	Returns the number of ticks between totally resetting this ShopKeepers inventory back to what it was.
java.lang.String[]	getFinalItemPricingAdjustments()	A string set describing how pricing for this ShopKeeper will differ based on item masks The format for each string is a floating point number followers by a space and a zapper mask
java.lang.String	getFinalPrejudiceFactors()	A string describing how pricing for this ShopKeeper will differ based on customer attributes such as race.
java.lang.String	getRawBbudget()	Returns a description of the buying budget of the shopkeeper.
java.lang.String	getRawCurrency()	Gets the default currency for this object, which will be referenced by shopkeepers, bankers, and other mobs.
java.lang.String	getRawDevalueRate()	Returns a string describing the percentage in the drop of the price at which this ShopKeeper will buy back items based on the number already in his inventory.
java.lang.String	getRawIgnoreMask()	Returns the mask used to determine if a customer is ignored by the ShopKeeper.
int	getRawInvResetRate()	Returns the number of ticks between totally resetting this ShopKeepers inventory back to what it was.
java.lang.String[]	getRawItemPricingAdjustments()	A string set describing how pricing for this ShopKeeper will differ based on item masks The format for each string is a floating point number followers by a space and a zapper mask
java.lang.String	getRawPrejudiceFactors()	A string describing how pricing for this ShopKeeper will differ based on customer attributes such as race.
void	setBudget(java.lang.String factors)	Sets a description of the buying budget of the shopkeeper.
void	setCurrency(java.lang.String currency)	Returns the default currency for this object, which will be referenced by shopkeepers, bankers, and other mobs.
void	setDevalueRate(java.lang.String factors)	Sets a string describing the percentage in the drop of the price at which this ShopKeeper will buy back items based on the number already in his inventory.
void	setIgnoreMask(java.lang.String factors)	Sets the mask used to determine if a customer is ignored by the ShopKeeper.
void	setInvResetRate(int ticks)	Sets the number of ticks between totally resetting this ShopKeepers inventory back to what it was.
void	setItemPricingAdjustments(java.lang.String[] factors)	Sets the string set describing how pricing for this ShopKeeper will differ based on item masks The format for each string is a floating point number followers by a space and a zapper mask
void	setPrejudiceFactors(java.lang.String factors)	Sets the string describing how pricing for this ShopKeeper will differ based on customer attributes such as race.

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

amDestroyed, destroy, isSavable, setSavable

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

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

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

expirationDate, setExpirationDate

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

executeMsg, okMessage

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

getTickStatus, name, tick

Method Detail

getRawPrejudiceFactors

java.lang.String getRawPrejudiceFactors()

A string describing how pricing for this ShopKeeper will differ based on customer attributes such as race.

Returns:

the string describing price prejudicing

getFinalPrejudiceFactors

java.lang.String getFinalPrejudiceFactors()

A string describing how pricing for this ShopKeeper will differ based on customer attributes such as race.

Returns:

the string describing price prejudicing

setPrejudiceFactors

void setPrejudiceFactors(java.lang.String factors)

Sets the string describing how pricing for this ShopKeeper will differ based on customer attributes such as race.

Parameters:

factors - the string describing price prejudicing

getFinalItemPricingAdjustments

java.lang.String[] getFinalItemPricingAdjustments()

A string set describing how pricing for this ShopKeeper will differ based on item masks The format for each string is a floating point number followers by a space and a zapper mask

Returns:

an array of the strings describing price adjustments

getRawItemPricingAdjustments

java.lang.String[] getRawItemPricingAdjustments()

A string set describing how pricing for this ShopKeeper will differ based on item masks The format for each string is a floating point number followers by a space and a zapper mask

Returns:

an array of the strings describing price adjustments

setItemPricingAdjustments

void setItemPricingAdjustments(java.lang.String[] factors)

Sets the string set describing how pricing for this ShopKeeper will differ based on item masks The format for each string is a floating point number followers by a space and a zapper mask

Parameters:

factors - the string describing price prejudicing

getFinalIgnoreMask

java.lang.String getFinalIgnoreMask()

Returns the mask used to determine if a customer is ignored by the ShopKeeper.

Returns:

the mask used

See Also:

MaskingLibrary

getRawIgnoreMask

java.lang.String getRawIgnoreMask()

Returns the mask used to determine if a customer is ignored by the ShopKeeper.

Returns:

the mask used

See Also:

MaskingLibrary

setIgnoreMask

void setIgnoreMask(java.lang.String factors)

Sets the mask used to determine if a customer is ignored by the ShopKeeper.

Parameters:

factors - the mask to use

See Also:

MaskingLibrary

getRawBbudget

java.lang.String getRawBbudget()

Returns a description of the buying budget of the shopkeeper. Format is an amount of base currency followed by HOUR,WEEK,DAY,MONTH or YEAR.

Returns:

the string for the shopkeepers buying budget

getFinalBudget

Pair<java.lang.Long,TimeClock.TimePeriod> getFinalBudget()

Returns a description of the buying budget of the shopkeeper. Format is an amount of base currency followed by HOUR,WEEK,DAY,MONTH or YEAR.

Returns:

the pair for the shopkeepers buying budget

setBudget

void setBudget(java.lang.String factors)

Sets a description of the buying budget of the shopkeeper. Format is an amount of base currency followed by HOUR,WEEK,DAY,MONTH or YEAR.

Parameters:

factors - the string for the shopkeepers buying budget

getFinalDevalueRate

double[] getFinalDevalueRate()

Returns a double array describing the percentage in the drop of the price at which this ShopKeeper will buy back items based on the number already in his inventory. The format is a number representing the percentage price drop per normal item followed by a space, followed by a number representing the percentage price drop per raw resource item. A value of null or [0,0] would mean no drop in price for either, ever.

Returns:

null, or the price dropping percentage rule for this shopkeeper

getRawDevalueRate

java.lang.String getRawDevalueRate()

Returns a string describing the percentage in the drop of the price at which this ShopKeeper will buy back items based on the number already in his inventory. The format is a number representing the percentage price drop per normal item followed by a space, followed by a number representing the percentage price drop per raw resource item. A value of "0 0" would mean no drop in price for either, ever.

Returns:

the price dropping percentage rule for this shopkeeper

setDevalueRate

void setDevalueRate(java.lang.String factors)

Sets a string describing the percentage in the drop of the price at which this ShopKeeper will buy back items based on the number already in his inventory. The format is a number representing the percentage price drop per normal item followed by a space, followed by a number representing the percentage price drop per raw resource item. A value of "0 0" would mean no drop in price for either, ever.

Parameters:

factors - the price dropping percentage rule for this shopkeeper

getFinalInvResetRate

int getFinalInvResetRate()

Returns the number of ticks between totally resetting this ShopKeepers inventory back to what it was.

Returns:

the number of ticks between total resets of inventory

getRawInvResetRate

int getRawInvResetRate()

Returns the number of ticks between totally resetting this ShopKeepers inventory back to what it was.

Returns:

the number of ticks between total resets of inventory

setInvResetRate

void setInvResetRate(int ticks)

Sets the number of ticks between totally resetting this ShopKeepers inventory back to what it was.

Parameters:

ticks - the number of ticks between total resets of inventory

getFinalCurrency

java.lang.String getFinalCurrency()

Gets the derived currency for this object, which will be referenced by shopkeepers, bankers, and other mobs. See Archon's Guide for the proper format for this string, as it can be anything from a full current definition, to a reference to an existing one.

Returns:

a currency name/definition

getRawCurrency

java.lang.String getRawCurrency()

Gets the default currency for this object, which will be referenced by shopkeepers, bankers, and other mobs. See Archon's Guide for the proper format for this string, as it can be anything from a full current definition, to a reference to an existing one.

Returns:

a currency name/definition or NULL to derive

setCurrency

void setCurrency(java.lang.String currency)

Returns the default currency for this object, which will be referenced by shopkeepers, bankers, and other mobs. See Archon's Guide for the proper format for this string, as it can be anything from a full current definition, to a reference to an existing one.

Parameters:

currency - a currency name/definition