Merge pull request #7234 from IllianiBird/factionStandingEffectsReport

Improvement: Replaced Placeholder Faction Standing Effect Text with Final

Author: rjhancock

MekHQ/resources/mekhq/resources/FactionStandings.properties

@@ -82,18 +82,18 @@ campaignOptionsChanged.description.disabled=You have just disabled <b>Faction St
   <p>{0}<b>Warning</b>:{1} This is a <b>permanent</b> change that <b>cannot be undone</b>.</p>
 # STANDING LEVELS
 ## Standing Effects
-factionStandingLevel.negotiation={0} to Contract Negotiations
-factionStandingLevel.resupply=Resupply Sizes at {0}%
-factionStandingLevel.commandCircuit={0}<b>Has Command Circuit Access</b>{1}
-factionStandingLevel.outlawed={0}<b>Outlawed: Planetary Access Forbidden</b>{1}
-factionStandingLevel.batchall={0}<b>Dezgra: Batchall Offers Revoked</b>{1}
-factionStandingLevel.recruitment.popularity={0} Recruitment Faction Popularity
-factionStandingLevel.recruitment.rolls={0} Recruitment Rolls
-factionStandingLevel.barracks={0}% Food & Housing Costs
-factionStandingLevel.unitMarket=Unit Type Rarity in the Unit Market
-factionStandingLevel.contractPay={0}% Contract Pay
-factionStandingLevel.supportPoints.signing={0} Support Points at Contract Signing
-factionStandingLevel.supportPoints.periodic={0} to Periodic Support Point Generation Checks
+factionStandingLevel.negotiation=Contract Negotiations ({0})
+factionStandingLevel.resupply=Resupply Sizes ({0}%)
+factionStandingLevel.commandCircuit=COMMAND CIRCUIT ACCESS GRANTED
+factionStandingLevel.outlawed=OUTLAWED: PLANETARY ACCESS REVOKED
+factionStandingLevel.batchall=DEZGRA: BATCHALL OFFERS REVOKED
+factionStandingLevel.recruitment.popularity=Recruitment Faction Popularity ({0})
+factionStandingLevel.recruitment.rolls=Recruitment Rolls ({0})
+factionStandingLevel.barracks=Food & Housing Costs ({0}%)
+factionStandingLevel.unitMarket=Unit Type Rarity in the Unit Market ({0})
+factionStandingLevel.contractPay=Contract Pay ({0}%)
+factionStandingLevel.supportPoints.signing=Support Points at Contract Signing ({0})
+factionStandingLevel.supportPoints.periodic=Periodic Support Point Generation Checks ({0})
 ## STANDING_LEVEL_0
 ### Inner Sphere
 factionStandingLevel.STANDING_LEVEL_0.innerSphere.label=An Enemy of the State

MekHQ/src/mekhq/campaign/universe/factionStanding/enums/FactionStandingLevel.java

@@ -32,21 +32,19 @@
  */
 package mekhq.campaign.universe.factionStanding.enums;
 
+import static java.lang.Math.round;
 import static mekhq.utilities.MHQInternationalization.getFormattedTextAt;
 import static mekhq.utilities.MHQInternationalization.getTextAt;
 import static mekhq.utilities.MHQInternationalization.isResourceKeyValid;
-import static mekhq.utilities.ReportingUtilities.CLOSING_SPAN_TAG;
-import static mekhq.utilities.ReportingUtilities.getNegativeColor;
-import static mekhq.utilities.ReportingUtilities.getPositiveColor;
-import static mekhq.utilities.ReportingUtilities.getWarningColor;
-import static mekhq.utilities.ReportingUtilities.spanOpeningWithCustomColor;
 
 import java.util.ArrayList;
 import java.util.List;
 
 import megamek.codeUtilities.MathUtility;
 import megamek.logging.MMLogger;
+import mekhq.campaign.CampaignOptions;
 import mekhq.campaign.universe.Faction;
