Implemented support for the Keyring.

Closes #586.

Author: Talyrius

Localization.lua

@@ -170,6 +170,7 @@ L["One section per item slot."] = true
 L["Only one section."] = true
 L["Please note this filter matchs every item. Any filter with lower priority than this one will have no effect."] = true
 L["Put any item that can be equipped (including bags) into the \"Equipment\" section."] = true
+L["Put items categorized as keys in their own section."] = true
 L["Put items in sections depending on their first-level category at the Auction House."] = true
 L["Put quest-related items in their own section."] = true
 L["Quest Items"] = true
@@ -341,6 +342,7 @@ L["Bag #%d"] = true
 L["Bank bag #%d"] = true
 L["Click to toggle the equipped bag panel, so you can change them."] = true
 L["Close"] = true
+L["Keyring"] = true
 L["Right-click to toggle %s."] = true
 L["auto-sort"] = true
 L["disabled"] = true
@@ -470,6 +472,7 @@ L["Jewelry"] = "Joaillerie"
 L["Junk category"] = "Catégorie camelote"
 L["Keep all stacks together."] = "Conserver les piles ensembles."
 L["KEYRING_TAG"] = "Cl"
+L["Keyring"] = "Trousseau de clés"
 L["LDB Plugin"] = "Plugin LDB"
 L["LEATHERWORKING_BAG_TAG"] = "Cu"
 L["Lock anchor"] = "Verrouiller l'ancre"
@@ -505,6 +508,7 @@ L["Press Alt while doing so to open a dropdown menu."] = "Presser Alt en le fais
 L["Priority"] = "Priorité"
 L["Provides a LDB data source to be displayed by LDB display addons."] = "Fournit une source LDB qui peut être affichée dans un addon d'affichage de LDB."
 L["Put any item that can be equipped (including bags) into the \"Equipment\" section."] = "Place les objets qui peuvent être équipés (y compris les sacs) dans la section \"Equipement\"."
+L["Put items categorized as keys in their own section."] = "Mettez les éléments classés comme clés dans leur propre section." -- Needs review
 L["Put items in sections depending on their first-level category at the Auction House."] = "Répartit les objets en fonction de leur catégorie principale (premier niveau de l'Hôtel des Ventes). "
 L["Put items of poor quality or labeled as junk in the \"Junk\" section."] = "Place les objets de mauvaise qualité ou considéré comme camelote dans la section \"Camelote\"."
 L["Put quest-related items in their own section."] = "Place les objets en rapport avec les quêtes dans une section spécifique."
@@ -664,6 +668,7 @@ L["Item information"] = "Gegenstandsinformation"
 L["Items"] = "Gegenstände"
 L["Jewelry"] = "Schmuck" -- Needs review
 L["KEYRING_TAG"] = "Schl"
+L["Keyring"] = "Schlüsselbund"
 L["LDB Plugin"] = "LBD Plugin"
 L["LEATHERWORKING_BAG_TAG"] = "Le"
 L["Lock anchor"] = "Anker abschließen"
@@ -688,6 +693,7 @@ L["Position mode"] = "Positions Modus"
 L["Priority"] = "Priorität"
 L["Provides a LDB data source to be displayed by LDB display addons."] = "Sieht vor, dass eine LDB Datenquelle von DataBroker Addons angezeigt wird"
 L["Put any item that can be equipped (including bags) into the \"Equipment\" section."] = "Zeigt jeden verwendbaren Gegenstand (inklusive Taschen) im \"Equipment\" Bereich."
+L["Put items categorized as keys in their own section."] = "Legen Sie als Schlüssel kategorisierte Elemente in einen eigenen Abschnitt." -- Needs review
 L["Put items in sections depending on their first-level category at the Auction House."] = "Zeigt Gegenstände basierend auf der ersten Kategorie des Auktoinshauses in den Bereichen an"
 L["Put items of poor quality or labeled as junk in the \"Junk\" section."] = "Zeigt Gegenstände geringer Qualität oder als Müll gekennzeichnete Gegenstände im \"Junk\" Bereich an."
 L["Put quest-related items in their own section."] = "Zeigt questbezogene Gegenstände in einem eigenen Bereich an"
@@ -822,6 +828,7 @@ L["Item information"] = "Информация о предмете"
 L["Items"] = "Предметы"
 L["Jewelry"] = "Драгоценности"
 L["KEYRING_TAG"] = "Клч"
