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

Add docs for the SendCard event

Browse source
This commit is contained in:
Oliver-Akins 2020-12-16 16:17:11 -07:00
parent 238b99b063
commit 170e222573
1 changed files with 18 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

19
server/events.md
View file

@ -104,8 +104,25 @@ This event is sent to and from the server when a spirit is typing into one of th
<br><br> <br><br>
--- ---
## Description: # `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: (`NewCard`)
| Property | Type | Description
| -------- | ---- | -----------
| text | String | The text of the card that was sent.
| from | String | The source of the card. This will be one of `"deck"`, or `"guesser"`
<br><br>
## Request Payload: ## Request Payload:
| Property | Type | Description | Property | Type | Description