refactor(plugin): move movability validation into isGameOver

Author: anarchuser

plugin/src/client/sc/plugin2021/AbstractClient.kt

@@ -30,6 +30,8 @@ abstract class AbstractClient @Throws(IOException::class) constructor(
         private val gameType = GamePlugin.PLUGIN_UUID
     }
 
+    var isGameOver = false
+    
     /** The handler reacts to messages from the server received by the lobby client. */
     protected lateinit var handler: IGameHandler
 
@@ -94,10 +96,12 @@ abstract class AbstractClient @Throws(IOException::class) constructor(
         if(id == PlayerType.OBSERVER) return
 
         handler.onUpdate(gameState)
-        if(gameState.currentTeam == team) {
-            handler.onUpdate(gameState.currentPlayer, gameState.otherPlayer)
-        } else {
-            handler.onUpdate(gameState.otherPlayer, gameState.currentPlayer)
+        if (gameState.orderedColors.isNotEmpty()) {
+            if(gameState.currentTeam == team) {
+                handler.onUpdate(gameState.currentPlayer, gameState.otherPlayer)
+            } else {
+                handler.onUpdate(gameState.otherPlayer, gameState.currentPlayer)
+            }
         }
     }
 
@@ -123,6 +127,7 @@ abstract class AbstractClient @Throws(IOException::class) constructor(
 
     override fun onGameOver(roomId: String, data: GameResult) {
         logger.info("$this on Game Over with game result $data")
+        isGameOver = true
         if (this::handler.isInitialized) {
             handler.gameEnded(data, team, error)
         }

plugin/src/server/sc/plugin2021/Game.kt

@@ -161,12 +161,7 @@ class Game(UUID: String = GamePlugin.PLUGIN_UUID): RoundBasedGameInstance<Player
             logger.debug("Current State: $gameState")
             logger.debug("Performing Move $data")
             GameRuleLogic.performMove(gameState, data)
-            if (!isGameOver()) {
-                GameRuleLogic.validateMovability(gameState)
-                next(gameState.currentPlayer)
-            } else {
-                next(null)
-            }
+            next(if (isGameOver()) null else gameState.currentPlayer)
             logger.debug("Current Board:\n${gameState.board}")
         } catch(e: InvalidMoveException) {
             super.catchInvalidMove(e, fromPlayer)
@@ -175,5 +170,8 @@ class Game(UUID: String = GamePlugin.PLUGIN_UUID): RoundBasedGameInstance<Player
 
     override fun getCurrentState(): IGameState = gameState
 
-    fun isGameOver(): Boolean = gameState.orderedColors.isEmpty()
+    fun isGameOver(): Boolean {
+        GameRuleLogic.removeInvalidColors(gameState)
+        return gameState.orderedColors.isEmpty()
+    }
 }

plugin/src/shared/sc/plugin2021/GameState.kt

@@ -57,7 +57,12 @@ class GameState @JvmOverloads constructor(
         get() = try {
             orderedColors[currentColorIndex]
         } catch (e: IndexOutOfBoundsException) {
-            throw GameLogicException("Trying to access the currently active color after the game has ended")
+            logger.error("""
+                :-- Exception on accessing currentColor --:
+                orderedColors:     $orderedColors
+                currentColorIndex: $currentColorIndex
+            """.trimIndent())
+            throw GameLogicException("Trying to access the currently active color with invalid index")
         }
 
     @XStreamAsAttribute
@@ -111,14 +116,17 @@ class GameState @JvmOverloads constructor(
      *  Do not do anything with currentColor before the turn is done for good.
      */
     fun removeActiveColor() {
-        logger.info("Removed $currentColor from the game")
-        orderedColors.remove(currentColor)
+        logger.info("Removing $currentColor from the game")
+        orderedColors.removeAt(currentColorIndex)
         if (orderedColors.isNotEmpty())
             currentColorIndex = (currentColorIndex + orderedColors.size - 1) % orderedColors.size
         logger.debug("Remaining Colors: $orderedColors")
     }
 
-    override fun toString(): String = "GameState $round/$turn -> $currentColor ${if (GameRuleLogic.isFirstMove(this)) "(Start Piece: $startPiece)" else ""}"
+    override fun toString(): String =
+            if (orderedColors.isNotEmpty())
+                "GameState $round/$turn -> $currentColor ${if (GameRuleLogic.isFirstMove(this)) "(Start Piece: $startPiece)" else ""}"
+            else "GameState finished at $round/$turn"
 
     override fun equals(other: Any?): Boolean {
         return !(this === other) &&

plugin/src/shared/sc/plugin2021/util/GameRuleLogic.kt

@@ -215,9 +215,12 @@ object GameRuleLogic {
 
     /** Ensures the currently active color of [gameState] can perform a move. */
     @JvmStatic
-    fun validateMovability(gameState: GameState) {
-        if (streamPossibleMoves(gameState).none { isValidSetMove(gameState, it) })
+    fun removeInvalidColors(gameState: GameState) {
+        if (gameState.orderedColors.isEmpty()) return
+        if (streamPossibleMoves(gameState).none { isValidSetMove(gameState, it) }) {
             gameState.removeActiveColor()
+            removeInvalidColors(gameState)
+        }
     }
 
     /** Streams all possible moves in the current turn of [gameState]. */