Lack of dev documentation
  • Hello, thank you for such great addon suite and subj.

    [UPD3] Read http://fisheye.norganna.org/browse/Auctioneer/trunk/Auc-Advanced/Modules/Auc-Stat-Example2/StatExample2.lua?hb=true

    - I couldn't find doc for `AucAdvanced.GetModuleLocals()`
    It seems to be WoW default call, yet it isn't documented anythere. Checking the source I can admit that I have no idea about the order of local variables being returned from other module as for example `aucPrint` is defined way past some other locals but used first in every `GetModuleLocals()` call.

    - http://wiki.norganna.org/Auctioneer/5.0/Modules_API is malformed
    ̶I̶ ̶g̶u̶e̶s̶s̶ ̶I̶ ̶s̶h̶o̶u̶l̶d̶ ̶a̶t̶ ̶l̶e̶a̶s̶t̶ ̶d̶e̶f̶i̶n̶e̶ ̶`̶G̶e̶t̶P̶r̶i̶c̶e̶(̶)̶`̶ ̶f̶o̶r̶ ̶s̶t̶a̶t̶ ̶a̶d̶d̶o̶n̶.̶ ̶O̶r̶ ̶s̶h̶o̶u̶l̶d̶ ̶I̶ ̶d̶e̶f̶i̶n̶e̶ ̶a̶l̶l̶ ̶o̶f̶ ̶t̶h̶o̶s̶e̶ ̶f̶u̶n̶c̶t̶i̶o̶n̶s̶?̶
    Only `GetPriceArray()` and `GetItemPDF()` are required for stat module

    - Wiki search is not working
    Just that.

    [UPD] Just for future viewers there is also http://wiki.norganna.org/Auctioneer/5.0/Core_API but has info only about `AucAdvanced.API.*`

    [UPD2] https://www.reddit.com/r/WowUI/comments/2lpmff/help_what_debugging_tools_are_available_to/ has some nifty slash commands for WoW dev process. `/dump AucAdvanced.GetModuleLocals()`, sadly, just said that all of those are functions.
  • Unfortunately the wiki has been broken for several years - no-one can log in to edit it.

    AucAdvanced.GetModuleLocals() is a convenience function, returning an assortment of commonly-used functions. These are usually loaded into locals near the top of module files.

    It's defined in CoreUtils.lua, lines 677-685. (in this file, lib = AucAdvanced)

    Functionally it's the equivalent of doing:
    local aucPrint = AucAdvanced.Print
    local decode = AucAdvanced.DecodeLink
    etc., etc.,
  • If you are writing a Stat module, it must have a GetItemPDF() function.
    It should have a GetPriceArray() or GetPriceSeen() function (but will not cause an error if these are missing - they are only used to get the 'seen' count).
Start a New Discussion

Howdy, Stranger!

It looks like you're new here. If you want to get involved, click one of these buttons!

In this Discussion

privacy
norganna's addons network · tf2 warehouse · scrap warehouse · auctioneer addon · gatherer addon · addon forums · rdrct