Added post humous commeendations for excellent soldiers

Author: Shoes01

bin/data/Ruleset/Commendations.rul

@@ -347,6 +347,10 @@ extraStrings:
      STR_MEDAL_MEDIKIT_DESCRIPTION: "Given to a soldier who has made regular use of the medikit on the battlefield."
      STR_MEDAL_BRAVERYGAIN_NAME: "Medal of Bravery"
      STR_MEDAL_BRAVERYGAIN_DESCRIPTION: "Given to a soldier who is an example of bravery."
+     STR_MEDAL_BESTOFRANK_NAME: "Best of Rank"
+     STR_MEDAL_BESTOFRANK_DESCRIPTION: "Given post humously to a soldier who was a rising star in his or her respective rank."
+     STR_MEDAL_BESTSOLDIER_NAME: "Best Soldier"
+     STR_MEDAL_BESTSOLDIER_DESCRIPTION: "Given post humously to a soldier who was an example for all others."
      STR_AWARD_0: "First award"
      STR_AWARD_1: "Second award"
      STR_AWARD_2: "Third award"
@@ -525,6 +529,10 @@ extraStrings:
      STR_MEDAL_MEDIKIT_DESCRIPTION: "Given to a soldier who has made regular use of the medikit on the battlefield."
      STR_MEDAL_BRAVERYGAIN_NAME: "Medal of Bravery"
      STR_MEDAL_BRAVERYGAIN_DESCRIPTION: "Given to a soldier who is an example of bravery."
+     STR_MEDAL_BESTOFRANK_NAME: "Best of Rank"
+     STR_MEDAL_BESTOFRANK_DESCRIPTION: "Given post humously to a soldier who was a rising star in his or her respective rank."
+     STR_MEDAL_BESTSOLDIER_NAME: "Best Soldier"
+     STR_MEDAL_BESTSOLDIER_DESCRIPTION: "Given post humously to a soldier who was an example for all others."
      STR_AWARD_0: "First award"
      STR_AWARD_1: "Second award"
      STR_AWARD_2: "Third award"
@@ -1392,6 +1400,16 @@ commendations:
     sprite: 00
     criteria:
       totalBraveryGain: [10, 10, 20, 20, 20, 20, 30, 30, 30, 30]
+  - type: STR_MEDAL_BESTOFRANK_NAME
+    description: STR_MEDAL_BESTOFRANK_DESCRIPTION
+    sprite: 00
+    criteria:
+      bestOfRank: [1, 2, 3, 4, 4, 5, 6, 6]
+  - type: STR_MEDAL_BESTSOLDIER_NAME
+    description: STR_MEDAL_BESTSOLDIER_DESCRIPTION
+    sprite: 00
+    criteria:
+      bestSoldier: [1, 1, 1, 1, 1, 1, 1, 1, 1, 1]
 ufopaedia:
   - id: STR_MEDAL_MILITARY_CROSS_NAME
     type_id: 7
@@ -1750,6 +1768,21 @@ ufopaedia:
     text: STR_MEDAL_BRAVERYGAIN_MEDAL_UFOPEDIA
     text_width: 164
     listOrder: 6051
+  - id: STR_MEDAL_BESTOFRANK_NAME
+    type_id: 7
+    section: STR_HEAVY_WEAPONS_PLATFORMS
+    image_id: PLACEHOLDER #BESTOFRANK
+    text: STR_MEDAL_BESTOFRANK_MEDAL_UFOPEDIA
+    text_width: 164
+    listOrder: 6052
+  - id: STR_MEDAL_BESTSOLDIER_NAME
+    type_id: 7
+    section: STR_HEAVY_WEAPONS_PLATFORMS
+    image_id: PLACEHOLDER #BESTSOLDIER
+    text: STR_MEDAL_BESTSOLDIER_MEDAL_UFOPEDIA
+    text_width: 164
+    listOrder: 6053
+
 # entries below move the HWPs to the Craft Section of the UFOPedia
   - id: STR_TANK_CANNON
     section: STR_XCOM_CRAFT_ARMAMENT

src/Battlescape/DebriefingState.cpp

