Fix issues identified from TQuest definition

Fix Quest definitions to properly represent heirarchy f Add additional definition types, fixes Make onTrigger function def return optional
LandSandBoat · Sep 2, 2024 · 788188a · 788188a
1 parent 8ee48ac
commit 788188a
Show file tree

Hide file tree

Showing 19 changed files with 122 additions and 89 deletions.
diff --git a/scripts/quests/ahtUrhgan/Olduum.lua b/scripts/quests/ahtUrhgan/Olduum.lua
@@ -20,8 +20,8 @@ local keyItems =
     xi.ki.ELECTROLOCOMOTIVE,
 }
 
-quest.hasKeyItem = function(player)
-    for i, v in pairs(keyItems) do
+local hasQuestKeyItem = function(player)
+    for _, v in pairs(keyItems) do
         if player:hasKeyItem(v) then
             return true
         end
@@ -68,7 +68,7 @@ quest.sections =
             ['Dkhaaya'] =
             {
                 onTrigger = function(player, npc)
-                    if quest.hasKeyItem(player) then
+                    if hasQuestKeyItem(player) then
                         return quest:progressEvent(6)
                     else
                         return quest:event(5)
@@ -94,7 +94,7 @@ quest.sections =
                 onTrade = function(player, npc, trade)
                     if
                         not player:hasItem(xi.item.OLDUUM_RING) and
-                        not quest.hasKeyItem(player) and
+                        not hasQuestKeyItem(player) and
                         npcUtil.tradeHasExactly(trade, xi.item.PICKAXE)
                     then
                         if math.random(1, 10) > 5 then
@@ -135,7 +135,7 @@ quest.sections =
             ['Dkhaaya'] =
             {
                 onTrigger = function(player, npc)
-                    if quest.hasKeyItem(player) then
+                    if hasQuestKeyItem(player) then
                         return quest:progressEvent(8)
                     elseif
                         player:hasItem(xi.item.OLDUUM_RING) or
@@ -202,7 +202,7 @@ quest.sections =
                 onTrade = function(player, npc, trade)
                     if
                         not player:hasItem(xi.item.OLDUUM_RING) and
-                        not quest.hasKeyItem(player) and
+                        not hasQuestKeyItem(player) and
                         npcUtil.tradeHasExactly(trade, xi.item.PICKAXE)
                     then
                         if math.random(1, 10) > 5 then

diff --git a/scripts/quests/ahtUrhgan/Three_Men_and_a_Closet.lua b/scripts/quests/ahtUrhgan/Three_Men_and_a_Closet.lua
@@ -19,15 +19,16 @@ quest.sections =
     -- Section: Begin quest
     {
         check = function(player, status, vars)
-            return status == xi.questStatus.QUEST_AVAILABLE and player:getQuestStatus(xi.questLog.AHT_URHGAN, xi.quest.id.ahtUrhgan.GOT_IT_ALL) == xi.questStatus.QUEST_COMPLETED
+            return status == xi.questStatus.QUEST_AVAILABLE and
+                player:getQuestStatus(xi.questLog.AHT_URHGAN, xi.quest.id.ahtUrhgan.GOT_IT_ALL) == xi.questStatus.QUEST_COMPLETED
         end,
 
         [xi.zone.AHT_URHGAN_WHITEGATE] =
         {
             ['Kubhe_Ijyuhla'] =
             {
                 onTrigger = function(player, npc)
-                    return quest:progressEvent(player, 836)
+                    return quest:progressEvent(836)
                 end
             },
 

diff --git a/scripts/quests/bastok/A_Question_of_Faith.lua b/scripts/quests/bastok/A_Question_of_Faith.lua
@@ -113,7 +113,7 @@ quest.sections =
             {
                 [6] = function(player, csid, option, npc)
                     player:delKeyItem(xi.ki.DAWN_TALISMAN)
-                    return quest:messageSpecial(ID.text.WAS_TAKEN_FROM_YOU, 0, xi.ki.DAWN_TALISMAN)
+                    player:messageSpecial(ID.text.WAS_TAKEN_FROM_YOU, 0, xi.ki.DAWN_TALISMAN)
                 end,
             },
         },

diff --git a/scripts/quests/bastok/Lure_of_the_Wildcat_Bastok.lua b/scripts/quests/bastok/Lure_of_the_Wildcat_Bastok.lua
@@ -41,6 +41,9 @@ local wildcatNpcData =
     ['Vaghron']           = { 19, 503 }, -- !pos -39.162 -1 -92.147 234
 }
 
+---@param player CBaseEntity
+---@param npc CBaseEntity
+---@return QuestReturnType?
 local wildcatOnTrigger = function(player, npc)
     local npcData = wildcatNpcData[npc:getName()]
 

diff --git a/scripts/quests/bastok/Teak_Me_to_the_Stars.lua b/scripts/quests/bastok/Teak_Me_to_the_Stars.lua
@@ -25,14 +25,17 @@ quest.sections =
 
         [xi.zone.METALWORKS] =
         {
-            onTrigger = function(player, npc)
-                local option = 0
-                if player:hasCompletedMission(xi.mission.id.cop.THE_CALL_OF_THE_WYRMKING) then
-                    option = 2 -- additional dialogue regarding Crystal propulsion unit and hooded scientists as mentioned in cop wyrmking mission
-                end
+            ['Raibaht'] =
+            {
+                onTrigger = function(player, npc)
+                    local option = 0
+                    if player:hasCompletedMission(xi.mission.log_id.COP, xi.mission.id.cop.THE_CALL_OF_THE_WYRMKING) then
+                        option = 2 -- additional dialogue regarding Crystal propulsion unit and hooded scientists as mentioned in cop wyrmking mission
+                    end
 
-                return quest:progressEvent(864, 0, xi.item.GARHADA_TEAK_LUMBER, 0, 0, 0, 0, option)
-            end,
+                    return quest:progressEvent(864, 0, xi.item.GARHADA_TEAK_LUMBER, 0, 0, 0, 0, option)
+                end,
+            },
 
             onEventFinish =
             {

diff --git a/scripts/quests/crystalWar/The_Price_of_Valor.lua b/scripts/quests/crystalWar/The_Price_of_Valor.lua
@@ -160,6 +160,10 @@ quest.sections =
                     elseif questProgress == 5 then
                         if quest:getLocalVar(player, 'nmDefeated') == 0 then
                             local zoneObj = player:getZone()
+                            if not zoneObj then
+                                return
+                            end
+
                             local mobObj  = zoneObj:queryEntitiesByName('Madthrasher_Zradbodd')[1]
 
                             if not mobObj:isSpawned() then

diff --git a/scripts/quests/jeuno/Chocobos_Wounds.lua b/scripts/quests/jeuno/Chocobos_Wounds.lua
@@ -163,7 +163,9 @@ quest.sections =
                     quest:setVar(player, 'Timer', os.time() + 45)
                     quest:setVar(player, 'Prog', 4)
 
-                    return quest:event(99)
+                    -- TODO: This needs retail verification to confirm no zoning
+                    -- event has occurred
+                    player:startEvent(99)
                 end,
 
                 [60] = function(player, csid, option, npc)

diff --git a/scripts/quests/otherAreas/A_Hard_Days_Knight.lua b/scripts/quests/otherAreas/A_Hard_Days_Knight.lua
@@ -135,14 +135,16 @@ quest.sections =
             {
                 [631] = function(player, csid, option, npc)
                     if quest:getVar(player, 'Prog') == 2 then
-                        return quest:progressEvent(632)
+                        -- TODO: This is most likely not retail accurate, and need to check captures
+                        -- for forced zoning events.
+                        player:startEvent(632)
                     end
                 end,
 
                 [632] = function(player, csid, option, npc)
                     player:confirmTrade()
                     quest:setVar(player, 'Prog', 0)
-                    return quest:keyItem(xi.ki.TEMPLE_KNIGHT_KEY)
+                    npcUtil.giveKeyItem(player, xi.ki.TEMPLE_KNIGHT_KEY)
                 end
             },
         },

diff --git a/scripts/quests/otherAreas/Give_a_Moogle_a_Break.lua b/scripts/quests/otherAreas/Give_a_Moogle_a_Break.lua
@@ -16,19 +16,22 @@ quest.reward =
 -- Since there are so many zones with interactions:
 quest.sections = {}
 
-quest.sections[1] = {}
-quest.sections[1].check = function(player, status, vars)
-    local bedPlacedTime = quest:getVar(player, 'bedPlacedTime')
-
-    return status == xi.questStatus.QUEST_AVAILABLE and
-        xi.moghouse.isInMogHouseInHomeNation(player) and
-        player:getFameLevel(player:getNation()) >= 3 and
-        not quest:getMustZone(player) and
-        quest:getLocalVar(player, 'questSeen') == 0 and
-        bedPlacedTime ~= 0 and
-        os.time() > bedPlacedTime + 60
-end
+quest.sections[1] =
+{
+    check = function(player, status, vars)
+        local bedPlacedTime = quest:getVar(player, 'bedPlacedTime')
+
+        return status == xi.questStatus.QUEST_AVAILABLE and
+            xi.moghouse.isInMogHouseInHomeNation(player) and
+            player:getFameLevel(player:getNation()) >= 3 and
+            not quest:getMustZone(player) and
+            quest:getLocalVar(player, 'questSeen') == 0 and
+            bedPlacedTime ~= 0 and
+            os.time() > bedPlacedTime + 60
+    end
+}
 
+---@type TQuestZoneSection
 local questAvailable =
 {
     ['Moogle'] =
@@ -50,11 +53,14 @@ local questAvailable =
     },
 }
 
-quest.sections[2] = {}
-quest.sections[2].check = function(player, status, vars)
-    return status == xi.questStatus.QUEST_ACCEPTED
-end
+quest.sections[2] =
+{
+    check = function(player, status, vars)
+        return status == xi.questStatus.QUEST_ACCEPTED
+    end
+}
 
+---@type TQuestZoneSection
 local questAccepted =
 {
     ['Moogle'] =

diff --git a/scripts/quests/otherAreas/Knocking_on_Forbidden_Doors.lua b/scripts/quests/otherAreas/Knocking_on_Forbidden_Doors.lua
@@ -47,7 +47,7 @@ quest.sections =
         {
             ['Chemioue'] =
             {
-                onTrigger = function(player, csid, option, npc)
+                onTrigger = function(player, npc)
                     if quest:getVar(player, 'Prog') == 0 then
                         return quest:progressEvent(536)
                     end
@@ -141,13 +141,13 @@ quest.sections =
                         quest:getVar(player, 'Prog') == 3 and
                         npcUtil.popFromQM(player, npc, misareauxID.mob.ALSHA, { claim = true, hide = 0 })
                     then
-                        return quest:messageSpecial(misareauxID.text.FOUL_STENCH)
+                        player:messageSpecial(misareauxID.text.FOUL_STENCH)
                     end
                 end,
 
                 [558] = function(player, csid, option, npc)
                     quest:setVar(player, 'Prog', 5)
-                    return quest:keyItem(xi.ki.BETTER_HUMES_AND_MANNEQUINS)
+                    npcUtil.giveKeyItem(player, xi.ki.BETTER_HUMES_AND_MANNEQUINS)
                 end,
             },
         },
@@ -156,7 +156,7 @@ quest.sections =
         {
             ['Fyi_Chalmwoh'] =
             {
-                onTrigger = function(player, csid, option, npc)
+                onTrigger = function(player, npc)
                     if quest:getVar(player, 'Prog') == 5 then
                         return quest:progressEvent(321, { [0] = 704,
                             [1] = xi.mannequin.getMannequins(player),
@@ -189,7 +189,7 @@ quest.sections =
         {
             ['Fyi_Chalmwoh'] =
             {
-                onTrigger = function(player, csid, option, npc)
+                onTrigger = function(player, npc)
                     return quest:progressEvent(321, { [1] = xi.mannequin.getMannequins(player),
                         [2] = xi.mannequin.cost.PURCHASE,
                         [3] = xi.mannequin.cost.TRADE,

diff --git a/scripts/quests/otherAreas/Moogles_in_the_Wild.lua b/scripts/quests/otherAreas/Moogles_in_the_Wild.lua
@@ -16,20 +16,23 @@ quest.reward =
 -- Since there are so many zones with interactions:
 quest.sections = {}
 
-quest.sections[1] = {}
-quest.sections[1].check = function(player, status, vars)
-    local bedPlacedTime = quest:getVar(player, 'bedPlacedTime')
-
-    return status == xi.questStatus.QUEST_AVAILABLE and
-        player:hasCompletedQuest(xi.questLog.OTHER_AREAS, xi.quest.id.otherAreas.THE_MOOGLE_PICNIC) and
-        xi.moghouse.isInMogHouseInHomeNation(player) and
-        player:getFameLevel(player:getNation()) >= 7 and
-        not quest:getMustZone(player) and
-        quest:getLocalVar(player, 'questSeen') == 0 and
-        bedPlacedTime ~= 0 and
-        os.time() > bedPlacedTime + 60
-end
+quest.sections[1] =
+{
+    check = function(player, status, vars)
+        local bedPlacedTime = quest:getVar(player, 'bedPlacedTime')
+
+        return status == xi.questStatus.QUEST_AVAILABLE and
+            player:hasCompletedQuest(xi.questLog.OTHER_AREAS, xi.quest.id.otherAreas.THE_MOOGLE_PICNIC) and
+            xi.moghouse.isInMogHouseInHomeNation(player) and
+            player:getFameLevel(player:getNation()) >= 7 and
+            not quest:getMustZone(player) and
+            quest:getLocalVar(player, 'questSeen') == 0 and
+            bedPlacedTime ~= 0 and
+            os.time() > bedPlacedTime + 60
+    end
+}
 
+---@type TQuestZoneSection
 local questAvailable =
 {
     ['Moogle'] =
@@ -51,11 +54,14 @@ local questAvailable =
     },
 }
 
-quest.sections[2] = {}
-quest.sections[2].check = function(player, status, vars)
-    return status == xi.questStatus.QUEST_ACCEPTED
-end
+quest.sections[2] =
+{
+    check = function(player, status, vars)
+        return status == xi.questStatus.QUEST_ACCEPTED
+    end
+}
 
+---@type TQuestZoneSection
 local questAccepted =
 {
     ['Moogle'] =

diff --git a/scripts/quests/otherAreas/RQ4_His_Name_is_Valgeir.lua b/scripts/quests/otherAreas/RQ4_His_Name_is_Valgeir.lua
@@ -72,7 +72,7 @@ quest.sections =
                     if
                         player:hasKeyItem(xi.ki.ARAGONEU_PIZZA) and -- No free ride after delivering Pizza.
                         player:getZPos() > 38.5 and -- Pos check.
-                        quest:setVar(player, 'Prog') == 0 -- Hasn't taken the free ride.
+                        quest:getVar(player, 'Prog') == 0 -- Hasn't taken the free ride.
                     then
                         return quest:progressEvent(230) -- Free ride. 1 time only. Non-Mandatory step.
                     end

diff --git a/scripts/quests/otherAreas/Test_My_Mettle.lua b/scripts/quests/otherAreas/Test_My_Mettle.lua
@@ -76,7 +76,7 @@ quest.sections =
                             quest:setVar(player, 'Reward', betAmount * rewardMultiplier[vanaHoursRemaining])
                             quest:begin(player)
                         else
-                            return quest:messageSpecial(selbinaID.text.DONT_HAVE_ENOUGH_GIL)
+                            player:messageSpecial(selbinaID.text.DONT_HAVE_ENOUGH_GIL)
                         end
                     end
                 end,

diff --git a/scripts/quests/otherAreas/The_Moogles_Picnic.lua b/scripts/quests/otherAreas/The_Moogles_Picnic.lua
@@ -16,20 +16,23 @@ quest.reward =
 -- Since there are so many zones with interactions:
 quest.sections = {}
 
-quest.sections[1] = {}
-quest.sections[1].check = function(player, status, vars)
-    local bedPlacedTime = quest:getVar(player, 'bedPlacedTime')
-
-    return status == xi.questStatus.QUEST_AVAILABLE and
-        player:hasCompletedQuest(xi.questLog.OTHER_AREAS, xi.quest.id.otherAreas.GIVE_A_MOOGLE_A_BREAK) and
-        xi.moghouse.isInMogHouseInHomeNation(player) and
-        player:getFameLevel(player:getNation()) >= 5 and
-        not quest:getMustZone(player) and
-        quest:getLocalVar(player, 'questSeen') == 0 and
-        bedPlacedTime ~= 0 and
-        os.time() > bedPlacedTime + 60
-end
+quest.sections[1] =
+{
+    check = function(player, status, vars)
+        local bedPlacedTime = quest:getVar(player, 'bedPlacedTime')
+
+        return status == xi.questStatus.QUEST_AVAILABLE and
+            player:hasCompletedQuest(xi.questLog.OTHER_AREAS, xi.quest.id.otherAreas.GIVE_A_MOOGLE_A_BREAK) and
+            xi.moghouse.isInMogHouseInHomeNation(player) and
+            player:getFameLevel(player:getNation()) >= 5 and
+            not quest:getMustZone(player) and
+            quest:getLocalVar(player, 'questSeen') == 0 and
+            bedPlacedTime ~= 0 and
+            os.time() > bedPlacedTime + 60
+    end
+}
 
+---@type TQuestZoneSection
 local questAvailable =
 {
     ['Moogle'] =
@@ -51,11 +54,14 @@ local questAvailable =
     },
 }
 
-quest.sections[2] = {}
-quest.sections[2].check = function(player, status, vars)
-    return status == xi.questStatus.QUEST_ACCEPTED
-end
+quest.sections[2] =
+{
+    check = function(player, status, vars)
+        return status == xi.questStatus.QUEST_ACCEPTED
+    end
+}
 
+---@type TQuestZoneSection
 local questAccepted =
 {
     ['Moogle'] =

diff --git a/scripts/quests/sandoria/The_Pickpocket.lua b/scripts/quests/sandoria/The_Pickpocket.lua
@@ -192,7 +192,7 @@ quest.sections =
         {
             ['Esca'] =
             {
-                onTrigger = function(player, npc, trade)
+                onTrigger = function(player, npc)
                     if player:hasItem(xi.item.GILT_GLASSES) then
                         return quest:event(123)
                     else

diff --git a/scripts/quests/windurst/Overnight_Delivery.lua b/scripts/quests/windurst/Overnight_Delivery.lua
@@ -185,7 +185,7 @@ quest.sections =
                 [346] = function(player, csid, option, npc)
                     player:delQuest(quest.areaId, quest.questId)
                     player:delKeyItem(xi.ki.SMALL_BAG)
-                    quest:setVar('dueDate', 0)
+                    quest:setVar(player, 'dueDate', 0)
                     quest:setVar(player, 'Prog', 256)
                 end,