(Completed) SAM OKC mod for FAF w/ download link

[Resin_Smoker]

2/20/2014 - completed work on the following:

Created mod folders, mod_info.lua and icon to identify FAF OKC
Unit Merg BP's for SAM launchers
Weapon.lua completed

Here is what the output of weapon.lua looks like...

Code: Select all

INFO: *** weapon.lua, GetDamageTable, Contents of damageTable to later pass to projectile***
INFO:         \000{
INFO:   Buffs={ },
INFO:   CollideFriendly=false,
INFO:   DamageAmount=100,
INFO:   DamageFriendly=true,
INFO:   DamageRadius=0,
INFO:   DamageType="Normal",
INFO:   Instigator={
INFO:     Army=1,
INFO:     Categories={
INFO:       "PRODUCTSC1",
INFO:       "SELECTABLE",
INFO:       "UEF",
INFO:       "MOBILE",
INFO:       "ECONOMIC",
INFO:       "COMMAND",
INFO:       "MASSPRODUCTION",
INFO:       "MASSFABRICATION",
INFO:       "ENERGYPRODUCTION",
INFO:       "REPAIR",
INFO:       "ENGINEER",
INFO:       "CONSTRUCTION",
INFO:       "RECLAIM",
INFO:       "CAPTURE",
INFO:       "DIRECTFIRE",
INFO:       "PODSTAGINGPLATFORM",
INFO:       "SILO",
INFO:       "VERIFYMISSILEUI",
INFO:       "LAND",
INFO:       "VISIBLETORECON",
INFO:       "PATROLHELPER",
INFO:       "SHOWQUEUE",
INFO:       "OVERLAYDIRECTFIRE",
INFO:       "OVERLAYINDIRECTFIRE",
INFO:       "OVERLAYOMNI",
INFO:       "OVERLAYDEFENSE"
INFO:     },
INFO:     Description="<LOC uel0001_desc>Armored Command Unit",
INFO:     EntityId="0",
INFO:     GameTime=20.200000762939,
INFO:     Location={ <metatable=table: 1D46F3E8> 148.5, 20.71044921875, 353.5 },
INFO:     UnitName=""
INFO:   },
INFO:   Target={
INFO:     Army=2,
INFO:     Categories={
INFO:       "PRODUCTSC1",
INFO:       "SELECTABLE",
INFO:       "BUILTBYTIER1FACTORY",
INFO:       "BUILTBYTIER2FACTORY",
INFO:       "BUILTBYTIER3FACTORY",
INFO:       "CYBRAN",
INFO:       "MOBILE",
INFO:       "LAND",
INFO:       "TECH1",
INFO:       "SCOUT",
INFO:       "INTELLIGENCE",
INFO:       "RADAR",
INFO:       "VISIBLETORECON",
INFO:       "RECLAIMABLE",
INFO:       "OVERLAYRADAR"
INFO:     },
INFO:     Description="<LOC url0101_desc>Land Scout",
INFO:     EntityId="1048584",
INFO:     Location={ <metatable=table: 1D46F3E8> 140.5, 20.69140625, 352.5 },
INFO:     UnitName="<LOC url0101_name>Mole"
INFO:   },
INFO:   Weapon={
INFO:     DisplayName="Zephyr Anti Matter Cannon",
INFO:     Label="RightZephyr",
INFO:     MaxRadius=22,
INFO:     MinRadius=1,
INFO:     MuzzleVelocity=35,
INFO:     NukeWeapon=false,
INFO:     OKC_Retargeting=false,
INFO:     ProjectileId="/projectiles/laserbotterran01/laserbotterran01_proj.bp",
INFO:     ProjectileLifetime=0,
INFO:     ProjectileLifetimeUsesMultiplier=2,
INFO:     TargetPriorities={
INFO:       "SPECIALHIGHPRI",
INFO:       "MOBILE",
INFO:       "STRUCTURE DEFENSE",
INFO:       "SPECIALLOWPRI",
INFO:       "ALLUNITS"
INFO:     }
INFO:   }
INFO: }

