BigBrotherBot v1.8.0
System Development Information for the BigBrotherBot project.

b3::plugin::Plugin Class Reference

Inheritance diagram for b3::plugin::Plugin:
b3::extplugins::xlrstats::XlrstatscontrollerPlugin b3::extplugins::xlrstats::XlrstatscontrollerPlugin b3::extplugins::xlrstats::XlrstatshistoryPlugin b3::extplugins::xlrstats::XlrstatshistoryPlugin b3::extplugins::xlrstats::XlrstatsPlugin b3::extplugins::xlrstats::XlrstatsPlugin b3::plugins::admin::AdminPlugin b3::plugins::admin::AdminPlugin b3::plugins::adv::AdvPlugin b3::plugins::adv::AdvPlugin b3::plugins::censor::CensorPlugin b3::plugins::censor::CensorPlugin b3::plugins::cod7http::Cod7HttpPlugin b3::plugins::cod7http::Cod7HttpPlugin b3::plugins::codam::CodamPlugin b3::plugins::codam::CodamPlugin b3::plugins::ftpytail::FtpytailPlugin b3::plugins::ftpytail::FtpytailPlugin b3::plugins::httpytail::HttpytailPlugin b3::plugins::httpytail::HttpytailPlugin b3::plugins::login::LoginPlugin b3::plugins::login::LoginPlugin b3::plugins::pingwatch::PingwatchPlugin b3::plugins::pingwatch::PingwatchPlugin b3::plugins::publist::PublistPlugin b3::plugins::publist::PublistPlugin b3::plugins::punkbuster::PunkbusterPlugin b3::plugins::punkbuster::PunkbusterPlugin b3::plugins::sftpytail::SftpytailPlugin b3::plugins::sftpytail::SftpytailPlugin b3::plugins::spamcontrol::SpamcontrolPlugin b3::plugins::spamcontrol::SpamcontrolPlugin b3::plugins::stats::StatsPlugin b3::plugins::stats::StatsPlugin b3::plugins::status::StatusPlugin b3::plugins::status::StatusPlugin b3::plugins::tk::TkPlugin b3::plugins::tk::TkPlugin b3::plugins::welcome::WelcomePlugin b3::plugins::welcome::WelcomePlugin makeroom::MakeroomPlugin makeroom::MakeroomPlugin poweradminbf3::Poweradminbf3Plugin poweradminbf3::Poweradminbf3Plugin teamspeakbf::TeamspeakbfPlugin xlrstats::XlrstatscontrollerPlugin xlrstats::XlrstatshistoryPlugin xlrstats::XlrstatsPlugin

List of all members.

Public Member Functions

def __init__
def enable
def disable
def isEnabled
def getMessage
def loadConfig
def onLoadConfig
def saveConfig
def registerEvent
def createEvent
def startup
def onStartup
def start
def parseEvent
def handle
def onEvent
def error
def debug
def bot
def verbose
def warning
def info
def exception
def critical
def __init__
def enable
def disable
def isEnabled
def getMessage
def loadConfig
def onLoadConfig
def saveConfig
def registerEvent
def createEvent
def startup
def onStartup
def start
def parseEvent
def handle
def onEvent
def error
def debug
def bot
def verbose
def warning
def info
def exception
def critical

Static Public Attributes

 console = None
list events = []
 config = None
 working = True
 requiresConfigFile = True

Private Attributes

 _messages

Static Private Attributes

 _enabled = True
dictionary _messages = {}

Constructor & Destructor Documentation


Member Function Documentation

