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

17
server/docs/events/SendCard.md Normal file
View file

@ -0,0 +1,17 @@
# `SendCard`:
## Description:
Sends a card to the server, the server either then either forwards the card to the spirit or the past questions pile. The action that is taken is dependant on what the `from` property is set to.
## Request Payload:
| Property | Type | Description
| -------- | ---- | -----------
| text | String | The text of the card that is being sent.
| from | String | The source of where the card is being sent from. This can be one of `"writer"`, `"guesser"`, any other value will return an error.
| team | Integer | The team that is sending the card. This can be either `1` or `2`, any other value will return an error.
## Response Payload: (`NewCards`)
| Property | Type | Description
| -------- | ---- | -----------
| cards | String[] | The text of the cards that was sent.
| from | String | The source of the card(s). This will be one of `"deck"`, or `"guesser"`