Bagshui/Components/Inventory.Ui.BagButton.lua

-- Bagshui Inventory Prototype: Bag Slot Buttons

Bagshui:AddComponent(function()
  local Inventory = Bagshui.prototypes.Inventory
  local InventoryUi = Bagshui.prototypes.InventoryUi

  --- Create one bag slot button per container ID in the class instance.
  function InventoryUi:CreateBagSlotButtons()
    local ui = self
    local inventory = self.inventory

    local buttonParent = ui.frames.bagBar
    local buttonTemplate, primaryBag, buttonName, previousBagSlot
    -- Gets assigned to the bagshuiData.bagSlotNum property so that the Bank can
    -- determine whether the slot has been purchased.
    -- Needs to start at 1 for the first non-primary container, so it's initialized
    -- to 0 and incremented in the loop.
    local sequentialBagSlotNum = 0

    for index, containerId in ipairs(inventory.containerIds) do
      local bagSlotButton, inventoryId

      buttonTemplate = inventory.bagButtonTemplate
      primaryBag = false

      if index == 1 and containerId == inventory.primaryContainer.id then
        -- Special handling for the primary bag.
        primaryBag = true
        buttonName = ui:CreateElementName("PrimaryBag")
        -- We use a normal ItemButtonTemplate that gets faked into being a faux bag button.
        buttonTemplate = "ItemButtonTemplate"
      else
        -- All other bags.
        -- Name needs to be in a specific format because we're depending on Blizzard
        -- code for bag slots and there are several places where it parses the element
        -- name using `strsub(this:GetName(), 10)`. It also expects a certain string
        -- to be produced -- for PaperDollItemSlotButton, it's "Bag#Slot" but for
        -- Bank bag buttons it's just "Bag#". The correct name formatting strings
        -- need to be set in each Inventory class' configuration.
        buttonName = string.format(inventory.bagSlotNameFormat, containerId + inventory.bagSlotNameNumberOffset)

        sequentialBagSlotNum = sequentialBagSlotNum + 1
      end

      -- Create the button.
      bagSlotButton = _G.CreateFrame("Button", buttonName, buttonParent, buttonTemplate)

      -- Post-creation button changes.
      if primaryBag then
        -- Primary bag needs extra tweaks.
        -- Blizzard code sets the `hasItem` property to 1 when a slot is occupied, so we're doing the same.
        bagSlotButton.hasItem = 1
        -- Blizzard also uses `tooltipText` to provide bag slot information adn we're reusing that too.
        bagSlotButton.tooltipText = inventory.primaryContainer.name

        -- Set the special texture for this faux bag button.
        _G.SetItemButtonTexture(bagSlotButton, inventory.primaryContainer.texture)
      else
        inventoryId = containerId + inventory.bagButtonIdOffset
        -- All other containers need this for compatibility with Blizzard code.
        -- Also used in Inventory:ShowBagSlotTooltip().
        bagSlotButton:SetID(inventoryId)
      end

      -- Add Bagshui properties.
      bagSlotButton.bagshuiData = {
        type = BS_UI_ITEM_BUTTON_TYPE.BAG,
        bagNum = containerId,
        containerId = containerId,
        bagSlotNum = sequentialBagSlotNum,
        inventoryId = inventoryId,
        inventorySlotId = inventoryId
          and (
            inventory.getInventorySlotFunction
              -- We absolutely have to use 1 instead of true here to get Blizzard's code to work.
              and inventory.getInventorySlotFunction(containerId, 1)
            or inventoryId
          ),
        primary = primaryBag,
        highlightLocked = false,
        cooldown = _G[buttonName .. "Cooldown"],
      }

      -- Need to nuke this property to prevent flickering when bags are being
      -- swapped with adjusted TexCoords (i.e. pfUI skin) due to an
      -- "our code vs Blizzard code" issue.
      bagSlotButton.backgroundTextureName = nil

      -- Create cooldown if needed.
      if not bagSlotButton.bagshuiData.cooldown then
        bagSlotButton.bagshuiData.cooldown = self:CreateItemButtonCooldown(bagSlotButton)
      end
      -- Set this even though we're not relying on it.
      -- See `Ui:ShowProgressViaCooldown()` for details.
      bagSlotButton.bagshuiData.cooldown.noCooldownCount = true

      -- Apply all our appearance adjustments.
      ui:SkinItemButton(bagSlotButton)

      -- Size should be the same as an item slot button.
      bagSlotButton:SetWidth(ui.buttons.itemSlots[1]:GetWidth())
      bagSlotButton:SetHeight(ui.buttons.itemSlots[1]:GetHeight())

      -- First button is anchored to bottom left, subsequent are anchored to the previous one.
      if table.getn(ui.buttons.bagSlots) == 0 then
        bagSlotButton:SetPoint("BOTTOMLEFT", 3, 0)
      else
        bagSlotButton:SetPoint("TOPLEFT", previousBagSlot, "TOPRIGHT", BsSkin.bagBarSpacing, 0)
      end

      -- Expand HitRectInsets to avoid item highlight flickering when moving mouse between buttons.
      local hitRectInset = BsSkin.bagBarSpacing / 2
      bagSlotButton:SetHitRectInsets(-hitRectInset, -hitRectInset, -hitRectInset, -hitRectInset)

      -- Event handling.
      -- We're not reusing Blizzard code for OnEnter/OnLeave/OnUpdate because
      -- it gets really messy trying to add new lines to tooltips when they're
      -- being reset on every frame by the OnUpdate functions.
      -- A lot of this could probably be refactored and merged with ItemButton
      -- code, but that's not a priority.

      -- Note that Bagshui info tooltips are handled in Bagshui.Tooltips.lua, at least for now.
      bagSlotButton:SetScript("OnEnter", function(bagButton)
        if inventory.editMode then
          return
        end

        local this = bagButton or _G.this
        this.bagshuiData.mouseIsOver = true

        -- Display tooltip.
        inventory:ShowBagSlotTooltip(this)

        -- Highlight this bag's contents.
        if
          inventory:BagSlotButtonHasBag(this)
          and not inventory.highlightItemsInContainerLocked
          and not inventory.highlightItemsContainerSlot
        then
          inventory.highlightItemsInContainerId = this.bagshuiData.bagNum
          inventory:UpdateItemSlotColors()
        end

        -- Show slot available/used counts.
        inventory.ui.frames.bagBar:GetScript("OnEnter")()
      end)

      bagSlotButton:SetScript("OnLeave", function()
        _G.this.bagshuiData.mouseIsOver = false

        -- Hide tooltip.
        if _G.GameTooltip:IsOwned(_G.this) then
          _G.GameTooltip:Hide()
        end

        -- Get rid of any cursor changes.
        _G.ResetCursor()

        -- Stop any further tooltip refreshes.
        _G.this.bagshuiData.tooltipCooldownUpdate = nil

        -- Remove bag highlight unless it's locked on.
        if
          inventory.highlightItemsInContainerId == _G.this.bagshuiData.bagNum
          and not inventory.highlightItemsInContainerLocked
          and not inventory.highlightItemsContainerSlot
        then
          inventory.highlightItemsInContainerId = nil
          inventory:UpdateItemSlotColors()
        end

        -- Decide whether to keep displaying slot available/used counts.
        inventory.ui.frames.bagBar:GetScript("OnLeave")()
      end)

      -- Storing at a higher scope to reduce garbage collector load.

      local onUpdate_refreshTooltip, onUpdate_cooldownStart, onUpdate_cooldownDuration, onUpdate_cooldownEnable

      bagSlotButton:SetScript("OnUpdate", function(elapsed)
        onUpdate_refreshTooltip = false

        -- Remove item highlighting if there's no longer a container in the slot.
        if
          inventory.highlightItemsInContainerLocked == _G.this.bagshuiData.bagNum
          and not inventory:BagSlotButtonHasBag(_G.this)
          and not inventory.highlightItemsContainerSlot
        then
          inventory.highlightItemsInContainerLocked = nil
          inventory.highlightItemsInContainerId = nil
          inventory:UpdateBagBar()
          inventory:UpdateItemSlotColors()
        end

        -- "Progress bar" for bag swapping using the cooldown animation.
        if type(_G.this.bagshuiData.progressPercent) == "number" then
          -- Use this by setting the bagButton.bagshuiData.progressPercent property to a value 0-100.
          -- At 100, the completion shine animation will trigger.

          if not _G.this.bagshuiData.progressFinishing then
            -- This has to run on every frame to hold the cooldown at the same spot.
            self:ShowProgressViaCooldown(_G.this.bagshuiData.cooldown, _G.this.bagshuiData.progressPercent)
          end

          if _G.this.bagshuiData.progressPercent == 100 then
            _G.this.bagshuiData.progressFinishing = true
          end

          if _G.this.bagshuiData.progressFinishing and not _G.this.bagshuiData.cooldown:IsVisible() then
            _G.this.bagshuiData.progressPercent = nil
            _G.this.bagshuiData.progressFinishing = nil
          end

          -- elseif this.bagshuiData.inventorySlotId then
          -- Normal cooldown checking is disabled because I don't think bag cooldowns are even a thing.
          -- Easy enough to restore if needed.
          -- If it does get enabled, there will also need to be something added to
          -- Ui:ShowProgressViaCooldown() to hide any cooldown text that was present.
          --
          -- Normal cooldown behavior (primary containers can't have cooldowns so they're excluded.)
          -- onUpdate_cooldownStart, onUpdate_cooldownDuration, onUpdate_cooldownEnable = _G.GetInventoryItemCooldown("player", _G.this.bagshuiData.inventorySlotId)
          -- _G.CooldownFrame_SetTimer(_G.this.bagshuiData.cooldown, onUpdate_cooldownStart, onUpdate_cooldownDuration, onUpdate_cooldownEnable);
        end

        -- Safeguard to prevent tooltips from popping up when the mouse has already left.
        if not _G.this.bagshuiData.mouseIsOver then
          _G.this.bagshuiData.tooltipCooldownUpdate = nil
          return
        end

        if _G.this.bagshuiData.tooltipCooldownUpdate ~= nil then
          -- tooltipCooldownUpdate is initially set to 1 by OnEnter when there's a cooldown.
          -- Here we subtract the elapsed time in seconds, which will eventually go below 0
          -- so long as the property isn't wiped by moving the mouse off this item.
          _G.this.bagshuiData.tooltipCooldownUpdate = _G.this.bagshuiData.tooltipCooldownUpdate - elapsed

          -- Don't proceed until it's been more than 1 second.
          if _G.this.bagshuiData.tooltipCooldownUpdate < 0 then
            onUpdate_refreshTooltip = true
          end
        end

        if onUpdate_refreshTooltip then
          inventory:ShowBagSlotTooltip(_G.this)
        end
      end)

      -- Most of the default OnClick behaviors for bag buttons are fine, but we need to overlay a few things.
      -- - Alt-click highlight lock/unlock.
      -- - Block default functions if offline.
      -- - Handle placing items in primary containers.
      local oldOnClick = bagSlotButton:GetScript("OnClick")
      bagSlotButton:SetScript("OnClick", function()
        local this = _G.this
        local bagNum = this.bagshuiData.bagNum

        local hasBag = inventory:BagSlotButtonHasBag(this)

        -- Right-click or Ctrl+Click: hide/show the items in this bag.
        if inventory:ToggleBagHiddenOnClick(this) then
          return
        end

        -- Alt-click highlight lock.
        if
          hasBag
          and (
            _G.IsAltKeyDown()
            -- Normal clicking needs to remove the highlight lock since the bag might be getting picked up.
            or (inventory.highlightItemsInContainerLocked == bagNum and inventory.online)
          )
          and not inventory.editMode
        then
          local oldHighlightItemsInContainerLocked = inventory.highlightItemsInContainerLocked

          -- Don't do anything if a specific item is highlighted.
          if inventory.highlightItemsContainerSlot then
            return
          end

          -- Toggle highlight lock for this button.
          inventory.highlightItemsInContainerLocked = inventory.highlightItemsInContainerLocked ~= bagNum and bagNum
            or nil

          inventory.highlightItemsInContainerId = bagNum
          inventory:UpdateBagBar()
          -- When the highlight lock is changed, we need to do a full window update
          -- so hidden items in this bag can be shown or hidden.
          if oldHighlightItemsInContainerLocked ~= inventory.highlightItemsInContainerLocked then
            inventory:ForceUpdateWindow()
          else
            inventory:UpdateItemSlotColors()
          end

          -- Don't pick up bag or do anything else if alt key was down.
          if _G.IsAltKeyDown() then
            return
          end
        end

        -- Can't do anything with bags other than highlight items if we're offline or in Edit Mode
        if not inventory.online or inventory.editMode then
          return
        end

        -- Two special cases are handled here.
        --
        -- 1. Placing items in the primary container.
        -- This needs special handling because there doesn't seem to be a bag ID
        -- that works with PutItemInBag for the primary Bank or Keyring containers.
        -- So instead we're iterating the container and looking for empty slots,
        -- then calling PickupContainerItem. This doesn't need to use Bagshui:PickupItem()
        -- since cursor tracking data gets cleared via the ClearCursor() hook and we
        -- don't need to call ContainerFrameItemButton_OnClick() either.
        --
        -- 2. Placing a bag in another bag via Shift+Click.
        if
          _G.CursorHasItem()
          and (
            this.bagshuiData.primary
            or (
              inventory:BagSlotButtonHasBag(this)
              and BsItemInfo:IsContainer(Bagshui.cursorItem)
              and _G.IsShiftKeyDown()
            )
          )
        then
          local noEmptySlots = true
          for slotNum, slotContents in ipairs(inventory.inventory[this.bagshuiData.bagNum]) do
            if slotContents.emptySlot == 1 then
              _G.PickupContainerItem(this.bagshuiData.bagNum, slotNum)
              noEmptySlots = false
            end
          end
          if noEmptySlots then
            Bagshui:ShowErrorMessage(_G.BAG_FULL, self.inventoryType)
          end
          return
        end

        -- Bag swapping.
        if
          _G.CursorHasItem()
          and inventory:BagSlotButtonHasBag(this)
          and BsItemInfo:IsContainer(Bagshui.cursorItem)
        then
          inventory:SwapBag(Bagshui.cursorItem, this.bagshuiData.bagNum)
          return
        end

        -- Call original OnClick.
        if oldOnClick then
          -- Outfitter's `Outfitter_PaperDollItemSlotButton_OnClick()` makes the assumption that
          -- it will only ever be called for the exact buttons it has defined. There is never a
          -- check to verify that `vInventorySlot` isn't nil, and this presents a problem for
          -- our use of `PaperDollItemSlotButtonTemplate` to build `BagshuiBagsContainerTemplate`.
          -- When a Bags bag slot is clicked, Outfitter will throw an error from `OutfitterQuickSlots_Open()`:
          -- ```
          -- Interface\AddOns\Outfitter\Outfitter.lua:6011: attempt to concatenate local `pSlotName' (a nil value)
          -- ```
          -- Luckily we can trick Outfitter into not going down that path by temporarily showing
          -- the OutfitterQuickSlots frame and then hiding it immediately afterwards.
          -- https://github.com/veechs/Bagshui/issues/101
          local outfitterQuickSlotsOldParent = nil
          if
            _G.OutfitterQuickSlots
            and type(_G.OutfitterQuickSlots.IsVisible) == "function"
            and not _G.OutfitterQuickSlots:IsVisible()
          then
            _G.OutfitterQuickSlots:ClearAllPoints()
            -- Need to re-parent to UIParent so `:IsVisible()` will be true.
            outfitterQuickSlotsOldParent = _G.OutfitterQuickSlots:GetParent()
            _G.OutfitterQuickSlots:SetParent(_G.UIParent)
            _G.OutfitterQuickSlots:Show()
          end

          oldOnClick()

          -- Undo the Outfitter workaround.
          if outfitterQuickSlotsOldParent then
            _G.OutfitterQuickSlots:SetParent(outfitterQuickSlotsOldParent)
            _G.OutfitterQuickSlots:Hide()
          end
        end

        -- Equipping a new bag should highlight slots immediately.
        if not hasBag then
          -- Need a short delay for inventory cache to update.
          Bagshui:QueueEvent(this:GetScript("OnEnter"), 0.25, nil, this)
        end
      end)

      -- OnDragStart -- just use the original OnDragStart, but block it when offline or in Edit Mode.
      local oldOnDragStart = bagSlotButton:GetScript("OnDragStart")
      bagSlotButton:SetScript("OnDragStart", function()
        if not inventory.online or inventory.editMode then
          return
        end

        if oldOnDragStart then
          oldOnDragStart()
        end
      end)

      -- Perform final initialization.
      -- This is done in a separate function so subclasses can override it.
      if not primaryBag then
        inventory:BagSlotButton_Init(bagSlotButton)
      end

      -- Add to bagSlots table.
      table.insert(ui.buttons.bagSlots, bagSlotButton)

      -- Update previousBagSlot for button placement.
      previousBagSlot = bagSlotButton
    end
  end

  --- Further initialization of bag slot buttons, called midway through CreateBagSlotButtons().
  --- Broken out as a separate function so subclasses can deal with nuances of different Blizzard
  --- code in Bags and Bank. Just a placeholder for subclasses to override.
  --- This feels like it could be refactored somehow to be cleaner, but it also doesn't feel worth it.
  ---@param bagSlotButton table Button widget.
  function Inventory:BagSlotButton_Init(bagSlotButton) end

  -- For the WoW API functions BagSlotButton_OnClick() and BagSlotButton_OnDrag)(),
  -- we need to first call the original function, then make sure our window is up to date.
  ---@param wowApiFunctionName string Hooked WoW API function that triggered this call.
  function Inventory:BagSlotButton_OnHook(wowApiFunctionName)
    -- Don't interfere if this isn't a Bagshui button
    if not string.find(_G.this:GetName(), self.bagSlotNameFormat) then
      self.hooks:OriginalHook(wowApiFunctionName)
      return
    end

    -- Can't do anything offline.
    if not self.online then
      return
    end
    self.hooks:OriginalHook(wowApiFunctionName)
    self:Update()
  end

  --- Does the given bagSlotButton contain a bag?
  --- (We can't just use the button's `hasItem` property because it doesn't get
  --- updated when viewing other characters.)
  ---@param bagSlotButton any
  ---@return boolean
  function Inventory:BagSlotButtonHasBag(bagSlotButton)
    return (
      self.containers[bagSlotButton.bagshuiData.bagNum]
      and (self.containers[bagSlotButton.bagshuiData.bagNum].numSlots or 0) > 0
    )
  end

  --- Apply bag slot button tooltip modifications.
  --- A lot of this could probably be refactored and merged with ItemButton
  --- code, but that's not a priority.
  ---@param bagSlotButton table Button widget.
  function Inventory:ShowBagSlotTooltip(bagSlotButton)
    local this = bagSlotButton or _G.this

    -- Cases when nothing should happen.
    if
      -- OnEnter still fires even if mouse events are disabled so we need to avoid doing anything when we're in that state.
      not this:IsMouseEnabled()
      -- Don't pop up tooltips or do anything else when a menu is open.
      or self.menus:IsMenuOpen()
    then
      return
    end

    -- Get the tooltip ready.
    _G.GameTooltip:SetOwner(
      this,
      "ANCHOR_" .. BsUtil.FlipAnchorPoint(self.settings.windowAnchorXPoint),
      -BsSkin.tooltipExtraOffset,
      BsSkin.tooltipExtraOffset
    )

    -- Is the bag currently on cooldown?
    local hasCooldown = false

    if not this.bagshuiData.primary and self.online and this.bagshuiData.inventorySlotId then
      -- Not using return value 1 (hasItem) because it's automatically captured into
      -- the button's hasItem property by Blizzard code when an event that changes
      -- bags fires.
      _, hasCooldown = _G.GameTooltip:SetInventoryItem("player", this.bagshuiData.inventorySlotId)
    end

    -- Trigger the OnUpdate function to reload the tooltip after 1 second if there's an active cooldown.
    -- (In other words, the 1 here represents number of seconds, NOT `true`).
    this.bagshuiData.tooltipCooldownUpdate = hasCooldown and 1 or nil

    -- Set bag name or slot status text in tooltip.
    if
      -- Primary bag always needs special handling.
      this.bagshuiData.primary
      -- Try to take care of other bags offline when the name is known.
      or (not self.online and (self.containers[this.bagshuiData.bagNum].name or this.tooltipText or (self.activeCharacterId ~= Bagshui.currentCharacterId)))
      -- When there's no inventoryId we can't use the tooltip's SetInventoryItem().
      or not this.bagshuiData.inventorySlotId
      -- No bag in slot.
      or not this.hasItem
    then
      _G.GameTooltip:SetText(
        (
          self.containers[this.bagshuiData.bagNum].name
          or this.tooltipText
          or (self.activeCharacterId ~= Bagshui.currentCharacterId and L.EmptyBagSlot)
          or _G.EQUIP_CONTAINER
        ),
        1.0,
        1.0,
        1.0
      )
    end

    -- Add key bindings to tooltip.
    if this.hasItem and self.opensViaHooks and self.activeCharacterId == Bagshui.currentCharacterId then
      local keyBinding = _G.GetBindingKey(
        (
          this.bagshuiData.primary and self.primaryContainer.bindingKey
          or (
            self.keyBindingPrefix
            and table.getn(self.containerIdRange) > 0
            -- Refer to Blizzard's BagSlotButton_OnEnter.
            and self.keyBindingPrefix
              .. (self.containerIdRange[2] - (this.bagshuiData.containerId - self.containerIdRange[1]))
          )
        )
      )
      if keyBinding then
        _G.GameTooltip:AppendText(" " .. NORMAL_FONT_COLOR_CODE .. "(" .. keyBinding .. ")" .. FONT_COLOR_CODE_CLOSE)
      end
    end

    -- Figure out how many slots are available and add it to the tooltip.
    local totalSlots = self.containers[this.bagshuiData.bagNum].numSlots
    if totalSlots > 0 then
      local usedSlots = self.containers[this.bagshuiData.bagNum].slotsFilled
      local availableSlots = totalSlots - usedSlots
      local full = (availableSlots <= 0) and (" (" .. L.Full .. ")") or ""
      _G.GameTooltip:AddDoubleLine(
        string.format(L.Symbol_Colon, L.Available) .. " " .. tostring(availableSlots) .. full,
        string.format(L.Symbol_Colon, L.Used) .. " " .. tostring(usedSlots) .. "/" .. tostring(totalSlots),
        1,
        1,
        0.5,
        1,
        1,
        0.5
      )
    end

    -- Is bag swapping possible based on current free space?
    if
      not this.bagshuiData.primary
      and _G.CursorHasItem()
      and self:BagSlotButtonHasBag(this)
      and BsItemInfo:IsContainer(Bagshui.cursorItem)
    then
      _G.GameTooltip:AddLine(self:GetBagSlotSwappableText(this.bagshuiData.bagNum))
      -- Shift+Click to move into bag instead of swapping.
      _G.GameTooltip:AddLine(
        string.format(L.Tooltip_Inventory_PlaceBagInBagHint, L.ShiftClick),
        GRAY_FONT_COLOR.r,
        GRAY_FONT_COLOR.g,
        GRAY_FONT_COLOR.b
      )
    end

    -- Add hint about locking highlight if there's something in the slot and there are items in the inventory cache.
    if
      not self.editMode
      and (((self.activeCharacterId == Bagshui.currentCharacterId) and this.hasItem or false) or (self.containers[this.bagshuiData.bagNum].numSlots or 0) > 0)
      and self.inventory[this.bagshuiData.bagNum]
      and not self.highlightItemsContainerSlot
    then
      _G.GameTooltip:AddLine(
        string.format(
          L.Tooltip_Inventory_ToggleBagSlotHighlightLockHint,
          L.AltClick,
          string.lower(
            (self.highlightItemsInContainerLocked and self.highlightItemsInContainerId == this.bagshuiData.bagNum)
                and L.Unlock
              or L.Lock
          )
        ),
        GRAY_FONT_COLOR.r,
        GRAY_FONT_COLOR.g,
        GRAY_FONT_COLOR.b
      )
    end

    -- Add hint about hiding/showing the bag's items (not for the primary containers, which can't be hidden).
    if not self.editMode and Bagshui.config.HideBagSettings[this.bagshuiData.bagNum] then
      _G.GameTooltip:AddLine(
        string.format(
          L.Tooltip_Inventory_ToggleBagHiddenHint,
          L.RightClick .. " / " .. L.CtrlClick,
          string.lower(self:IsBagHidden(this.bagshuiData.bagNum) and L.Show or L.Hide)
        ),
        GRAY_FONT_COLOR.r,
        GRAY_FONT_COLOR.g,
        GRAY_FONT_COLOR.b
      )
    end

    -- Use code in Bagshui.Tooltips.lua to show info tooltip.
    _G.GameTooltip.bagshuiData.infoTooltipAlwayShow = true
    _G.GameTooltip:Show()
  end

  --- Right-click or Ctrl+Click on a bag button hides/shows the items in that bag.
  --- Called from the bag button's OnClick (and from Bank's replacement OnClick).
  --- Does nothing when something is on the cursor, so bag swapping and item placing still work.
  ---@param bagSlotButton table Bag slot button that was clicked.
  ---@return boolean handled # `true` if the click was used to toggle the bag, so the caller should stop.
  function Inventory:ToggleBagHiddenOnClick(bagSlotButton)
    local settingName = Bagshui.config.HideBagSettings[bagSlotButton.bagshuiData.bagNum]
    if
      settingName
      and (_G.arg1 == "RightButton" or _G.IsControlKeyDown())
      and not _G.CursorHasItem()
      and not self.editMode
    then
      self.settings[settingName] = not self.settings[settingName]
      self:UpdateBagBar()
      return true
    end
    return false
  end

  function Inventory:GetBagSlotSwappableText(bagNum, noColors)
    local text
    local neededSlots, inventoriesChecked = self:GetAdditionalSlotsNeededToSwapBag(bagNum)
    if neededSlots > 0 then
      text = string.format(L.Bag_SlotsNeededToSwap, neededSlots)
      if
        -- Other inventory classes that can be used during swapping are configured in this property.
        type(self.bagSwappingSupplementalStorage) == "table" and table.getn(self.bagSwappingSupplementalStorage) > 0
      then
        local supplementalClasses = ""
        for _, inventoryClassName in ipairs(self.bagSwappingSupplementalStorage) do
          if not inventoriesChecked[inventoryClassName] then
            supplementalClasses = (string.len(supplementalClasses) > 0 and "/" or "")
              .. supplementalClasses
              .. L[inventoryClassName]
          end
        end
        if string.len(supplementalClasses) > 0 then
          text = text
            .. BS_NEWLINE
            .. (not noColors and LIGHTYELLOW_FONT_COLOR_CODE or "")
            .. string.format(L.Bag_SupplementalSpaceAvailable, supplementalClasses, self.inventoryTypeLocalized)
            .. (not noColors and FONT_COLOR_CODE_CLOSE or "")
        end
      end
    end
    return text
  end
end)