Added a button in the addon settins UI to open the Collections UI.

Numynum · Numynum · commit 692178ee011e · 2025-07-26T13:14:22.000+02:00
Added an option to the Collections UI, to treat "From Another Item" as collected
diff --git a/TransmogUpgradeMaster.lua b/TransmogUpgradeMaster.lua
@@ -12,7 +12,6 @@ ns.core = TUM
 TUM.data = ns.data
 --- @type TransmogUpgradeMasterConfig
 TUM.Config = ns.Config
-local settingKeys = TUM.Config.settingKeys
 
 --- @alias TUM_LearnedFromOtherItem "learnedFromOtherItem"
 local LEARNED_FROM_OTHER_ITEM = 'learnedFromOtherItem'
@@ -72,14 +71,14 @@ EventUtil.ContinueOnAddOnLoaded(name, function()
             return;
         end
 
-        TUM.UI:SetShown(not TUM.UI:IsShown());
+        TUM.UI:ToggleUI();
     end
 end)
 
 do
     function TransmogUpgradeMaster_OnAddonCompartmentClick(_, mouseButton)
         if mouseButton == 'LeftButton' then
-            TUM.UI:SetShown(not TUM.UI:IsShown());
+            TUM.UI:ToggleUI();
         else
             TUM.Config:OpenSettings();
         end
