Fix right-click ignores

The mod now reacts by adding or removing the Breakable button row when the player gains or loses an appropriate skill or profession. So if you train Enchanting, a disenchant bar will be added and if you unlearn it it will go away, for example.

.github/workflows/release.yml

@@ -23,6 +23,7 @@ jobs:
     env:
       CF_API_KEY: ${{ secrets.CF_API_KEY }}
       WOWI_API_TOKEN: ${{ secrets.WOWI_API_TOKEN }}
+      WAGO_API_TOKEN: ${{ secrets.WAGO_API_TOKEN }}
       GITHUB_OAUTH: ${{ secrets.GITHUB_TOKEN }}  # "GITHUB_TOKEN" is a secret always provided to the workflow
                                                  # for your own token, the name cannot start with "GITHUB_"
 
@@ -31,20 +32,27 @@ jobs:
 
       # we first have to clone the AddOn project, this is a required step
       - name: Clone project
-        uses: actions/checkout@v1
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0  # gets git history for changelogs
 
       # once cloned, we just run the GitHub Action for the packager project
       - name: Package and release
-        uses: BigWigsMods/packager@master
+        uses: BigWigsMods/packager@v2
 
       # another example where we supply additional arguments, this example is specifically to release
       # for the Classic version of the game
       - name: Package and release for Classic
-        uses: BigWigsMods/packager@master
+        uses: BigWigsMods/packager@v2
         with:
           args: -g classic -w 0
 
       - name: Package and release for TBC
-        uses: BigWigsMods/packager@master
+        uses: BigWigsMods/packager@v2
         with:
           args: -g bcc -w 0
+
+      - name: Package and release for Wrath
+        uses: BigWigsMods/packager@v2
+        with:
+          args: -g wrath -w 0

.pkgmeta

@@ -37,6 +37,7 @@ externals:
 
 ignore:
     - readme.md
+    - FUNDING.yml
 
 manual-changelog: changelog.txt
 

Breakables.lua

@@ -13,8 +13,32 @@ if not IsArtifactRelicItem then
 end
 
 local WowVer = select(4, GetBuildInfo())
-local IsClassic = WOW_PROJECT_ID and WOW_PROJECT_ID == WOW_PROJECT_CLASSIC
-local IsClassicBC = WOW_PROJECT_ID and WOW_PROJECT_ID == WOW_PROJECT_BURNING_CRUSADE_CLASSIC
+local IsClassic = false
+local IsClassicBC = false
+local IsClassicWrath = false
+if GetClassicExpansionLevel then
+	IsClassic = GetClassicExpansionLevel() == 0
+	IsClassicBC = GetClassicExpansionLevel() == 1
+	IsClassicWrath = GetClassicExpansionLevel() == 2
+else
+	IsClassic = WOW_PROJECT_ID and WOW_PROJECT_ID == WOW_PROJECT_CLASSIC
+	IsClassicBC = false
+	IsClassicWrath = false
+	if WOW_PROJECT_ID and WOW_PROJECT_ID == WOW_PROJECT_BURNING_CRUSADE_CLASSIC then
+		if not LE_EXPANSION_LEVEL_CURRENT or LE_EXPANSION_LEVEL_CURRENT == LE_EXPANSION_BURNING_CRUSADE then
+			IsClassicBC = true
+		elseif LE_EXPANSION_LEVEL_CURRENT == LE_EXPANSION_WRATH_OF_THE_LICH_KING then
+			IsClassicWrath = true
+		end
+	elseif WOW_PROJECT_WRATH_CLASSIC and WOW_PROJECT_ID == WOW_PROJECT_WRATH_CLASSIC then
+		IsClassicWrath = true
+	end
+end
+
+local ShouldHookTradeskillUpdate = WowVer < 80000
+local ShouldShowTabardControls = WowVer >= 80000
+local UseNonNativeEqManagerChecks = WowVer < 80000
+local IgnoreEnchantingSkillLevelForDisenchant = WowVer >= 80000
 
 local MillingId = 51005
 local MillingItemSubType = babbleInv["Herb"]
