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

b3::parsers::bf3::Bf3Parser Class Reference

Inheritance diagram for b3::parsers::bf3::Bf3Parser:
b3::parsers::frostbite2::abstractParser::AbstractParser b3::parsers::frostbite2::abstractParser::AbstractParser b3::parser::Parser b3::parser::Parser b3::parser::Parser b3::parser::Parser

List of all members.

Public Member Functions

def startup
def pluginsStarted
def OnPlayerTeamchange
 Frostbite2 events handlers.
def OnPlayerSquadchange
def saybig
 B3 Parser interface implementation.
def message
def getPlayerPings
def load_config_message_delay
 Other methods.
def load_conf_max_say_line_length
def checkVersion
def getClient
def getHardName
def getEasyName
def getGameMode
def getSupportedMapIds
def getServerVars
def getServerInfo
def getTeam
def decodeServerinfo
def startup
def pluginsStarted
def OnPlayerTeamchange
 Frostbite2 events handlers.
def OnPlayerSquadchange
def saybig
 B3 Parser interface implementation.
def message
def getPlayerPings
def load_config_message_delay
 Other methods.
def load_conf_max_say_line_length
def checkVersion
def getClient
def getHardName
def getEasyName
def getGameMode
def getSupportedMapIds
def getServerVars
def getServerInfo
def getTeam
def decodeServerinfo

Static Public Attributes

string gameName = 'bf3'

Private Attributes

 _gamePort

Static Private Attributes

tuple _gameServerVars

Member Function Documentation

def b3::parsers::bf3::Bf3Parser::checkVersion (   self)
def b3::parsers::bf3::Bf3Parser::checkVersion (   self)
def b3::parsers::bf3::Bf3Parser::decodeServerinfo (   data)
<serverName: string> <current playercount: integer> <max playercount: integer> <current gamemode: string>
<current map: string> <roundsPlayed: integer> <roundsTotal: string> <scores: team scores>
<onlineState: online state> <ranked: boolean> <punkBuster: boolean> <hasGamePassword: boolean>
<serverUpTime: seconds> <roundTime: seconds>

['BigBrotherBot #2', '0', '16', 'ConquestLarge0', 'MP_012', '0', '2', '2', '300', '300', '0', '', 'true', 'true', 'false', '5148', '455']

def b3::parsers::bf3::Bf3Parser::decodeServerinfo (   data)
<serverName: string> <current playercount: integer> <max playercount: integer> <current gamemode: string>
<current map: string> <roundsPlayed: integer> <roundsTotal: string> <scores: team scores>
<onlineState: online state> <ranked: boolean> <punkBuster: boolean> <hasGamePassword: boolean>
<serverUpTime: seconds> <roundTime: seconds>

['BigBrotherBot #2', '0', '16', 'ConquestLarge0', 'MP_012', '0', '2', '2', '300', '300', '0', '', 'true', 'true', 'false', '5148', '455']

def b3::parsers::bf3::Bf3Parser::getClient (   self,
  cid,
  guid = None 
)
Get a connected client from storage or create it
B3 CID   <--> character name
B3 GUID  <--> EA_guid
def b3::parsers::bf3::Bf3Parser::getClient (   self,
  cid,
  guid = None 
)
Get a connected client from storage or create it
B3 CID   <--> character name
B3 GUID  <--> EA_guid
def b3::parsers::bf3::Bf3Parser::getEasyName (   self,
  mapname 
)
Change levelname to real name 
def b3::parsers::bf3::Bf3Parser::getEasyName (   self,
  mapname 
)
Change levelname to real name 
def b3::parsers::bf3::Bf3Parser::getGameMode (   self,
  gamemode_id 
)
Get game mode in real name 
def b3::parsers::bf3::Bf3Parser::getGameMode (   self,
  gamemode_id 
)
Get game mode in real name 
def b3::parsers::bf3::Bf3Parser::getHardName (   self,
  mapname 
)
Change real name to level name 
def b3::parsers::bf3::Bf3Parser::getHardName (   self,
  mapname 
)
Change real name to level name 
def b3::parsers::bf3::Bf3Parser::getPlayerPings (   self)
Ask the server for a given client's pings

Reimplemented from b3::parser::Parser.

def b3::parsers::bf3::Bf3Parser::getPlayerPings (   self)
Ask the server for a given client's pings

Reimplemented from b3::parser::Parser.

def b3::parsers::bf3::Bf3Parser::getServerInfo (   self)
query server info, update self.game and return query results
Response: OK,serverName,numPlayers,maxPlayers,level,gamemode,[teamscores],isRanked,hasPunkbuster,hasPassword,serverUptime,roundTime
The first number in the [teamscore] component I listed is numTeams, followed by the score or ticket count for each team (0-4 items), 
then the targetScore. (e.g. in TDM/SQDM this is the number of kills to win)
So when you start a Squad Deathmatch round with 50 kills needed to win, it will look like this:
4,0,0,0,0,50

