Update/add file headers for documentation purposes

This commit is contained in:
Oliver-Akins 2020-09-30 23:49:10 -06:00
parent d204378ea5
commit 1380a7919b
3 changed files with 16 additions and 2 deletions

View file

@ -3,8 +3,9 @@ Starts a game on the server, this also acts as the `JoinGame` event for the
host, except that it doesn't send any events out to other players as there
are none yet.
This will also emit the `HostInformation` event to the host client, which will
allow us to send them information about what the game code is
Emissions:
HostInformation - Data containing if the game created successfully or not
and the game code for the game if it was successful.
Client Side: After the host receives the `HostInformation` event, the Query
String parameters should be updated with the Websocket URI and the game code so