From 0dc55876cf750893c83a9fa2d9c3449c4b0acf22 Mon Sep 17 00:00:00 2001 From: Oliver-Akins Date: Thu, 6 Jan 2022 16:26:58 -0700 Subject: [PATCH] Add players.update event documentation --- docs/events.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/docs/events.md b/docs/events.md index 5b1de07..a64e647 100644 --- a/docs/events.md +++ b/docs/events.md @@ -53,6 +53,23 @@ join into it. | Yes | Yes | No ### Payloads -Request Payload: `IGameJoinRequest` +Request Payload: `LobbyJoinRequest` -Response Payload: `IGameJoinResponse` \ No newline at end of file +Response Payload: `LobbyJoinResponse` + +--- + +## `players.update` +Tells the client that the player list has been updated. This event is broadcast +when a new player joins the game, or when a player has updated their ship +design. + +### Supported Event Types +| Request | Response | Broadcasted +| ------- | -------- | ----------- +| No | Yes | Yes + +### Payloads +Request Payload: N/A + +Response Payload: `PlayerUpdateResponse` \ No newline at end of file