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

makeroom::MakeroomPlugin Class Reference

Inheritance diagram for makeroom::MakeroomPlugin:
b3::plugin::Plugin b3::plugin::Plugin

List of all members.

Public Member Functions

def onLoadConfig
def loadConfigAutomation
def uninstall_automation
def onStartup
def onEvent
def getCmd
def cmd_makeroomauto
def cmd_makeroom
def check_free_slots
def onLoadConfig
def loadConfigAutomation
def uninstall_automation
def onStartup
def onEvent
def getCmd
def cmd_makeroomauto
def cmd_makeroom
def check_free_slots

Private Member Functions

def _free_a_slot
def _free_a_slot

Static Private Attributes

 _adminPlugin = None
 _non_member_level = None
 _automation_enabled = None
 _total_slots = None
 _min_free_slots = None
 _delay = None
tuple _kick_in_progress = threading.Lock()

Detailed Description

This plugin provides a command to free a slot kicking the last connected player from
the lowest group

Member Function Documentation

def makeroom::MakeroomPlugin::_free_a_slot (   self,
  client 
) [private]
def makeroom::MakeroomPlugin::_free_a_slot (   self,
  client 
) [private]
def makeroom::MakeroomPlugin::check_free_slots (   self,
  last_connected_client 
)
def makeroom::MakeroomPlugin::check_free_slots (   self,
  last_connected_client 
)
def makeroom::MakeroomPlugin::cmd_makeroom (   self,
  data = None,
  client = None,
  cmd = None 
)
\
free a slot
def makeroom::MakeroomPlugin::cmd_makeroom (   self,
  data = None,
  client = None,
  cmd = None 
)
\
free a slot
def makeroom::MakeroomPlugin::cmd_makeroomauto (   self,
  data = None,
  client = None,
  cmd = None 
)
\
<on/off> - enable or disable automation
def makeroom::MakeroomPlugin::cmd_makeroomauto (   self,
  data = None,
  client = None,
  cmd = None 
)
\
<on/off> - enable or disable automation
def makeroom::MakeroomPlugin::getCmd (   self,
  cmd 
)
def makeroom::MakeroomPlugin::getCmd (   self,
  cmd 
)
def makeroom::MakeroomPlugin::loadConfigAutomation (   self)
def makeroom::MakeroomPlugin::loadConfigAutomation (   self)
def makeroom::MakeroomPlugin::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 makeroom::MakeroomPlugin::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 makeroom::MakeroomPlugin::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 makeroom::MakeroomPlugin::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 makeroom::MakeroomPlugin::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.

def makeroom::MakeroomPlugin::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.

def makeroom::MakeroomPlugin::uninstall_automation (   self)
def makeroom::MakeroomPlugin::uninstall_automation (   self)

Member Data Documentation

makeroom::MakeroomPlugin::_adminPlugin = None [static, private]
makeroom::MakeroomPlugin::_delay = None [static, private]
tuple makeroom::MakeroomPlugin::_kick_in_progress = threading.Lock() [static, private]
makeroom::MakeroomPlugin::_total_slots = None [static, private]

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