feat(sdk): create RoomOrchestrationMessage marker interface

Author: xeruf

sdk/src/framework/sc/shared/GameResult.kt

@@ -3,7 +3,7 @@ package sc.shared
 import com.thoughtworks.xstream.annotations.XStreamAlias
 import com.thoughtworks.xstream.annotations.XStreamImplicit
 import sc.framework.plugins.Player
-import sc.protocol.room.RoomMessage
+import sc.protocol.room.RoomOrchestrationMessage
 
 /**
  * Das Endergebnis eines Spiels.
@@ -17,7 +17,7 @@ data class GameResult(
         val scores: List<PlayerScore>,
         @XStreamImplicit(itemFieldName = "winner")
         val winners: List<Player>?
-): RoomMessage {
+): RoomOrchestrationMessage {
 
     val isRegular: Boolean
         get() = scores.all { it.cause == ScoreCause.REGULAR }

sdk/src/framework/sc/shared/WelcomeMessage.kt

@@ -3,13 +3,13 @@ package sc.shared
 import com.thoughtworks.xstream.annotations.XStreamAlias
 import com.thoughtworks.xstream.annotations.XStreamAsAttribute
 import sc.api.plugins.ITeam
-import sc.protocol.room.RoomMessage
+import sc.protocol.room.RoomOrchestrationMessage
 
 /** Nachricht, die zu Beginn eines Spiels an einen Client geschickt wird, um ihm seine Spielerfarbe mitzuteilen.  */
 @Suppress("DataClassPrivateConstructor")
 @XStreamAlias(value = "welcomeMessage")
 data class WelcomeMessage private constructor(
-        @XStreamAsAttribute val color: String
-): RoomMessage {
+        @XStreamAsAttribute val color: String,
+): RoomOrchestrationMessage {
     constructor(color: ITeam): this(color.name)
 }

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

@@ -31,4 +31,6 @@ interface IGameState : RoomMessage, Cloneable {
 
     /** Aktuelle Rundenzahl */
     val round: Int
+    
+    public override fun clone(): IGameState
 }

sdk/src/server-api/sc/api/plugins/TwoPlayerGameState.kt

@@ -57,6 +57,4 @@ abstract class TwoPlayerGameState<P : Player>(
     override fun toString() =
             "GameState(turn=$turn,currentPlayer=${currentPlayer.color})"
 
-    public abstract override fun clone(): IGameState
-    
 }

sdk/src/server-api/sc/protocol/room/ErrorMessage.kt

@@ -9,7 +9,7 @@ data class ErrorMessage(
         val originalMessage: RoomMessage,
         @XStreamAsAttribute
         val message: String,
-): RoomMessage {
+): RoomOrchestrationMessage {
     val logMessage
         get() = "$originalMessage caused an error: $message"
 }

sdk/src/server-api/sc/protocol/room/GamePaused.kt

@@ -14,4 +14,4 @@ import sc.framework.plugins.Player
 data class GamePaused(
         @XStreamAsAttribute
         val nextPlayer: Player
-): RoomMessage
+): RoomOrchestrationMessage

sdk/src/server-api/sc/protocol/room/RoomMessage.kt

@@ -1,3 +1,8 @@
 package sc.protocol.room
 
+/** Implemented by any message sent within a GameRoom. */
 interface RoomMessage
+
+/** Implemented by any message within a room
+ * that does not concern the progress of the game. */
+interface RoomOrchestrationMessage: RoomMessage

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

@@ -19,4 +19,5 @@ data class TestGameState(
         currentPlayer = TestTeam.values()[(turn + startPlayer.index) % 2]
     }
 
+    override fun clone() = throw NotImplementedError()
 }