LibFilters-3.0
This version of LibFilters does
NOT need any dependency to other libraries anymore (e.g. no LibStub needed).
You simply reference it by using the global Variable
Other libraries
This libray optionally supports the use of
LibDebugLogger to log messages to the addon log instead of the normal chat.
Attention - PLEASE READ
If you also use LibFilters-2.0:
Please update your addons to NOT use LibFilters-2.0 anymore, instead use LibFilters-3.0!
Change your addons manifest TXT file to ## DependsOn: LibFilters-3.0 and be sure to update the call of your addon to LibFilters-3.0 global variable "LibFilters3" instead of the old one!
LibStub is NOT supported anymore/is obsolete, so please remove and LibStub usage from your addons as well!
If LibFilters-3.0 and LibFilters-2.0 are loaded at the same time you'll see this information in your chat and should contact the authors of your addons which still use LibFilters-2.0 to update to LibFilters-3.0 please:
Code:
[LibFilters-3.0]An older version of this library is loaded too: LibFilters-2.0.
Please check which addons use this old Library in the ingame AddOn Manager and inform their authors to switch to LibFilters-3.0.
Otherwise addons using the different versions might conflict at some filter panels!"
Welcome to LibFilters-3.0!
The goal of LibFilters is to provide an easy interface for applying custom sorting rules to different lists of items found in the game. At the moment, you can filter the inventory, bank withdrawal, bank deposits, guild bank withdrawal, guild bank deposits, vendor buying, vendor selling, buyback, repair, guild store selling, mail sending, trading, smithing (refinement, deconstruction, improvement, research), alchemy creation, enchanting creation, enchanting extraction, fence selling, fence laundering, the craftbag, and the quickslot inventory.
To use LibFilters in your addon, you simply assign a reference to it's global variable LibFilters3.
Yo do NOT need any call to LibStub for it anymore. In your manifest you need to add LibFilters-3.0 to the ##DependsOn tag:
Code:
##DependsOn: LibFilters-3.0
In your addon, you need to invoke LibFilters with the global LibFilters3 variable and then initialize LibFilters:
Lua Code:
local LibFilters = LibFilters3
LibFilters:InitializeLibFilters()
This is the list of available filterType constants:
Code:
LF_INVENTORY = 1
LF_BANK_WITHDRAW = 2
LF_BANK_DEPOSIT = 3
LF_GUILDBANK_WITHDRAW = 4
LF_GUILDBANK_DEPOSIT = 5
LF_VENDOR_BUY = 6
LF_VENDOR_SELL = 7
LF_VENDOR_BUYBACK = 8
LF_VENDOR_REPAIR = 9
LF_GUILDSTORE_BROWSE = 10
LF_GUILDSTORE_SELL = 11
LF_MAIL_SEND = 12
LF_TRADE = 13
LF_SMITHING_REFINE = 14
LF_SMITHING_CREATION = 15
LF_SMITHING_DECONSTRUCT = 16
LF_SMITHING_IMPROVEMENT = 17
LF_SMITHING_RESEARCH = 18
LF_ALCHEMY_CREATION = 19
LF_ENCHANTING_CREATION = 20
LF_ENCHANTING_EXTRACTION = 21
LF_PROVISIONING_COOK = 22
LF_PROVISIONING_BREW = 23
LF_FENCE_SELL = 24
LF_FENCE_LAUNDER = 25
LF_CRAFTBAG = 26
LF_QUICKSLOT = 27
LF_RETRAIT = 28
LF_HOUSE_BANK_WITHDRAW = 29
LF_HOUSE_BANK_DEPOSIT = 30
LF_JEWELRY_REFINE = 31
LF_JEWELRY_CREATION = 32
LF_JEWELRY_DECONSTRUCT = 33
LF_JEWELRY_IMPROVEMENT = 34
LF_JEWELRY_RESEARCH = 35
LF_SMITHING_RESEARCH_DIALOG = 36
LF_JEWELRY_RESEARCH_DIALOG = 37
LF_INVENTORY_QUEST = 38
LF_FILTER_MIN = LF_INVENTORY
LF_FILTER_MAX = LF_INVENTORY_QUEST
The filterTypes will pass information from the bag & slotIndex, or the inventorySlot, to a filterCallback function registered to that filterType.
For the slots, these are the keys available in the passed table:
Code:
inventory slot: age, bagId, condition, dataEntry, equipType, filterData,
iconFile, inventory, isJunk, isPlayerLocked, itemInstanceId, itemType,
launderPrice, locked, meetsUsageRequirement, name, quality, rawName,
requiredLevel, searchData, sellPrice, slotControl, slotIndex,
specializedItemType, stackCount, stackLaunderPrice, statValue, stolen,
uniqueId
store slot: currencyQuantity1, currencyQuantity2, currencyType1,
currencyType2, dataEntry, entryType, filterData, icon, isUnique,
meetsRequirementsToBuy, meetsRequirementsToEquip, name, price, quality,
questNameColor, sellPrice, slotIndex, stack, stackBuyPrice,
stackBuyPriceCurrency1, stackBuyPriceCurrency2, statValue
buyback slot: icon, meetsRequirements, name, price, quality, slotIndex,
stack, stackBuyPrice
repair slot: bagId, condition, dataEntry, icon, name, quality, repairCost,
slotIndex, stackCount
quickslot slot: age, bagId, filterData, iconFile, locked,
meetsUsageRequirement, name, quality, sellPrice, slotIndex, slotType,
stackCount, stackSellPrice, stolen
This library uses the inventory/fragment/dialog's attribute "additionalFilters" to register the filter callbackFunction, so it will run in addition to the original filter functions of the ZOs code.
LibFilters has the following functions available:
Code:
function LibFilters:InitializeLibFilters()
Must be called after you've assigned LibFilters-3.0 to your local variable, to start the initialization of the library, and to make it work.
function LibFilters3:GetMinFilterType()
Returns the minimum filterType available
function LibFilters3:GetMaxFilterType()
Returns the maximum filterType available
function LibFilters3:GetFilterTypes()
Returns the LibFilters LF* filterType connstants table: value = "name"
function LibFilters3:GetFilterTypeName(libFiltersFilterType)
Returns the LibFilters LF* filterType connstant's name
function LibFilters3:GetCurrentFilterTypeForInventory(inventoryType)
Returns the filterType currently affecting the provided inventoryType.
function LibFilters3:GetFilterCallback(filterTag, filterType)
filterTag is the unique string that identifies your filter. filterType is
the provided "LF_" prefixed constants your filter was registered for.
Returns the filterCallback registered for the provided filterTag and
filterType; returns nil otherwise.
function LibFilters:IsFilterRegistered(filterTag, filterType)
filterTag is the unique string that identifies your filter. filterType is
the provided "LF_" prefixed constants your filter was registered for.
Returns true if there is a filter registered with the provided filterTag.
Returns false if there is not a filter registered with the provided
filterTag. filterType is optional. If a filterType is provided, will only
return true if a filter is registered to that filterType under the
provided filterTag.
function LibFilters3:RegisterFilter(filterTag, filterType, filterCallback)
filterTag is a unique string to identify your filter. filterType is one of
the provided "LF_" prefixed constants. filterCallback is a function which
accepts either one or two arguments; this is determined by the filterType.
filterCallback should return true if an item is to be shown.
filterCallback should return false if an item should not be shown.
function LibFilters3:UnregisterFilter(filterTag, filterType)
filterTag is the unique string that identifies your filter. filterType the
provided "LF_" prefixed constants your filter was registered for.
filterType is optional. If a filterType is not provided, all filters
registered with the provided filterTag will be unregistered.
function LibFilters3:RequestUpdate(filterType)
filterType is one of the provided "LF_" prefixed constants. Runs the updater
appropriate for the provided filter type to pick up any filtering changes.
function LibFilters3:SetResearchLineLoopValues(fromResearchLineIndex, toResearchLineIndex, skipTable)
number fromResearchLineIndex: Start the loop here
number toResearchLineIndex: End the loop here
table skipTable: A table containing the researchLine indices to skip in the loop (theyx won't be added to the horizontal scroll list)
02/16/21, 01:53 AM
