Merge pull request #7290 from IllianiBird/factionStandingPhase2

Improvement: Numerous Faction Standing Improvements; Added Faction Standing Events

Author: IllianiBird

MekHQ/resources/mekhq/resources/FactionJudgmentDialog.properties

@@ -0,0 +1,32 @@
+# suppress inspection "UnusedMessageFormatParameter" for the whole file
+# suppress inspection "UnusedProperty" for the whole file
+# Bonus
+FactionAccoladeDialog.credit=A generous donation.
+# Confirmation
+FactionAccoladeDialog.confirmation.inCharacter=Are you sure, {0}?
+FactionAccoladeDialog.confirmation.outOfCharacter=<b>WARNING:</b> each faction will only make this offer once per \
+  campaign.
+FactionAccoladeDialog.confirmation.button.confirm=(Confirm) Continue as ordered.
+FactionAccoladeDialog.confirmation.button.cancel=(Cancel) Let me reconsider.
+# General
+FactionStandingUtilities.clan=Clan
+FactionStandingUtilities.the=the
+FactionCensureDialog.button.cancel=Cancel
+FactionCensureDialog.button.confirm=Confirm
+FactionCensureEvent.fine=Legal censure
+# FactionCensureGoingRogueDialog
+FactionCensureGoingRogueDialog.possibleFactions=Possible Factions:
+FactionCensureGoingRogueDialog.inCharacter=I''ve put together a list of our options.\
+  <p>I hope you know what you''re doing, {0}...</p>
+FactionCensureGoingRogueDialog.outOfCharacter=This process will change your campaign faction. All other campaign \
+  settings, including the rank system used, will be unchanged.\
+  <p>The factions you can choose are dependent on the galactic political climate. Only the enemy of your current \
+  faction, or their rivals, will be willing to accept you. Alternatively, the mercenary and pirate factions are \
+  almost always available.</p>\
+  <p>Changing faction will test the loyalties of all personnel, and it is likely some will choose to remain with your \
+  current faction. This will cause them to leave your campaign.</p>\
+  <p>Defecting (changing to a faction other than Mercenary or Pirate) will not be bloodless, expect casualties.</p>
+FactionCensureConfirmationDialog.button.confirm=(Continue) Yes
+FactionCensureConfirmationDialog.button.cancel=(Return) No
+FactionCensureConfirmationDialog.inCharacter=Are you sure, {0}?\
+  <p>Once I send your answer, there''s no turning back.</p>

MekHQ/resources/mekhq/resources/FactionJudgmentNewsArticle.properties

@@ -291,7 +291,10 @@ factionStandingLevel.STANDING_LEVEL_3.innerSphere.label=Distrusted
 factionStandingLevel.STANDING_LEVEL_3.innerSphere.description=Few believe in your loyalty. Every job comes with a watchful\
   \ eye.
 factionStandingLevel.STANDING_LEVEL_3.CC.label=Watched
-factionStandingLevel.STANDING_LEVEL_3.CC.description=You are tolerated but not trusted. The ISF observes your every move.
+factionStandingLevel.STANDING_LEVEL_3.CC.description=You are tolerated but not trusted. The Maskirovka observes your every move.
+factionStandingLevel.STANDING_LEVEL_3.DC.label=Tolerated
+factionStandingLevel.STANDING_LEVEL_3.DC.description=You are permitted to operate, but only under suspicion. Your \
+  loyalty remains uncertain.
 factionStandingLevel.STANDING_LEVEL_3.LA.label=A Liability
 factionStandingLevel.STANDING_LEVEL_3.LA.description=Association with your unit reflects poorly on Lyran officers.\
   \ Resources are restricted.

MekHQ/resources/mekhq/resources/FactionJudgmentSceneDialog.properties

@@ -1,3 +1,4 @@
+# suppress inspection "UnusedProperty" for the whole file
 ### NORMAL
 ACTIVE.label=Active
 ACTIVE.tooltip=They are currently a member of the force.
@@ -59,18 +60,19 @@ ENEMY_BONDSMAN.label=Enemy Bondsman
 ENEMY_BONDSMAN.tooltip=They were taken as a Bondsman by enemy forces.
 ENEMY_BONDSMAN.report=The enemy has claimed %s as a {0}<b>Bondsman</b>{1}.
 ENEMY_BONDSMAN.log=Taken as a Bondsman
