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 HelpController

Authors: - Tyrence (RK2)

Namespace: Budabot\Core\Modules
Definecommand(:

command = 'help', accessLevel = 'all', description = 'Show help topics', help = 'help.txt', defaultStatus = '1' )


Instance: Commands this class contains:
Located at HELP/HelpController.class.php
Methods summary
public
# setup( )

Setup

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

Handlescommand("help")

Matches("/^help$/i")

public
# helpShowCommand( $message, $channel, $sender, $sendto, $args )

Handlescommand("help")

Matches("/^help

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

Name of the module. Set automatically by module loader.

Name of the module. Set automatically by module loader.

#
public $commandManager

Inject

#
public $commandAlias

Inject

#
public $helpManager

Inject

#
public $text

Inject

#
Budabot 4 Docs API documentation generated by ApiGen