Fix 10k rounds reached combat error. (#12564)

This would happen when edit mode was left on when switching to an AI player. This changes makes such transitions turn off edit mode as well as making all battle simulations ignore edit mode.
triplea-game · May 4, 2024 · 565f203 · 565f203
1 parent 3eb8bf0
commit 565f203
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 1 deletion.
diff --git a/game-app/game-core/src/main/java/games/strategy/engine/data/GameStep.java b/game-app/game-core/src/main/java/games/strategy/engine/data/GameStep.java
@@ -93,7 +93,7 @@ public GameStep(
     properties = stepProperties;
   }
 
-  public GamePlayer getPlayerId() {
+  public @Nullable GamePlayer getPlayerId() {
     return player;
   }
 

diff --git a/game-app/game-core/src/main/java/games/strategy/engine/framework/ServerGame.java b/game-app/game-core/src/main/java/games/strategy/engine/framework/ServerGame.java
@@ -1,6 +1,7 @@
 package games.strategy.engine.framework;
 
 import static com.google.common.base.Preconditions.checkNotNull;
+import static games.strategy.triplea.Constants.EDIT_MODE;
 
 import games.strategy.engine.GameOverException;
 import games.strategy.engine.data.Change;
@@ -40,6 +41,7 @@
 import games.strategy.net.Messengers;
 import games.strategy.net.websocket.ClientNetworkBridge;
 import games.strategy.triplea.delegate.DiceRoll;
+import games.strategy.triplea.delegate.EditDelegate;
 import games.strategy.triplea.settings.ClientSetting;
 import java.io.IOException;
 import java.nio.file.Files;
@@ -467,6 +469,15 @@ private void runStep(final boolean stepIsRestoredFromSavedGame) {
               ? launchAction.getAutoSaveFileUtils().getEvenRoundAutoSaveFile()
               : launchAction.getAutoSaveFileUtils().getOddRoundAutoSaveFile());
     }
+    // Turn off Edit Mode if we're transitioning to an AI player to prevent infinite round combats.
+    if (EditDelegate.getEditMode(gameData.getProperties())) {
+      GamePlayer newPlayer = gameData.getSequence().getStep().getPlayerId();
+      if (newPlayer != null && newPlayer.isAi() && !newPlayer.equals(currentStep.getPlayerId())) {
+        String text = "Turning off Edit Mode when switching to AI player";
+        gameData.getHistory().getHistoryWriter().startEvent(text);
+        gameData.getProperties().set(EDIT_MODE, false);
+      }
+    }
     if (!isMoveStep && shouldAutoSaveAfterEnd(currentDelegate)) {
       autoSaveAfter(currentDelegate);
     }

diff --git a/...-app/game-core/src/main/java/games/strategy/triplea/odds/calculator/BattleCalculator.java b/...-app/game-core/src/main/java/games/strategy/triplea/odds/calculator/BattleCalculator.java
@@ -1,5 +1,7 @@
 package games.strategy.triplea.odds.calculator;
 
+import static games.strategy.triplea.Constants.EDIT_MODE;
+
 import com.google.common.base.Preconditions;
 import games.strategy.engine.data.CompositeChange;
 import games.strategy.engine.data.GameData;
@@ -44,6 +46,7 @@ class BattleCalculator implements IBattleCalculator {
 
   BattleCalculator(byte[] data) {
     gameData = GameDataUtils.createGameDataFromBytes(data).orElseThrow();
+    gameData.getProperties().set(EDIT_MODE, false);
   }
 
   @Override