Track body parts shot and side of unit shot

Author: Shoes01

bin/data/Ruleset/Commendations.rul

@@ -289,6 +289,8 @@ extraStrings:
      STR_MEDAL_NIKE_CROSS_DESCRIPTION: "Given to a soldier who single handedly killed every alien in a mission."
      STR_MEDAL_MERCY_CROSS_NAME: "Mercy Cross"
      STR_MEDAL_MERCY_CROSS_DESCRIPTION: "Given to a soldier who single handedly stunned every alien in a mission."
+     STR_MEDAL_HEADSHOT_NAME: "Head Hunter"
+     STR_MEDAL_HEADSHOT_DESCRIPTION: "Given to a soldier with a steady hand who has landed multiple headshots."
      STR_AWARD_0: "First award"
      STR_AWARD_1: "Second award"
      STR_AWARD_2: "Third award"
@@ -427,8 +429,10 @@ extraStrings:
      STR_MEDAL_ALIEN_BASE_ASSAULT_DESCRIPTION: "Given to a soldier who has been part of a successful alien base assault mission."
      STR_MEDAL_NIKE_CROSS_NAME: "Nike Cross"
      STR_MEDAL_NIKE_CROSS_DESCRIPTION: "Given to a soldier who single handedly killed every alien in a mission."
-     STR_MEDAL_MERCY_CROSS_NAME: "Nike Cross"
-     STR_MEDAL_MERCY_CROSS_DESCRIPTION: "Given to a soldier who single handedly killed every alien in a mission."
+     STR_MEDAL_MERCY_CROSS_NAME: "Mercy Cross"
+     STR_MEDAL_MERCY_CROSS_DESCRIPTION: "Given to a soldier who single handedly stunned every alien in a mission."
+     STR_MEDAL_HEADSHOT_NAME: "Head Hunter"
+     STR_MEDAL_HEADSHOT_DESCRIPTION: "Given to a soldier with a steady hand who has landed multiple headshots."
      STR_AWARD_0: "First award"
      STR_AWARD_1: "Second award"
      STR_AWARD_2: "Third award"
@@ -931,6 +935,7 @@ extraStrings:
 #   totalValientCrux
 #   totalTrapKills
 #   isDead
+#   totalHeadShots
 # The following criteria use a hardcoded noun for the name/description.
 # They are INCOMPATIBLE with eachother. If used together,
 # the commendation will be given out repeatedly.
@@ -1159,6 +1164,11 @@ commendations:
     sprite: 32
     criteria:
       totalAllAliensStunned: [1, 1, 2, 2, 2, 2, 3, 3, 3, 3]
+  - type: STR_MEDAL_HEADSHOT_NAME
+    description: STR_MEDAL_HEADSHOT_DESCRIPTION
+    sprite: 32
+    criteria:
+      totalHeadShots: [3, 6, 9, 9, 9, 9, 12, 12, 12, 12]
 ufopaedia:
   - id: STR_MEDAL_MILITARY_CROSS_NAME
     type_id: 7
@@ -1398,6 +1408,13 @@ ufopaedia:
     text: STR_MEDAL_MERCY_CROSS_MEDAL_UFOPEDIA
     text_width: 164
     listOrder: 6033  
+  - id: STR_MEDAL_HEADSHOT_NAME
+    type_id: 7
+    section: STR_HEAVY_WEAPONS_PLATFORMS
+    image_id: NIKE_CROSS
+    text: STR_MEDAL_HEADSHOT_MEDAL_UFOPEDIA
+    text_width: 164
+    listOrder: 6033  
 # entries below move the HWPs to the Craft Section of the UFOPedia
   - id: STR_TANK_CANNON
     section: STR_XCOM_CRAFT_ARMAMENT

src/Battlescape/BattlescapeGame.cpp