@@ -219,6 +243,7 @@ local BREAKABLE_PICK = 4
 local BREAKABLE_COMBINE = 5
 
 local BagUpdateCheckDelay = 0.1
+local PickLockFinishedDelay = 1
 local nextCheck = {}
 for i=0,NUM_BAG_SLOTS do
 	nextCheck[i] = -1
@@ -237,6 +262,10 @@ local showingTooltip = nil
 
 Breakables.optionsFrame = {}
 Breakables.justClicked = false
+Breakables.justClickedBag = -1
+Breakables.justClickedSlot = -1
+Breakables.justPickedBag = -1
+Breakables.justPickedSlot = -1
 
 function Breakables:OnInitialize()
 	self.defaults = {
@@ -310,12 +339,28 @@ function Breakables:InitLDB()
 	end
 end
 
-function Breakables:OnEnable()
+function Breakables:SetCapabilities()
 	CanMill = IsUsableSpell(GetSpellInfo(MillingId))
 	CanProspect = IsUsableSpell(GetSpellInfo(ProspectingId))
 	CanDisenchant = IsUsableSpell(GetSpellInfo(DisenchantId))
 	CanPickLock = IsUsableSpell(GetSpellInfo(PickLockId))
+end
 
+function Breakables:OnSpellsChanged()
+	local couldMill = CanMill
+	local couldProspect = CanProspect
+	local couldDisenchant = CanDisenchant
+	local couldPick = CanPickLock
+	self:SetCapabilities()
+
+	if couldMill ~= CanMill or couldProspect ~= CanProspect or couldDisenchant ~= CanDisenchant or couldPick ~= CanPickLock then
+		self:SetupButtons()
+	end
+end
+
+function Breakables:OnEnable()
+	self:SetCapabilities()
+	
 	self.EnchantingLevel = 0
 
 	LibStub("AceConfig-3.0"):RegisterOptionsTable("Breakables", self:GetOptions(), "breakables")
@@ -332,7 +377,16 @@ function Breakables:OnEnable()
 
 	self:RegisterEvents()
 
-	if CanMill or CanProspect or CanDisenchant or CanPickLock then
+	self:SetupButtons()
+end
+
+local canBreakSomething = function()
+	return CanMill or CanProspect or CanDisenchant or CanPickLock
+end
+
+function Breakables:SetupButtons()
+	numEligibleProfessions = 0
+	if canBreakSomething() then
 		if CanMill then
 			numEligibleProfessions = numEligibleProfessions + 1
 		end
@@ -358,7 +412,7 @@ function Breakables:OnEnable()
 		end
 		self.frame:SetScript("OnUpdate", self.frame.OnUpdateFunc)
 	else
-		self:UnregisterAllEvents()
+		self:CreateButtonFrame()
 	end
 end
 
@@ -387,14 +441,13 @@ function Breakables:RegisterEvents()
 	self:RegisterEvent("PLAYER_REGEN_ENABLED", "OnLeaveCombat")
 
 	self:RegisterEvent("MODIFIER_STATE_CHANGED", "FindBreakables")
+	self:RegisterEvent("SPELLS_CHANGED", "OnSpellsChanged")
 
-	if CanDisenchant and WowVer < 80000 then
+	if ShouldHookTradeskillUpdate then
 		self:RegisterEvent("TRADE_SKILL_UPDATE", "OnTradeSkillUpdate")
 	end
 
-	if CanPickLock then
-		self:RegisterEvent("CHAT_MSG_OPENING", "OnBagItemLockPicked")
-	end
+	self:RegisterEvent("UNIT_SPELLCAST_SUCCEEDED", "OnSpellCastSucceeded")
 
 	if UnitCanPetBattle then
 		self:RegisterEvent("PET_BATTLE_OPENING_START", "PetBattleStarted")
@@ -460,12 +513,24 @@ function Breakables:OnLeaveCombat()
 end
 
 function Breakables:OnTradeSkillUpdate()
+	if not CanDisenchant then
+		return
+	end
+
 	self:GetEnchantingLevel()
 	self:FindBreakables()
 end
 
-function Breakables:OnBagItemLockPicked()
+function Breakables:OnSpellCastSucceeded(evt, unit, guid, spell)
+	if spell ~= PickLockId or not CanPickLock then
+		return
+	end
+
+	self.justPickedBag = self.justClickedBag
+	self.justPickedSlot = self.justClickedSlot
+
 	self:FindBreakables()
+	nextCheck[0] = GetTime() + PickLockFinishedDelay
 end
 
 function Breakables:PetBattleStarted()
@@ -498,6 +563,14 @@ function Breakables:GetEnchantingLevel()
 				self.EnchantingLevel = rank
 			end
 		end
+	elseif GetSkillLineInfo then
+		for i=1,100 do
+			local skillName, header, isExpanded, skillRank, numTempPoints, skillModifier, skillMaxRank, isAbandonable, stepCost, rankCost, minLevel, skillCostType = GetSkillLineInfo(i)
+			if skillName == babbleInv["Enchanting"] then
+				self.EnchantingLevel = skillRank
+				break
+			end
+		end
 	end
 end
 
@@ -720,65 +793,86 @@ function Breakables:GetOptions()
 				hidden = function() return not IsIgnoringAnything() end,
 				order = 31,
 			},
