Oliver/Secret-Hitler-Online-Server
0
0
Fork 0
Code Issues 13 Pull requests Projects Releases Packages Wiki Activity Actions

Begin work on event documentation

Browse source
This commit is contained in:
Oliver-Akins 2020-10-08 23:06:21 -06:00
parent 150a719116
commit 12798e7a53
1 changed files with 160 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

160
docs/events.html Normal file
View file

@ -0,0 +1,160 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Secret Hitler Online Documentation</title>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/water.css@2/out/dark.min.css">
</head>
<body>
<h2 id="legend">Legend For Sources:</h2>
<ul>
<li>Origin - The client that triggered the server-side event</li>
<li>Room - All connected clients to the game</li>
<li>Others - All connected clients to the game, except the Origin</li>
<li>Not Sent - This indicates that the event is not sent clients at all</li>
</ul>
<hr>
<h2 id="events">Event List:</h2>
<table>
<thead>
<tr>
<td>Event From Client</td>
<td>Response Event</td>
<td>Response Sent To</td>
<td colspan="2">Description</td>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="#">HostGame</a></code></td>
<td><code><a href="#">HostInformation</a></code></td>
<td>
Success: Origin
<br>
Fail: Origin
</td>
<td colspan="2">Creates a game. This will rarely ever fail.</td>
</tr>
<tr>
<td><code><a href="#">JoinGame</a></code></td>
<td><code><a href="#">GameJoined</a></code></td>
<td>
Success: Origin
<br>
Fail: Origin
</td>
<td colspan="2">
Indicates if the client joined a game or not.
</td>
</tr>
<tr>
<td><code><a href="#">JoinGame</a></code></td>
<td><code><a href="#">NewPlayer</a></code></td>
<td>
Success: Others
<br>
Fail: Not Sent
</td>
<td colspan="2">
Alerts players already in the game of the newly joined player.
</td>
</tr>
<tr>
<td><code><a href="#">KickPlayer</a></code></td>
<td><code><a href="#">PlayerKicked</a></code></td>
<td>
Success: Room
<br>
Fail: Origin
</td>
<td colspan="2">
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.
</td>
</tr>
<tr>
<td><code><a href="#">GetPlayerList</a></code></td>
<td><code><a href="#">PlayerList</a></code></td>
<td>
Success: Origin
<br>
Fail: Origin
</td>
<td colspan="2">
This is just to get the list of players, there's nothing else to it.
</td>
</tr>
<tr>
<td><code><a href="#"></a></code></td>
<td><code><a href="#"></a></code></td>
<td>
Success:
<br>
Fail:
</td>
<td colspan="2"></td>
</tr>
<tr>
<td><code><a href="#"></a></code></td>
<td><code><a href="#"></a></code></td>
<td>
Success:
<br>
Fail:
</td>
<td colspan="2"></td>
</tr>
<tr>
<td><code><a href="#"></a></code></td>
<td><code><a href="#"></a></code></td>
<td>
Success:
<br>
Fail:
</td>
<td colspan="2"></td>
</tr>
<tr>
<td><code><a href="#"></a></code></td>
<td><code><a href="#"></a></code></td>
<td>
Success:
<br>
Fail:
</td>
<td colspan="2"></td>
</tr>
<tr>
<td><code><a href="#"></a></code></td>
<td><code><a href="#"></a></code></td>
<td>
Success:
<br>
Fail:
</td>
<td colspan="2"></td>
</tr>
<tr>
<td><code><a href="#"></a></code></td>
<td><code><a href="#"></a></code></td>
<td>
Success:
<br>
Fail:
</td>
<td colspan="2"></td>
</tr>
<tr>
<td><code><a href="#"></a></code></td>
<td><code><a href="#"></a></code></td>
<td>
Success:
<br>
Fail:
</td>
<td colspan="2"></td>
</tr>
</tbody>
</table>
</body>
</html>