Overview

Namespaces

  • Budabot
    • Core
      • Modules
    • User
      • Modules
  • None
  • Tyrence
    • Modules

Classes

  • AdminController
  • AliasController
  • AltInfo
  • AltsController
  • BanController
  • BuddylistController
  • ColorsController
  • CommandlistController
  • CommandSearchController
  • ConfigController
  • EventlistController
  • HelpController
  • LogsController
  • PlayerLookupController
  • ProfileCommandReply
  • ProfileController
  • SettingsController
  • SQLController
  • SystemController
  • UsageController
  • WhitelistController

Functions

  • read_input
  • Overview
  • Namespace
  • Class

Class SystemController

Authors: - Sebuda (RK2) - Tyrence (RK2)

Namespace: Budabot\Core\Modules
Definecommand(:

command = 'checkaccess', accessLevel = 'all', description = 'Check effective access level of a character', help = 'checkaccess.txt' )


Definecommand(:

command = 'clearqueue', accessLevel = 'mod', description = 'Clear outgoing chatqueue from all pending messages', help = 'clearqueue.txt' )


Definecommand(:

command = 'macro', accessLevel = 'all', description = 'Execute multiple commands at once', help = 'macro.txt' )


Definecommand(:

command = 'showcommand', accessLevel = 'mod', description = 'Execute a command and have output sent to another player', help = 'showcommand.txt' )


Definecommand(:

command = 'system', accessLevel = 'mod', description = 'Show detailed information about the bot', help = 'system.txt' )


Definecommand(:

command = 'restart', accessLevel = 'admin', description = 'Restart the bot', help = 'system.txt', defaultStatus = '1' )


Definecommand(:

command = 'shutdown', accessLevel = 'admin', description = 'Shutdown the bot', help = 'system.txt', defaultStatus = '1' )


Instance: Commands this controller contains:
Located at SYSTEM/SystemController.class.php
Methods summary
public
# setup( )

Setup

This handler is called on bot startup.
public
# restartCommand( $message, $channel, $sender, $sendto, $args )

Handlescommand("restart")

Matches("/^restart$/i")
public
# shutdownCommand( $message, $channel, $sender, $sendto, $args )

Handlescommand("shutdown")

Matches("/^shutdown$/i")
public
# systemCommand( $message, $channel, $sender, $sendto, $args )

Handlescommand("system")

Matches("/^system$/i")
public
# checkaccessCommand( $message, $channel, $sender, $sendto, $args )

Handlescommand("checkaccess")

Matches("/^checkaccess

(.+)$/i")

Matches("/^checkaccess$/i")
public
# clearqueueCommand( $message, $channel, $sender, $sendto, $args )

This command handler clear outgoing chatqueue from all pending messages.

This command handler clear outgoing chatqueue from all pending messages.

Handlescommand("clearqueue")
public
# macroCommand( $message, $channel, $sender, $sendto, $args )

This command handler execute multiple commands at once.

This command handler execute multiple commands at once.

Handlescommand("macro")

Matches("/^macro

(.+)$/si")
public
# refreshMySQLConnectionEvent( $eventObj )

Defaultstatus("1")

Description("this

event handler is called every hour to keep MySQL connection active")

Event("timer(1hr)")
public
# onConnectEvent( $eventObj )

Defaultstatus("1")

Description("notify

private channel, guild channel, and admins that bot is online")

Event("connect")
public
# showCommandCommand( $message, $channel, $sender, $sendto, $args )

Handlescommand("showcommand")

Matches("/^showcommand

([^ ]+) (.+)$/i")
Properties summary
public $moduleName

Name of the module. Set automatically by module loader.

Name of the module. Set automatically by module loader.
#
public $accessManager

Inject
#
public $adminManager

Inject
#
public $chatBot

Inject
#
public $db

Inject
#
public $commandManager

Inject
#
public $eventManager

Inject
#
public $commandAlias

Inject
#
public $subcommandManager

Inject
#
public $helpManager

Inject
#
public $buddylistManager

Inject
#
public $settingManager

Inject
#
public $text

Inject
#
public $util

Inject
#
public $logger

Logger
#
public string $defaultSymbol

Accesslevel("mod")

Description("command

prefix symbol")

Options("!;#;*;@;$;+;-")

Setting("symbol")

Type("text")

Visibility("edit")
# "!"
public string $defaultMaxBlobSize

Accesslevel("mod")

Description("max

chars for a window")

Help("max_blob_size.txt")

Options("4500;6000;7500;9000;10500;12000")

Setting("max_blob_size")

Type("number")

Visibility("edit")
# "7500"
public string $defaultHttpTimeout

Accesslevel("mod")

Description("max

time to wait for response from making http queries")

Options("1s;2s;5s;10s;30s")

Setting("http_timeout")

Type("time")

Visibility("edit")
# "10s"
public string $defaultGuildChannelStatus

Accesslevel("mod")

Description("enable

the guild channel")

Intoptions("1;0")

Options("true;false")

Setting("guild_channel_status")

Type("options")

Visibility("edit")
# "1"
public string $defaultGuildChannelCmdFeedback

Accesslevel("mod")

Description("show

message on invalid command in guild channel")

Intoptions("1;0")

Options("true;false")

Setting("guild_channel_cmd_feedback")

Type("options")

Visibility("edit")
# "1"
public string $defaultPrivateChannelCmdFeedback

Accesslevel("mod")

Description("show

message on invalid command in private channel")

Intoptions("1;0")

Options("true;false")

Setting("private_channel_cmd_feedback")

Type("options")

Visibility("edit")
# "1"
public string $defaultVersion

Accesslevel("mod")

Description("database

version")

Setting("version")

Type("text")

Visibility("noedit")
# "0"
public string $defaultAccessDeniedNotifyGuild

Accesslevel("mod")

Description("notify

guild channel when a player is denied access to a command in tell")

Intoptions("1;0")

Options("true;false")

Setting("access_denied_notify_guild")

Type("options")

Visibility("edit")
# "1"
public string $defaultAccessDeniedNotifyPriv

Accesslevel("mod")

Description("notify

private channel when a player is denied access to a command in tell")

Intoptions("1;0")

Options("true;false")

Setting("access_denied_notify_priv")

Type("options")

Visibility("edit")
# "1"
Budabot 4 Docs API documentation generated by ApiGen