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

teamspeakbf::TeamspeakbfPlugin Class Reference

Inheritance diagram for teamspeakbf::TeamspeakbfPlugin:
b3::plugin::Plugin

List of all members.

Public Member Functions

def startup
def getCmd
def onLoadConfig
def readConfig
def onEvent
def cmd_tsreconnect
def cmd_tsdisconnect
def cmd_teamspeak
def cmd_tsauto
def moveClient
def tsSendCommand
def tsConnect
def tsInitChannels
def tsDeleteChannels
def tsCreateSubChannel
def tsGetChannelIdByName
def tsGetClient
def tsMoveTsclientToChannelId
def tsIsClientInB3Channel
def tsIsClientInChannelTeam1
def tsIsClientInChannelTeam2
def tsTellClient

Public Attributes

 TS3QueryPort
 TS3ChannelB3
 TS3ChannelTeam1
 TS3ChannelTeam2
 autoswitchDefaultTarget
 tsServerPort
 tsChannelIdSquadsTeam1
 tsChannelIdSquadsTeam2

Static Public Attributes

 connected = False
 give a bit a guidance to the user in such case
 TS3ServerIP = None
int TS3QueryPort = 10011
 TS3ServerID = None
 TS3Login = None
 TS3Password = None
string TS3ChannelB3 = 'B3 autoswitched channels'
string TS3ChannelTeam1 = 'Team A'
string TS3ChannelTeam2 = 'Team B'
 tsconnection = None
string tsServerPort = 'unknown'
dictionary squadNames
 autoswitchDefault = True
string autoswitchDefaultTarget = 'squad'
 tsChannelIdB3 = None
 tsChannelIdTeam1 = None
 tsChannelIdTeam2 = None
dictionary tsChannelIdSquadsTeam1
dictionary tsChannelIdSquadsTeam2

Private Member Functions

def _tsSendCommand

Static Private Attributes

 _adminPlugin = None

Member Function Documentation

def teamspeakbf::TeamspeakbfPlugin::_tsSendCommand (   self,
  cmd,
  parameter,
  option,
  numtries = 1 
) [private]
def teamspeakbf::TeamspeakbfPlugin::cmd_teamspeak (   self,
  data,
  client,
  cmd = None 
)
\
Teamspeak server info
def teamspeakbf::TeamspeakbfPlugin::cmd_tsauto (   self,
  data,
  client,
  cmd = None 
)
\
Change the way you are moved to the different TeamSpeak channels
def teamspeakbf::TeamspeakbfPlugin::cmd_tsdisconnect (   self,
  data,
  client,
  cmd = None 
)
\
Disconnect B3 from the Teamspeak server
def teamspeakbf::TeamspeakbfPlugin::cmd_tsreconnect (   self,
  data,
  client,
  cmd = None 
)
\
Reconnect B3 to the Teamspeak server
def teamspeakbf::TeamspeakbfPlugin::getCmd (   self,
  cmd 
)
def teamspeakbf::TeamspeakbfPlugin::moveClient (   self,
  client 
)
Move the client to its team or squad depending on his settings
def teamspeakbf::TeamspeakbfPlugin::onEvent (   self,
  event 
)
\
Handle intercepted events

Reimplemented from b3::plugin::Plugin.

def teamspeakbf::TeamspeakbfPlugin::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 teamspeakbf::TeamspeakbfPlugin::readConfig (   self)
def teamspeakbf::TeamspeakbfPlugin::startup (   self)
\
Initialize plugin settings

Reimplemented from b3::plugin::Plugin.

def teamspeakbf::TeamspeakbfPlugin::tsConnect (   self)
def teamspeakbf::TeamspeakbfPlugin::tsCreateSubChannel (   self,
  channelName,
  parentChannelId 
)
def teamspeakbf::TeamspeakbfPlugin::tsDeleteChannels (   self)
def teamspeakbf::TeamspeakbfPlugin::tsGetChannelIdByName (   self,
  channelName,
  channellist = [],
  parentChannel = None 
)
def teamspeakbf::TeamspeakbfPlugin::tsGetClient (   self,
  client 
)
Return a dict with all TS client properties as returned by the 
clientinfo command
def teamspeakbf::TeamspeakbfPlugin::tsInitChannels (   self)
def teamspeakbf::TeamspeakbfPlugin::tsIsClientInB3Channel (   self,
  tsclient 
)
Return True if the client is found in the B3 channel or one of
its sub-channels
def teamspeakbf::TeamspeakbfPlugin::tsIsClientInChannelTeam1 (   self,
  tsclient 
)
Return True if the client is found in the team1 channel or one of
its sub-channels
def teamspeakbf::TeamspeakbfPlugin::tsIsClientInChannelTeam2 (   self,
  tsclient 
)
Return True if the client is found in the team2 channel or one of
its sub-channels
def teamspeakbf::TeamspeakbfPlugin::tsMoveTsclientToChannelId (   self,
  tsclient,
  tsChannelId 
)
def teamspeakbf::TeamspeakbfPlugin::tsSendCommand (   self,
  cmd,
  parameter = {},
  option = [] 
)
def teamspeakbf::TeamspeakbfPlugin::tsTellClient (   self,
  clid,
  msg 
)
Send a private message to a TS3 client

Member Data Documentation

give a bit a guidance to the user in such case

Initial value:
{
        0: 'no squad',
        1: 'Alpha',
        2: 'Bravo',
        3: 'Charlie',
        4: 'Delta',
        5: 'Echo',
        6: 'Foxtrot',
        7: 'Golf',
        8: 'Hotel',
    }
string teamspeakbf::TeamspeakbfPlugin::TS3ChannelB3 = 'B3 autoswitched channels' [static]
Initial value:
{
        0: None,
        1: None,
        2: None,
        3: None,
        4: None,
        5: None,
        6: None,
        7: None,
        8: None,
    }
Initial value:
{
        0: None,
        1: None,
        2: None,
        3: None,
        4: None,
        5: None,
        6: None,
        7: None,
        8: None,
    }
string teamspeakbf::TeamspeakbfPlugin::tsServerPort = 'unknown' [static]

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