-		},
-	}
-
-	if CanDisenchant then
-		opts.args.showSoulbound = {
-			type = "toggle",
-			name = L["Show soulbound items"],
-			desc = L["Whether or not to display soulbound items as breakables."],
-			get = function(info)
-				return self.settings.showSoulbound
-			end,
-			set = function(info, v)
-				self.settings.showSoulbound = v
-				if info.uiType == "cmd" then
-					print("|cff33ff99Breakables|r: set |cffffff78showSoulbound|r to " .. tostring(self.settings.showSoulbound))
-				end
-				self:FindBreakables()
-			end,
-			order = 20,
-		}
-		if GetNumEquipmentSets or C_EquipmentSet then
-			opts.args.hideEqManagerItems = {
+			showSoulbound = {
 				type = "toggle",
-				name = L["Hide Eq. Mgr items"],
-				desc = L["Whether or not to hide items that are part of an equipment set in the game's equipment manager."],
+				name = L["Show soulbound items"],
+				desc = L["Whether or not to display soulbound items as breakables."],
 				get = function(info)
-					return self.settings.hideEqManagerItems
+					return self.settings.showSoulbound
 				end,
 				set = function(info, v)
-					self.settings.hideEqManagerItems = v
+					self.settings.showSoulbound = v
 					if info.uiType == "cmd" then
-						print("|cff33ff99Breakables|r: set |cffffff78hideEqManagerItems|r to " .. tostring(self.settings.hideEqManagerItems))
+						print("|cff33ff99Breakables|r: set |cffffff78showSoulbound|r to " .. tostring(self.settings.showSoulbound))
 					end
 					self:FindBreakables()
 				end,
 				hidden = function()
-					return not self.settings.showSoulbound
+					return not CanDisenchant
 				end,
-				order = 21,
-			}
-		end
-		if WowVer >= 80000 then
-			opts.args.hideTabards = {
-				type = "toggle",
-				name = L["Hide Tabards"],
-				desc = L["Whether or not to hide tabards from the disenchantable items list."],
-				get = function(info)
-					return self.settings.hideTabards
-				end,
-				set = function(info, v)
-					self.settings.hideTabards = v
-					if info.uiType == "cmd" then
-						print("|cff33ff99Breakables|r: set |cffffff78hideTabards|r to " .. tostring(self.settings.hideTabards))
-					end
-					self:FindBreakables()
-				end,
-				order = 22,
-			}
-		end
+				order = 20,
+			},
+		},
+	}
+
+	if GetNumEquipmentSets or C_EquipmentSet then
+		opts.args.hideEqManagerItems = {
+			type = "toggle",
+			name = L["Hide Eq. Mgr items"],
+			desc = L["Whether or not to hide items that are part of an equipment set in the game's equipment manager."],
+			get = function(info)
+				return self.settings.hideEqManagerItems
+			end,
+			set = function(info, v)
+				self.settings.hideEqManagerItems = v
+				if info.uiType == "cmd" then
+					print("|cff33ff99Breakables|r: set |cffffff78hideEqManagerItems|r to " .. tostring(self.settings.hideEqManagerItems))
+				end
+				self:FindBreakables()
+			end,
+			hidden = function()
+				return not CanDisenchant and not self.settings.showSoulbound
+			end,
+			order = 21,
+		}
+	end
+
+	if ShouldShowTabardControls then
+		opts.args.hideTabards = {
+			type = "toggle",
+			name = L["Hide Tabards"],
+			desc = L["Whether or not to hide tabards from the disenchantable items list."],
+			get = function(info)
+				return self.settings.hideTabards
+			end,
+			set = function(info, v)
+				self.settings.hideTabards = v
+				if info.uiType == "cmd" then
+					print("|cff33ff99Breakables|r: set |cffffff78hideTabards|r to " .. tostring(self.settings.hideTabards))
+				end
+				self:FindBreakables()
+			end,
+			order = 22,
+		}
+	end
+
+	if not IgnoreEnchantingSkillLevelForDisenchant then
+		opts.args.ignoreEnchantingSkillLevel = {
+			type = "toggle",
+			name = L["Ignore Enchanting skill level"],
+			desc = L["Whether or not items should be shown when Breakables thinks you don't have the appropriate skill level to disenchant it."],
+			get = function(info)
+				return self.settings.ignoreEnchantingSkillLevel
+			end,
+			set = function(info, v)
+				self.settings.ignoreEnchantingSkillLevel = v
+				self:FindBreakables()
+				if info.uiType == "cmd" then
+					print("|cff33ff99Breakables|r: set |cffffff78ignoreEnchantingSkillLevel|r to " .. tostring(self.settings.ignoreEnchantingSkillLevel))
+				end
+			end,
+			order = 10,
+		}
 	end
 
 	if UnitCanPetBattle then
