refactor: change from "consumeables" to "consumables"

Author: S1M0N38

src/lua/api.lua

@@ -606,12 +606,12 @@ API.functions["rearrange_jokers"] = function(args)
   }
 end
 
----Rearranges the consumeables based on the given card indices
----Call G.FUNCS.rearrange_consumeables(new_consumeables)
----@param args RearrangeConsumeablesArgs The card indices to rearrange the consumeables with
-API.functions["rearrange_consumeables"] = function(args)
+---Rearranges the consumables based on the given card indices
+---Call G.FUNCS.rearrange_consumables(new_consumables)
+---@param args RearrangeConsumablesArgs The card indices to rearrange the consumables with
+API.functions["rearrange_consumables"] = function(args)
   -- Validate required parameters
-  local success, error_message, error_code, context = validate_request(args, { "consumeables" })
+  local success, error_message, error_code, context = validate_request(args, { "consumables" })
 
   if not success then
     ---@cast error_message string
@@ -620,34 +620,34 @@ API.functions["rearrange_consumeables"] = function(args)
     return
   end
 
-  -- Validate that consumeables exist
+  -- Validate that consumables exist
   if not G.consumeables or not G.consumeables.cards or #G.consumeables.cards == 0 then
     API.send_error_response(
-      "No consumeables available to rearrange",
+      "No consumables available to rearrange",
       ERROR_CODES.MISSING_GAME_OBJECT,
-      { consumeables_available = false }
+      { consumables_available = false }
     )
     return
   end
 
