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

Update the types for the objects.

Browse source
This commit is contained in:
Oliver-Akins 2020-12-16 18:53:10 -07:00
parent 00d5b7f4f4
commit 351318ece4
1 changed files with 15 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

20
server/types.md
View file

@ -2,12 +2,22 @@
| Property | Type | Description | Property | Type | Description
| -------- | ---- | ----------- | -------- | ---- | -----------
| name | String | The player's name. | name | String | The player's name.
| role | String | The player's role. This will be one of `"guesser"` or `"writer"`. | id | String | The player's unique ID.
| team | Integer | The player's team. This will be one of `1` or `2`
## Game: ## Game:
| Property | Type | Description | Property | Type | Description
| -------- | ---- | ----------- | -------- | ---- | -----------
| game_code | String | The game's unique identifier used for joining the game. | id | String | The game's ID to join with.
| players | Player[] | The players that are currently in the game. | teams | Team[] | The teams that are a part of this game.
| state | String | What state the game is currently in. This can be one of `"lobby"`, or `"playing"` | players | Player[] | All of the players that are in this game.
| q_deck | String[] | The deck of question cards that the mediums can ask the spirit.
| o_deck | String[] | The deck of object cards that the spririts can pick from when the game starts.
## Team
| Property | Type | Description
| -------- | ---- | -----------
| players | Player[] | All the Players that are on this team.
| spirit | Player | The player that is acting as the team's spirit.
| hand | String[] | The cards that are in this team's hand.
| questions | String[] | The questions that the mediums have asked the spirit.
| answers | String[] | The answers that the spirit has given.