-BONDSREF.label=Bondsref
-BONDSREF.tooltip=They have performed Bondsref
-BONDSREF.report=%s has preformed {0}<b>Bondsref</b>{1} instead of becoming a Bondsman.
-BONDSREF.log=Performed Bondsref
-SEPPUKU.label=Seppuku
-SEPPUKU.tooltip=They have performed Seppuku
-SEPPUKU.report=%s has performed {0}<b>Seppuku</b>{1} instead of becoming a Prisoner.
-SEPPUKU.log=Performed Seppuku
 BACKGROUND_CHARACTER.label=Background Character
 BACKGROUND_CHARACTER.tooltip=They are part of someone else's story
 BACKGROUND_CHARACTER.report=%s exited stage left.
 BACKGROUND_CHARACTER.log=Fell Into The Background
+IMPRISONED.label=Imprisoned
+IMPRISONED.tooltip=They have been imprisoned for their crimes
+IMPRISONED.report=%s has been {0}<b>Imprisoned</b>{1} for their crimes.
+IMPRISONED.log=Was imprisoned for their crimes
+DISHONORABLY_DISCHARGED.label=Dishonorably Discharged
+DISHONORABLY_DISCHARGED.tooltip=They have been dishonorably discharged
+DISHONORABLY_DISCHARGED.report=%s has been {0}<b>Dishonorably Discharged</b>{1}.
+DISHONORABLY_DISCHARGED.log=Was dishonorably discharged
+
 ### DEATH
 KIA.label=Killed in Action
 KIA.tooltip=They have been killed in action.
@@ -116,3 +118,11 @@ SUICIDE.label=Died from Suicide
 SUICIDE.tooltip=They took their own life.
 SUICIDE.report=%s has died by {0}<b>Suicide</b>{1}.
 SUICIDE.log=Took their own life
+BONDSREF.label=Bondsref
+BONDSREF.tooltip=They have performed Bondsref
+BONDSREF.report=%s has preformed {0}<b>Bondsref</b>{1} instead of becoming a Bondsman.
+BONDSREF.log=Performed Bondsref
+SEPPUKU.label=Seppuku
+SEPPUKU.tooltip=They have performed Seppuku
+SEPPUKU.report=%s has retained their honor by performing {0}<b>Seppuku</b>{1}.
+SEPPUKU.log=Performed Seppuku

MekHQ/resources/mekhq/resources/FactionStandingJudgments.properties

@@ -244,6 +244,10 @@
 import mekhq.campaign.universe.enums.HiringHallLevel;
 import mekhq.campaign.universe.eras.Era;
 import mekhq.campaign.universe.eras.Eras;
+import mekhq.campaign.universe.factionStanding.FactionAccoladeEvent;
+import mekhq.campaign.universe.factionStanding.FactionAccoladeLevel;
+import mekhq.campaign.universe.factionStanding.FactionCensureEvent;
+import mekhq.campaign.universe.factionStanding.FactionCensureLevel;
 import mekhq.campaign.universe.factionStanding.FactionStandingUtilities;
 import mekhq.campaign.universe.factionStanding.FactionStandings;
 import mekhq.campaign.universe.factionStanding.PerformBatchall;
