Improve drawin specification with local vars

scripts/enum/mob_mod.lua

@@ -19,7 +19,7 @@ xi.mobMod =
     HP_HEAL_CHANCE         = 9,  -- can cast cures below this HP %
     SUBLINK                = 10, -- sub link group
     LINK_RADIUS            = 11, -- link radius
-    DRAW_IN                = 12, -- 1 - player draw in, 2 - alliance draw in -- only add as a spawn mod!
+    DRAW_IN                = 12, -- 1 - player/pet draw in, only add as a spawn mod, also see local var options like [DrawIn]IncludeAlliance=1 for alliance drawin
     SEVERE_SPELL_CHANCE    = 13, -- % chance to use a severe spell like death or impact
     SKILL_LIST             = 14, -- uses given mob skill list
     MUG_GIL                = 15, -- amount gil carried for mugging

scripts/zones/Attohwa_Chasm/mobs/Tiamat.lua

@@ -14,10 +14,11 @@ end
 
 entity.onMobInitialize = function(mob)
     mob:setCarefulPathing(true)
-    mob:setMobMod(xi.mobMod.DRAW_IN, 8)
+    mob:setMobMod(xi.mobMod.DRAW_IN, 1)
 end
 
 entity.onMobSpawn = function(mob)
+    mob:setLocalVar('[DrawIn]TriggerDist', 8)
     -- Reset animation so it starts grounded.
     mob:setMobSkillAttack(0)
     mob:setAnimationSub(0)

scripts/zones/Behemoths_Dominion/mobs/King_Behemoth.lua

@@ -10,9 +10,11 @@ local entity = {}
 entity.onMobInitialize = function(mob)
     mob:setMobMod(xi.mobMod.ADD_EFFECT, 1)
     mob:setMobMod(xi.mobMod.MAGIC_COOL, 60)
+    mob:setMobMod(xi.mobMod.DRAW_IN, 1)
 end
 
 entity.onMobSpawn = function(mob)
+    mob:setLocalVar('[DrawIn]TriggerDist', 25)
     mob:setLocalVar('[rage]timer', 3600) -- 60 minutes
 
     -- Despawn the ???

scripts/zones/Dragons_Aery/mobs/Fafnir.lua

@@ -7,7 +7,12 @@ mixins = { require('scripts/mixins/rage') }
 -----------------------------------
 local entity = {}
 
+entity.onMobInitialize = function(mob)
+    mob:setMobMod(xi.mobMod.DRAW_IN, 1)
+end
+
 entity.onMobSpawn = function(mob)
+    mob:setLocalVar('[DrawIn]TriggerDist', 20)
     mob:setLocalVar('[rage]timer', 3600) -- 60 minutes
     mob:setMobMod(xi.mobMod.WEAPON_BONUS, 50) -- Level 90 + 50 = 140 Base Weapon Damage
 

scripts/zones/FeiYin/mobs/Capricious_Cassie.lua

@@ -7,7 +7,11 @@ mixins = { require('scripts/mixins/rage') }
 local entity = {}
 
 entity.onMobInitialize = function(mob)
-    mob:setMobMod(xi.mobMod.DRAW_IN, 2)
+    mob:setMobMod(xi.mobMod.DRAW_IN, 1)
+end
+
+entity.onMobSpawn = function(mob)
+    mob:setLocalVar('[DrawIn]IncludeAlliance', 1)
 end
 
 entity.onMobDeath = function(mob, player, optParams)

scripts/zones/King_Ranperres_Tomb/mobs/Vrtra.lua

@@ -6,6 +6,14 @@ local entity = {}
 
 local offsets = { 1, 3, 5, 2, 4, 6 }
 
+entity.onMobInitialize = function(mob)
+    mob:setMobMod(xi.mobMod.DRAW_IN, 1)
+end
+
+entity.onMobSpawn = function(mob)
+    mob:setLocalVar('[DrawIn]TriggerDist', 15)
+end
+
 entity.onMobEngage = function(mob, target)
     -- Reset the onMobFight variables
     mob:setLocalVar('spawnTime', 0)

scripts/zones/Mamook/mobs/Gulool_Ja_Ja.lua

@@ -9,7 +9,8 @@ local entity = {}
 
 entity.onMobSpawn = function(mob)
     mob:setMod(xi.mod.DOUBLE_ATTACK, 20)
