[ all elements ]

Index of all elements

[ a ] [ b ] [ g ] [ i ] [ l ] [ _ ]

a

adminBanAddPlayerGUID
in file BC2Conn.php, method BC2Conn::adminBanAddPlayerGUID()
    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
adminBanAddPlayerIP
in file BC2Conn.php, method BC2Conn::adminBanAddPlayerIP()
    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
adminBanAddPlayername
in file BC2Conn.php, method BC2Conn::adminBanAddPlayername()
    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
adminBanlistClear
in file BC2Conn.php, method BC2Conn::adminBanlistClear()
    clears all bans from playername banlist
adminBanlistList
in file BC2Conn.php, method BC2Conn::adminBanlistList()
    lists all bans from banlist
adminBanlistLoad
in file BC2Conn.php, method BC2Conn::adminBanlistLoad()
    loads the banlist from banlist file
adminBanlistSave
in file BC2Conn.php, method BC2Conn::adminBanlistSave()
    saves the current banlist to banlist file
adminBanRemovePlayerIP
in file BC2Conn.php, method BC2Conn::adminBanRemovePlayerIP()
    unbans a player by playerip
adminBanRemovePlayername
in file BC2Conn.php, method BC2Conn::adminBanRemovePlayername()
    unbans a player by playername
adminEndRound
in file BC2Conn.php, method BC2Conn::adminEndRound()
    ends the current round, declaring the given teamId as winner
adminEventsEnabledStatusGet
in file BC2Conn.php, method BC2Conn::adminEventsEnabledStatusGet()
    returns true/false, if server events are enabled in this connection or not
adminGamePasswordGet
in file BC2Conn.php, method BC2Conn::adminGamePasswordGet()
    returns the gamepassword as a string
adminGamePasswordSet
in file BC2Conn.php, method BC2Conn::adminGamePasswordSet()
    sets a new password on the gameserver.
password MUST NOT contain whitespaces!!

to clear the password, use adminGamePasswordSet("")
adminGetAllCommands
in file BC2Conn.php, method BC2Conn::adminGetAllCommands()
    returns all commands available on the server - requires login
adminGetPlayerdata
in file BC2Conn.php, method BC2Conn::adminGetPlayerdata()
    gets the gamedata of a given playername on the gameserver
adminGetPlayerGUID
in file BC2Conn.php, method BC2Conn::adminGetPlayerGUID()
    returns the GUID of a given playername
adminGetPlayerlist
in file BC2Conn.php, method BC2Conn::adminGetPlayerlist()
    gets the full gamedata of all players on the gameserver
adminGetPlaylist
in file BC2Conn.php, method BC2Conn::adminGetPlaylist()
    returns current playmode on server
adminGetPlaylists
in file BC2Conn.php, method BC2Conn::adminGetPlaylists()
    returns all available playmodes on server
adminGetSupportedMaps
in file BC2Conn.php, method BC2Conn::adminGetSupportedMaps()
    gets list of maps supported by given playmode
adminKickPlayer
in file BC2Conn.php, method BC2Conn::adminKickPlayer()
    kicks a specified player by playername
adminKickPlayerWithReason
in file BC2Conn.php, method BC2Conn::adminKickPlayerWithReason()
    kicks a specified player by playername with a given kickreason
adminKillPlayer
in file BC2Conn.php, method BC2Conn::adminKillPlayer()
    kills the given player without counting this death on the playerstats
adminMaplistAppend
in file BC2Conn.php, method BC2Conn::adminMaplistAppend()
    appends a given map to the end of the maplist file
adminMaplistClear
in file BC2Conn.php, method BC2Conn::adminMaplistClear()
    clears the maplist file
adminMaplistGetNextMapIndex
in file BC2Conn.php, method BC2Conn::adminMaplistGetNextMapIndex()
    gets index of next map to be run
adminMaplistInsertMapInIndex
in file BC2Conn.php, method BC2Conn::adminMaplistInsertMapInIndex()
    adds map with name at the specified index to the maplist
