-- Initialize Food pool if not existing, which may be created by other mods.
-- Any joker can add itself to this pool by adding a pools table to its definition
-- Credits to Cryptid for the idea
if not SMODS.ObjectTypes.Food then
  SMODS.ObjectType {
    key = 'Food',
    default = 'j_egg',
    cards = {},
    inject = function(self)
      SMODS.ObjectType.inject(self)
      -- Insert base game food jokers
      for k, _ in pairs(PB_UTIL.vanilla_food) do
        self:inject_card(G.P_CENTERS[k])
      end
    end
  }
end

---Checks if a string is a valid paperclip key
---@param str string
---@return boolean
function PB_UTIL.is_paperclip(str)
  for _, v in ipairs(PB_UTIL.ENABLED_PAPERCLIPS) do
    if 'paperback_' .. v == str then
      return true
    end
  end
  return false
end

---Checks if a card has a paperclip. If found, the first value returned is the key.
---The second value returned is the config table of the supplied paperclip.
---Returns nil if no paperclip is on the card.
---@param card table
---@return string | nil
---@return table | nil
function PB_UTIL.has_paperclip(card)
  for k, v in pairs(card and card.ability or {}) do
    if PB_UTIL.is_paperclip(k) then
      return k, v
    end
  end
end

--- Counts all the paperclips in the specified area and returns the count
--- @param args { area: table, allow_debuff: boolean?, exclude_highlighted: boolean? }
--- @return integer
function PB_UTIL.count_paperclips(args)
  local clips = 0

  for _, v in ipairs(args.area and args.area.cards or {}) do
    local debuff_check = args.allow_debuff or not v.debuff
    local highlighted_check = not args.exclude_highlighted or not v.highlighted

    if PB_UTIL.has_paperclip(v) and debuff_check and highlighted_check then
      clips = clips + 1
    end
  end

  return clips
end

--- Removes all paperclip keys from this card
---@param card table
function PB_UTIL.remove_paperclip(card)
  for k, _ in pairs(card and card.ability or {}) do
    if PB_UTIL.is_paperclip(k) then
      card.ability[k] = nil
    end
  end
end

---Applies a paperclip with provided type to the provided card.
---A playing card can only have a single paperclip.
---@param card table
---@param type Paperclip
function PB_UTIL.set_paperclip(card, type)
  local key = 'paperback_' .. type .. '_clip'

  if card and PB_UTIL.is_paperclip(key) then
    PB_UTIL.remove_paperclip(card)
    SMODS.Stickers[key]:apply(card, true)
  end
end

