0
0
Fork 0
Phantom-Ink-Online/server/docs/events/SendCard.md
2020-12-23 12:37:53 -07:00

14 lines
No EOL
793 B
Markdown

# `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`)
The response to this event comes in the form of an `UpdateHand` event with the `mode` set to `"append"`.