adminMaplistList
in file BC2Conn.php, method BC2Conn::adminMaplistList()
    returns the maplist from map file
adminMaplistLoad
in file BC2Conn.php, method BC2Conn::adminMaplistLoad()
    loads the maplist
adminMaplistRemove
in file BC2Conn.php, method BC2Conn::adminMaplistRemove()
    removes a given map from maplist
[ index = Integer! ]
adminMaplistSave
in file BC2Conn.php, method BC2Conn::adminMaplistSave()
    saves the current maplist to file
adminMaplistSetNextMapIndex
in file BC2Conn.php, method BC2Conn::adminMaplistSetNextMapIndex()
    sets index of next map to be run
[ index = Integer! ]
adminMovePlayerSwitchSquad
in file BC2Conn.php, method BC2Conn::adminMovePlayerSwitchSquad()
    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! ]
adminMovePlayerSwitchTeam
in file BC2Conn.php, method BC2Conn::adminMovePlayerSwitchTeam()
    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! ]
adminReservedSlotsAddPlayer
in file BC2Conn.php, method BC2Conn::adminReservedSlotsAddPlayer()
    adds a player by given playername to reserved slots file
adminReservedSlotsClear
in file BC2Conn.php, method BC2Conn::adminReservedSlotsClear()
    clears the file containing all reserved slots
adminReservedSlotsList
in file BC2Conn.php, method BC2Conn::adminReservedSlotsList()
    lists all playernames in reserved slots file
adminReservedSlotsLoad
in file BC2Conn.php, method BC2Conn::adminReservedSlotsLoad()
    loads the file containing all reserved slots