@@ -656,7 +656,7 @@ void BattlescapeGame::checkForCasualties(BattleItem *murderweapon, BattleUnit *m
 			{
 				if (murderer->getGeoscapeSoldier() && murderer->getFaction() == FACTION_PLAYER)
 				{
-					murderer->getStatistics()->kills.push_back(new BattleUnitKills(killStatRank, killStatRace, killStatWeapon, killStatWeaponAmmo, victim->getFaction(), STATUS_DEAD, killStatMission, killStatTurn ));
+					murderer->getStatistics()->kills.push_back(new BattleUnitKills(killStatRank, killStatRace, killStatWeapon, killStatWeaponAmmo, victim->getFaction(), STATUS_DEAD, killStatMission, killStatTurn, victim->getFatalShotSide(), victim->getFatalShotBodyPart() ));
 					victim->setMurdererId(murderer->getId());
 				}
 				murderer->addKillCount();
@@ -745,7 +745,7 @@ void BattlescapeGame::checkForCasualties(BattleItem *murderweapon, BattleUnit *m
 		{
 			if (murderer && murderer->getGeoscapeSoldier() && murderer->getFaction() == FACTION_PLAYER) 
 			{
-                    murderer->getStatistics()->kills.push_back(new BattleUnitKills(killStatRank, killStatRace, killStatWeapon, killStatWeaponAmmo, victim->getFaction(), STATUS_UNCONSCIOUS, killStatMission, killStatTurn ));
+                    murderer->getStatistics()->kills.push_back(new BattleUnitKills(killStatRank, killStatRace, killStatWeapon, killStatWeaponAmmo, victim->getFaction(), STATUS_UNCONSCIOUS, killStatMission, killStatTurn, victim->getFatalShotSide(), victim->getFatalShotBodyPart() ));
 			}
 			if (victim && victim->getGeoscapeSoldier())
 			{

src/Savegame/BattleUnit.cpp

@@ -57,7 +57,7 @@ BattleUnit::BattleUnit(Soldier *soldier, int depth) :
 	_expBravery(0), _expReactions(0), _expFiring(0), _expThrowing(0), _expPsiSkill(0), _expPsiStrength(0), _expMelee(0),
 	_motionPoints(0), _kills(0), _hitByFire(false), _moraleRestored(0), _coverReserve(0), _charging(0),
 	_turnsSinceSpotted(255), _geoscapeSoldier(soldier), _unitRules(0), _rankInt(-1), _turretType(-1), _hidingForTurn(false), _respawn(false),
-    _statistics(), _murdererId(0)
+    _statistics(), _murdererId(0), _fatalShotSide(SIDE_FRONT), _fatalShotBodyPart(BODYPART_HEAD)
 {
 	_name = soldier->getName(true);
 	_id = soldier->getId();
@@ -149,7 +149,8 @@ BattleUnit::BattleUnit(Unit *unit, UnitFaction faction, int id, Armor *armor, in
 	_expThrowing(0), _expPsiSkill(0), _expPsiStrength(0), _expMelee(0), _motionPoints(0), _kills(0), _hitByFire(false),
 	_moraleRestored(0), _coverReserve(0), _charging(0), _turnsSinceSpotted(255),
 	_armor(armor), _geoscapeSoldier(0),  _unitRules(unit), _rankInt(-1),
-	_turretType(-1), _hidingForTurn(false), _respawn(false), _statistics(), _murdererId(0)
+	_turretType(-1), _hidingForTurn(false), _respawn(false), _statistics(), _murdererId(0),
+    _fatalShotSide(SIDE_FRONT), _fatalShotBodyPart(BODYPART_HEAD)
 {
 	_type = unit->getType();
 	_rank = unit->getRank();
@@ -1070,6 +1071,8 @@ int BattleUnit::damage(const Position &relative, int power, ItemDamageType type,
 		}
 	}
 
+    setFatalShotInfo(side, bodypart);
+
 	return power < 0 ? 0:power;
 }
 
@@ -2973,4 +2976,32 @@ int BattleUnit::getMurdererId() const
 	return _murdererId;
 }
 
+/**
+ * Set information on the unit's fatal blow.
+ * @param UnitSide unit's side that was shot.
+ * @param UnitBodyPart unit's body part that was shot.
+ */
+void BattleUnit::setFatalShotInfo(UnitSide side, UnitBodyPart bodypart)
+{
+    _fatalShotSide = side;
+    _fatalShotBodyPart = bodypart;
+}
+
+/**
+ * Get information on the unit's fatal shot's side.
+ * @return UnitSide fatal shot's side.
+ */
+UnitSide BattleUnit::getFatalShotSide() const
+{
+    return _fatalShotSide;
+}
+
+/**
+ * Get information on the unit's fatal shot's body part.
+ * @return UnitBodyPart fatal shot's body part.
+ */
+UnitBodyPart BattleUnit::getFatalShotBodyPart() const
+{
+    return _fatalShotBodyPart;
+}
 }

src/Savegame/BattleUnit.h

@@ -62,6 +62,8 @@ struct BattleUnitKills
 	UnitFaction faction;
 	UnitStatus status;
     int mission, turn;
+    UnitSide side;
+    UnitBodyPart bodypart;
 
     /// Functions
     // Make turn unique across all kills
@@ -86,6 +88,8 @@ struct BattleUnitKills
         faction = (UnitFaction)node["faction"].as<int>();
         mission = node["mission"].as<int>(mission);
         turn = node["turn"].as<int>(turn);
+        side = (UnitSide)node["side"].as<int>();
+        bodypart = (UnitBodyPart)node["bodypart"].as<int>();
     }
     // Save
     YAML::Node save() const
@@ -99,9 +103,11 @@ struct BattleUnitKills
         node["faction"] = (int)faction;
         node["mission"] = mission;
         node["turn"] = turn;
+        node["side"] = (int)side;
+        node["bodypart"] = (int)bodypart;
         return node;
     }
-    // Convert victim State to string
+    // Convert victim State to string.
     std::string getUnitStatusString() const
     {
         switch (status)
@@ -111,7 +117,7 @@ struct BattleUnitKills
         default:                    return "status error";
         }
     }
-    // Convert victim Faction to string
+    // Convert victim Faction to string.
     std::string getUnitFactionString() const
     {
         switch (faction)
@@ -122,9 +128,36 @@ struct BattleUnitKills
         default:                return "faction error";
         }
     }
