Oliver/Gravwell-Online
0
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add some more event documentation for the server

Browse source
This commit is contained in:
Oliver-Akins 2022-01-03 18:47:46 -07:00
parent 9d11b9eb6f
commit 988810b9eb
1 changed files with 22 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

28
server/events.md
View file

@ -3,32 +3,48 @@ minimum for the front-end to work with getting all the data that it needs.
--- ---
`get.game` `get.game` (incoming)
Get's a game's current information, this includes player list, and options Get's a game's current information, this includes player list, and options
`game.info` (outgoing)
The game data that was requested.
--- ---
`delete.game` `delete.game` (incoming)
Deletes a game from the system, kicking all the players from the lobby. Deletes a game from the system, kicking all the players from the lobby.
`game.deleted` (outgoing)
Alert for all the players that the game got deleted and to reset all state.
--- ---
`get.system.colours` `get.system.colours` (incoming)
Retrieves a list of all colours that are currently supported for players to pick Retrieves a list of all colours that are currently supported for players to pick
from for their spaceship. from for their spaceship.
`get.system.icons` `get.system.icons` (incoming)
Retrieves a list of all the supported icons that players can pick from for their Retrieves a list of all the supported icons that players can pick from for their
spaceship. spaceship.
`system.colours` (outgoing)
The list of all colours that the players can pick from.
`system.icons` (outgoing)
The list of all the icons that players can pick from.
--- ---
`put.player.design` `put.player.design` (incoming)
Updates a player's design that will be used in the game for their spaceship. Updates a player's design that will be used in the game for their spaceship.
`game.player.update` (outgoing)
Tells everyone in the game that one of the players has updated something about
their data and to refresh the local data to keep it up to date.
--- ---
`put.game.option` `put.game.option` (incoming)
Updates the game's options that affect how the game flow works. Updates the game's options that affect how the game flow works.
--- ---