Merge branch 'hunt-system' into release

Author: ibm2431

documentation/Regime_IDs.csv

@@ -975,8 +975,8 @@ local function getFinishOpts(regimeType)
     end
     return out
 end
-
-local function clearPlayerVars(player)
+-- function made global to be called by hunts.lua
+tpz.regime.clearRegimeVars = function(player)
     player:setCharVar("[regime]type", 0)
     player:setCharVar("[regime]zone", 0)
     player:setCharVar("[regime]id", 0)
@@ -990,7 +990,11 @@ local function clearPlayerVars(player)
 end
 
 tpz.regime.bookOnTrigger = function(player, regimeType)
-    if (regimeType == tpz.regime.type.FIELDS and ENABLE_FIELD_MANUALS == 1) or (regimeType == tpz.regime.type.GROUNDS and ENABLE_GROUNDS_TOMES == 1) then
+     -- checks if hunt is active, if so prompts player to cancel
+  if player:getCharVar("[hunt]status") >= 1 then
+     player:startEvent(info.event,0,0,3,1,0,0,player:getCurrency("valor_point"),player:getCharVar("[hunt]page"))
+
+  elseif (regimeType == tpz.regime.type.FIELDS and ENABLE_FIELD_MANUALS == 1) or (regimeType == tpz.regime.type.GROUNDS and ENABLE_GROUNDS_TOMES == 1) then
         local info = regimeInfo[regimeType].zone[player:getZoneID()]
 
         -- arg2 is a bitmask that controls which pages appear for examination
@@ -1061,6 +1065,10 @@ tpz.regime.bookOnEventFinish = function(player, option, regimeType)
         return
     end
 
+    if option == 7 then
+      tpz.hunts.clearHuntVars(player)
+    end
+
     -- check player has enough tabs
     if opt.cost and opt.cost > tabs then
         player:showText(player, msgOffset + 1032) -- You do not have enough tabs.
@@ -1079,7 +1087,7 @@ tpz.regime.bookOnEventFinish = function(player, option, regimeType)
         player:delCurrency("valor_point", opt.cost)
 
         if act == "CANCEL_REGIME" then
-            clearPlayerVars(player)
+            tpz.regime.clearRegimeVars(player)
             player:showText(player, msgOffset + 2) -- Training regime canceled.
 
         elseif act == "REPATRIATION" then
@@ -1355,6 +1363,6 @@ tpz.regime.checkRegime = function(player, mob, regimeId, index, regimeType)
 
         player:messageBasic(tpz.msg.basic.FOV_REGIME_BEGINS_ANEW)
     else
-        clearPlayerVars(player)
+        tpz.regime.clearRegimeVars(player)
     end
 end

documentation/Regime_IDs.txt

@@ -21,6 +21,12 @@ zones[tpz.zone.AHT_URHGAN_WHITEGATE] =
         HOMEPOINT_SET                 = 1366, -- Home point set!
         IMAGE_SUPPORT_ACTIVE          = 1405, -- You have to wait a bit longer before asking for synthesis image support again.
         IMAGE_SUPPORT                 = 1407, -- Your [fishing/woodworking/smithing/goldsmithing/clothcraft/leatherworking/bonecraft/alchemy/cooking] skills went up [a little/ever so slightly/ever so slightly].
+        REGIME_CANCELED               = 1466, -- Current training regime canceled.
+        HUNT_ACCEPTED                 = 1484, -- Hunt accepted!
+        USE_SCYLDS                    = 1485, -- You use <fee> scylds. Scyld balance: <scylds>.
+        HUNT_RECORDED                 = 1496, -- You record your hunt.
+        OBTAIN_SCYLDS                 = 1498, -- You obtain <scylds>! Current Balance: <scylds>.
+        HUNT_CANCELED                 = 1502, -- Hunt canceled.
         ITEM_OBTAINEDX                = 1497, -- You obtain <item>!
         RUNIC_PORTAL                  = 4584, -- You cannot use the runic portal without the Empire's authorization.
         UGRIHD_PURCHASE_DIALOGUE      = 4645, -- Salaheem's Sentinels values your contribution to the success of the company. Please come again!

scripts/globals/hunts.lua

@@ -0,0 +1,16 @@
+require("scripts/globals/hunts")
+
+function onTrade(player, npc, trade)
+end
+
+function onTrigger(player,npc,event)
+  tpz.hunts.onTrigger(player,npc,event)
+end
+
+function onEventUpdate(player,csid,option)
+  tpz.hunts.onEventUpdate(player,csid,option)
+end
+
+function onEventFinish(player, csid, option)
+  tpz.hunts.onEventFinish(player, csid, option)
+end

