Merge pull request #7251 from IllianiBird/factionStandingCommandCircuit

Improvement: Implemented Command Circuit Travel via GM Mode or Faction Standings

Author: IllianiBird

MekHQ/resources/mekhq/resources/CampaignGUI.properties

@@ -204,6 +204,10 @@ btnBeginTransit.text=Begin Transit
 chkAvoidAbandonedSystems.text=Avoid Empty Systems
 chkAvoidAbandonedSystems.toolTipText=Pathfinding will avoid abandoned systems. In-universe travelling in empty systems\
   \ was avoided whenever possible.
+chkUseCommandCircuits.text=Always Use Command Circuits (GM)
+chkUseCommandCircuits.toolTipText=Reduces all JumpShip recharge times to 10 hours (or less). While this is intended \
+  to represent the use of Command Circuits, it can also be used to reduce travel times resulting in a more fastpaced \
+  campaign.
 lblFindPlanet.text=Find Planet:
 panAssignedPatient.title=Assigned Patients
 panUnassignedPatient.title=Unassigned Patients

MekHQ/src/mekhq/campaign/Campaign.java

@@ -358,6 +358,7 @@ public class Campaign implements ITechManager {
 
     private CurrentLocation location;
     private boolean isAvoidingEmptySystems;
+    private boolean isOverridingCommandCircuitRequirements;
 
     private final News news;
 
@@ -458,6 +459,7 @@ public Campaign() {
         CurrencyManager.getInstance().setCampaign(this);
         location = new CurrentLocation(Systems.getInstance().getSystems().get("Galatea"), 0);
         isAvoidingEmptySystems = true;
+        isOverridingCommandCircuitRequirements = false;
         currentReport = new ArrayList<>();
         currentReportHTML = "";
         newReports = new ArrayList<>();
@@ -614,6 +616,14 @@ public void setIsAvoidingEmptySystems(boolean isAvoidingEmptySystems) {
         this.isAvoidingEmptySystems = isAvoidingEmptySystems;
     }
 
+    public boolean isOverridingCommandCircuitRequirements() {
+        return isOverridingCommandCircuitRequirements;
+    }
+
+    public void setIsOverridingCommandCircuitRequirements(boolean isOverridingCommandCircuitRequirements) {
+        this.isOverridingCommandCircuitRequirements = isOverridingCommandCircuitRequirements;
+    }
+
     /**
      * Returns the Hiring Hall level from the force's current system on the current date. If there is no hiring hall
      * present, the level is HiringHallLevel.NONE.
@@ -6766,6 +6776,10 @@ public void writeToXML(final PrintWriter writer) {
         finances.writeToXML(writer, indent);
         location.writeToXML(writer, indent);
         MHQXMLUtility.writeSimpleXMLTag(writer, indent, "isAvoidingEmptySystems", isAvoidingEmptySystems);
+        MHQXMLUtility.writeSimpleXMLTag(writer,
+              indent,
+              "isOverridingCommandCircuitRequirements",
+              isOverridingCommandCircuitRequirements);
         shoppingList.writeToXML(writer, indent);
         MHQXMLUtility.writeSimpleXMLOpenTag(writer, indent++, "kills");
         for (List<Kill> kills : kills.values()) {
@@ -7060,9 +7074,14 @@ public JumpPath calculateJumpPath(PlanetarySystem start, PlanetarySystem end) {
         // A* search
         final int MAX_JUMPS = 10000;
         for (int jumps = 0; jumps < MAX_JUMPS; jumps++) {
-            // Get current node's information
             PlanetarySystem currentSystem = systemsInstance.getSystemById(current);
-            double currentG = scoreG.get(current) + currentSystem.getRechargeTime(getLocalDate());
+
+            boolean isUseCommandCircuits =
+                  FactionStandingUtilities.isUseCommandCircuit(isOverridingCommandCircuitRequirements, gmMode,
+                  campaignOptions.isUseFactionStandingCommandCircuitSafe(), factionStandings, getActiveAtBContracts());
+
+            // Get current node's information
+            double currentG = scoreG.get(current) + currentSystem.getRechargeTime(getLocalDate(), isUseCommandCircuits);
             final String localCurrent = current;
 
             // Explore neighbors

MekHQ/src/mekhq/campaign/CampaignOptions.java

@@ -652,7 +652,7 @@ public static String getTechLevelName(final int techLevel) {
     private boolean useFactionStandingNegotiation;
     private boolean useFactionStandingResupply;
     private boolean useFactionStandingCommandCircuit;
-    private boolean useFactionStandingOutlawed;
+    private boolean useFactionStandingOutlawed; // TODO
     private boolean useFactionStandingBatchallRestrictions;
     private boolean useFactionStandingRecruitment;
     private boolean useFactionStandingBarracksCosts;

MekHQ/src/mekhq/campaign/CurrentLocation.java

@@ -58,6 +58,7 @@
 import mekhq.campaign.universe.Planet;
 import mekhq.campaign.universe.PlanetarySystem;
 import mekhq.campaign.universe.Systems;
+import mekhq.campaign.universe.factionStanding.FactionStandingUtilities;
 import mekhq.gui.baseComponents.immersiveDialogs.ImmersiveDialogSimple;
 import mekhq.utilities.MHQXMLUtility;
 import mekhq.utilities.ReportingUtilities;
@@ -158,56 +159,83 @@ private boolean pickJumpPoint(LocalDate now) {
         return randomInt(2) == 1;
     }
 
+    /**
+     * Use {@link #getReport(LocalDate, Money, boolean)} instead
+     */
+    @Deprecated(since = "0.50.07", forRemoval = true)
     public String getReport(LocalDate date, Money jumpCost) {
-        StringBuilder sb = new StringBuilder();
-        sb.append("<html>")
+        return getReport(date, jumpCost, false);
+    }
+
+    /**
+     * Generates a detailed status report for the current location and travel state.
+     *
+     * <p>The report includes:</p>
+     * <ul>
+     *   <li>The current system and position, indicating if on a planet, at a jump point (with recharge status),
+     *       in transit from a planet, or close to a jump point.</li>
+     *   <li>Travel progress, including the destination system, remaining jumps, or if already at the destination.</li>
+     *   <li>The estimated jump cost for the current journey.</li>
+     * </ul>
+     *
+     * <p>The report is formatted as HTML suitable for display in GUI components.</p>
+     *
+     * @param date                the current {@link LocalDate} for context-sensitive names and status
+     * @param jumpCost            the estimated jump cost as a {@link Money} value
+     * @param isUseCommandCircuit whether the command circuit option is enabled
+     *
+     * @return a formatted HTML string representing the travel and location status report
+     */
+    public String getReport(LocalDate date, Money jumpCost, boolean isUseCommandCircuit) {
+        double currentRechargeTime = currentSystem.getRechargeTime(date, isUseCommandCircuit);
+
+        StringBuilder report = new StringBuilder();
+        report.append("<html>")
               // First Line
               .append("In ").append(currentSystem.getPrintableName(date)).append(' ');
 
         if (isOnPlanet()) {
-            sb.append("on planet ").append(getPlanet().getPrintableName(date));
+            report.append("on planet ").append(getPlanet().getPrintableName(date));
         } else if (isAtJumpPoint()) {
-            sb.append("at jump point");
-            if (!Double.isInfinite(currentSystem.getRechargeTime(date))) {
-                sb.append(" (Jumpship ")
+            report.append("at jump point");
+            if (!Double.isInfinite(currentRechargeTime)) {
+                report.append(" (Jumpship ")
                       .append(String.format(Locale.ROOT,
                             "%.0f",
-                            (100.0 * rechargeTime) / currentSystem.getRechargeTime(date)))
+                            (100.0 * rechargeTime) / currentRechargeTime))
                       .append("% charged)");
             }
         } else {
             if ((null != jumpPath) && (currentSystem == jumpPath.getLastSystem())) {
-                sb.append(String.format(Locale.ROOT, "%.2f", getTransitTime())).append(" days from planet");
+                report.append(String.format(Locale.ROOT, "%.2f", getTransitTime())).append(" days from planet");
             } else {
                 double timeToJP = currentSystem.getTimeToJumpPoint(1.0) - getTransitTime();
-                sb.append(String.format(Locale.ROOT, "%.2f", timeToJP)).append(" days from jump point");
+                report.append(String.format(Locale.ROOT, "%.2f", timeToJP)).append(" days from jump point");
             }
-
         }
 
-        sb.append("<br/>");
+        report.append("<br/>");
 
         // Second Line
-
         if ((null != jumpPath) && !jumpPath.isEmpty()) {
-            sb.append("Traveling to ").append(jumpPath.getLastSystem().getPrintableName(date)).append(": ");
+            report.append("Traveling to ").append(jumpPath.getLastSystem().getPrintableName(date)).append(": ");
             if (jumpPath.getJumps() > 0) {
-                sb.append(jumpPath.getJumps())
+                report.append(jumpPath.getJumps())
                       .append(jumpPath.getJumps() == 1 ? " jump remaining" : " jumps remaining");
             } else {
-                sb.append("In destination system");
+                report.append("In destination system");
             }
         } else {
-            sb.append("Not traveling");
+            report.append("Not traveling");
         }
 
-        sb.append("<br/>");
+        report.append("<br/>");
 
         // Third Line
-        sb.append("Estimated Jump Cost: ").append(jumpCost.toAmountString()).append(" C-Bills<br><br>");
+        report.append("Estimated Jump Cost: ").append(jumpCost.toAmountString()).append(" C-Bills<br><br>");
 
-        sb.append("</html>");
-        return sb.toString();
+        report.append("</html>");
+        return report.toString();
     }
 
     public JumpPath getJumpPath() {
@@ -226,7 +254,11 @@ public void setJumpPath(JumpPath path) {
      * @return True if the JumpShip has to spend time recharging, otherwise false.
      */
     public boolean isRecharging(Campaign campaign) {
-        return currentSystem.getRechargeTime(campaign.getLocalDate()) > 0;
+        boolean isUseCommandCircuit = FactionStandingUtilities.isUseCommandCircuit(campaign.isOverridingCommandCircuitRequirements(),
+              campaign.isGM(), campaign.getCampaignOptions().isUseFactionStandingCommandCircuitSafe(),
+              campaign.getFactionStandings(), campaign.getActiveAtBContracts());
+
+        return currentSystem.getRechargeTime(campaign.getLocalDate(), isUseCommandCircuit) > 0;
     }
 
     /**
@@ -235,7 +267,11 @@ public boolean isRecharging(Campaign campaign) {
      * @param campaign The campaign object which owns the JumpShip.
      */
     public void setRecharged(Campaign campaign) {
-        rechargeTime = currentSystem.getRechargeTime(campaign.getLocalDate());
+        boolean isUseCommandCircuit = FactionStandingUtilities.isUseCommandCircuit(campaign.isOverridingCommandCircuitRequirements(),
+              campaign.isGM(), campaign.getCampaignOptions().isUseFactionStandingCommandCircuitSafe(),
+              campaign.getFactionStandings(), campaign.getActiveAtBContracts());
+
+        rechargeTime = currentSystem.getRechargeTime(campaign.getLocalDate(), isUseCommandCircuit);
     }
 
     /**
@@ -244,10 +280,14 @@ public void setRecharged(Campaign campaign) {
     public void newDay(Campaign campaign) {
         final boolean wasTraveling = !isOnPlanet();
 
+        boolean isUseCommandCircuit = FactionStandingUtilities.isUseCommandCircuit(campaign.isOverridingCommandCircuitRequirements(),
+              campaign.isGM(), campaign.getCampaignOptions().isUseFactionStandingCommandCircuitSafe(),
+              campaign.getFactionStandings(), campaign.getActiveAtBContracts());
+
         // recharge even if there is no jump path
         // because JumpShips don't go anywhere
         double hours = 24.0;
-        double neededRechargeTime = currentSystem.getRechargeTime(campaign.getLocalDate());
+        double neededRechargeTime = currentSystem.getRechargeTime(campaign.getLocalDate(), isUseCommandCircuit);
         double usedRechargeTime = Math.min(hours, neededRechargeTime - rechargeTime);
         if (usedRechargeTime > 0) {
             campaign.addReport("JumpShips spent " +

MekHQ/src/mekhq/campaign/JumpPath.java

@@ -25,6 +25,11 @@
  *
  * Catalyst Game Labs and the Catalyst Game Labs logo are trademarks of
  * InMediaRes Productions, LLC.
+ *
+ * MechWarrior Copyright Microsoft Corporation. MekHQ was created under
+ * Microsoft's "Game Content Usage Rules"
+ * <https://www.xbox.com/en-US/developers/rules> and it is not endorsed by or
+ * affiliated with Microsoft.
  */
 package mekhq.campaign;
 
@@ -33,12 +38,11 @@
 import java.util.ArrayList;
 import java.util.List;
 
-import org.w3c.dom.Node;
-import org.w3c.dom.NodeList;
-
 import megamek.logging.MMLogger;
 import mekhq.campaign.universe.PlanetarySystem;
 import mekhq.utilities.MHQXMLUtility;
+import org.w3c.dom.Node;
+import org.w3c.dom.NodeList;
 
 /**
  * This is an array list of planets for a jump path, from which we can derive
@@ -104,7 +108,26 @@ public double getEndTime() {
         return endTime;
     }
 
+    /**
+     * Use {@link #getTotalRechargeTime(LocalDate, boolean)} instead
+     */
     public double getTotalRechargeTime(LocalDate when) {
+        return getTotalRechargeTime(when, false);
+    }
+
+    /**
+     * Calculates the total recharge time, in days, required to complete a journey along the path of planetary systems.
+     *
+     * <p>This method iterates through each system in the path, excluding the first and last systems, and sums the
+     * rounded-up recharge time (in hours) for each waypoint. The total is then converted from hours to days.</p>
+     *
+     * @param when                the date to use for determining recharge times at each system
+     * @param isUseCommandCircuit {@code true} if command circuits are being utilized during the journey; may affect
+     *                            recharge efficiency or duration
+     *
+     * @return the total recharge time for the route, expressed in days
+     */
+    public double getTotalRechargeTime(LocalDate when, boolean isUseCommandCircuit) {
         int rechargeTime = 0;
         for (PlanetarySystem system : path) {
             if (system.equals(getFirstSystem())) {
@@ -113,7 +136,7 @@ public double getTotalRechargeTime(LocalDate when) {
             if (system.equals(getLastSystem())) {
                 continue;
             }
-            rechargeTime += (int) Math.ceil(system.getRechargeTime(when));
+            rechargeTime += (int) Math.ceil(system.getRechargeTime(when, isUseCommandCircuit));
         }
         return rechargeTime / 24.0;
     }
@@ -122,8 +145,36 @@ public int getJumps() {
         return size() - 1;
     }
 
+    /**
+     * Use {@link #getTotalTime(LocalDate, double, boolean)} instead
+     * <p>
+     * Used in Legacy AtB tests.
+     */
+    @Deprecated(since = "0.50.07", forRemoval = false)
     public double getTotalTime(LocalDate when, double currentTransit) {
-        return getTotalRechargeTime(when) + getStartTime(currentTransit) + getEndTime();
+        return getTotalTime(when, currentTransit, false);
+    }
+
+    /**
+     * Calculates the total journey time for the path of planetary systems, including recharge, start, and end times.
+     *
+     * <p>This method sums three parts:</p>
+     * <ul>
+     *     <li>Recharge time for intermediate planetary systems (in days), accounting for possible command circuit usage</li>
+     *     <li>Start time, based on the current transit</li>
+     *     <li>End time, representing final approach or operations at the destination</li>
+     * </ul>
+     *
+     * @param when                the date to use for all time calculations in the journey
+     * @param currentTransit      the remaining fraction of the current transit (in days or hours, depending on
+     *                            context)
+     * @param isUseCommandCircuit {@code true} if command circuits are used for the journey, which may affect recharge
+     *                            time calculations
+     *
+     * @return the total time required for the journey, in days
+     */
+    public double getTotalTime(LocalDate when, double currentTransit, boolean isUseCommandCircuit) {
+        return getTotalRechargeTime(when, isUseCommandCircuit) + getStartTime(currentTransit) + getEndTime();
     }
 
     public void addSystem(PlanetarySystem s) {