From 12798e7a5380a0ab0665784fa93b88814d070f9f Mon Sep 17 00:00:00 2001 From: Oliver-Akins Date: Thu, 8 Oct 2020 23:06:21 -0600 Subject: [PATCH] Begin work on event documentation --- docs/events.html | 160 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 160 insertions(+) create mode 100644 docs/events.html diff --git a/docs/events.html b/docs/events.html new file mode 100644 index 0000000..bcd1ccb --- /dev/null +++ b/docs/events.html @@ -0,0 +1,160 @@ + + + + + + Secret Hitler Online Documentation + + + +

Legend For Sources:

+ +
+

Event List:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Event From ClientResponse EventResponse Sent ToDescription
HostGameHostInformation + Success: Origin +
+ Fail: Origin + 		Creates a game. This will rarely ever fail.
JoinGameGameJoined + Success: Origin +
+ Fail: Origin + 		+ Indicates if the client joined a game or not. +
JoinGameNewPlayer + Success: Others +
+ Fail: Not Sent + 		+ Alerts players already in the game of the newly joined player. +
KickPlayerPlayerKicked + Success: Room +
+ Fail: Origin + 		+ When the host kicks a player from the lobby this event is sent out to alert all the players of the player's removal so the UI can be updated as needed. +
GetPlayerListPlayerList + Success: Origin +
+ Fail: Origin + 		+ This is just to get the list of players, there's nothing else to it. +
+ Success: +
+ Fail: +
+ Success: +
+ Fail: +
+ Success: +
+ Fail: +
+ Success: +
+ Fail: +
+ Success: +
+ Fail: +
+ Success: +
+ Fail: +
+ Success: +
+ Fail: +
+ + \ No newline at end of file