As you can see, i know everything required about the attacker, its projectile and the target in one little neat table!

Resin

[Nombringer]

......

<3


This would fix a lot of issues with T3 air, out of curiosity, how are you planning to do it?

[Resin_Smoker]

......

<3


This would fix a lot of issues with T3 air, out of curiosity, how are you planning to do it?

Have a look at General chat.

[Resin_Smoker]

Did some more work and I'd say I'm 1/2 way there (give or take)...

Here is what the Projectile.lua PassDamageData outputs...

Code: Select all

INFO: *** projectile.lua, PassDamageData ***
INFO:         Game time is: \00030.300001144409
INFO:         Passing extra data
INFO:         Adjusting for ProjectileLifetimeUsesMultiplier
INFO:         OKC_Retargeting: \000true
INFO:         OKC Projectile found, forking to "self.ProjHeartBeat"
INFO:         self.DamageData: \000{
INFO:   Buffs={ },
INFO:   CollideFriendly=false,
INFO:   DamageAmount=600,
INFO:   DamageFriendly=true,
INFO:   DamageRadius=0,
INFO:   DamageType="Normal",
INFO:   Instigator={
INFO:     Army=1,
INFO:     Brain={ <metatable=table: 28580DC0>
INFO:       AIPlansList={
INFO:         { "/lua/AI/aiarchetype-managerloader.lua" },
INFO:         { "/lua/AI/aiarchetype-managerloader.lua" },
INFO:         { "/lua/AI/aiarchetype-managerloader.lua" },
INFO:         { "/lua/AI/aiarchetype-managerloader.lua" }
INFO:       },
INFO:       AttackData={
INFO:         AMPlatoonCount={
INFO:           DefaultGroupAir=0,
INFO:           DefaultGroupLand=0,
INFO:           DefaultGroupSea=0
INFO:         },
INFO:         NeedSort=false
INFO:       },
INFO:       BrainType="Human",
INFO:       ConstantEval=true,
INFO:       DefaultPlan=true,
INFO:       EconStateUnits={ EnergyStorage={ }, MassStorage={ } },
INFO:       EconStorageTrigs={ },
INFO:       IgnoreArmyCaps=false,
INFO:       IntelTriggerList={ },
INFO:       Name="ARMY_1",
INFO:       Nickname="Resin_Smoker",
INFO:       PingCallbackList={ },
INFO:       RepeatExecution=false,
INFO:       Trash={ },
INFO:       TriggerList={ },
INFO:       UnitBuiltTriggerList={ },
INFO:       VOTable={ },
INFO:       VeterancyTriggerList={ },
INFO:       _c_object=userdata: CScriptObject* at 2E631588 = [CScriptObject at 0x2BDED6C0]
INFO:     },
INFO:     Categories={
INFO:       "PRODUCTFA",
INFO:       "SELECTABLE",
INFO:       "BUILTBYTIER3ENGINEER",
INFO:       "BUILTBYTIER3COMMANDER",
INFO:       "SERAPHIM",
INFO:       "STRUCTURE",
INFO:       "DEFENSE",
INFO:       "TECH3",
INFO:       "ANTIAIR",
INFO:       "DRAGBUILD",
INFO:       "SIZE4",
INFO:       "VISIBLETORECON",
INFO:       "RECLAIMABLE",
INFO:       "OVERLAYANTIAIR",
INFO:       "SORTDEFENSE"
INFO:     },
INFO:     Description="<LOC xsb2304_desc>Anti-Air Defense",
INFO:     EntityId="1",
INFO:     GameTime=30.300001144409,
INFO:     Location={ <metatable=table: 318DBA78> 197.5, 20.578125, 372.5 },
INFO:     UnitName="<LOC xsb2304_name>Iathu-ioz"
INFO:   },
INFO:   Target={
INFO:     Army=2,
INFO:     Categories={
INFO:       "PRODUCTFA",
INFO:       "SELECTABLE",
INFO:       "BUILTBYTIER1FACTORY",
INFO:       "BUILTBYTIER2FACTORY",
INFO:       "BUILTBYTIER3FACTORY",
INFO:       "SERAPHIM",
INFO:       "MOBILE",
INFO:       "AIR",
INFO:       "HIGHALTAIR",
INFO:       "TECH1",
INFO:       "INTELLIGENCE",
INFO:       "SCOUT",
INFO:       "VISIBLETORECON",
INFO:       "RECLAIMABLE"
INFO:     },
INFO:     Description="<LOC xsa0101_desc>Air Scout",
INFO:     EntityId="1048584",
INFO:     Location={ <metatable=table: 318DBA78> 203.5, 40.603515625, 373.5 },
INFO:     UnitName="<LOC xsa0101_name>Sele-istle"
INFO:   },
INFO:   Weapon={
INFO:     DisplayName="Losaare AA Autocannon",
INFO:     Label="AntiAirMissiles",
INFO:     MaxRadius=60,
INFO:     MinRadius=0,
INFO:     MuzzleVelocity=60,
INFO:     NukeWeapon=false,
INFO:     OKC_Retargeting=true,
INFO:     ProjectileId="/projectiles/saalosaareautocannon04/saalosaareautocannon04_proj.bp",
INFO:     ProjectileLifetime=5,
INFO:     ProjectileLifetimeUsesMultiplier=1.25,
INFO:     TargetPriorities={
INFO:       "SPECIALHIGHPRI",
INFO:       "AIR MOBILE HIGHPRIAIR",
INFO:       "AIR MOBILE TECH3 BOMBER",
INFO:       "AIR MOBILE BOMBER",
INFO:       "AIR MOBILE GROUNDATTACK",
INFO:       "AIR MOBILE TRANSPORTATION",
INFO:       "AIR MOBILE",
INFO:       "SPECIALLOWPRI",
INFO:       "ALLUNITS"
INFO:     }
INFO:   }
INFO: }

