From 67d6987a4062c01ae655a305699498148144d91b Mon Sep 17 00:00:00 2001
From: LoxleyXI <119976133+LoxleyXI@users.noreply.github.com>
Date: Sat, 18 Jan 2025 19:00:32 +0000
Subject: [PATCH] Lua: Allow npcUtil.giveItem to force alternative message for
 consistency

---
 scripts/globals/npc_util.lua | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/scripts/globals/npc_util.lua b/scripts/globals/npc_util.lua
index 1d35a58c3bd..cfca4e62b13 100644
--- a/scripts/globals/npc_util.lua
+++ b/scripts/globals/npc_util.lua
@@ -242,6 +242,9 @@ end
         "Try trading again after sorting your inventory"
         instead of
         "Come back again after sorting your inventory"
+    multiple (boolean default false)
+        if set, force message type as multiples version
+        eg. You obtain 1 chunk of rock salt!
 --]]
 
 ---@class itemQuantityEntry : { [xi.item]: xi.item, [integer]: integer }
@@ -251,7 +254,7 @@ end
 
 ---@param player CBaseEntity
 ---@param items xi.item|itemQuantityEntry|multipleItemList
----@param params { silent: boolean?, fromTrade: boolean? }?
+---@param params { silent: boolean?, fromTrade: boolean?, multiple: boolean? }?
 ---@return boolean
 function npcUtil.giveItem(player, items, params)
     params = params or {}
@@ -294,7 +297,10 @@ function npcUtil.giveItem(player, items, params)
     for _, v in pairs(givenItems) do
         if player:addItem(v[1], v[2], true) then
             if not params.silent and not messagedItems[v[1]] then
-                if v[2] > 1 then
+                if
+                    v[2] > 1 or
+                    params.multiple
+                then
                     player:messageSpecial(ID.text.ITEM_OBTAINED + 9, v[1], v[2])
                 else
                     player:messageSpecial(ID.text.ITEM_OBTAINED, v[1])
@@ -502,7 +508,7 @@ end
 
 ---@class rewardParam
 ---@field item xi.item|itemQuantityEntry|multipleItemList?
----@field itemParams { silent: boolean?, fromTrade: boolean? }?
+---@field itemParams { silent: boolean?, fromTrade: boolean?, multiple: boolean? }?
 ---@field keyItem xi.keyItem|{ [integer]: xi.keyItem }?
 ---@field ki xi.keyItem|{ [integer]: xi.keyItem }?
 ---@field fame integer?