def b3::plugin::Plugin::bot (   self,
  msg,
  args,
  kwargs 
)
\
Log a bot message to the main log.
def b3::plugin::Plugin::bot (   self,
  msg,
  args,
  kwargs 
)
\
Log a bot message to the main log.
def b3::plugin::Plugin::createEvent (   self,
  key,
  name 
)
def b3::plugin::Plugin::createEvent (   self,
  key,
  name 
)
def b3::plugin::Plugin::critical (   self,
  msg,
  args,
  kwargs 
)
\
Log a critical message to the main log.
def b3::plugin::Plugin::critical (   self,
  msg,
  args,
  kwargs 
)
\
Log a critical message to the main log.
def b3::plugin::Plugin::debug (   self,
  msg,
  args,
  kwargs 
)
\
Log a debug message to the main log.
def b3::plugin::Plugin::debug (   self,
  msg,
  args,
  kwargs 
)
\
Log a debug message to the main log.
def b3::plugin::Plugin::disable (   self)
def b3::plugin::Plugin::disable (   self)
def b3::plugin::Plugin::enable (   self)
def b3::plugin::Plugin::enable (   self)
def b3::plugin::Plugin::error (   self,
  msg,
  args,
  kwargs 
)
\
Log an error message to the main log.
def b3::plugin::Plugin::error (   self,
  msg,
  args,
  kwargs 
)
\
Log an error message to the main log.
def b3::plugin::Plugin::exception (   self,
  msg,
  args,
  kwargs 
)
\
Log an exception message to the main log.
def b3::plugin::Plugin::exception (   self,
  msg,
  args,
  kwargs 
)
\
Log an exception message to the main log.
def b3::plugin::Plugin::getMessage (   self,
  msg,
  args 
)
def b3::plugin::Plugin::getMessage (   self,
  msg,
  args 
)
def b3::plugin::Plugin::handle (   self,
  event 
)
def b3::plugin::Plugin::handle (   self,
  event 
)
def b3::plugin::Plugin::info (   self,
  msg,
  args,
  kwargs 
)
\
Log an info message to the main log.
def b3::plugin::Plugin::info (   self,
  msg,
  args,
  kwargs 
)
\
Log an info message to the main log.
def b3::plugin::Plugin::isEnabled (   self)
def b3::plugin::Plugin::isEnabled (   self)
def b3::plugin::Plugin::loadConfig (   self,
  fileName = None 
)
def b3::plugin::Plugin::loadConfig (   self,
  fileName = None 
)
def b3::plugin::Plugin::onLoadConfig (   self)
\
This is called after loadConfig(). Any plugin private variables loaded
from the config need to be reset here.

Reimplemented in b3::extplugins::xlrstats::XlrstatsPlugin, b3::plugins::adv::AdvPlugin, b3::plugins::censor::CensorPlugin, b3::plugins::cod7http::Cod7HttpPlugin, b3::plugins::ftpytail::FtpytailPlugin, b3::plugins::httpytail::HttpytailPlugin, b3::plugins::login::LoginPlugin, b3::plugins::pingwatch::PingwatchPlugin, b3::plugins::publist::PublistPlugin, b3::plugins::punkbuster::PunkbusterPlugin, b3::plugins::sftpytail::SftpytailPlugin, b3::plugins::spamcontrol::SpamcontrolPlugin, b3::plugins::stats::StatsPlugin, b3::plugins::status::StatusPlugin, b3::plugins::tk::TkPlugin, b3::plugins::welcome::WelcomePlugin, b3::extplugins::xlrstats::XlrstatsPlugin, b3::plugins::adv::AdvPlugin, b3::plugins::censor::CensorPlugin, b3::plugins::cod7http::Cod7HttpPlugin, b3::plugins::ftpytail::FtpytailPlugin, b3::plugins::httpytail::HttpytailPlugin, b3::plugins::login::LoginPlugin, b3::plugins::pingwatch::PingwatchPlugin, b3::plugins::publist::PublistPlugin, b3::plugins::punkbuster::PunkbusterPlugin, b3::plugins::sftpytail::SftpytailPlugin, b3::plugins::spamcontrol::SpamcontrolPlugin, b3::plugins::stats::StatsPlugin, b3::plugins::status::StatusPlugin, b3::plugins::tk::TkPlugin, b3::plugins::welcome::WelcomePlugin, makeroom::MakeroomPlugin, poweradminbf3::Poweradminbf3Plugin, teamspeakbf::TeamspeakbfPlugin, makeroom::MakeroomPlugin, poweradminbf3::Poweradminbf3Plugin, and xlrstats::XlrstatsPlugin.

