Merge pull request #4008 from IllianiCBT/AutoMedals

Added the Automatic Tracking of Award Eligibility and Additional Award Enhancements

Author: HammerGS

MekHQ/data/universe/awards/standard.xml

@@ -0,0 +1,11 @@
+AutoAwardsDialog.title=Award Ceremony
+
+txtInstructions.title=Instructions
+txtInstructions.text=Deselect awards you do not want issued, then select 'Issue Awards' to issue the remaining awards. Selecting 'Skip' will skip the current award type. Selecting 'Skip All' will skip this and all remaining award types.
+
+btnDeselectAll.text=Deselect All
+btnSelectAll.text=Select All
+
+btnDone.text=Issue Awards
+btnSkip.text=Skip
+btnSkipAll.text=Skip All

MekHQ/docs/Award Stuff/Award Guide.md renamed to MekHQ/docs/Archive Stuff/Award Stuff (old)/Award Guide.md

@@ -88,7 +88,8 @@ miCargoReport.text=Cargo Report...
 # View Menu
 menuView.text=View
 miShowHistoricalReportLog.text=Historical Daily Report Log
-miRetirementDefectionDialog.text=Employee Turnover Dialog...
+miRetirementDefectionDialog.text=Employee Turnover Dialog
+miAwardEligibilityDialog.text=Award Eligibility Dialog
 
 # Manage Campaign Menu
 menuManageCampaign.text=Manage Campaign

MekHQ/docs/Award Stuff/AwardTracker.xlsx renamed to MekHQ/docs/Archive Stuff/Award Stuff (old)/AwardTracker.xlsx

@@ -379,6 +379,45 @@ exponentialRandomDeathPanel.title=Exponential Random Death
 lblExponentialRandomDeathAge.text=* age)
 ageRangeRandomDeathPanel.title=Age Range Random Death
 lblAgeRange.text=Age Range
+
+
+# Awards
+awardsPanel.title=Awards
+lblAwardBonusStyle.text=Award Bonuses
+lblAwardBonusStyle.toolTipText=Toggle XP and/or Edge bonuses from awards.
+chkEnableAutoAwards.text=Track Award Eligibility
+chkEnableAutoAwards.toolTipText=Enable the automatic tracking of award eligibility.
+chkIssuePosthumousAwards.text=Issue Posthumous Awards
+chkIssuePosthumousAwards.toolTipText=Enabling this setting will qualify personnel for awards even if they are dead (excludes formation-based kill awards).
+chkIssueBestAwardOnly.text=Only Issue Best Award
+chkIssueBestAwardOnly.toolTipText=Activating this setting will disqualify personnel from receiving an award if they qualify for a higher-tier award of the same type.
+chkIgnoreStandardSet.text=Ignore Standard Set
+chkIgnoreStandardSet.toolTipText=Ignore the default set of awards
+lblAwardTierSize.text=Award Tier Size
+lblAwardTierSize.toolTipText=How many times must an award be issued before using the image of the next tier
+autoAwardsPanel.title=Award Tracking
+chkEnableContractAwards.text=Contract
+chkEnableContractAwards.toolTipText=Awards issued for completing Contracts.
+chkEnableFactionHunterAwards.text=Faction Hunter
+chkEnableFactionHunterAwards.toolTipText=Awards issued for completing AtB Contracts against specific Factions.
+chkEnableInjuryAwards.text=Injury
+chkEnableInjuryAwards.toolTipText=Awards issued for suffering Hits during a Scenario.
+chkEnableIndividualKillAwards.text=Kill (Individual)
+chkEnableIndividualKillAwards.toolTipText=Awards issued for pilot kills in Scenarios or Missions.
+chkEnableFormationKillAwards.text=Kill (Formation)
+chkEnableFormationKillAwards.toolTipText=Awards issued for formation kills (Lance, Company, etc.) in Missions.
+chkEnableRankAwards.text=Rank
+chkEnableRankAwards.toolTipText=Awards issued for achieving specific Ranks.
+chkEnableScenarioAwards.text=Scenario
+chkEnableScenarioAwards.toolTipText=Awards issued for completing a certain number of Scenarios.
+chkEnableSkillAwards.text=Skill
+chkEnableSkillAwards.toolTipText=Awards issued for reaching certain levels in specific Skills.
+chkEnableTheatreOfWarAwards.text=Theatre of War
+chkEnableTheatreOfWarAwards.toolTipText=Awards issued for partaking in galactic conflicts.
+chkEnableTimeAwards.text=Time
+chkEnableTimeAwards.toolTipText=Awards for remaining in the unit for a certain duration.
+chkEnableMiscAwards.text=Misc
+chkEnableMiscAwards.toolTipText=Miscellaneous awards (see documentation).
 ##end Personnel Tab
 
 ## Finances Tab

