Difference between revisions of "BanManager.php"

From Bebot Wiki 2
Jump to navigationJump to search
Line 16: Line 16:
 
===== Commands provided =====
 
===== Commands provided =====
 
<pre>
 
<pre>
^Command  ^ Keyword ^Argument(s)   ^Description                                ^Tell      ^Guild    ^Priv     ^
+
^Command  ^ Keyword ^Argument(s)       ^Description                                ^Tell      ^Guild    ^Priv
|!banlist| | |Shows a listing of all currently banned characters|Guest|Guest|Guest|
+
|!banlist |         |                 |Shows a listing of all banned characters   |Guest     |Guest     |Guest
|!ban|[list]| |Shows a listing of all currently banned characters|Admin |Admin |Admin |
+
|!ban     |add     |<name> <why>     |Permanently bans <name>, optional <why>   |Admin     |Admin     |Admin
|!ban|add       |<name> [<reason>]      |Permanently bans <name>, with optional <reason> |Admin |Admin |Admin |
+
|!ban     |add     |<name> <t> [<why>]|Temporarly bans <name>, optional <why>.   |Admin     |Admin     |Admin
|!ban|add       |<name> <time> [<reason>]       |Temporarily bans <name>, with optional <reason>. Time is in the format #[mhd], where the optional suffix defines the unit of time. m means time is in minutes, h for hours, d for days. The bot checks once every minute for bans that timed out. |Admin |Admin |Admin |
+
|!ban     |del     |<name>           |Unbans <name>                             |Admin    |Admin    |Admin
|!ban|del       |<name>       |Unbans <name>|Admin|Admin|Admin|
+
|!ban    |history  |                  |Shows previously banned last issue details |Admin     |Admin     |Admin
 +
|!ban    |search  |<word>            |Searches ban datas for <word>              |Admin    |Admin    |Admin
 
</pre>
 
</pre>
 +
 +
* : the optional suffix defines the unit of time. m means time is in minutes, h for hours, d for days. The bot checks once every minute for bans that timed out.

Revision as of 11:33, 13 October 2021

BanManager.php

Description

Module to manage banning and unbanning of characters in the bot.


Features

 * allows adding and removing of bans
 * temporary bans that run out automatically
 * optional reason for a ban is saved
 * shows all information about banned users


Commands provided
^Command  ^ Keyword ^Argument(s)       ^Description                                ^Tell      ^Guild     ^Priv
|!banlist |         |                  |Shows a listing of all banned characters   |Guest     |Guest     |Guest
|!ban     |add      |<name> <why>      |Permanently bans <name>, optional <why>    |Admin     |Admin     |Admin
|!ban     |add      |<name> <t> [<why>]|Temporarly bans <name>, optional <why>.    |Admin     |Admin     |Admin
|!ban     |del      |<name>            |Unbans <name>                              |Admin     |Admin     |Admin
|!ban     |history  |                  |Shows previously banned last issue details |Admin     |Admin     |Admin
|!ban     |search   |<word>            |Searches ban datas for <word>              |Admin     |Admin     |Admin
  • : the optional suffix defines the unit of time. m means time is in minutes, h for hours, d for days. The bot checks once every minute for bans that timed out.