AtB - StratCon implementation

MekHQ/data/scenariomodifiers/airBattleModifiers.xml

@@ -22,9 +22,6 @@
 		<modifier>
 			GoodEquipment.xml
 		</modifier>
-		<modifier>
-			BadEvent.xml
-		</modifier>
 		<!--modifier> 
 			Need ability to allow player to specifically deploy dropships
 			HotDrop.xml
@@ -71,9 +68,6 @@
 		<modifier>
 			PreBattleDamageAllies.xml
 		</modifier>
-		<modifier>
-			GoodEvent.xml
-		</modifier>
 		<modifier>
 			AlliedTraineesAir.xml
 		</modifier>

MekHQ/data/scenariomodifiers/groundBattleModifiers.xml

@@ -43,9 +43,6 @@
 		<modifier>
 			GoodEquipment.xml
 		</modifier>
-		<modifier>
-			BadEvent.xml
-		</modifier>
 		<!--modifier> 
 			Need ability to allow player to specifically deploy dropships
 			HotDrop.xml
@@ -129,9 +126,6 @@
 		<modifier>
 			SearchAndRescue.xml
 		</modifier>
-		<modifier>
-			GoodEvent.xml
-		</modifier>
 		<modifier>
 			AlliedTraineesGround.xml
 		</modifier>

MekHQ/docs/AtB Stuff/stratcon-faq.txt

@@ -0,0 +1,62 @@
+StratCon reference and FAQ
+
+How do I get this started?
+Go to the AtB tab in Campaign Options and check "Use StratCon" at the very bottom.
+
+
+How do I use the StratCon tab?
+It's a graphical representation of one or more theatres of operations for your current AtB contract. It will have meaningful data once you arrive on the contract planet and the contract begins.
+
+Hexes where you've conducted recon are displayed as light gray, hexes where you have not are dark gray. Pro tip: if you want to reveal hexes faster, use a lance with the "scout" disposition, that'll reveal all hexes around the deployment hex.
+
+Allied facilities are displayed as green squares.
+Hostile facilities are displayed as red squares.
+Your forces deployed to the track are displayed as cyan circles.
+Pending scenarios against hostile forces are concentric red squares.
+
+
+That's great, how do I win?
+Under Integrated and House command, you need to keep your VP count positive. Every time you win a scenario which you didn't initiate, that's +1 VP. Every time you lose a scenario you didn't initiate, that's -1 VP. 
+
+Under Liaison command, you need to keep your VP count positive AND you're responsible for completing the given number of strategic objectives. On defensive contracts, this may include keeping allied facilities intact and under allied control. On offensive contracts, it's usually capturing/destroying facilities or winning specific scenarios. VPs are only affected by scenarios in which a liaison participates.
+
+Under Independent command, you're only responsible for completing strategic objectives.
+
+
+This scenario looks pretty tough, how do I bring in more forces?
+Right click on it and select 'manage scenario'. Now you have a couple of options:
+
+If your primary lance leader has leadership, and you have "auxiliary units" available (ones that are not of the same type as the main unit type of the primary force), you can deploy as many auxiliaries as you have leadership points.
+
+If your primary lance is in a 'defend' role, you can deploy up to 2 * (x + 1) your lance leader's tactics skill in infantry, battle armor squads and minefields. Any "left-over" defensive points are automatically converted into standard minefields.
+
+Finally, you can bring in additional lances, with rules as follows:
+- If the lance is already on the same track as the scenario, you can just deploy it as is.
+- If you have a support point or a victory point to spare, you can deploy the lance as is.
+- If the lance is in a 'fight' role, you can deploy it. However, on a 8- on a 2d6, it will add an extra negative modifier to the scenario.
+- Otherwise, you can attempt to deploy a lance anyway. 2-5 means deployment failure, 6-8 adds extra negative modifier, 9+ succeeds.
+
+
+I want to leave a lance deployed in the field so I don't have to pay SPs or risk extra negative modifiers, can I do that?
+Yep, right click on it and select 'remain deployed'. Now it will stay in the field until you uncheck that setting and be able to reinforce any scenarios you want without problems. However, you won't be able to carry out repairs or reloads.
+
+
+I don't want to do this scenario, can I skip it?
+Under integrated or house command, or if the liaison is coming along for the ride, you will lose a VP.
+Additionally, if there's an allied facility on the track, the scenario will move towards the nearest allied facility. Sometimes, you need to keep those intact as part of the contract. And if they get captured without a fight, the enemy will put them to use, making subsequent scenarios more difficult.
+
+
+There seems to be an excessive amount of enemy reinforcements coming into my battles, what gives?
+Might be a hostile facility or three on the track. Better do some recon and take them out, or, even better, capture them so you can use them. Or, you might just be having bad luck - each scenario can receive up to three modifiers.
+
+
+How do I capture a hostile facility?
+You'll need to complete the 'capture' objective in an attack scenario on it, without completing the 'destroy' objective. Meaning, you'll need to leave the facility turrets intact (though disabling them via crew kills, equipment destruction or ammo depletion is fine), while routing any mobile enemy ground units
+
+
+How do I manually deploy units to a track?
+Right click on the desired hex, and click the 'deploy force' item, then pick a force. Easy! Just watch out, the hostiles might not like it and may intercept your force.
+
+
+My units aren't showing up in the repair tab! Why?
+You've probably got them deployed to a StratCon track. Wait for them to come back, and don't deploy them to any additional scenarios.

