Cleaned up code and commendations

Author: Shoes01

bin/data/Ruleset/Commendations.rul

@@ -89,6 +89,8 @@ extraStrings:
      STR_MEDAL_DISTINGUISHED_SERVICE_DESCRIPTION: "Given to a soldier who has killed alien soldiers of all kinds."
      STR_MEDAL_BOLTS_CROSS_NAME: "Bolt's Cross"
      STR_MEDAL_BOLTS_CROSS_DESCRIPTION: "Given to a soldier who has used non-lethal force to take down important targets."
+     STR_MEDAL_GRENADIERS_MEDAL_NAME: "Grenadier's Medal"
+     STR_MEDAL_GRENADIERS_MEDAL_DESCRIPTION: "Given to a soldier who has used thrown explosives to kill 3 aliens at once."
      STR_AWARD_0: "First award"
      STR_AWARD_1: "Second award"
      STR_AWARD_2: "Third award"
@@ -240,16 +242,33 @@ extraStrings:
 #   total_missions_in_a_region
 #   total_kills_by_race
 #   total_kills_by_rank
-# For more control over commendation awards, use kills_with_criteria.
-# The killCriteria can list any race, rank, weapon, ammo, STATUS_DEAD, STATUS_UNCONSCIOUS,
-# FACTION_HOSTILE, FACTION_NEUTRAL, FACTION_PLAYER. For example, 
-# ["STR_INCENDIARY_ROCKET", "FACTION_HOSTILE"] looks for a kill with Incendiary Rockets AND hostile faction.
+# The following criteria allow more control over the kinds of kills that can be awarded.
+# To use, you must define a killCriteria.
+# The killCriteria can list any race, rank, weapon, ammo, 
+# or one of these statuses: STATUS_DEAD and STATUS_UNCONSCIOUS,
+# or one of these faction   s: FACTION_HOSTILE, FACTION_NEUTRAL, FACTION_PLAYER
+# Use the strings from the ruleset to define them (mods can be used too). 
+# For example, look at "STR_MEDAL_BOLTS_CROSS_NAME". It is awarded if a soldier
+# stuns a hostile commander or stuns a hostile leader.
+# kills_with_criteria_career 
+# kills_with_criteria_mission
+# kills_with_criteria_turn
 commendations:
+  - type: STR_MEDAL_BOLTS_CROSS_NAME
+    description: STR_MEDAL_BOLTS_CROSS_DESCRIPTION
+    sprite: 13
+    criteria:
+      kills_with_criteria_career: [1, 2, 3, 4, 5, 7, 9, 11, 15, 20]
+    killCriteria:
+      -
+        1: ["STR_LIVE_COMMANDER", "FACTION_HOSTILE", "STATUS_UNCONSCIOUS"]
+      -
+        1: ["STR_LIVE_LEADER", "FACTION_HOSTILE", "STATUS_UNCONSCIOUS"]
   - type: STR_MEDAL_MERIT_STAR_NAME
     description: STR_MEDAL_MERIT_STAR_DESCRIPTION
     sprite: 0
     criteria:
-      kills_with_criteria: [3, 5, 10, 15, 20, 25, 30, 35, 40, 50]
+      kills_with_criteria_career: [3, 5, 10, 15, 20, 25, 30, 35, 40, 50]
     killCriteria:
       -
         1: ["FACTION_HOSTILE", "STATUS_DEAD"]
@@ -262,7 +281,7 @@ commendations:
     description: STR_MEDAL_ORDER_OF_RESTRAINT_DESCRIPTION
     sprite: 2
     criteria:
-      kills_with_criteria: [1, 3, 5, 7, 9, 11, 13, 15, 17, 20]
+      kills_with_criteria_career: [1, 3, 5, 7, 9, 11, 13, 15, 17, 20]
     killCriteria:
       -
         1: ["FACTION_HOSTILE", "STATUS_UNCONSCIOUS"]
@@ -310,46 +329,33 @@ commendations:
     description: STR_MEDAL_HELLRAISER_MEDAL_DESCRIPTION
     sprite: 11
     criteria:
-      kills_with_criteria: [1, 2, 3, 4, 5, 7, 9, 11, 15, 20]
+      kills_with_criteria_career: [1, 2, 3, 4, 5, 7, 9, 11, 15, 20]
     killCriteria:
       -
         1: ["STR_INCENDIARY_ROCKET", "FACTION_HOSTILE"]
   - type: STR_MEDAL_DISTINGUISHED_SERVICE_NAME
     description: STR_MEDAL_DISTINGUISHED_SERVICE_DESCRIPTION
     sprite: 12
     criteria:
-      kills_with_criteria: [1, 2, 3, 4, 5, 7, 9, 11, 15, 20]
+      kills_with_criteria_career: [1, 2, 3, 4, 5, 7, 9, 11, 15, 20]
     killCriteria:
       -
         1: ["STR_SECTOID", "STR_LIVE_SOLDIER", "FACTION_HOSTILE", "STATUS_DEAD"]
         1: ["STR_FLOATER", "STR_LIVE_SOLDIER", "FACTION_HOSTILE", "STATUS_DEAD"]
         1: ["STR_SNAKEMAN", "STR_LIVE_SOLDIER", "FACTION_HOSTILE", "STATUS_DEAD"]
         1: ["STR_MUTON", "STR_LIVE_SOLDIER", "FACTION_HOSTILE", "STATUS_DEAD"]
         1: ["STR_ETHEREAL", "STR_LIVE_SOLDIER", "FACTION_HOSTILE", "STATUS_DEAD"]