-    mob:setMobMod(xi.mobMod.DRAW_IN, 2)
+    mob:setMobMod(xi.mobMod.DRAW_IN, 1)
+    mob:setLocalVar('[DrawIn]IncludeAlliance', 1)
 end
 
 entity.onMobEngage = function(mob, target)

scripts/zones/Phomiuna_Aqueducts/mobs/Minotaur.lua

@@ -7,10 +7,12 @@ mixins = { require('scripts/mixins/fomor_hate') }
 local entity = {}
 
 entity.onMobInitialize = function(mob)
-    mob:setMobMod(xi.mobMod.DRAW_IN, 15)
+    mob:setMobMod(xi.mobMod.DRAW_IN, 1)
 end
 
 entity.onMobSpawn = function(mob)
+    mob:setLocalVar('[DrawIn]IncludeAlliance', 1)
+    mob:setLocalVar('[DrawIn]TriggerDist', 15)
     mob:setLocalVar('fomorHateAdj', 2)
 end
 

scripts/zones/Riverne-Site_A01/mobs/Ouryu.lua

@@ -6,10 +6,11 @@
 local entity = {}
 
 entity.onMobInitialize = function(mob)
-    mob:setMobMod(xi.mobMod.DRAW_IN, 15)
+    mob:setMobMod(xi.mobMod.DRAW_IN, 1)
 end
 
 entity.onMobSpawn = function(mob, player, optParams)
+    mob:setLocalVar('[DrawIn]TriggerDist', 15)
     mob:setMobMod(xi.mobMod.WEAPON_BONUS, 60) -- Level 85 + 60 = 145 Base Weapon Damage
 end
 

scripts/zones/The_Boyahda_Tree/mobs/Voluptuous_Vivian.lua

@@ -7,7 +7,11 @@ mixins = { require('scripts/mixins/job_special') }
 local entity = {}
 
 entity.onMobInitialize = function(mob)
-    mob:setMobMod(xi.mobMod.DRAW_IN, 2)
+    mob:setMobMod(xi.mobMod.DRAW_IN, 1)
+end
+
+entity.onMobSpawn = function(mob)
+    mob:setLocalVar('[DrawIn]IncludeAlliance', 1)
 end
 
 entity.onMobDeath = function(mob, player, optParams)

scripts/zones/Uleguerand_Range/mobs/Jormungand.lua

@@ -13,10 +13,11 @@ end
 
 entity.onMobInitialize = function(mob)
     mob:setCarefulPathing(true)
-    mob:setMobMod(xi.mobMod.DRAW_IN, 15)
+    mob:setMobMod(xi.mobMod.DRAW_IN, 1)
 end
 
 entity.onMobSpawn = function(mob)
+    mob:setLocalVar('[DrawIn]TriggerDist', 15)
     -- Reset animation so it starts grounded.
     mob:setMobSkillAttack(0)
     mob:setAnimationSub(0)

scripts/zones/Waughroon_Shrine/mobs/Dark_Dragon.lua

@@ -9,6 +9,10 @@ entity.onMobInitialize = function(mob)
     mob:setMobMod(xi.mobMod.DRAW_IN, 1)
 end
 
+entity.onMobSpawn = function(mob)
+    mob:setLocalVar('[DrawIn]TriggerDist', 25)
+end
+
 entity.onMobDeath = function(mob, player, optParams)
     player:addTitle(xi.title.DARK_DRAGON_SLAYER)
 end

scripts/zones/Western_Altepa_Desert/mobs/King_Vinegarroon.lua

@@ -6,7 +6,12 @@ local entity = {}
 
 entity.onMobInitialize = function(mob)
     mob:setMobMod(xi.mobMod.ADD_EFFECT, 1)
-    mob:setMobMod(xi.mobMod.DRAW_IN, 2)
+    mob:setMobMod(xi.mobMod.DRAW_IN, 1)
+end
+
+entity.onMobSpawn = function(mob)
+    mob:setLocalVar('[DrawIn]TriggerDist', 15)
+    mob:setLocalVar('[DrawIn]IncludeAlliance', 1)
 end
 
 entity.onMobDrawIn = function(mob, target)

scripts/zones/Xarcabard/mobs/Boreal_Coeurl.lua