MekHQ/src/mekhq/campaign/Campaign.java

@@ -101,6 +101,7 @@
 import mekhq.campaign.market.ShoppingList;
 import mekhq.campaign.market.UnitMarket;
 import mekhq.campaign.mission.AtBContract;
+import mekhq.campaign.mission.AtBDynamicScenario;
 import mekhq.campaign.mission.AtBScenario;
 import mekhq.campaign.mission.Contract;
 import mekhq.campaign.mission.Mission;
@@ -3025,12 +3026,19 @@ && getLocation().getJumpPath().getLastSystem().getId().equals(contract.getSystem
                     continue;
                 }
                 if ((s.getDate() != null) && s.getDate().isBefore(getLocalDate())) {
-                    s.setStatus(Scenario.S_DEFEAT);
-                    s.clearAllForcesAndPersonnel(this);
-                    contract.addPlayerMinorBreach();
+                    if (getCampaignOptions().getUseStratCon() &&
+                            s instanceof AtBDynamicScenario) {
+                        StratconRulesManager.processIgnoredScenario(
+                                (AtBDynamicScenario) s, contract.getStratconCampaignState());
+                    } else {
+                        s.setStatus(Scenario.S_DEFEAT);
+                        s.clearAllForcesAndPersonnel(this);
+                        contract.addPlayerMinorBreach();
+                        s.generateStub(this);
+                    }
+
                     addReport("Failure to deploy for " + s.getName()
-                            + " resulted in defeat and a minor contract breach.");
-                    s.generateStub(this);
+                    + " resulted in defeat and a minor contract breach.");
                 }
             }
         }

MekHQ/src/mekhq/campaign/mission/AtBDynamicScenario.java

