Gravwell-Online/server/events.md
2022-01-03 18:47:46 -07:00

50 lines
No EOL
1.3 KiB
Markdown

This is a list of all events that the server must support in order at the bare
minimum for the front-end to work with getting all the data that it needs.
---
`get.game` (incoming)
Get's a game's current information, this includes player list, and options
`game.info` (outgoing)
The game data that was requested.
---
`delete.game` (incoming)
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` (incoming)
Retrieves a list of all colours that are currently supported for players to pick
from for their spaceship.
`get.system.icons` (incoming)
Retrieves a list of all the supported icons that players can pick from for their
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` (incoming)
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` (incoming)
Updates the game's options that affect how the game flow works.
---