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 @@ + + +
+ + +| Event From Client | +Response Event | +Response Sent To | +Description | +|
HostGame |
+ HostInformation |
+
+ Success: Origin
+ + Fail: Origin + |
+ Creates a game. This will rarely ever fail. | +|
JoinGame |
+ GameJoined |
+
+ Success: Origin
+ + Fail: Origin + |
+ + Indicates if the client joined a game or not. + | +|
JoinGame |
+ NewPlayer |
+
+ Success: Others
+ + Fail: Not Sent + |
+ + Alerts players already in the game of the newly joined player. + | +|
KickPlayer |
+ PlayerKicked |
+
+ 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. + | +|
GetPlayerList |
+ PlayerList |
+
+ 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: + |
+ + | |