[lua] Implement BST Ability "Killer Instinct"

Author: UmeboshiXI

scripts/actions/abilities/killer_instinct.lua

@@ -0,0 +1,18 @@
+-----------------------------------
+-- Ability: Killer Instinct
+-- Grants your pet's Killer Effect to party members within area of effect.
+-- Obtained: Beastmaster Level 75 (Merit)
+-- Recast Time: 5:00
+-- Duration: 3:00
+-----------------------------------
+local abilityObject = {}
+
+abilityObject.onAbilityCheck = function(player, target, ability)
+    return xi.job_utils.beastmaster.onAbilityCheckKillerInstinct(player, target, ability)
+end
+
+abilityObject.onUseAbility = function(player, target, ability)
+    return xi.job_utils.beastmaster.onUseAbilityKillerInstinct(player, target, ability)
+end
+
+return abilityObject

scripts/effects/killer_instinct.lua

@@ -5,6 +5,25 @@
 local effectObject = {}
 
 effectObject.onEffectGain = function(target, effect)
+    -- onUseAbilityKillerInstinct in BST job_utils assigns the pet's ecosystem Enum as the effect subPower.
+    -- subPower is then used to grant the corresponding killer effect.
+    local ecosystemCorrelationMap =
+    {
+        -- Pet Ecosystem(subPower), Corresponding killer modifier
+        [xi.ecosystem.AMORPH]   = xi.mod.BIRD_KILLER,
+        [xi.ecosystem.AQUAN]    = xi.mod.AMORPH_KILLER,
+        [xi.ecosystem.BEAST]    = xi.mod.LIZARD_KILLER,
+        [xi.ecosystem.BIRD]     = xi.mod.AQUAN_KILLER,
+        [xi.ecosystem.LIZARD]   = xi.mod.VERMIN_KILLER,
+        [xi.ecosystem.PLANTOID] = xi.mod.BEAST_KILLER,
+        [xi.ecosystem.VERMIN]   = xi.mod.PLANTOID_KILLER,
+    }
+
+    local mod = ecosystemCorrelationMap[effect:getSubPower()]
+
+    if mod then
+        effect:addMod(mod, effect:getPower())
+    end
 end
 
 effectObject.onEffectTick = function(target, effect)

scripts/globals/job_utils/beastmaster.lua

@@ -508,7 +508,7 @@ xi.job_utils.beastmaster.onAbilityCheckFight = function(player, target, ability)
     return 0, 0
 end
 
--- On Ability Use Stay
+-- On Ability Use Fight
 xi.job_utils.beastmaster.onUseAbilityFight = function(player, target, ability)
     local pet = player:getPet()
 
@@ -521,6 +521,32 @@ xi.job_utils.beastmaster.onUseAbilityFight = function(player, target, ability)
     end
 end
 
+-- On Ability Check Killer Instinct
+xi.job_utils.beastmaster.onAbilityCheckKillerInstinct = function(player, target, ability)
+    local pet = player:getPet()
+
+    if
+        pet == nil or -- No pet currently spawned
+        (not player:hasJugPet() and pet:getObjType() ~= xi.objType.MOB) -- The pet spawned is not a jug pet or charmed mob
+    then
+        return xi.msg.basic.REQUIRES_A_PET, 0
+    end
+
+    return 0, 0
+end
+
+-- On Ability Use Killer Instinct
+xi.job_utils.beastmaster.onUseAbilityKillerInstinct = function(player, target, ability)
+    -- Notes: Pet ecosystem is assigned to the subPower, then mapped to the correct killer mod in the effect script.
+    local pet          = player:getPet()
+    local petEcosystem = pet:getEcosystem()
+    local power        = 10
+    local duration     = 180 + (player:getMerit(xi.merit.KILLER_INSTINCT) - 10)
+    -- TODO: Is there gear/mods that enhance power/duration?
+
+    target:addStatusEffect(xi.effect.KILLER_INSTINCT, power, 0, duration, 0, petEcosystem)
+end
+
 local function getCharmDuration(charmer, target)
     local charmDuration = 0