+import mekhq.gui.dialog.reportDialogs.FactionStanding.FactionStandingReport;
 
 /**
  * Represents a standing level within the Faction Standing reputation system.
@@ -73,7 +71,7 @@ public enum FactionStandingLevel {
     STANDING_LEVEL_2(2, -40, -25, -2, 0.5, false, false, true, 1, 0, 1.75, -1, 0.8, -1, -2),
     STANDING_LEVEL_3(3, -25, -10, -1, 0.75, false, false, true, 2, 0, 1.5, 0, 0.9, 0, -1),
     STANDING_LEVEL_4(4, -10, 10, 0, 1.0, false, false, true, 3, 0, 1.0, 0, 1.0, 0, 0),
-    STANDING_LEVEL_5(5, 10, 25, 1, 1.9, false, false, true, 4, 0, 1.0, 0, 1.05, 0, 1),
+    STANDING_LEVEL_5(5, 10, 25, 1, 1.25, false, false, true, 4, 0, 1.0, 0, 1.05, 0, 1),
     STANDING_LEVEL_6(6, 25, 40, 2, 1.5, false, false, true, 5, 0, 0.85, 1, 1.1, 1, 1),
     STANDING_LEVEL_7(7, 40, 50, 3, 1.75, true, false, true, 10, 1, 0.80, 2, 1.15, 1, 2),
     STANDING_LEVEL_8(8, 50, Integer.MAX_VALUE, 4, 2.0, true, false, true, 15, 2, 0.75, 3, 1.2, 2, 3);
@@ -418,6 +416,14 @@ public String getDescription(Faction relevantFaction) {
         return label;
     }
 
+    /**
+     * Use {@link #getEffectsDescription(boolean, CampaignOptions)} instead
+     */
+    @Deprecated(since = "0.50.07", forRemoval = true)
+    public String getEffectsDescription() {
+        return getEffectsDescription(false, new CampaignOptions());
+    }
+
     /**
      * Generates a textual description of all effects based on the current faction standing modifiers.
      *
@@ -429,76 +435,74 @@ public String getDescription(Faction relevantFaction) {
      * @return a comma-separated {@link String} listing all active faction standing effects; returns
      * an empty string if there are no effects.
      */
