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

Add docs for the RemoveCard event

Browse source
This commit is contained in:
Oliver-Akins 2020-12-16 18:23:31 -07:00
parent ebfc1f5855
commit 00d5b7f4f4
1 changed files with 15 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

17
server/events.md
View file

@ -124,10 +124,23 @@ Sends a card to the server, the server either then either forwards the card to t
<br><br> <br><br>
--- ---
# `RemoveCard`:
## Description:
This event is sent from the server when a guesser sends a card to the spirit, it's purpose is to keep the other medium's hands in sync.
## Request Payload:
This event is only sent by the server.
## Response Payload: (`RemoveCard`)
| Property | Type | Description | Property | Type | Description
| -------- | ---- | ----------- | -------- | ---- | -----------
| text | String | The text of the card that was sent. | card | String | The card to remove the player's hand.
| from | String | The source of the card. This will be one of `"deck"`, or `"guesser"` | team | Integer | The team to remove the card from. This will be either `1`, or `2`.
<br><br>
---
<br><br> <br><br>
--- ---