@@ -80,11 +80,17 @@ entity.onMobRoam = function(mob)
     end
 end
 
+entity.onMobInitialize = function(mob)
+    mob:setMobMod(xi.mobMod.DRAW_IN, 1)
+end
+
 entity.onMobEngage = function(mob)
     mob:setSpeed(baseSpeed)
 end
 
 entity.onMobSpawn = function(mob)
+    mob:setLocalVar('[DrawIn]TriggerDist', 15)
+    mob:setLocalVar('[DrawIn]IncludeAlliance', 1)
     mob:setSpeed(baseSpeed)
     -- Failsafe to make sure NPC is down when NM is up
     if xi.settings.main.OLDSCHOOL_G2 then

scripts/zones/Xarcabard/mobs/Boreal_Hound.lua

@@ -82,11 +82,17 @@ entity.onMobRoam = function(mob)
     end
 end
 
+entity.onMobInitialize = function(mob)
+    mob:setMobMod(xi.mobMod.DRAW_IN, 1)
+end
+
 entity.onMobEngage = function(mob)
     mob:setSpeed(baseSpeed)
 end
 
 entity.onMobSpawn = function(mob)
+    mob:setLocalVar('[DrawIn]TriggerDist', 15)
+    mob:setLocalVar('[DrawIn]IncludeAlliance', 1)
     mob:setSpeed(baseSpeed)
     -- Failsafe to make sure NPC is down when NM is up
     if xi.settings.main.OLDSCHOOL_G2 then

scripts/zones/Xarcabard/mobs/Boreal_Tiger.lua

@@ -81,7 +81,13 @@ entity.onMobEngage = function(mob)
     mob:setSpeed(baseSpeed)
 end
 
+entity.onMobInitialize = function(mob)
+    mob:setMobMod(xi.mobMod.DRAW_IN, 1)
+end
+
 entity.onMobSpawn = function(mob)
+    mob:setLocalVar('[DrawIn]TriggerDist', 15)
+    mob:setLocalVar('[DrawIn]IncludeAlliance', 1)
     mob:setSpeed(baseSpeed)
     -- Failsafe to make sure NPC is down when NM is up
     if xi.settings.main.OLDSCHOOL_G2 then

sql/mob_pool_mods.sql

@@ -131,9 +131,6 @@ INSERT INTO `mob_pool_mods` VALUES (820,368,10,0); -- REGAIN: 10
 -- Darksteel Golem
 INSERT INTO `mob_pool_mods` VALUES (906,4,4,1); -- SIGHT_RANGE: 4
 
--- Dark Dragon
-INSERT INTO `mob_pool_mods` VALUES (912,12,25,1); -- DRAW_IN: 25
-
 -- Dea
 INSERT INTO `mob_pool_mods` VALUES (930,370,15,0); -- REGEN: 15
 

sql/mob_spawn_mods.sql

@@ -332,16 +332,11 @@ INSERT INTO `mob_spawn_mods` VALUES (17235987,2,2765,1); -- GIL_MAX: 2765
 INSERT INTO `mob_spawn_mods` VALUES (17236201,55,180,1); -- IDLE_DESPAWN: 180
 
 -- Boreal Hound
-INSERT INTO `mob_spawn_mods` VALUES (17236202,12,15,1);  -- DRAW_IN: 15
 INSERT INTO `mob_spawn_mods` VALUES (17236202,160,50,0); -- DMG: 50
 
 -- Boreal Coeurl
-INSERT INTO `mob_spawn_mods` VALUES (17236203,12,15,1);  -- DRAW_IN: 15
 INSERT INTO `mob_spawn_mods` VALUES (17236203,23,8,1);   -- IMMUNITY: 8
 
--- Boreal Tiger
-INSERT INTO `mob_spawn_mods` VALUES (17236204,12,15,1);  -- DRAW_IN: 15
-
 -- Koenigstiger
 INSERT INTO `mob_spawn_mods` VALUES (17236205,55,240,1); -- IDLE_DESPAWN: 240
 
@@ -399,9 +394,6 @@ INSERT INTO `mob_spawn_mods` VALUES (17285545,55,300,1); -- IDLE_DESPAWN: 300
 -- Kappa Biwa
 INSERT INTO `mob_spawn_mods` VALUES (17285546,55,150,1); -- IDLE_DESPAWN: 150
 
