Force - add doc comment

MegaMek · Oct 20, 2024 · d1690ef · d1690ef
1 parent b947336
commit d1690ef
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/MekHQ/src/mekhq/campaign/force/Force.java b/MekHQ/src/mekhq/campaign/force/Force.java
@@ -183,6 +183,11 @@ public int getScenarioId() {
         return scenarioId;
     }
 
+    /**
+     * Set scenario ID (e.g. deploy to scenario) for a force and all of its subforces and units
+     * @param scenarioId scenario to deploy to
+     * @param campaign campaign - required to update units
+     */
     public void setScenarioId(int scenarioId, Campaign campaign) {
         this.scenarioId = scenarioId;
         for (Force sub : getSubForces()) {