Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface ShoppingLibrary

All Superinterfaces:

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

All Known Implementing Classes:

CoffeeShops

public interface ShoppingLibrary
extends CMLibrary

This library handles everything related to shopkeepers and merchants. This includes all the buying, selling, paying, being paid, viewing, and valueing. Although there are shopkeeper mobs, there are also shopkeeper properties that can appear on anything, and so you'll often see that shopkeeper interface is considered separate from the host object that the player sees as the shop.

Field Summary

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

idConverter

Method Summary

Modifier and Type	Method	Description
java.util.List<Environmental>	addRealEstateTitles(java.util.List<Environmental> productsV, MOB buyer, CoffeeShop shop, Room myRoom)	Adjusts the given inventory of a shopkeepers shop by adding external inventory, which might include new real estate titles, or existing titles to real estate, ships, and the like.
void	auctionNotify(MOB M, java.lang.String resp, java.lang.String regardingItem)	Sends a notification to the given stakeholder in an auction for the given item.
java.lang.String[]	bid(MOB mob, double bid, java.lang.String bidCurrency, AuctionData auctionData, Item I, java.util.List<java.lang.String> auctionAnnounces)	Submits a new bid for an item by the given mob, of the given amount of the given currency to the given auction for the given item.
void	cancelAuction(java.lang.String auctionHouse, AuctionData data)	Cancels the given auction.
boolean	doISellThis(Environmental thisThang, ShopKeeper shop)	Returns whether the given shopkeeper shop sells the given thing normally.
AuctionData	fetchAuctionByItemName(java.lang.String named, java.lang.String auctionHouse)	Returns auction data for the auction for an item of the given name in the given auction house.
java.lang.String	findInnRoom(InnKey key, java.lang.String addThis, Room R)	Given an inn key, and a starting room, this will return the directions to follow to reach the room.
java.util.List<Environmental>	getAllShopkeepers(Room here, MOB notMOB)	Returns all the shopkeeper hosts accessible by anyone in the given room.
java.lang.String	getAuctionInventory(MOB seller, MOB buyer, Auctioneer auction, java.lang.String itemName)	Returns the formal auction listing of all items for the given auctioneer's auction house.
java.util.Enumeration<AuctionData>	getAuctions(java.lang.Object ofLike, java.lang.String auctionHouse)	Returns an enumeration of all active auctions in the given auction house, of the given name
java.lang.String	getListForMask(java.lang.String targetMessage)	Checks a BUY message for an english embedded 'FOR' message, which can affect the assignment of purchased private property.
java.lang.String	getListInventory(MOB seller, MOB buyer, java.util.List<? extends Environmental> inventory, int limit, ShopKeeper shop, java.lang.String mask)	Formats and returns a displayable inventory for a shopkeeper.
double	getSalesTax(Room homeRoom, MOB seller)	Returns the applicable sales tax percentage for the given seller from the given room.
ShopKeeper	getShopKeeper(Environmental E)	Given a potential shopkeeper host, this will return the shopkeeper shop itself.
java.lang.String	getViewDescription(MOB viewerM, Environmental E, java.util.Set<ShopKeeper.ViewType> flags)	Returns the official view message for the given item and viewer mob.
boolean	ignoreIfNecessary(MOB mob, java.lang.String ignoreMask, MOB whoIgnores)	Returns whether the given ignorer (usually a shopkeeper mob) is ignoring the given mob for most purposes.
Pair<java.lang.Long,TimeClock.TimePeriod>	parseBudget(java.lang.String budget)	Parses the given budget string into a data structure showing the amount of base currency, and how often that amount is reset for the purpose of making purchases.
MOB	parseBuyingFor(MOB buyer, java.lang.String message)	Given a BUY message string, will look for the FOR syntax and return the mob in the same room as the agent buyer with that name, or null.
double[]	parseDevalueRate(java.lang.String factors)	Parses a rate of devaluation for each purchase, preceded optionally by a special rate just for raw resources.
java.lang.String[]	parseItemPricingAdjustments(java.lang.String factors)	Parses the given list of factors into a set of factors.
boolean	pawnEvaluation(MOB buyerShopM, MOB sellerCustM, Environmental product, ShopKeeper shop, double maxToPay, double maxEverPaid, boolean sellNotValue)	Evaluates a proposed sale of an item to a shopkeeper by a player/mob Returns whether the sale can go forth.
ShopKeeper.ShopPrice	pawningPrice(MOB buyerShopM, MOB sellerCustM, Environmental product, ShopKeeper shopKeeper, CoffeeShop shop)	Gives the value of an item that might be sold to a shopkeeper by a player/mob.
void	purchaseAbility(Ability A, MOB seller, ShopKeeper shop, MOB mobFor)	Completes the purchase of the given ability from the given seller to the given buyer mob.
boolean	purchaseItems(Item baseProduct, java.util.List<Environmental> products, MOB seller, MOB mobFor)	Completes the purchase of the given item from the given seller to the given buyer mob.
boolean	purchaseMOB(MOB product, MOB seller, ShopKeeper shop, MOB mobFor)	Completes the purchase of the given follower mob from the given seller to the given buyer mob.
void	returnMoney(MOB to, java.lang.String currency, double amt)	A manipulator of the given players money.
void	saveAuction(AuctionData data, java.lang.String auctionHouse, boolean updateOnly)	Update the given AuctionData (an auction) for the given auctionHouse.
boolean	sellEvaluation(MOB sellerShopM, MOB buyerCustM, Environmental product, ShopKeeper shop, boolean buyNotView)	Evaluates a potential sale of an item from a shopkeeper to a player/npc.
ShopKeeper.ShopPrice	sellingPrice(MOB sellerShopM, MOB buyerCustM, Environmental product, ShopKeeper shopKeeper, CoffeeShop shop, boolean includeSalesTax)	Gives the price of an item that might be sold to a player/mob by a shopkeeper.
java.lang.String	storeKeeperString(CoffeeShop shop, ShopKeeper keeper)	Returns a brief plain ordinary camel-cased description of what kind of shopkeeper this is: Miscellaneous Magic Items, General Items, etc.
void	transactMoneyOnly(MOB sellerM, MOB buyerM, ShopKeeper shop, Environmental product, boolean sellerGetsPaid)	Part of a shopkeeper selling an item to a player/mob is the transaction of the price.
double	transactPawn(MOB shopkeeperM, MOB pawnerM, ShopKeeper shop, Environmental product)	Does the transaction where a player/mob sells an item to a shopkeeper.

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

