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

18
server/docs/events/UpdateAnswer.md Normal file
View file

@ -0,0 +1,18 @@
# `UpdateAnswer`:
## Description:
This event is sent to and from the server when a spirit is typing into one of the text boxes.
## Request Payload:
| Property | Type | Description
| -------- | ---- | -----------
| team | Integer | The team indicator number. This can be either `1`, or `2`, any other value will cause this event to return an error.
| answer | Integer | The answer that is being updated. This can be any number between `1` and `8` (inclusive), any other value will cause this event return an error.
| value | String | The new text for the input box.
## Response Payload: (`UpdateAnswer`)
| Property | Type | Description
| -------- | ---- | -----------
| team | Integer | The team indicator number. This can be either `1`, or `2`.
| answer | Integer | The answer that is being updated. This can be any number between `1` and `8` (inclusive).
| value | String | The new text for the input box.