@@ -5685,6 +5689,7 @@ public boolean newDay() {
         // Advance the day by one
         final LocalDate yesterday = currentDay;
         currentDay = currentDay.plusDays(1);
+        boolean isMonday = currentDay.getDayOfWeek() == DayOfWeek.MONDAY;
         boolean isFirstOfMonth = currentDay.getDayOfMonth() == 1;
         boolean isNewYear = currentDay.getDayOfYear() == 1;
 
@@ -5764,7 +5769,7 @@ public boolean newDay() {
 
         // Prisoner events can occur on Monday or the 1st of the month depending on the
         // type of event
-        if (currentDay.getDayOfWeek() == DayOfWeek.MONDAY || isFirstOfMonth) {
+        if (isMonday || isFirstOfMonth) {
             new PrisonerEventManager(this);
         }
 
@@ -5794,7 +5799,7 @@ public boolean newDay() {
             }
         }
 
-        if (topUpWeekly && currentDay.getDayOfWeek() == DayOfWeek.MONDAY) {
+        if (topUpWeekly && isMonday) {
             int bought = stockUpPartsInUse(getPartsInUse(ignoreMothballed, false, ignoreSparesUnderQuality));
             addReport(String.format(resources.getString("weeklyStockCheck.text"), bought));
         }
@@ -5805,16 +5810,85 @@ public boolean newDay() {
         }
 
         // Faction Standing
-        if (isFirstOfMonth && campaignOptions.isTrackFactionStanding()) {
-            String report = factionStandings.updateClimateRegard(faction, currentDay);
-            addReport(report);
+        if (campaignOptions.isTrackFactionStanding()) {
+            performFactionStandingChecks(isFirstOfMonth);
         }
 
         // This must be the last step before returning true
         MekHQ.triggerEvent(new NewDayEvent(this));
         return true;
     }
 
+    /**
+     * Performs all daily and periodic standing checks for factions relevant to this campaign.
+     *
+     * <p>On the first day of the month, this method updates the climate regard for the active campaign faction,
+     * storing a summary report. It then iterates once through all faction standings and, for each faction:</p>
+     *
+     * <ul>
+     *     <li>Checks for new censure actions and handles the creation of related events.</li>
+     *     <li>Evaluates for new accolade levels, creating corresponding events.</li>
+     *     <li>Warns if any referenced faction cannot be resolved.</li>
+     * </ul>
+     *
+     * <p>Finally, at the end of the checks, it processes censure degradation for all factions.</p>
+     *
+     * @param isFirstOfMonth {@code true} if called on the first day of the month.
+     *
+     * @author Illiani
+     * @since 0.50.07
+     */
+    private void performFactionStandingChecks(boolean isFirstOfMonth) {
+        if (isFirstOfMonth) {
+            String report = factionStandings.updateClimateRegard(faction, currentDay);
+            addReport(report);
+        }
+
+        List<Mission> activeMissions = getActiveMissions(false);
+        boolean isInTransit = !location.isOnPlanet();
+        Factions factions = Factions.getInstance();
+
+        for (Entry<String, Double> standing : factionStandings.getAllFactionStandings().entrySet()) {
+            String factionCode = standing.getKey();
+            Faction relevantFaction = factions.getFaction(factionCode);
+            if (relevantFaction == null) {
+                logger.warn("Unable to fetch faction standing for faction: {}", factionCode);
+                continue;
+            }
+
+            // Censure check
+            if (relevantFaction.equals(faction)
+                      || (faction.getShortName().equals("MERC") && relevantFaction.isMercenaryOrganization())) {
+                FactionCensureLevel newCensureLevel = factionStandings.checkForCensure(
+                      relevantFaction, currentDay, activeMissions, isInTransit);
+                if (newCensureLevel != null) {
+                    new FactionCensureEvent(this, newCensureLevel, relevantFaction);
+                }
+            }
+
+            // Accolade check
+            boolean ignoreEmployer = relevantFaction.isMercenaryOrganization();
+            boolean isOnMission = FactionStandingUtilities.isIsOnMission(
+                  !isInTransit,
+                  getActiveAtBContracts(),
+                  activeMissions,
+                  relevantFaction.getShortName(),
+                  location.getCurrentSystem(),
+                  ignoreEmployer);
+
+            FactionAccoladeLevel newAccoladeLevel = factionStandings.checkForAccolade(
+                  relevantFaction, currentDay, isOnMission);
+
+            if (newAccoladeLevel != null) {
+                new FactionAccoladeEvent(this, relevantFaction, newAccoladeLevel,
+                      faction.equals(relevantFaction));
+            }
+        }
+
+        // Censure degradation
+        factionStandings.processCensureDegradation(currentDay);
+    }
+
     public void refreshPersonnelMarkets() {
         PersonnelMarketStyle marketStyle = campaignOptions.getPersonnelMarketStyle();
         if (marketStyle == PERSONNEL_MARKET_DISABLED) {
@@ -6025,6 +6099,13 @@ private void processEducationNewDay() {
         }
     }
 
+    /**
+     * Retrieves the flagged commander from the personnel list. If no flagged commander is found returns {@code null}.
+     *
+     * <p><b>Usage:</b> consider using {@link #getCommander()} instead.</p>
+     *
+     * @return the flagged commander if present, otherwise {@code null}
+     */
     public @Nullable Person getFlaggedCommander() {
         return getPersonnel().stream().filter(Person::isCommander).findFirst().orElse(null);
     }

MekHQ/resources/mekhq/resources/FactionStandings.properties

@@ -653,7 +653,10 @@ private void updateEnemy(Campaign campaign, LocalDate today) {
 
             if (tracksStanding) {
                 // Whenever we dynamically change the enemy faction, we update standing accordingly
-                factionStandings.processContractAccept(campaignFactionCode, faction, today);
+                String report = factionStandings.processContractAccept(campaignFactionCode, faction, today);
+                if (report != null) {
+                    campaign.addReport(report);
+                }
             }
         }
     }

MekHQ/resources/mekhq/resources/PersonnelStatus.properties

@@ -88,7 +88,9 @@ public enum PersonnelStatus {
     ENEMY_BONDSMAN(NotificationSeverity.NEGATIVE, false, false),
     BONDSREF(NotificationSeverity.NEGATIVE, true, true),
     SEPPUKU(NotificationSeverity.NEGATIVE, true, true),
-    BACKGROUND_CHARACTER(NotificationSeverity.WARNING, false, false);
+    BACKGROUND_CHARACTER(NotificationSeverity.WARNING, false, false),
+    IMPRISONED(NotificationSeverity.NEGATIVE, false, false),
+    DISHONORABLY_DISCHARGED(NotificationSeverity.NEGATIVE, false, false);
 
     /**
      * Represents the severity levels of a status.
@@ -488,6 +490,16 @@ public boolean isEnemyBondsman() {
         return this == ENEMY_BONDSMAN;
     }
 
+    /**
+     * Checks if the character has the {@link #DISHONORABLY_DISCHARGED} personnel status.
+     *
+     * @return {@code true} if the character has the {@link #DISHONORABLY_DISCHARGED} personnel status {@code false}
+     *       otherwise.
+     */
+    public boolean isDishonorablyDischarged() {
+        return this == DISHONORABLY_DISCHARGED;
+    }
+
     /**
      * Checks if the character has the {@link #BONDSREF} personnel status.
      *
@@ -516,18 +528,25 @@ public boolean isBackground() {
         return this == BACKGROUND_CHARACTER;
     }
 
+    /**
+     * Checks if the character has the {@link #IMPRISONED} personnel status.
+     *
+     * @return {@code true} if the character has the {@link #IMPRISONED} personnel status {@code false} otherwise.
+     */
+    public boolean isImprisoned() {
+        return this == IMPRISONED;
+    }
+
     /**
      * @return {@code true} if a person is currently absent from the core force, otherwise {@code false}
      */
     public boolean isAbsent() {
         return isMIA() ||
                      isPoW() ||
-                     isEnemyBondsman() ||
                      isOnLeave() ||
                      isOnMaternityLeave() ||
                      isAwol() ||
-                     isStudent() ||
-                     isMissing();
+                     isStudent();
     }
 
     /**
@@ -553,7 +572,10 @@ public boolean isDepartedUnit() {
                      isDeserted() ||
                      isDefected() ||
                      isMissing() ||
-                     isLeft() || isEnemyBondsman() ||
+                     isLeft() ||
+                     isImprisoned() ||
+                     isEnemyBondsman() ||
+                     isDishonorablyDischarged() ||
                      // We count background characters as departed, even though they technically never joined
                      isBackground();
     }

MekHQ/src/mekhq/campaign/Campaign.java

@@ -40,11 +40,6 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
-import org.w3c.dom.Document;
-import org.w3c.dom.Element;
-import org.w3c.dom.Node;
-import org.w3c.dom.NodeList;
-
 import megamek.Version;
 import megamek.common.annotations.Nullable;
 import megamek.common.event.Subscribe;
@@ -64,6 +59,10 @@
 import mekhq.campaign.storyarc.storypoint.TravelStoryPoint;
 import mekhq.campaign.storyarc.storypoint.WaitStoryPoint;
 import mekhq.utilities.MHQXMLUtility;
+import org.w3c.dom.Document;
+import org.w3c.dom.Element;
+import org.w3c.dom.Node;
+import org.w3c.dom.NodeList;
 
 /**
  * The Story Arc class manages a given story arc campaign.
@@ -554,7 +553,7 @@ private static void updateReplacementTokens(Campaign c) {
         }
 
         // get commander information
-        Person commander = c.getSeniorCommander();
+        Person commander = c.getCommander();
         if (null == commander) {
             // shouldn't happen unless there are no personnel, but just in case
             replacementTokens.put("\\{commanderCallsign\\}", "callsign(?)");