Add documentation for the game.state event
This commit is contained in:
parent
df6b8a0875
commit
6f38c7e2a3
2 changed files with 18 additions and 1 deletions
|
|
@ -109,7 +109,7 @@ Allows a player to join a lobby based on the lobby identifier.
|
||||||
### Payloads
|
### Payloads
|
||||||
Request Payload: `IJoinLobby`
|
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`
|
Request Payload: `IUpdatePlayer`
|
||||||
|
|
||||||
Response Payload: `ServerResponse`
|
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`
|
||||||
|
|
@ -14,6 +14,7 @@ server info: `server.info`
|
||||||
|
|
||||||
|
|
||||||
# In-Game
|
# In-Game
|
||||||
|
current game state: `game.state`
|
||||||
alerting the players who's turn it is: `game.turn`
|
alerting the players who's turn it is: `game.turn`
|
||||||
distributing card piles: `game.mining.piles`
|
distributing card piles: `game.mining.piles`
|
||||||
picking a card pile: `game.mining.choose`
|
picking a card pile: `game.mining.choose`
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue