Ticket #1910: 1910-death-damage-4.patch

binaries/data/mods/public/globalscripts/Templates.js

@@ -137 +137 @@
                     // true if undefined
                     "friendlyFire": template.Attack[type].Splash.FriendlyFire != "false"
                 };
+
+            if (type == "Death")
+                ret.attack.Death = {
+                    "hack": getAttackStat("Hack"),
+                    "pierce": getAttackStat("Pierce"),
+                    "crush": getAttackStat("Crush"),
+                    // true if undefined
+                    "friendlyFire": template.Attack.Death.FriendlyFire != "false"
+                };
         }
     }
 

binaries/data/mods/public/gui/common/tooltips.js

@@ -8 +8 @@
 const g_AttackTypes = {
     "Melee": translate("Melee Attack:"),
     "Ranged": translate("Ranged Attack:"),
-    "Capture": translate("Capture Attack:")
+    "Capture": translate("Capture Attack:"),
+    "Death": translate("Damage on Destroy:")
 };
 
 const g_DamageTypes = {
@@ -141 +142 @@
     let attacks = [];
     for (let type in template.attack)
     {
+        if (type == "Death") {
+            attacks.push(sprintf(translate("%(label)s %(details)s Friendly Fire: %(enabled)s"), {
+                "label": headerFont(g_AttackTypes[type]),
+                "details": damageTypesToText(template.attack.Death),
+                "enabled": template.attack.Death.friendlyFire ? translate("Yes") : translate("No")
+            }));
+            continue;
+        }
+
         if (type == "Slaughter")
             continue; // Slaughter is used to kill animals, so do not show it.
 

binaries/data/mods/public/simulation/components/Attack.js

@@ -37 +37 @@
             "<text/>" +
         "</element>" +
     "</optional>";
+    
+Attack.prototype.splashSchema = "<interleave>" +
+                "<element name='Shape' a:help='Shape of the splash damage, can be circular or linear'><text/></element>" +
+                "<element name='Range' a:help='Size of the area affected by the splash'><ref name='nonNegativeDecimal'/></element>" +
+                "<element name='FriendlyFire' a:help='Whether the splash damage can hurt non enemy units'><data type='boolean'/></element>" +
+                "<element name='Hack' a:help='Hack damage strength'><ref name='nonNegativeDecimal'/></element>" +
+                "<element name='Pierce' a:help='Pierce damage strength'><ref name='nonNegativeDecimal'/></element>" +
+                "<element name='Crush' a:help='Crush damage strength'><ref name='nonNegativeDecimal'/></element>" +
+                Attack.prototype.bonusesSchema +
+            "</interleave>";
 
 Attack.prototype.Schema =
     "<a:help>Controls the attack abilities and strengths of the unit.</a:help>" +
@@ -94 +104 @@
             "<Crush>0.0</Crush>" +
             "<MaxRange>4.0</MaxRange>" +
         "</Slaughter>" +
+        "<Death>" +
+            "<Shape>Circular</Shape>" +
+            "<Range>20</Range>" +
+            "<FriendlyFire>false</FriendlyFire>" +
+            "<Hack>0.0</Hack>" +
+            "<Pierce>10.0</Pierce>" +
+            "<Crush>50.0</Crush>" +
+        "</Death>" +
     "</a:example>" +
     "<optional>" +
         "<element name='Melee'>" +
@@ -138 +156 @@
                 "<optional>" +
                     "<element name='Splash'>" +
                         "<interleave>" +
-                            "<element name='Shape' a:help='Shape of the splash damage, can be circular or linear'><text/></element>" +
-                            "<element name='Range' a:help='Size of the area affected by the splash'><ref name='nonNegativeDecimal'/></element>" +
-                            "<element name='FriendlyFire' a:help='Whether the splash damage can hurt non enemy units'><data type='boolean'/></element>" +
-                            "<element name='Hack' a:help='Hack damage strength'><ref name='nonNegativeDecimal'/></element>" +
-                            "<element name='Pierce' a:help='Pierce damage strength'><ref name='nonNegativeDecimal'/></element>" +
-                            "<element name='Crush' a:help='Crush damage strength'><ref name='nonNegativeDecimal'/></element>" +
-                            Attack.prototype.bonusesSchema +
+                            Attack.prototype.splashSchema +
                         "</interleave>" +
                     "</element>" +
                 "</optional>" +
@@ -177 +189 @@
                 Attack.prototype.restrictedClassesSchema +
             "</interleave>" +
         "</element>" +
+    "</optional>" +
+    "<optional>" +
+        "<element name='Death' a:help='When a unit or building is detroyed then it inflicts damage to nearby units.'>" +
+            Attack.prototype.splashSchema +
+        "</element>" +
     "</optional>";
 
 Attack.prototype.Init = function()
@@ -606 +623 @@
         cmpUnitAI.UpdateRangeQueries();
 };
 
+Attack.prototype.CauseDeathDamage = function()
+{
+    if (!this.template.Death)
+        return;
+
+    let cmpPosition = Engine.QueryInterface(this.entity, IID_Position);
+    if (!cmpPosition.IsInWorld())
+        return;
+
+    let pos = cmpPosition.GetPosition();
+    let cmpDamage = Engine.QueryInterface(SYSTEM_ENTITY, IID_Damage);
+    let owner = Engine.QueryInterface(this.entity, IID_Ownership).GetOwner();
+    let playersToDamage = cmpDamage.GetPlayersToDamage(this.template.Death.FriendlyFire, owner);
+
+    cmpDamage.CauseSplashDamage({
+        "attacker": this.entity,
+        "origin": Vector2D.from3D(pos),
+        "radius": this.template.Death.Range,
+        "shape": this.template.Death.Shape,
+        "strengths": this.GetAttackStrengths("Death"),
+        "direction": 0, //does directed death damage make sense? 
+        "playersToDamage": playersToDamage,
+        "type": this.template.Type,
+        "attackerOwner": owner
+    });
+};
+
 Engine.RegisterComponentType(IID_Attack, "Attack", Attack);

binaries/data/mods/public/simulation/components/Damage.js

@@ -65 +65 @@
 };
 
 /**
+ * Get the list of players affected by the damage.
+ * @param {boolean} friendlyFire - a flag indicating if allied entities are also damaged.
+ * @param {number}  attackerOwner - the player id of the attacker.
+ */
+Damage.prototype.GetPlayersToDamage = function(friendlyFire, attackerOwner)
+{
+    if (!friendlyFire)
+        return QueryPlayerIDInterface(attackerOwner).GetEnemies();
+
+    var playersToDamage = [];
+    let numPlayers = Engine.QueryInterface(SYSTEM_ENTITY, IID_PlayerManager).GetNumPlayers();
+    for (let i = 0; i < numPlayers; ++i)
+        playersToDamage.push(i);
+
+    return playersToDamage;
+}
+
+/**
  * Handles hit logic after the projectile travel time has passed.
  * @param {Object}   data - the data sent by the caller.
  * @param {number}   data.attacker - the entity id of the attacker.
@@ -90 +108 @@
     // Do this first in case the direct hit kills the target
     if (data.isSplash)
     {
-        let playersToDamage = [];
-        if (!data.friendlyFire)
-            playersToDamage = QueryPlayerIDInterface(data.attackerOwner).GetEnemies();
-        else
-        {
-            let numPlayers = Engine.QueryInterface(SYSTEM_ENTITY, IID_PlayerManager).GetNumPlayers();
-            for (let i = 0; i < numPlayers; ++i)
-                playersToDamage.push(i);
-        }
+        let playersToDamage = this.GetPlayersToDamage(data.friendlyFire, data.attackerOwner);
 
         this.CauseSplashDamage({
             "attacker": data.attacker,

binaries/data/mods/public/simulation/components/Health.js

@@ -244 +244 @@
 
             this.hitpoints = 0;
             this.RegisterHealthChanged(oldHitpoints);
+
+            let cmpAttack = Engine.QueryInterface(this.entity, IID_Attack);
+            if (cmpAttack)
+                cmpAttack.CauseDeathDamage();
         }
 
     }

binaries/data/mods/public/simulation/components/tests/test_Attack.js

@@ -6 +6 @@
 Engine.LoadComponentScript("interfaces/TechnologyManager.js");
 Engine.LoadComponentScript("interfaces/Formation.js");
 Engine.LoadComponentScript("interfaces/Attack.js");
+Engine.LoadComponentScript("interfaces/Damage.js");
+Engine.LoadComponentScript("interfaces/Timer.js");
 Engine.LoadComponentScript("Attack.js");
+Engine.LoadComponentScript("Timer.js");
 
 let entityID = 903;
+let cmpTimer = ConstructComponent(SYSTEM_ENTITY, "Timer");
 
 function attackComponentTest(defenderClass, test_function)
 {
@@ -30 +34 @@
 
     AddMock(attacker, IID_Position, {
         "IsInWorld": () => true,
-        "GetHeightOffset": () => 5
+        "GetHeightOffset": () => 5,
+        "GetPosition": () => new Vector3D(1, 2, 3)
     });
 
     AddMock(attacker, IID_Ownership, {
@@ -66 +71 @@
             "MaxRange": 80,
             "PrepareTime": 300,
             "RepeatTime": 500,
+            "ProjectileSpeed": 50,
+            "Spread": 2.5,
             "PreferredClasses": {
                 "_string": "Archer"
             },
             "RestrictedClasses": {
                 "_string": "Elephant"
+            },
+            "Splash" : {
+                "Shape": "Circular",
+                "Range": 10,
+                "FriendlyFire": "false",
+                "Hack": 0.0,
+                "Pierce": 15.0,
+                "Crush": 35.0
             }
         },
         "Capture" : {
@@ -77 +92 @@
             "Value": 8,
             "MaxRange": 10,
         },
-        "Slaughter": {}
+        "Slaughter": {},
+        "Death": {
+            "Shape": "Circular",
+            "Range": 20,
+            "FriendlyFire": false,
+            "Hack": 0.0,
+            "Pierce": 10.0,
+            "Crush": 50.0
+        }
     });
 
     let defender = ++entityID;
@@ -119 +142 @@
         "prepare": 0,
         "repeat": 1000
     });
+
+    TS_ASSERT_UNEVAL_EQUALS(cmpAttack.GetSplashDamage("Ranged"), {hack: 0, pierce: 15, crush: 35, friendlyFire: false});
 });
 
 for (let className of ["Infantry", "Cavalry"])
@@ -161 +186 @@
 testGetBestAttackAgainst("Archer", "Ranged");
 testGetBestAttackAgainst("Domestic", "Slaughter");
 testGetBestAttackAgainst("Structure", "Capture", true);
+
+attackComponentTest(undefined, (attacker, cmpAttack, defender) => {
+
+    var causeSplashDamageArg = "";
+
+    AddMock(SYSTEM_ENTITY, IID_Damage, {
+        "CauseDamage": () => false, 
+        "SetTimeout": () => false,
+        "GetPlayersToDamage": () => [1, 2],
+        "CauseSplashDamage": function (arg) { causeSplashDamageArg = arg; }
+    });
+
+    cmpAttack.CauseDeathDamage();
+
+    TS_ASSERT_UNEVAL_EQUALS(causeSplashDamageArg, {
+        attacker: attacker,
+        origin: {x:1, y:3},
+        radius: 20,
+        shape: "Circular",
+        strengths: {hack:0, pierce:10, crush:50},
+        direction: 0,
+        playersToDamage: [1, 2],
+        type: void(0),
+        attackerOwner: 1
+    });
+});

binaries/data/mods/public/simulation/components/tests/test_Damage.js

@@ -53 +53 @@
 
 AddMock(SYSTEM_ENTITY, IID_PlayerManager, {
     GetPlayerByID: (id) => atkPlayerEntity,
+    GetNumPlayers: () => 4
 });
 
 AddMock(SYSTEM_ENTITY, IID_RangeManager, { 
@@ -122 +123 @@
 cmpAttack.PerformAttack("Ranged", target);
 Engine.DestroyEntity(attacker);
 TestDamage();
+
+atkPlayerEntity = 1;
+AddMock(atkPlayerEntity, IID_Player, {
+    GetEnemies: () => [2, 3],
+});
+TS_ASSERT_UNEVAL_EQUALS(cmpDamage.GetPlayersToDamage(true, atkPlayerEntity), [0, 1, 2, 3]);
+TS_ASSERT_UNEVAL_EQUALS(cmpDamage.GetPlayersToDamage(false, atkPlayerEntity), [2, 3]);

binaries/data/mods/public/simulation/templates/template_structure_civic_civil_centre.xml

@@ -26 +26 @@
       <Spread>1.5</Spread>
       <PreferredClasses datatype="tokens">Human</PreferredClasses>
     </Ranged>
+    <Death>
+      <Shape>Circular</Shape>
+      <Range>15</Range>
+      <FriendlyFire>true</FriendlyFire>
+      <Hack>50.0</Hack>
+      <Pierce>60.0</Pierce>
+      <Crush>170.0</Crush>
+    </Death>
   </Attack>
   <BuildingAI>
     <DefaultArrowCount>3</DefaultArrowCount>

binaries/data/mods/public/simulation/templates/template_structure_military_fortress.xml

@@ -18 +18 @@
       <Spread>1.5</Spread>
       <PreferredClasses datatype="tokens">Human</PreferredClasses>
     </Ranged>
+    <Death>
+      <Shape>Circular</Shape>
+      <Range>15</Range>
+      <FriendlyFire>true</FriendlyFire>
+      <Hack>0.0</Hack>
+      <Pierce>0.0</Pierce>
+      <Crush>270.0</Crush>
+    </Death>
   </Attack>
   <BuildingAI>
     <DefaultArrowCount>3</DefaultArrowCount>