MekHQ/docs/Award Stuff/CampaignDataForAwards.cpnx renamed to MekHQ/docs/Archive Stuff/Award Stuff (old)/CampaignDataForAwards.cpnx

@@ -51,6 +51,16 @@ AgeGroup.TODDLER.toolTipText=Personnel are Toddlers from their 1st birthday unti
 AgeGroup.BABY.text=Baby
 AgeGroup.BABY.toolTipText=Personnel are babies until their 1st birthday.
 
+# Award Enum
+AwardBonuses.BOTH.text=XP/Edge
+AwardBonuses.BOTH.toolTipText=All Award bonuses are enabled
+AwardBonuses.XP.text=XP
+AwardBonuses.XP.toolTipText=Only XP Award bonuses are enabled
+AwardBonuses.EDGE.text=Edge
+AwardBonuses.EDGE.toolTipText=Only Edge Award bonuses are enabled
+AwardBonuses.NONE.text=None
+AwardBonuses.NONE.toolTipText=All Award bonuses are disabled
+
 # BabySurnameStyle Enum
 BabySurnameStyle.FATHERS.text=Fathers
 BabySurnameStyle.FATHERS.toolTipText=The baby will use the father's surname, or the mother's surname if there is no father

MekHQ/docs/Awards Module.pdf

