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

poweradminbf3::Poweradminbf3Plugin Class Reference

Inheritance diagram for poweradminbf3::Poweradminbf3Plugin:
b3::plugin::Plugin b3::plugin::Plugin

List of all members.

Public Member Functions

def __init__
def onLoadConfig
 Plugin interface implementation.
def startup
def onEvent
def cmd_roundnext
 Commands implementations.
def cmd_serverreboot
def cmd_endround
def cmd_roundrestart
def cmd_kill
def cmd_changeteam
def cmd_swap
def cmd_punkbuster
def cmd_setnextmap
def cmd_loadconfig
def cmd_listconfig
def cmd_scramble
def cmd_scramblemode
def cmd_autoscramble
def cmd_unlockmode
def cmd_vehicles
def cmd_idle
def cmd_autoassign
def cmd_autobalance
def load_server_config
def config_manager_construct_file_names
def config_manager_check_config
def autoassign
def run_autobalance
def auto_move_players
def autobalance_time
def count_teams
def client_connect
def client_disconnect
def current_winningTeamID
def __init__
def onLoadConfig
 Plugin interface implementation.
def startup
def onEvent
def cmd_roundnext
 Commands implementations.
def cmd_roundrestart
def cmd_kill
def cmd_changeteam
def cmd_swap
def cmd_punkbuster
def cmd_setnextmap
def cmd_loadconfig
def cmd_listconfig
def cmd_scramble
def cmd_scramblemode
def cmd_autoscramble
def load_server_config

Public Attributes

 no_level_check_level

Private Member Functions

def _load_scrambler
 Other methods.
def _load_messages
def _load_config_path
def _load_configmanager_config_path
def _load_no_level_check_level
def _load_autobalance_settings
def _load_configmanager
def _getCmd
def _registerCommands
def _movePlayer
def _get_server_config_directory
def _load_server_config_from_file
def _list_available_server_config_files
def _getConfigSoundingLike
def _sendMessage
def _get_rounds_left
def _load_scrambler
 Other methods.
def _load_messages
def _load_config_path
def _load_no_level_check_level
def _getCmd
def _registerCommands
def _movePlayer
def _get_server_config_directory
def _load_server_config_from_file
def _list_available_server_config_files
def _getConfigSoundingLike

Private Attributes

 _adminPlugin
 _configPath
 _configManager_configPath
 _configmanager_delay
 _team_swap_threshold
 _autoassign
 _no_autoassign_level
 _joined_order
 _autobalance
 _run_autobalancer
 _one_round_over
 _autobalance_timer
 _autobalance_message_interval
 _cronTab_autobalance
 _scramblingdone
 _scrambling_planned
 _autoscramble_rounds
 _autoscramble_maps
 _scrambler
 _last_idleTimeout
 _configmanager
 _next_typeandmap
 _next_gametype

Constructor & Destructor Documentation

def poweradminbf3::Poweradminbf3Plugin::__init__ (   self,
  console,
  config = None 
)

Reimplemented from b3::plugin::Plugin.

def poweradminbf3::Poweradminbf3Plugin::__init__ (   self,
  console,
  config = None 
)

Reimplemented from b3::plugin::Plugin.


Member Function Documentation

def poweradminbf3::Poweradminbf3Plugin::_get_rounds_left (   self) [private]
check and return rounds left
def poweradminbf3::Poweradminbf3Plugin::_get_server_config_directory (   self,
  dir_name = '' 
) [private]
returns an existing absolute directory path supposed to contain some game server config files.
Actual directory if found by checking the existence of :
    dir_name
    <plugin config folder>/dir_name
    <B3 config directory>/dir_name
If no directory found, returns None
def poweradminbf3::Poweradminbf3Plugin::_get_server_config_directory (   self,
  dir_name = '' 
) [private]
returns an existing absolute directory path supposed to contain some game server config files.
Actual directory if found by checking the existence of :
    dir_name
    <plugin config folder>/dir_name
    <B3 config directory>/dir_name
If no directory found, returns None
def poweradminbf3::Poweradminbf3Plugin::_getCmd (   self,
  cmd 
) [private]
def poweradminbf3::Poweradminbf3Plugin::_getCmd (   self,
  cmd 
) [private]
def poweradminbf3::Poweradminbf3Plugin::_getConfigSoundingLike (   self,
  config_name 
) [private]
return a list of existing server config names sounding like config_name
def poweradminbf3::Poweradminbf3Plugin::_getConfigSoundingLike (   self,
  config_name 
) [private]
return a list of existing server config names sounding like config_name
def poweradminbf3::Poweradminbf3Plugin::_list_available_server_config_files (   self) [private]
def poweradminbf3::Poweradminbf3Plugin::_list_available_server_config_files (   self) [private]
def poweradminbf3::Poweradminbf3Plugin::_load_autobalance_settings (   self) [private]
def poweradminbf3::Poweradminbf3Plugin::_load_config_path (   self) [private]
def poweradminbf3::Poweradminbf3Plugin::_load_config_path (   self) [private]
def poweradminbf3::Poweradminbf3Plugin::_load_configmanager (   self) [private]
def poweradminbf3::Poweradminbf3Plugin::_load_configmanager_config_path (   self) [private]
def poweradminbf3::Poweradminbf3Plugin::_load_messages (   self) [private]
Loads the messages section from the plugin config file
def poweradminbf3::Poweradminbf3Plugin::_load_messages (   self) [private]
Loads the messages section from the plugin config file
def poweradminbf3::Poweradminbf3Plugin::_load_no_level_check_level (   self) [private]
def poweradminbf3::Poweradminbf3Plugin::_load_no_level_check_level (   self) [private]
def poweradminbf3::Poweradminbf3Plugin::_load_scrambler (   self) [private]

