[Revnpcsys] Revisioned Npc System v1.1 (#4724)

- npc now correctly clears all npc id data when he is removed
- farewell and greet messages can be individually set per talk state if not they fall back to default
- fixed a bug if the npc disappeared while the player was talking to him, then the npc would not respond to the player again once he was spawned
- better warning/error messages which show which npc it occured and which file it originates from
- added shop callback function callback(npc, player, handler, items, afterDiscount) order:
- discount (if there is any) -> callback
- added NpcsHandler:player() this is basicly the equivalent to requirements but instead of requireing you can add/set stuff to the player (modules.lua)
- implemented modules they're load after callbacks order:
    requirements (if returns true) -> callback (if returns true) -> modules
- moved teleport/addItems/setStorageValue to modules
- added new requirements
- changed the requirements functions
- I've included the error message directly inside the functions
- removed :failureRespond & :getFailureRespond as they're redundant with requirement re work
- changed modules outfit function it requires to insert 2 different outfits now because of 2 different player sexes
    ex: :outfit(id1, id2, addon)
- a few linter/annotation fixes
- if the player changed the talk state but still had the shop open and then tried to purchase something it thrown errors, this is now fixed

Author: EvilHero90

data/cpplinter.lua

@@ -322,7 +322,7 @@ Podium = {}
 ---@field setSkull fun(self: Creature, skullType: number)
 ---@field getOutfit fun(self: Creature): Outfit
 ---@field setOutfit fun(self: Creature, outfit: Outfit)
----@field getCondition fun(self: Creature, conditionType: number): Condition
+---@field getCondition fun(self: Creature, conditionType: number, conditionId?: number, subId?: number): Condition
 ---@field addCondition fun(self: Creature, condition: Condition)
 ---@field removeCondition fun(self: Creature, conditionType: number)
 ---@field hasCondition fun(self: Creature, conditionType: number): boolean
@@ -400,7 +400,7 @@ Creature = {}
 ---@field setVocation fun(self: Player, vocationId: number)
 ---@field getSex fun(self: Player): number
 ---@field setSex fun(self: Player, sexId: number)
----@field getTown fun(self: Player): number
+---@field getTown fun(self: Player): Town
 ---@field setTown fun(self: Player, townId: number)
 ---@field getGuild fun(self: Player): Guild
 ---@field setGuild fun(self: Player, guild: Guild)
@@ -449,10 +449,10 @@ Creature = {}
 ---@field hasBlessing fun(self: Player, blessingId: number): boolean
 ---@field addBlessing fun(self: Player, blessingId: number)
 ---@field removeBlessing fun(self: Player, blessingId: number)
----@field canLearnSpell fun(self: Player, spellId: number): boolean
----@field learnSpell fun(self: Player, spellId: number)
----@field forgetSpell fun(self: Player, spellId: number)
----@field hasLearnedSpell fun(self: Player, spellId: number): boolean
+---@field canLearnSpell fun(self: Player, name: string): boolean
+---@field learnSpell fun(self: Player, name: string)
+---@field forgetSpell fun(self: Player, name: string)
+---@field hasLearnedSpell fun(self: Player, name: string): boolean
 ---@field sendTutorial fun(self: Player, tutorialId: number)
 ---@field addMapMark fun(self: Player, position: Position, type: number, description?: string)
 ---@field save fun(self: Player)
@@ -580,6 +580,13 @@ Npc = {}
 ---@field onPlayerCloseChannel fun(self: NpcType, callback: function): boolean
 ---@field onPlayerEndTrade fun(self: NpcType, callback: function): boolean
 ---@field onThink fun(self: NpcType, callback: function): boolean
+---@field onSayCallback fun(self: NpcType, callback: function): boolean
+---@field onDisappearCallback fun(self: NpcType, callback: function): boolean
+---@field onAppearCallback fun(self: NpcType, callback: function): boolean
+---@field onMoveCallback fun(self: NpcType, callback: function): boolean
+---@field onPlayerCloseChannelCallback fun(self: NpcType, callback: function): boolean
+---@field onPlayerEndTradeCallback fun(self: NpcType, callback: function): boolean
+---@field onThinkCallback fun(self: NpcType, callback: function): boolean
 NpcType = {}
 
 ---@class Guild
@@ -1314,7 +1321,7 @@ function getDistanceTo(creature) end
 function doNpcSetCreatureFocus(creature) end
 function getNpcParameter(key) end
 function openShopWindow(shopWindow) end
-function closeShopWindow() end
+function closeShopWindow(player) end
 function doSellItem(item) end
 
 storages = {}

data/lib/compat/compat.lua

@@ -1674,6 +1674,28 @@ function table.maxn(t)
 	return max
 end
 
+function dump(t, indent, done)
+    done = done or {}
+    indent = indent or 0
+
+    done[t] = true
+
+    for key, value in pairs(t) do
+        print(string.rep("\t", indent))
+
+        if type(value) == "table" and not done[value] then
+            done[value] = true
+            print(key, ":\n")
+
+            dump(value, indent + 2, done)
+            done[value] = nil
+        else
+            print(key, "\t=\t", value, "\n")
+        end
+    end
+end
+
+
 ItemType.getDuration = ItemType.getDurationMin
 
 function getFormattedWorldTime()

data/npc/lib/revnpcsys/events.lua

@@ -73,18 +73,24 @@ if not NpcEvents then
     ---@param npc Npc The NPC that disappeared.
     ---@param creature Creature The creature (player) that the NPC disappeared from.
     function NpcEvents.onDisappear(npc, creature)
-        if not creature:isPlayer() then
-            return
-        end
         local focus = NpcFocus(npc)
-        if focus:isFocused(creature) then
-            focus:removeFocus(creature)
-            local talkQueue = NpcTalkQueue(npc)
+        local talkQueue = NpcTalkQueue(npc)
+        local voices = NpcVoices(npc)
+        -- If the creature is a player and is focused on the NPC, the focus is removed and the talk state is reset
+        if creature:isPlayer() and focus:isFocused(creature) then
             local handler = NpcsHandler(npc)
+            focus:removeFocus(creature)
             talkQueue:clearQueue(creature)
             handler:setTalkState(handler, creature)
             handler:resetData(creature)
         end
+
+        -- Npc is being removed we clear all the data which is specific to it's npc id he holds to not leak memory
+        if npc == creature then
+            focus:clear()
+            talkQueue:clear()
+            voices:clear()
+        end
     end
 
     -- onThink function is called when an NPC thinks.
@@ -166,12 +172,25 @@ if not NpcEvents then
                     focus:removeFocus(creature)
                     closeShopWindow(creature)
                     local msg = handler.farewellResponses[math.random(1, #handler.farewellResponses)]:replaceTags({playerName = creature:getName()})
+                    if handler:getTalkState(creature).farewellResponses then
+                        msg = handler:getTalkState(creature).farewellResponses[math.random(1, #handler:getTalkState(creature).farewellResponses)]:replaceTags({playerName = creature:getName()})
+                    end
                     talkQueue:addToQueue(creature, msg, TALK.defaultDelay)
                     handler:setTalkState(handler, creature)
                     handler:resetData(creature)
                     return
                 end
             end
+        -- incase the player is not focused but he has a talk state which was not resetted
+        -- this can only happen if player talked with the npc and the npc somehow disappeared
+        else
+            if not handler:getTalkState(creature):isKeyword(message) then
+                if handler ~= handler:getTalkState(creature) then
+                    handler:setTalkState(handler, creature)
+                    handler:getTalkState(creature):checkOnStorage(creature, handler)
+                    handler:resetData(creature)
+                end
+            end
         end
 
         -- Checks if the NPC has a response for the given message
@@ -189,7 +208,10 @@ if not NpcEvents then
                     if message == word then
                         focus:addFocus(creature)
                         doNpcSetCreatureFocus(creature:getId())
-                        local msg = handler:getTalkState(creature).greetResponses[math.random(1, #handler:getTalkState(creature).greetResponses)]:replaceTags({playerName = creature:getName()})
+                        local msg = handler.greetResponses[math.random(1, #handler.greetResponses)]:replaceTags({playerName = creature:getName()})
+                        if handler:getTalkState(creature).greetResponses then
+                            msg = handler:getTalkState(creature).greetResponses[math.random(1, #handler:getTalkState(creature).greetResponses)]:replaceTags({playerName = creature:getName()})
+                        end
                         talkQueue:addToQueue(creature, msg, TALK.defaultDelay)
                         greeted = true
                         break
@@ -199,6 +221,8 @@ if not NpcEvents then
                     return
                 end
             end
+            -- incase shop is open and the player swaps the talk state, then we need to close the shop
+            closeShopWindow(creature)
             -- renewing the focus for the player
             focus:addFocus(creature)
 
@@ -209,29 +233,16 @@ if not NpcEvents then
                 handler:getTalkState(creature):checkOnStorage(creature, handler)
             end
             -- checking for requirements
-            local ret, msg, reqType = handler:getTalkState(creature):requirements():init(creature)
+            local ret, msg = handler:getTalkState(creature):requirements():init(creature)
             if not ret then
-                if handler:getTalkState(creature):requirements():getFailureRespond(reqType) then
-                    msg = handler:getTalkState(creature):requirements():getFailureRespond(reqType):replaceTags({playerName = creature:getName()})
+                if msg then
+                    talkQueue:addToQueue(creature, msg, TALK.defaultDelay)
                 end
-                talkQueue:addToQueue(creature, msg, TALK.defaultDelay)
                 local _, start = next(handler.keywords)
                 handler:setTalkState(start, creature)
                 handler:getTalkState(creature):checkOnStorage(creature, handler)
                 return
             end
-            -- check if we want to release focus for this keyword
-            if handler:getTalkState(creature).releaseFocus then
-                if handler:getTalkState(creature):getResponse() then
-                    local msg = handler:getTalkState(creature):getResponse():replaceTags({playerName = creature:getName()})
-                    talkQueue:addToQueue(creature, msg, TALK.defaultDelay)
-                end
-                focus:removeFocus(creature)
-                closeShopWindow(creature)
-                handler:setTalkState(handler, creature)
-                handler:resetData(creature)
-                return
-            end
             -- check if we have a callback for this talk state
             local messageSent = false
             if handler:getTalkState(creature).callback then
@@ -246,7 +257,8 @@ if not NpcEvents then
                     handler:setTalkState(start, creature)
                     handler:getTalkState(creature):checkOnStorage(creature, handler)
                     if msg == "" then
-                        print("[Warning - NpcEvents.onSay] There is no failureResponse set for keyword: ".. message ..".\n".. debug.getinfo(2).source:match("@?(.*)"))
+                        print("[Warning - NpcEvents.onSay] Npc: ".. npc:getName() .." There is no failureResponse set for keyword: ".. message)
+                        print(debug.getinfo(handler:getTalkState(creature).callback).source:match("@?(.*)"))
                     end
                     return
                 end
@@ -256,18 +268,11 @@ if not NpcEvents then
                 end
             end
             -- checking for modules
-            -- todo implement modules
-            if handler:getTalkState(creature).teleportPosition then
-                focus:removeFocus(creature)
-                closeShopWindow(creature)
-                local msg = handler:getTalkState(creature):getResponse():replaceTags({playerName = creature:getName()})
-                selfSay(msg, creature)
-                Position(creature:getPosition()):sendMagicEffect(handler:getTalkState(creature).teleportPosition.magicEffectFromPos)
-                creature:teleportTo(handler:getTalkState(creature).teleportPosition.position)
-                Position(creature:getPosition()):sendMagicEffect(handler:getTalkState(creature).teleportPosition.magicEffectToPos)
-                handler:setTalkState(handler, creature)
-                handler:resetData(creature)
-                return
+            if handler:getTalkState(creature).modules then
+                if handler:getTalkState(creature).modules:init(npc, creature) == false then
+                    -- need to do that because of teleport
+                    return
+                end
             end
             -- If the NPC has a shop for the message, it opens the shop window
             if handler:getTalkState(creature):getShop(message) then
@@ -284,53 +289,24 @@ if not NpcEvents then
                             subtype = item.subtype == nil and nil or item.subtype
                         })
                     end
-                    npc:openShopWindow(creature, afterDiscount, shop.onBuy, shop.onSell)
-                else
-                    npc:openShopWindow(creature, items, shop.onBuy, shop.onSell)
-                end
-            end
-            -- If the Player gets a storage value set
-            if handler:getTalkState(creature).setStorage then
-                local storage = handler:getTalkState(creature).setStorage
-                creature:setStorageValue(storage.key, storage.value)
-            end
-            -- If the Player gets items added (goes into the backpack by default but if there is no space/capacity it goes into inbox)
-            if handler:getTalkState(creature).items then
-                local weight = 0
-                for _, item in pairs(handler:getTalkState(creature).items.items) do
-                    -- checking how much all items would weight
-                    weight = weight + ItemType(item.item):getWeight(item.count)
-                end
-                local backpack = creature:getSlotItem(CONST_SLOT_BACKPACK) and Container(creature:getSlotItem(CONST_SLOT_BACKPACK).uid) or nil
-                -- checking if the player has enough capacity or has a backpack
-                if creature:getFreeCapacity() < weight or not backpack then
-                    local containerId = handler:getTalkState(creature).items.container or ITEM_SHOPPING_BAG
-                    creature:sendInboxItems(handler:getTalkState(creature).items.items, containerId)
-                    local msg = "The items are to heavy for you to carry. I've sent them to your inbox."
-                    creature:sendTextMessage(MESSAGE_STATUS_CONSOLE_BLUE, msg)
-                -- checking if the player has enough space in the backpack
-                elseif backpack and backpack:getEmptySlots(true) < #handler:getTalkState(creature).items.items then
-                    local containerId = handler:getTalkState(creature).items.container or ITEM_SHOPPING_BAG
-                    creature:sendInboxItems(handler:getTalkState(creature).items.items, containerId)
-                    local msg = "You don't have enough space in your backpack. I've sent the items to your inbox."
-                    creature:sendTextMessage(MESSAGE_STATUS_CONSOLE_BLUE, msg)
-                -- checking if we should add the items by default into inbox
-                elseif handler:getTalkState(creature).items.inbox then
-                    local containerId = handler:getTalkState(creature).items.container or ITEM_SHOPPING_BAG
-                    creature:sendInboxItems(handler:getTalkState(creature).items.items, containerId)
-                    local msg = "Your items are waiting for you in your inbox."
-                    creature:sendTextMessage(MESSAGE_STATUS_CONSOLE_BLUE, msg)
+                    if shop.callback then
+                        afterDiscount = shop:callback(npc, creature, handler, items, afterDiscount)
+                    end
+                    if type(afterDiscount) == "table" then
+                        npc:openShopWindow(creature, afterDiscount, shop.onBuy, shop.onSell)
+                    else
+                        print("[Warning - NpcEvents.onSay] Callback for Npc: ".. npc:getName() .." with shop: ".. handler:getActiveShop(creature) .." did not return a table.")
+                        print(debug.getinfo(shop.callback).source:match("@?(.*)"))
+                    end
                 else
-                    if handler:getTalkState(creature).items.container then
-                        local container = Game.createItem(handler:getTalkState(creature).items.container, 1)
-                        for _, item in pairs(handler:getTalkState(creature).items.items) do
-                            container:addItem(item.item, item.count)
-                        end
-                        container:moveTo(creature)
+                    if shop.callback then
+                        items = shop:callback(npc, creature, handler, items)
+                    end
+                    if type(items) == "table" then
+                        npc:openShopWindow(creature, items, shop.onBuy, shop.onSell)
                     else
-                        for _, item in pairs(handler:getTalkState(creature).items.items) do
-                            creature:addItem(item.item, item.count)
-                        end
+                        print("[Warning - NpcEvents.onSay] Callback for Npc: ".. npc:getName() .." with shop: ".. handler:getActiveShop(creature) .." did not return a table.")
+                        print(debug.getinfo(shop.callback).source:match("@?(.*)"))
                     end
                 end
             end
@@ -341,6 +317,18 @@ if not NpcEvents then
                     talkQueue:addToQueue(creature, msg, TALK.defaultDelay)
                 end
             end
+            -- check if we want to release focus for this keyword
+            if handler:getTalkState(creature).releaseFocus then
+                if handler:getTalkState(creature):getResponse() then
+                    local msg = handler:getTalkState(creature):getResponse():replaceTags({playerName = creature:getName()})
+                    talkQueue:addToQueue(creature, msg, TALK.defaultDelay)
+                end
+                focus:removeFocus(creature)
+                closeShopWindow(creature)
+                handler:setTalkState(handler, creature)
+                handler:resetData(creature)
+                return
+            end
             -- if the NPC has reached the last keyword, it resets the talk state
             if next(handler:getTalkState(creature).keywords) == nil and not handler:getTalkState(creature).answer then
                 local _, start = next(handler.keywords)
@@ -397,7 +385,8 @@ if not NpcEvents then
                         handler:setTalkState(start, creature)
                         handler:getTalkState(creature):checkOnStorage(creature, handler)
                         if msg == "" then
-                            print("[Warning - NpcEvents.onSay] There is no failureResponse set for keyword: ".. message ..".\n".. debug.getinfo(2).source:match("@?(.*)"))
+                            print("[Warning - NpcEvents.onSay] Npc: ".. npc:getName() .." has no failureResponse set for keyword: ".. message ..".")
+                            print(debug.getinfo(handler:getTalkState(creature).callback).source:match("@?(.*)"))
                         end
                         handler:resetData(creature)
                         return
@@ -407,7 +396,8 @@ if not NpcEvents then
                         messageSent = true
                     end
                 else
-                    print("[Warning - NpcEvents.onSay] Npc: ".. npc:getName() .." has no callback set for onAnswer\n".. debug.getinfo(2).source:match("@?(.*)"))
+                    print("[Error - NpcEvents.onSay] Npc: ".. npc:getName() .." has no callback set for onAnswer")
+                    print(debug.getinfo(handler:getTalkState(creature).callback).source:match("@?(.*)"))
                     local _, start = next(handler.keywords)
                     handler:setTalkState(start, creature)
                     handler:getTalkState(creature):checkOnStorage(creature, handler)

data/npc/lib/revnpcsys/focus.lua

@@ -8,6 +8,7 @@
         - The focus duration and distance are defined in the FOCUS table in constants.lua.
 
     Functions:
+        - NpcFocus:clear()
         - NpcFocus:addFocus(player)
         - NpcFocus:isFocused(player)
         - NpcFocus:removeFocus(player)
@@ -17,6 +18,7 @@
 ---@class NpcFocus
 ---@field focus table<number, number>
 ---@field currentFocus Player
+---@field clear fun()
 ---@field addFocus fun(player: Player)
 ---@field isFocused fun(player: Player): boolean
 ---@field removeFocus fun(player: Player)
@@ -42,6 +44,11 @@ if not NpcFocus then
         end
     })
 
+    -- Clears all NpcFocus data for an NPC.
+    function NpcFocus:clear()
+        self = nil
+    end
+
     -- Adds focus on a player for a certain duration.
     ---@param player Player The player to add focus on.
     function NpcFocus:addFocus(player)