getShopKeeper

ShopKeeper getShopKeeper(Environmental E)

Given a potential shopkeeper host, this will return the shopkeeper shop itself. Sometimes they are the same, sometimes not.

Parameters:

E - the potential shopkeeper host

Returns:

null, or the shopkeeper shop

getAllShopkeepers

java.util.List<Environmental> getAllShopkeepers(Room here,
                                                MOB notMOB)

Returns all the shopkeeper hosts accessible by anyone in the given room.

Parameters:

here - the room to find shopkeeper

notMOB - an exception, or null for no exceptions

Returns:

the list of all shopkeeper hosts

getViewDescription

java.lang.String getViewDescription(MOB viewerM,
                                    Environmental E,
                                    java.util.Set<ShopKeeper.ViewType> flags)

Returns the official view message for the given item and viewer mob.

Parameters:

viewerM - the mob viewing the irem

E - the item being viewed

flags - the level of information returned

Returns:

the official 'view' of an item

See Also:

ShopKeeper.ViewType

parseBuyingFor

MOB parseBuyingFor(MOB buyer,
                   java.lang.String message)

Given a BUY message string, will look for the FOR syntax and return the mob in the same room as the agent buyer with that name, or null.

Parameters:

buyer - the agent buyer in the room

message - the buy message string

Returns:

the mob in the room the item is really for

ignoreIfNecessary

boolean ignoreIfNecessary(MOB mob,
                          java.lang.String ignoreMask,
                          MOB whoIgnores)

Returns whether the given ignorer (usually a shopkeeper mob) is ignoring the given mob for most purposes.