@@ -296,9 +295,9 @@ local modifierFunctions = {
 --- @param isCollected boolean
 function TUM:AddTooltipLine(tooltip, text, isCollected, fromOtherItem)
     local modifierSetting =
-        (isCollected and self.db[settingKeys.showCollectedModifierKey])
-        or (fromOtherItem and self.db[settingKeys.showCollectedFromOtherItemModifierKey])
-        or (self.db[settingKeys.showUncollectedModifierKey])
+        (isCollected and self.db.showCollectedModifierKey)
+        or (fromOtherItem and self.db.showCollectedFromOtherItemModifierKey)
+        or (self.db.showUncollectedModifierKey)
     local modifierFunction = modifierFunctions[modifierSetting]
     if not modifierFunction or not modifierFunction() then
         return
@@ -313,7 +312,7 @@ end
 --- @param tooltip GameTooltip
 --- @param text string
 function TUM:AddDebugLine(tooltip, text)
-    if not self.db[settingKeys.debug] then return end
+    if not self.db.debug then return end
 
     tooltip:AddDoubleLine('<TUM Debug>', text, 1, 0.5, 0, 1, 1, 1)
 end
@@ -561,11 +560,11 @@ function TUM:HandleTooltip(tooltip, tooltipData)
         end
     end
 
-    if modifierFunctions[self.db[settingKeys.showWarbandCatalystInfoModifierKey]]() and self:CanSendItemToAlt(itemLink, tooltipData) then
+    if modifierFunctions[self.db.showWarbandCatalystInfoModifierKey]() and self:CanSendItemToAlt(itemLink, tooltipData) then
         local catalystClassList = {}
         local catalystUpgradeClassList = {}
         for classID = 1, GetNumClasses() do
-            if classID ~= playerClassID and self.db[settingKeys.warbandCatalystClassList][classID] then
+            if classID ~= playerClassID and self.db.warbandCatalystClassList[classID] then
                 local classResult = self:IsAppearanceMissing(itemLink, classID)
                 if classResult.catalystAppearanceMissing then
                     table.insert(catalystClassList, classID)
@@ -709,7 +708,7 @@ function TUM:HandleCatalystInteraction()
     local isFree = not ItemInteractionFrame:UsesCharges() and not ItemInteractionFrame:CostsCurrency()
     if not isConversion then return end
 
-    local setting = self.db[settingKeys.autoConfirmCatalyst]
+    local setting = self.db.autoConfirmCatalyst
     if
         setting == self.Config.autoConfirmCatalystOptions.always
         or (setting == self.Config.autoConfirmCatalystOptions.previousSeason and isFree)
diff --git a/collectionUi.lua b/collectionUi.lua
@@ -72,6 +72,60 @@ function UI:Init()
         titleBar:SetPoint('BOTTOMRIGHT', self, 'TOPRIGHT', 0, -32);
     end
 
+    local settings = CreateFrame('DropdownButton', nil, self);
+    self.Settings = settings;
+    do
+        settings:SetFrameStrata('HIGH');
+        settings:SetPoint('RIGHT', self.TitleBar, 'RIGHT', -20, 3);
+        settings:SetSize(32, 32);
+        do -- icon
+            settings.atlasKey = 'GM-icon-settings';
+            settings:SetNormalAtlas(settings.atlasKey);
+            Mixin(settings, ButtonStateBehaviorMixin);
+            function settings:OnButtonStateChanged()
+                local atlas = self.atlasKey;
+                if self:IsDownOver() or self:IsOver() then
+                    atlas = atlas .. '-hover';
+                elseif self:IsDown() then
+                    atlas = atlas .. '-pressed';
+                end
+
+                self:GetNormalTexture():SetAtlas(atlas, TextureKitConstants.IgnoreAtlasSize);
+            end
+
+            settings:OnLoad();
+            settings:HookScript('OnEnter', settings.OnEnter);
+            settings:HookScript('OnLeave', settings.OnLeave);
+            settings:HookScript('OnMouseDown', settings.OnMouseDown);
+            settings:HookScript('OnMouseUp', settings.OnMouseUp);
+        end
+
+        settings:HookScript('OnEnter', function()
+            GameTooltip:SetOwner(settings, 'ANCHOR_TOPRIGHT');
+            GameTooltip:SetText('Settings');
+            GameTooltip_AddInstructionLine(GameTooltip, CreateAtlasMarkup('NPE_LeftClick', 18, 18) .. ' to open settings');
+            GameTooltip:Show();
+        end);
+        settings:HookScript('OnLeave', function()
+            GameTooltip:Hide();
+        end);
+        --- @param rootDescription RootMenuDescriptionProxy
+        settings:SetupMenu(function(_, rootDescription)
+            rootDescription:CreateButton(CreateAtlasMarkup('GM-icon-settings', 20, 20) .. ' Open General TUM Settings', function() TUM.Config:OpenSettings(); end);
+            rootDescription:CreateTitle('Collection UI Settings');
+            rootDescription:CreateCheckbox(
+                'Treat "From Another Item" as collected',
+                function()
+                    return TUM.db.UI_treatOtherItemAsCollected;
+                end,
+                function()
+                    TUM.db.UI_treatOtherItemAsCollected = not TUM.db.UI_treatOtherItemAsCollected;
+                    UI.deferNewResult = true;
+                end
+            );
+        end);
+    end
+
     local classDropdown = CreateFrame('DropdownButton', nil, self, 'WowStyle1DropdownTemplate');
     self.classDropdown = classDropdown;
     do
@@ -278,10 +332,6 @@ function UI:Init()
             headers:SetHeight(1);
             headers.Background:Hide();
             headers.TopTileStreaks:Hide();
-            --[[
-                Future ideas:
-                - Add a spyglass icon to the header, clicking it will open Dressing Room showing the relevant item set
-            --]]
 
             local magnifyingGlassAtlas = 'common-search-magnifyingglass'
 
@@ -337,10 +387,7 @@ function UI:Init()
         self.rows = {};
         --- @param column TUM_UI_Column
         local function OnEnter(column)
-            --[[
-                Future ideas:
-                - Add a model viewer to the tooltip, to show the item appearance
-            --]]
+            if column.isCollected then return; end
             GameTooltip:SetOwner(column, 'ANCHOR_CURSOR_RIGHT');
             GameTooltip:AddLine('Transmog Upgrade Master');
             if column.results and next(column.results) then
@@ -393,6 +440,8 @@ function UI:Init()
                 column.slot = slot;
                 --- @type nil|TUM_UI_ResultData[]
                 column.results = nil; -- will be filled later when results are available
+                --- @type boolean|'learnedFromOtherItem'|nil
+                column.isCollected = nil;
 
                 if j ~= 1 then
                     column:SetScript('OnEnter', OnEnter)
@@ -424,6 +473,10 @@ function UI:Init()
     end
 end
 
+function UI:ToggleUI()
+    self:SetShown(not self:IsShown());
+end
+
 function UI:RegisterIntoBlizzMove()
     --- @type BlizzMoveAPI?
     local BlizzMoveAPI = BlizzMoveAPI; ---@diagnostic disable-line: undefined-global
@@ -482,6 +535,9 @@ function UI:OnUpdate()
                     local results = self.results and self.results[slot] and self.results[slot][tier];
                     column.results = results;
                     column.isCollected = TUM:IsCatalystItemCollected(self.currentSeason, self.currentClass, slot, tier);
+                    if TUM.db.UI_treatOtherItemAsCollected and 'learnedFromOtherItem' == column.isCollected then
+                        column.isCollected = true;
+                    end
 
                     column.Text:ClearPointsOffset()
                     if true == column.isCollected then
diff --git a/config.lua b/config.lua
@@ -4,6 +4,7 @@ local name, ns = ...;
 local Config = {}
 ns.Config = Config;
 
+--- @enum TUM_Config_ModifierKeyOptions
 Config.modifierKeyOptions = {
     always = "always",
     shift = "shift",
@@ -12,6 +13,7 @@ Config.modifierKeyOptions = {
     never = "never",
 };
 
+--- @enum TUM_Config_AutoConfirmCatalystOptions
 Config.autoConfirmCatalystOptions = {
     never = "never",
     previousSeason = "previousSeason",
@@ -27,34 +29,47 @@ Config.settingKeys = {
     warbandCatalystClassList = "warbandCatalystClassList",
     autoConfirmCatalyst = "autoConfirmCatalyst",
     debug = "debug",
+    UI_treatOtherItemAsCollected = "UI_treatOtherItemAsCollected",
 };
 
+--- @return TUM_DB
 function Config:Init()
-    TransmogUpgradeMasterDB = TransmogUpgradeMasterDB or {};
-    self.db = TransmogUpgradeMasterDB;
+    --- @class TUM_DB
     local defaults = {
-        [self.settingKeys.hideWhenCollected] = false,
-        [self.settingKeys.debug] = false,
-        [self.settingKeys.showCollectedModifierKey] = self.modifierKeyOptions.always,
-        [self.settingKeys.showCollectedFromOtherItemModifierKey] = self.modifierKeyOptions.always,
-        [self.settingKeys.showUncollectedModifierKey] = self.modifierKeyOptions.always,
-        [self.settingKeys.showWarbandCatalystInfoModifierKey] = self.modifierKeyOptions.shift,
-        [self.settingKeys.warbandCatalystClassList] = {},
-        [self.settingKeys.autoConfirmCatalyst] = self.autoConfirmCatalystOptions.previousSeason,
+        --- @type boolean
+        hideWhenCollected = false,
+        --- @type boolean
+        debug = false,
+        --- @type TUM_Config_ModifierKeyOptions
+        showCollectedModifierKey = self.modifierKeyOptions.always,
+        --- @type TUM_Config_ModifierKeyOptions
+        showCollectedFromOtherItemModifierKey = self.modifierKeyOptions.always,
+        --- @type TUM_Config_ModifierKeyOptions
+        showUncollectedModifierKey = self.modifierKeyOptions.always,
+        --- @type TUM_Config_ModifierKeyOptions
+        showWarbandCatalystInfoModifierKey = self.modifierKeyOptions.shift,
+        --- @type table<number, boolean> # [classID] = true/false
+        warbandCatalystClassList = {},
+        --- @type TUM_Config_AutoConfirmCatalystOptions
+        autoConfirmCatalyst = self.autoConfirmCatalystOptions.previousSeason,
+        --- @type boolean
+        UI_treatOtherItemAsCollected = false,
     };
+    TransmogUpgradeMasterDB = TransmogUpgradeMasterDB or {};
+    self.db = TransmogUpgradeMasterDB;
     for k, v in pairs(defaults) do
         if self.db[k] == nil then
-            if k == self.settingKeys.showCollectedFromOtherItemModifierKey then
-                self.db[k] = (self.db[self.settingKeys.showUncollectedModifierKey] or v);
+            if k == "showCollectedFromOtherItemModifierKey" then
+                self.db[k] = (self.db.showUncollectedModifierKey or v);
             else
                 self.db[k] = v;
             end
         end
     end
     for classID = 1, GetNumClasses() do
-        defaults[self.settingKeys.warbandCatalystClassList][classID] = true;
-        if self.db[self.settingKeys.warbandCatalystClassList][classID] == nil then
-            self.db[self.settingKeys.warbandCatalystClassList][classID] = true;
+        defaults.warbandCatalystClassList[classID] = true;
+        if self.db.warbandCatalystClassList[classID] == nil then
+            self.db.warbandCatalystClassList[classID] = true;
         end
     end
 
@@ -120,7 +135,7 @@ function Config:Init()
         local expandInitializer, isExpanded = self:MakeExpandableSection("Displayed Classes")
 
         local function isVisible()
-            return self.db[self.settingKeys.showWarbandCatalystInfoModifierKey] ~= self.modifierKeyOptions.never;
+            return self.db.showWarbandCatalystInfoModifierKey ~= self.modifierKeyOptions.never;
         end
         expandInitializer:AddShownPredicate(isVisible);
         layout:AddInitializer(expandInitializer);
@@ -134,9 +149,9 @@ function Config:Init()
                 category,
                 label,
                 classID,
-                defaults[self.settingKeys.warbandCatalystClassList][classID],
+                defaults.warbandCatalystClassList[classID],
                 tooltip:format(classColor:WrapTextInColorCode(className)),
-                self.db[self.settingKeys.warbandCatalystClassList]
+                self.db.warbandCatalystClassList
             );
             classCheckbox:SetParentInitializer(showWarbandInfo, isVisible);
             classCheckbox:AddShownPredicate(isVisible);
@@ -178,6 +193,19 @@ function Config:Init()
         "Reset the Transmog cache. This will cause the addon to re-cache all items, which may take a minute or so. This can fix rare situations when transmog changes are hotfixed in by blizzard."
     )
 
+    self:MakeButton(
+        category,
+        layout,
+        "Open Collections UI",
+        function()
+            TUM.UI:ToggleUI();
+        end,
+        string.format(
+            "Open the Collections UI, you can also type %s in chat, or click on the Addon Compartment button to open this UI.",
+            GREEN_FONT_COLOR:WrapTextInColorCode("/tum")
+        )
+    )
+
     Settings.RegisterAddOnCategory(category)
 
     return self.db;
@@ -279,10 +307,6 @@ end
 --- @class TransmogUpgradeMaster_SettingsButtonControlMixin : SettingsControlMixin
 TransmogUpgradeMaster_SettingsButtonControlMixin = CreateFromMixins(SettingsControlMixin);
 do
-    local function InitializeSettingTooltip(initializer)
-        Settings.InitTooltip(initializer:GetName(), initializer:GetTooltip());
-    end
-
     local mixin = TransmogUpgradeMaster_SettingsButtonControlMixin;
     function mixin:OnLoad()
         SettingsControlMixin.OnLoad(self);
@@ -297,8 +321,9 @@ do
         self.Button:SetText(self.data.buttonText);
         self.Button:SetScript("OnClick", self.data.OnButtonClick);
         self.Button:SetScript("OnEnter", function(button)
-            GameTooltip:SetOwner(button, "ANCHOR_RIGHT");
-            InitializeSettingTooltip(initializer);
+            GameTooltip:SetOwner(button, "ANCHOR_TOP");
+            GameTooltip_AddHighlightLine(GameTooltip, initializer:GetName());
+            GameTooltip_AddNormalLine(GameTooltip, initializer:GetTooltip());
             GameTooltip:Show();
         end);
         self.Button:SetScript("OnLeave", function() GameTooltip:Hide(); end);
