Mamanyonyo/akashi-esquizolandia
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update /ban documentation

Browse Source
This commit is contained in:
MangosArentLiterature 2021-05-07 21:46:16 -05:00 committed by GitHub
parent 72d073e6df
commit 67708f2c1b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
include/aoclient.h
View File

@ -1005,14 +1005,12 @@ class AOClient : public QObject {
* @brief Bans a client from the server, forcibly severing its connection to the server,
* and disallowing their return.
*
* @details The first argument is the **target's IPID**, the second is the **reason** why the client
* was banned, the third is the **duration**.
* @details The first argument is the **target's IPID**, the second is the **duration**,
* and the third is the **reason** why the client was banned.
*
* Both the reason and the duration must be in quotation marks.
*
* The duration can be `"perma"`, meaning a forever ban, otherwise, it must be given in the format of `"YYyWWwDDdHHhMMmSSs"` to
* The duration can be `perma`, meaning a forever ban, otherwise, it must be given in the format of `YYyWWwDDdHHhMMmSSs` to
* mean a YY years, WW weeks, DD days, HH hours, MM minutes and SS seconds long ban. Any of these may be left out, for example,
* `"1h30m"` for a 1.5 hour long ban.
* `1h30m` for a 1.5 hour long ban.
*
* Besides banning, this command kicks all clients having the given IPID,
* thus a multiclienting user will have all their clients be kicked from the server.