Merge pull request #6222 from Scoppio/feat/pacar-kill-convoys

Feat/pacar kill convoys

Author: IllianiBird

MekHQ/data/scenariotemplates/Convoy Escort.xml

@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <ScenarioTemplate>
     <name>Convoy Escort</name>
+    <stratConScenarioType>CONVOY</stratConScenarioType>
     <shortBriefing>Escort supply convoy or defeat attackers.</shortBriefing>
     <detailedBriefing>An allied convoy carrying critical supplies is moving through hostile territory, and enemy forces are preparing to intercept. Your mission is to ensure that the convoy reaches its destination. At least 50% of the convoy must reach the far edge of the engagement area intact. These supplies are vital to sustaining our operations, and failure is not an option.
 

MekHQ/data/scenariotemplates/Convoy Interdiction.xml

@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <ScenarioTemplate>
     <name>Convoy Interdiction</name>
+    <stratConScenarioType>CONVOY</stratConScenarioType>
     <shortBriefing>Intercept and neutralize enemy convoy.</shortBriefing>
     <detailedBriefing>An enemy convoy is on the move, and your orders are simple—hit them hard and stop at least 50% of their forces from reaching the far edge of the engagement zone. This is a direct strike, not a prolonged engagement. Destroy or cripple the convoy units with no regard for salvage or escort interference. Speed and overwhelming firepower are your greatest assets.
 

MekHQ/data/scenariotemplates/Convoy Raid.xml

@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <ScenarioTemplate>
     <name>Convoy Raid</name>
+    <stratConScenarioType>CONVOY</stratConScenarioType>
     <shortBriefing>Intercept and disrupt enemy convoy.</shortBriefing>
     <detailedBriefing>An enemy supply convoy is on the move, and this is our chance to cripple their logistics. Your mission is to intercept and raid the convoy before it can escape the engagement zone. These supplies are vital to the enemy’s war effort, and every truck or transport we eliminate weakens their ability to fight. Speed and aggression will be key—hit them hard, hit them fast, and get out before their reinforcements arrive.
 

MekHQ/data/scenariotemplates/Critical Convoy Escort.xml

@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <ScenarioTemplate>
     <name>Critical Convoy Escort</name>
+    <stratConScenarioType>CONVOY</stratConScenarioType>
     <shortBriefing>Escort critical convoy or defeat attackers.</shortBriefing>
     <detailedBriefing>An allied convoy carrying critical supplies is moving through hostile territory, and a large, heavily armed enemy force is preparing to intercept. Your mission is to ensure that at least 50% of the convoy reaches the far edge of the engagement area intact. These supplies are essential to sustaining our war effort, and failure is not an option.
 

MekHQ/data/scenariotemplates/Irregular Force Suppression.xml

@@ -2,7 +2,7 @@
 <ScenarioTemplate>
     <name>Irregular Force Suppression</name>
     <shortBriefing>Engage and defeat irregular-supported force.</shortBriefing>
-    <detailedBriefing>ocal insurgent forces are receiving direct military support in this region, strengthening their ability to disrupt our operations. If they are not dealt with decisively, they will continue to erode our control and pose a long-term threat. Your mission is to engage and destroy at least 50% of the combined enemy force, cutting off their ability to operate effectively.
+    <detailedBriefing>Local insurgent forces are receiving direct military support in this region, strengthening their ability to disrupt our operations. If they are not dealt with decisively, they will continue to erode our control and pose a long-term threat. Your mission is to engage and destroy at least 50% of the combined enemy force, cutting off their ability to operate effectively.
 
 Expect a blend of unconventional tactics and structured military resistance. The insurgents will use ambushes, terrain familiarity, and hit-and-run attacks, while their military allies will bring firepower, coordination, and heavier assets into the fight. Dismantle their cohesion, eliminate key targets, and disrupt their ability to function as a fighting force.
 

MekHQ/src/mekhq/MekHQ.java

@@ -61,13 +61,16 @@
 import mekhq.campaign.autoresolve.AtBSetupForces;
 import mekhq.campaign.handler.PostScenarioDialogHandler;
 import mekhq.campaign.handler.XPHandler;