@@ -811,6 +905,11 @@ function Breakables:CreateButtonFrame()
 		self.buttonFrame = {}
 	end
 
+	for i=numEligibleProfessions+1,#self.buttonFrame do
+		self.buttonFrame[i]:ClearAllPoints()
+		self.buttonFrame[i]:Hide()
+	end
+
 	for i=1,numEligibleProfessions do
 		if not self.buttonFrame[i] then
 			self.buttonFrame[i] = CreateFrame("Button", "BREAKABLES_BUTTON_FRAME"..i, self.frame, "SecureActionButtonTemplate")
@@ -833,7 +932,7 @@ function Breakables:CreateButtonFrame()
 			frame:SetHeight(buttonSize)
 
 			frame:EnableMouse(true)
-			frame:RegisterForClicks("LeftButtonUp")
+			frame:RegisterForClicks("LeftButtonUp", "LeftButtonDown")
 
 			if not frame.OnMouseDownFunc then
 				frame.OnMouseDownFunc = function(frame) self:OnMouseDown(frame) end
@@ -941,6 +1040,10 @@ function Breakables:FindBreakables(bag)
 		return
 	end
 
+	if not canBreakSomething() then
+		return
+	end
+
 	if self.bCombat then
 		self.bPendingUpdate = true
 		return
@@ -1003,7 +1106,7 @@ function Breakables:FindBreakables(bag)
 						btn:SetWidth(buttonSize)
 						btn:SetHeight(buttonSize)
 						btn:EnableMouse(true)
-						btn:RegisterForClicks("AnyUp")
+						btn:RegisterForClicks("AnyUp", "AnyDown")
 
 						btn:SetAttribute("type1", "spell")
 
@@ -1161,6 +1264,9 @@ function Breakables:OnLeaveBreakableButton()
 end
 
 function Breakables:PostClickedBreakableButton(this)
+	self.justClickedBag = this.bag
+	self.justClickedSlot = this.slot
+
 	if this.type == BREAKABLE_HERB or this.type == BREAKABLE_ORE or this.type == BREAKABLE_DE or this.type == BREAKABLE_COMBINE then
 		self.justClicked = true
 	end
