Repository navigation
Docs: add The Burning Crusade Anniversary to keyring documentation (#1359) - #1370
Merged
Merged
Conversation
…1359) Issue #1359: BetterBags_TBC.toc loads core/era/constants.lua, which adds Enum.BagIndex.Keyring (-2) to const.BACKPACK_BAGS and const.BACKPACK_ONLY_BAGS. No keyring check inspects the running client; each keyring check tests the bag ID and const.BACKPACK_BAGS. On The Burning Crusade Anniversary, BetterBags therefore reads the keyring with the backpack, reads only the slots opened by GetKeyRingSize(), excludes keyring slots from free space, labels the keyring "#6: Keyring" in Show Bags, and orders the keyring after every bag, matching Classic Era behavior. Previously, the rules files, code comments, and README files named only Classic Era and WoW: Forever, and one comment named only WoW: Forever. Blizzard's TBC Anniversary UI source (branch classic_anniversary, 2.5.6.70577) defines the same keyring as Classic Era: Enum.BagIndex.Keyring is -2, KEYRING_CONTAINER equals Enum.BagIndex.Keyring, Blizzard_MainMenuBarBagButtons/Classic/MainMenuBarBagButtons.lua defines GetKeyRingSize() identically to Classic Era and loads at startup on every classic game type, and ContainerFrame_GetContainerNumSlots returns GetKeyRingSize() for the keyring. This change edits documentation and code comments only; no code behavior changes: - .claude/rules/keyring.md: Add TBC Anniversary to the introduction, section 1, and the section 2 coverage note. Record that no keyring check inspects the running client, and that on Classic Era and TBC Anniversary BetterBags does not call IsKeyRingEnabled() (unlike Blizzard's keyring button), so a keyring with zero slots yields zero slots. - .claude/rules/bag-drop-zone.md: Document the keyring for keys on TBC Anniversary. - .claude/rules/item-drawing.md: Extend the open in-game check on whether empty keyring slots display the key glyph to TBC Anniversary alongside Classic Era. - Code comments: Update comments in data/items.lua (isBackpackKeyring, items:GetBagName, IncludeBagInFreeSpace, items:Harvest), util/sort.lua (slotOrder), core/constants.lua (the WoW: Forever keyring), and spec/helpers/wow_mocks.lua (the source reference for the GetKeyRingSize mock). - README.md, data/README.md, util/README.md: Update the keyring client list in each file. No tests were added because code behavior is unchanged and the existing Classic Era keyring specs (keyring -2 with bags 0-4) exercise TBC Anniversary's bag IDs. luacheck and the full test suite pass.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #1359.
Problem
BetterBags_TBC.tocloadscore/era/constants.lua, which addsEnum.BagIndex.Keyring(-2) toconst.BACKPACK_BAGSandconst.BACKPACK_ONLY_BAGS. No keyring check inspects the running client; each keyring check tests the bag ID andconst.BACKPACK_BAGS. On The Burning Crusade Anniversary, BetterBags therefore reads the keyring with the backpack, reads only the slots opened byGetKeyRingSize(), excludes keyring slots from free space, labels the keyring "#6: Keyring" in Show Bags, and orders the keyring after every bag, matching Classic Era behavior. Previously, the rules files, code comments, and README files named only Classic Era and WoW: Forever, and theIncludeBagInFreeSpacecomment named only WoW: Forever.Evidence
Blizzard's TBC Anniversary UI source (branch
classic_anniversary,2.5.6.70577) defines the same keyring as Classic Era:Enum.BagIndex.Keyringis-2(BagIndexConstantsDocumentation.lua), andKEYRING_CONTAINERequalsEnum.BagIndex.Keyring(Blizzard_FrameXMLBase/Classic/Constants.lua).Blizzard_MainMenuBarBagButtons/Classic/MainMenuBarBagButtons.luadefinesGetKeyRingSize()identically to Classic Era and loads at startup on every classic game type.ContainerFrame_GetContainerNumSlots(Blizzard_UIPanels_Game/Classic/ContainerFrame_Shared.lua) returnsGetKeyRingSize()for the keyring.Changes
Documentation and code comments only; no code behavior changes.
.claude/rules/keyring.mdIsKeyRingEnabled()on Classic Era or TBC Anniversary, so a keyring with zero slots yields zero slots.claude/rules/bag-drop-zone.md.claude/rules/item-drawing.mddata/items.luaisBackpackKeyring,items:GetBagName,IncludeBagInFreeSpace, anditems:Harvestutil/sort.luaslotOrdercore/constants.luaspec/helpers/wow_mocks.luaGetKeyRingSizemock citesREADME.md,data/README.md,util/README.mdTesting
No tests were added because code behavior is unchanged and the existing Classic Era keyring specs (keyring
-2with bags0-4) exercise TBC Anniversary's bag IDs.luacheckand the full test suite pass.