Other methods.

def poweradminbf3::Poweradminbf3Plugin::_load_scrambler (   self) [private]

Other methods.

def poweradminbf3::Poweradminbf3Plugin::_load_server_config_from_file (   self,
  client,
  config_name,
  file_path,
  threaded = False 
) [private]
Loads a preset config file to send to the server
def poweradminbf3::Poweradminbf3Plugin::_load_server_config_from_file (   self,
  client,
  config_name,
  file_path,
  threaded = False 
) [private]
Loads a preset config file to send to the server
def poweradminbf3::Poweradminbf3Plugin::_movePlayer (   self,
  client,
  teamId,
  squadId = 0 
) [private]
def poweradminbf3::Poweradminbf3Plugin::_movePlayer (   self,
  client,
  teamId,
  squadId = 0 
) [private]
def poweradminbf3::Poweradminbf3Plugin::_registerCommands (   self) [private]
def poweradminbf3::Poweradminbf3Plugin::_registerCommands (   self) [private]
def poweradminbf3::Poweradminbf3Plugin::_sendMessage (   self,
  client,
  msg 
) [private]
send message to console when client is None
def poweradminbf3::Poweradminbf3Plugin::auto_move_players (   self,
  team,
  players 
)
def poweradminbf3::Poweradminbf3Plugin::autoassign (   self,
  client 
)
Auto Assign team on joining or changing teams to keep teams balanced
def poweradminbf3::Poweradminbf3Plugin::autobalance_time (   self)
def poweradminbf3::Poweradminbf3Plugin::client_connect (   self,
  client 
)
Add client to joined order list
def poweradminbf3::Poweradminbf3Plugin::client_disconnect (   self,
  client,
  client_name 
)
Remove client from joined order list
def poweradminbf3::Poweradminbf3Plugin::cmd_autoassign (   self,
  data,
  client,
  cmd = None 
)
\
<off|on> manage the auto assign
def poweradminbf3::Poweradminbf3Plugin::cmd_autobalance (   self,
  data,
  client,
  cmd = None 
)
\
<off|on|now> manage the auto balance
def poweradminbf3::Poweradminbf3Plugin::cmd_autoscramble (   self,
  data,
  client,
  cmd = None 
)
\
<off|round|map> manage the auto scrambler
def poweradminbf3::Poweradminbf3Plugin::cmd_autoscramble (   self,
  data,
  client,
  cmd = None 
)
\
<off|round|map> manage the auto scrambler
def poweradminbf3::Poweradminbf3Plugin::cmd_changeteam (   self,
  data,
  client,
  cmd = None 
)
\
<name> - change a player to the other team
def poweradminbf3::Poweradminbf3Plugin::cmd_changeteam (   self,
  data,
  client,
  cmd = None 
)
\
<name> - change a player to the other team
def poweradminbf3::Poweradminbf3Plugin::cmd_endround (   self,
  data,
  client,
  cmd = None 
)
\
<team id> - End current round. team id is the winning team
def poweradminbf3::Poweradminbf3Plugin::cmd_idle (   self,
  data,
  client = None,
  cmd = None 
)
\
<on|off|minutes> - Toggle idle on / off or the number of minutes you choose
def poweradminbf3::Poweradminbf3Plugin::cmd_kill (   self,
  data,
  client,
  cmd = None 
)
\
<player> [reason] - Kill a player without scoring effects
def poweradminbf3::Poweradminbf3Plugin::cmd_kill (   self,
  data,
  client,
  cmd = None 
)
\
<player> [reason] - Kill a player without scoring effects
def poweradminbf3::Poweradminbf3Plugin::cmd_listconfig (   self,
  data,
  client = None,
  cmd = None 
)
\
List available config files that can be loaded with the !loadconfig command
def poweradminbf3::Poweradminbf3Plugin::cmd_listconfig (   self,
  data,
  client = None,
  cmd = None 
)
\
List available config files that can be loaded with the !loadconfig command
def poweradminbf3::Poweradminbf3Plugin::cmd_loadconfig (   self,
  data,
  client = None,
  cmd = None 
)
\
<config name> - Load a server config file
def poweradminbf3::Poweradminbf3Plugin::cmd_loadconfig (   self,
  data,
  client = None,
  cmd = None 
)
\
<config name> - Load a server config file
def poweradminbf3::Poweradminbf3Plugin::cmd_punkbuster (   self,
  data,
  client,
  cmd = None 
)
\
<punkbuster command> - Execute a punkbuster command
def poweradminbf3::Poweradminbf3Plugin::cmd_punkbuster (   self,
  data,
  client,
  cmd = None 
)
\
<punkbuster command> - Execute a punkbuster command
def poweradminbf3::Poweradminbf3Plugin::cmd_roundnext (   self,
  data,
  client,
  cmd = None 
)

