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

Add placeholders for all the planned events.

Browse source
This commit is contained in:
Oliver-Akins 2020-10-08 23:22:06 -06:00
parent d2014d6742
commit a451c69dad
1 changed files with 80 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

99
docs/events.html
View file

@ -6,7 +6,7 @@
<title>Secret Hitler Online Documentation</title> <title>Secret Hitler Online Documentation</title>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/water.css@2/out/dark.min.css"> <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/water.css@2/out/dark.min.css">
</head> </head>
<body> <body style="max-width: 1000px;">
<h2 id="legend">Legend For Sources:</h2> <h2 id="legend">Legend For Sources:</h2>
<ul> <ul>
<li>Origin - The client that triggered the server-side event</li> <li>Origin - The client that triggered the server-side event</li>
@ -30,6 +30,58 @@
</tr> </tr>
</thead> </thead>
<tbody> <tbody>
<tr>
<td><code><a href="#">ChancellorNomination</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="#">ChancellorPolicy</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="#">ExecutePlayer</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="#">ExecutiveConfirmation</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="#">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> <tr>
<td><code><a href="#">HostGame</a></code></td> <td><code><a href="#">HostGame</a></code></td>
<td><code><a href="#">HostInformation</a></code></td> <td><code><a href="#">HostInformation</a></code></td>
@ -40,6 +92,16 @@
</td> </td>
<td colspan="2">Creates a game. This will rarely ever fail.</td> <td colspan="2">Creates a game. This will rarely ever fail.</td>
</tr> </tr>
<tr>
<td><code><a href="#">InvestigateParty</a></code></td>
<td><code><a href="#"></a></code></td>
<td>
Success:
<br>
Fail:
</td>
<td colspan="2"></td>
</tr>
<tr> <tr>
<td><code><a href="#">JoinGame</a></code></td> <td><code><a href="#">JoinGame</a></code></td>
<td><code><a href="#">GameJoined</a></code></td> <td><code><a href="#">GameJoined</a></code></td>
@ -76,20 +138,9 @@
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. 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> </td>
</tr> </tr>
<tr> <tr>
<td><code><a href="#">GetPlayerList</a></code></td> <td><code><a href="#">KillGame</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><code><a href="#"></a></code></td>
<td> <td>
Success: Success:
@ -99,7 +150,7 @@
<td colspan="2"></td> <td colspan="2"></td>
</tr> </tr>
<tr> <tr>
<td><code><a href="#"></a></code></td> <td><code><a href="#">NextPresident</a></code></td>
<td><code><a href="#"></a></code></td> <td><code><a href="#"></a></code></td>
<td> <td>
Success: Success:
@ -109,7 +160,7 @@
<td colspan="2"></td> <td colspan="2"></td>
</tr> </tr>
<tr> <tr>
<td><code><a href="#"></a></code></td> <td><code><a href="#">PresidentPolicies</a></code></td>
<td><code><a href="#"></a></code></td> <td><code><a href="#"></a></code></td>
<td> <td>
Success: Success:
@ -119,7 +170,7 @@
<td colspan="2"></td> <td colspan="2"></td>
</tr> </tr>
<tr> <tr>
<td><code><a href="#"></a></code></td> <td><code><a href="#">StartGame</a></code></td>
<td><code><a href="#"></a></code></td> <td><code><a href="#"></a></code></td>
<td> <td>
Success: Success:
@ -129,7 +180,7 @@
<td colspan="2"></td> <td colspan="2"></td>
</tr> </tr>
<tr> <tr>
<td><code><a href="#"></a></code></td> <td><code><a href="#">VetoConfirm</a></code></td>
<td><code><a href="#"></a></code></td> <td><code><a href="#"></a></code></td>
<td> <td>
Success: Success:
@ -139,7 +190,7 @@
<td colspan="2"></td> <td colspan="2"></td>
</tr> </tr>
<tr> <tr>
<td><code><a href="#"></a></code></td> <td><code><a href="#">VetoRequest</a></code></td>
<td><code><a href="#"></a></code></td> <td><code><a href="#"></a></code></td>
<td> <td>
Success: Success:
@ -149,6 +200,16 @@
<td colspan="2"></td> <td colspan="2"></td>
</tr> </tr>
<tr> <tr>
<td><code><a href="#">Vote</a></code></td>
<td><code><a href="#"></a></code></td>
<td>
Success:
<br>
Fail:
</td>
<td colspan="2"></td>
</tr>
<tr hidden>
<td><code><a href="#"></a></code></td> <td><code><a href="#"></a></code></td>
<td><code><a href="#"></a></code></td> <td><code><a href="#"></a></code></td>
<td> <td>