+L["Keyring"] = "Связка ключей"
 L["LDB Plugin"] = "Плагин LDB"
 L["LEATHERWORKING_BAG_TAG"] = "Кж"
 L["Lock anchor"] = "Блокировать якорь"
@@ -846,6 +853,7 @@ L["Position mode"] = "Режим позиционирования"
 L["Priority"] = "Приоритет"
 L["Provides a LDB data source to be displayed by LDB display addons."] = "Позволяет отображать источник LDB данных другими аддонами для отображения LDB." -- Needs review
 L["Put any item that can be equipped (including bags) into the \"Equipment\" section."] = "Поместить все предметы которые могут быть одеты на персонажа (включая сумки) в секцию \"Экипировка\""
+L["Put items categorized as keys in their own section."] = "Поместите элементы, отнесенные к категории ключей, в отдельный раздел." -- Needs review
 L["Put items in sections depending on their first-level category at the Auction House."] = "Раскладывать вещи в сумках, используя общие категории аукциона."
 L["Put items of poor quality or labeled as junk in the \"Junk\" section."] = "Поместить предметы низкого качества или помеченных как хлам с секцию \"Хлам\"."
 L["Put quest-related items in their own section."] = "Поместить предметы связанные с заданием в свою секцию."
@@ -962,6 +970,7 @@ L["Plugins"] = "Accesorio, complemento."
 L["Priority"] = "Prioridad"
 L["Provides a LDB data source to be displayed by LDB display addons."] = "Proporciona una fuente de datos de Carga que se muestran en el panel del ayudante LDB.(loaddatabase)"
 L["Put any item that can be equipped (including bags) into the \"Equipment\" section."] = "Ponga cualquier elemento que puede ser equipado (incluyendo las bolsas) en la sección \"equipo\" ."