[ I don't know if this function is useful.. ]
adminReservedSlotsRemovePlayer
in file BC2Conn.php, method BC2Conn::adminReservedSlotsRemovePlayer()
    removes a player by given playername from reserved slots file
adminReservedSlotsSave
in file BC2Conn.php, method BC2Conn::adminReservedSlotsSave()
    saves made changes to reserved slots file
adminRestartMap
in file BC2Conn.php, method BC2Conn::adminRestartMap()
    restarts the current level
adminRunNextLevel
in file BC2Conn.php, method BC2Conn::adminRunNextLevel()
    runs the next level on maplist
adminSayMessageToAll
in file BC2Conn.php, method BC2Conn::adminSayMessageToAll()
    sends a chat mesage to all. the message must be less than 100 characters long.
adminSayMessageToPlayer
in file BC2Conn.php, method BC2Conn::adminSayMessageToPlayer()
    sends a chat message to a player. the message must be less than 100 characters long.
adminSayMessageToTeam
in file BC2Conn.php, method BC2Conn::adminSayMessageToTeam()
    sends a chat mesage to a team. the message must be less than 100 characters long.
adminSetPlaylist
in file BC2Conn.php, method BC2Conn::adminSetPlaylist()
    sets a new playlist

example: adminSetPlaylist("SQDM") - for setting playmode to 'Squad Deathmatch'
adminVarGet3dSpotting
in file BC2Conn.php, method BC2Conn::adminVarGet3dSpotting()
    gets true/false, if 3d spotting is enabled or not
adminVarGet3rdPersonVehiCam
in file BC2Conn.php, method BC2Conn::adminVarGet3rdPersonVehiCam()
    gets true/false, if 3rd person vehicle cam is enabled or not
adminVarGetAdminPassword
in file BC2Conn.php, method BC2Conn::adminVarGetAdminPassword()
    gets the admin (rcon) password
[ I only get the result: PasswordRetrievalNotAllowed ]
adminVarGetBannerURL
in file BC2Conn.php, method BC2Conn::adminVarGetBannerURL()
    gets the banner url
adminVarGetCrosshair
in file BC2Conn.php, method BC2Conn::adminVarGetCrosshair()
    gets true/false, if crosshair is enabled or not
adminVarGetFriendlyFire
in file BC2Conn.php, method BC2Conn::adminVarGetFriendlyFire()
    gets true/false, if friendly fire is enabled or not
adminVarGetHardcore
in file BC2Conn.php, method BC2Conn::adminVarGetHardcore()
    gets true/false, if hardcore mode is enabled or not
adminVarGetIdleTimeout
in file BC2Conn.php, method BC2Conn::adminVarGetIdleTimeout()
    gets the current idle time allowed
adminVarGetKillCam
in file BC2Conn.php, method BC2Conn::adminVarGetKillCam()
    gets true/false, if killcam is enabled or not
adminVarGetMiniMap
in file BC2Conn.php, method BC2Conn::adminVarGetMiniMap()
    gets true/false, if minimap is enabled or not
adminVarGetMiniMapSpotting
in file BC2Conn.php, method BC2Conn::adminVarGetMiniMapSpotting()
    gets true/false, if minimap spotting is enabled or not
adminVarGetProfanityFilter
in file BC2Conn.php, method BC2Conn::adminVarGetProfanityFilter()
    gets the current value for the profanity filter
adminVarGetPunkbuster
in file BC2Conn.php, method BC2Conn::adminVarGetPunkbuster()
    gets true/false, if punkbuster is enabled or not
adminVarGetRanked
in file BC2Conn.php, method BC2Conn::adminVarGetRanked()
    gets true/false if ranked server settings are enabled or not
adminVarGetRankLimit
in file BC2Conn.php, method BC2Conn::adminVarGetRankLimit()
    gets rank limit set on server
adminVarGetServerDescription
in file BC2Conn.php, method BC2Conn::adminVarGetServerDescription()
    gets the server description
adminVarGetTeambalance
in file BC2Conn.php, method BC2Conn::adminVarGetTeambalance()
    gets true/false, if teambalance is enabled or not
adminVarGetTeamKillCountForKick
in file BC2Conn.php, method BC2Conn::adminVarGetTeamKillCountForKick()
    gets the number of teamkills allowed during one round
adminVarGetTeamKillValueDecreasePerSecond
in file BC2Conn.php, method BC2Conn::adminVarGetTeamKillValueDecreasePerSecond()
    gets the decrease value
adminVarGetTeamKillValueForKick
in file BC2Conn.php, method BC2Conn::adminVarGetTeamKillValueForKick()
    gets the highest kill-value allowed before a player is kicked for teamkilling
adminVarGetTeamKillValueIncrease
in file BC2Conn.php, method BC2Conn::adminVarGetTeamKillValueIncrease()
    gets the value of a teamkill
adminVarSet3dSpotting
in file BC2Conn.php, method BC2Conn::adminVarSet3dSpotting()
    sets 3d spotting on maps on/off
adminVarSet3rdPersonVehiCam
in file BC2Conn.php, method BC2Conn::adminVarSet3rdPersonVehiCam()
    sets the 3rd person vehicle cam on/off

adminVarSetAdminPassword
in file BC2Conn.php, method BC2Conn::adminVarSetAdminPassword()
    sets the admin (rcon) password
[ I haven't tested this ]
adminVarSetBannerURL
in file BC2Conn.php, method BC2Conn::adminVarSetBannerURL()
    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. ]
adminVarSetCrosshair
in file BC2Conn.php, method BC2Conn::adminVarSetCrosshair()
    sets crosshair on/off
adminVarSetFriendlyFire
in file BC2Conn.php, method BC2Conn::adminVarSetFriendlyFire()
    sets friendly fire on/off
adminVarSetHardcore
in file BC2Conn.php, method BC2Conn::adminVarSetHardcore()
    sets hardcore mode on/off
adminVarSetIdleTimeout
in file BC2Conn.php, method BC2Conn::adminVarSetIdleTimeout()
    sets how many seconds a player can be idle before he/she is kicked from the server
adminVarSetKillCam
in file BC2Conn.php, method BC2Conn::adminVarSetKillCam()
    sets killcam on/off
adminVarSetMiniMap
in file BC2Conn.php, method BC2Conn::adminVarSetMiniMap()
    sets minimap on/off
adminVarSetMiniMapSpotting
in file BC2Conn.php, method BC2Conn::adminVarSetMiniMapSpotting()
    sets minimap spotting on/off
adminVarSetProfanityFilter
in file BC2Conn.php, method BC2Conn::adminVarSetProfanityFilter()
    enabled/disables the profanity filter
adminVarSetPunkbuster
in file BC2Conn.php, method BC2Conn::adminVarSetPunkbuster()
    sets punkbuster on/off
adminVarSetRanked
in file BC2Conn.php, method BC2Conn::adminVarSetRanked()
    sets ranked server on/off
adminVarSetRankLimit
in file BC2Conn.php, method BC2Conn::adminVarSetRankLimit()
    sets the max rank limit players are allowed to join

##QA: Says 'OK' but still allow higher ranked players to join.
adminVarSetServerDescription
in file BC2Conn.php, method BC2Conn::adminVarSetServerDescription()
    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.
adminVarSetServername
in file BC2Conn.php, method BC2Conn::adminVarSetServername()
    sets a new servername
adminVarSetTeambalance
in file BC2Conn.php, method BC2Conn::adminVarSetTeambalance()
    sets teambalance on/off
adminVarSetTeamKillCountForKick
in file BC2Conn.php, method BC2Conn::adminVarSetTeamKillCountForKick()
    sets the number of teamkills allowed during one round, before the game kicks the player in question
adminVarSetTeamKillValueDecreasePerSecond
in file BC2Conn.php, method BC2Conn::adminVarSetTeamKillValueDecreasePerSecond()
    sets how much every player's kill-value should decrease per second
adminVarSetTeamKillValueForKick
in file BC2Conn.php, method BC2Conn::adminVarSetTeamKillValueForKick()
    sets the highest kill-value allowed before a player is kicked for teamkilling
set to 0 to disable kill value mechanism
adminVarSetTeamKillValueIncrease
in file BC2Conn.php, method BC2Conn::adminVarSetTeamKillValueIncrease()
    sets the value of a teamkill (adds to the player's current kill-value)
adminYellMessage
in file BC2Conn.php, method BC2Conn::adminYellMessage()
    sends an admin-yell message to a specified player (or all)
example: adminYellMessage("Storm the front!", "JLNNN") - send the message to player "JLNNN"
adminYellMessageToTeam
in file BC2Conn.php, method BC2Conn::adminYellMessageToTeam()
    sends an admin-yell message to a specified team
example: adminYellMessageToTeam("Storm the front!", 1) - send the message to teamID 1
top

b

BC2Conn
in file BC2Conn.php, class BC2Conn
    Project page:
BC2Conn.php
procedural page BC2Conn.php
top

g

getCurrentGameRound
in file BC2Conn.php, method BC2Conn::getCurrentGameRound()
    returns the current round of the game
getCurrentMap
in file BC2Conn.php, method BC2Conn::getCurrentMap()
    returns the current map as a string
getCurrentMapName
in file BC2Conn.php, method BC2Conn::getCurrentMapName()
    returns the current map (human readable) as a string
getCurrentPlayers
in file BC2Conn.php, method BC2Conn::getCurrentPlayers()
    returns the current players on server as an integer
getCurrentPlaymode
in file BC2Conn.php, method BC2Conn::getCurrentPlaymode()
    returns the current playmode as a string
getCurrentPlaymodeName
in file BC2Conn.php, method BC2Conn::getCurrentPlaymodeName()
    returns the current playmode (human readable) as a string
getGameMaxRounds
in file BC2Conn.php, method BC2Conn::getGameMaxRounds()
    returns the max amount of rounds of the current game
getGameType
in file BC2Conn.php, method BC2Conn::getGameType()
    returns the game type currently running
getMapName
in file BC2Conn.php, method BC2Conn::getMapName()
    returns the name of the given map

example: getMapName("Levels/MP_002")
getMaxPlayers
in file BC2Conn.php, method BC2Conn::getMaxPlayers()
    returns the max amount of players allowed on server as an integer
getOnlineState
in file BC2Conn.php, method BC2Conn::getOnlineState()
    returns the current online state of the gameserver
getPlayerClantag
in file BC2Conn.php, method BC2Conn::getPlayerClantag()
    returns the clantag of a given playername
getPlayerdata
in file BC2Conn.php, method BC2Conn::getPlayerdata()
    TODO: check for caching if playername = all
getPlayerDeaths
in file BC2Conn.php, method BC2Conn::getPlayerDeaths()
    returns the current deaths of a given playername
getPlayerKills
in file BC2Conn.php, method BC2Conn::getPlayerKills()
    returns the current kills of a given playername
getPlayerlist
in file BC2Conn.php, method BC2Conn::getPlayerlist()
    returns list of all players on the server, but with zeroed out GUIDs
getPlayerlistNames
in file BC2Conn.php, method BC2Conn::getPlayerlistNames()
    returns list of all playernames on server (useful for other functions)
getPlayername
in file BC2Conn.php, method BC2Conn::getPlayername()
    returns the playername of a given playername
getPlayerPing
in file BC2Conn.php, method BC2Conn::getPlayerPing()
    returns the ping of a given playername
getPlayerScore
in file BC2Conn.php, method BC2Conn::getPlayerScore()
    returns the score of a given playername
getPlayerSquadID
in file BC2Conn.php, method BC2Conn::getPlayerSquadID()
    returns the squadid of a given playername
getPlayerTeamID
in file BC2Conn.php, method BC2Conn::getPlayerTeamID()
    returns the teamid of a given playername
getPlaymodeName
in file BC2Conn.php, method BC2Conn::getPlaymodeName()
    returns the name of the given playmode

example: getPlaymodeName("RUSH")
getServerInfo
in file BC2Conn.php, method BC2Conn::getServerInfo()
    returns the server information as an array
getServerIP
in file BC2Conn.php, method BC2Conn::getServerIP()
    returns the server ip as a string
getServerName
in file BC2Conn.php, method BC2Conn::getServerName()
    returns the server name as a string
getSquadName
in file BC2Conn.php, method BC2Conn::getSquadName()
    returns the name of the given squad

example: getSquadName(1) - will return "Bravo Squad"
getTeamName
in file BC2Conn.php, method BC2Conn::getTeamName()
    gets the teamname of a given map, playmode and teamid (DIFFERENT IN SQDM!)
getTeamScores
in file BC2Conn.php, method BC2Conn::getTeamScores()
    returns the current teamscores
getVersion
in file BC2Conn.php, method BC2Conn::getVersion()
    returns the server version as an array
getVersionID
in file BC2Conn.php, method BC2Conn::getVersionID()
    returns the build-id of the game
top

i

isConnected
in file BC2Conn.php, method BC2Conn::isConnected()
    returns true if connected to a gameserver, otherwise false
isLoggedIn
in file BC2Conn.php, method BC2Conn::isLoggedIn()
    if logged in with rcon && successful, return true, otherwise false
isServerOnline
in file BC2Conn.php, method BC2Conn::isServerOnline()
    returns true if server is available, otherwise false
top

l

loginInsecure
in file BC2Conn.php, method BC2Conn::loginInsecure()
    plain text login to gameserver
[ RCON password MUST NOT contain whitespaces!! ]
loginSecure
in file BC2Conn.php, method BC2Conn::loginSecure()
    salted hash login to gameserver
[ RCON password MUST NOT contain whitespaces!! ]
logout
in file BC2Conn.php, method BC2Conn::logout()
    logging out
top

_

__construct
in file BC2Conn.php, method BC2Conn::__construct()
__destruct
in file BC2Conn.php, method BC2Conn::__destruct()
top

Documentation generated on Sun, 01 Aug 2010 12:55:28 +0200 by phpDocumentor 1.4.3