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

b3::plugins::tk::TkPlugin Class Reference

Inheritance diagram for b3::plugins::tk::TkPlugin:
b3::plugin::Plugin

List of all members.

Public Member Functions

def onStartup
def onLoadConfig
def onEvent
def checkTKBan
def getMultipliers
def clientDamage
def getClientTkInfo
def forgive
def grudge
def forgiveAll
def cmd_grudge
def cmd_forgive
def cmd_forgivelast
def cmd_forgiveall
def cmd_forgivelist
def cmd_forgiveinfo
def cmd_forgiveclear

Private Attributes

 _grudge_level
 _issue_warning
 _round_grace
 _maxLevel
 _maxPoints

Static Private Attributes

dictionary _levels = {}
 _adminPlugin = None
int _maxLevel = 0
int _maxPoints = 0
 _grudge_enable = True
int _grudge_level = 0
 _private_messages = None
list _ffa = ['dm', 'ffa', 'syc-ffa']

Member Function Documentation

def b3::plugins::tk::TkPlugin::checkTKBan (   self,
  client 
)
def b3::plugins::tk::TkPlugin::clientDamage (   self,
  attacker,
  victim,
  points,
  killed = False 
)
def b3::plugins::tk::TkPlugin::cmd_forgive (   self,
  data,
  client,
  cmd = None 
)
\
<name> - forgive a player for team damaging
def b3::plugins::tk::TkPlugin::cmd_forgiveall (   self,
  data,
  client,
  cmd = None 
)
\
- forgive all attackers' tk points
def b3::plugins::tk::TkPlugin::cmd_forgiveclear (   self,
  data,
  client,
  cmd = None 
)
\
<name> - clear a user's tk points
def b3::plugins::tk::TkPlugin::cmd_forgiveinfo (   self,
  data,
  client,
  cmd = None 
)
\
<name> - display a user's tk points
def b3::plugins::tk::TkPlugin::cmd_forgivelast (   self,
  data,
  client,
  cmd = None 
)
\
- forgive the last person to tk you
def b3::plugins::tk::TkPlugin::cmd_forgivelist (   self,
  data,
  client,
  cmd = None 
)
\
- list all the players who have shot you
def b3::plugins::tk::TkPlugin::cmd_grudge (   self,
  data,
  client,
  cmd = None 
)
\
<name> - grudge a player for team damaging, a grudge player will not be auto-forgiven
def b3::plugins::tk::TkPlugin::forgive (   self,
  acid,
  victim,
  silent = False 
)
def b3::plugins::tk::TkPlugin::forgiveAll (   self,
  acid 
)
def b3::plugins::tk::TkPlugin::getClientTkInfo (   self,
  client 
)
def b3::plugins::tk::TkPlugin::getMultipliers (   self,
  client 
)
def b3::plugins::tk::TkPlugin::grudge (   self,
  acid,
  victim,
  silent = False 
)
def b3::plugins::tk::TkPlugin::onEvent (   self,
  event 
)
\
Called by B3 when a registered event is encountered. You must overwrite
this to intercept events.

Reimplemented from b3::plugin::Plugin.

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

Reimplemented from b3::plugin::Plugin.

def b3::plugins::tk::TkPlugin::onStartup (   self)
\
Called after the plugin is created before it is started. Overwrite this
for anything you need to initialize you plugin with.

Reimplemented from b3::plugin::Plugin.


Member Data Documentation

b3::plugins::tk::TkPlugin::_adminPlugin = None [static, private]
list b3::plugins::tk::TkPlugin::_ffa = ['dm', 'ffa', 'syc-ffa'] [static, private]
int b3::plugins::tk::TkPlugin::_grudge_level = 0 [static, private]
dictionary b3::plugins::tk::TkPlugin::_levels = {} [static, private]
int b3::plugins::tk::TkPlugin::_maxLevel = 0 [static, private]
int b3::plugins::tk::TkPlugin::_maxPoints = 0 [static, private]

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