CommonClient: add docstring to /ready

This commit is contained in:
Fabian Dill 2021-12-03 07:04:17 +01:00
parent 47c1300f30
commit 21d465bcb8
2 changed files with 3 additions and 2 deletions

View File

@ -94,6 +94,7 @@ class ClientCommandProcessor(CommandProcessor):
self.output(location_name) self.output(location_name)
def _cmd_ready(self): def _cmd_ready(self):
"""Send ready status to server."""
self.ctx.ready = not self.ctx.ready self.ctx.ready = not self.ctx.ready
if self.ctx.ready: if self.ctx.ready:
state = ClientStatus.CLIENT_READY state = ClientStatus.CLIENT_READY

View File

@ -85,11 +85,11 @@ Firewall.
Once you have changed the loaded core, you must restart BizHawk. Once you have changed the loaded core, you must restart BizHawk.
2. Load your ROM file if it hasn't already been loaded. 2. Load your ROM file if it hasn't already been loaded.
3. Click on the Tools menu and click on **Lua Console** 3. Click on the Tools menu and click on **Lua Console**
4. Click Script -> Open Scipt... 4. Click Script -> Open Script...
5. Select the `Connector.lua` file you downloaded above 5. Select the `Connector.lua` file you downloaded above
- Z3Client users should download `sniConnector.lua` from the client download page - Z3Client users should download `sniConnector.lua` from the client download page
- SNIClient users should look in their Archipelago folder for `/sni/lua` - SNIClient users should look in their Archipelago folder for `/sni/lua`
6. Run the script by double clicking it in the listing 6. Run the script by double-clicking it in the listing
#### With hardware #### With hardware
This guide assumes you have downloaded the correct firmware for your device. If you have not This guide assumes you have downloaded the correct firmware for your device. If you have not