feat(plugin): add getAllMoves for GameState

Author: xeruf

.dev/scopes.txt

@@ -12,6 +12,7 @@ testclient
 player
 server
 
+plugin
 plugin23
 plugin24
 gamerules

plugin/src/main/kotlin/sc/plugin2023/GameState.kt

@@ -66,6 +66,9 @@ data class GameState @JvmOverloads constructor(
                 board.filterValues { it.fish == 1 }.map { Move(null, it.key) }
             }
 
+    override fun getAllMoves(): Iterator<IMove> =
+            getSensibleMoves().iterator()
+    
     fun canPlacePenguin(pos: Coordinates) = !penguinsPlaced && board[pos].fish == 1
 
     fun immovable(team: Team? = null) =

plugin/src/main/kotlin/sc/plugin2024/GameState.kt

@@ -132,6 +132,10 @@ data class GameState @JvmOverloads constructor(
     override fun getSensibleMoves(): List<IMove> =
             getPossibleMoves(currentShip.coal.coerceAtMost(1)).ifEmpty { getPossibleMoves() }
 
+    /** TODO Incomplete */
+    override fun getAllMoves(): Iterator<IMove> =
+            getPossibleMoves().iterator()
+    
     // TODO this should be a Stream
     /** Possible simple Moves (accelerate+turn+move) using at most the given coal amount. */
     fun getPossibleMoves(maxCoal: Int = currentShip.coal): List<IMove> =

plugin/src/test/kotlin/sc/plugin2024/BoardTest.kt

@@ -133,12 +133,12 @@ class BoardTest: FunSpec({
         }
 
         test("return false when rotation mismatch") {
-            val board = Board(listOf(Segment(CubeDirection.RIGHT, CubeCoordinates.ORIGIN, arrayOf(arrayOf(Field.WATER, Field.WATER, Field.PASSENGER(CubeDirection.LEFT))))))
+            val miniBoard = Board(listOf(Segment(CubeDirection.RIGHT, CubeCoordinates.ORIGIN, arrayOf(arrayOf(Field.WATER, Field.WATER, Field.PASSENGER(CubeDirection.LEFT))))))
             val ship = Ship(CubeCoordinates.ORIGIN, Team.ONE)
-            board.pickupPassenger(CubeCoordinates.ORIGIN) shouldBe null
-            board.pickupPassenger(ship) shouldBe false
-            board[CubeCoordinates.ORIGIN + CubeDirection.LEFT.vector].shouldBeInstanceOf<Field.PASSENGER>()
-            board.pickupPassenger(CubeCoordinates.ORIGIN + CubeDirection.LEFT.vector * 2) shouldBe Field.PASSENGER(CubeDirection.LEFT)
+            miniBoard.pickupPassenger(CubeCoordinates.ORIGIN) shouldBe null
+            miniBoard.pickupPassenger(ship) shouldBe false
+            miniBoard[CubeCoordinates.ORIGIN + CubeDirection.LEFT.vector].shouldBeInstanceOf<Field.PASSENGER>()
+            miniBoard.pickupPassenger(CubeCoordinates.ORIGIN + CubeDirection.LEFT.vector * 2) shouldBe Field.PASSENGER(CubeDirection.LEFT)
         }
     }
 

sdk/src/main/server-api/sc/api/plugins/IGameState.kt

@@ -28,10 +28,10 @@ import sc.protocol.room.RoomMessage
  * Zusaetzlich zu den eigentlichen Informationen koennen bestimmte
  * Teilinformationen abgefragt werden.
  */
-interface IGameState : RoomMessage, PublicCloneable<IGameState> {
+interface IGameState: RoomMessage, PublicCloneable<IGameState> {
     /** Aktuelle Zugzahl  */
     val turn: Int
-
+    
     /** Aktuelle Rundenzahl */
     val round: Int
 
@@ -44,8 +44,18 @@ interface IGameState : RoomMessage, PublicCloneable<IGameState> {
     /** Gibt Punktzahlen des Teams entsprechend der [ScoreDefinition] zurück. */
     fun getPointsForTeam(team: ITeam): IntArray
 
-    /** Die möglichen Züge des aktuellen Teams in der aktuellen Situation.
+    /** Mögliche Züge des aktuellen Teams in der aktuellen Situation.
      * Bei manchen Spielen wird aufgrund der unüberschaubaren Zahl möglicher Züge
      * nur ein Ausschnitt zurückgegeben. */
-    fun getSensibleMoves(): List<IMove>
+    fun getSensibleMoves(): List<IMove> {
+        val possibleMoves = getAllMoves()
+        val someMoves: MutableList<IMove> = ArrayList()
+        while(possibleMoves.hasNext() && someMoves.size < 100)
+            someMoves.add(possibleMoves.next())
+        return someMoves
+    }
+    
+    /** Eine Abfolge aller möglichen Züge des aktuellen Teams,
+     * nur soweit berechnet wie nötig. */
+    fun getAllMoves(): Iterator<IMove>
 }

server/src/test/java/sc/server/plugins/TestGameState.kt

@@ -16,9 +16,11 @@ data class TestGameState(
     @Transient
     override val isOver = false
 
-    override fun getPointsForTeam(team: ITeam): IntArray = intArrayOf(currentTeam.index, turn)
+    override fun getPointsForTeam(team: ITeam): IntArray =
+            intArrayOf(currentTeam.index, turn)
 
-    override fun getSensibleMoves(): List<IMove> = throw NotImplementedError("TestGame has no possible Moves")
+    override fun getAllMoves(): Iterator<IMove> =
+            throw NotImplementedError("TestGame has no possible Moves")
 
     override val round get() = turn / 2