-  -- Validate number of consumeables is equal to the number of consumeables in the consumeables area
-  if #args.consumeables ~= #G.consumeables.cards then
+  -- Validate number of consumables is equal to the number of consumables in the consumables area
+  if #args.consumables ~= #G.consumeables.cards then
     API.send_error_response(
-      "Invalid number of consumeables to rearrange",
+      "Invalid number of consumables to rearrange",
       ERROR_CODES.PARAMETER_OUT_OF_RANGE,
-      { consumeables_count = #args.consumeables, valid_range = tostring(#G.consumeables.cards) }
+      { consumables_count = #args.consumables, valid_range = tostring(#G.consumeables.cards) }
     )
     return
   end
 
   -- Convert incoming indices from 0-based to 1-based
-  for i, joker_index in ipairs(args.consumeables) do
-    args.consumeables[i] = joker_index + 1
+  for i, consumable_index in ipairs(args.consumables) do
+    args.consumables[i] = consumable_index + 1
   end
 
-  -- Create a new consumeables array to swap card indices
+  -- Create a new consumables array to swap card indices
   local new_consumables = {}
-  for _, old_index in ipairs(args.consumeables) do
+  for _, old_index in ipairs(args.consumables) do
     local card = G.consumeables.cards[old_index]
     if not card then
       API.send_error_response(
@@ -662,7 +662,7 @@ API.functions["rearrange_consumeables"] = function(args)
 
   G.consumeables.cards = new_consumables
 
-  -- Update each consumeable's order field so future sort('order') calls work correctly
+  -- Update each consumable's order field so future sort('order') calls work correctly
   for i, card in ipairs(G.consumeables.cards) do
     if card.ability then
       card.ability.order = i
@@ -673,8 +673,8 @@ API.functions["rearrange_consumeables"] = function(args)
   end
 
   ---@type PendingRequest
-  API.pending_requests["rearrange_consumeables"] = {
-    condition = utils.COMPLETION_CONDITIONS["rearrange_consumeables"][""],
+  API.pending_requests["rearrange_consumables"] = {
+    condition = utils.COMPLETION_CONDITIONS["rearrange_consumables"][""],
     action = function()
       local game_state = utils.get_game_state()
       API.send_response(game_state)

src/lua/log.lua

@@ -260,7 +260,7 @@ function hook_hand_rearrange()
   local previous_orders = {
     hand = {},
     joker = {},
-    consumeables = {},
+    consumables = {},
   }
   -- local previous_hand_order = {}
   -- local previous_joker_order = {}
@@ -271,7 +271,7 @@ function hook_hand_rearrange()
       self.config
       ---@diagnostic disable-next-line: undefined-field
       and (self.config.type == "hand" or self.config.type == "joker")
-      -- consumeables are type "joker"
+      -- consumables are type "joker"
       ---@diagnostic disable-next-line: undefined-field
       and self.cards
       ---@diagnostic disable-next-line: undefined-field
@@ -343,8 +343,8 @@ function hook_hand_rearrange()
 
             if are_consumables and not are_jokers then
               function_call = {
-                name = "rearrange_consumeables",
-                arguments = { consumeables = cards },
+                name = "rearrange_consumables",
+                arguments = { consumables = cards },
               }
             elseif are_jokers and not are_consumables then
               function_call = {

src/lua/types.lua

@@ -55,8 +55,8 @@
 ---@class RearrangeJokersArgs
 ---@field jokers number[] Array of joker indices for every joker (0-based)
 
----@class RearrangeConsumeablesArgs
----@field consumeables number[] Array of consumeable indices for every consumeable (0-based)
+---@class RearrangeConsumablesArgs
+---@field consumables number[] Array of consumable indices for every consumable (0-based)
 
 ---@class ShopActionArgs
 ---@field action "next_round" | "buy_card" | "reroll" The action to perform
@@ -87,7 +87,7 @@
 ---@field game? GGame Game information (null if not in game)
 ---@field hand? GHand Hand information (null if not available)
 ---@field jokers GJokers Jokers area object (with sub-field `cards`)
----@field consumeables GConsumeables Consumables area object (typo intentional)
+---@field consumables GConsumables Consumables area object
 ---@field shop_jokers? GShopJokers Shop jokers area
 ---@field shop_vouchers? GShopVouchers Shop vouchers area
 ---@field shop_booster? GShopBooster Shop booster packs area
@@ -227,8 +227,7 @@
 ---@field config GCardAreaConfig Config for jokers card area
 ---@field cards GJokersCard[] Array of joker card objects
 
--- Keeping typo "consumeables" for compatibility
----@class GConsumeables
+---@class GConsumables
 ---@field config GCardAreaConfig Configuration for the consumables slot
 ---@field cards? GConsumablesCard[] Array of consumable card objects
 
@@ -246,13 +245,13 @@
 ---@class GJokersCardConfig
 ---@field center_key string Key identifier for the joker center
 
--- Consumable card (G.consumeables.cards[])
+-- Consumable card (G.consumables.cards[])
 ---@class GConsumablesCard
 ---@field label string Display label of the consumable
 ---@field cost number Purchase cost of the consumable
 ---@field config GConsumablesCardConfig Consumable configuration
 
--- Consumable card configuration (G.consumeables.cards[].config)
+-- Consumable card configuration (G.consumables.cards[].config)
 ---@class GConsumablesCardConfig
 ---@field center_key string Key identifier for the consumable center
 

src/lua/utils.lua

@@ -312,7 +312,7 @@ function utils.get_game_state()
     }
   end
 
-  local consumeables = nil
+  local consumables = nil
   if G.consumeables then
     local cards = {}
     if G.consumeables.cards then
@@ -330,7 +330,7 @@ function utils.get_game_state()
         }
       end
     end
-    consumeables = {
+    consumables = {
       cards = cards,
       config = {
         card_count = G.consumeables.config.card_count,
@@ -534,8 +534,7 @@ function utils.get_game_state()
     shop_jokers = shop_jokers, -- NOTE: This contains all cards in the shop, not only jokers.
     shop_vouchers = shop_vouchers,
     shop_booster = shop_booster,
-    consumeables = consumeables,
-    -- NOTE: yes it's consumeables, not consumables. Following the naming convention of the game.
+    consumables = consumables,
   }
 end
 
@@ -743,7 +742,7 @@ utils.COMPLETION_CONDITIONS = {
     end,
   },
 
-  rearrange_consumeables = {
+  rearrange_consumables = {
     [""] = function()
       return #G.E_MANAGER.queues.base < EVENT_QUEUE_THRESHOLD and G.STATE_COMPLETE
     end,