Parameters:

mob - the mob who might be ignored

ignoreMask - the zappermask determining if the mob is ignored

whoIgnores - the mob who might be ignoring

Returns:

true if ignored, false othwrwise

storeKeeperString

java.lang.String storeKeeperString(CoffeeShop shop,
                                   ShopKeeper keeper)

Returns a brief plain ordinary camel-cased description of what kind of shopkeeper this is: Miscellaneous Magic Items, General Items, etc.

Parameters:

shop - coffee shop inventory to check

keeper - the actual coffee shop

Returns:

the items sold description

doISellThis

boolean doISellThis(Environmental thisThang,
                    ShopKeeper shop)

Returns whether the given shopkeeper shop sells the given thing normally. Does not care whether its in stock.

Parameters:

thisThang - the thing to see if its ordinary stock

shop - the actual shop to check for a good match

Returns:

true if the shop would sell it, false otherwise

sellingPrice

ShopKeeper.ShopPrice sellingPrice(MOB sellerShopM,
                                  MOB buyerCustM,
                                  Environmental product,
                                  ShopKeeper shopKeeper,
                                  CoffeeShop shop,
                                  boolean includeSalesTax)

Gives the price of an item that might be sold to a player/mob by a shopkeeper.

Parameters:

sellerShopM - the shopkeeper mob

buyerCustM - the player buyer mob

product - the proposed produce to sell to the shop

shopKeeper - the shop itself

shop - the inventory object of the shop

includeSalesTax - true to include sales tax in the price, false otherwise

Returns:

the selling price that this shopkeeper will put on the item

See Also:

transactMoneyOnly(MOB, MOB, ShopKeeper, Environmental, boolean), sellEvaluation(MOB, MOB, Environmental, ShopKeeper, boolean), getSalesTax(Room, MOB)

getSalesTax

double getSalesTax(Room homeRoom,
                   MOB seller)

Returns the applicable sales tax percentage for the given seller from the given room.

Parameters:

homeRoom - the room the shopkeeper is originally from

seller - the seller him or herself

Returns:

a value from 0-1.

See Also:

transactMoneyOnly(MOB, MOB, ShopKeeper, Environmental, boolean), sellEvaluation(MOB, MOB, Environmental, ShopKeeper, boolean), sellingPrice(MOB, MOB, Environmental, ShopKeeper, CoffeeShop, boolean)

sellEvaluation

boolean sellEvaluation(MOB sellerShopM,
                       MOB buyerCustM,
                       Environmental product,
                       ShopKeeper shop,
                       boolean buyNotView)

Evaluates a potential sale of an item from a shopkeeper to a player/npc. Returns whether the sale can go forth. This also handles proposed VIEW commands.

Parameters:

sellerShopM - the mob doing the selling

buyerCustM - the player or mob doing the buying

product - the product to potentiall sell to the buyer

shop - the actual shop

buyNotView - true if a buy is requested, false for a view

Returns:

true if the buy or view should go forward

See Also:

transactMoneyOnly(MOB, MOB, ShopKeeper, Environmental, boolean), getSalesTax(Room, MOB), sellingPrice(MOB, MOB, Environmental, ShopKeeper, CoffeeShop, boolean)

transactMoneyOnly

void transactMoneyOnly(MOB sellerM,
                       MOB buyerM,
                       ShopKeeper shop,
                       Environmental product,
                       boolean sellerGetsPaid)

Part of a shopkeeper selling an item to a player/mob is the transaction of the price. This handles that by taking away the buyers money, qp, xp, or whatever. The price comes from sellingPrice above. Having the money go into the shopkeepers pocket is optional.

Parameters:

sellerM - the seller mob who wants money

buyerM - the buyer mob who is losing money

shop - the shop itself

product - the product being sold, whose value constitutes the price

sellerGetsPaid - true to add the money to the shopkeepers

See Also:

sellEvaluation(MOB, MOB, Environmental, ShopKeeper, boolean), getSalesTax(Room, MOB), sellingPrice(MOB, MOB, Environmental, ShopKeeper, CoffeeShop, boolean)