One thing I've done here is use the ProjectileLifetimeUsesMultiplier if it's present in the unit blueprint. What this does is act as a multi for what ever LifeTime is set within the projectiles blueprint. Hence if this is available it will override the standard ProjectileLifetime held in the unit blueprint weapons section.

In the above our sam has a weapon lifetime multi of "1.25" while the projectile blueprint shows "4"... (1.25 * 4 = 5)

This way i can use either the standard LifeTime of the weapon or the multi'd LifeTime of the projectile if it's available.

Here is the script:

Code: Select all

PassDamageData = function( self, damageData )
      local myDebug = true
      if myDebug or masterDebug then
         LOG('*** projectile.lua, PassDamageData ***')
         LOG('   Game time is: ', GetGameTimeSeconds() )         
      end      
      --> Run old first to ensure that data from weapon.lua is being passed into projectile DamageData
      oldProjectile.PassDamageData( self, damageData )
      --> Ensure that projectiles used as props or nukes dont trigger the passing of extra data
      if self.DamageData.DamageAmount > 1 and not self.damageData.Weapon.NukeWeapon then
         if myDebug or masterDebug then
            LOG('   Passing extra data')      
         end
         --> Pass extra data into self.DamageData      
         self.DamageData.Instigator = damageData.Instigator
         self.DamageData.Target = damageData.Target
         self.DamageData.Weapon = damageData.Weapon
           --> Use lifetime multiplier if avalible
           if self.DamageData.Weapon.ProjectileLifetimeUsesMultiplier > 0 then
            if myDebug or masterDebug then
               LOG('   Adjusting for ProjectileLifetimeUsesMultiplier')
            end            
              self.DamageData.Weapon.ProjectileLifetime = ( self.MyBP.Physics.Lifetime or self.DamageData.Weapon.ProjectileLifetime or 1 ) * ( self.DamageData.Weapon.ProjectileLifetimeUsesMultiplier or 1 )
           else
            if myDebug or masterDebug then
               LOG('   Using default self.DamageData.Weapon.ProjectileLifetime')
            end               
           end           
           --> Run OKC threads or bypass if its a normal projectile
           if self.DamageData and self.DamageData.Weapon.OKC_Retargeting then
            if myDebug or masterDebug then       
                 LOG('   OKC_Retargeting: ', repr( self.DamageData.Weapon.OKC_Retargeting ) )
                 LOG('   OKC Projectile found, forking to "self.ProjHeartBeat" ')
              end               
             --> Kick off main OKC thread
             --self:ForkThread( self.ProjHeartBeat )
           else
            if myDebug or masterDebug then       
                 LOG('   OKC_Retargeting: ', repr( self.DamageData.Weapon.OKC_Retargeting ) )
                 LOG('   Normal projectile, bypassing fork')              
              end
           end                                 
      else
         if myDebug or masterDebug then
            LOG('   Prop or nuke projectile detected, aborting extra data pass')   
         end         
      end            
      if myDebug or masterDebug then
         LOG('   self.DamageData: ', repr( self.DamageData ) )   
      end
   end,