--- King Vinegarroon
-INSERT INTO `mob_spawn_mods` VALUES (17289575,12,15,1); -- DRAW_IN: 15
-
 -- Eastern Sphinx
 INSERT INTO `mob_spawn_mods` VALUES (17289654,55,168,1); -- IDLE_DESPAWN: 168
 
@@ -412,9 +404,6 @@ INSERT INTO `mob_spawn_mods` VALUES (17289655,55,168,1); -- IDLE_DESPAWN: 168
 INSERT INTO `mob_spawn_mods` VALUES (17293486,31,5,1); -- ROAM_DISTANCE: 5
 INSERT INTO `mob_spawn_mods` VALUES (17293486,51,1,1); -- ROAM_TURNS: 1
 
--- King Behemoth
-INSERT INTO `mob_spawn_mods` VALUES (17297441,12,25,1); -- DRAW_IN: 25
-
 -- Picklix Longindex
 INSERT INTO `mob_spawn_mods` VALUES (17297446,55,180,1); -- IDLE_DESPAWN: 180
 
@@ -827,9 +816,6 @@ INSERT INTO `mob_spawn_mods` VALUES (17404337,55,288,1); -- IDLE_DESPAWN: 288
 -- Beet Leafhopper
 INSERT INTO `mob_spawn_mods` VALUES (17404338,55,120,1); -- IDLE_DESPAWN: 120
 
--- Fafnir
-INSERT INTO `mob_spawn_mods` VALUES (17408018,12,20,1); -- DRAW_IN: 20
-
 -- Gerwitz'S Scythe
 INSERT INTO `mob_spawn_mods` VALUES (17420629,55,300,1); -- IDLE_DESPAWN: 300
 

src/map/ai/controllers/mob_controller.cpp

@@ -712,9 +712,9 @@ void CMobController::Move()
             // TODO: can this be moved to scripts entirely?
             if (PMob->getMobMod(MOBMOD_DRAW_IN) > 0)
             {
-                if (currentDistance >= PMob->GetMeleeRange() * 2 && battleutils::DrawIn(PTarget, PMob, PMob->GetMeleeRange() - 0.2f))
+                bool didDrawin = HandleDrawin(currentDistance);
+                if (didDrawin)
                 {
-                    FaceTarget();
                     return;
                 }
             }
@@ -1408,3 +1408,26 @@ bool CMobController::IsSpellReady(float currentDistance)
 
     return (m_Tick >= m_LastMagicTime + std::chrono::milliseconds(PMob->getBigMobMod(MOBMOD_MAGIC_COOL) - bonusTime));
 }
+
+bool CMobController::HandleDrawin(float currentDistance)
+{
+    // get specific draw-in settings that can be set on any given mob otherwise use default values
+    uint32 drawInTriggerDistance = PMob->GetLocalVar("[DrawIn]TriggerDist") > 0 ? PMob->GetLocalVar("[DrawIn]TriggerDist") : PMob->GetMeleeRange() * 2;
+    uint32 drawInMaxDistance     = PMob->GetLocalVar("[DrawIn]MaxDist") > 0 ? PMob->GetLocalVar("[DrawIn]MaxDist") : std::numeric_limits<int16>::max();
+    bool   includeAlliance       = PMob->GetLocalVar("[DrawIn]IncludeAlliance") > 0 ? true : false;
+    bool   toFrontOfMob          = PMob->GetLocalVar("[DrawIn]ToFrontOfMob") > 0 ? true : false;
+
+    bool didDrawin = false;
+
+    if (currentDistance >= drawInTriggerDistance)
+    {
+        bool didDrawin = battleutils::DrawIn(PTarget, PMob, PMob->GetMeleeRange() - 0.2f, drawInMaxDistance, includeAlliance, toFrontOfMob);
+
+        if (didDrawin)
+        {
+            FaceTarget();
+        }
+    }
+
+    return didDrawin;
+}

src/map/ai/controllers/mob_controller.h

@@ -83,6 +83,7 @@ class CMobController : public CController
     bool         CanMoveForward(float currentDistance);
     bool         IsSpecialSkillReady(float currentDistance);
     bool         IsSpellReady(float currentDistance);
+    bool         HandleDrawin(float currentDistance);
 
     CBattleEntity* PTarget{ nullptr };