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

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

@@ -94 +94 @@
             "<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'>" +
@@ -177 +185 @@
                 Attack.prototype.restrictedClassesSchema +
             "</interleave>" +
         "</element>" +
+    "</optional>" +
+    "<optional>" +
+        "<element name='Death' a:help='When a unit dies it inflicts damage on nearby units.'>" +
+            "<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.preferredClassesSchema +
+                Attack.prototype.restrictedClassesSchema +
+            "</interleave>" +
+        "</element>" +
     "</optional>";
 
 Attack.prototype.Init = function()
@@ -545 +568 @@
         };
         if (this.template.Ranged.Splash)
         {
-            data.friendlyFire = this.template.Ranged.Splash.FriendlyFire;
+            data.friendlyFire = this.template.Ranged.Splash.FriendlyFire != "false";
             data.radius = +this.template.Ranged.Splash.Range;
             data.shape = this.template.Ranged.Splash.Shape;
             data.isSplash = true;
@@ -605 +628 @@
         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

@@ -62 +62 @@
 };
 
 /**
+ * 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)
+{
+    var playersToDamage = [];
+    if (!friendlyFire)
+        playersToDamage = QueryPlayerIDInterface(attackerOwner).GetEnemies();
+    else
+    {
+        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.
@@ -87 +106 @@
     // Do this first in case the direct hit kills the target
     if (data.isSplash)
     {
-        let playersToDamage = !data.friendlyFire ? QueryPlayerIDInterface(data.attackerOwner).GetEnemies() : null;
+        let playersToDamage = this.GetPlayersToDamage(data.friendlyFire, data.attackerOwner);
 
         this.CauseSplashDamage({
             "attacker": data.attacker,
@@ -148 +167 @@
  * @param {string}   data.type - the type of damage.
  * @param {number}   data.attackerOwner - the player id of the attacker.
  * @param {Vector3D} data.direction - the unit vector defining the direction.
- * @param {number[]} [data.playersToDamage] - the array of player id's to damage.
+ * @param {number[]} data.playersToDamage - the array of player id's to damage.
  */
 Damage.prototype.CauseSplashDamage = function(data)
 {

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/templates/template_unit_infantry_ranged_slinger.xml

@@ -16 +16 @@
       <RepeatTime>1000</RepeatTime>
       <Spread>1.4</Spread>
     </Ranged>
+    <Death>
+      <Shape>Circular</Shape>
+      <Range>15</Range>
+      <FriendlyFire>true</FriendlyFire>
+      <Hack>50.0</Hack>
+      <Pierce>60.0</Pierce>
+      <Crush>70.0</Crush>
+    </Death>
   </Attack>
   <Cost>
     <Resources>