Move event and type docs into their own files.
This commit is contained in:
parent
ce7e35cd53
commit
2ca4eef0a6
19 changed files with 213 additions and 261 deletions
7
server/docs/types/Deck.md
Normal file
7
server/docs/types/Deck.md
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
## 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
|
||||
11
server/docs/types/Game.md
Normal file
11
server/docs/types/Game.md
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
## Game:
|
||||
This is a representation of the game and it's corresponding data.
|
||||
|
||||
| Property | Type | Description
|
||||
| -------- | ---- | -----------
|
||||
| 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.
|
||||
| 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.
|
||||
8
server/docs/types/Player.md
Normal file
8
server/docs/types/Player.md
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
## Player:
|
||||
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.
|
||||
10
server/docs/types/Team.md
Normal file
10
server/docs/types/Team.md
Normal file
|
|
@ -0,0 +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,
|
||||
|
||||
| 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.
|
||||
| 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.
|
||||
Loading…
Add table
Add a link
Reference in a new issue