UE3:QHCurrent (UT3)

Object >> QHCurrent

Package: 

WebAdmin

Implemented interfaces: 

IQueryHandler

The query handler that provides information about the current game. It will also set the start page for the webadmin.

Copyright 2008 Epic Games, Inc. All Rights Reserved

Author: Michiel 'elmuerte' Hendriks

Properties

adminCmdHandler

Type: AdminCommandHandler

Instance that handled "Admin" console command aliases.

AdminCommandHandlerClass

Type: string

Modifiers: config

The AdminCommandHandler class to use for handling the admin console command hack.

Default value: "WebAdmin.AdminCommandHandler"

bAdminConsoleCommandsHack

Type: bool

Modifiers: config

if true use the hack to access some special admin commands lick "kickban ...", "restartlevel". If false these commands would not be available

Default value: True

bConsoleEnabled

Type: bool

Modifiers: config

If true the management console will be available. This will allow users to directly enter console commands on the server. This means that the user will have the ability to shutdown the server or execute commands that change certain core variables.

Default value: True

bEnableTeamChat

Type: bool

Modifiers: config

if true team chat will be enabled.

Default value: True

ChatRefresh

Type: int

Modifiers: config

Refresh time of the chat console

Default value: 5000

cssHidden

Type: string

CSS code to make HTML elements hidden.

Default value: "display: none;"

cssVisible

Type: string

CSS code to make things visible.

denyConsoleCommands

Type: array<string>

Modifiers: config

Lists of console commands that are not allowed to be executed.

Default value, index 0: "say"

Default value, index 1: "obj"

Default value, index 2: "debug"

Default value, index 3: "flush"

Default value, index 4: "set"

Default value, index 5: "get engine.accesscontrol"

denyUrlOptions

Type: array<string>

Modifiers: config

Options in this list are not allowed to be set in the "change game" page. They will removed from the url.

Default value, index 0: "GamePassword"

Default value, index 1: "AdminPassword"

Default value, index 2: "Port"

Default value, index 3: "QueryPort"

factions

Type: array<FactionCharacters>

List of factions and their characters

newUrl

Type: string

Modifiers: private

Will hold the url where to switch the game to. Game switching a delayed for a few ms.

sortedPRI

Type: array<PlayerReplicationInfo>

Will hold a sorted player replication info list.

webadmin

Type: WebAdmin

Structs

FactionCharacters

string factionName 

UTCustomChar_Data.FactionInfo fi 

array<UTCustomChar_Data.CharacterInfo> chars 

Functions

Static functions

comparePRI

static function bool comparePRI (PlayerReplicationInfo PRI1, PlayerReplicationInfo PRI2, string key)

getPlayerKey

static function string getPlayerKey (PlayerReplicationInfo pri)

substPri

static function substPri (IQueryHandler.WebAdminQuery q, PlayerReplicationInfo pri)

Events

ChangeGameTimer

event ChangeGameTimer ()

Other instance functions

banByHash

protected function banByHash (PlayerController PC)

banByID

protected function banByID (PlayerController PC)

banByIP

protected function banByIP (PlayerController PC)

BroadcastMessage

function BroadcastMessage (Controller Sender, int teamidx, coerce string Msg, name Type)

buildSortedPRI

function buildSortedPRI (string sortkey, optional bool reverse, optional bool includeBots)

cleanup

function cleanup ()

Specified by: IQueryHandler.cleanup

Cleanup (prepare for being destroyed). If the implementation extends Object it should set all actor references to none.

CreateTeamChatProxy

function CreateTeamChatProxy ()

handleBots

function handleBots (IQueryHandler.WebAdminQuery q)

handleConsole

function handleConsole (IQueryHandler.WebAdminQuery q)

handleCurrent

function handleCurrent (IQueryHandler.WebAdminQuery q)

handleCurrentChange

function handleCurrentChange (IQueryHandler.WebAdminQuery q)

handleCurrentChangeData

function handleCurrentChangeData (IQueryHandler.WebAdminQuery q)

handleCurrentChat

function handleCurrentChat (IQueryHandler.WebAdminQuery q)

handleCurrentChatData

function handleCurrentChatData (IQueryHandler.WebAdminQuery q)

handleCurrentPlayers

function handleCurrentPlayers (IQueryHandler.WebAdminQuery q)

handleCurrentPlayersAction

function bool handleCurrentPlayersAction (IQueryHandler.WebAdminQuery q)

handleCurrentPlayersData

function handleCurrentPlayersData (IQueryHandler.WebAdminQuery q)

handleQuery

function bool handleQuery (IQueryHandler.WebAdminQuery q)

Specified by: IQueryHandler.handleQuery

(Description copied from IQueryHandler.handleQuery)
Called by the webadmin to request the query handler to handle this query.

Returns:

true when the query was handled.

init

function init (WebAdmin webapp)

Specified by: IQueryHandler.init

Called when the WebAdmin creates and initializes this query handler.

procChatData

function procChatData (IQueryHandler.WebAdminQuery q, optional int startFrom, optional string substvar)

procCurrentChange

function procCurrentChange (IQueryHandler.WebAdminQuery q, string currentGameType, string curmap, array<string> currentMutators, out string outMaps, out string outMutators, out int outMutatorGroups)

registerMenuItems

function registerMenuItems (WebAdminMenu menu)

Specified by: IQueryHandler.registerMenuItems

Called by the webadmin to request the query handler to add its menu items to the web admin menu. The menu is used to determine what query handler will be handle a given path. Paths not registered will be passed to all query handlers until one returns true.

unhandledQuery

function bool unhandledQuery (IQueryHandler.WebAdminQuery q)

Specified by: IQueryHandler.unhandledQuery

(Description copied from IQueryHandler.unhandledQuery)
Called in case of an unhandled path.

Returns:

true when the query was handled.