def b3::parsers::bf3::Bf3Parser::getServerInfo (   self)
query server info, update self.game and return query results
Response: OK,serverName,numPlayers,maxPlayers,level,gamemode,[teamscores],isRanked,hasPunkbuster,hasPassword,serverUptime,roundTime
The first number in the [teamscore] component I listed is numTeams, followed by the score or ticket count for each team (0-4 items), 
then the targetScore. (e.g. in TDM/SQDM this is the number of kills to win)
So when you start a Squad Deathmatch round with 50 kills needed to win, it will look like this:
4,0,0,0,0,50

def b3::parsers::bf3::Bf3Parser::getServerVars (   self)
Update the game property from server fresh data
def b3::parsers::bf3::Bf3Parser::getServerVars (   self)
Update the game property from server fresh data
def b3::parsers::bf3::Bf3Parser::getSupportedMapIds (   self)
return a list of supported levels for the current game mod
def b3::parsers::bf3::Bf3Parser::getSupportedMapIds (   self)
return a list of supported levels for the current game mod
def b3::parsers::bf3::Bf3Parser::getTeam (   self,
  team 
)
convert team numbers to B3 team numbers
def b3::parsers::bf3::Bf3Parser::getTeam (   self,
  team 
)
convert team numbers to B3 team numbers
def b3::parsers::bf3::Bf3Parser::load_conf_max_say_line_length (   self)
def b3::parsers::bf3::Bf3Parser::load_conf_max_say_line_length (   self)
def b3::parsers::bf3::Bf3Parser::load_config_message_delay (   self)

Other methods.

def b3::parsers::bf3::Bf3Parser::load_config_message_delay (   self)

Other methods.

def b3::parsers::bf3::Bf3Parser::message (   self,
  client,
  text 
)
\
display a message to a given player

Reimplemented from b3::parser::Parser.

def b3::parsers::bf3::Bf3Parser::message (   self,
  client,
  text 
)
\
display a message to a given player

Reimplemented from b3::parser::Parser.

def b3::parsers::bf3::Bf3Parser::OnPlayerSquadchange (   self,
  action,
  data 
)
player.onSquadChange <soldier name: player name> <team: Team ID> <squad: Squad ID>    

Effect: Player might have changed squad
NOTE: this event also happens after a player left the game
def b3::parsers::bf3::Bf3Parser::OnPlayerSquadchange (   self,
  action,
  data 
)
player.onSquadChange <soldier name: player name> <team: Team ID> <squad: Squad ID>    

Effect: Player might have changed squad
NOTE: this event also happens after a player left the game
def b3::parsers::bf3::Bf3Parser::OnPlayerTeamchange (   self,
  action,
  data 
)

Frostbite2 events handlers.

player.onTeamChange <soldier name: player name> <team: Team ID> <squad: Squad ID>
Effect: Player might have changed team
def b3::parsers::bf3::Bf3Parser::OnPlayerTeamchange (   self,
  action,
  data 
)

Frostbite2 events handlers.

player.onTeamChange <soldier name: player name> <team: Team ID> <squad: Squad ID>
Effect: Player might have changed team
def b3::parsers::bf3::Bf3Parser::pluginsStarted (   self)
\
Called after the parser loaded and started all plugins. 
Overwrite this in parsers to take actions once plugins are ready

Reimplemented from b3::parser::Parser.

def b3::parsers::bf3::Bf3Parser::pluginsStarted (   self)
\
Called after the parser loaded and started all plugins. 
Overwrite this in parsers to take actions once plugins are ready

Reimplemented from b3::parser::Parser.

def b3::parsers::bf3::Bf3Parser::saybig (   self,
  msg 
)

B3 Parser interface implementation.

\
broadcast a message to all players in a way that will catch their attention.

Reimplemented from b3::parser::Parser.

def b3::parsers::bf3::Bf3Parser::saybig (   self,
  msg 
)

B3 Parser interface implementation.

\
broadcast a message to all players in a way that will catch their attention.

Reimplemented from b3::parser::Parser.

def b3::parsers::bf3::Bf3Parser::startup (   self)
\
Called after the parser is created before run(). Overwrite this
for anything you need to initialize you parser with.

Reimplemented from b3::parser::Parser.

def b3::parsers::bf3::Bf3Parser::startup (   self)
\
Called after the parser is created before run(). Overwrite this
for anything you need to initialize you parser with.

Reimplemented from b3::parser::Parser.


Member Data Documentation


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