-    public String getEffectsDescription() {
+    public String getEffectsDescription(boolean isClan, CampaignOptions campaignOptions) {
+        MMLogger logger = MMLogger.create(FactionStandingReport.class);
+        logger.info(this);
         List<String> effects = new ArrayList<>();
 
-        // If we're fetching for STANDING_LEVEL_4, then we're guaranteed not to pass any of the conditionals, so exit.
-        if (this == STANDING_LEVEL_4) {
-            return "";
+        if (hasCommandCircuitAccess && campaignOptions.isUseFactionStandingCommandCircuit()) {
+            effects.add(getFormattedTextAt(RESOURCE_BUNDLE, "factionStandingLevel.commandCircuit"));
         }
 
-        if (negotiationModifier != STANDING_LEVEL_4.getNegotiationModifier()) {
-            effects.add(getFormattedTextAt(RESOURCE_BUNDLE,
-                  "factionStandingLevel.negotiation",
-                  getPolarityOfModifier(negotiationModifier)));
+        if (isOutlawed && campaignOptions.isUseFactionStandingOutlawed()) {
+            effects.add(getFormattedTextAt(RESOURCE_BUNDLE, "factionStandingLevel.outlawed"));
         }
 
-        int resupplyPercentage = (int) resupplyWeightModifier * 100;
-        effects.add(getFormattedTextAt(RESOURCE_BUNDLE, "factionStandingLevel.resupply", resupplyPercentage));
-
-        if (hasCommandCircuitAccess) {
-            effects.add(getFormattedTextAt(RESOURCE_BUNDLE,
-                  "factionStandingLevel.commandCircuit",
-                  spanOpeningWithCustomColor(getPositiveColor()),
-                  CLOSING_SPAN_TAG));
+        if (isClan && !isBatchallAllowed && campaignOptions.isUseFactionStandingBatchallRestrictions()) {
+            effects.add(getFormattedTextAt(RESOURCE_BUNDLE, "factionStandingLevel.batchall"));
         }
 
-        if (isOutlawed) {
+        if (negotiationModifier != 0 && campaignOptions.isUseFactionStandingNegotiation()) {
             effects.add(getFormattedTextAt(RESOURCE_BUNDLE,
-                  "factionStandingLevel.outlawed",
-                  spanOpeningWithCustomColor(getNegativeColor()),
-                  CLOSING_SPAN_TAG));
+                  "factionStandingLevel.negotiation",
+                  getPolarityOfModifier(negotiationModifier)));
         }
 
-        if (!isBatchallAllowed) {
-            effects.add(getFormattedTextAt(RESOURCE_BUNDLE,
-                  "factionStandingLevel.batchall",
-                  spanOpeningWithCustomColor(getWarningColor()),
-                  CLOSING_SPAN_TAG));
+        if (resupplyWeightModifier != 1.0
+                  && campaignOptions.isUseStratCon()
+                  && campaignOptions.isUseFactionStandingResupply()) {
+            int resupplyPercentage = (int) round(resupplyWeightModifier * 100);
+            effects.add(getFormattedTextAt(RESOURCE_BUNDLE, "factionStandingLevel.resupply", resupplyPercentage));
         }
 
-        effects.add(getFormattedTextAt(RESOURCE_BUNDLE,
-              "factionStandingLevel.recruitment.popularity",
-              getPolarityOfModifier(recruitmentTickets - STANDING_LEVEL_4.getRecruitmentTickets())));
-
-        if (recruitmentRollsModifier != STANDING_LEVEL_4.getRecruitmentRollsModifier()) {
-            effects.add(getFormattedTextAt(RESOURCE_BUNDLE,
-                  "factionStandingLevel.recruitment.rolls",
-                  getPolarityOfModifier(recruitmentRollsModifier)));
+        if (campaignOptions.isUseFactionStandingRecruitment()) {
+            int ticketsModifier = recruitmentTickets - STANDING_LEVEL_4.getRecruitmentTickets();
+            if (ticketsModifier != 0) {
+                effects.add(getFormattedTextAt(RESOURCE_BUNDLE, "factionStandingLevel.recruitment.popularity",
+                      getPolarityOfModifier(ticketsModifier)));
+            }
+
+            if (recruitmentRollsModifier != 0) {
+                effects.add(getFormattedTextAt(RESOURCE_BUNDLE, "factionStandingLevel.recruitment.rolls",
+                      getPolarityOfModifier(recruitmentRollsModifier)));
+            }
         }
 
-        int barracksCostPercentage = (int) barrackCostsMultiplier * 100;
-        effects.add(getFormattedTextAt(RESOURCE_BUNDLE, "factionStandingLevel.barracks", barracksCostPercentage));
+        if (barrackCostsMultiplier != 1.0 && campaignOptions.isUseFactionStandingBarracksCosts()) {
+            int barracksCostPercentage = (int) round(barrackCostsMultiplier * 100);
+            effects.add(getFormattedTextAt(RESOURCE_BUNDLE, "factionStandingLevel.barracks", barracksCostPercentage));
+        }
 
-        if (unitMarketRarityModifier != STANDING_LEVEL_4.getUnitMarketRarityModifier()) {
-            effects.add(getFormattedTextAt(RESOURCE_BUNDLE,
-                  "factionStandingLevel.unitMarket",
+        if (unitMarketRarityModifier != 0 && campaignOptions.isUseFactionStandingUnitMarket()) {
+            effects.add(getFormattedTextAt(RESOURCE_BUNDLE, "factionStandingLevel.unitMarket",
                   getPolarityOfModifier(unitMarketRarityModifier)));
         }
 
-        int payPercentage = (int) contractPayMultiplier * 100;
-        effects.add(getFormattedTextAt(RESOURCE_BUNDLE, "factionStandingLevel.contractPay", payPercentage));
-
-        if (supportPointModifierContractStart != STANDING_LEVEL_4.getSupportPointModifierContractStart()) {
-            effects.add(getFormattedTextAt(RESOURCE_BUNDLE,
-                  "factionStandingLevel.supportPoints.signing",
-                  getPolarityOfModifier(supportPointModifierContractStart)));
+        if (contractPayMultiplier != 1.0 && campaignOptions.isUseFactionStandingContractPay()) {
+            int payPercentage = (int) round(contractPayMultiplier * 100);
+            effects.add(getFormattedTextAt(RESOURCE_BUNDLE, "factionStandingLevel.contractPay", payPercentage));
         }
 
-        if (supportPointModifierPeriodic != STANDING_LEVEL_4.getSupportPointModifierPeriodic()) {
-            effects.add(getFormattedTextAt(RESOURCE_BUNDLE,
-                  "factionStandingLevel.supportPoints.periodic",
-                  getPolarityOfModifier(supportPointModifierContractStart)));
+        if (campaignOptions.isUseFactionStandingSupportPoints()) {
+            if (supportPointModifierContractStart != 0) {
+                effects.add(getFormattedTextAt(RESOURCE_BUNDLE, "factionStandingLevel.supportPoints.signing",
+                      getPolarityOfModifier(supportPointModifierContractStart)));
+            }
+
+            if (supportPointModifierPeriodic != 0) {
+                effects.add(getFormattedTextAt(RESOURCE_BUNDLE, "factionStandingLevel.supportPoints.periodic",
+                      getPolarityOfModifier(supportPointModifierPeriodic)));
+            }
         }
 
         return String.join(", ", effects);

MekHQ/src/mekhq/gui/CommandCenterTab.java

@@ -595,7 +595,7 @@ private void initReportsPanel() {
                   getCampaign().getFaction(),
                   getCampaign().getCampaignFactionIcon(),
                   getCampaign().getMissions(),
-                  getCampaignOptions().isTrackFactionStanding());
+                  getCampaignOptions());
 
             for (String report : factionStandingReport.getReports()) {
                 if (report != null && !report.isBlank()) {

MekHQ/src/mekhq/gui/dialog/reportDialogs/FactionStanding/FactionStandingReport.java

@@ -66,6 +66,7 @@
 import megamek.logging.MMLogger;
 import megamek.utilities.ImageUtilities;
 import mekhq.MekHQ;
+import mekhq.campaign.CampaignOptions;
 import mekhq.campaign.mission.Mission;
 import mekhq.campaign.mission.enums.MissionStatus;
 import mekhq.campaign.universe.Faction;
@@ -125,6 +126,7 @@ public class FactionStandingReport extends JDialog {
     private final ImageIcon campaignIcon;
     private final List<Mission> missions;
     private final boolean isFactionStandingEnabled;
+    private final CampaignOptions campaignOptions;
 
     private final List<String> innerSphereFactions = new ArrayList<>();
     private final List<String> clanFactions = new ArrayList<>();
@@ -143,14 +145,14 @@ public class FactionStandingReport extends JDialog {
      * @param isGM A boolean indicating whether the user is a Game Master (GM).
      * @param campaignFaction The primary faction for the campaign associated with the report.
      * @param campaignIcon An {@link ImageIcon} for the campaign (either a custom user icon or faction icon).
-     * @param isFactionStandingEnabled {@code true} if the tacking of Faction Standing is enabled in campaign options; {@code false} otherwise.
+     * @param campaignOptions the {@link CampaignOptions} object associated with the current campaign.
      *
      * @author Illiani
      * @since 0.50.07
      */
     public FactionStandingReport(final JFrame frame, final FactionStandings factionStandings, final LocalDate today,
-                                 final boolean isGM, final Faction campaignFaction, final ImageIcon campaignIcon,
-                                 final Collection<Mission> missions, final boolean isFactionStandingEnabled) {
+          final boolean isGM, final Faction campaignFaction, final ImageIcon campaignIcon,
+          final Collection<Mission> missions, final CampaignOptions campaignOptions) {
         this.frame = frame;
         this.today = today;
         this.gameYear = today.getYear();
@@ -160,7 +162,8 @@ public FactionStandingReport(final JFrame frame, final FactionStandings factionS
         this.factionStandings = factionStandings;
         factions = Factions.getInstance();
         this.missions = new ArrayList<>(missions);
-        this.isFactionStandingEnabled = isFactionStandingEnabled;
+        this.isFactionStandingEnabled = campaignOptions.isTrackFactionStanding();
+        this.campaignOptions = campaignOptions;
 
         sortFactions();
         createReportPanel();
@@ -351,12 +354,8 @@ private JPanel createEffectsPanel() {
         lblStandingEffects.setBorder(null);
         lblStandingEffects.setFocusable(false);
         lblStandingEffects.setText("");
-        lblStandingEffects.setMinimumSize(new Dimension(Integer.MAX_VALUE, FACTION_EFFECTS_MINIMUM_HEIGHT));
-        lblStandingEffects.setPreferredSize(new Dimension(Integer.MAX_VALUE, FACTION_EFFECTS_MINIMUM_HEIGHT));
 
-        pnlEffects.add(lblStandingEffects, BorderLayout.CENTER);
-        pnlEffects.setMinimumSize(new Dimension(Integer.MAX_VALUE, FACTION_EFFECTS_MINIMUM_HEIGHT));
-        pnlEffects.setPreferredSize(new Dimension(Integer.MAX_VALUE, FACTION_EFFECTS_MINIMUM_HEIGHT));
+        pnlEffects.add(lblStandingEffects, BorderLayout.SOUTH);
 
         return pnlEffects;
     }
@@ -475,7 +474,8 @@ private JPanel createFactionPanel(final String factionCode) {
         pnlFactionStanding.setBorder(createStandingColoredRoundedTitledBorder(factionStanding.getStandingLevel()));
         pnlFactionStanding.setPreferredSize(new Dimension(FACTION_PANEL_WIDTH, FACTION_PANEL_HEIGHT));
         pnlFactionStanding.setMaximumSize(new Dimension(FACTION_PANEL_WIDTH, FACTION_PANEL_HEIGHT));
-        pnlFactionStanding.addMouseListener(createEffectsPanelUpdater(getEffectsDescription(climateRegard)));
+        pnlFactionStanding.addMouseListener(createEffectsPanelUpdater(getEffectsDescription(faction.isClan(),
+              climateRegard)));
 
         // Faction Logo
         ImageIcon icon = Factions.getFactionLogo(gameYear, factionCode);
@@ -645,15 +645,17 @@ private static JSlider getRegardSlider(String factionCode, double factionRegard,
     /**
      * Calculates the standing effects description string for a given faction regard value.
      *
+     * @param isClan {@code true} if the faction is a Clan faction, otherwise {@code false}
      * @param factionRegard the regard value of the faction
+     *
      * @return the standing effects description for the corresponding {@link FactionStandingLevel}
      *
      * @author Illiani
      * @since 0.50.07
      */
-    private static String getEffectsDescription(double factionRegard) {
+    private String getEffectsDescription(boolean isClan, double factionRegard) {
         FactionStandingLevel factionStanding = FactionStandingUtilities.calculateFactionStandingLevel(factionRegard);
-        return factionStanding.getEffectsDescription();
+        return factionStanding.getEffectsDescription(isClan, campaignOptions);
     }
 
     /**