addRealEstateTitles

java.util.List<Environmental> addRealEstateTitles(java.util.List<Environmental> productsV,
                                                  MOB buyer,
                                                  CoffeeShop shop,
                                                  Room myRoom)

Adjusts the given inventory of a shopkeepers shop by adding external inventory, which might include new real estate titles, or existing titles to real estate, ships, and the like.

Parameters:

productsV - the existing inventory

buyer - the buyer who wants to see the inventory

shop - the shop inventory object

myRoom - the room where the shopkeeper is

Returns:

the filled inventory

pawningPrice

ShopKeeper.ShopPrice pawningPrice(MOB buyerShopM,
                                  MOB sellerCustM,
                                  Environmental product,
                                  ShopKeeper shopKeeper,
                                  CoffeeShop shop)

Gives the value of an item that might be sold to a shopkeeper by a player/mob. Takes current stock into account.

Parameters:

buyerShopM - the shopkeeper mob

sellerCustM - the player seller mob

product - the proposed produce to sell to the shop

shopKeeper - the shop itself

shop - the inventory object of the shop

Returns:

the valuation that this shopkeeper will put on the item

See Also:

transactPawn(MOB, MOB, ShopKeeper, Environmental), pawnEvaluation(MOB, MOB, Environmental, ShopKeeper, double, double, boolean)

pawnEvaluation

boolean pawnEvaluation(MOB buyerShopM,
                       MOB sellerCustM,
                       Environmental product,
                       ShopKeeper shop,
                       double maxToPay,
                       double maxEverPaid,
                       boolean sellNotValue)

Evaluates a proposed sale of an item to a shopkeeper by a player/mob Returns whether the sale can go forth. This also handles proposed VALUE commands.

Parameters:

buyerShopM - the shopkeeper mob

sellerCustM - the player seller mob

product - the proposed produce to sell to the shop

shop - the shop itself

maxToPay - money the shopkeeper has remaining

maxEverPaid - the overall budget of the shopkeeper

sellNotValue - true if a sale is proposed, and false for a valuation

Returns:

true if the sale should go through, false otherwise

See Also:

transactPawn(MOB, MOB, ShopKeeper, Environmental), pawningPrice(MOB, MOB, Environmental, ShopKeeper, CoffeeShop)

transactPawn

double transactPawn(MOB shopkeeperM,
                    MOB pawnerM,
                    ShopKeeper shop,
                    Environmental product)

Does the transaction where a player/mob sells an item to a shopkeeper. It returns the amount given to the player in absolute value. Adds the item to the shopkeepers inventory

Parameters:

shopkeeperM - the shopkeeper mob being sold to

pawnerM - the player/mob selling an item

shop - the shopkeeper object

product - the product sold to the shopkeeper

Returns:

the value given to the player

See Also:

pawnEvaluation(MOB, MOB, Environmental, ShopKeeper, double, double, boolean), pawningPrice(MOB, MOB, Environmental, ShopKeeper, CoffeeShop)

getListForMask

java.lang.String getListForMask(java.lang.String targetMessage)

Checks a BUY message for an english embedded 'FOR' message, which can affect the assignment of purchased private property.

Parameters:

targetMessage - the target message string

Returns:

null, or a name that the object is being purchased for

See Also:

getListInventory(MOB, MOB, List, int, ShopKeeper, String), getListForMask(String)

getListInventory

java.lang.String getListInventory(MOB seller,
                                  MOB buyer,
                                  java.util.List<? extends Environmental> inventory,
                                  int limit,
                                  ShopKeeper shop,
                                  java.lang.String mask)

Formats and returns a displayable inventory for a shopkeeper.

Parameters:

seller - the seller mob who speaks

buyer - the buyer mob who is ... buying

inventory - the inventory of the seller to show

limit - 0, or maximum number of rows to display

shop - the ShopKeeper object

mask - null, or a name substring mask for items to show

Returns:

the formatted displayable inventory

See Also:

getListInventory(MOB, MOB, List, int, ShopKeeper, String), getListForMask(String)