@@ -288,6 +288,37 @@ DebriefingState::DebriefingState() : _region(0), _country(0), _noContainment(fal
 			// Set the UnitStats delta
 			(*j)->getStatistics()->delta = *(*j)->getGeoscapeSoldier()->getCurrentStats() - *(*j)->getGeoscapeSoldier()->getInitStats();
 
+			std::map<SoldierRank, Soldier*> bestSoldierCandidates;
+			int bestScore[7] = {0, 0, 0, 0, 0, 0, 0};
+			int bestOverallScore = 0;
+			// Check to see if any of the dead soldiers were exceptional.
+			for (std::vector<Soldier*>::iterator deadUnit = _game->getSavedGame()->getDeadSoldiers()->begin(); deadUnit != _game->getSavedGame()->getDeadSoldiers()->end(); ++deadUnit)
+			{
+				// Find the best soldier per rank by comparing score
+				int score = (*deadUnit)->getDiary()->getScoreTotal();
+				SoldierRank rank = (*deadUnit)->getRank();				
+				
+				if (score > bestScore[rank])
+				{
+					bestSoldierCandidates[rank] = (*deadUnit);
+					bestScore[rank] = score;
+					if (score > bestOverallScore)
+					{
+						bestOverallScore = score;
+					}
+				}
+			}
+			// Now award those soldiers commendations!
+			for (std::map<SoldierRank, Soldier*>::iterator bestSoldier = bestSoldierCandidates.begin(); bestSoldier != bestSoldierCandidates.end(); ++bestSoldier)
+			{
+				(*bestSoldier).second->getDiary()->awardBestOfRank((*bestSoldier).second->getRank());
+				if ((*bestSoldier).second->getDiary()->getScoreTotal() == bestOverallScore)
+				{
+					(*bestSoldier).second->getDiary()->awardBestOverall();
+					bestOverallScore++; // If there is a tie, first come first serve!
+				}
+			}
+
             (*j)->getGeoscapeSoldier()->getDiary()->updateDiary((*j)->getStatistics(), _missionStatistics, _game->getRuleset());
 			if ((*j)->getStatus() != STATUS_DEAD && (*j)->getGeoscapeSoldier()->getDiary()->manageCommendations(_game->getRuleset()))
 			{

src/Ruleset/Ruleset.cpp

@@ -792,6 +792,10 @@ SavedGame *Ruleset::newSave() const
 		soldier->setCraft(base->getCrafts()->front());
 		base->getSoldiers()->push_back(soldier);
 		soldier->getDiary()->awardOriginalEightCommendation();
+		for (std::vector<SoldierCommendations*>::iterator comm = soldier->getDiary()->getSoldierCommendations()->begin(); comm != soldier->getDiary()->getSoldierCommendations()->end(); ++comm)
+		{
+			(*comm)->makeOld(); // Soldier was already awarded these before arriving on base.
+		}
 	}
 
 	save->getBases()->push_back(base);

src/Savegame/SoldierDiary.cpp

@@ -40,7 +40,8 @@ SoldierDiary::SoldierDiary() : _killList(), _regionTotal(), _countryTotal(), _ty
 	_totalShotByFriendlyCounter(0), _totalShotFriendlyCounter(0), _ironManTotal(0), _importantMissionTotal(0), _longDistanceHitCounterTotal(0),
     _lowAccuracyHitCounterTotal(0), _shotsFiredCounterTotal(0), _shotsLandedCounterTotal(0), _shotAtCounter10in1Mission(0), _hitCounter5in1Mission(0),
 	_reactionFireTotal(0), _timesWoundedTotal(0), _valiantCruxTotal(0), _KIA(0), _trapKillTotal(0), _alienBaseAssaultTotal(0), _allAliensKilledTotal(0), _allAliensStunnedTotal(0),
-    _woundsHealedTotal(0), _allUFOs(0), _allMissionTypes(0), _statGainTotal(0), _revivedUnitTotal(0), _wholeMedikitTotal(0), _braveryGainTotal(0)
+    _woundsHealedTotal(0), _allUFOs(0), _allMissionTypes(0), _statGainTotal(0), _revivedUnitTotal(0), _wholeMedikitTotal(0), _braveryGainTotal(0), _bestOfRank(0),
+    _bestSoldier(false)
 {
 }
 /**
@@ -116,6 +117,8 @@ void SoldierDiary::load(const YAML::Node& node)
     _revivedUnitTotal = node["_revivedUnitTotal"].as<int>(_revivedUnitTotal);
     _wholeMedikitTotal = node["_wholeMedikitTotal"].as<int>(_wholeMedikitTotal);
     _braveryGainTotal = node["_braveryGainTotal"].as<int>(_braveryGainTotal);
+    _bestOfRank = node["_bestOfRank"].as<int>(_bestOfRank);
+    _bestSoldier = node["_bestSoldier"].as<bool>(_bestSoldier);
 }
 /**
  * Saves the diary to a YAML file.
@@ -171,6 +174,8 @@ YAML::Node SoldierDiary::save() const
     if (_revivedUnitTotal) node["_revivedUnitTotal"] = _revivedUnitTotal;
     if(_wholeMedikitTotal) node["_wholeMedikitTotal"] = _wholeMedikitTotal;
     if(_braveryGainTotal) node["_braveryGainTotal"] = _braveryGainTotal;
+    if (_bestOfRank) node["_bestOfRank"] = _bestOfRank;
+    if (_bestSoldier) node["_bestSoldier"] = _bestSoldier;
 	return node;
 }
 /**
@@ -363,7 +368,9 @@ bool SoldierDiary::manageCommendations(Ruleset *rules)
 					((*j).first == "totalStatGain" && _statGainTotal < (*j).second.at(nextCommendationLevel["noNoun"])) ||
 					((*j).first == "totalRevives" && _revivedUnitTotal < (*j).second.at(nextCommendationLevel["noNoun"])) ||
 					((*j).first == "totalWholeMedikit" && _wholeMedikitTotal < (*j).second.at(nextCommendationLevel["noNoun"])) ||
-					((*j).first == "totalBraveryGain" && _braveryGainTotal < (*j).second.at(nextCommendationLevel["noNoun"])) )
+					((*j).first == "totalBraveryGain" && _braveryGainTotal < (*j).second.at(nextCommendationLevel["noNoun"])) ||
+					((*j).first == "bestOfRank" && _bestOfRank < (*j).second.at(nextCommendationLevel["noNoun"])) ||
+                    ((*j).first == "bestSoldier" && (int)_bestSoldier < (*j).second.at(nextCommendationLevel["noNoun"])) )
 			{
 				awardCommendationBool = false;
 				break;
@@ -754,6 +761,21 @@ void SoldierDiary::awardOriginalEightCommendation()
 {
     _commendations.push_back(new SoldierCommendations("STR_MEDAL_ORIGINAL8_NAME", "NoNoun"));
 }
+/**
+ *  Award post-humous best-of commendation.
+ */
+void SoldierDiary::awardBestOfRank(SoldierRank rank)
+{
+    _bestOfRank = (int)rank + 1;
+}
+/**
+ *  Award post-humous best-of commendation.
+ */
+void SoldierDiary::awardBestOverall()
+{
+    _bestSoldier = true;
+}
+
 /**
  * Initializes a new commendation entry from YAML.
  * @param node YAML node.

src/Savegame/SoldierDiary.h

@@ -76,7 +76,8 @@ class SoldierDiary
 		_terrorMissionTotal, _nightMissionTotal, _nightTerrorMissionTotal, _monthsService, _unconciousTotal, _shotAtCounterTotal, _hitCounterTotal, _ironManTotal,
 		_importantMissionTotal, _longDistanceHitCounterTotal, _lowAccuracyHitCounterTotal, _shotsFiredCounterTotal, _shotsLandedCounterTotal, _shotAtCounter10in1Mission,
 		_hitCounter5in1Mission, _reactionFireTotal, _timesWoundedTotal, _valiantCruxTotal, _KIA, _trapKillTotal, _alienBaseAssaultTotal, _allAliensKilledTotal, _allAliensStunnedTotal,
-        _woundsHealedTotal, _allUFOs, _allMissionTypes, _statGainTotal, _revivedUnitTotal, _wholeMedikitTotal, _braveryGainTotal;
+        _woundsHealedTotal, _allUFOs, _allMissionTypes, _statGainTotal, _revivedUnitTotal, _wholeMedikitTotal, _braveryGainTotal, _bestOfRank;
+    bool _bestSoldier;
 	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:
@@ -132,6 +133,10 @@ class SoldierDiary
     std::vector<BattleUnitKills*> &getKills();
     /// Award special commendation to the original 8 soldiers.
     void awardOriginalEightCommendation();
+    /// Award post-humous best-of rank commendation.
+    void awardBestOfRank(SoldierRank rank);
+    /// Award post-humous best overall commendation.
+    void awardBestOverall();
 };
 }
 #endif