+    // Convert victim Side to string.
+    std::string getUnitSideString() const
+    {
+        switch (side)
+        {
+        case SIDE_FRONT:    return "SIDE_FRONT";
+        case SIDE_LEFT:     return "SIDE_LEFT";
+        case SIDE_RIGHT:    return "SIDE_RIGHT";
+        case SIDE_REAR:     return "SIDE_REAR";
+        case SIDE_UNDER:    return "SIDE_UNDER";
+        default:            return "side error";
+        }
+    }
+    // Convert victim Body part to string.
+    std::string getUnitBodyPart() const
+    {
+        switch (bodypart)
+        {
+        case BODYPART_HEAD:     return "BODYPART_HEAD";
+        case BODYPART_TORSO:    return "BODYPART_TORSO";
+        case BODYPART_RIGHTARM: return "BODYPART_RIGHTARM";
+        case BODYPART_LEFTARM:  return "BODYPART_LEFTARM";
+        case BODYPART_RIGHTLEG: return "BODYPART_RIGHTLEG";
+        case BODYPART_LEFTLEG:  return "BODYPART_LEFTLEG";
+        default:                return "body part error";
+        }
+    }
     BattleUnitKills(const YAML::Node& node) { load(node); }
-    BattleUnitKills(std::string Rank, std::string Race, std::string Weapon, std::string WeaponAmmo, UnitFaction Faction, UnitStatus Status, int Mission, int Turn) : 
-						rank(Rank), race(Race), weapon(Weapon), weaponAmmo(WeaponAmmo), faction(Faction), status(Status), mission(Mission), turn(Turn) { }
+    BattleUnitKills(std::string Rank, std::string Race, std::string Weapon, std::string WeaponAmmo, UnitFaction Faction, UnitStatus Status, int Mission, int Turn, UnitSide Side, UnitBodyPart BodyPart) : 
+						rank(Rank), race(Race), weapon(Weapon), weaponAmmo(WeaponAmmo), faction(Faction), status(Status), mission(Mission), turn(Turn), side(Side), bodypart(BodyPart) { }
     ~BattleUnitKills() { }
 };
 
@@ -261,6 +294,8 @@ class BattleUnit
 	std::string _activeHand;
     BattleUnitStatistics* _statistics;
 	int _murdererId;	// used to credit the murderer with the kills that this unit got by blowing up on death
+    UnitSide _fatalShotSide;
+    UnitBodyPart _fatalShotBodyPart;
 
 	// static data
 	std::string _type;
@@ -622,6 +657,12 @@ class BattleUnit
 	void setMurdererId(int id);
 	/// Get the unit murderer's id.
 	int getMurdererId() const;
+    /// Set information on the unit's fatal shot.
+    void setFatalShotInfo(UnitSide side, UnitBodyPart bodypart);
+    /// Get information on the unit's fatal shot's side.
+    UnitSide getFatalShotSide() const;
+    /// Get information on the unit's fatal shot's body part.
+    UnitBodyPart getFatalShotBodyPart() const;
 };
 
 }

src/Savegame/SoldierDiary.cpp