findInnRoom

java.lang.String findInnRoom(InnKey key,
                             java.lang.String addThis,
                             Room R)

Given an inn key, and a starting room, this will return the directions to follow to reach the room.

Parameters:

key - the key to find the room for

addThis - a word to prefix the directions with

R - the room starting from

Returns:

the directions to the room

parseDevalueRate

double[] parseDevalueRate(java.lang.String factors)

Parses a rate of devaluation for each purchase, preceded optionally by a special rate just for raw resources. Each numbe is a percentage like 30%.

Parameters:

factors - the rate of devaluation(s)

Returns:

the raw material followed by normal devalue rate 0-1

See Also:

parseItemPricingAdjustments(String), parseBudget(String)

parseItemPricingAdjustments

java.lang.String[] parseItemPricingAdjustments(java.lang.String factors)

Parses the given list of factors into a set of factors. Each factor is a mask followed by a decimal percentage to adjust prices by.

Parameters:

factors - the raw factors string

Returns:

the parsed list of factors

See Also:

parseDevalueRate(String), parseBudget(String)

parseBudget

Pair<java.lang.Long,TimeClock.TimePeriod> parseBudget(java.lang.String budget)

Parses the given budget string into a data structure showing the amount of base currency, and how often that amount is reset for the purpose of making purchases.

Parameters:

budget - the encoded budget string (amount time period)

Returns:

the parsed budget object

See Also:

parseDevalueRate(String), parseItemPricingAdjustments(String)

purchaseItems

boolean purchaseItems(Item baseProduct,
                      java.util.List<Environmental> products,
                      MOB seller,
                      MOB mobFor)

Completes the purchase of the given item from the given seller to the given buyer mob.

Parameters:

baseProduct - the item being purchased

products - all items in the item product

seller - the seller

mobFor - the buyer

Returns:

true if the purchase went through, false otherwise

See Also:

purchaseAbility(Ability, MOB, ShopKeeper, MOB), purchaseMOB(MOB, MOB, ShopKeeper, MOB)

purchaseMOB

boolean purchaseMOB(MOB product,
                    MOB seller,
                    ShopKeeper shop,
                    MOB mobFor)

Completes the purchase of the given follower mob from the given seller to the given buyer mob.

Parameters:

product - the follower mob being purchased

seller - the seller

shop - the seller's shop

mobFor - the buyer

Returns:

true if the purchase went through, false otherwise

See Also:

purchaseAbility(Ability, MOB, ShopKeeper, MOB), purchaseItems(Item, List, MOB, MOB)

purchaseAbility

void purchaseAbility(Ability A,
                     MOB seller,
                     ShopKeeper shop,
                     MOB mobFor)

Completes the purchase of the given ability from the given seller to the given buyer mob.

Parameters:

A - the ability being purchased

seller - the seller

shop - the seller's shop

mobFor - the buyer

See Also:

purchaseMOB(MOB, MOB, ShopKeeper, MOB), purchaseItems(Item, List, MOB, MOB)

returnMoney

void returnMoney(MOB to,
                 java.lang.String currency,
                 double amt)

A manipulator of the given players money. Either adds or subtracts money as given, and then re-saves the players inventory to the database.

Parameters:

to - the mob who is getting or losing money

currency - the currency to add/remove

amt - the amount to add/remove

bid

java.lang.String[] bid(MOB mob,
                       double bid,
                       java.lang.String bidCurrency,
                       AuctionData auctionData,
                       Item I,
                       java.util.List<java.lang.String> auctionAnnounces)

Submits a new bid for an item by the given mob, of the given amount of the given currency to the given auction for the given item. It also returns a message for any public auction channels to the given array. It turns a two- dimensional array.

Parameters:

mob - the bidder mob

bid - the bidding amount in base value

bidCurrency - the bidding currency

auctionData - the auction data for the auction bid on

I - the item bid on (why not use from auction data?)

auctionAnnounces - list to put channel messages into

Returns:

2-dim array: message to bidder, message to prev high bidder

See Also:

