Merge pull request LandSandBoat#8467 from Xaver-DaRed/clup

[Chore] Selbina and Mhaura zone script cleanup

Author: Xaver-DaRed

scripts/zones/Mhaura/Zone.lua

@@ -6,13 +6,11 @@ local ID = zones[xi.zone.MHAURA]
 ---@type TZone
 local zoneObject = {}
 
-local piratesChance = 10 -- 10% chance to zone from mhaura/selbina into pirates encounter
-
 zoneObject.onGameHour = function(zone)
     local laughingBison = GetNPCByID(ID.npc.LAUGHING_BISON)
     if laughingBison then
         -- Script for Laughing Bison sign flip animations
-        local timer = 1152 - ((GetSystemTime() - 1009810802)%1152)
+        local timer = 1152 - (GetSystemTime() - 1009810802) % 1152
 
         -- Next ferry is Al Zhabi for higher values.
         if timer >= 576 then
@@ -22,7 +20,8 @@ zoneObject.onGameHour = function(zone)
         end
     end
 
-    zone:setLocalVar('piratesVoyageRng', math.random(1, 100))
+    local destinationId = math.random(1, 100) <= 10 and xi.zone.SHIP_BOUND_FOR_SELBINA_PIRATES or xi.zone.SHIP_BOUND_FOR_SELBINA
+    zone:setLocalVar('[Pirate]Zone', destinationId)
 end
 
 zoneObject.onInitialize = function(zone)
@@ -58,6 +57,10 @@ zoneObject.onConquestUpdate = function(zone, updatetype, influence, owner, ranki
 end
 
 zoneObject.onTransportEvent = function(player, prevZoneId, transportId)
+    if player:isInEvent() then
+        return
+    end
+
     if
         prevZoneId == xi.zone.OPEN_SEA_ROUTE_TO_AL_ZAHBI or
         prevZoneId == xi.zone.OPEN_SEA_ROUTE_TO_MHAURA
@@ -69,19 +72,14 @@ zoneObject.onTransportEvent = function(player, prevZoneId, transportId)
         then
             player:startEvent(200)
         else
-            -- TODO find rejection event, as this method doesn't cleanly boot from the boat and if you were inside the ship, the game client keeps it rendered
-            player:setPos(8.200, -1.363, 3.445, 192)
+            player:startEvent(204)
             player:messageSpecial(ID.text.DO_NOT_POSSESS, xi.ki.BOARDING_PERMIT)
         end
     else
-        -- TODO don't double fire transport events (a ship "arrives" from normal and pirates zones at the same time and triggers a transport event)
-        if not player:isInEvent() then
-            if player:hasKeyItem(xi.ki.FERRY_TICKET) then
-                player:startEvent(200)
-            else
-                -- TODO find rejection event, as this method doesn't cleanly boot from the boat and if you were inside the ship, the game client keeps it rendered
-                player:setPos(8.200, -1.363, 3.445, 192)
-            end
+        if player:hasKeyItem(xi.ki.FERRY_TICKET) then
+            player:startEvent(200)
+        else
+            player:startEvent(204)
         end
     end
 end
@@ -91,19 +89,21 @@ end
 
 zoneObject.onEventFinish = function(player, csid, option, npc)
     if csid == 200 then
-        local DepartureTime = VanadielHour()
-
-        if DepartureTime % 8 == 0 then
-            local currZone = player:getZone()
-            if currZone and currZone:getLocalVar('piratesVoyageRng') <= piratesChance then
-                player:setPos(0, 0, 0, 0, xi.zone.SHIP_BOUND_FOR_SELBINA_PIRATES)
-            else
-                player:setPos(0, 0, 0, 0, xi.zone.SHIP_BOUND_FOR_SELBINA)
-            end
-        elseif DepartureTime % 8 == 4 then
+        local departureTime = VanadielHour() % 8
+        local zone          = player:getZone()
+        local destinationId = zone and zone:getLocalVar('[Pirate]Zone') or xi.zone.SHIP_BOUND_FOR_SELBINA
+
+        -- To Selbina.
+        if departureTime == 0 then
+            player:setPos(0, 0, 0, 0, destinationId)
+
+        -- To Al Zahbi
+        elseif departureTime == 4 then
             player:setPos(0, 0, 0, 0, xi.zone.OPEN_SEA_ROUTE_TO_AL_ZAHBI)
+
+        -- Something went wrong, dump them on the dock for safety.
         else
-            player:setPos(8, -1, 5, 62, 249) -- Something went wrong, dump them on the dock for safety.
+            player:setPos(8, -1, 5, 62, xi.zone.MHAURA)
         end
     end
 end

scripts/zones/Selbina/Zone.lua

@@ -6,15 +6,14 @@ local ID = zones[xi.zone.SELBINA]
 ---@type TZone
 local zoneObject = {}
 
-local piratesChance = 10 -- 10% chance to zone from mhaura/selbina into pirates encounter
-
 zoneObject.onInitialize = function(zone)
     xi.server.setExplorerMoogles(ID.npc.EXPLORER_MOOGLE)
     InitializeFishingContestSystem()
 end
 
 zoneObject.onGameHour = function(zone)
-    zone:setLocalVar('piratesVoyageRng', math.random(1, 100))
+    local destinationId = math.random(1, 100) <= 10 and xi.zone.SHIP_BOUND_FOR_MHAURA_PIRATES or xi.zone.SHIP_BOUND_FOR_MHAURA
+    zone:setLocalVar('[Pirate]Zone', destinationId)
 end
 
 zoneObject.onZoneTick = function(zone)
@@ -60,26 +59,27 @@ end
 zoneObject.onTransportEvent = function(player, prevZoneId, transportId)
     -- TODO don't double fire transport events (a ship "arrives" from normal and pirates zones at the same time and triggers a transport event)
     if not player:isInEvent() then
-        if player:hasKeyItem(xi.ki.FERRY_TICKET) then
-            player:startEvent(200)
-        else
-            -- TODO find rejection event, as this method doesn't cleanly boot from the boat and if you were inside the ship, the game client keeps it rendered
-            player:setPos(32.500, -2.500, -45.500, 192)
-        end
+        return
+    end
+
+    if player:hasKeyItem(xi.ki.FERRY_TICKET) then
+        player:startEvent(200)
+    else
+        player:startEvent(204)
     end
 end
 
 zoneObject.onEventUpdate = function(player, csid, option, npc)
 end
 
 zoneObject.onEventFinish = function(player, csid, option, npc)
+    -- Transport event.
     if csid == 200 then
-        local currZone = player:getZone()
-        if currZone and currZone:getLocalVar('piratesVoyageRng') <= piratesChance then
-            player:setPos(0, 0, 0, 0, xi.zone.SHIP_BOUND_FOR_MHAURA_PIRATES)
-        else
-            player:setPos(0, 0, 0, 0, xi.zone.SHIP_BOUND_FOR_MHAURA)
-        end
+        local zone          = player:getZone()
+        local destinationId = zone and zone:getLocalVar('[Pirate]Zone') or xi.zone.SHIP_BOUND_FOR_MHAURA
+        player:setPos(0, 0, 0, 0, destinationId)
+
+    -- Quest logic. TODO: Convert quest to interaction.
     elseif
         csid == 1101 and
         npcUtil.completeQuest(player, xi.questLog.OUTLANDS, xi.quest.id.outlands.I_LL_TAKE_THE_BIG_BOX, { item = 14226, fameArea = xi.fameArea.NORG, var = { 'Enagakure_Killed', 'illTakeTheBigBoxCS' } })