@@ -114,6 +114,8 @@ public final class MHQConstants extends SuiteConstants {
     public static final String PAID_RETIREMENT_FOREGROUND = "paidRetirementForeground";
     public static final String PAID_RETIREMENT_BACKGROUND = "paidRetirementBackground";
     public static final String STRATCON_HEX_COORD_FOREGROUND = "stratconHexCoordForeground";
+    public static final String AUTO_AWARDS_FOREGROUND = "paidRetirementForeground";
+    public static final String AUTO_AWARDS_BACKGROUND = "paidRetirementBackground";
     //endregion Colours
 
     //region Fonts

MekHQ/resources/mekhq/resources/AutoAwardsDialog.properties

@@ -318,6 +318,25 @@ public static String getTransitUnitName(final int unit) {
     private double[] exponentialRandomDeathFemaleValues;
     private Map<TenYearAgeRange, Double> ageRangeRandomDeathMaleValues;
     private Map<TenYearAgeRange, Double> ageRangeRandomDeathFemaleValues;
+
+    // Awards
+    private AwardBonus awardBonusStyle;
+    private boolean enableAutoAwards;
+    private boolean issuePosthumousAwards;
+    private boolean issueBestAwardOnly;
+    private boolean ignoreStandardSet;
+    private int awardTierSize;
+    private boolean enableContractAwards;
+    private boolean enableFactionHunterAwards;
+    private boolean enableInjuryAwards;
+    private boolean enableIndividualKillAwards;
+    private boolean enableFormationKillAwards;
+    private boolean enableRankAwards;
+    private boolean enableScenarioAwards;
+    private boolean enableSkillAwards;
+    private boolean enableTheatreOfWarAwards;
+    private boolean enableTimeAwards;
+    private boolean enableMiscAwards;
     //endregion Personnel Tab
 
     //region Finance tab
@@ -803,6 +822,25 @@ public CampaignOptions() {
         getAgeRangeRandomDeathFemaleValues().put(TenYearAgeRange.SIXTY_FIVE_SEVENTY_FOUR, 1421.0);
         getAgeRangeRandomDeathFemaleValues().put(TenYearAgeRange.SEVENTY_FIVE_EIGHTY_FOUR, 3788.0);
         getAgeRangeRandomDeathFemaleValues().put(TenYearAgeRange.EIGHTY_FIVE_OR_OLDER, 12870.0);
+
+        // Awards
+        setAwardBonusStyle(AwardBonus.BOTH);
+        setEnableAutoAwards(true);
+        setIssuePosthumousAwards(false);
+        setIssueBestAwardOnly(true);
+        setIgnoreStandardSet(false);
+        setAwardTierSize(5);
+        setEnableContractAwards(true);
+        setEnableFactionHunterAwards(true);
+        setEnableInjuryAwards(true);
+        setEnableIndividualKillAwards(true);
+        setEnableFormationKillAwards(true);
+        setEnableRankAwards(true);
+        setEnableScenarioAwards(true);
+        setEnableSkillAwards(true);
+        setEnableTheatreOfWarAwards(true);
+        setEnableTimeAwards(true);
+        setEnableMiscAwards(true);
         //endregion Personnel Tab
 
         //region Finances Tab
@@ -2215,6 +2253,144 @@ public void setAgeRangeRandomDeathFemaleValues(final Map<TenYearAgeRange, Double
         this.ageRangeRandomDeathFemaleValues = ageRangeRandomDeathFemaleValues;
     }
     //endregion Death
+
+    //region Awards
+    public boolean isIssuePosthumousAwards() {
+        return issuePosthumousAwards;
+    }
+
+    public void setIssuePosthumousAwards(final boolean issuePosthumousAwards) {
+        this.issuePosthumousAwards = issuePosthumousAwards;
+    }
+
+    public boolean isIssueBestAwardOnly() {
+        return issueBestAwardOnly;
+    }
+
+    public void setIssueBestAwardOnly(final boolean issueBestAwardOnly) {
+        this.issueBestAwardOnly = issueBestAwardOnly;
+    }
+
+    public boolean isIgnoreStandardSet() {
+        return ignoreStandardSet;
+    }
+
+    public void setIgnoreStandardSet(final boolean ignoreStandardSet) {
+        this.ignoreStandardSet = ignoreStandardSet;
+    }
+
+    public int getAwardTierSize() {
+        return awardTierSize;
+    }
+
+    public void setAwardTierSize(final int awardTierSize) {
+        this.awardTierSize = awardTierSize;
+    }
+
+    public AwardBonus getAwardBonusStyle() {
+        return awardBonusStyle;
+    }
+
+    public void setAwardBonusStyle(final AwardBonus awardBonusStyle) {
+        this.awardBonusStyle = awardBonusStyle;
+    }
+
+    public boolean isEnableAutoAwards() {
+        return enableAutoAwards;
+    }
+
+    public void setEnableAutoAwards(final boolean enableAutoAwards) {
+        this.enableAutoAwards = enableAutoAwards;
+    }
+
+    public boolean isEnableContractAwards() {
+        return enableContractAwards;
+    }
+
+    public void setEnableContractAwards(final boolean enableContractAwards) {
+        this.enableContractAwards = enableContractAwards;
+    }
+
+    public boolean isEnableFactionHunterAwards() {
+        return enableFactionHunterAwards;
+    }
+
+    public void setEnableFactionHunterAwards(final boolean enableFactionHunterAwards) {
+        this.enableFactionHunterAwards = enableFactionHunterAwards;
+    }
+
+    public boolean isEnableInjuryAwards() {
+        return enableInjuryAwards;
+    }
+
+    public void setEnableInjuryAwards(final boolean enableInjuryAwards) {
+        this.enableInjuryAwards = enableInjuryAwards;
+    }
+
+    public boolean isEnableIndividualKillAwards() {
+        return enableIndividualKillAwards;
+    }
+
+    public void setEnableIndividualKillAwards(final boolean enableIndividualKillAwards) {
+        this.enableIndividualKillAwards = enableIndividualKillAwards;
+    }
+
+    public boolean isEnableFormationKillAwards() {
+        return enableFormationKillAwards;
+    }
+
+    public void setEnableFormationKillAwards(final boolean enableFormationKillAwards) {
+        this.enableFormationKillAwards = enableFormationKillAwards;
+    }
+
+    public boolean isEnableRankAwards() {
+        return enableRankAwards;
+    }
+
+    public void setEnableRankAwards(final boolean enableRankAwards) {
+        this.enableRankAwards = enableRankAwards;
+    }
+
+    public boolean isEnableScenarioAwards() {
+        return enableScenarioAwards;
+    }
+
+    public void setEnableScenarioAwards(final boolean enableScenarioAwards) {
+        this.enableScenarioAwards = enableScenarioAwards;
+    }
+
+    public boolean isEnableSkillAwards() {
+        return enableSkillAwards;
+    }
+
+    public void setEnableSkillAwards(final boolean enableSkillAwards) {
+        this.enableSkillAwards = enableSkillAwards;
+    }
+
+    public boolean isEnableTheatreOfWarAwards() {
+        return enableTheatreOfWarAwards;
+    }
+
+    public void setEnableTheatreOfWarAwards(final boolean enableTheatreOfWarAwards) {
+        this.enableTheatreOfWarAwards = enableTheatreOfWarAwards;
+    }
+
+    public boolean isEnableTimeAwards() {
+        return enableTimeAwards;
+    }
+
+    public void setEnableTimeAwards(final boolean enableTimeAwards) {
+        this.enableTimeAwards = enableTimeAwards;
+    }
+
+    public boolean isEnableMiscAwards() {
+        return enableMiscAwards;
+    }
+
+    public void setEnableMiscAwards(final boolean enableMiscAwards) {
+        this.enableMiscAwards = enableMiscAwards;
+    }
+    //endregion Awards
     //endregion Personnel Tab
 
     //region Finances Tab
@@ -3756,6 +3932,26 @@ public void writeToXml(final PrintWriter pw, int indent) {
         }
         MHQXMLUtility.writeSimpleXMLCloseTag(pw, --indent, "ageRangeRandomDeathFemaleValues");
         //endregion Death
+
+        //region Awards
+        MHQXMLUtility.writeSimpleXMLTag(pw, indent, "awardBonusStyle", getAwardBonusStyle().name());
+        MHQXMLUtility.writeSimpleXMLTag(pw, indent, "enableAutoAwards", isEnableAutoAwards());
+        MHQXMLUtility.writeSimpleXMLTag(pw, indent, "issuePosthumousAwards", isIssuePosthumousAwards());
+        MHQXMLUtility.writeSimpleXMLTag(pw, indent, "issueBestAwardOnly", isIssueBestAwardOnly());
+        MHQXMLUtility.writeSimpleXMLTag(pw, indent, "ignoreStandardSet", isIgnoreStandardSet());
+        MHQXMLUtility.writeSimpleXMLTag(pw, indent, "awardTierSize", getAwardTierSize());
+        MHQXMLUtility.writeSimpleXMLTag(pw, indent, "enableContractAwards", isEnableContractAwards());
+        MHQXMLUtility.writeSimpleXMLTag(pw, indent, "enableFactionHunterAwards", isEnableFactionHunterAwards());
+        MHQXMLUtility.writeSimpleXMLTag(pw, indent, "enableInjuryAwards", isEnableInjuryAwards());
+        MHQXMLUtility.writeSimpleXMLTag(pw, indent, "enableIndividualKillAwards", isEnableIndividualKillAwards());
+        MHQXMLUtility.writeSimpleXMLTag(pw, indent, "enableFormationKillAwards", isEnableFormationKillAwards());
+        MHQXMLUtility.writeSimpleXMLTag(pw, indent, "enableRankAwards", isEnableRankAwards());
+        MHQXMLUtility.writeSimpleXMLTag(pw, indent, "enableScenarioAwards", isEnableScenarioAwards());
+        MHQXMLUtility.writeSimpleXMLTag(pw, indent, "enableSkillAwards", isEnableSkillAwards());
+        MHQXMLUtility.writeSimpleXMLTag(pw, indent, "enableTheatreOfWarAwards", isEnableTheatreOfWarAwards());
+        MHQXMLUtility.writeSimpleXMLTag(pw, indent, "enableTimeAwards", isEnableTimeAwards());
+        MHQXMLUtility.writeSimpleXMLTag(pw, indent, "enableMiscAwards", isEnableMiscAwards());
+        //endregion Awards
         //endregion Personnel Tab
 
         //region Finances Tab
@@ -4470,6 +4666,43 @@ public static CampaignOptions generateCampaignOptionsFromXml(Node wn, Version ve
                         }
                     }
                 //endregion Death
+
+                //region Awards
+                } else if (wn2.getNodeName().equalsIgnoreCase("awardBonusStyle")) {
+                    retVal.setAwardBonusStyle(AwardBonus.valueOf(wn2.getTextContent().trim()));
+                } else if (wn2.getNodeName().equalsIgnoreCase("enableAutoAwards")) {
+                    retVal.setEnableAutoAwards(Boolean.parseBoolean(wn2.getTextContent().trim()));
+                } else if (wn2.getNodeName().equalsIgnoreCase("issuePosthumousAwards")) {
+                    retVal.setIssuePosthumousAwards(Boolean.parseBoolean(wn2.getTextContent().trim()));
+                } else if (wn2.getNodeName().equalsIgnoreCase("issueBestAwardOnly")) {
+                    retVal.setIssueBestAwardOnly(Boolean.parseBoolean(wn2.getTextContent().trim()));
+                } else if (wn2.getNodeName().equalsIgnoreCase("ignoreStandardSet")) {
+                    retVal.setIgnoreStandardSet(Boolean.parseBoolean(wn2.getTextContent().trim()));
+                } else if (wn2.getNodeName().equalsIgnoreCase("awardTierSize")) {
+                    retVal.setAwardTierSize(Integer.parseInt(wn2.getTextContent()));
+                } else if (wn2.getNodeName().equalsIgnoreCase("enableContractAwards")) {
+                    retVal.setEnableContractAwards(Boolean.parseBoolean(wn2.getTextContent().trim()));
+                } else if (wn2.getNodeName().equalsIgnoreCase("enableFactionHunterAwards")) {
+                    retVal.setEnableFactionHunterAwards(Boolean.parseBoolean(wn2.getTextContent().trim()));
+                } else if (wn2.getNodeName().equalsIgnoreCase("enableInjuryAwards")) {
+                    retVal.setEnableInjuryAwards(Boolean.parseBoolean(wn2.getTextContent().trim()));
+                } else if (wn2.getNodeName().equalsIgnoreCase("enableIndividualKillAwards")) {
+                    retVal.setEnableIndividualKillAwards(Boolean.parseBoolean(wn2.getTextContent().trim()));
+                } else if (wn2.getNodeName().equalsIgnoreCase("enableFormationKillAwards")) {
+                    retVal.setEnableFormationKillAwards(Boolean.parseBoolean(wn2.getTextContent().trim()));
+                } else if (wn2.getNodeName().equalsIgnoreCase("enableRankAwards")) {
+                    retVal.setEnableRankAwards(Boolean.parseBoolean(wn2.getTextContent().trim()));
+                } else if (wn2.getNodeName().equalsIgnoreCase("enableScenarioAwards")) {
+                    retVal.setEnableScenarioAwards(Boolean.parseBoolean(wn2.getTextContent().trim()));
+                } else if (wn2.getNodeName().equalsIgnoreCase("enableSkillAwards")) {
+                    retVal.setEnableSkillAwards(Boolean.parseBoolean(wn2.getTextContent().trim()));
+                } else if (wn2.getNodeName().equalsIgnoreCase("enableTheatreOfWarAwards")) {
+                    retVal.setEnableTheatreOfWarAwards(Boolean.parseBoolean(wn2.getTextContent().trim()));
+                } else if (wn2.getNodeName().equalsIgnoreCase("enableTimeAwards")) {
+                    retVal.setEnableTimeAwards(Boolean.parseBoolean(wn2.getTextContent().trim()));
+                } else if (wn2.getNodeName().equalsIgnoreCase("enableMiscAwards")) {
+                    retVal.setEnableMiscAwards(Boolean.parseBoolean(wn2.getTextContent().trim()));
+                //endregion Awards
                 //endregion Personnel Tab
 
                 //region Finances Tab

MekHQ/resources/mekhq/resources/CampaignGUI.properties

@@ -37,6 +37,7 @@
 import mekhq.campaign.parts.Armor;
 import mekhq.campaign.parts.Part;
 import mekhq.campaign.personnel.Person;
+import mekhq.campaign.personnel.autoAwards.AutoAwardsController;
 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,20 @@ public void resolveScenario(ScenarioStatus resolution, String report) {
             if (status.toRemove()) {
                 getCampaign().removePerson(person, false);
             }
+
+            if (getCampaign().getCampaignOptions().isEnableAutoAwards()) {
+                if (!person.getStatus().isDead() || getCampaign().getCampaignOptions().isIssuePosthumousAwards()) {
+                    int injuryCount = 0;
+
+                    if (status.getHits() > person.getHits()) {
+                        injuryCount = status.getHits() - person.getHits();
+                    }
+
+                    AutoAwardsController autoAwardsController = new AutoAwardsController();
+
+                    autoAwardsController.PostScenarioController(campaign, scenario.getId(), person.getId(), injuryCount);
+                }
+            }
         }
 
         //region Prisoners