Commands implementations.

\
Switch to next round, without ending current
def poweradminbf3::Poweradminbf3Plugin::cmd_roundnext (   self,
  data,
  client,
  cmd = None 
)

Commands implementations.

\
Switch to next round, without ending current
def poweradminbf3::Poweradminbf3Plugin::cmd_roundrestart (   self,
  data,
  client,
  cmd = None 
)
\
Restart current round
def poweradminbf3::Poweradminbf3Plugin::cmd_roundrestart (   self,
  data,
  client,
  cmd = None 
)
\
Restart current round
def poweradminbf3::Poweradminbf3Plugin::cmd_scramble (   self,
  data,
  client,
  cmd = None 
)
\
Toggle on/off the teams scrambling for next round
def poweradminbf3::Poweradminbf3Plugin::cmd_scramble (   self,
  data,
  client,
  cmd = None 
)
\
Toggle on/off the teams scrambling for next round
def poweradminbf3::Poweradminbf3Plugin::cmd_scramblemode (   self,
  data,
  client,
  cmd = None 
)
\
<random|score> change the scrambling strategy
def poweradminbf3::Poweradminbf3Plugin::cmd_scramblemode (   self,
  data,
  client,
  cmd = None 
)
\
<random|score> change the scrambling strategy
def poweradminbf3::Poweradminbf3Plugin::cmd_serverreboot (   self,
  data,
  client,
  cmd = None 
)
\
Restart the Battlefield 3 Gameserver.
def poweradminbf3::Poweradminbf3Plugin::cmd_setnextmap (   self,
  data,
  client = None,
  cmd = None 
)
\
<mapname> - Set the nextmap (partial map name works)
def poweradminbf3::Poweradminbf3Plugin::cmd_setnextmap (   self,
  data,
  client = None,
  cmd = None 
)
\
<mapname> - Set the nextmap (partial map name works)
def poweradminbf3::Poweradminbf3Plugin::cmd_swap (   self,
  data,
  client,
  cmd = None 
)
\
<player A> [<player B>] - swap teams for player A and B if they are in different teams or squads
def poweradminbf3::Poweradminbf3Plugin::cmd_swap (   self,
  data,
  client,
  cmd = None 
)
\
<player A> [<player B>] - swap teams for player A and B if they are in different teams or squads
def poweradminbf3::Poweradminbf3Plugin::cmd_unlockmode (   self,
  data,
  client,
  cmd = None 
)
\
<all|common|stats|none> set the weapons unlocks mode
def poweradminbf3::Poweradminbf3Plugin::cmd_vehicles (   self,
  data,
  client = None,
  cmd = None 
)
\
<on|off> - Toggle vehicles on or off
def poweradminbf3::Poweradminbf3Plugin::config_manager_check_config (   self)
Check and run the configs
def poweradminbf3::Poweradminbf3Plugin::config_manager_construct_file_names (   self)
Construct file names based on next level name and next game mode for configmanager feature
def poweradminbf3::Poweradminbf3Plugin::count_teams (   self,
  clients 
)
Return the number of players in each team
def poweradminbf3::Poweradminbf3Plugin::current_winningTeamID (   self)
Return winning TeamID from current game
def poweradminbf3::Poweradminbf3Plugin::load_server_config (   self,
  client,
  config_name,
  items = None 
)
Clean up the lines in the config and send them to the server
def poweradminbf3::Poweradminbf3Plugin::load_server_config (   self,
  client,
  config_name,
  items = None 
)
Clean up the lines in the config and send them to the server
def poweradminbf3::Poweradminbf3Plugin::onEvent (   self,
  event 
)
\
Handle intercepted events

Reimplemented from b3::plugin::Plugin.

def poweradminbf3::Poweradminbf3Plugin::onEvent (   self,
  event 
)
\
Handle intercepted events

Reimplemented from b3::plugin::Plugin.

def poweradminbf3::Poweradminbf3Plugin::onLoadConfig (   self)

Plugin interface implementation.

\
This is called after loadConfig(). Any plugin private variables loaded
from the config need to be reset here.

Reimplemented from b3::plugin::Plugin.

def poweradminbf3::Poweradminbf3Plugin::onLoadConfig (   self)

Plugin interface implementation.

\
This is called after loadConfig(). Any plugin private variables loaded
from the config need to be reset here.

Reimplemented from b3::plugin::Plugin.

def poweradminbf3::Poweradminbf3Plugin::run_autobalance (   self)
Perform Auto balance to keep teams balanced
def poweradminbf3::Poweradminbf3Plugin::startup (   self)
\
Initialize plugin settings

Reimplemented from b3::plugin::Plugin.

def poweradminbf3::Poweradminbf3Plugin::startup (   self)
\
Initialize plugin settings

Reimplemented from b3::plugin::Plugin.


Member Data Documentation


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