Merge pull request #6245 from LandSandBoat/lls/zone

LLS: Create TZone type, annotate zones/Zone.lua files, correct issues identified

scripts/actions/abilities/pets/automaton/arcuballista.lua

@@ -6,7 +6,6 @@ local abilityObject = {}
 
 abilityObject.onAutomatonAbilityCheck = function(target, automaton, skill)
     local master = automaton:getMaster()
-
     if not master then
         return
     end

scripts/actions/abilities/pets/automaton/armor_piercer.lua

@@ -6,7 +6,6 @@ local abilityObject = {}
 
 abilityObject.onAutomatonAbilityCheck = function(target, automaton, skill)
     local master = automaton:getMaster()
-
     if not master then
         return
     end

scripts/actions/abilities/pets/automaton/armor_shatterer.lua

@@ -6,7 +6,6 @@ local abilityObject = {}
 
 abilityObject.onAutomatonAbilityCheck = function(target, automaton, skill)
     local master = automaton:getMaster()
-
     if not master then
         return
     end

scripts/actions/abilities/pets/automaton/bone_crusher.lua

@@ -6,7 +6,6 @@ local abilityObject = {}
 
 abilityObject.onAutomatonAbilityCheck = function(target, automaton, skill)
     local master = automaton:getMaster()
-
     if not master then
         return
     end

scripts/actions/abilities/pets/automaton/cannibal_blade.lua

@@ -6,7 +6,6 @@ local abilityObject = {}
 
 abilityObject.onAutomatonAbilityCheck = function(target, automaton, skill)
     local master = automaton:getMaster()
-
     if not master then
         return
     end

scripts/actions/abilities/pets/automaton/chimera_ripper.lua

@@ -6,7 +6,6 @@ local abilityObject = {}
 
 abilityObject.onAutomatonAbilityCheck = function(target, automaton, skill)
     local master = automaton:getMaster()
-
     if not master then
         return
     end

scripts/actions/abilities/pets/automaton/daze.lua

@@ -6,7 +6,6 @@ local abilityObject = {}
 
 abilityObject.onAutomatonAbilityCheck = function(target, automaton, skill)
     local master = automaton:getMaster()
-
     if not master then
         return
     end

scripts/actions/abilities/pets/automaton/knockout.lua

@@ -6,7 +6,6 @@ local abilityObject = {}
 
 abilityObject.onAutomatonAbilityCheck = function(target, automaton, skill)
     local master = automaton:getMaster()
-
     if not master then
         return
     end

scripts/actions/abilities/pets/automaton/magic_mortar.lua

@@ -6,7 +6,6 @@ local abilityObject = {}
 
 abilityObject.onAutomatonAbilityCheck = function(target, automaton, skill)
     local master = automaton:getMaster()
-
     if not master then
         return
     end

scripts/actions/abilities/pets/automaton/slapstick.lua

@@ -6,7 +6,6 @@ local abilityObject = {}
 
 abilityObject.onAutomatonAbilityCheck = function(target, automaton, skill)
     local master = automaton:getMaster()
-
     if not master then
         return
     end

scripts/actions/abilities/pets/automaton/string_clipper.lua

@@ -6,7 +6,6 @@ local abilityObject = {}
 
 abilityObject.onAutomatonAbilityCheck = function(target, automaton, skill)
     local master = automaton:getMaster()
-
     if not master then
         return
     end

scripts/actions/abilities/pets/automaton/string_shredder.lua

@@ -6,7 +6,6 @@ local abilityObject = {}
 
 abilityObject.onAutomatonAbilityCheck = function(target, automaton, skill)
     local master = automaton:getMaster()
-
     if not master then
         return
     end

scripts/actions/abilities/pets/concentric_pulse.lua

@@ -9,8 +9,7 @@ abilityObject.onAbilityCheck = function(player, target, ability)
 end
 
 abilityObject.onPetAbility = function(target, pet, skill)
-    local master             = pet:getMaster()
-
+    local master = pet:getMaster()
     if not master then
         return
     end

scripts/actions/abilities/repair.lua

@@ -64,8 +64,7 @@ abilityObject.onAbilityCheck = function(player, target, ability)
 end
 
 abilityObject.onUseAbility = function(player, target, ability)
-    local pet                 = player:getPet()
-
+    local pet = player:getPet()
     if not pet then
         return
     end

scripts/actions/abilities/role_reversal.lua

@@ -22,7 +22,6 @@ end
 
 abilityObject.onUseAbility = function(player, target, ability)
     local pet = player:getPet()
-
     if pet then
         local bonus    = 1 + (player:getMerit(xi.merit.ROLE_REVERSAL) - 5) / 100
         local playerHP = player:getHP()

scripts/actions/abilities/ventriloquy.lua

@@ -22,7 +22,6 @@ end
 
 abilityObject.onUseAbility = function(player, target, ability)
     local pet = player:getPet()
-
     if pet then
         local enmitylist            = target:getEnmityList()
         local playerfound, petfound = false, false