---Fetches a random paperclip type using a given seed
---@param seed string
function PB_UTIL.poll_paperclip(seed)
  local clip = pseudorandom_element(PB_UTIL.ENABLED_PAPERCLIPS, pseudoseed(seed))
  clip = string.sub(clip, 1, #clip - 5)
  return clip
end

---Checks if a provided card is classified as a "Food Joker"
---@param card table | string a center key or a card
---@return boolean
function PB_UTIL.is_food(card)
  local center = type(card) == "string"
      and G.P_CENTERS[card]
      or (card.config and card.config.center)

  if not center then
    return false
  end

  -- If the center has the Food pool in its definition
  if center.pools and center.pools.Food then
    return true
  end

  -- If it doesn't, we check if this is a vanilla food joker
  return PB_UTIL.vanilla_food[center.key]
end

---Returns a table of all the Jokers classified as "Food Jokers" in the G.jokers cardarea
---@return table
function PB_UTIL.get_owned_food()
  local res = {}

  if G.jokers then
    for _, v in ipairs(G.jokers.cards) do
      if PB_UTIL.is_food(v) then
        res[#res + 1] = v
      end
    end
  end

  return res
end

---Registers a list of items in a custom order
---@param items table
---@param path string
function PB_UTIL.register_items(items, path)
  for i = 1, #items do
    SMODS.load_file(path .. "/" .. items[i] .. ".lua")()
  end
end

---Reverses a provided table
---@param t table
---@return table
function PB_UTIL.reverse_table(t)
  local reversed = {}
  for i = #t, 1, -1 do
    table.insert(reversed, t[i])
  end
  return reversed
end

---Gets the number of complete suits that the user has in their deck
---@param vanilla_ranks boolean
---@return integer
function PB_UTIL.get_complete_suits(vanilla_ranks)
  if not G.playing_cards then return 0 end

  local deck = {}
  local amount = 0

  for k, v in ipairs(G.playing_cards) do
    if not SMODS.has_no_suit(v) then
      deck[v.base.suit] = deck[v.base.suit] or {}
      deck[v.base.suit][v.base.value] = true
    end
  end

  for _, deck_ranks in pairs(deck) do
    local res = true

    for k, v in pairs(vanilla_ranks and PB_UTIL.base_ranks or SMODS.Ranks) do
      if not deck_ranks[vanilla_ranks and v or k] then
        res = false
      end
    end

    amount = amount + (res and 1 or 0)
  end

  return amount
end

---Modifies the sell value of a provided card by the provided amount
---@param card table | Card
---@param amount integer
function PB_UTIL.modify_sell_value(card, amount)
  if not card.set_cost or amount == 0 then return end
  card.ability.extra_value = (card.ability.extra_value or 0) + amount
  card:set_cost()
end

--- Sets the base sell cost of `card` to `amount`.
--- (total sell cost is base plus `card.ability.extra_value`)
---@param card table | Card
---@param amount integer
function PB_UTIL.set_base_sell_value(card, amount)
  if not card.set_cost then return end
  card.ability.paperback_forced_base_sell_cost = amount
  card:set_cost()
end

--- Sets the sell cost of `card` to `amount`.
--- Also clears `card.ability.extra_value`.
---@param card table | Card`
---@param amount integer
function PB_UTIL.set_sell_value(card, amount)
  if not card.set_cost then return end
  card.ability.paperback_forced_base_sell_cost = amount
  card.ability.extra_value = nil
  card:set_cost()
end

---Calculates the xMult provided by the supplied Stick Joker (card)
---@param card table
---@return number
function PB_UTIL.calculate_stick_xMult(card)
  local xMult = card.ability.extra.xMult

  -- Only calculate the xMult if the G.jokers cardarea exists
  if G.jokers and G.jokers.cards then
    for k, current_card in pairs(G.jokers.cards) do
      if current_card ~= card and string.match(string.lower(current_card.ability.name), "%f[%w]stick%f[%W]") then
        xMult = xMult + card.ability.extra.xMult
      end
    end
  end

  return xMult
end

---Gets the number of unique suits in a provided scoring hand
---@param scoring_hand table
---@param bypass_debuff boolean?
---@param flush_calc boolean?
---@return integer
function PB_UTIL.get_unique_suits(scoring_hand, bypass_debuff, flush_calc)
  -- Set each suit's count to 0
  local suits = {}

  for k, _ in pairs(SMODS.Suits) do
    suits[k] = 0
  end

  -- First we cover all the non Wild Cards in the hand
  for _, card in ipairs(scoring_hand) do
    if not SMODS.has_any_suit(card) then
      for suit, count in pairs(suits) do
        if card:is_suit(suit, bypass_debuff, flush_calc) and count == 0 then
          suits[suit] = count + 1
          break
        end
      end
    end
  end

  -- Then we cover Wild Cards, filling the missing suits
  for _, card in ipairs(scoring_hand) do
    if SMODS.has_any_suit(card) then
      for suit, count in pairs(suits) do
        if card:is_suit(suit, bypass_debuff, flush_calc) and count == 0 then
          suits[suit] = count + 1
          break
        end
      end
    end
  end

  -- Count the amount of suits that were found
  local num_suits = 0

  for _, v in pairs(suits) do
    if v > 0 then num_suits = num_suits + 1 end
  end

  return num_suits
end

--- Creates and opens the specified booster pack, the same way a Tag would do it
--- @param key string
function PB_UTIL.open_booster_pack(key)
  local pack = Card(
    G.play.T.x + G.play.T.w / 2 - G.CARD_W * 1.27 / 2,
    G.play.T.y + G.play.T.h / 2 - G.CARD_H * 1.27 / 2,
    G.CARD_W * 1.27, G.CARD_H * 1.27, G.P_CARDS.empty,
    G.P_CENTERS[key],
    { bypass_discovery_center = true, bypass_discovery_ui = true }
  )

  pack.cost = 0
  pack.from_tag = true

  G.FUNCS.use_card { config = { ref_table = pack } }
  pack:start_materialize()
end

--- Creates and redeems the specified voucher
---@param key string
function PB_UTIL.redeem_voucher(key)
  local voucher = Card(
    G.shop_vouchers.T.x + G.shop_vouchers.T.w / 2,
    G.shop_vouchers.T.y,
    G.CARD_W, G.CARD_H, G.P_CARDS.empty,
    G.P_CENTERS[key],
    { bypass_discovery_center = true, bypass_discovery_ui = true }
  )

  voucher.cost = 0

  G.FUNCS.use_card { config = { ref_table = voucher } }
  voucher:start_materialize()
end

---Gets a pseudorandom tag from the Tag pool
---@param seed string
---@param options table? a list of tags to choose from, defaults to normal pool
---@return table
function PB_UTIL.poll_tag(seed, options)
  -- This part is basically a copy of how the base game does it
  -- Look at get_next_tag_key in common_events.lua
  local pool = options or get_current_pool('Tag')
  local tag_key = pseudorandom_element(pool, pseudoseed(seed))

  while tag_key == 'UNAVAILABLE' do
    tag_key = pseudorandom_element(pool, pseudoseed(seed))
  end

  local tag = Tag(tag_key)

  -- The way the hand for an orbital tag in the base game is selected could cause issues
  -- with mods that modify blinds, so we randomly pick one from all visible hands
  if tag_key == "tag_orbital" then
    local available_hands = {}

    for _, k in ipairs(G.handlist) do
      local hand = G.GAME.hands[k]
      if hand.visible then
        available_hands[#available_hands + 1] = k
      end
    end

    tag.ability.orbital_hand = pseudorandom_element(available_hands, pseudoseed(seed .. '_orbital'))
  end

  return tag
end

--- Adds a tag the same way vanilla does it
--- @param tag string | table a tag key or a tag table
--- @param event boolean? whether to send this in an event or not
--- @param silent boolean? whether to play a sound
function PB_UTIL.add_tag(tag, event, silent)
  local func = function()
    add_tag(type(tag) == 'string' and Tag(tag) or tag)
    if not silent then
      play_sound('generic1', 0.9 + math.random() * 0.1, 0.8)
      play_sound('holo1', 1.2 + math.random() * 0.1, 0.4)
    end
    return true
  end

  if event then
    G.E_MANAGER:add_event(Event {
      func = func
    })
  else
    func()
  end
end

--- Gets a random consumable type
--- @param seed string
--- @return SMODS.ConsumableType
function PB_UTIL.poll_consumable_type(seed)
  local types = {}
  for _, k in ipairs(SMODS.ConsumableType.ctype_buffer) do
    types[#types + 1] = SMODS.ConsumableTypes[k]
  end

  return pseudorandom_element(types, pseudoseed(seed))
end

--- Tries to spawn a card into either the Jokers or Consumeable card areas, ensuring
--- that there is space available, using the respective buffer.
--- DOES NOT TAKE INTO ACCOUNT ANY OTHER AREAS
--- @param args CreateCard | { card: Card?, strip_edition: boolean? } | { instant: boolean?, func: function? } info:
--- Either a table passed to SMODS.create_card, which will create a new card.
--- Or a table with 'card', which will copy the passed card and remove its edition based on 'strip_edition'.
--- @return boolean? spawned whether the card was able to spawn
function PB_UTIL.try_spawn_card(args)
  local is_joker = args.card and (args.card.ability.set == 'Joker') or
      (args.set == 'Joker' or (args.key and args.key:sub(1, 1) == 'j'))
  local area = args.area or (is_joker and G.jokers) or G.consumeables
  local buffer = area == G.jokers and 'joker_buffer' or 'consumeable_buffer'

  if #area.cards + G.GAME[buffer] < area.config.card_limit then
    local added_card
    local function add()
      if args.card then
        added_card = copy_card(args.card, nil, nil, nil, args.strip_edition)
        added_card:add_to_deck()
        area:emplace(added_card)
      else
        added_card = SMODS.add_card(args)
      end
    end

    if args.instant then
      add()
    else
      G.GAME[buffer] = G.GAME[buffer] + 1

      G.E_MANAGER:add_event(Event {
        func = function()
          add()
          G.GAME[buffer] = 0
          return true
        end
      })
    end

    if args.func and type(args.func) == "function" then
      args.func(added_card)
    end

    return true
  end
end

--- Whether the area has space for a card to be added
---@param area table|CardArea
---@param inc_buffer boolean? Whether to increment the buffer
---@return boolean?
function PB_UTIL.can_spawn_card(area, inc_buffer)
  local buffer =
      (area == G.jokers and 'joker_buffer') or
      (area == G.consumeables and 'consumeable_buffer') or nil

  if area and #area.cards + (buffer and G.GAME[buffer] or 0) < area.config.card_limit then
    if inc_buffer and buffer then
      G.GAME[buffer] = G.GAME[buffer] + 1
    end

    return true
  end
end

---Destroys the provided Joker
---@param card table
---@param after function?
function PB_UTIL.destroy_joker(card, after)
  G.E_MANAGER:add_event(Event({
    func = function()
      play_sound('tarot1')
      card.T.r = -0.2
      card:juice_up(0.3, 0.4)
      card.states.drag.is = true
      card.children.center.pinch.x = true
      G.E_MANAGER:add_event(Event({
        trigger = 'after',
        delay = 0.3,
        blockable = false,
        func = function()
          G.jokers:remove_card(card)
          card:remove()

          if after and type(after) == "function" then
            after()
          end

          return true
        end
      }))
      return true
    end
  }))
end

---This function is basically a copy of how the base game does the flipping animation
---on playing cards when using a consumable that modifies them
---@param card table?
---@param cards_to_flip table?
---@param action function?
---@param sound string?
function PB_UTIL.use_consumable_animation(card, cards_to_flip, action, sound)
  -- If it's not a list, make it one
  if cards_to_flip and not cards_to_flip[1] then
    cards_to_flip = { cards_to_flip }
  end

  if card then
    G.E_MANAGER:add_event(Event {
      trigger = 'after',
      delay = 0.4,
      func = function()
        play_sound(sound or 'tarot1')
        card:juice_up(0.3, 0.5)
        return true
      end
    })
  end

  if cards_to_flip then
    for i = 1, #cards_to_flip do
      local c = cards_to_flip[i]
      local percent = 1.15 - (i - 0.999) / (#cards_to_flip - 0.998) * 0.3

      G.E_MANAGER:add_event(Event {
        trigger = 'after',
        delay = 0.15,
        func = function()
          c:flip()
          play_sound('card1', percent)
          c:juice_up(0.3, 0.3)
          return true
        end
      })
    end

    delay(0.2)
  end

  G.E_MANAGER:add_event(Event {
    trigger = 'after',
    delay = 0.1,
    func = function()
      if action and type(action) == "function" then
        action()
      end
      return true
    end
  })

  if cards_to_flip then
    for i = 1, #cards_to_flip do
      local c = cards_to_flip[i]
      local percent = 0.85 + (i - 0.999) / (#cards_to_flip - 0.998) * 0.3

      G.E_MANAGER:add_event(Event {
        trigger = 'after',
        delay = 0.15,
        func = function()
          c:flip()
          play_sound('tarot2', percent, 0.6)
          c:juice_up(0.3, 0.3)

          -- Update the sprites of cards
          if c.config and c.config.center then
            c:set_sprites(c.config.center)
          end
          if c.ability then
            c.front_hidden = c:should_hide_front()
          end

          return true
        end
      })
    end
  end

  G.E_MANAGER:add_event(Event {
    trigger = 'after',
    delay = 0.2,
    func = function()
      G.hand:unhighlight_all()
      return true
    end
  })

  if cards_to_flip then
    delay(0.5)
  end
end

--- Shows the "Nope!" text that Wheel of Fortune does when failing on top of a card
--- @param card table
--- @param color table? the color of the square that pops up, defaults to Tarot
function PB_UTIL.show_nope_text(card, color)
  -- This is all a copy of how the base game does it
  G.E_MANAGER:add_event(Event({
    trigger = 'after',
    delay = 0.4,
    func = function()
      local booster = G.STATE == G.STATES.TAROT_PACK
          or G.STATE == G.STATES.SPECTRAL_PACK
          or G.STATE == G.STATES.SMODS_BOOSTER_OPENED

      attention_text({
        text = localize('k_nope_ex'),
        scale = 1.3,
        hold = 1.4,
        major = card,
        backdrop_colour = color or G.C.SECONDARY_SET.Tarot,
        align = booster and 'tm' or 'cm',
        offset = {
          x = 0,
          y = booster and -0.2 or 0
        },
        silent = true
      })

      G.E_MANAGER:add_event(Event({
        trigger = 'after',
        delay = 0.06 * G.SETTINGS.GAMESPEED,
        blockable = false,
        blocking = false,
        func = function()
          play_sound('tarot2', 0.76, 0.4)
          return true
        end
      }))

      play_sound('tarot2', 1, 0.4)
      card:juice_up(0.3, 0.5)
      return true
    end
  }))
end

--- Returns hands or discards, whichever is lower
--- @return { hands: boolean?, discards: boolean?, amt: integer }
function PB_UTIL.get_lowest_hand_discard()
  if not G.GAME then return { amt = 0 } end

  local hands = G.GAME.current_round.hands_left
  local discards = G.GAME.current_round.discards_left

  if hands == discards then
    return { amt = hands, discards = true, hands = true }
  elseif hands < discards then
    return { amt = hands, hands = true }
  else
    return { amt = discards, discards = true }
  end
end

--- Returns the key of the Planet card for the specified poker hand
--- @param hand_name string the name of the poker hand, like "Four of a Kind"
--- @return string?
function PB_UTIL.get_planet_for_hand(hand_name)
  for _, v in ipairs(G.P_CENTER_POOLS.Planet) do
    if v.config and v.config.hand_type == hand_name then
      return v.key
    end
  end
end

--- Returns a list of visible hands, ordered by most played to least
--- @return {key: string, hand: table, planet_key: string}[]
function PB_UTIL.get_most_played_hands()
  local hands = {}

  for _, v in ipairs(G.P_CENTER_POOLS.Planet) do
    if v.config and v.config.hand_type then
      local hand = G.GAME.hands[v.config.hand_type]

      if hand and hand.visible then
        hands[#hands + 1] = {
          key = v.config.hand_type,
          hand = hand,
          planet_key = v.key
        }
      end
    end
  end

  table.sort(hands, function(a, b)
    if a.hand.played ~= b.hand.played then
      return a.hand.played > b.hand.played
    end

    -- Sort by base values if the played amount is equal
    return (a.hand.s_mult * a.hand.s_chips) > (b.hand.s_mult * b.hand.s_chips)
  end)

  return hands
end

---Gets a sorted list of all ranks in descending order
---@return table
function PB_UTIL.get_sorted_ranks()
  local ranks = {}

  for k, v in pairs(SMODS.Ranks) do
    ranks[#ranks + 1] = v
  end

  table.sort(ranks, function(a, b)
    return a.sort_nominal > b.sort_nominal
  end)

  return ranks
end

--- Checks whether a given card is a certain rank
---@param card Card | table
---@param rank string | integer a rank's name, like "Jack" or "4", or an id like 11 or 4
---@return boolean | nil
function PB_UTIL.is_rank(card, rank)
  if not card or not card.get_id then return end
  local id = card:get_id()

  if type(rank) == 'string' then
    local rank_obj = SMODS.Ranks[rank]
    return rank_obj and rank_obj.id == id
  elseif type(rank) == 'number' then
    return id == rank
  end
end

---Gets a rank's object from a supplied id
---@param id integer
---@return table | nil
function PB_UTIL.get_rank_from_id(id)
  for _, v in pairs(SMODS.Ranks) do
    if v.id == id then return v end
  end
end

---Returns whether the first rank is higher than the second
---@param rank1 string | integer a rank such as "Ace" or "9", or an id such as 14 or 9
---@param rank2 string | integer
---@param allow_equal? boolean
---@return boolean
function PB_UTIL.compare_ranks(rank1, rank2, allow_equal)
  local r1 = type(rank1) == 'string' and SMODS.Ranks[rank1] or PB_UTIL.get_rank_from_id(rank1)
  local r2 = type(rank2) == 'string' and SMODS.Ranks[rank2] or PB_UTIL.get_rank_from_id(rank2)

  -- If one of the ranks doesn't exist
  if not r1 or not r2 then return false end

  local comp = function(a, b)
    return allow_equal and (a >= b) or (a > b)
  end

  return comp(r1.sort_nominal, r2.sort_nominal)
end

---Used to check whether a card is a light or dark suit
---@param card table
---@param type 'light' | 'dark'
---@return boolean
function PB_UTIL.is_suit(card, type)
  for _, v in ipairs(type == 'light' and PB_UTIL.light_suits or PB_UTIL.dark_suits) do
    if card:is_suit(v) then return true end
  end
  return false
end

---Checks if the provided suit is currently in the deck
---@param suit string
---@param ignore_wild? boolean
---@return boolean
function PB_UTIL.has_suit_in_deck(suit, ignore_wild)
  for _, v in ipairs(G.playing_cards or {}) do
    if not SMODS.has_no_suit(v) and (v.base.suit == suit or (not ignore_wild and v:is_suit(suit))) then
      return true
    end
  end
  return false
end

-- Checks if a spectrum hand has been played
--- @return boolean
function PB_UTIL.spectrum_played()
  local spectrum_played = false
  if G and G.GAME and G.GAME.hands then
    for k, v in pairs(G.GAME.hands) do
      if string.find(k, "Spectrum", nil, true) then
        if G.GAME.hands[k].played > 0 then
          spectrum_played = true
          break
        end
      end
    end
  end

  return spectrum_played
end

--- Whether the played hand contains a spectrum
---@param hands table obtained from `context.poker_hands`
---@return boolean | nil
function PB_UTIL.contains_spectrum(hands)
  for k, v in pairs(hands) do
    if k:find('Spectrum', nil, true) and #v > 0 then
      return true
    end
  end
end

--- @return boolean
function PB_UTIL.has_modded_suit_in_deck()
  for k, v in ipairs(G.playing_cards or {}) do
    local is_modded = true
    for _, suit in ipairs(PB_UTIL.base_suits) do
      if v.base.suit == suit then
        is_modded = false
      end
    end

    if not SMODS.has_no_suit(v) and is_modded then
      return true
    end
  end
  return false
end

--- Balances chips and shows the cosmetic effects just like Plasma deck
---@param card (table|Card)?
---@param only_visual boolean whether to only do the visual effects
function PB_UTIL.apply_plasma_effect(card, only_visual)
  -- Actually balance the chips and mult
  if not only_visual then
    local tot = hand_chips + mult
    hand_chips = mod_chips(math.floor(tot / 2))
    mult = mod_mult(math.floor(tot / 2))
  end

  update_hand_text({ delay = 0 }, { mult = mult, chips = hand_chips })

  -- Cosmetic effects
  G.E_MANAGER:add_event(Event({
    func = (function()
      -- Play sounds and change the color of the scoring values
      play_sound('gong', 0.94, 0.3)
      play_sound('gong', 0.94 * 1.5, 0.2)
      play_sound('tarot1', 1.5)
      ease_colour(G.C.UI_CHIPS, { 0.8, 0.45, 0.85, 1 })
      ease_colour(G.C.UI_MULT, { 0.8, 0.45, 0.85, 1 })

      -- If a card was passed, show the balanced message on it
      if card then
        SMODS.calculate_effect({
          message = localize('k_balanced'),
          colour  = { 0.8, 0.45, 0.85, 1 },
          instant = true
        }, card)
      end

      -- Return the colors to normal
      G.E_MANAGER:add_event(Event({
        trigger = 'after',
        blockable = false,
        blocking = false,
        delay = 4.3,
        func = (function()
          ease_colour(G.C.UI_CHIPS, G.C.BLUE, 2)
          ease_colour(G.C.UI_MULT, G.C.RED, 2)
          return true
        end)
      }))

      G.E_MANAGER:add_event(Event({
        trigger = 'after',
        blockable = false,
        blocking = false,
        no_delete = true,
        delay = 6.3,
        func = (function()
          G.C.UI_CHIPS[1], G.C.UI_CHIPS[2], G.C.UI_CHIPS[3], G.C.UI_CHIPS[4] =
              G.C.BLUE[1], G.C.BLUE[2], G.C.BLUE[3], G.C.BLUE[4]
          G.C.UI_MULT[1], G.C.UI_MULT[2], G.C.UI_MULT[3], G.C.UI_MULT[4] =
              G.C.RED[1], G.C.RED[2], G.C.RED[3], G.C.RED[4]
          return true
        end)
      }))
      return true
    end)
  }))

  delay(0.6)
end

--- Logic for the Panorama Jokers
--- @param self (SMODS.Center)
--- @param card (Card)
--- @param context (CalcContext)
function PB_UTIL.panorama_logic(self, card, context)
  if context.individual and context.cardarea == G.play then
    -- Reset the xMult if the current card is not the required suit
    if not context.other_card:is_suit(card.ability.extra.suit) then
      card.ability.extra.xMult = card.ability.extra.xMult_base
      return
    end

    -- Give the xMult if the current card is the required suit
    if context.other_card:is_suit(card.ability.extra.suit) then
      local xMult = card.ability.extra.xMult
      -- Upgrade the xMult if not blueprint
      if not context.blueprint then
        card.ability.extra.xMult = card.ability.extra.xMult + card.ability.extra.xMult_gain
      end

      return {
        x_mult = xMult,
        card = card
      }
    end
  end

  -- Quietly reset the xMult for the card at the end of played hand
  if context.after and not context.blueprint then
    card.ability.extra.xMult = card.ability.extra.xMult_base
  end
end

--- Loc Vars function for the Panorama Jokers
---@param self table
---@param info_queue table
---@param card Card
---@return table
function PB_UTIL.panorama_loc_vars(self, info_queue, card)
  return {
    vars = {
      localize(card.ability.extra.suit, 'suits_plural'),
      tostring(card.ability.extra.xMult_base),
      tostring(card.ability.extra.xMult_gain),
      localize(card.ability.extra.suit, 'suits_singular'),

    }
  }
end

--- Logic for the Stick Food Jokers
---@param self (SMODS.Center)
---@param card (Card)
---@param context (CalcContext)
---@return table
function PB_UTIL.stick_food_joker_logic(self, card, context)
  -- Give the mult during play if card is the specified suit
  if context.individual and context.cardarea == G.play then
    if context.other_card:is_suit(card.ability.extra.suit) then
      return {
        mult = card.ability.extra.mult,
        card = card
      }
    end
  end

  -- Check if the Joker needs to be eaten
  if context.end_of_round and not context.blueprint and context.main_eval then
    if PB_UTIL.chance(card, card.ability.extra.stick_key) then
      PB_UTIL.destroy_joker(card, function()
        -- Remove this joker from the pool
        G.GAME.pool_flags[card.config.center.original_key .. "_can_spawn"] = false

        -- Create Popsicle Stick
        SMODS.add_card {
          key = card.ability.extra.stick_key,
          edition = card.edition
        }
      end)

      return {
        message = localize('k_eaten_ex'),
        colour = G.C.MULT,
        card = card
      }
    else
      return {
        message = localize('k_safe_ex'),
        colour = G.C.CHIPS,
        card = card
      }
    end
  end
end

--- The logic for the Stick Jokers
---@param self (SMODS.Center)
---@param card (Card)
---@param context (CalcContext)
---@return table
function PB_UTIL.stick_joker_logic(self, card, context)
  if context.joker_main then
    local xMult = PB_UTIL.calculate_stick_xMult(card)

    if xMult ~= 1 then
      return {
        x_mult = xMult,
        card = card
      }
    end
  end
end

--- Gets a random hand that has been unlocked by the player
---@param seed string
---@return string hand the name of the hand, for example "Five of a Kind"
function PB_UTIL.get_random_visible_hand(seed)
  local hands = {}
  for k, _ in pairs(SMODS.PokerHands) do
    if SMODS.is_poker_hand_visible(k) then hands[#hands + 1] = k end
  end
  return pseudorandom_element(hands, pseudoseed(seed)) or 'High Card'
end

--- Gets the next suit in the Da Capo cycle Spades -> Hearts -> Clubs -> Diamonds -> None -> Spades
---@param current_suit string current suit in the Da Capo cycle
---@return string hand the next suit
function PB_UTIL.da_capo_cycle(current_suit)
  local suits = { 'Clubs', 'Spades', 'Diamonds', 'Hearts', 'None' }
  if current_suit == 'None' then
    return 'Clubs'
  end
  for k, v in ipairs(suits) do
    if current_suit == v then
      return suits[k + 1]
    end
  end
  -- In case current_suit ever gets modified externally to a value unaccounted for, set it to Clubs
  return 'Clubs'
end

--- Counts consumables of a given set used in the current run
---@param set string
---@param count_repeats? boolean if only unique cards should be counted
---@return integer
function PB_UTIL.count_used_consumables(set, count_repeats)
  local count = 0
  local repeats = count_repeats and true
  for _, v in pairs(G.GAME.consumeable_usage) do
    if v.set == set then
      if count_repeats then
        count = count + v.count
      else
        count = count + 1
      end
    end
  end
  return count
end

--- Creates an array of all the highlighted cards in the given area sorted by their X position
---@param area CardArea|table
---@return (Card|table)[] cards the sorted array
function PB_UTIL.get_sorted_by_position(area)
  local cards = {}

  for i = 1, #area.highlighted do
    cards[i] = area.highlighted[i]
  end

  table.sort(cards, function(a, b)
    return a.T.x < b.T.x
  end)

  return cards
end

--- For It's TV Time. Returns True if the Joker is in the card area, the drawn card has the Bonus Enhancement, and the Suit being asked is Stars
function PB_UTIL.tenna_check(card, suit)
  if not next(SMODS.find_card('j_paperback_its_tv_time')) then
    return false
  end
  if SMODS.has_enhancement(card, 'm_bonus') and (suit == "paperback_Stars") then
    return true
  end
  return false
end

--- Wrapper function around SMODS.pseudorandom_probability
---@param obj Card|table
---@param seed string|number
---@param base_numerator number|nil -- If skipped, defaults to 1
---@param base_denominator number|nil -- If skipped, tries to access `obj.ability.extra.odds`
---@param key string|nil -- If skipped, sets to `"paperback_" .. seed`
---@return boolean
function PB_UTIL.chance(obj, seed, base_numerator, base_denominator, key)
  return SMODS.pseudorandom_probability(
    obj,
    seed,
    base_numerator or 1,
    base_denominator or (obj.ability and obj.ability.extra and obj.ability.extra.odds),
    key or ('paperback_' .. seed)
  )
end

--- Wrapper function around SMODS.get_probability_vars
---@param obj Card|table
---@param key string|nil -- If skipped, tries to set it to `obj.config.center_key`
---@param base_numerator number|nil -- If skipped, defaults to 1
---@param base_denominator number|nil -- If skipped, tries to access `obj.ability.extra.odds`
---@return number numerator
---@return number denominator
function PB_UTIL.chance_vars(obj, key, base_numerator, base_denominator)
  return SMODS.get_probability_vars(
    obj,
    base_numerator or 1,
    base_denominator or (obj.ability and obj.ability.extra and obj.ability.extra.odds),
    key or (obj.config and obj.config.center_key),
    false
  )
end

--- Whether a given value is of the Card type
---@param c any
---@return boolean
function PB_UTIL.is_card(c)
  return c and type(c) == "table" and c.is and type(c.is) == "function" and c:is(Card)
end
