Auction House Events |
Discworld Help |
Auction House Events |
Name
Auction House Events - Special mailer messages that may be customised for internal auction house events
Description
When certain events occur within the auction house commercial object, the house needs to be able to inform people of these events. For instance, when an object receives no bid in the amount of time given, or when an object is successfully sold to someone. These messages may be customised by the owner of the commercial property, utilising control codes described below.
Auction House Events
There now follows a list of auction house events, each of which has two messages assigned to it. One message is the message mailed to the seller and the other is the message mailed to the high bidder.
no_bid_retrying
There was no bid on the lot, but the auction house will automatically retry it.
no_bid_not_retrying
There was no bid on the lot and the house will no longer attempt to resell the auction.
finished
There was a high bid on the lot and it is sold.
destroy
The lot was never collected and was automatically destroyed by the house.
not_collected_retrying
The lot was never collected by the high bidder, but the auction house will automatically retry the auction.
not_collected_not_retrying
The lot was never collected by the high bidder and the house will not attempt to resell the auction.
rejected
The owner rejected the lot.
withdrawn
The lot was withdrawn by the seller before the auction could finish.
Control Codes
There now follows a list of control codes that can be used in any of the messages. Each control code will be replaced with the information specified when the string is evaluated, based on the lot data.
$auction_objects$
A nice list of the objects in this lot.
$retrieval_time$
The amount of time a high bidder has to retrieve the lot once the auction ends or the amount of time a seller has to retrieve the lot before it is destroyed if there is no successful sale. This is interpreted as Ankh-Morpork time.
$retrieval_date$
This is similar to $retrieval_time$, but this takes the current time into account and prints a date that shows when the lot must be retrieved. This is interpreted as Ankh-Morpork time.
$max_retries$
This is the amount of times that a failed auction will be automatically retried.
$owner_cut$
This is the owners cut displayed as a percentage.
$owner_cut_value$
This is the actual owner's cut on this specific lot, displayed as a money string.
$seller_profit$
This is the seller's profit, with the owner's cut removed, displayed as a money string.
$defaulted_auction_cost$
This is the cost of a failed auction to the seller displayed as a money string.
$high_bidder$
This is the high bidder of the lot's name.
$seller$
This is the seller of the lot.
$final_bid$
This is the final bid that the lot received.
$num_retries$
This is the number of times that this lot has already been retried.
$time_started$
This displays the date and time at which the lot was put up for sale. This is interpreted as Ankh-Morpork time.
$auction_name$
This is the name of the lot, as defined by the seller when he or she first put the lot up for sale.