@@ -1174,12 +1280,17 @@ function Breakables:FindBreakablesInBag(bagId)
 		for slotId=1,GetContainerNumSlots(bagId) do
 			local found = self:FindBreakablesInSlot(bagId, slotId)
 			if found then
-				local addedToExisting = self:MergeBreakables(found, foundBreakables)
+				if bagId ~= self.justPickedBag or slotId ~= self.justPickedSlot then
+					local addedToExisting = self:MergeBreakables(found, foundBreakables)
 
-				if not addedToExisting then
-					foundBreakables[i] = found
-					i = i + 1
+					if not addedToExisting then
+						foundBreakables[i] = found
+						i = i + 1
+					end
 				end
+			elseif bagId == self.justPickedBag and slotId == self.justPickedSlot then
+				self.justPickedBag = -1
+				self.justPickedSlot = -1
 			end
 		end
 	end
@@ -1355,7 +1466,7 @@ do
 end
 
 function Breakables:IsInEquipmentSet(itemId)
-	if WowVer < 80000 and GetNumEquipmentSets then
+	if UseNonNativeEqManagerChecks and GetNumEquipmentSets then
 		for setIdx=1, GetNumEquipmentSets() do
 			local set = GetEquipmentSetInfo(setIdx)
 			local itemArray = GetEquipmentSetItemIDs(set)
@@ -1420,8 +1531,17 @@ end
 function Breakables:BreakableIsDisenchantable(itemType, itemLevel, itemRarity, itemLink, itemId)
 	for i=1,#DisenchantTypes do
 		if DisenchantTypes[i] == itemType or IsArtifactRelicItem(itemLink) then
-			-- temp hack for bfa until disenchant item level scales are identified. and for classic until finding the profession level api
-			if WowVer >= 80000 or IsClassic or IsClassicBC then
+			-- bfa+ no longer has skill level requirements for disenchanting
+			if IgnoreEnchantingSkillLevelForDisenchant then
+				return true
+			end
+
+			if self.settings.ignoreEnchantingSkillLevel then
+				return true
+			end
+
+			-- if we couldn't figure out the player's enchanting skill level, err on the side of showing stuff
+			if self.EnchantingLevel == 0 then
 				return true
 			end
 

Breakables.toc

@@ -1,7 +1,8 @@
-## Interface: 90205
-## Interface-Retail: 90205
+## Interface: 100000
+## Interface-Retail: 100000
 ## Interface-Classic: 11403
 ## Interface-BCC: 20504
+## Interface-Wrath: 30400
 ## Author: Parnic
 ## Name: Breakables
 ## Title: Breakables |cff7fff7f-Ace3-|r
@@ -16,6 +17,7 @@
 ## OptionalDeps: Ace3, LibBabble-Inventory-3.0, Masque
 ## X-Curse-Project-ID: 16629
 ## X-WoWI-ID: 17929
+## X-Wago-ID: rkGrlA6y
 
 #@no-lib-strip@
 embeds.xml

FUNDING.yml

@@ -0,0 +1,3 @@
+github: parnic
+ko_fi: parnic
+custom: "https://www.paypal.me/parnic"

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 parnic
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

changelog.txt

@@ -1,3 +1,26 @@
+v1.9.1:
+
+- Fix right-click ignore functionality after the upgrade to 10.0.
+
+v1.9.0:
+
+- Handle gaining and losing a Breakable skill without requiring a UI reload
+- Update TOC, fix button clicking bug for 10.0
+
+v1.8.7:
+
+- Improve reliability of UI updates after picking lockboxes. There's no good game event for "locked item opened", so this uses some best-guess heuristics to make it function as expected in most cases.
+
+v1.8.6:
+
+- Improve enchanting level detection for Wrath Classic
+- Add option to ignore enchanting skill level for showing disenchantable items
+
+v1.8.5:
+
+- Wrath Classic compatibility
+- Updated TOCs
+
 v1.8.4:
 
 - Updated TOCs