sc.protocol.requests

Class PauseGameRequest

sc.protocol.requests.PauseGameRequest

All Implemented Interfaces:

AdminLobbyRequest, ILobbyRequest, ProtocolMessage

public class PauseGameRequest
implements AdminLobbyRequest

Request by administrative client to pause or unpause a game specified by given roomId.

A game will only be paused immediately if there is no pending MoveRequest, otherwise the game will be paused next turn.

When the game is paused no GameState or MoveRequest will be sent to the players (and all other observers) until an AdminClient sends a StepRequest or resumes the game.

Constructor Detail

PauseGameRequest

public PauseGameRequest(@NotNull
                        java.lang.String roomId,
                        boolean pause)

Request by administrative client to pause or unpause a game specified by given roomId.

A game will only be paused immediately if there is no pending MoveRequest, otherwise the game will be paused next turn.

When the game is paused no GameState or MoveRequest will be sent to the players (and all other observers) until an AdminClient sends a StepRequest or resumes the game.

Method Detail

getRoomId

@NotNull
public java.lang.String getRoomId()

getPause

public boolean getPause()

component1

@NotNull
public java.lang.String component1()

component2

public boolean component2()

copy

@NotNull
public PauseGameRequest copy(@NotNull
                                      java.lang.String roomId,
                                      boolean pause)

Request by administrative client to pause or unpause a game specified by given roomId.

A game will only be paused immediately if there is no pending MoveRequest, otherwise the game will be paused next turn.

When the game is paused no GameState or MoveRequest will be sent to the players (and all other observers) until an AdminClient sends a StepRequest or resumes the game.

toString

@NotNull
public java.lang.String toString()

Request by administrative client to pause or unpause a game specified by given roomId.

A game will only be paused immediately if there is no pending MoveRequest, otherwise the game will be paused next turn.

When the game is paused no GameState or MoveRequest will be sent to the players (and all other observers) until an AdminClient sends a StepRequest or resumes the game.

hashCode

public int hashCode()

Request by administrative client to pause or unpause a game specified by given roomId.

A game will only be paused immediately if there is no pending MoveRequest, otherwise the game will be paused next turn.

When the game is paused no GameState or MoveRequest will be sent to the players (and all other observers) until an AdminClient sends a StepRequest or resumes the game.

equals

public boolean equals(@Nullable
                      java.lang.Object p)

Request by administrative client to pause or unpause a game specified by given roomId.

A game will only be paused immediately if there is no pending MoveRequest, otherwise the game will be paused next turn.

When the game is paused no GameState or MoveRequest will be sent to the players (and all other observers) until an AdminClient sends a StepRequest or resumes the game.