-  - type: STR_MEDAL_BOLTS_CROSS_NAME
-    description: STR_MEDAL_BOLTS_CROSS_DESCRIPTION
-    sprite: 13
-    criteria:
-      kills_with_criteria: [1, 2, 3, 4, 5, 7, 9, 11, 15, 20]
-    killCriteria:
-      -
-        1: ["STR_LIVE_COMMANDER", "FACTION_HOSTILE", "STATUS_UNCONSCIOUS"]
-        1: ["STR_LIVE_LEADER", "FACTION_HOSTILE", "STATUS_UNCONSCIOUS"]
-  - type: STR_DOUBLE_KILL
-    description: STR_DOUBLE_KILL
+  - type: STR_MEDAL_GRENADIERS_MEDAL_NAME
+    description: STR_MEDAL_GRENADIERS_MEDAL_DESCRIPTION
     sprite: 0
     criteria:
-      kills_with_criteria: [1, 2, 3, 4, 5, 7, 9, 11, 15, 20]
+      kills_with_criteria_turn: [1, 2, 3, 4, 5, 7, 9, 11, 15, 20]
     killCriteria:
       -
-        2: ["FACTION_HOSTILE", "STATUS_DEAD"]
-  - type: STR_TRIPLE_KILL
-    description: STR_TRIPLE_KILL
-    sprite: 0
-    criteria:
-      kills_with_criteria: [1, 2, 3, 4, 5, 7, 9, 11, 15, 20]
-    killCriteria:
+        3: ["FACTION_HOSTILE", "STATUS_DEAD", "STR_GRENADE"]
+      -
+        3: ["FACTION_HOSTILE", "STATUS_DEAD", "STR_PROXIMITY_GRENADE"]
+      -
+        3: ["FACTION_HOSTILE", "STATUS_DEAD", "STR_ALIEN_GRENADE"]
       -
-        3: ["FACTION_HOSTILE", "STATUS_DEAD"]
-#
-# killCriteria can be specified for a single turn, a single mission, or career wide
+        3: ["FACTION_HOSTILE", "STATUS_DEAD", "STR_HIGH_EXPLOSIVE"]

src/Savegame/SoldierDiary.cpp

@@ -435,11 +435,6 @@ bool SoldierDiary::manageCommendations(Ruleset *rules)
 			}
             else if ((*j).first == "kills_with_criteria_career" || (*j).first == "kills_with_criteria_mission" || (*j).first == "kills_with_criteria_turn")
             {
-                /**
-                Career: Look at all
-                Mission: Look only at kills with same mission ID
-                Turn: Look only at kills with same turn ID
-                **/
                 // Looks to see how many kills the soldier has received over the course of his career
                 std::vector<std::map<int, std::vector<std::string> > > *_killCriteriaList = (*i).second->getKillCriteria();
 
@@ -510,29 +505,26 @@ bool SoldierDiary::manageCommendations(Ruleset *rules)
                                     {
                                         count++;
                                         // Only one count per mission, unless the commendation wants more than one
+                                        // This also stops a "double kill" not getting awarded because we got 5 kills
                                         if ( count == (*andCriteria).first) break;
                                     }
                                 }
-                                int multiCriteria = (*andCriteria).first;
-                                // If one of the AND criteria fail, stop looking
-                                if (multiCriteria == 0 || count / multiCriteria < (*j).second.at(_nextCommendationLevel[""]))
-                                {
-                                    _awardCommendation = false;
-                                    break;
-                                }
+                            }
+                            int multiCriteria = (*andCriteria).first;
+                            // If one of the AND criteria fail, stop looking
+                            if (multiCriteria == 0 || count / multiCriteria < (*j).second.at(_nextCommendationLevel[""]))
+                            {
+                                _awardCommendation = false;
+                                break;
                             }
                         }
                     }
-                        
-                        
-                        
-                        
                     else if ((*j).first == "kills_with_criteria_turn")
                     {
                         // Loop over the AND vectors
                         for (std::map<int, std::vector<std::string> >::const_iterator andCriteria = orCriteria->begin(); andCriteria != orCriteria->end(); ++andCriteria)
                         {
-                            int count = 0; // Each AND vector has to match the award criteria
+                            int count = 0; // How many AND vectors (list of DETAILs) have been successful
                             int killThisTurn = 0;
                             int killLastTurn = -1;
                             bool goToNextTurn = false;
@@ -582,21 +574,11 @@ bool SoldierDiary::manageCommendations(Ruleset *rules)
                                 break;
                             }
                         }
-                            
-                            
-                            // Missions: only loops through kills on the same mission
-                            // Turns: only loops through kills on the same turn
                     }
-                        
-                        
-                        
-                        
-                        
-                        
+
                     }
                     if (_awardCommendation) break; // Stop looking because we are getting one regardless
-                }
-            }                   
+            }
         }
 		if (_awardCommendation)
 		{