Add documentation for the game.state event

This commit is contained in:
Oliver Akins 2022-03-12 22:15:15 -06:00
parent df6b8a0875
commit 6f38c7e2a3
No known key found for this signature in database
GPG key ID: 3C2014AF9457AF99
2 changed files with 18 additions and 1 deletions

View file

@ -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`