diff --git a/server/docs/types/Deck.md b/server/docs/types/Deck.md index c73ee17..32adbdb 100644 --- a/server/docs/types/Deck.md +++ b/server/docs/types/Deck.md @@ -1,7 +1,8 @@ -## Deck +## Deck This represents a stack of cards that can be drawn from and discarded to. | Property | Type | Description | -------- | ---- | ----------- -| discard | String[] | The used cards -| deck | String[] | The unused cards \ No newline at end of file +| _discard | T[] | The used cards from the deck. +| _unknown | T[] | The cards that are neither in the deck or the discard. +| (get) size | Integer | The number of the cards that are left in the deck. \ No newline at end of file diff --git a/server/docs/types/Game.md b/server/docs/types/Game.md index 38d688a..875ea83 100644 --- a/server/docs/types/Game.md +++ b/server/docs/types/Game.md @@ -4,8 +4,13 @@ This is a representation of the game and it's corresponding data. | Property | Type | Description | -------- | ---- | ----------- | id | String | The game's ID to join with. +| host | Player | The player who created the game. +| ingame | Boolean | Whether or not this game is being played or is in the lobby. | teams | Team[] | The teams that are a part of this game. | players | Player[] | All of the players that are in this game. -| questons | Deck | The deck and discard of the question cards. -| objects | Deck | The deck and discard of the object cards. -| getObjects | String[] | Gets the objects that the game has chosen. \ No newline at end of file +| _questons | Deck | The deck and discard of the question cards. +| _objects | Deck | The deck and discard of the object cards. +| _objectCard | String[] | The card that was drawn from the deck for the spirits to choose an object from. +| object | String | The chosen object that the spirits decided on. +| (get) questions | Deck | Returns the deck from the private attribute. +| (get) objects | String[] | Returns the objects from the card that was drawn for the game. \ No newline at end of file diff --git a/server/docs/types/Player.md b/server/docs/types/Player.md index b0698dd..1c2064e 100644 --- a/server/docs/types/Player.md +++ b/server/docs/types/Player.md @@ -4,5 +4,6 @@ A player's information for the game. | Property | Type | Description | -------- | ---- | ----------- | name | String | The player's name. -| id | String | The player's unique ID. -| socket | Socket | The socket object used to send events directly to the player. \ No newline at end of file +| socket | Socket | The socket object used to send events directly to the player. +| isHost | Boolean | Whether or not the player is the host of the game. +| connected | Boolean | Whether or not the socket is connected. \ No newline at end of file diff --git a/server/docs/types/Team.md b/server/docs/types/Team.md index e9948cd..b5bbb3f 100644 --- a/server/docs/types/Team.md +++ b/server/docs/types/Team.md @@ -1,10 +1,10 @@ ## Team -A representation of a team, this consists of which player is the spirit and a complete list of all the players on the team, +A representation of a team, this consists of which player is the spirit and a complete list of all the players on the team, | Property | Type | Description | -------- | ---- | ----------- -| mediums | Player[] | All the Players that are on this team. -| spirit | Player | The player that is acting as the team's spirit. +| guessers | Player[] | All the Players that are on this team. +| writer | Player | The player that is acting as the team's spirit. | hand | String[] | The cards that are in the medium's hand. | questions | String[] | The questions that the mediums have asked the spirit. (This is not equivalent to the Spirit's hand) | answers | String[] | The answers that the spirit has given. \ No newline at end of file