From 351318ece4934cd2dbd25efeca1a5e60ebbc8514 Mon Sep 17 00:00:00 2001 From: Oliver-Akins Date: Wed, 16 Dec 2020 18:53:10 -0700 Subject: [PATCH] Update the types for the objects. --- server/types.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/server/types.md b/server/types.md index 29cb866..e4230b9 100644 --- a/server/types.md +++ b/server/types.md @@ -2,12 +2,22 @@ | Property | Type | Description | -------- | ---- | ----------- | name | String | The player's name. -| role | String | The player's role. This will be one of `"guesser"` or `"writer"`. -| team | Integer | The player's team. This will be one of `1` or `2` +| id | String | The player's unique ID. ## Game: | Property | Type | Description | -------- | ---- | ----------- -| game_code | String | The game's unique identifier used for joining the game. -| players | Player[] | The players that are currently in the game. -| state | String | What state the game is currently in. This can be one of `"lobby"`, or `"playing"` \ No newline at end of file +| id | String | The game's ID to join with. +| teams | Team[] | The teams that are a part of this game. +| 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. \ No newline at end of file