Auctioneer/5.0/Modules API

This function returns the name of the module, for example if the full module's name is "Auc-Util-Example", this function should return "Example".

Auctioneer Advanced will call this function when your module's variables are loaded by the game.

Passes the addon name.

You can register your interest in being notified of other AddOns than your own by placing an entry for that AddOn's name in your LoadTriggers table.

This function is the generic message handler.

Auctioneer Advanced will call this function whenever it has something to communicate to the module. Example callback types are:

• "auctionui"
  Called to inform the module that the auction house has been loaded.
• "load", addon
  Called whenever an auctioneer advanced module loads.
• "tooltip", frame, name, hyperlink, quality, quantity, cost, additional
  Called to give the module a chance to display tooltip information.
• "listupdate"
  Called whenever the auction house browse list is updated.
• "config", gui
  Called when the GUI config is first opened to give you the chance to add your configuration parameters to it. Supplies the Gui object as the first parameter.
• "configchanged", setting, value
  Called whenever a parameter is updated in the configuration. Passes the setting name and the new value as parameters.
• "inventory"
  Fired when there's an inventory change.
• "scanstats", stats
  A scan has completed and stats are updated. You should clear all your cached stats. Passes statistics about the scan, and what was updated.
• "scanprogress", state, totalAuctions, scannedAuctions
  Called when the progress of a scan has been changed. The state parameter will be true if we want to show the process indicator, false if we want to hide it and nil if we only want to update it. The totalAuctions parameter will be a number that is the max number of items in the scan and the scannedAuctions parameter is the current progress of the scan.
• "pagefinished", pageNumber
  Called when AucAdv is done with a page, allowing modules to work with it.
• "postresult", success, id, request, [error]
  Whenever a queued post has succeeded or failed, this callback will be called. The success flag will be set to either true or false, depending on if the post was made or not. The postId is one of the postIds that was returned in a table from the AucAdvanced.Post.PostAuction(sig, size, bid, buyout, duration, multiple) function. The request parameter contains the detail of the post in a table like: {sig, size, bid, buyout, duration}. The error message is passed if there was an error and contains the text of the error.
• "bidplaced", auctionstring
  Called whenever a bid has been successfully placed. Auctionstring is "itemlink;seller;count;buyout;pricepaid;reason"

This function is used to pass along any slash commands pertaining to your module. Passes the remainder of the entered command, split at spaces.

This table of functions is used to receive messages from the scanning module.

If you want to store stats about the items as they are scanned, you should place entries in this table with the key equal to one of the below message types and pointers to the function that you want to process that data as the values. The possible messages that can be sent to your module are:

• "begin"
  Sent when the scanner is about to send a batch of data. Initializing once-per-scan variables here is a good idea instead of redoing them for every single item.
• "update", newitem, olditem
  An existing item has been changed.
• "leave", olditem
  An existing item that still exists and has not changed.
• "create", newitem
  A new item has been found which did not exist prior to the scan.
• "delete", olditem
  An item that existed prior to the scan now does not exist.
• "complete"
  The batch has completed, you may now cleanup / process / store any accumulated data.

A table of interesting AddOns to your module.

Whenever an AddOn loads that has a key in this table, your OnLoad(addon) function will be called with that AddOn's name.

Note: All AddOn's names should be entered into this table in lowercase

This function returns a series of values the most accurate/relevant/recent price is the first value returned other less relevant prices are returned in order of most relevant, to least relevant then a false value is returned then other "interesting" values are returned thereafter.

This function returns the respective "names" of the values returned by GetPrice(itemLink, serverKey)

This function is a combination of the above two functions, and returns it's values in a table.

Three of the keys that are expected to be in this table are "price", "seen", and "confidence", being the best price, the seen count, and a confidence value (0.00-1.00).

Other values may be provided by the AddOn in other fields.

This function returns a probability distribution function (PDF) which indicates the module's determined probability of a price value for the item. The function returned should accept one parameter, the price of the item, and return a value from 0 to 1 indicating the probability of that price to be the true price. The area under the curve should be 1 in most cases, though any finite value is allowed, but will have the side effect of a weight against other modules (i.e., a function with an area of 5 will count 5 times as much as a function with an area of 1). The API function AucAdvanced.API.GenerateBellCurve() can provide the standard normal distribution as a common PDF (the bell curve).

This function tells the statistics module to clear data for the linked item.

This function filtes based on the information in itemData. itemData is a table containing all of the Auctioneer Advanced information about an item, including information available thru the default tooltips, as well as information such as the last time it was seen, and how many times it has been seen.