Oliver/Gravwell-Online
0
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add players.update event documentation

Browse source
This commit is contained in:
Oliver-Akins 2022-01-06 16:26:58 -07:00
parent e6293ec30f
commit 0dc55876cf
1 changed files with 19 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

21
docs/events.md
View file

@ -53,6 +53,23 @@ join into it.
| Yes | Yes | No
### Payloads
Request Payload: `IGameJoinRequest`
Request Payload: `LobbyJoinRequest`
Response Payload: `IGameJoinResponse`
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`