scripts/globals/regimes.lua

@@ -0,0 +1,10 @@
+------------------------------
+-- Area: Alzadaal Undersea Ruins
+--   NM: Boompadu
+------------------------------
+require("scripts/globals/hunts")
+------------------------------
+
+function onMobDeath(mob, player, isKiller)
+    tpz.hunts.checkHunt(mob, player, 476)
+end

scripts/zones/Aht_Urhgan_Whitegate/IDs.lua

@@ -2,6 +2,7 @@
 -- Area: Alzadaal Undersea Ruins (72)
 --   NM: Cookieduster Lipiroon
 -----------------------------------
+require("scripts/globals/hunts")
 require("scripts/globals/status")
 -----------------------------------
 
@@ -14,4 +15,5 @@ function onAdditionalEffect(mob, target, damage)
 end
 
 function onMobDeath(mob, player, isKiller)
+    tpz.hunts.checkHunt(mob, player, 477)
 end

scripts/zones/Aht_Urhgan_Whitegate/npcs/Hunt_Registry.lua

@@ -2,6 +2,7 @@
 -- Area: Alzadaal Undersea Ruins
 --   NM: Oupire
 -----------------------------------
+require("scripts/globals/hunts")
 require("scripts/globals/titles")
 require("scripts/globals/mobs")
 -----------------------------------
@@ -15,6 +16,7 @@ function onAdditionalEffect(mob, target, damage)
 end
 
 function onMobDeath(mob, player, isKiller)
+    tpz.hunts.checkHunt(mob, player, 478)
     player:addTitle(tpz.title.OUPIRE_IMPALER)
 end
 

scripts/zones/Alzadaal_Undersea_Ruins/mobs/Boompadu.lua

@@ -0,0 +1,10 @@
+------------------------------
+-- Area: Arrapago Reef
+--   NM: Bloody Bones
+------------------------------
+require("scripts/globals/hunts")
+------------------------------
+
+function onMobDeath(mob, player, isKiller)
+    tpz.hunts.checkHunt(mob, player, 472)
+end

scripts/zones/Alzadaal_Undersea_Ruins/mobs/Cookieduster_Lipiroon.lua

@@ -2,6 +2,7 @@
 -- Area: Arrapago Reef
 --   NM: Euryale
 -----------------------------------
+require("scripts/globals/hunts")
 require("scripts/globals/mobs")
 -----------------------------------
 
@@ -14,4 +15,5 @@ function onAdditionalEffect(mob, target, damage)
 end
 
 function onMobDeath(mob, player, isKiller)
+    tpz.hunts.checkHunt(mob, player, 474)
 end

scripts/zones/Alzadaal_Undersea_Ruins/mobs/Oupire.lua

@@ -2,8 +2,10 @@
 -- Area: Attohwa Chasm
 --  Mob: Ambusher Antlion
 -----------------------------------
+require("scripts/globals/hunts")
 mixins = {require("scripts/mixins/families/antlion_ambush")}
 -----------------------------------
 
 function onMobDeath(mob, player, isKiller)
+    tpz.hunts.checkHunt(mob, player, 277)
 end;

scripts/zones/Arrapago_Reef/mobs/Bloody_Bones.lua

@@ -2,6 +2,8 @@
 -- Area: Attohwa Chasm
 --  Mob: Citipati
 -----------------------------------
+require("scripts/globals/hunts")
 
 function onMobDeath(mob, player, isKiller)
+    tpz.hunts.checkHunt(mob, player, 278)
 end;

scripts/zones/Arrapago_Reef/mobs/Euryale.lua

@@ -2,6 +2,7 @@
 -- Area: Attohwa Chasm
 --   NM: Sargas
 -----------------------------------
+require("scripts/globals/hunts")
 require("scripts/globals/mobs")
 -----------------------------------
 
@@ -40,6 +41,7 @@ function onSpikesDamage(mob, target, damage)
 end
 
 function onMobDeath(mob, player, isKiller)
+    tpz.hunts.checkHunt(mob, player, 279)
 end
 
 function onMobDespawn(mob)

scripts/zones/Attohwa_Chasm/mobs/Ambusher_Antlion.lua

@@ -2,6 +2,7 @@
 -- Area: Attohwa Chasm
 --   NM: Sekhmet
 -----------------------------------
+require("scripts/globals/hunts")
 require("scripts/globals/mobs")
 -----------------------------------
 
@@ -16,6 +17,7 @@ function onAdditionalEffect(mob, target, damage)
 end
 
 function onMobDeath(mob, player, isKiller)
+    tpz.hunts.checkHunt(mob, player, 276)
 end;
 
 function onMobDespawn(mob)

scripts/zones/Attohwa_Chasm/mobs/Citipati.lua

@@ -0,0 +1,10 @@
+------------------------------
+-- Area: Aydeewa Subterrane
+--   NM: Bluestreak Gyugyuroon
+------------------------------
+require("scripts/globals/hunts")
+------------------------------
+
+function onMobDeath(mob, player, isKiller)
+    tpz.hunts.checkHunt(mob, player, 464)
+end

scripts/zones/Attohwa_Chasm/mobs/Sargas.lua

@@ -0,0 +1,10 @@
+------------------------------
+-- Area: Aydeewa Subterrane
+--   NM: Crystal Eater
+------------------------------
+require("scripts/globals/hunts")
+------------------------------
+
+function onMobDeath(mob, player, isKiller)
+    tpz.hunts.checkHunt(mob, player, 463)
+end

scripts/zones/Attohwa_Chasm/mobs/Sekhmet.lua

@@ -2,6 +2,7 @@
 -- Area: Aydeewa Subterrane
 --   NM: Lizardtrap
 -----------------------------------
+require("scripts/globals/hunts")
 require("scripts/globals/mobs")
 -----------------------------------
 
@@ -14,6 +15,7 @@ function onAdditionalEffect(mob, target, damage)
 end
 
 function onMobDeath(mob, player, isKiller)
+    tpz.hunts.checkHunt(mob, player, 462)
 end
 
 function onMobDespawn(mob)

scripts/zones/Aydeewa_Subterrane/mobs/Bluestreak_Gyugyuroon.lua

@@ -17,6 +17,12 @@ zones[tpz.zone.BASTOK_MARKETS_S] =
         FISHING_MESSAGE_OFFSET   = 7049, -- You can't fish here.
         BLINGBRIX_SHOP_DIALOG    = 7199, -- Blingbrix good Gobbie from Boodlix's! Boodlix's Emporium help fighting fighters and maging mages. Gil okay, okay?
         MOG_LOCKER_OFFSET        = 7460, -- Your Mog Locker lease is valid until <timestamp>, kupo.
+        REGIME_CANCELED          = 7698, -- Current training regime canceled.
+        HUNT_ACCEPTED            = 7716, -- Hunt accepted!
+        USE_SCYLDS               = 7717, -- You use <fee> scylds. Scyld balance: <scylds>.
+        HUNT_RECORDED            = 7728, -- You record your hunt.
+        OBTAIN_SCYLDS            = 7730, -- You obtain <scylds>! Current Balance: <scylds>.
+        HUNT_CANCELED            = 7734, -- Hunt canceled.
         HOMEPOINT_SET            = 10827, -- Home point set!
         KARLOTTE_DELIVERY_DIALOG = 10861, -- I am here to help with all your parcel delivery needs.
         WELDON_DELIVERY_DIALOG   = 10862, -- Do you have something you wish to send?

scripts/zones/Aydeewa_Subterrane/mobs/Crystal_Eater.lua

@@ -0,0 +1,16 @@
+require("scripts/globals/hunts")
+
+function onTrade(player, npc, trade)
+end
+
+function onTrigger(player,npc,event)
+  tpz.hunts.onTrigger(player,npc,event)
+end
+
+function onEventUpdate(player,csid,option)
+  tpz.hunts.onEventUpdate(player,csid,option)
+end
+
+function onEventFinish(player, csid, option)
+  tpz.hunts.onEventFinish(player, csid, option)
+end

scripts/zones/Aydeewa_Subterrane/mobs/Lizardtrap.lua

@@ -30,6 +30,12 @@ zones[tpz.zone.BASTOK_MINES] =
         NO_MORE_GP_ELIGIBLE            = 7082, -- You are not eligible to receive guild points at this time.
         GP_OBTAINED                    = 7087, -- Obtained: <number> guild points.
         NOT_HAVE_ENOUGH_GP             = 7088, -- You do not have enough guild points.
+        REGIME_CANCELED                = 7269, -- Current training regime canceled.
+        HUNT_ACCEPTED                  = 7287, -- Hunt accepted!
+        USE_SCYLDS                     = 7288, -- You use <fee> scylds. Scyld balance: <scylds>.
+        HUNT_RECORDED                  = 7299, -- You record your hunt.
+        OBTAIN_SCYLDS                  = 7301, -- You obtain <scylds>! Current Balance: <scylds>.
+        HUNT_CANCELED                  = 7305, -- Hunt canceled.
         ITEM_DELIVERY_DIALOG           = 10435, -- Need something sent to a friend's house? Sending items to your own house? You've come to the right place!
         DETZO_RIVALS_DIALOG            = 10586, -- Can I borrow it for just a few seconds? I'll give it back, promise! I'll even give you a reward!
         FAUSTIN_CLOSED_DIALOG          = 10779, -- Sorry, I don't have anything to sell you. I'm trying to start a business selling goods from Ronfaure, but it's not easy getting stuff from areas that aren't under Bastokan control.

