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

Update docs to match adjusted objects

Browse source
This commit is contained in:
Oliver-Akins 2020-12-26 14:36:14 -07:00
parent 7b4c39b740
commit b06502d32a
4 changed files with 18 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

7
server/docs/types/Deck.md
View file

@ -1,7 +1,8 @@
## Deck ## Deck<T>
This represents a stack of cards that can be drawn from and discarded to. This represents a stack of cards that can be drawn from and discarded to.
| Property | Type | Description | Property | Type | Description
| -------- | ---- | ----------- | -------- | ---- | -----------
| discard | String[] | The used cards | _discard | T[] | The used cards from the deck.
| deck | String[] | The unused cards | _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.

11
server/docs/types/Game.md
View file

@ -4,8 +4,13 @@ This is a representation of the game and it's corresponding data.
| Property | Type | Description | Property | Type | Description
| -------- | ---- | ----------- | -------- | ---- | -----------
| id | String | The game's ID to join with. | 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. | teams | Team[] | The teams that are a part of this game.
| players | Player[] | All of the players that are in this game. | players | Player[] | All of the players that are in this game.
| questons | Deck | The deck and discard of the question cards. | _questons | Deck | The deck and discard of the question cards.
| objects | Deck | The deck and discard of the object cards. | _objects | Deck | The deck and discard of the object cards.
| getObjects | String[] | Gets the objects that the game has chosen. | _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.

5
server/docs/types/Player.md
View file

@ -4,5 +4,6 @@ A player's information for the game.
| Property | Type | Description | Property | Type | Description
| -------- | ---- | ----------- | -------- | ---- | -----------
| name | String | The player's name. | 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.
| 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.

6
server/docs/types/Team.md
View file

@ -1,10 +1,10 @@
## Team ## 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 | Property | Type | Description
| -------- | ---- | ----------- | -------- | ---- | -----------
| mediums | Player[] | All the Players that are on this team. | guessers | Player[] | All the Players that are on this team.
| spirit | Player | The player that is acting as the team's spirit. | writer | Player | The player that is acting as the team's spirit.
| hand | String[] | The cards that are in the medium's hand. | 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) | 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. | answers | String[] | The answers that the spirit has given.