def b3::plugin::Plugin::onLoadConfig (   self)
\
This is called after loadConfig(). Any plugin private variables loaded
from the config need to be reset here.

Reimplemented in b3::extplugins::xlrstats::XlrstatsPlugin, b3::plugins::adv::AdvPlugin, b3::plugins::censor::CensorPlugin, b3::plugins::cod7http::Cod7HttpPlugin, b3::plugins::ftpytail::FtpytailPlugin, b3::plugins::httpytail::HttpytailPlugin, b3::plugins::login::LoginPlugin, b3::plugins::pingwatch::PingwatchPlugin, b3::plugins::publist::PublistPlugin, b3::plugins::punkbuster::PunkbusterPlugin, b3::plugins::sftpytail::SftpytailPlugin, b3::plugins::spamcontrol::SpamcontrolPlugin, b3::plugins::stats::StatsPlugin, b3::plugins::status::StatusPlugin, b3::plugins::tk::TkPlugin, b3::plugins::welcome::WelcomePlugin, b3::extplugins::xlrstats::XlrstatsPlugin, b3::plugins::adv::AdvPlugin, b3::plugins::censor::CensorPlugin, b3::plugins::cod7http::Cod7HttpPlugin, b3::plugins::ftpytail::FtpytailPlugin, b3::plugins::httpytail::HttpytailPlugin, b3::plugins::login::LoginPlugin, b3::plugins::pingwatch::PingwatchPlugin, b3::plugins::publist::PublistPlugin, b3::plugins::punkbuster::PunkbusterPlugin, b3::plugins::sftpytail::SftpytailPlugin, b3::plugins::spamcontrol::SpamcontrolPlugin, b3::plugins::stats::StatsPlugin, b3::plugins::status::StatusPlugin, b3::plugins::tk::TkPlugin, b3::plugins::welcome::WelcomePlugin, makeroom::MakeroomPlugin, poweradminbf3::Poweradminbf3Plugin, teamspeakbf::TeamspeakbfPlugin, makeroom::MakeroomPlugin, poweradminbf3::Poweradminbf3Plugin, and xlrstats::XlrstatsPlugin.

def b3::plugin::Plugin::parseEvent (   self,
  event 
)
def b3::plugin::Plugin::parseEvent (   self,
  event 
)
def b3::plugin::Plugin::registerEvent (   self,
  eventName 
)
def b3::plugin::Plugin::registerEvent (   self,
  eventName 
)
def b3::plugin::Plugin::saveConfig (   self)
def b3::plugin::Plugin::saveConfig (   self)
def b3::plugin::Plugin::start (   self)
\
Called after Plugin.startup().
def b3::plugin::Plugin::start (   self)
\
Called after Plugin.startup().
def b3::plugin::Plugin::verbose (   self,
  msg,
  args,
  kwargs 
)
\
Log a verbose message to the main log. More "chatty" than a debug message.
def b3::plugin::Plugin::verbose (   self,
  msg,
  args,
  kwargs 
)
\
Log a verbose message to the main log. More "chatty" than a debug message.
def b3::plugin::Plugin::warning (   self,
  msg,
  args,
  kwargs 
)
\
Log a warning message to the main log.
def b3::plugin::Plugin::warning (   self,
  msg,
  args,
  kwargs 
)
\
Log a warning message to the main log.

Member Data Documentation

b3::plugin::Plugin::_enabled = True [static, private]
b3::plugin::Plugin::config = None [static]
list b3::plugin::Plugin::events = [] [static]
b3::plugin::Plugin::working = True [static]

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Properties