scripts/zones/Bastok_Markets_[S]/IDs.lua

@@ -0,0 +1,16 @@
+require("scripts/globals/hunts")
+
+function onTrade(player, npc, trade)
+end
+
+function onTrigger(player,npc,event)
+  tpz.hunts.onTrigger(player,npc,event)
+end
+
+function onEventUpdate(player,csid,option)
+  tpz.hunts.onEventUpdate(player,csid,option)
+end
+
+function onEventFinish(player, csid, option)
+  tpz.hunts.onEventFinish(player, csid, option)
+end

scripts/zones/Bastok_Markets_[S]/npcs/Hunt_Registry.lua

@@ -2,6 +2,7 @@
 -- Area: Batallia Downs
 --   NM: Eyegouger
 -----------------------------------
+require("scripts/globals/hunts")
 require("scripts/globals/mobs")
 -----------------------------------
 
@@ -14,4 +15,5 @@ function onAdditionalEffect(mob, target, damage)
 end
 
 function onMobDeath(mob, player, isKiller)
+    tpz.hunts.checkHunt(mob, player, 163)
 end

scripts/zones/Bastok_Mines/IDs.lua

@@ -2,6 +2,7 @@
 -- Area: Batallia Downs
 --   NM: Prankster Maverix
 -----------------------------------
+require("scripts/globals/hunts")
 require("scripts/globals/status")
 -----------------------------------
 
@@ -10,4 +11,5 @@ function onMobInitialize(mob)
 end
 
 function onMobDeath(mob, player, isKiller)
+    tpz.hunts.checkHunt(mob, player, 164)
 end

scripts/zones/Bastok_Mines/npcs/Hunt_Registry.lua

@@ -2,6 +2,7 @@
 -- Area: Batallia Downs (105)
 --  Mob: Skirling Liger
 -----------------------------------
+require("scripts/globals/hunts")
 require("scripts/globals/status");
 -----------------------------------
 
@@ -14,6 +15,7 @@ function onMobDisengage(mob)
 end;
 
 function onMobDeath(mob, player, isKiller)
+    tpz.hunts.checkHunt(mob, player, 162)
 end;
 
 function onMobDespawn(mob)

scripts/zones/Batallia_Downs/mobs/Eyegouger.lua

@@ -2,6 +2,8 @@
 -- Area: Batallia Downs (105)
 --  Mob: Tottering Toby
 -----------------------------------
+require("scripts/globals/hunts")
 
 function onMobDeath(mob, player, isKiller)
+    tpz.hunts.checkHunt(mob, player, 161)
 end;

scripts/zones/Batallia_Downs/mobs/Prankster_Maverix.lua

@@ -2,6 +2,7 @@
 -- Area: Batallia Downs [S]
 --   NM: Burlibix Brawnback
 -----------------------------------
+require("scripts/globals/hunts")
 require("scripts/globals/status")
 -----------------------------------
 
@@ -10,4 +11,5 @@ function onMobSpawn(mob)
 end
 
 function onMobDeath(mob, player, isKiller)
+    tpz.hunts.checkHunt(mob, player, 494)
 end

scripts/zones/Batallia_Downs/mobs/Skirling_Liger.lua

@@ -2,6 +2,7 @@
 -- Area: Batallia Downs [S]
 --   NM: Chaneque
 -----------------------------------
+require("scripts/globals/hunts")
 require("scripts/globals/mobs")
 -----------------------------------
 
@@ -14,6 +15,7 @@ function onAdditionalEffect(mob, target, damage)
 end
 
 function onMobDeath(mob, player, isKiller)
+    tpz.hunts.checkHunt(mob, player, 492)
 end;
 
 function onMobDespawn(mob)

scripts/zones/Batallia_Downs/mobs/Tottering_Toby.lua

@@ -2,6 +2,7 @@
 -- Area: Batallia Downs [S]
 --   NM: Habergoass
 -----------------------------------
+require("scripts/globals/hunts")
 require("scripts/globals/status")
 -----------------------------------
 
@@ -10,4 +11,5 @@ function onMobInitialize(mob)
 end
 
 function onMobDeath(mob, player, isKiller)
+    tpz.hunts.checkHunt(mob, player, 493)
 end