Added the Automatic Tracking of Award Eligibility and Additional Award Enhancements

MekHQ/resources/mekhq/resources/AutoAwards.properties

@@ -0,0 +1,2 @@
+EligibleForAwardReport.format=is eligible for the {0} award from the [{1}] set.
+EligibleForAwardReportAll.format=All active personnel are eligible for the {0} award from the [{1}] set.

MekHQ/src/mekhq/campaign/ResolveScenarioTracker.java

@@ -37,6 +37,7 @@
 import mekhq.campaign.parts.Armor;
 import mekhq.campaign.parts.Part;
 import mekhq.campaign.personnel.Person;
+import mekhq.campaign.personnel.autoAwards.AutoAwardsPostScenarioController;
 import mekhq.campaign.personnel.enums.PersonnelStatus;
 import mekhq.campaign.personnel.enums.PrisonerStatus;
 import mekhq.campaign.unit.TestUnit;
@@ -1413,6 +1414,7 @@ public void resolveScenario(ScenarioStatus resolution, String report) {
             for (Kill k : status.getKills()) {
                 getCampaign().addKill(k);
             }
+
             if (status.isMissing()) {
                 person.changeStatus(getCampaign(), getCampaign().getLocalDate(), PersonnelStatus.MIA);
             } else if (status.isDead()) {
@@ -1430,6 +1432,18 @@ public void resolveScenario(ScenarioStatus resolution, String report) {
             if (status.toRemove()) {
                 getCampaign().removePerson(person, false);
             }
+
+            // TODO add Posthumous Awards to Campaign Options
+            boolean fakeCampaignOptionPosthumousAwardsIsEnabled = false;
+            if (!person.getStatus().isDead() || fakeCampaignOptionPosthumousAwardsIsEnabled) {
+                int injuryCount = 0;
+
+                if (status.getHits() > person.getHits()) {
+                    injuryCount = status.getHits() - person.getHits();
+                }
+
+                new AutoAwardsPostScenarioController(campaign, scenario.getId(), person, injuryCount);
+            }
         }
 
         //region Prisoners

MekHQ/src/mekhq/campaign/force/Force.java

@@ -286,7 +286,7 @@ public Vector<UUID> getAllUnits(boolean combatForcesOnly) {
     /**
      * Add a unit id to the units vector. In general, this
      * should not be called directly to add unid because they will
-     * not be assigned a force id. Use {@link Campaign#addUnitToForce(mekhq.campaign.unit.Unit, int)}
+     * not be assigned a force id. Use {@link Campaign#addUnitToForce(Unit, int)}
      * instead
      * @param uid
      */
@@ -311,12 +311,12 @@ public void addUnit(Campaign campaign, UUID uid, boolean useTransfers, Force old
                 }
             }
         }
-        
+
         updateCommander(campaign);
     }
 
     /**
-     * This should not be directly called except by {@link Campaign#removeUnitFromForce(mekhq.campaign.unit.Unit)}
+     * This should not be directly called except by {@link Campaign#removeUnitFromForce(Unit)}
      * instead
      * @param id
      */
@@ -341,7 +341,7 @@ public void removeUnit(Campaign campaign, UUID id, boolean log) {
                     }
                 }
             }
-            
+
             updateCommander(campaign);
         }
     }
@@ -384,27 +384,27 @@ public int getId() {
     public void setId(int i) {
         this.id = i;
     }
-    
+
     public UUID getForceCommanderID() {
         return forceCommanderID;
     }
-    
+
     public void setForceCommanderID(UUID commanderID) {
         forceCommanderID = commanderID;
     }
-    
+
     public List<UUID> getEligibleCommanders(Campaign c) {
         List<UUID> people = new ArrayList<>();
         Person highestRankPerson = c.getPerson(getForceCommanderID());
-        
-        // safety check: if the person is no longer assigned to a unit or the force, 
+
+        // safety check: if the person is no longer assigned to a unit or the force,
         // then they're not really the highest ranked person in the force.
-        if ((highestRankPerson != null) && 
+        if ((highestRankPerson != null) &&
                 ((highestRankPerson.getUnit() == null) ||
                 (!getUnits().contains(highestRankPerson.getUnit().getId())))) {
             highestRankPerson = null;
         }
-        
+
         for (UUID uid : getUnits()) {
             Unit u = c.getUnit(uid);
             if (null != u) {
@@ -425,23 +425,23 @@ public List<UUID> getEligibleCommanders(Campaign c) {
                 }
             }
         }
-        
+
         return people;
     }
-    
+
     /**
      * Automatically update the force's commander
      */
     public void updateCommander(Campaign c) {
         List<UUID> eligibleCommanders = getEligibleCommanders(c);
-        
+
         // logic: if we found someone eligible who is a higher rank, the first one of those becomes the new commander
         // otherwise, the existing commander remains the commander
         if (!eligibleCommanders.contains(getForceCommanderID()) && (eligibleCommanders.size() > 0)) {
             forceCommanderID = eligibleCommanders.get(0);
         }
     }
-    
+
     public void removeSubForce(int id) {
         int idx = 0;
         boolean found = false;
@@ -605,7 +605,7 @@ public void writeToXML(PrintWriter pw1, int indent) {
         } else if (version.isLowerThan("0.49.7")) {
             retVal.setForceIcon(ForceIconMigrator.migrateForceIcon0496To0497(retVal.getForceIcon()));
         }
-        
+
         retVal.updateCommander(c);
 
         return retVal;
@@ -713,4 +713,58 @@ public int getPrimaryUnitType(Campaign c) {
 
         return biggestBucketID;
     }
+
+
+    /**
+     * Finds the distance (depth) from the origin force
+     * @param force the force to get depth for
+     */
+    public static int getDepth(Force force) {
+        int depth = 0;
+
+        Force parent = force.getParentForce();
+
+        if (parent != null) {
+            depth++;
+
+            while (parent != null) {
+                parent = force.getParentForce();
+
+                if (parent != null) {
+                    depth++;
+                }
+            }
+        }
+
+        return depth;
+    }
+
+    /**
+     * Uses a recursive search to find the maximum distance (depth) from the origin force
+     * @param force the current force. Should always equal campaign.getForce(0), if called remotely
+     * @param depth the current recursive depth. Can be left null, if called remotely
+     */
+    public static int getMaximumDepth(Force force, @Nullable Integer depth) {
+        Vector<Force> subforces = force.getSubForces();
+
+        if (depth == null) {
+            depth = 0;
+        }
+
+        int maximumDepth;
+        int nextDepth;
+
+        if (subforces.isEmpty()) {
+            return depth;
+        } else {
+            maximumDepth = depth;
+            for (Force subforce: subforces) {
+                nextDepth = getMaximumDepth(subforce, depth + 1);
+                if (nextDepth > maximumDepth) {
+                    maximumDepth = nextDepth;
+                }
+            }
+        }
+        return maximumDepth;
+    }
 }

MekHQ/src/mekhq/campaign/personnel/Award.java

@@ -58,6 +58,18 @@ public class Award implements Comparable<Award> {
     @XmlElement(name = "edge")
     private int edge = 0;
 
+    @XmlElement(name = "qty")
+    private int qty;
+
+    @XmlElement(name = "item")
+    private String item;
+
+    @XmlElement(name = "size")
+    private String size;
+
+    @XmlElement(name = "range")
+    private String range;
+
     @XmlElement(name = "stackable")
     private boolean stackable = false;
 
@@ -72,7 +84,7 @@ public Award() {
     }
 
     public Award(String name, String set,  String description, List<String> medals, List<String> ribbons,
-                 List<String> miscs, int xp, int edge, boolean stackable, int id) {
+                 List<String> miscs, int xp, int edge, boolean stackable, int qty, String item, String size, String range, int id) {
         this.name = name;
         this.set = set;
         this.description = description;
@@ -81,6 +93,10 @@ public Award(String name, String set,  String description, List<String> medals,
         this.miscs = miscs;
         this.xp = xp;
         this.edge = edge;
+        this.qty = qty;
+        this.item = item;
+        this.size = size;
+        this.range = range;
         this.stackable = stackable;
         dates = new ArrayList<>();
         this.id = id;
@@ -125,6 +141,26 @@ public String getDescription() {
         return description;
     }
 
+    /**
+     * Returns the xml element 'qty'
+     * Use getQuantity() if looking for the number of times an award has been issued to an individual
+     */
+    public int getQty() {
+        return qty;
+    }
+
+    public String getItem() {
+        return item;
+    }
+
+    public String getSize() {
+        return size;
+    }
+
+    public String getRange() {
+        return range;
+    }
+
     /**
      * Gets the file name of an award given i times.
      * @param i times given the award
@@ -189,7 +225,7 @@ public int getEdgeReward() {
      */
     public Award createCopy() {
         return new Award(this.name, this.set, this.description, this.medals, this.ribbons, this.miscs,
-                this.xp, this.edge, this.stackable, this.id);
+                this.xp, this.edge, this.stackable, this.qty, this.item, this.size, this.range, this.id);
     }
 
     /**
@@ -284,7 +320,7 @@ public boolean hasDates() {
     }
 
     /**
-     * @return the number of times this award has been awarded to the person.
+     * @return the number of times this award has been awarded.
      */
     public int getQuantity() {
         return dates.size();