One last thing... Notice how I've also included the data from the AI brain !!!!

Resin

[IceDreamer]

What does the data from the AI Brain mean/change/do?

[Resin_Smoker]

What does the data from the AI Brain mean/change/do?

I can use AI functions to search all enemies in range of a particular type. This is very fast and easier to script than other methods.

Resin

[Resin_Smoker]

Here is what the missile's heart beat looks like but keep in mind that re-targeting isn't enabled yet. Doing that next!

Code: Select all

INFO: *** FAF_OKC projectile.lua, OKC_HeartBeat ***
INFO:         Projectile ID: \000268435457
INFO:         Game time is: \00033.5
INFO: *************************************
INFO:         "OKC_HeartBeat, while-loop-do"
INFO:         Projectile ID: \000268435457
INFO:         Game time is: \00033.5
INFO:         Tracking a target
INFO:         Game time is: \00033.5
INFO:         target.IncommingDamage NOT set, creating it now, including amount of incomming damage
INFO:         self.DamageData.Damage amount is: \000200
INFO:         Game time is: \00033.5
INFO:         self.LifeCounter = \0001
INFO:         Game time is: \00033.5
INFO: *** FAF_OKC projectile.lua, OKC_HeartBeat ***
INFO:         Projectile ID: \000268435458
INFO:         Game time is: \00033.600002288818
INFO: *************************************
INFO:         "OKC_HeartBeat, while-loop-do"
INFO:         Projectile ID: \000268435458
INFO:         Game time is: \00033.600002288818
INFO:         Tracking a target
INFO:         Game time is: \00033.600002288818
INFO:         target.IncommingDamage set, target.IncommingDamage >= target:GetHealth(), self.RetargetFlag is: \000false\000     calling self.OKC_Retargeting
INFO:         self.DamageData.Damage amount is:\000200
INFO:         Game time is: \00033.600002288818
INFO:         self.LifeCounter = \0001
INFO:         Game time is: \00033.600002288818
INFO: *** FAF_OKC projectile.lua, OKC_HeartBeat ***
INFO:         Projectile ID: \000268435459
INFO:         Game time is: \00033.700000762939
INFO: *************************************
INFO:         "OKC_HeartBeat, while-loop-do"
INFO:         Projectile ID: \000268435459
INFO:         Game time is: \00033.700000762939
INFO:         Tracking a target
INFO:         Game time is: \00033.700000762939
INFO:         target.IncommingDamage set, target.IncommingDamage >= target:GetHealth(), self.RetargetFlag is: \000false\000     calling self.OKC_Retargeting
INFO:         self.DamageData.Damage amount is:\000200
INFO:         Game time is: \00033.700000762939
INFO:         self.LifeCounter = \0001
INFO:         Game time is: \00033.700000762939
INFO: *** FAF_OKC projectile.lua, OKC_HeartBeat ***
INFO:         Projectile ID: \000268435460
INFO:         Game time is: \00033.799999237061
INFO: *************************************
INFO:         "OKC_HeartBeat, while-loop-do"
INFO:         Projectile ID: \000268435460
INFO:         Game time is: \00033.799999237061
INFO:         Tracking a target
INFO:         Game time is: \00033.799999237061
INFO:         target.IncommingDamage set, target.IncommingDamage >= target:GetHealth(), self.RetargetFlag is: \000false\000     calling self.OKC_Retargeting
INFO:         self.DamageData.Damage amount is:\000200
INFO:         Game time is: \00033.799999237061
INFO:         self.LifeCounter = \0001
INFO:         Game time is: \00033.799999237061
INFO: *** FAF_OKC projectile.lua, OKC_HeartBeat ***
INFO:         Projectile ID: \000268435461
INFO:         Game time is: \00033.900001525879
INFO: *************************************
INFO:         "OKC_HeartBeat, while-loop-do"
INFO:         Projectile ID: \000268435461
INFO:         Game time is: \00033.900001525879
INFO:         Tracking a target
INFO:         Game time is: \00033.900001525879
INFO:         target.IncommingDamage set, target.IncommingDamage >= target:GetHealth(), self.RetargetFlag is: \000false\000     calling self.OKC_Retargeting
INFO:         self.DamageData.Damage amount is:\000200
INFO:         Game time is: \00033.900001525879
INFO:         self.LifeCounter = \0001
INFO:         Game time is: \00033.900001525879
INFO: *** FAF_OKC projectile.lua, OKC_HeartBeat ***
INFO:         Projectile ID: \000268435462
INFO:         Game time is: \00034
INFO: *************************************
INFO:         "OKC_HeartBeat, while-loop-do"
INFO:         Projectile ID: \000268435462
INFO:         Game time is: \00034
INFO:         Tracking a target
INFO:         Game time is: \00034
INFO:         target.IncommingDamage set, target.IncommingDamage >= target:GetHealth(), self.RetargetFlag is: \000false\000     calling self.OKC_Retargeting
INFO:         self.DamageData.Damage amount is:\000200
INFO:         Game time is: \00034
INFO:         self.LifeCounter = \0001
INFO:         Game time is: \00034
INFO:         "OKC_HeartBeat, while-loop-do"
INFO:         Projectile ID: \000268435457
INFO:         Game time is: \00034.400001525879
INFO:         Tracking a target
INFO:         Game time is: \00034.400001525879
INFO:         self.LifeCounter = \0002
INFO:         Game time is: \00034.400001525879
INFO:         "OKC_HeartBeat, while-loop-do"
INFO:         Projectile ID: \000268435458
INFO:         Game time is: \00034.5
INFO:         self.LifeCounter = \0002
INFO:         Game time is: \00034.5
INFO:         "OKC_HeartBeat, while-loop-do"
INFO:         Projectile ID: \000268435459
INFO:         Game time is: \00034.600002288818
INFO:         self.LifeCounter = \0002
INFO:         Game time is: \00034.600002288818
INFO:         "OKC_HeartBeat, while-loop-do"
INFO:         Projectile ID: \000268435460
INFO:         Game time is: \00034.700000762939
INFO:         self.LifeCounter = \0002
INFO:         Game time is: \00034.700000762939
INFO:         "OKC_HeartBeat, while-loop-do"
INFO:         Projectile ID: \000268435461
INFO:         Game time is: \00034.799999237061
INFO:         self.LifeCounter = \0002
INFO:         Game time is: \00034.799999237061
INFO: *** FAF_OKC projectile.lua, OnImpact ***
INFO:         Projectile ID: \000268435457
INFO:         Game time is: \00034.799999237061
INFO:         targetType: \000UnitAir
INFO:         targetEntity: \000table: 31CCD5A0
INFO: *************************************
INFO:         "OKC_HeartBeat, while-loop-do"
INFO:         Projectile ID: \000268435462
INFO:         Game time is: \00034.900001525879
INFO:         self.LifeCounter = \0002
INFO:         Game time is: \00034.900001525879
INFO: *** FAF_OKC projectile.lua, OnImpact ***
INFO:         Projectile ID: \000268435456
INFO:         Game time is: \00035.100002288818
INFO:         targetType: \000Air
INFO:         targetEntity: \000nil
INFO: *************************************
INFO:         "OKC_HeartBeat, while-loop-do"
INFO:         Projectile ID: \000268435458
INFO:         Game time is: \00035.400001525879
INFO:         self.LifeCounter = \0003
INFO:         Game time is: \00035.400001525879
INFO:         "OKC_HeartBeat, while-loop-do"
INFO:         Projectile ID: \000268435459
INFO:         Game time is: \00035.5
INFO:         self.LifeCounter = \0003
INFO:         Game time is: \00035.5
INFO:         "OKC_HeartBeat, while-loop-do"
INFO:         Projectile ID: \000268435460
INFO:         Game time is: \00035.600002288818
INFO:         self.LifeCounter = \0003
INFO:         Game time is: \00035.600002288818
INFO: *** FAF_OKC projectile.lua, OnImpact ***
INFO:         Projectile ID: \000268435458
INFO:         Game time is: \00035.600002288818
INFO:         targetType: \000Air
INFO:         targetEntity: \000nil
INFO: *************************************
INFO: *** FAF_OKC projectile.lua, OnImpact ***
INFO:         Projectile ID: \000268435459
INFO:         Game time is: \00035.600002288818
INFO:         targetType: \000Air
INFO:         targetEntity: \000nil
INFO: *************************************
INFO: *** FAF_OKC projectile.lua, OnImpact ***
INFO:         Projectile ID: \000268435460
INFO:         Game time is: \00035.600002288818
INFO:         targetType: \000Air
INFO:         targetEntity: \000nil
INFO: *************************************
INFO: *** FAF_OKC projectile.lua, OnImpact ***
INFO:         Projectile ID: \000268435461
INFO:         Game time is: \00035.600002288818
INFO:         targetType: \000Air
INFO:         targetEntity: \000nil
INFO: *************************************
INFO: *** FAF_OKC projectile.lua, OnImpact ***
INFO:         Projectile ID: \000268435462
INFO:         Game time is: \00035.600002288818
INFO:         targetType: \000Air
INFO:         targetEntity: \000nil
INFO: *************************************
INFO: *** FAF_OKC projectile.lua, OnImpact ***
INFO:         Projectile ID: \000269484033
INFO:         Game time is: \00043.799999237061
INFO:         targetType: \000Terrain
INFO:         targetEntity: \000nil
INFO: *************************************
INFO: *** FAF_OKC projectile.lua, OnImpact ***
INFO:         Projectile ID: \000269484032
INFO:         Game time is: \00045.100002288818
INFO:         targetType: \000Terrain
INFO:         targetEntity: \000nil
INFO: *************************************


[Resin_Smoker]

Got it working !!!!

FAF OKC, Public Release (v0.1) download link http://www.mediafire.com/download/bh3df ... AF_OKC.rar

I've also uploaded this to the mod vault!

Only play tested this lightly and just so you know this doesn't work for the Sera as their T3 launcher is direct fire and does not use tracking missiles. Instead I gave them a 0.25 damage radius so they can hit multiple units that are stacked in a small location.

Resin

[Nombringer]

Sweet, Ill test this out as soon as I can

[Resin_Smoker]

Sweet, Ill test this out as soon as I can

Awesome!

After more play testing I've discovered that some SAM's are much better then others.

Here are my rankings:

UEF: Tracking weapon. Low damage, 6 projectiles, fast firing rate, OKC effect is profound, totally shredds masses of small fighters.

CYBRAN: tracking weapon, med damage, 4 projectiles, med firing rate, OKC effect is very noticeable, very good vs small / med fighters.

AEON: Tracking weapon, med damage, 2 projectiles, med firing rate, OKC effects is good, strong vs med / large fighters.

SERAPHIM: Direct fire weapon that's high damage, slow firing, with slow projectile speed. Updating the firing priorities could help as would allowing the projectile to detonate like a flack weapon.

Resin