+L["Put items categorized as keys in their own section."] = "Coloque los elementos categorizados como claves en su propia sección." -- Needs review
 L["Put items in sections depending on their first-level category at the Auction House."] = "Coloca los artículos en las secciones en función de su primer nivel de categoría de la casa de subastas."
 L["Put items of poor quality or labeled as junk in the \"Junk\" section."] = "Coloca los artículos de mala calidad o etiquetados como basura en la sección \"basura\" ."
 L["Put quest-related items in their own section."] = [=[Poner los objetos relacionados con misiones en su correspondiente seccion.
@@ -1113,6 +1122,7 @@ L["Jewelry"] = "飾品"
 L["Junk category"] = "垃圾" -- Needs review
 L["Keep all stacks together."] = "保持全部堆疊合起來。"
 L["KEYRING_TAG"] = "Ke"
+L["Keyring"] = "鑰匙圈"
 L["LDB Plugin"] = "LDB 插件"
 L["LEATHERWORKING_BAG_TAG"] = "皮類" -- Needs review
 L["Let SyLevel handle the the display."] = "讓(SyLevel)處理的顯示。" -- Needs review
@@ -1149,6 +1159,7 @@ L["Press Alt while doing so to open a dropdown menu."] = "按下Alt鍵，而這
 L["Priority"] = "優先順序"
 L["Provides a LDB data source to be displayed by LDB display addons."] = "提供LDB顯示插件的資料來源"
 L["Put any item that can be equipped (including bags) into the \"Equipment\" section."] = "放置可裝備物品至「裝備」類別。" -- Needs review
+L["Put items categorized as keys in their own section."] = "將分類為鍵的項目放在它們自己的部分中。" -- Needs review
 L["Put items in sections depending on their first-level category at the Auction House."] = "按拍賣場主類型規則類別放置物品。" -- Needs review
 L["Put items of poor quality or labeled as junk in the \"Junk\" section."] = "將劣質或垃圾裝備放置於垃圾類別。" -- Needs review
 L["Put quest-related items in their own section."] = "將任務相關物品置入相關類別" -- Needs review
@@ -1353,6 +1364,7 @@ L["Jewelry"] = "饰品"
 L["Junk category"] = "垃圾"
 L["Keep all stacks together."] = "将所有堆叠合并"
 L["KEYRING_TAG"] = "钥"
+L["Keyring"] = "钥匙链"
 L["LDB Plugin"] = "LDB 组件"
 L["LEATHERWORKING_BAG_TAG"] = "皮"
 L["Lock anchor"] = "锁定锚点"
@@ -1388,6 +1400,7 @@ L["Press Alt while doing so to open a dropdown menu."] = "按下Alt键将打开
 L["Priority"] = "优先级"
 L["Provides a LDB data source to be displayed by LDB display addons."] = "给 LDB 提供数据资料, 以便符合 LDB 规范的插件使用."
 L["Put any item that can be equipped (including bags) into the \"Equipment\" section."] = "放置可装备物品至[装备]分组"
+L["Put items categorized as keys in their own section."] = "将归类为键的项目放在它们自己的部分中。" -- Needs review
 L["Put items in sections depending on their first-level category at the Auction House."] = "按拍卖行主类型规则分组放置物品."
 L["Put items of poor quality or labeled as junk in the \"Junk\" section."] = "将低品质或者垃圾物品放入[垃圾]分组"
 L["Put quest-related items in their own section."] = "将任务物品放入相关分组"
@@ -1597,6 +1610,7 @@ L["Jewelry"] = "장신구"
 L["Junk category"] = "잡동사니"
 L["Keep all stacks together."] = "모든 중첩을 함께 유지합니다."
 L["KEYRING_TAG"] = "열쇠"
+L["Keyring"] = "열쇠고리"
 L["LDB Plugin"] = "LDB 플러그인"
 L["LEATHERWORKING_BAG_TAG"] = "가세"
 L["Legacy"] = "기존 스타일"
@@ -1634,6 +1648,7 @@ L["Press Alt while doing so to open a dropdown menu."] = "드롭다운 메뉴를
 L["Priority"] = "우선 순위"
 L["Provides a LDB data source to be displayed by LDB display addons."] = "LDB 표시 애드온에 표시될 LDB 데이터 소스를 제공합니다."
 L["Put any item that can be equipped (including bags) into the \"Equipment\" section."] = "착용할 수 있는 모든 아이템(가방 포함)을 \"장비\" 항목으로 분류합니다."
+L["Put items categorized as keys in their own section."] = "키로 분류 된 항목을 자체 섹션에 넣습니다." -- Needs review
 L["Put items in sections depending on their first-level category at the Auction House."] = "경매장의 1차 범주에 따라 아이템을 항목으로 분류합니다."
 L["Put items of poor quality or labeled as junk in the \"Junk\" section."] = "하급 아이템이나 잡동사니 아이템을 \"잡동사니\" 항목으로 분류합니다."
 L["Put quest-related items in their own section."] = "퀘스트 관련 아이템을 항목으로 분류합니다."
@@ -1839,6 +1854,7 @@ L["Jewelry"] = "Jóias"
 L["Junk category"] = "Categoria de sucata"
 L["Keep all stacks together."] = "Manter todas as pilhas juntas"
 L["KEYRING_TAG"] = "Ch"
+L["Keyring"] = "Chaveiro"
 L["LDB Plugin"] = "Plugin LDB"
 L["LEATHERWORKING_BAG_TAG"] = "Co"
 L["Let SyLevel handle the the display."] = "Permite que SyLevel suporte a tela"
@@ -1875,6 +1891,7 @@ L["Press Alt while doing so to open a dropdown menu."] = "Pressione Alt enquanto
 L["Priority"] = "Prioridade"
 L["Provides a LDB data source to be displayed by LDB display addons."] = "Fornece uma fonte LDB para ser exibida por LDB addons"
 L["Put any item that can be equipped (including bags) into the \"Equipment\" section."] = "Põe qualquer item que pode ser equipado (incluindo bolsas) na categoria \"equipamento\""
+L["Put items categorized as keys in their own section."] = "Coloque os itens categorizados como chaves em sua própria seção." -- Needs review
 L["Put items in sections depending on their first-level category at the Auction House."] = "Põe itens em seções dependendo da categoria inicial na Casa de Leilões"
 L["Put items of poor quality or labeled as junk in the \"Junk\" section."] = "Põe itens de qualidade inferior ou rotulados como sucata na seção \"Sucata\" "
 L["Put quest-related items in their own section."] = "Põe itens relativos a missões em suas respectivas seções"

core/Constants.lua

@@ -26,16 +26,17 @@ local L = addon.L
 local _G = _G
 local BACKPACK_CONTAINER = _G.BACKPACK_CONTAINER
 local BANK_CONTAINER = _G.BANK_CONTAINER
+local KEYRING_CONTAINER = _G.KEYRING_CONTAINER
 local NUM_BAG_SLOTS = _G.NUM_BAG_SLOTS
 local NUM_BANKBAGSLOTS = _G.NUM_BANKBAGSLOTS
 local pairs = _G.pairs
 --GLOBALS>
 
--- Backpack and bags
-local BAGS = { [BACKPACK_CONTAINER] = BACKPACK_CONTAINER }
+-- Keyring, backpack, and bags
+local BAGS = { [KEYRING_CONTAINER] = KEYRING_CONTAINER, [BACKPACK_CONTAINER] = BACKPACK_CONTAINER }
 for i = 1, NUM_BAG_SLOTS do BAGS[i] = i end
 
--- Base nank bags
+-- Bank and bank bags
 local BANK = { [BANK_CONTAINER] = BANK_CONTAINER }
 for i = NUM_BAG_SLOTS + 1, NUM_BAG_SLOTS + NUM_BANKBAGSLOTS do BANK[i] = i end
 

core/DefaultFilters.lua

@@ -44,6 +44,7 @@ function addon:SetupDefaultFilters()
 	local TRADE_GOODS = GetItemClassInfo(LE_ITEM_CLASS_TRADEGOODS)
 	local WEAPON = GetItemClassInfo(LE_ITEM_CLASS_WEAPON)
 	local ARMOR = GetItemClassInfo(LE_ITEM_CLASS_ARMOR)
+	local KEY = GetItemClassInfo(LE_ITEM_CLASS_KEY)
 	local JEWELRY = L['Jewelry']
 	local EQUIPMENT = L['Equipment']
 	local AMMUNITION = L['Ammunition']
@@ -56,9 +57,23 @@ function addon:SetupDefaultFilters()
 		[CONSUMMABLE] = -10,
 		[MISCELLANEOUS] = -20,
 		[AMMUNITION] = -30,
-		[JUNK] = -40,
+		[KEY] = -40,
+		[JUNK] = -50,
 	}
 
+	-- [90] Key
+	do
+		local keyFilter = addon:RegisterFilter('Key', 90, function(self, slotData)
+			if slotData.bagFamily == 256 or slotData.class == KEY or slotData.subclass == KEY then
+				return KEY
+			else
+				return false
+			end
+		end)
+		keyFilter.uiName = KEY
+		keyFilter.uiDesc = L['Put items categorized as keys in their own section.']
+	end
+
 	-- [75] Quest Items
 	do
 		local questItemFilter = addon:RegisterFilter('Quest', 75, function(self, slotData)

modules/DataSource.lua

@@ -28,6 +28,7 @@ local format = _G.format
 local GetContainerNumFreeSlots = _G.GetContainerNumFreeSlots
 local GetContainerNumSlots = _G.GetContainerNumSlots
 local ipairs = _G.ipairs
+local KEYRING_CONTAINER = _G.KEYRING_CONTAINER
 local pairs = _G.pairs
 local strjoin = _G.strjoin
 local tconcat = _G.table.concat
@@ -121,7 +122,7 @@ local function BuildSpaceString(bags)
 	wipe(free)
 	for bag in pairs(bags) do
 		local bagSize = GetContainerNumSlots(bag)
-		if bagSize and bagSize > 0 then
+		if bag ~= KEYRING_CONTAINER and bagSize and bagSize > 0 then
 			local bagFree, bagFamily = GetContainerNumFreeSlots(bag)
 			if mod.db.profile.mergeBags then bagFamily = 0 end
 			size[bagFamily] = (size[bagFamily] or 0) + bagSize

widgets/BagSlots.lua

@@ -49,6 +49,7 @@ local GetItemInfo = _G.GetItemInfo
 local GetNumBankSlots = _G.GetNumBankSlots
 local ipairs = _G.ipairs
 local IsInventoryItemLocked = _G.IsInventoryItemLocked
+local KEYRING_CONTAINER = _G.KEYRING_CONTAINER
 local next = _G.next
 local NUM_BAG_SLOTS = _G.NUM_BAG_SLOTS
 local NUM_BANKGENERIC_SLOTS = _G.NUM_BANKGENERIC_SLOTS
@@ -103,7 +104,7 @@ do
 		addon:Debug('FindSlotForItem', itemId, GetItemInfo(itemId), 'count=', itemCount, 'maxStack=', maxStack, 'family=', itemFamily, 'bags:', unpack(bags))
 		local bestBag, bestSlot, bestScore
 		for i, bag in pairs(bags) do
-			local scoreBonus = band(select(2, GetContainerNumFreeSlots(bag)) or 0, itemFamily) ~= 0 and maxStack or 0
+			local scoreBonus = band(bag == KEYRING_CONTAINER and 256 or select(2, GetContainerNumFreeSlots(bag)) or 0, itemFamily) ~= 0 and maxStack or 0
 			for slot = 1, GetContainerNumSlots(bag) do
 				local texture, slotCount, locked = GetContainerItemInfo(bag, slot)
 				if not locked and (not texture or GetContainerItemID(bag, slot) == itemId) then
@@ -456,7 +457,7 @@ function addon:CreateBagSlotPanel(container, name, bags, isBank)
 	local x = BAG_INSET
 	local height = 0
 	for i, bag in ipairs(bags) do
-		if bag ~= BACKPACK_CONTAINER and bag ~= BANK_CONTAINER then
+		if bag ~= KEYRING_CONTAINER and bag ~= BACKPACK_CONTAINER and bag ~= BANK_CONTAINER then
 			local button = buttonClass:Create(bag)
 			button:SetParent(self)
 			button:SetPoint("TOPLEFT", x, -TOP_PADDING)

widgets/ContainerFrame.lua

@@ -41,6 +41,7 @@ local GetCursorInfo = _G.GetCursorInfo
 local GetItemInfo = _G.GetItemInfo
 local GetMerchantItemLink = _G.GetMerchantItemLink
 local ipairs = _G.ipairs
+local KEYRING_CONTAINER = _G.KEYRING_CONTAINER
 local max = _G.max
 local min = _G.min
 local next = _G.next
@@ -384,7 +385,7 @@ local function FindBagWithRoom(self, itemFamily)
 	for bag in pairs(self:GetBagIds()) do
 		local numFree, family = GetContainerNumFreeSlots(bag)
 		if numFree and numFree > 0 then
-			if band(family, itemFamily) ~= 0 then
+			if band(bag == KEYRING_CONTAINER and 256 or family, itemFamily) ~= 0 then
 				return bag
 			elseif not fallback then
 				fallback = bag
@@ -495,6 +496,7 @@ function containerProto:UpdateContent(bag)
 	local content = self.content[bag]
 	local newSize = self:GetBagIds()[bag] and GetContainerNumSlots(bag) or 0
 	local _, bagFamily = GetContainerNumFreeSlots(bag)
+	bagFamily = bag == KEYRING_CONTAINER and 256 or bagFamily
 	content.family = bagFamily
 	for slot = 1, newSize do
 		local itemId = GetContainerItemID(bag, slot)
@@ -588,7 +590,9 @@ end
 local function FilterByBag(slotData)
 	local bag = slotData.bag
 	local name
-	if bag == BACKPACK_CONTAINER then
+	if bag == KEYRING_CONTAINER then
+		name = L['Keyring']
+	elseif bag == BACKPACK_CONTAINER then
 		name = L['Backpack']
 	elseif bag == BANK_CONTAINER then
 		name = L['Bank']

widgets/ItemButton.lua

@@ -38,6 +38,7 @@ local IsContainerItemAnUpgrade = _G.IsContainerItemAnUpgrade
 local IsInventoryItemLocked = _G.IsInventoryItemLocked
 local ITEM_QUALITY_COMMON = _G.Enum.ItemQuality.Standard
 local ITEM_QUALITY_POOR = _G.Enum.ItemQuality.Poor
+local KEYRING_CONTAINER = _G.KEYRING_CONTAINER
 local next = _G.next
 local pairs = _G.pairs
 local select = _G.select
@@ -275,7 +276,7 @@ function buttonProto:FullUpdate()
 	self.itemLink = GetContainerItemLink(bag, slot)
 	self.hasItem = not not self.itemId
 	self.texture = GetContainerItemInfo(bag, slot)
-	self.bagFamily = select(2, GetContainerNumFreeSlots(bag))
+	self.bagFamily = bag == KEYRING_CONTAINER and 256 or select(2, GetContainerNumFreeSlots(bag))
 	self:Update()
 end