perf/refactor: implement player batch updates

data-canary/npc/the_lootmonger.lua

@@ -0,0 +1,87 @@
+local internalNpcName = "The Lootmonger"
+local npcType = Game.createNpcType(internalNpcName)
+local npcConfig = {}
+
+npcConfig.name = internalNpcName
+npcConfig.description = internalNpcName
+
+npcConfig.health = 100
+npcConfig.maxHealth = npcConfig.health
+npcConfig.walkInterval = 2000
+npcConfig.walkRadius = 2
+
+npcConfig.outfit = {
+	lookType = 1575,
+	lookHead = 96,
+	lookBody = 101,
+	lookLegs = 120,
+	lookFeet = 120,
+	lookAddons = 2,
+}
+
+npcConfig.flags = {
+	floorchange = false,
+}
+
+local keywordHandler = KeywordHandler:new()
+local npcHandler = NpcHandler:new(keywordHandler)
+
+npcType.onThink = function(npc, interval)
+	npcHandler:onThink(npc, interval)
+end
+
+npcType.onAppear = function(npc, creature)
+	npcHandler:onAppear(npc, creature)
+end
+
+npcType.onDisappear = function(npc, creature)
+	npcHandler:onDisappear(npc, creature)
+end
+
+npcType.onMove = function(npc, creature, fromPosition, toPosition)
+	npcHandler:onMove(npc, creature, fromPosition, toPosition)
+end
+
+npcType.onSay = function(npc, creature, type, message)
+	npcHandler:onSay(npc, creature, type, message)
+end
+
+npcType.onCloseChannel = function(npc, creature)
+	npcHandler:onCloseChannel(npc, creature)
+end
+
+npcHandler:addModule(FocusModule:new(), npcConfig.name, true, true, true)
+
+npcConfig.shop = LootShopConfig
+
+local function creatureSayCallback(npc, player, type, message)
+	if not npcHandler:checkInteraction(npc, player) then
+		return false
+	end
+	local categoryTable = LootShopConfigTable[message:lower()]
+	if MsgContains(message, "shop options") then
+		npcHandler:say("I sell a selection of " .. GetFormattedShopCategoryNames(LootShopConfigTable), npc, player)
+	elseif categoryTable then
+		local remainingCategories = npc:getRemainingShopCategories(message:lower(), LootShopConfigTable)
+		npcHandler:say("Of course, just browse through my wares. You can also look at " .. remainingCategories .. ".", npc, player)
+		npc:openShopWindowTable(player, categoryTable)
+	end
+	return true
+end
+
+npcHandler:setCallback(CALLBACK_MESSAGE_DEFAULT, creatureSayCallback)
+npcHandler:setMessage(MESSAGE_GREET, "Ah, a customer! Be greeted, |PLAYERNAME|! I buy all kinds of loot, would you like a {trade}? I can also show you my {shop options}.")
+npcHandler:setMessage(MESSAGE_SENDTRADE, "Ah, a customer! Be greeted, |PLAYERNAME|! I buy all kinds of loot, would you look at " .. GetFormattedShopCategoryNames(LootShopConfigTable) .. ".")
+
+-- On buy npc shop message
+npcType.onBuyItem = function(npc, player, itemId, subType, amount, ignore, inBackpacks, totalCost)
+	npc:sellItem(player, itemId, amount, subType, 0, ignore, inBackpacks)
+end
+-- On sell npc shop message
+npcType.onSellItem = function(npc, player, itemId, subtype, amount, ignore, name, totalCost)
+	player:sendTextMessage(MESSAGE_TRADE, string.format("Sold %ix %s for %i gold.", amount, name, totalCost))
+end
+-- On check npc shop message (look item)
+npcType.onCheckItem = function(npc, player, clientId, subType) end
+
+npcType:register(npcConfig)

data/scripts/eventcallbacks/README.md

@@ -144,7 +144,7 @@ Some event callbacks are expected to return a enum value, in this case, the enum
 Here is an example of a ReturnValue event callback:
 
 ```lua
-local callback = EventCallback()
+local callback = EventCallback("CreatureOnAreaCombat")
 
 function callback.creatureOnAreaCombat(creature, tile, isAggressive)
 	-- if the creature is not aggressive, stop the execution of the C++ function

data/scripts/talkactions/god/add_item_to_rewardchest.lua

@@ -0,0 +1,56 @@
+local addReward = TalkAction("/addreward")
+
+function addReward.onSay(player, words, param)
+	local args = param:split(",")
+	local itemInput = (args[1] or ""):trim()
+	local amount = tonumber(args[2]) or 1
+	local targetName = args[3] and args[3]:trim() or player:getName()
+
+	if itemInput == "" then
+		player:sendCancelMessage("Usage: /addreward item_name_or_id, amount[, target_player]")
+		return false
+	end
+
+	-- resolve target
+	local target = Player(targetName)
+	if not target then
+		player:sendCancelMessage("Target player not found.")
+		return false
+	end
+
+	-- resolve item
+	local it = ItemType(itemInput)
+	if it:getId() == 0 then
+		it = ItemType(tonumber(itemInput) or -1)
+	end
+	if it:getId() == 0 then
+		player:sendCancelMessage("Invalid item name or ID.")
+		return false
+	end
+
+	if amount < 1 then
+		player:sendCancelMessage("Invalid amount.")
+		return false
+	end
+
+	-- create/get the reward chest with a unique timestamp
+	local timestamp = systemTime()
+	local rewardBag = target:getReward(timestamp, true)
+
+	-- **this** will split your `amount` across as many
+	-- containers as necessary and return the total added
+	local added = target:addItemBatchToPaginedContainer(rewardBag, it:getId(), amount)
+	if added > 0 then
+		player:sendTextMessage(MESSAGE_EVENT_ADVANCE, string.format("Added %d x %s to %s's reward chest(s).", added, it:getName(), target:getName()))
+		target:sendTextMessage(MESSAGE_EVENT_ADVANCE, string.format("You received %d x %s in your reward chest(s).", added, it:getName()))
+		target:getPosition():sendMagicEffect(CONST_ME_MAGIC_GREEN)
+	else
+		player:sendCancelMessage("Could not add item to reward chest.")
+	end
+
+	return false
+end
+
+addReward:separator(" ")
+addReward:groupType("god")
+addReward:register()