scripts/actions/mobskills/astral_flow_pet.lua

@@ -45,7 +45,6 @@ local petAstralFlowAbility =
 
 mobskillObject.onMobWeaponSkill = function(target, mob, skill)
     local pet = mob:getPet()
-
     if not pet then
         return
     end

scripts/actions/mobskills/eald2_warp_out.lua

@@ -11,7 +11,6 @@ end
 
 mobskillObject.onMobWeaponSkill = function(target, mob, skill)
     local battletarget = mob:getTarget()
-
     if not battletarget then
         return
     end

scripts/actions/spells/trust/sylvie_uc.lua

@@ -14,8 +14,8 @@ end
 
 spellObject.onMobSpawn = function(mob)
     xi.trust.message(mob, xi.trust.messageOffset.SPAWN)
-    local master = mob:getMaster()
 
+    local master = mob:getMaster()
     if not master then
         return
     end

scripts/commands/checklocalvar.lua

@@ -34,7 +34,6 @@ commandObj.onTrigger = function(player, arg1, arg2, arg3)
             arg3 = tonumber(arg3)
             if zone and zone:getTypeMask() == xi.zoneType.INSTANCED then
                 local instance = player:getInstance()
-
                 if not instance then
                     return
                 end

scripts/globals/battlefield.lua

@@ -708,7 +708,6 @@ function Battlefield.onEntryTrigger(player, npc)
         local status  = player:getStatusEffect(xi.effect.BATTLEFIELD)
         local id      = status:getPower()
         local content = xi.battlefield.contents[id]
-
         if not content then
             return
         end

scripts/globals/beastmentreasure.lua

@@ -240,7 +240,6 @@ xi.beastmentreasure.updatePeddlestox = function(zone, peddlestoxID)
     and once at the start of each new game day. Since Peddlestox is disabled in the db by default, we
     only need to enable her on the appropriate day and disable her on the following day. ]]--
     local peddlestox = GetNPCByID(peddlestoxID)
-
     if not peddlestox then
         return
     end

scripts/globals/chocobo_raising.lua

@@ -1062,7 +1062,6 @@ end
 
 xi.chocoboRaising.initChocoboData = function(player)
     local chocoState = player:getChocoboRaisingInfo()
-
     if not chocoState then
         return chocoState
     end

scripts/globals/follow.lua

@@ -40,7 +40,6 @@ end
 
 xi.follow.clearFollowers = function(leader)
     local followers = xi.follow.getFollowers(leader)
-
     if not followers then
         return
     end

scripts/globals/job_utils/summoner.lua

@@ -221,7 +221,6 @@ end
 
 xi.job_utils.summoner.onUseBloodPact = function(target, petskill, summoner, action)
     local bloodPactAbility = GetAbility(petskill:getID()) -- Player abilities and Avatar abilities are mapped 1:1
-
     if not bloodPactAbility then
         return
     end

scripts/globals/magian.lua

@@ -918,7 +918,6 @@ xi.magian.onItemEquip = function(player, itemObj)
     end
 
     local trialData = xi.magian.trials[itemTrialId]
-
     if not trialData then
         return
     end

scripts/globals/npc_util.lua

@@ -925,7 +925,6 @@ end
 
 function npcUtil.UpdateNPCSpawnPoint(id, minTime, maxTime, posTable, serverVar)
     local npc = GetNPCByID(id)
-
     if not npc then
         return
     end

scripts/globals/pets/avatar.lua

@@ -385,7 +385,6 @@ end
 xi.pets.avatar.getLightSpiritSpell = function(pet)
     -- returns the spirit's preferred target based on positioning
     local master = pet:getMaster()
-
     if not master then
         return 0, nil
     end

scripts/globals/regimes.lua

@@ -1108,7 +1108,6 @@ xi.regime.bookOnEventUpdate = function(player, option, regimeType)
     -- check valid option
     local opts = getUpdateOpts(regimeType)
     local opt  = opts[option]
-
     if not opt then
         return
     end
@@ -1154,7 +1153,6 @@ xi.regime.bookOnEventFinish = function(player, option, regimeType)
     -- check valid option
     local opts = getFinishOpts(regimeType)
     local opt  = opts[option]
-
     if not opt then
         return
     end

scripts/items/astral_pot.lua

@@ -25,7 +25,6 @@ end
 
 itemObject.onEffectGain = function(target, effect)
     local pet = target:getPet()
-
     if not pet then
         return
     end

scripts/items/bag_of_wyvern_feed.lua

@@ -9,7 +9,8 @@ local itemObject = {}
 
 itemObject.onItemCheck = function(target, item, param, caster)
     local effect = target:getStatusEffect(xi.effect.ENCHANTMENT)
-    local pet = target:getPet()
+    local pet    = target:getPet()
+
     if not pet then
         return xi.msg.basic.REQUIRES_A_PET, 0
     elseif effect ~= nil and effect:getSubType() == 18242 then
