Oliver/Phantom-Ink-Online
0
0
Fork 0
Code Issues Activity

Move event and type docs into their own files.

Browse source
This commit is contained in:
Oliver-Akins 2020-12-19 18:01:36 -07:00
parent ce7e35cd53
commit 2ca4eef0a6
19 changed files with 213 additions and 261 deletions
Download patch file Download diff file Expand all files Collapse all files

14
server/docs/events/JoinTeam.md Normal file
View file

@ -0,0 +1,14 @@
# `JoinTeam`:
## Description:
This event is triggered by the client when the user attempts to join a team from the lobby.
## Request Payload:
| Property | Type | Description
| -------- | ---- | -----------
| team | int | The team to join. Accepted values are: `1`, and `2`, any other value will throw an error.
| role | String | The role the player is assuming. This can be `"writer"` or `"guesser"`, any other value will throw an error.
## Response Payload: (`JoinTeam`)
| Property | Type | Description
| -------- | ---- | -----------