@@ -108,6 +108,7 @@ void SoldierDiary::load(const YAML::Node& node)
 	_alienBaseAssaultTotal = node["alienBaseAssaultTotal"].as<int>(_alienBaseAssaultTotal);
 	_allAliensKilledTotal = node["allAliensKilledTotal"].as<int>(_allAliensKilledTotal);
     _allAliensStunnedTotal = node["_allAliensStunnedTotal"].as<int>(_allAliensStunnedTotal);
+    _headshotTotal = node["_headshotTotal"].as<int>(_headshotTotal);
 }
 /**
  * Saves the diary to a YAML file.
@@ -156,6 +157,7 @@ YAML::Node SoldierDiary::save() const
 	if (_alienBaseAssaultTotal) node["alienBaseAssaultTotal"] = _alienBaseAssaultTotal;
 	if (_allAliensKilledTotal) node["allAliensKilledTotal"] = _allAliensKilledTotal;
     if (_allAliensStunnedTotal) node["_allAliensStunnedTotal"] = _allAliensStunnedTotal;
+    if (_headshotTotal) node["_headshotTotal"] = _headshotTotal;
 	return node;
 }
 /**
@@ -175,10 +177,14 @@ void SoldierDiary::updateDiary(BattleUnitStatistics *unitStatistics, MissionStat
             _stunTotal++;
 		_killList.push_back(*kill);
 		if ((*kill)->hostileTurn())
+        {
 			if (rules->getItem((*kill)->weapon)->getBattleType() == BT_GRENADE || rules->getItem((*kill)->weapon)->getBattleType() == BT_PROXIMITYGRENADE)
 				_trapKillTotal++;
 			else
 				_reactionFireTotal++;
+        }
+        if ((*kill)->getUnitSideString() == "BODYPART_HEAD")
+            _headshotTotal++;
     }
     _regionTotal[missionStatistics->region.c_str()]++;
     _countryTotal[missionStatistics->country.c_str()]++;
@@ -306,7 +312,8 @@ bool SoldierDiary::manageCommendations(Ruleset *rules)
 					((*j).first == "totalTrapKills" && _trapKillTotal < (*j).second.at(nextCommendationLevel["noNoun"])) ||
 					((*j).first == "totalAlienBaseAssaults" && _alienBaseAssaultTotal < (*j).second.at(nextCommendationLevel["noNoun"])) ||
 					((*j).first == "totalAllAliensKilled" && _allAliensKilledTotal < (*j).second.at(nextCommendationLevel["noNoun"])) || 
-                    ((*j).first == "totalAllAliensStunned" && _allAliensStunnedTotal < (*j).second.at(nextCommendationLevel["noNoun"])) ))
+                    ((*j).first == "totalAllAliensStunned" && _allAliensStunnedTotal < (*j).second.at(nextCommendationLevel["noNoun"])) ||
+                    ((*j).first == "totalHeadShots" && _headshotTotal < (*j).second.at(nextCommendationLevel["noNoun"])) )
 			{
 				awardCommendationBool = false;
 				break;

src/Savegame/SoldierDiary.h

@@ -75,7 +75,8 @@ class SoldierDiary
 	int _scoreTotal, _killTotal, _winTotal, _stunTotal, _daysWoundedTotal, _baseDefenseMissionTotal, _totalShotByFriendlyCounter, _totalShotFriendlyCounter, _loneSurvivorTotal,
 		_terrorMissionTotal, _nightMissionTotal, _nightTerrorMissionTotal, _monthsService, _unconciousTotal, _shotAtCounterTotal, _hitCounterTotal, _ironManTotal,
 		_importantMissionTotal, _longDistanceHitCounterTotal, _lowAccuracyHitCounterTotal, _shotsFiredCounterTotal, _shotsLandedCounterTotal, _shotAtCounter10in1Mission,
-		_hitCounter5in1Mission, _reactionFireTotal, _timesWoundedTotal, _valiantCruxTotal, _KIA, _trapKillTotal, _alienBaseAssaultTotal, _allAliensKilledTotal, _allAliensStunnedTotal;
+		_hitCounter5in1Mission, _reactionFireTotal, _timesWoundedTotal, _valiantCruxTotal, _KIA, _trapKillTotal, _alienBaseAssaultTotal, _allAliensKilledTotal, _allAliensStunnedTotal,
+        _headshotTotal;
 	void manageModularCommendations(std::map<std::string, int> &nextCommendationLevel, std::map<std::string, int> &modularCommendations, std::pair<std::string, int> statTotal, int criteria);
 	void awardCommendation(std::string type, std::string noun = "noNoun");
 public: