File Source for BC2Conn.php

<?php
/*
* BC2Conn - PHP class for communicating with a Battlefield Bad Company 2 gameserver
* http://bc2conn.sf.net/
* Copyright (C) 2010 by JLNNN <JLN@hush.ai>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/**
* Project page:
* http://bc2conn.sf.net/
*
* Message board:
* http://bc2conn.sf.net/board/
*
* API:
* http://bc2conn.sf.net/API/
*
* @author JLNNN <JLN@hush.ai>
* @version 1.05
*
* $Id: BC2Conn.php 16 2010-08-01 09:17:15Z jlnnn $
*/
class BC2Conn {
private $_serverIP = null;
private $_serverRconQueryPort = null;
private $_clientSequenceNr = 0;
private $_sock = null;
private $_connection = false;
private $_playerdata = null; // used for caching
private $_playerdata_admin = null; // used for caching
private $_serverdata = null; // used for caching
private $_isLoggedIn = false;
private $_sockType = null;
/*-- configuration vars --*/
private $_globalMsg = array(
"PLAYER_NOT_FOUND" => "PlayerNotFoundError",
"TEAM_NOT_FOUND" => "TeamNameNotFoundError",
"SQUAD_NOT_FOUND" => "SquadNameNotFoundError",
"PLAYMODE_NOT_FOUND" => "PlaymodeNameNotFoundError",
"MAPNAME_NOT_FOUND" => "MapNameNotFoundError",
"ADMIN_YELL_DURATION_MAX" => 59999,
"NOT_LOGGED_IN" => "NotLoggedInAsAdmin",
"LOGIN_FAILED" => "LoginFailed",
);
private $_globalVars = array(
"mapsFileXML" => "mapNames.xml",
"playmodesFileXML" => "playModes.xml",
"squadnamesFileXML" => "squadNames.xml",
"teamnamesFileXML" => "teamNames.xml",
"defaultServerResponse" => "OK",
"cachingEnabled" => true, // change this to false if you want caching disabled
);
/*-- constructor and destructor --*/
/**
* @param String
* @param Integer
* @param String (optional) - for debugging, use "-d"
*/
function __construct($serverIP, $serverRconQueryPort, $debug = null) {
if($this->_serverIP == null) {
$this->_serverIP = $serverIP;
$this->_serverRconQueryPort = $serverRconQueryPort;
$this->_connection = $this->_openConnection($debug);
}
}
function __destruct() {
if($this->_connection) {
$this->_closeConnection();
$this->_connection = false;
}
}
/*-- required methods for communicating with the gameserver --*/
private function _encodeClientRequest($data) {
$packet = $this->_encodePacket(false, false, $this->_clientSequenceNr, $data);
$this->_clientSequenceNr = ($this->_clientSequenceNr + 1) & 0x3fffffff;
return $packet;
}
private function _encodeHeader($isFromServer, $isResponse, $sequence) {
$header = $sequence & 0x3fffffff;
if($isFromServer) {
$header += 0x80000000;
}
if($isResponse) {
$header += 0x40000000;
}
return pack('I', $header);
}
private function _decodeHeader($data) {
$header = unpack('I', $data);
return array(
$header & 0x80000000,
$header & 0x40000000,
$header & 0x3fffffff
);
}
private function _encodeInt32($size) {
return pack('I', $size);
}
private function _decodeInt32($data) {
$decode = unpack('I', $data);
return $decode[1];
}
private function _encodeWords($words) {
$size = 0;
$encodedWords = '';
foreach($words as $word) {
$strWord = $word;
$encodedWords .= $this->_encodeInt32(strlen($strWord));
$encodedWords .= $strWord;
$encodedWords .= "\x00";
$size += strlen($strWord) + 5;
}
return array(
$size,
$encodedWords
);
}
private function _decodeWords($size, $data) {
$numWords = $this->_decodeInt32($data);
$offset = 0;
while($offset < $size) {
$wordLen = $this->_decodeInt32(substr($data, $offset, 4));
$word = substr($data, $offset + 4, $wordLen);
$words[] = $word;
$offset += $wordLen + 5;
}
return $words;
}
private function _encodePacket($isFromServer, $isResponse, $sequence, $data) {
$data = explode(' ', $data);
if($data[0] == "admin.yell" && isset($data[1])) {
$adminYell = array($data[0], '', '', '');
$yellStyle = '';
$yellKey = 0;
foreach($data as $key => $content) {
if($key != 0) {
if($content == "{%player%}") {
$yellStyle = "player";
$yellKey = $key;
break;
} else if($content == "{%team%}") {
$yellStyle = "team";
$yellKey = $key;
break;
} else if($content == "{%all%}") {
$yellStyle = "all";
$yellKey = $key;
break;
}
}
}
if($yellStyle == "all") {
foreach($data as $key => $content) {
if($key != 0 && $key < $yellKey - 1) {
$adminYell[1] .= $content . ' ';
} else if($key == $yellKey) {
$adminYell[3] = $yellStyle;
} else if($key == $yellKey-1) {
$adminYell[2] = $data[$yellKey-1];
}
}
$adminYell[1] = trim($adminYell[1]);
} else if($yellStyle == "player" || $yellStyle == "team") {
$adminYell[4] = '';
foreach($data as $key => $content) {
if($key != 0 && $key < $yellKey - 1) {
$adminYell[1] .= $content . ' ';
} else if($key == $yellKey) {
$adminYell[3] = $yellStyle;
} else if($key == $yellKey-1) {
$adminYell[2] = $data[$yellKey-1];
} else if($key > $yellKey) {
$adminYell[4] .= $content . ' ';
}
}
$adminYell[4] = trim($adminYell[4]); // trim whitespaces
}
$data = $adminYell;
} else if($data[0] == "vars.serverDescription" && isset($data[1])) {
$serverDesc = array($data[0], '');
foreach($data as $key => $value) {
if($key != 0) {
$serverDesc[1] .= $value . ' ';
}
}
$serverDesc[1] = trim($serverDesc[1]);
$data = $serverDesc;
} else if($data[0] == "admin.kickPlayer" && isset($data[1])) {
$reason = false;
foreach($data as $key => $value) {
if($value == "{%reason%}") {
$reason = true;
}
}
if(!$reason) {
$kickPlayer = array($data[0], '');
foreach($data as $key => $value) {
if($key != 0) {
$kickPlayer[1] .= $value . ' ';
}
}
$kickPlayer[1] = trim($kickPlayer[1]);
} else {
$kickPlayer = array($data[0], '', '');
$i = 0;
foreach($data as $key => $value) {
if($key != 0) {
if($value == "{%reason%}") {
$i = $key;
}
if($i == 0) {
$kickPlayer[1] .= $value . ' ';
} else {
if($key != $i) {
$kickPlayer[2] .= $value . ' ';
}
}
}
}
$kickPlayer[1] = trim($kickPlayer[1]); // trim whitespaces
$kickPlayer[2] = trim($kickPlayer[2]); // trim whitespaces
}
$data = $kickPlayer;
} else if($data[0] == "banList.add" || $data[0] == "banList.remove" && isset($data[1])) {
$dataCount = count($data) - 1;
$banPlayer = array($data[0], $data[1], '');
foreach($data as $key => $value) {
if($key != 0 && $key != 1) {
if($data[0] == "banList.add" && $key != $dataCount) {
$banPlayer[2] .= $value . ' ';
} else if($data[0] == "banList.remove") {
$banPlayer[2] .= $value . ' ';
}
}
}
$banPlayer[2] = trim($banPlayer[2]); // trim whitespace
if($data[0] == "banList.add") {
$banPlayer[3] = $data[$dataCount];
}
$data = $banPlayer;
} else if($data[0] == "admin.listPlayers" || $data[0] == "listPlayers" && isset($data[1])) {
$listPlayer = array($data[0]);
if($data[1] != "all") {
if($data[1] == "player") {
$listPlayer[1] = $data[1];
$listPlayer[2] = '';
foreach($data as $key => $value) {
if($key != 0 && $key != 1) {
$listPlayer[2] .= $value . ' ';
}
}
$listPlayer[2] = trim($listPlayer[2]); // trim ending whitespace
}
} else {
$listPlayer[1] = $data[1];
}
$data = $listPlayer;
} else if($data[0] == "reservedSlots.addPlayer" || $data[0] == "reservedSlots.removePlayer" && isset($data[1])) {
$reservedSlots = array($data[0], '');
foreach($data as $key => $value) {
if($key != 0) {
$reservedSlots[1] .= $value . ' ';
}
}
$reservedSlots[1] = trim($reservedSlots[1]); // trim whitespace
$data = $reservedSlots;
} else if($data[0] == "admin.say" && isset($data[1])) {
$adminSay = array($data[0], '', '', '');
$i = 0;
foreach($data as $key => $value) {
if($key != 0) {
if($value == "{%player%}" || $value == "{%team%}" || $value == "{%all%}") {
$i = $key;
$adminSay[2] = preg_replace("/[{}%]/", '', $value);
}
if($i == 0) {
$adminSay[1] .= $value . ' ';
} else {
if($key != $i && $adminSay[2] != "all") {
$adminSay[3] .= $value . ' ';
}
}
}
}
$adminSay[1] = trim($adminSay[1]); // trim whitespace
$adminSay[3] = trim($adminSay[3]); // trim whitespace
if($adminSay[2] == "all") {
unset($adminSay[3]);
}
$data = $adminSay;
} else if($data[0] == "admin.killPlayer" && isset($data[1])) {
$adminKillPlayer = array($data[0], '');
$i = 0;
foreach($data as $key => $value) {
if($key != 0) {
$adminKillPlayer[1] .= $value . ' ';
}
}
$adminKillPlayer[1] = trim($adminKillPlayer[1]); // trim whitespace
$data = $adminKillPlayer;
} else if($data[0] == "admin.movePlayer" && isset($data[1])) {
$dataCount = count($data) - 3;
$adminMovePlayer = array($data[0], '', '', '', '');
$i = 0;
foreach($data as $key => $value) {
if($key != 0 && $key < $dataCount) {
$adminMovePlayer[1] .= $value . ' ';
}
}
$adminMovePlayer[1] = trim($adminMovePlayer[1]); // trim whitespace
$adminMovePlayer[2] = $data[$dataCount];
$adminMovePlayer[3] = $data[$dataCount + 1];
$adminMovePlayer[4] = $data[$dataCount + 2];
$data = $adminMovePlayer;
}
$encodedHeader = $this->_encodeHeader($isFromServer, $isResponse, $sequence);
$encodedNumWords = $this->_encodeInt32(count($data));
list($wordsSize, $encodedWords) = $this->_encodeWords($data);
$encodedSize = $this->_encodeInt32($wordsSize + 12);
return $encodedHeader . $encodedSize . $encodedNumWords . $encodedWords;
}
private function _decodePacket($data) {
list($isFromServer, $isResponse, $sequence) = $this->_decodeHeader($data);
$wordsSize = $this->_decodeInt32(substr($data, 4, 4)) - 12;
$words = $this->_decodeWords($wordsSize, substr($data, 12));
return array(
$isFromServer,
$isResponse,
$sequence,
$words
);
}
private function _containsCompletePacket($data) {
if(strlen($data) < 8) {
return false;
}
if(strlen($data) < $this->_decodeInt32(substr($data, 4, 4)))
{
return false;
}
return true;
}
private function _receivePacket($receiveBuffer) {
while(!$this->_containsCompletePacket($receiveBuffer)) {
if($this->_sockType == 1) {
$receiveBuffer .= socket_read($this->_sock, 4096);
} else {
$receiveBuffer .= fread($this->_sock, 4096);
}
}
$packetSize = $this->_decodeInt32(substr($receiveBuffer, 4, 4));
$packet = substr($receiveBuffer, 0, $packetSize);
$receiveBuffer = substr($receiveBuffer, $packetSize, strlen($receiveBuffer));
return array(
$packet,
$receiveBuffer
);
}
private function _hex_str($hex) {
$string = '';
for($i = 0; $i < strlen($hex) - 1; $i += 2) {
$string .= chr(hexdec($hex[$i] . $hex[$i + 1]));
}
return $string;
}
private function _bool2String($boolean) {
$onOrOff = '';
if($boolean) {
$onOrOff = "true";
} else {
$onOrOff = "false";
}
return $onOrOff;
}
private function _array2String($array, $key = 1) {
return $array[$key];
}
private function _array2boolean($array, $key = 1) {
if($array[$key] == "true") {
return true;
} else {
return false;
}
}
/*-- internal methods --*/
private function _openConnection($debug = null) {
$connection = false;
if(function_exists("socket_create") && function_exists("socket_connect") && function_exists("socket_strerror") && function_exists("socket_last_error") && function_exists("socket_set_block") && function_exists("socket_read") && function_exists("socket_write") && function_exists("socket_close")) {
$this->_sock = socket_create(AF_INET, SOCK_STREAM, SOL_TCP);
@$connection = socket_connect($this->_sock, $this->_serverIP, $this->_serverRconQueryPort);
if($debug == "-d") {
echo "[DEBUG]: " . socket_strerror(socket_last_error()) . ".\n";
}
if($connection) {
socket_set_block($this->_sock);
}
$this->_sockType = 1;
} else if(function_exists("fsockopen")) {
if($debug == "-d") {
@$this->_sock = fsockopen("tcp://" . $this->_serverIP, $this->_serverRconQueryPort, $errno, $errstr, 500000);
if(!$this->_sock) {
echo "[DEBUG]: " . $errno . " - " . $errstr . "\n";
}
} else {
@$this->_sock = fsockopen("tcp://" . $this->_serverIP, $this->_serverRconQueryPort);
}
$connection = $this->_sock;
$this->_sockType = 2;
}
return $connection;
}
private function _closeConnection() {
$this->_clientRequest("quit");
if($this->_sockType == 1) {
socket_close($this->_sock);
} else {
fclose($this->_sock);
}
$this->_sockType = null;
}
private function _clientRequest($clientRequest) {
$data = $this->_encodeClientRequest($clientRequest);
if($this->_sockType == 1) {
socket_write($this->_sock, $data, strlen($data));
} else {
fwrite($this->_sock, $data, strlen($data));
}
$receiveBuffer = '';
list($packet, $receiveBuffer) = $this->_receivePacket($receiveBuffer);
list($isFromServer, $isResponse, $sequence, $requestAnswer) = $this->_decodePacket($packet);
return $requestAnswer;
}
/**
* returns true if connected to a gameserver, otherwise false
*
* @see isServerOnline()
*
* @return boolean
*/
function isConnected() {
return $this->_connection;
}
/*-- login and logout --*/
/**
* plain text login to gameserver
* [ RCON password MUST NOT contain whitespaces!! ]
*
* @param String
*
* @return String
*/
function loginInsecure($rconPassword) {
$loginStatus = $this->_array2String($this->_clientRequest("login.plainText " . $rconPassword), 0);
if($loginStatus == $this->_globalVars['defaultServerResponse']) {
$this->_isLoggedIn = true;
return $loginStatus;
} else {
return $this->_globalMsg['LOGIN_FAILED'];
}
}
/**
* salted hash login to gameserver
* [ RCON password MUST NOT contain whitespaces!! ]
*
* @param String
*
* @return String
*/
function loginSecure($rconPassword) {
$salt = $this->_array2String($this->_clientRequest("login.hashed"));
$hashedPW = $this->_hex_str($salt) . $rconPassword;
$saltedHashedPW = strtoupper(md5($hashedPW));
$loginStatus = $this->_array2String($this->_clientRequest("login.hashed " . $saltedHashedPW), 0);
if($loginStatus == $this->_globalVars['defaultServerResponse']) {
$this->_isLoggedIn = true;
return $loginStatus;
} else {
return $this->_globalMsg['LOGIN_FAILED'];
}
}
/**
* logging out
*
* @return String
*/
function logout() {
$this->_isLoggedIn = false;
return $this->_array2String($this->_clientRequest("logout"), 0);
}
/**
* if logged in with rcon && successful, return true, otherwise false
*
* @return boolean
*/
public function isLoggedIn() {
return $this->_isLoggedIn;
}
/*-- replacements --*/
/**
* returns the name of the given map
* example: getMapName("Levels/MP_002")
*
* @param String
*
* @return String name of the given map
*/
function getMapName($mapURI) {
$mapNamesXML = simplexml_load_file($this->_globalVars['mapsFileXML']);
$mapName = $this->_globalMsg['MAPNAME_NOT_FOUND'];
for($i = 0; $i <= (count($mapNamesXML->map) - 1); $i++) {
if($mapURI == $mapNamesXML->map[$i]->attributes()->uri) {
$mapName = $mapNamesXML->map[$i]->attributes()->name;
}
}
return $mapName;
}
/**
* returns the name of the given playmode
* example: getPlaymodeName("RUSH")
*
* @param String
*
* @return String name of the given playmode
*/
function getPlaymodeName($playmodeURI) {
$playModesXML = simplexml_load_file($this->_globalVars['playmodesFileXML']);
$playmodeName = $this->_globalMsg['PLAYMODE_NOT_FOUND'];
for($i = 0; $i <= (count($playModesXML->playmode) - 1); $i++) {
if($playmodeURI == $playModesXML->playmode[$i]->attributes()->uri) {
$playmodeName = $playModesXML->playmode[$i]->attributes()->name;
}
}
return $playmodeName;
}
/**
* returns the name of the given squad
* example: getSquadName(1) - will return "Bravo Squad"
*
* @param Integer
*
* @return String
*/
function getSquadName($squadID) {
$squadNamesXML = simplexml_load_file($this->_globalVars['squadnamesFileXML']);
$squadName = $this->_globalMsg['SQUAD_NOT_FOUND'];
for($i = 0; $i <= (count($squadNamesXML->squad) - 1); $i++) {
if($squadID == $squadNamesXML->squad[$i]->attributes()->id) {
$squadName = $squadNamesXML->squad[$i]->attributes()->name;
}
}
return $squadName;
}
/**
* gets the teamname of a given map, playmode and teamid (DIFFERENT IN SQDM!)
*
* @param String
* @param String
* @param Integer
* @param Integer (optional) - if playmode = SQDM, a squadid is required!
*
* @return String
*/
function getTeamName($mapURI, $playmodeURI, $teamID, $squadID = null) {
$teamNameXML = simplexml_load_file($this->_globalVars['teamnamesFileXML']);
$teamName = $this->_globalMsg['TEAM_NOT_FOUND'];
if($mapURI == "Levels/MP_012GR") { // xml case 'Levels/MP_012GR'
if(count($teamNameXML->teamName[1]->playMode[0]) - 1 >= $teamID) {
$teamName = $teamNameXML->teamName[1]->playMode[0]->team[$teamID]->name;
}
} else
if($mapURI == "Levels/MP_008") { // xml case 'Levels/MP_008'
if(count($teamNameXML->teamName[2]->playMode[0]) - 1 >= $teamID) {
$teamName = $teamNameXML->teamName[2]->playMode[0]->team[$teamID]->name;
}
} else
if($mapURI != "Levels/MP_012GR" && $playmodeURI == "SQDM") { // xml case 'SQDM'
if($squadID != null) {
if($squadID == 24) {
$squadID = 0;
}
if(count($teamNameXML->teamName[3]->playMode[0]) - 1 >= $squadID) {
$teamName = $teamNameXML->teamName[3]->playMode[0]->squad[$squadID]->name;
}
}
} else { // xml case 'default'
$playModes = count($teamNameXML->teamName[0]) - 1;
if($playModes >= $teamID) {
for($i = 0; $i <= $playModes; $i++) {
if($teamNameXML->teamName[0]->playMode[$i]->attributes()->uri == $playmodeURI) {
$teamName = $teamNameXML->teamName[0]->playMode[$i]->team[$teamID]->name;
}
}
}
}
return $teamName;
}
/*-- server information --*/
/**
* returns the server ip as a string
*
* @return String
*/
function getServerIP() {
return $this->_serverIP;
}
/**
* returns the server information as an array
*
* @return array
*/
function getServerInfo() {
if($this->_serverdata == null || !$this->_globalVars['cachingEnabled']) {
$this->_serverdata = $this->_clientRequest("serverInfo");
}
return $this->_serverdata;
}
/**
* returns the server name as a string
*
* @return String
*/
function getServerName() {
$serverInfo = $this->getServerInfo();
return $this->_array2String($serverInfo);
}
/**
* returns the current players on server as an integer
*
* @return Integer
*/
function getCurrentPlayers() {
$serverInfo = $this->getServerInfo();
return (int) $this->_array2String($serverInfo, 2);
}
/**
* returns the max amount of players allowed on server as an integer
*
* @return Integer
*/
function getMaxPlayers() {
$serverInfo = $this->getServerInfo();
return (int) $this->_array2String($serverInfo, 3);
}
/**
* returns the current playmode as a string
*
* @return String
*/
function getCurrentPlaymode() {
$serverInfo = $this->getServerInfo();
return $this->_array2String($serverInfo, 4);
}
/**
* returns the current playmode (human readable) as a string
*
* @return String
*/
function getCurrentPlaymodeName() {
$serverInfo = $this->getServerInfo();
return $this->getPlaymodeName($this->getCurrentPlaymode());
}
/**
* returns the current map as a string
*
* @return String
*/
function getCurrentMap() {
$serverInfo = $this->getServerInfo();
return $this->_array2String($serverInfo, 5);
}
/**
* returns the current map (human readable) as a string
*
* @return String
*/
function getCurrentMapName() {
$serverInfo = $this->getServerInfo();
return $this->getMapName($this->getCurrentMap());
}
/**
* returns the server version as an array
*
* @return array
*/
function getVersion() {
return $this->_clientRequest("version");
}
/**
* returns the build-id of the game
*
* @return Integer
*/
function getVersionID() {
return (int) $this->_array2String($this->getVersion(), 2);
}
/**
* returns the game type currently running
*
* @return String
*/
function getGameType() {
return $this->_array2String($this->getVersion());
}
/**
* returns the current round of the game
*
* @return Integer
*/
function getCurrentGameRound() {
return (int) $this->_array2String($this->getServerInfo(), 6);
}
/**
* returns the max amount of rounds of the current game
*
* @return Integer
*/
function getGameMaxRounds() {
return (int) $this->_array2String($this->getServerInfo(), 7);
}
/**
* returns the current teamscores
*
* @return Integer
*/
function getTeamScores() {
return (int) $this->_array2String($this->getServerInfo(), 8);
}
/**
* returns the current online state of the gameserver
*
* @return String
*/
function getOnlineState() {
return $this->_array2String($this->getServerInfo(), 9);
}
/**
* returns list of all players on the server, but with zeroed out GUIDs
*
* @return array
*/
function getPlayerlist() {
if($this->_playerdata == null || !$this->_globalVars['cachingEnabled']) {
$this->_playerdata = $this->_clientRequest("listPlayers all");
}
return $this->_playerdata;
}
/**
* returns list of all playernames on server (useful for other functions)
*
* @return array
*/
function getPlayerlistNames() {
$players = $this->getPlayerlist();
$playersAmount = $this->getCurrentPlayers();
if($playersAmount == 0) {
$playersNames = array();
}
$playersParameters = (int) $players[1];
for($i = 0; $i < $playersAmount; $i++) {
$playersNames[] = $players[($playersParameters) * $i + $playersParameters +4];
}
return $playersNames;
}
/**
* TODO: check for caching if playername = all
*
* returns gamedata of given playername with zeroed out GUID
*
* @param String (if not set, all players will be listed)
*
* @return array
*/
function getPlayerdata($playerName = '') {
if(!isset($playerName) || $playerName == '') {
$playerName = "all";
} else {
$playerName = "player " . $playerName;
}
return $this->_clientRequest("listPlayers " . $playerName);
}
/**
* returns true if server is available, otherwise false
*
* @see isConnected()
*
* @return boolean
*/
function isServerOnline() {
return $this->isConnected();
}
/*-- admin server information --*/
/**
* returns the gamepassword as a string
*
* @return String
*/
function adminGamePasswordGet() {
return $this->_array2String($this->_clientRequest("vars.gamePassword"));
}
/**
* gets the full gamedata of all players on the gameserver
*
* @return array
*/
function adminGetPlayerlist() {
if($this->_playerdata_admin == null || !$this->_globalVars['cachingEnabled']) {
$this->_playerdata_admin = $this->_clientRequest("admin.listPlayers all");
}
return $this->_playerdata_admin;
}
/**
* gets the gamedata of a given playername on the gameserver
*
* TODO: check for playerNotFound
*
* @param String (optional) - if not set, all players will be listed
*
* @return array
*/
function adminGetPlayerdata($playerName = '') {
if(!isset($playerName) || $playerName == '') {
$playerName = "all";
} else {
$playerName = "player " . $playerName;
}
return $this->_clientRequest("admin.listPlayers " . $playerName);
}
/**
* returns all commands available on the server - requires login
*
* @return array
*/
function adminGetAllCommands() {
return $this->_clientRequest("help");
}
/**
* returns true/false, if server events are enabled in this connection or
* not
*
* @return array
*/
function adminEventsEnabledStatusGet() {
return $this->_clientRequest("eventsEnabled");
}
/**
* sets the server events on/off in this connection
* [ Useless, if you set them on and use this class only ;) ]
*
* @param boolean
*
* @return array
*/
// function adminEventsEnabledStatusSet($boolean) {
// return $this->_clientRequest("eventsEnabled " .
// $this->_bool2String($boolean));
// }
/**
* returns the clantag of a given playername
*
* @param String
*
* @return String
*/
function getPlayerClantag($playerName) {
$playerInfo = $this->getPlayerdata($playerName);
if(!isset($playerInfo[12])) {
return $this->_globalMsg['PLAYER_NOT_FOUND'];
}
return $this->_array2String($playerInfo, 12);
}
/**
* returns the playername of a given playername
*
* @param String
*
* @return String
*/
function getPlayername($playerName) {
$playerInfo = $this->getPlayerdata($playerName);
if(!isset($playerInfo[12])) {
return $this->_globalMsg['PLAYER_NOT_FOUND'];
}
return $this->_array2String($playerInfo, 13);
}
/**
* returns the teamid of a given playername
*
* @param String
*
* @return Integer
*/
function getPlayerTeamID($playerName) {
$playerInfo = $this->getPlayerdata($playerName);
if(!isset($playerInfo[12])) {
return $this->_globalMsg['PLAYER_NOT_FOUND'];
}
return (int) $this->_array2String($playerInfo, 15);
}
/**
* returns the squadid of a given playername
*
* @param String
*
* @return Integer
*/
function getPlayerSquadID($playerName) {
$playerInfo = $this->getPlayerdata($playerName);
if(!isset($playerInfo[12])) {
return $this->_globalMsg['PLAYER_NOT_FOUND'];
}
return (int) $this->_array2String($playerInfo, 16);
}
/**
* returns the current kills of a given playername
*
* @param String
*
* @return Integer
*/
function getPlayerKills($playerName) {
$playerInfo = $this->getPlayerdata($playerName);
if(!isset($playerInfo[12])) {
return $this->_globalMsg['PLAYER_NOT_FOUND'];
}
return (int) $this->_array2String($playerInfo, 17);
}
/**
* returns the current deaths of a given playername
*
* @param String
*
* @return Integer
*/
function getPlayerDeaths($playerName) {
$playerInfo = $this->getPlayerdata($playerName);
if(!isset($playerInfo[12])) {
return $this->_globalMsg['PLAYER_NOT_FOUND'];
}
return (int) $this->_array2String($playerInfo, 18);
}
/**
* returns the score of a given playername
*
* @param String
*
* @return Integer
*/
function getPlayerScore($playerName) {
$playerInfo = $this->getPlayerdata($playerName);
if(!isset($playerInfo[12])) {
return $this->_globalMsg['PLAYER_NOT_FOUND'];
}
return (int) $this->_array2String($playerInfo, 19);
}
/**
* returns the ping of a given playername
*
* @param String
*
* @return Integer
*/
function getPlayerPing($playerName) {
$playerInfo = $this->getPlayerdata($playerName);
if(!isset($playerInfo[12])) {
return $this->_globalMsg['PLAYER_NOT_FOUND'];
}
return (int) $this->_array2String($playerInfo, 20);
}
/*-- admin commands --*/
/**
* sends an admin-yell message to a specified player (or all)
* example: adminYellMessage("Storm the front!", "JLNNN") - send the message to player "JLNNN"
*
* TODO: Need fix for sending messages to squads
* TODO: Cut strings with length more than 100 chars
*
* @param String
* @param String (optional) - if not set, message will be sent to all
* players
* @param Integer (optional) - amount of time the message will be displayed,
* must be 1-59999
*
* @return String
*/
function adminYellMessage($text, $playerName = "{%all%}", $durationInMS = 15000) {
if($durationInMS > $this->_globalMsg['ADMIN_YELL_DURATION_MAX']) {
$durationInMS == $this->_globalMsg['ADMIN_YELL_DURATION_MAX'];
}
if($playerName != "{%all%}") {
$playerName = "{%player%}" . " " . $playerName;
}
return $this->_array2String($this->_clientRequest("admin.yell " . $text . " " .
$durationInMS . " " . $playerName), 0);
}
/**
* sends an admin-yell message to a specified team
* example: adminYellMessageToTeam("Storm the front!", 1) - send the message to teamID 1
*
* TODO: Cut strings with length more than 100 chars
*
* @param String
* @param Integer
* @param Integer (optional) - amount of time the message will be displayed,
* must be 1-59999
*
* @return String
*/
function adminYellMessageToTeam($text, $teamID, $durationInMS = 15000) {
if($durationInMS > $this->_globalMsg['ADMIN_YELL_DURATION_MAX']) {
$durationInMS == $this->_globalMsg['ADMIN_YELL_DURATION_MAX'];
}
return $this->_array2String($this->_clientRequest("admin.yell " . $text . " " .
$durationInMS . " {%team%} " . $teamID), 0);
}
/**
* sends a chat message to a player. the message must be less than 100 characters long.
*
* @param String
* @param String
*
* @return String
*/
function adminSayMessageToPlayer($playerName, $text) {
return $this->_array2String($this->_clientRequest("admin.say " . $text . " {%player%} " . $playerName), 0);
}
/**
* sends a chat mesage to a team. the message must be less than 100 characters long.
*
* @param String
* @param Integer
*
* @return String
*/
function adminSayMessageToTeam($teamID, $text) {
return $this->_array2String($this->_clientRequest("admin.say " . $text . " {%team%} " . $teamID), 0);
}
/**
* sends a chat mesage to all. the message must be less than 100 characters long.
*
* @param String
*
* @return String
*/
function adminSayMessageToAll($text) {
return $this->_array2String($this->_clientRequest("admin.say " . $text . " {%all%}"), 0);
}
/**
* runs the next level on maplist
*
* @return String
*/
function adminRunNextLevel() {
return $this->_array2String($this->_clientRequest("admin.runNextLevel"), 0);
}
/**
* TODO: planned feature adminSetNextLevel() ?
*
* sets the next level to play
*
* @param String
*
* @return String
*/
//function adminSetNextLevel($mapURI) {
//
//}
/**
* restarts the current level
*
* @return String
*/
function adminRestartMap() {
return $this->_array2String($this->_clientRequest("admin.restartMap"), 0);
}
/**
* sets a new playlist
* example: adminSetPlaylist("SQDM") - for setting playmode to 'Squad Deathmatch'
*
* @param String
*
* @return String
*/
function adminSetPlaylist($playmodeURI) {
return $this->_array2String($this->_clientRequest("admin.setPlaylist " . $playmodeURI), 0);
}
/**
* returns all available playmodes on server
*
* @return array
*/
function adminGetPlaylists() {
return $this->_clientRequest("admin.getPlaylists");
}
/**
* returns current playmode on server
*
* @see getCurrentPlaymode()
*
* @return String
*/
function adminGetPlaylist() {
return $this->_array2String($this->_clientRequest("admin.getPlaylist"));
}
/**
* loads the maplist
*
* @see adminMaplistList()
*
* @return array
*/
function adminMaplistLoad() {
return $this->_clientRequest("mapList.load");
}
/**
* saves the current maplist to file
*
* @return String
*/
function adminMaplistSave() {
return $this->_array2String($this->_clientRequest("mapList.save"), 0);
}
/**
* returns the maplist from map file
*
* @return array
*/
function adminMaplistList() {
$this->adminMaplistLoad();
return $this->_clientRequest("mapList.list");
}
/**
* clears the maplist file
*
* @return String
*/
function adminMaplistClear() {
return $this->_array2String($this->_clientRequest("mapList.clear"), 0);
}
/**
* removes a given map from maplist
* [ index = Integer! ]
*
* @param Integer
*
* @return String
*/
function adminMaplistRemove($rowID) {
return $this->_array2String($this->_clientRequest("mapList.remove " . $rowID), 0);
}
/**
* appends a given map to the end of the maplist file
*
* @param String
*
* @return String
*/
function adminMaplistAppend($mapURI) {
return $this->_array2String($this->_clientRequest("mapList.append " . $mapURI), 0);
}
/**
* gets index of next map to be run
*
* @return Integer
*/
function adminMaplistGetNextMapIndex() {
return (int) $this->_array2String($this->_clientRequest("mapList.nextLevelIndex"));
}
/**
* sets index of next map to be run
* [ index = Integer! ]
*
* @param Integer
*
* @return String
*/
function adminMaplistSetNextMapIndex($index) {
return $this->_array2String($this->_clientRequest("mapList.nextLevelIndex " . $index), 0);
}
/**
* adds map with name at the specified index to the maplist
*
* @param Integer
* @param String
*
* @return String
*/
function adminMaplistInsertMapInIndex($index, $mapURI) {
return $this->_array2String($this->_clientRequest("mapList.insert " . $index . " " . $mapURI), 0);
}
/**
* gets list of maps supported by given playmode
*
* @param String
*
* @return array
*/
function adminGetSupportedMaps($playmode) {
return $this->_clientRequest("admin.supportedMaps " . $playmode);
}
/**
* kicks a specified player by playername
*
* @param String
*
* @return String
*/
function adminKickPlayer($playerName) {
return $this->_array2String($this->_clientRequest("admin.kickPlayer " . $playerName), 0);
}
/**
* kicks a specified player by playername with a given kickreason
*
* @param String
* @param String (optional) - if not set, default kickreason is given
*
* @return String
*/
function adminKickPlayerWithReason($playerName, $reason = "Kicked by administrator") {
return $this->_array2String($this->_clientRequest("admin.kickPlayer " . $playerName . " {%reason%} " . $reason), 0);
}
/**
* bans a specified player by playername for a given range of time.
* range of time can be: perm = permanent, round = current round
* if no range is given, the player will be banned permanently
*
* TODO: ban for xx seconds
* TODO: banreason
*
* @param String
* @param String (optional) - if not set, given player will be banned permanently
*
* @return String
*/
function adminBanAddPlayername($playerName, $timerange = "perm") {
return $this->_array2String($this->_clientRequest("banList.add name " . $playerName . " " . $timerange));
}
/**
* bans a specified player by given playerip
* range of time can be: perm = permanent, round = current round
* if no range is given, the ip will be banned permanently
*
* TODO: ban for xx seconds
* TODO: banreason
*
* @param String
* @param String (optional) - if not set, ip will be banned permanently
*
* @return String
*/
function adminBanAddPlayerIP($playerIP, $timerange = "perm") {
return $this->_array2String($this->_clientRequest("banList.add ip " . $playerIP . " " . $timerange), 0);
}
/**
* bans a specified player by given playerguid
* range of time can be: perm = permanent, round = current round
* if no range is given, the ip will be banned permanently
*
* TODO: ban for xx seconds
* TODO: banreason
*
* @param String
* @param String (optional) - if not set, guid will be banned permanently
*
* @return String
*/
function adminBanAddPlayerGUID($playerName, $timerange = "perm") {
$playerGUID = $this->adminGetPlayerGUID($playerName);
if($playerGUID != $this->_globalMsg['PLAYER_NOT_FOUND']) {
return $this->_array2String($this->_clientRequest("banList.add guid " . $playerGUID . " " . $timerange), 0);
} else {
return $this->_globalMsg['PLAYER_NOT_FOUND'];
}
}
/**
* saves the current banlist to banlist file
*
* @return String
*/
function adminBanlistSave() {
return $this->_array2String($this->_clientRequest("banList.save"), 0);
}
/**
* loads the banlist from banlist file
*
* @return String
*/
function adminBanlistLoad() {
return $this->_array2String($this->_clientRequest("banList.load"), 0);
}
/**
* unbans a player by playername
*
* @param String
*
* @return String
*/
function adminBanRemovePlayername($playerName) {
return $this->_array2String($this->_clientRequest("banList.remove name " . $playerName), 0);
}
/**
* unbans a player by playerip
*
* @param String
*
* @return String
*/
function adminBanRemovePlayerIP($playerIP) {
return $this->_array2String($this->_clientRequest("banList.remove ip " . $playerIP), 0);
}
/**
* clears all bans from playername banlist
*
* @return String
*/
function adminBanlistClear() {
return $this->_array2String($this->_clientRequest("banList.clear"), 0);
}
/**
* lists all bans from banlist
*
* @return array
*/
function adminBanlistList() {
return $this->_clientRequest("banList.list");
}
/**
* loads the file containing all reserved slots
* [ I don't know if this function is useful.. ]
*
* @return String
*/
function adminReservedSlotsLoad() {
return $this->_array2String($this->_clientRequest("reservedSlots.load"), 0);
}
/**
* saves made changes to reserved slots file
*
* @return String
*/
function adminReservedSlotsSave() {
return $this->_array2String($this->_clientRequest("reservedSlots.save"), 0);
}
/**
* adds a player by given playername to reserved slots file
*
* @param String
*
* @return String
*/
function adminReservedSlotsAddPlayer($playerName) {
return $this->_array2String($this->_clientRequest("reservedSlots.addPlayer " . $playerName), 0);
}
/**
* removes a player by given playername from reserved slots file
*
* @param String
*
* @return String
*/
function adminReservedSlotsRemovePlayer($playerName) {
return $this->_array2String($this->_clientRequest("reservedSlots.removePlayer " . $playerName), 0);
}
/**
* clears the file containing all reserved slots
*
* @return String
*/
function adminReservedSlotsClear() {
return $this->_array2String($this->_clientRequest("reservedSlots.clear"), 0);
}
/**
* lists all playernames in reserved slots file
*
* @return array
*/
function adminReservedSlotsList() {
return $this->_clientRequest("reservedSlots.list");
}
/**
* returns the GUID of a given playername
*
* @param String
*
* @return String
*/
function adminGetPlayerGUID($playerName) {
$playerInfo = $this->adminGetPlayerdata($playerName);
if(!isset($playerInfo[12])) {
return $this->_globalMsg['PLAYER_NOT_FOUND'];
}
return $this->_array2String($playerInfo, 14);
}
/**
* kills the given player without counting this death on the playerstats
*
* @param $playerName
*
* @return String
*/
function adminKillPlayer($playerName) {
return $this->_array2String($this->_clientRequest("admin.killPlayer " .
$playerName), 0);
}
/**
* moves the given player to the opponent team
* if $forceKill is true, the player will be killed
* [ Works only if the player is dead! Otherwise $forceKill has to be true! ]
*
* @param $playerName
* @param $forceKill (optional) - if not set, player will not be killed
*
* @return String
*/
function adminMovePlayerSwitchTeam($playerName, $forceKill = false) {
$playerTeam = $this->getPlayerTeamID($playerName);
$forceKill = $this->_bool2String($forceKill);
if($playerTeam == 1) {
$newPlayerTeam = 2;
} else {
$newPlayerTeam = 1;
}
return $this->_array2String($this->_clientRequest("admin.movePlayer " .
$playerName . " " . $newPlayerTeam . " 0 " . $forceKill), 0);
}
/**
* moves the given player to another specific squad
* if $forceKill is true, the player will be killed
* [ Works only if the player is dead! Otherwise $forceKill has to be true! ]
*
* @param $playerName
* @param $newSquadID
* @param $forceKill (optional) - if not set, player will not be killed
* @param $newTeamID (optional) - if not set, player will stay in his team
*
* @return String
*/
function adminMovePlayerSwitchSquad($playerName, $newSquadID, $forceKill = false, $newTeamID = null) {
if ($newTeamID == null || !is_int($newTeamID)) {
$newTeamID = $this->getPlayerTeamID($playerName);
}
$forceKill = $this->_bool2String($forceKill);
return $this->_array2String($this->_clientRequest("admin.movePlayer " .
$playerName . " " . $newTeamID . " " . $newSquadID . " " . $forceKill), 0);
}
/**
* ends the current round, declaring the given teamId as winner
*
* @param $teamId
*
* @return String
*/
function adminEndRound($teamId) {
return $this->_array2String($this->_clientRequest("admin.endRound " . $teamId), 0);
}
/*-- admin server settings --*/
/**
* sets a new password on the gameserver.
* password MUST NOT contain whitespaces!!
* to clear the password, use adminGamePasswordSet("")
*
* @param String
*
* @return String
*/
function adminGamePasswordSet($serverPassword) {
return $this->_array2String($this->_clientRequest("vars.gamePassword " . $serverPassword), 0);
}
/**
* sets punkbuster on/off
*
* @param boolean
*
* @return String
*/
function adminVarSetPunkbuster($boolean) {
return $this->_array2String($this->_clientRequest("vars.punkBuster " .
$this->_bool2String($boolean)), 0);
}
/**
* gets true/false, if punkbuster is enabled or not
*
* @return boolean
*/
function adminVarGetPunkbuster() {
return $this->_array2boolean($this->_clientRequest("vars.punkBuster"));
}
/**
* sets the admin (rcon) password
* [ I haven't tested this ]
*
* @param String
*
* @return String
*/
function adminVarSetAdminPassword($string) {
return $this->_array2String($this->_clientRequest("vars.adminPassword " . $string), 0);
}
/**
* gets the admin (rcon) password
* [ I only get the result: PasswordRetrievalNotAllowed ]
*
* @return String
*/
function adminVarGetAdminPassword() {
return $this->_array2String($this->_clientRequest("vars.adminPassword"), 0);
}
/**
* sets hardcore mode on/off
*
* @param boolean
*
* @return String
*/
function adminVarSetHardcore($boolean) {
return $this->_array2String($this->_clientRequest("vars.hardCore " .
$this->_bool2String($boolean)), 0);
}
/**
* gets true/false, if hardcore mode is enabled or not
*
* @return boolean
*/
function adminVarGetHardcore() {
return $this->_array2boolean($this->_clientRequest("vars.hardCore"));
}
/**
* sets ranked server on/off
*
* @param boolean
*
* @return String
*/
function adminVarSetRanked($boolean) {
return $this->_array2String($this->_clientRequest("vars.ranked " .
$this->_bool2String($boolean)), 0);
}
/**
* gets true/false if ranked server settings are enabled or not
*
* @return boolean
*/
function adminVarGetRanked() {
return $this->_array2boolean($this->_clientRequest("vars.ranked"));
}
/**
* sets the max rank limit players are allowed to join
* ##QA: Says 'OK' but still allow higher ranked players to join.
*
* @param Integer
*
* @return String
*/
function adminVarSetRankLimit($integer) {
return $this->_array2String($this->_clientRequest("vars.rankLimit " . $integer), 0);
}
/**
* gets rank limit set on server
*
* @return String
*/
function adminVarGetRankLimit() {
return $this->_array2String($this->_clientRequest("vars.rankLimit"));
}
/**
* sets teambalance on/off
*
* @param boolean
*
* @return String
*/
function adminVarSetTeambalance($boolean) {
return $this->_array2String($this->_clientRequest("vars.teamBalance " .
$this->_bool2String($boolean)), 0);
}
/**
* gets true/false, if teambalance is enabled or not
*
* @return boolean
*/
function adminVarGetTeambalance() {
return $this->_array2boolean($this->_clientRequest("vars.teamBalance"));
}
/**
* sets friendly fire on/off
*
* @param boolean
*
* @return String
*/
function adminVarSetFriendlyFire($boolean) {
return $this->_array2String($this->_clientRequest("vars.friendlyFire " .
$this->_bool2String($boolean)), 0);
}
/**
* gets true/false, if friendly fire is enabled or not
*
* @return boolean
*/
function adminVarGetFriendlyFire() {
return $this->_array2boolean($this->_clientRequest("vars.friendlyFire"));
}
/**
* sets the banner url to given address
* [ The banner url needs to be less than 64 characters long.
* The banner needs to be a 512x64 picture and smaller than 127kbytes. ]
*
* @param String
*
* @return String
*/
function adminVarSetBannerURL($string) {
return $this->_array2String($this->_clientRequest("vars.bannerUrl " . $string), 0);
}
/**
* gets the banner url
*
* @return String
*/
function adminVarGetBannerURL() {
return $this->_array2String($this->_clientRequest("vars.bannerUrl"));
}
/**
* sets the server description to given text
* [ Character '|' doesn't work for now as a 'newline'. ]
* ##Request from RSPs: In addition being able to enter a new line would be
* great, BF2142 used the "|" character as newline.
*
* @param String
*
* @return String
*/
function adminVarSetServerDescription($string) {
return $this->_array2String($this->_clientRequest("vars.serverDescription " . $string), 0);
}
/**
* gets the server description
*
* @return String
*/
function adminVarGetServerDescription() {
return $this->_array2String($this->_clientRequest("vars.serverDescription"));
}
/**
* sets killcam on/off
*
* @param boolean
*
* @return String
*/
function adminVarSetKillCam($boolean) {
return $this->_array2String($this->_clientRequest("vars.killCam " .
$this->_bool2String($boolean)), 0);
}
/**
* gets true/false, if killcam is enabled or not
*
* @return boolean
*/
function adminVarGetKillCam() {
return $this->_array2boolean($this->_clientRequest("vars.killCam"));
}
/**
* sets minimap on/off
*
* @param boolean
*
* @return String
*/
function adminVarSetMiniMap($boolean) {
return $this->_array2String($this->_clientRequest("vars.miniMap " .
$this->_bool2String($boolean)), 0);
}
/**
* gets true/false, if minimap is enabled or not
*
* @return boolean
*/
function adminVarGetMiniMap() {
return $this->_array2boolean($this->_clientRequest("vars.miniMap"));
}
/**
* sets crosshair on/off
*
* @param boolean
*
* @return String
*/
function adminVarSetCrosshair($boolean) {
return $this->_array2String($this->_clientRequest("vars.crossHair " .
$this->_bool2String($boolean)), 0);
}
/**
* gets true/false, if crosshair is enabled or not
*
* @return boolean
*/
function adminVarGetCrosshair() {
return $this->_array2boolean($this->_clientRequest("vars.crossHair"));
}
/**
* sets 3d spotting on maps on/off
*
* @param boolean
*
* @return String
*/
function adminVarSet3dSpotting($boolean) {
return $this->_array2String($this->_clientRequest("vars.3dSpotting " .
$this->_bool2String($boolean)), 0);
}
/**
* gets true/false, if 3d spotting is enabled or not
*
* @return boolean
*/
function adminVarGet3dSpotting() {
return $this->_array2boolean($this->_clientRequest("vars.3dSpotting"));
}
/**
* sets minimap spotting on/off
*
* @param boolean
*
* @return String
*/
function adminVarSetMiniMapSpotting($boolean) {
return $this->_array2String($this->_clientRequest("vars.miniMapSpotting " .
$this->_bool2String($boolean)), 0);
}
/**
* gets true/false, if minimap spotting is enabled or not
*
* @return boolean
*/
function adminVarGetMiniMapSpotting() {
return $this->_array2boolean($this->_clientRequest("vars.miniMapSpotting"));
}
/**
* sets the 3rd person vehicle cam on/off
* ##QA: Works but is bugged. If you change the setting and someone is in
* a vehicle in 3rd person view when at end of round, that player will be
* stuck in 3rd person view even though the setting should only allow 1st
* person view.
*
* @param boolean
*
* @return String
*/
function adminVarSet3rdPersonVehiCam($boolean) {
return $this->_array2String($this->_clientRequest("vars.thirdPersonVehicleCameras " .
$this->_bool2String($boolean)), 0);
}
/**
* gets true/false, if 3rd person vehicle cam is enabled or not
*
* @return boolean
*/
function adminVarGet3rdPersonVehiCam() {
return $this->_array2boolean($this->_clientRequest("vars.thirdPersonVehicleCameras"));
}
/**
* sets a new servername
*
* @param $serverName
*
* @return String
*/
function adminVarSetServername($serverName) {
return $this->_array2String($this->_clientRequest("vars.serverName " . $serverName), 0);
}
/**
* sets the number of teamkills allowed during one round, before the game kicks
* the player in question
*
* @param $integer
*
* @return String
*/
function adminVarSetTeamKillCountForKick($integer) {
return $this->_array2String($this->_clientRequest("vars.teamKillCountForKick " . $integer), 0);
}
/**
* gets the number of teamkills allowed during one round
*
* @return Integer
*/
function adminVarGetTeamKillCountForKick() {
return (int) $this->_array2String($this->_clientRequest("vars.teamKillCountForKick"));
}
/**
* sets the highest kill-value allowed before a player is kicked for teamkilling
* set to 0 to disable kill value mechanism
*
* @param $integer
*
* @return String
*/
function adminVarSetTeamKillValueForKick($integer) {
return $this->_array2String($this->_clientRequest("vars.teamKillValueForKick " . $integer), 0);
}
/**
* gets the highest kill-value allowed before a player is kicked for teamkilling
*
* @return Integer
*/
function adminVarGetTeamKillValueForKick() {
return (int) $this->_array2String($this->_clientRequest("vars.teamKillValueForKick"));
}
/**
* sets the value of a teamkill (adds to the player's current kill-value)
*
* @param $integer
*
* @return String
*/
function adminVarSetTeamKillValueIncrease($integer) {
return $this->_array2String($this->_clientRequest("vars.teamKillValueIncrease " . $integer), 0);
}
/**
* gets the value of a teamkill
*
* @return Integer
*/
function adminVarGetTeamKillValueIncrease() {
return (int) $this->_array2String($this->_clientRequest("vars.teamKillValueIncrease"));
}
/**
* sets how much every player's kill-value should decrease per second
*
* @param $integer
*
* @return String
*/
function adminVarSetTeamKillValueDecreasePerSecond($integer) {
return $this->_array2String($this->_clientRequest("vars.teamKillValueDecreasePerSecond " . v), 0);
}
/**
* gets the decrease value
*
* @return Integer
*/
function adminVarGetTeamKillValueDecreasePerSecond() {
return (int) $this->_array2String($this->_clientRequest("vars.teamKillValueDecreasePerSecond"));
}
/**
* sets how many seconds a player can be idle before he/she is kicked from the server
*
* @param $timeInSeconds
*
* @return String
*/
function adminVarSetIdleTimeout($timeInSeconds) {
return $this->_array2String($this->_clientRequest("vars.idleTimeout " . $timeInSeconds), 0);
}
/**
* gets the current idle time allowed
*
* @return Integer
*/
function adminVarGetIdleTimeout() {
return (int) $this->_array2String($this->_clientRequest("vars.idleTimeout " . $timeInSeconds));
}
/**
* enabled/disables the profanity filter
*
* @param $boolean
*
* @return String
*/
function adminVarSetProfanityFilter($boolean) {
return $this->_array2String($this->_clientRequest("vars.profanityFilter " . $this->_bool2String($boolean)), 0);
}
/**
* gets the current value for the profanity filter
*
* @return boolean
*/
function adminVarGetProfanityFilter() {
return $this->_array2boolean($this->_clientRequest("vars.profanityFilter"));
}
}
?>

Source for file BC2Conn.php