AuctionData, auctionNotify(MOB, String, String), saveAuction(AuctionData, String, boolean), cancelAuction(String, AuctionData), fetchAuctionByItemName(String, String), getAuctions(Object, String), getAuctionInventory(MOB, MOB, Auctioneer, String)

getAuctionInventory

java.lang.String getAuctionInventory(MOB seller,
                                     MOB buyer,
                                     Auctioneer auction,
                                     java.lang.String itemName)

Returns the formal auction listing of all items for the given auctioneer's auction house.

Parameters:

seller - the seller mob, which is not necessarily the auction house

buyer - the buyer doing the listing

auction - the auction house object itself

itemName - the null or the name of the item interested in

Returns:

the displayable list of auctioned items

See Also:

AuctionData, auctionNotify(MOB, String, String), saveAuction(AuctionData, String, boolean), cancelAuction(String, AuctionData), fetchAuctionByItemName(String, String), getAuctions(Object, String), bid(MOB, double, String, AuctionData, Item, List)

getAuctions

java.util.Enumeration<AuctionData> getAuctions(java.lang.Object ofLike,
                                               java.lang.String auctionHouse)

Returns an enumeration of all active auctions in the given auction house, of the given name

Parameters:

ofLike - null, or a name to match

auctionHouse - the auction house to return auctions from

Returns:

an enumeration of all auctions

See Also:

AuctionData, auctionNotify(MOB, String, String), saveAuction(AuctionData, String, boolean), cancelAuction(String, AuctionData), fetchAuctionByItemName(String, String), getAuctionInventory(MOB, MOB, Auctioneer, String), bid(MOB, double, String, AuctionData, Item, List)

fetchAuctionByItemName

AuctionData fetchAuctionByItemName(java.lang.String named,
                                   java.lang.String auctionHouse)

Returns auction data for the auction for an item of the given name in the given auction house.

Parameters:

named - the item name, or partial match

auctionHouse - the auction house to search in

Returns:

null, or the auctio data

See Also:

AuctionData, auctionNotify(MOB, String, String), saveAuction(AuctionData, String, boolean), cancelAuction(String, AuctionData), getAuctions(Object, String), getAuctionInventory(MOB, MOB, Auctioneer, String), bid(MOB, double, String, AuctionData, Item, List)

auctionNotify

void auctionNotify(MOB M,
                   java.lang.String resp,
                   java.lang.String regardingItem)

Sends a notification to the given stakeholder in an auction for the given item. It does a tell for online players, and an email for those not online.

Parameters:

M - the recipient of the message

resp - the message

regardingItem - the item up for auction

See Also:

AuctionData, saveAuction(AuctionData, String, boolean), cancelAuction(String, AuctionData), fetchAuctionByItemName(String, String), getAuctions(Object, String), getAuctionInventory(MOB, MOB, Auctioneer, String), bid(MOB, double, String, AuctionData, Item, List), auctionNotify(MOB, String, String)

cancelAuction

void cancelAuction(java.lang.String auctionHouse,
                   AuctionData data)

Cancels the given auction.

Parameters:

auctionHouse - the auction house the data belongs to

data - the AuctionData to delete

See Also:

AuctionData, saveAuction(AuctionData, String, boolean), fetchAuctionByItemName(String, String), getAuctions(Object, String), getAuctionInventory(MOB, MOB, Auctioneer, String), bid(MOB, double, String, AuctionData, Item, List), auctionNotify(MOB, String, String)

saveAuction

void saveAuction(AuctionData data,
                 java.lang.String auctionHouse,
                 boolean updateOnly)

Update the given AuctionData (an auction) for the given auctionHouse. Called usually when the auction is created, or max big is raised.

Parameters:

data - the AuctionData to update

auctionHouse - the auction house the data belongs to

updateOnly - true for update, false when creating

See Also:

AuctionData, auctionNotify(MOB, String, String), cancelAuction(String, AuctionData), fetchAuctionByItemName(String, String), getAuctions(Object, String), getAuctionInventory(MOB, MOB, Auctioneer, String), bid(MOB, double, String, AuctionData, Item, List)