+import mekhq.campaign.mission.AtBContract;
 import mekhq.campaign.mission.AtBDynamicScenario;
 import mekhq.campaign.mission.AtBScenario;
 import mekhq.campaign.mission.Scenario;
 import mekhq.campaign.mission.ScenarioTemplate;
 import mekhq.campaign.mission.ScenarioTemplate.BattlefieldControlType;
 import mekhq.campaign.personnel.Person;
+import mekhq.campaign.stratcon.StratconCampaignState;
 import mekhq.campaign.stratcon.StratconRulesManager;
+import mekhq.campaign.stratcon.StratconScenario;
 import mekhq.campaign.unit.Unit;
 import mekhq.gui.CampaignGUI;
 import mekhq.gui.dialog.ChooseMulFilesDialog;
@@ -476,8 +479,8 @@ public void startHost(Scenario scenario, boolean loadSavegame, List<Unit> meks,
         currentScenario = scenario;
 
         // Start the game thread - also refactor this into a factory
-        if (getCampaign().getCampaignOptions().isUseAtB() && (scenario instanceof AtBScenario)) {
-            gameThread = new AtBGameThread(playerName, password, client, this, meks, (AtBScenario) scenario, autoResolveBehaviorSettings, useExperimentalPacarGui, true);
+        if (getCampaign().getCampaignOptions().isUseAtB() && (scenario instanceof AtBScenario atBScenario)) {
+            gameThread = new AtBGameThread(playerName, password, client, this, meks, atBScenario, autoResolveBehaviorSettings, useExperimentalPacarGui, true);
         } else {
             gameThread = new GameThread(playerName, password, client, this, meks, scenario);
         }

MekHQ/src/mekhq/campaign/mission/enums/ScenarioType.java

@@ -50,7 +50,8 @@ public enum ScenarioType {
     NONE,
     SPECIAL_LOSTECH,
     SPECIAL_RESUPPLY,
-    SPECIAL_JAIL_BREAK;
+    SPECIAL_JAIL_BREAK,
+    CONVOY;
 
     /**
      * @return {@code true} if the scenario is considered a LosTech scenario, {@code false} otherwise.
@@ -59,6 +60,14 @@ public boolean isLosTech() {
         return this == SPECIAL_LOSTECH;
     }
 
+    /**
+     * @return {@code true} if the scenario is considered a convoy scenario, {@code false} otherwise. Convoy scenarios involve the
+     * defense or interception of a convoys with supplies, VIPs, or resupplies.
+     */
+    public boolean isConvoy() {
+        return this == SPECIAL_RESUPPLY || this == CONVOY;
+    }
+
     /**
      * @return {@code true} if the scenario is considered a Resupply scenario, {@code false} otherwise.
      */
@@ -110,7 +119,7 @@ public static ScenarioType parseFromString(final String text) {
         } catch (Exception ignored) {}
 
         MMLogger.create(ScenarioType.class)
-            .error("Unable to parse " + text + " into an ScenarioType. Returning NONE.");
+            .warn("Unable to parse {} into an ScenarioType. Returning NONE.", text);
 
         return NONE;
     }

MekHQ/src/mekhq/gui/BriefingTab.java

@@ -28,6 +28,7 @@
 package mekhq.gui;
 
 import megamek.client.bot.princess.BehaviorSettings;
+import megamek.client.bot.princess.PrincessException;
 import megamek.client.generator.ReconfigurationParameters;
 import megamek.client.generator.TeamLoadOutGenerator;
 import megamek.client.ui.baseComponents.MMComboBox;
@@ -830,10 +831,10 @@ private void startScenario(BehaviorSettings autoResolveBehaviorSettings) {
             }
         }
 
-        if (scenario instanceof AtBDynamicScenario) {
-            AtBDynamicScenarioFactory.setPlayerDeploymentTurns((AtBDynamicScenario) scenario, getCampaign());
-            AtBDynamicScenarioFactory.finalizeStaggeredDeploymentTurns((AtBDynamicScenario) scenario, getCampaign());
-            AtBDynamicScenarioFactory.setPlayerDeploymentZones((AtBDynamicScenario) scenario, getCampaign());
+        if (scenario instanceof AtBDynamicScenario atBDynamicScenario) {
+            AtBDynamicScenarioFactory.setPlayerDeploymentTurns(atBDynamicScenario, getCampaign());
+            AtBDynamicScenarioFactory.finalizeStaggeredDeploymentTurns(atBDynamicScenario, getCampaign());
+            AtBDynamicScenarioFactory.setPlayerDeploymentZones(atBDynamicScenario, getCampaign());
         }
 
         if (!undeployed.isEmpty()) {
@@ -847,10 +848,16 @@ private void startScenario(BehaviorSettings autoResolveBehaviorSettings) {
             }
         }
 
+        // Ensure that the MegaMek year GameOption matches the campaign year
+        // this is being set early on so that when setting up the autoconfig munitions
+        // the correct year is used
+        getCampaign().getGameOptions().getOption(OptionsConstants.ALLOWED_YEAR)
+            .setValue(getCampaign().getGameYear());
+
         // code to support deployment of reinforcements for legacy ATB scenarios.
-        if ((scenario instanceof AtBScenario) && !(scenario instanceof AtBDynamicScenario)) {
+        if ((scenario instanceof AtBScenario atBScenario) && !(scenario instanceof AtBDynamicScenario)) {
 
-            CombatTeam combatTeam = ((AtBScenario) scenario).getCombatTeamById(getCampaign());
+            CombatTeam combatTeam = atBScenario.getCombatTeamById(getCampaign());
             if (combatTeam != null) {
                 int assignedForceId = combatTeam.getForceId();
                 int cmdrStrategy = 0;
@@ -870,24 +877,64 @@ private void startScenario(BehaviorSettings autoResolveBehaviorSettings) {
             }
         }
 
-        if (getCampaign().getCampaignOptions().isUseAtB() && (scenario instanceof AtBScenario)) {
-            ((AtBScenario) scenario).refresh(getCampaign());
+        if (getCampaign().getCampaignOptions().isUseAtB() && (scenario instanceof AtBScenario atBScenario)) {
+            atBScenario.refresh(getCampaign());
 
             // Autoconfigure munitions for all non-player forces once more, using finalized
             // forces
             if (getCampaign().getCampaignOptions().isAutoConfigMunitions()) {
-                autoconfigureBotMunitions(((AtBScenario) scenario), chosen);
+                autoconfigureBotMunitions(atBScenario, chosen);
+            }
+            configureBotAi(atBScenario);
+        }
+
+        if (scenario.getStratConScenarioType().isConvoy() && (autoResolveBehaviorSettings != null)) {
+            try {
+                autoResolveBehaviorSettings = autoResolveBehaviorSettings.getCopy();
+                autoResolveBehaviorSettings.setIAmAPirate(true);
+            } catch (PrincessException e) {
+                logger.error("Failed to copy autoResolveBehaviorSettings", e);
             }
         }
 
         if (!chosen.isEmpty()) {
-            // Ensure that the MegaMek year GameOption matches the campaign year
-            getCampaign().getGameOptions().getOption(OptionsConstants.ALLOWED_YEAR)
-                    .setValue(getCampaign().getGameYear());
             getCampaignGui().getApplication()
                 .startHost(scenario, false, chosen, autoResolveBehaviorSettings);
+        }
+    }
+
+    private void configureBotAi(AtBScenario scenario) {
+        Faction opFor = getEnemyFactionFromScenario(scenario);
+        boolean isPirate = opFor.isRebelOrPirate();
+        for (var bf : scenario.getBotForces()) {
+            bf.getBehaviorSettings().setIAmAPirate(isPirate);
+        }
+    }
 
+    /**
+     * Get the enemy faction from the Mission from the scenario
+     * @param scenario the scenario to get the enemy faction from
+     * @return the enemy faction
+     */
+    private Faction getEnemyFactionFromScenario(Scenario scenario) {
+        Mission mission = null;
+        if (scenario.getMissionId() != -1) {
+            mission = getCampaign().getMission(scenario.getMissionId());
+        }
+        if (mission == null) {
+            mission = comboMission.getSelectedItem();
+        }
+        String opforFactionCode = "IS";
+        Faction enemy;
+        if (mission instanceof AtBContract atBContract) {
+            enemy = atBContract.getEnemy();
+            if (enemy != null) {
+                return atBContract.getEnemy();
+            }
+            opforFactionCode = atBContract.getEnemyCode().isBlank() ? opforFactionCode : atBContract.getEnemyCode();
         }
+        enemy = Factions.getInstance().getFaction(opforFactionCode);
+        return enemy;
     }
 
     /**