diff --git a/docs/events.md b/docs/events.md index 9d88c99..bfbea92 100644 --- a/docs/events.md +++ b/docs/events.md @@ -109,7 +109,7 @@ Allows a player to join a lobby based on the lobby identifier. ### Payloads Request Payload: `IJoinLobby` -Response Payload: `ILobbyInfo` +Response Payload: `ILobbyInfo` (or `IGameState` if the game is in progress) --- @@ -143,3 +143,19 @@ updating the ship design. Request Payload: `IUpdatePlayer` Response Payload: `ServerResponse` + +--- + +## `game.state` +Provides information about the current game state, used to help keep clients in +the correct state. + +### Supported Event Types +| Request | Response | Broadcasted +| ------- | -------- | ----------- +| No | Yes | Yes + +### Payloads +Request Payload: N/A + +Response Payload: `IGameState` \ No newline at end of file diff --git a/docs/raw_events_list.md b/docs/raw_events_list.md index e86f259..75978cb 100644 --- a/docs/raw_events_list.md +++ b/docs/raw_events_list.md @@ -14,6 +14,7 @@ server info: `server.info` # In-Game +current game state: `game.state` alerting the players who's turn it is: `game.turn` distributing card piles: `game.mining.piles` picking a card pile: `game.mining.choose`