@@ -25,7 +26,6 @@ end
 
 itemObject.onEffectGain = function(target, effect)
     local pet = target:getPet()
-
     if not pet then
         return
     end

scripts/items/bottle_of_dawn_mulsum.lua

@@ -15,13 +15,12 @@ itemObject.onItemCheck = function(target, item, param, caster)
 end
 
 itemObject.onItemUse = function(target)
-    local percent = math.random(20, 35) * xi.settings.main.ITEM_POWER
     local pet = target:getPet()
-
     if not pet then
         return
     end
 
+    local percent = math.random(20, 35) * xi.settings.main.ITEM_POWER
     local totalHP = (pet:getMaxHP() / 100) * percent
     pet:addHP(totalHP)
     pet:messageBasic(xi.msg.basic.RECOVERS_HP, 0, totalHP)

scripts/items/chunk_of_smelling_salts.lua

@@ -9,7 +9,8 @@ local itemObject = {}
 
 itemObject.onItemCheck = function(target, item, param, caster)
     local pet = target:getPet()
-    if pet == nil then
+
+    if not pet then
         return xi.msg.basic.REQUIRES_A_PET
     elseif pet:hasStatusEffect(xi.effect.MEDICINE) then
         return xi.msg.basic.ITEM_NO_USE_MEDICATED
@@ -21,7 +22,6 @@ end
 itemObject.onItemUse = function(target)
     if target:addStatusEffect(xi.effect.MEDICINE, 0, 0, 180, 5320) then
         local pet = target:getPet()
-
         if not pet then
             return
         end

scripts/items/cirrocumulus_cell.lua

@@ -20,7 +20,6 @@ end
 
 itemObject.onItemUse = function(target)
     local encumbrance = target:getStatusEffect(xi.effect.ENCUMBRANCE_I)
-
     if not encumbrance then
         return
     end

scripts/items/qiqirn_mine.lua

@@ -17,13 +17,11 @@ end
 
 itemObject.onItemUse = function(target)
     local instance = target:getInstance()
-
     if not instance then
         return
     end
 
     local bomb = instance:insertAlly(100)
-
     if not bomb then
         return
     end

scripts/items/scapegoat.lua

@@ -15,7 +15,6 @@ itemObject.onItemUse = function(target)
 
     if target:hasStatusEffect(xi.effect.RERAISE) then
         local effect = target:getStatusEffect(xi.effect.RERAISE)
-
         if not effect then
             return
         end

scripts/items/scroll_of_instant_reraise.lua

@@ -15,7 +15,6 @@ itemObject.onItemUse = function(target)
     local duration = 1800
     if target:hasStatusEffect(xi.effect.RERAISE) then
         local effect = target:getStatusEffect(xi.effect.RERAISE)
-
         if not effect then
             return
         end

scripts/items/tube_of_healing_salve_i.lua

@@ -16,7 +16,6 @@ end
 
 itemObject.onItemUse = function(target)
     local pet = target:getPet()
-
     if not pet then
         return
     end

scripts/items/tube_of_healing_salve_ii.lua

@@ -16,7 +16,6 @@ end
 
 itemObject.onItemUse = function(target)
     local pet = target:getPet()
-
     if not pet then
         return
     end

scripts/missions/wotg/19_Betrayal_at_Beaucedine.lua

@@ -32,8 +32,7 @@ mission.sections =
                     if missionStatus == 0 then
                         return mission:progressEvent(15, 136, 300, 200, 100, 0, 9306122, 0, 0)
                     elseif missionStatus == 1 then
-                        local zoneObj    = player:getZone()
-
+                        local zoneObj = player:getZone()
                         if not zoneObj then
                             return
                         end

scripts/quests/outlands/Forge_Your_Destiny.lua

@@ -65,7 +65,6 @@ quest.sections =
                             return quest:messageSpecial(konschtatID.text.BLACKENED_NOTHING_HAPPENS, xi.item.LUMP_OF_ORIENTAL_STEEL)
                         else
                             local forgerMob = SpawnMob(konschtatID.mob.FORGER)
-
                             if not forgerMob then
                                 return quest:noAction()
                             end
@@ -246,7 +245,6 @@ quest.sections =
                             return quest:messageSpecial(zitahID.text.STRANGE_FORCE_PREVENTS)
                         else
                             local treantMob = SpawnMob(zitahID.mob.GUARDIAN_TREANT)
-
                             if not treantMob then
                                 return quest:noAction()
                             end

scripts/specs/types/Container.lua

@@ -14,7 +14,7 @@
 ---@alias onZoneHandler fun(player: CBaseEntity): TAction?
 
 ---@class onTriggerAreaHandler
----@field [integer] fun(player: CBaseEntity, triggerArea: CTriggerArea): TAction?
+---@field [integer] fun(player: CBaseEntity, triggerArea: CTriggerArea, optInstance: CInstance?): TAction?
 
 ---@class EntitySection
 ---@field onTrade? TAction|fun(player: CBaseEntity, npc: CBaseEntity, trade: CTradeContainer): TAction?