@@ -381,7 +381,7 @@ public boolean alreadyHasModifier(AtBScenarioModifier modifier) {
 
     @Override
     public int getScenarioType() {
-        return 0;
+        return DYNAMIC;
     }
 
     @Override

MekHQ/src/mekhq/campaign/mission/AtBDynamicScenarioFactory.java

@@ -1930,23 +1930,28 @@ private static void setDeploymentTurns(AtBDynamicScenario scenario) {
         for (int x = 0; x < scenario.getNumBots(); x++) {
             BotForce currentBotForce = scenario.getBotForce(x);
             ScenarioForceTemplate forceTemplate = scenario.getBotForceTemplates().get(currentBotForce);
-            setDeploymentTurns(currentBotForce, forceTemplate.getArrivalTurn());
+            setDeploymentTurns(currentBotForce, forceTemplate.getArrivalTurn(), scenario);
         }
     }
 
     /**
      * Sets up deployment turns for all bot units within the specified bot force according to the specified force template's rules.
      * @param botForce The bot force to process
      * @param deployRound The specific deployment round, or a special constant.
+     * ARRIVAL_TURN_STAGGERED_BY_LANCE is not implemented.
      * ARRIVAL_TURN_STAGGERED is processed just prior to scenario start instead (?)
      */
-    public static void setDeploymentTurns(BotForce botForce, int deployRound) {
+    public static void setDeploymentTurns(BotForce botForce, int deployRound,
+            AtBDynamicScenario scenario) {
+        // deployment turns don't matter for transported entities
+        List<Entity> untransportedEntities = scenario.filterUntransportedUnits(botForce.getEntityList());
+
         if (deployRound == ScenarioForceTemplate.ARRIVAL_TURN_STAGGERED_BY_LANCE) {
-            setDeploymentTurnsStaggeredByLance(botForce.getEntityList());
+            setDeploymentTurnsStaggeredByLance(untransportedEntities);
         } else if (deployRound == ScenarioForceTemplate.ARRIVAL_TURN_AS_REINFORCEMENTS) {
-            setDeploymentTurnsForReinforcements(botForce.getEntityList(), 0);
+            setDeploymentTurnsForReinforcements(untransportedEntities, 0);
         } else {
-            for (Entity entity : botForce.getEntityList()) {
+            for (Entity entity : untransportedEntities) {
                 entity.setDeployRound(deployRound);
             }
         }
@@ -2115,7 +2120,7 @@ public static void setDeploymentTurnsForReinforcements(List<Entity> entityList,
             if (entity.getTransportId() != Entity.NONE) {
                 continue;
             }
-
+            
             int speed = calculateAtBSpeed(entity);
 
             // don't reduce minimum speed to 0, since dividing by zero further down is problematic

MekHQ/src/mekhq/campaign/mission/AtBScenario.java

@@ -27,10 +27,12 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.HashMap;
+import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
 import java.util.ResourceBundle;
+import java.util.Set;
 import java.util.StringJoiner;
 import java.util.UUID;
 import java.util.Vector;
@@ -70,6 +72,7 @@ public abstract class AtBScenario extends Scenario implements IAtBScenario {
     //region Variable Declarations
     private static final long serialVersionUID = 1148105510264408943L;
 
+    public static final int DYNAMIC = -1;
     public static final int BASEATTACK = 0;
     public static final int EXTRACTION = 1;
     public static final int CHASE = 2;
@@ -1957,6 +1960,28 @@ protected String getCsvFromList(List<?> list) {
     public AtBContract getContract(Campaign c) {
         return (AtBContract) c.getMission(getMissionId());
     }
+
+    /**
+     * Gets all the entities that are part of the given entity list and are 
+     * not in this scenario's transport linkages as a transported unit.
+     */
+    public List<Entity> filterUntransportedUnits(List<Entity> entities) {
+        List<Entity> retVal = new ArrayList<>();
+
+        // assemble a set of transported units for easier lookup
+        Set<String> transportedUnits = new HashSet<>();
+        for (List<String> transported : getTransportLinkages().values()) {
+            transportedUnits.addAll(transported);
+        }
+
+        for (Entity entity : entities) {
+            if (!transportedUnits.contains(entity.getExternalIdAsString())) {
+                retVal.add(entity);
+            }
+        }
+
+        return retVal;
+    }
 
     public int getLanceForceId() {
         return lanceForceId;

MekHQ/src/mekhq/campaign/mission/ScenarioTemplate.java

@@ -60,6 +60,8 @@ public ScenarioTemplate clone() {
         st.name = this.name;
         st.shortBriefing = this.shortBriefing;
         st.detailedBriefing = this.detailedBriefing;
+        st.isHostileFacility = this.isHostileFacility;
+        st.isAlliedFacility = this.isAlliedFacility;
         for (ScenarioForceTemplate sft : scenarioForces.values()) {
             st.scenarioForces.put(sft.getForceName(), sft.clone());
         }

MekHQ/src/mekhq/campaign/mission/atb/AtBScenarioModifierApplicator.java

@@ -74,7 +74,7 @@ private static void postAddForce(Campaign campaign, AtBDynamicScenario scenario,
         // the most recently added bot force is the one we just generated
         BotForce generatedBotForce = scenario.getBotForce(scenario.getNumBots() - 1);
         generatedBotForce.setStart(deploymentZone);
-        AtBDynamicScenarioFactory.setDeploymentTurns(generatedBotForce, templateToApply.getArrivalTurn());
+        AtBDynamicScenarioFactory.setDeploymentTurns(generatedBotForce, templateToApply.getArrivalTurn(), scenario);
         AtBDynamicScenarioFactory.setDestinationZone(generatedBotForce, templateToApply);
 
         // at this point, we have to re-translate the scenario objectives
@@ -95,6 +95,11 @@ private static void preAddForce(Campaign campaign, AtBDynamicScenario scenario,
      * Worker function that removes the number of units from the specified side.
      */
     public static void removeUnits(AtBDynamicScenario scenario, Campaign campaign, ForceAlignment eventRecipient, int unitRemovalCount) {
+        // can't do this if we don't have bots
+        if (scenario.getNumBots() == 0) {
+            return;
+        }
+
         int actualUnitsToRemove = unitRemovalCount;
 
         if (unitRemovalCount == ScenarioForceTemplate.FIXED_UNIT_SIZE_LANCE) {
@@ -112,7 +117,11 @@ public static void removeUnits(AtBDynamicScenario scenario, Campaign campaign, F
         for (int x = 0; x < actualUnitsToRemove; x++) {
             int botForceIndex = Compute.randomInt(scenario.getNumBots());
             BotForce bf = scenario.getBotForce(botForceIndex);
-            if (bf.getTeam() == ScenarioForceTemplate.TEAM_IDS.get(eventRecipient.ordinal())) {
+
+            // only remove units from a bot force if it's on the affected team
+            // AND if it has any units to remove
+            if ((bf.getTeam() == ScenarioForceTemplate.TEAM_IDS.get(eventRecipient.ordinal()))
+                    && (bf.getEntityList().size() > 0)) {
                 int unitIndexToRemove = Compute.randomInt(bf.getEntityList().size());
                 bf.removeEntity(unitIndexToRemove);
             }