Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

WormbotReporter.WIR_GameHandler

Extends
WIR_ModHandler
Modifiers
dependson ( WIR_Util )

Copyright (c) 2005-2007 by Wormbo $Id$

Core.Object
|   
+-- Engine.Actor
   |   
   +-- Engine.Info
      |   
      +-- WormbotReporter.WIR_ModHandler
         |   
         +-- WormbotReporter.WIR_GameHandler

Direct Known Subclasses:

WIR_GameHandler_Assault, WIR_GameHandler_Betrayal, WIR_GameHandler_BombingRun, WIR_GameHandler_CTF, WIR_GameHandler_DM, WIR_GameHandler_DoubleDom, WIR_GameHandler_Jailbreak, WIR_GameHandler_Onslaught, WIR_GameHandler_Other

Variables Summary
boolbAnnounceOutOfLives
boolbReportKillingSprees
boolbReportLocations
boolbReportMultiKills
boolbReportSpecial
boolbReportWeapons
boolbScoreEndsRound
array<GUI.eTextAlign>ColumnAlign
stringdataReportKills
stringdataReportPickups
stringdescGameHandler
stringdescReportKillingSprees
stringdescReportKills
stringdescReportLocations
stringdescReportMultiKills
stringdescReportPickups
stringdescReportSpecial
stringdescReportWeapons
stringdescScoreReportDelay
array<TGameHandler>GameHandler
stringlblGameHandler
stringlblReportKillingSprees
stringlblReportKills
stringlblReportLocations
stringlblReportMultiKills
stringlblReportPickups
stringlblReportSpecial
stringlblReportWeapons
stringlblScoreReportDelay
stringMsgClientMessage
stringMsgCurrentTeamScores
stringMsgGameEndFragLimit
stringMsgGameEndLastMan
stringMsgGameEndRoundLimit
stringMsgGameEndTeamScoreLimit
stringMsgGameEndTimeLimit
stringMsgGameFirstBlood
stringMsgGameInfo
stringMsgGameInProgress
stringMsgGameMaxLives
stringMsgGameOvertime
stringMsgGameScoreLimit
stringMsgGameStarted
stringMsgGameTimeLimit
stringMsgLastSecondSave
stringMsgPlayerScoredMultiKill
stringMsgScoreboard
stringMsgSpreeEndKill
stringMsgSpreeEndSuicideFemale
stringMsgSpreeEndSuicideMale
stringMsgSpreeEndTeamKill
stringMsgSpreeStart[6]
byteReportKills
byteReportPickups
intScoreReportDelay
stringStringNameBomb
stringStringNameCore
stringStringNameFlag
stringStringNameFlags
stringStringPrefixOvertime
stringStringScoreTemplate
stringStringSuffixOvertime
stringStringSuffixWinnerPlayer
stringStringSuffixWinnerTeam
stringStringSuffixWinnerTeams
array<string>StringTableHeader
stringStringTableSeparator
stringStringTeamScore
stringStringTimeNotPlaying
Inherited Variables from WormbotReporter.WIR_ModHandler
bMatchStarted, descModHandler, HandlerGroup, lblModHandler, ModHandler, MyMutator, NextHandler
Inherited Variables from Engine.Info
BotsGroup, ChatGroup, GameGroup, KickVoteGroup, MapVoteGroup, RulesGroup, ServerGroup

Structures Summary
TGameHandler
Game, Handler
Inherited Structures from WormbotReporter.WIR_ModHandler
TModHandler

Functions Summary
function AddRow (out array<WIR_Util.TAlignedTable> Table, int row, PlayerReplicationInfo PRI, bool bRightSide))
functionbool CriticalPlayer (Controller Player))
function FillPlayInfo (PlayInfo PlayInfo))
functionstring FormatPlayerName (Actor Player, optional bool bOnlyName, optional string StringScoreTemplate, optional out string CustomPrefix))
functionActor GetClosestGameObjective (vector DesiredLocation))
eventstring GetDescriptionText (string PropertyName))
functionstring GetGameInfoString ()))
functionstring GetObjectiveName (GameObjective GO, optional bool bTeamColored))
functionstring GetObjectName (GameObject GO, optional bool bTeamColored))
functionstring GetRemainingTime ()))
functionbool HandleEndGame (out string Reason))
functionbool HandleKill (out Controller Killer, out Controller Killed, out class<DamageType> DamageType, out string MsgSuffix))
functionbool HandleLocalizedMessage (class<LocalMessage> Message, int Switch, PlayerReplicationInfo RelatedPRI_1, PlayerReplicationInfo RelatedPRI_2, Object OptionalObject))
functionbool HandleStringMessage (string Message, name Type))
functionbool InOrder (PlayerReplicationInfo PRI1, PlayerReplicationInfo PRI2))
function MatchStarting ()))
function ReportScores ()))
Inherited Functions from WormbotReporter.WIR_ModHandler
AcceptPlayInfoProperty, AddHandler, CriticalPlayer, Destroyed, FillPlayInfo, FormatPlayerName, GetDescriptionText, GetLocationNameFor, GetObjectiveName, GetObjectName, GetRemainingTime, HandleEndGame, HandleEndRound, HandleKill, HandleLocalizedMessage, HandleNewRound, HandleStringMessage, MatchStarting, Mutate, PostBeginPlay, ScoreObjective, UpdateLocationNames
Inherited Functions from Engine.Info
AcceptPlayInfoProperty, AllowClassRemoval, FillPlayInfo, GetDescriptionText, GetSecurityLevel


Variables Detail

bAnnounceOutOfLives Source code

var bool bAnnounceOutOfLives;

bReportKillingSprees Source code

var config bool bReportKillingSprees;

bReportLocations Source code

var config bool bReportLocations;

bReportMultiKills Source code

var config bool bReportMultiKills;

bReportSpecial Source code

var config bool bReportSpecial;

bReportWeapons Source code

var config bool bReportWeapons;

bScoreEndsRound Source code

var bool bScoreEndsRound;

ColumnAlign Source code

var array<GUI.eTextAlign> ColumnAlign;

dataReportKills Source code

var localized string dataReportKills;

dataReportPickups Source code

var localized string dataReportPickups;

descGameHandler Source code

var localized string descGameHandler;

descReportKillingSprees Source code

var localized string descReportKillingSprees;

descReportKills Source code

var localized string descReportKills;

descReportLocations Source code

var localized string descReportLocations;

descReportMultiKills Source code

var localized string descReportMultiKills;

descReportPickups Source code

var localized string descReportPickups;

descReportSpecial Source code

var localized string descReportSpecial;

descReportWeapons Source code

var localized string descReportWeapons;

descScoreReportDelay Source code

var localized string descScoreReportDelay;

GameHandler Source code

var globalconfig array<TGameHandler> GameHandler;

lblGameHandler Source code

var localized string lblGameHandler;

lblReportKillingSprees Source code

var localized string lblReportKillingSprees;

lblReportKills Source code

var localized string lblReportKills;

lblReportLocations Source code

var localized string lblReportLocations;

lblReportMultiKills Source code

var localized string lblReportMultiKills;

lblReportPickups Source code

var localized string lblReportPickups;

lblReportSpecial Source code

var localized string lblReportSpecial;

lblReportWeapons Source code

var localized string lblReportWeapons;

lblScoreReportDelay Source code

var localized string lblScoreReportDelay;

MsgClientMessage Source code

var localized string MsgClientMessage;

MsgCurrentTeamScores Source code

var localized string MsgCurrentTeamScores;

MsgGameEndFragLimit Source code

var localized string MsgGameEndFragLimit;

MsgGameEndLastMan Source code

var localized string MsgGameEndLastMan;

MsgGameEndRoundLimit Source code

var localized string MsgGameEndRoundLimit;

MsgGameEndTeamScoreLimit Source code

var localized string MsgGameEndTeamScoreLimit;

MsgGameEndTimeLimit Source code

var localized string MsgGameEndTimeLimit;

MsgGameFirstBlood Source code

var localized string MsgGameFirstBlood;

MsgGameInfo Source code

var localized string MsgGameInfo;

MsgGameInProgress Source code

var localized string MsgGameInProgress;

MsgGameMaxLives Source code

var localized string MsgGameMaxLives;

MsgGameOvertime Source code

var localized string MsgGameOvertime;

MsgGameScoreLimit Source code

var localized string MsgGameScoreLimit;

MsgGameStarted Source code

var localized string MsgGameStarted;

MsgGameTimeLimit Source code

var localized string MsgGameTimeLimit;

MsgLastSecondSave Source code

var localized string MsgLastSecondSave;

MsgPlayerScoredMultiKill Source code

var localized string MsgPlayerScoredMultiKill;

MsgScoreboard Source code

var localized string MsgScoreboard;

MsgSpreeEndKill Source code

var localized string MsgSpreeEndKill;

MsgSpreeEndSuicideFemale Source code

var localized string MsgSpreeEndSuicideFemale;

MsgSpreeEndSuicideMale Source code

var localized string MsgSpreeEndSuicideMale;

MsgSpreeEndTeamKill Source code

var localized string MsgSpreeEndTeamKill;

MsgSpreeStart[6] Source code

var localized string MsgSpreeStart[6];

ReportKills Source code

var config byte ReportKills;

ReportPickups Source code

var config byte ReportPickups;

ScoreReportDelay Source code

var config int ScoreReportDelay;

StringNameBomb Source code

var localized string StringNameBomb;

StringNameCore Source code

var localized string StringNameCore;

StringNameFlag Source code

var localized string StringNameFlag;

StringNameFlags Source code

var localized string StringNameFlags;

StringPrefixOvertime Source code

var localized string StringPrefixOvertime;

StringScoreTemplate Source code

var localized string StringScoreTemplate;

StringSuffixOvertime Source code

var localized string StringSuffixOvertime;

StringSuffixWinnerPlayer Source code

var localized string StringSuffixWinnerPlayer;

StringSuffixWinnerTeam Source code

var localized string StringSuffixWinnerTeam;

StringSuffixWinnerTeams Source code

var localized string StringSuffixWinnerTeams;

StringTableHeader Source code

var localized array<string> StringTableHeader;

StringTableSeparator Source code

var localized string StringTableSeparator;

StringTeamScore Source code

var localized string StringTeamScore;

StringTimeNotPlaying Source code

var localized string StringTimeNotPlaying;


Structures Detail

TGameHandler Source code

struct TGameHandler
{
var config string Game;
var config string Handler;
};



Functions Detail

AddRow Source code

function AddRow ( out array<WIR_Util.TAlignedTable> Table, int row, PlayerReplicationInfo PRI, bool bRightSide) )
Adds data in a row on the left or right side of the scoreboard table.

CriticalPlayer Source code

function bool CriticalPlayer ( Controller Player) )
Called when the match starts.

FillPlayInfo Source code

static function FillPlayInfo ( PlayInfo PlayInfo) )
Add the configuration options to the PlayInfo.

FormatPlayerName Source code

function string FormatPlayerName ( Actor Player, optional bool bOnlyName, optional string StringScoreTemplate, optional out string CustomPrefix) )
Returns a formatted player name for IRC.

GetClosestGameObjective Source code

function Actor GetClosestGameObjective ( vector DesiredLocation) )
Called when the match starts.

GetDescriptionText Source code

static event string GetDescriptionText ( string PropertyName) )
Returns a description for the specified configuration option.

GetGameInfoString Source code

function string GetGameInfoString ( ) )
Returns a string describing the game type and map.

GetObjectiveName Source code

function string GetObjectiveName ( GameObjective GO, optional bool bTeamColored) )
Returns a GameObjective's name.

GetObjectName Source code

function string GetObjectName ( GameObject GO, optional bool bTeamColored) )
Returns a GameObject's name.

GetRemainingTime Source code

function string GetRemainingTime ( ) )
Returns the time remaining in the match or the time elapsed if there's no time limit.

HandleEndGame Source code

function bool HandleEndGame ( out string Reason) )
Return True if the handler wants to override the mutator's default behavior.

HandleKill Source code

function bool HandleKill ( out Controller Killer, out Controller Killed, out class<DamageType> DamageType, out string MsgSuffix) )
Return True if the handler wants to override the mutator's default behavior.

HandleLocalizedMessage Source code

function bool HandleLocalizedMessage ( class<LocalMessage> Message, int Switch, PlayerReplicationInfo RelatedPRI_1, PlayerReplicationInfo RelatedPRI_2, Object OptionalObject) )
Return True if the message should not be reported through the default event.

HandleStringMessage Source code

function bool HandleStringMessage ( string Message, name Type) )
Return True if the message was handled by the handler class.

InOrder Source code

function bool InOrder ( PlayerReplicationInfo PRI1, PlayerReplicationInfo PRI2) )
Returns True if player 1 ranks higher than player 2.

MatchStarting Source code

function MatchStarting ( ) )
Called when the match starts.

ReportScores Source code

function ReportScores ( ) )
Sends a scoreboard to the IRC channel.


Defaultproperties

defaultproperties
{
	GameHandler[0]  = (Game="xDeathMatch",Handler="WIR_GameHandler_DM")
	GameHandler[1]  = (Game="xTeamGame",Handler="WIR_GameHandler_TDM")
	GameHandler[2]  = (Game="xDoubleDom",Handler="WIR_GameHandler_DoubleDom")
	GameHandler[3]  = (Game="xCTFGame",Handler="WIR_GameHandler_CTF")
	GameHandler[4]  = (Game="InstaGibCTF",Handler="WIR_GameHandler_ICTF")
	GameHandler[5]  = (Game="xBombingRun",Handler="WIR_GameHandler_BombingRun")
	GameHandler[6]  = (Game="ONSOnslaughtGame",Handler="WIR_GameHandler_Onslaught")
	GameHandler[7]  = (Game="xVehicleCTFGame",Handler="WIR_GameHandler_VCTF")
	GameHandler[8]  = (Game="xMutantGame",Handler="WormbotHandlerBonuspack.WIR_GameHandler_Mutant")
	GameHandler[9]  = (Game="xLastManStandingGame",Handler="WormbotHandlerBonuspack.WIR_GameHandler_LMS")
	GameHandler[10] = (Game="Invasion",Handler="WormbotHandlerInvasion.WIR_GameHandler_Invasion")
	GameHandler[11] = (Game="OLTeamDeathmatch",Handler="WormbotHandlerOLTeamGames.WIR_GameHandler_OLTDM")
	GameHandler[12] = (Game="OLCTFGame",Handler="WormbotHandlerOLTeamGames.WIR_GameHandler_OLCTF")
	GameHandler[13] = (Game="ASGameInfo",Handler="WormbotHandlerAssault.WIR_GameHandler_Assault")
	GameHandler[14] = (Game="Jailbreak",Handler="WormbotHandlerJailbreak.WIR_GameHandler_Jailbreak")
	GameHandler[15] = (Game="ChaosxDeathMatch",Handler="WIR_GameHandler_DM")
	GameHandler[16] = (Game="ChaosxTeamDeathMatch",Handler="WIR_GameHandler_TDM")
	GameHandler[17] = (Game="ChaosxDoubleDom",Handler="WIR_GameHandler_DoubleDom")
	GameHandler[18] = (Game="ChaosCTF",Handler="WIR_GameHandler_CTF")
	GameHandler[19] = (Game="TDM_Game_3SPN",Handler="WormbotHandler3SPN.WIR_GameHandler_TAM")
	GameHandler[20] = (Game="LMS_Game_3SPN",Handler="WormbotHandler3SPN.WIR_GameHandler_AM")
	GameHandler[21] = (Game="TeamArenaMaster",Handler="WormbotHandler3SPNv3.WIR_GameHandler_TAMv3")
	GameHandler[22] = (Game="ArenaMaster",Handler="WormbotHandler3SPNv3.WIR_GameHandler_AMv3")
	GameHandler[23] = (Game="Freon",Handler="WormbotHandler3SPNv3.WIR_GameHandler_Freon")
	GameHandler[24] = (Game="ChaosHyperCTF",Handler="WIR_GameHandler_ICTF")
	GameHandler[25] = (Game="BR4Game",Handler="WormbotHandlerBombingRun4.WIR_GameHandler_BR4")


	ReportKills           = 1
	bReportMultiKills     = True
	bReportKillingSprees  = True
	bReportLocations      = True
	bReportWeapons        = True
	ReportPickups         = 2
	bReportSpecial        = True
	ScoreReportDelay      = 120


	bAnnounceOutOfLives = True


	MsgGameInfo       = "[^B]%g[^B] on [^B]%m[^B]"
	MsgGameInProgress = "[^B]%g[^B] in progress on [^B]%m[^B]"
	MsgGameScoreLimit = ", Goal Score: [^B]%s[^B]"
	MsgGameMaxLives   = ", Max Lives: [^B]%l[^B]"
	MsgGameTimeLimit  = ", Time Limit: [^B]%t minutes[^B]"


	MsgGameStarted    = "[^B][%r] The match has begun.[^B]"
	MsgGameOvertime   = "[^B][%r] Sudden Death Overtime![^B]"
	MsgGameFirstBlood = "[%r] - %p[^O] drew [^B]First Blood[^B]"
	MsgLastSecondSave = "[%r] - [^B]Last Second Save[^B] by %t"


	MsgGameEndFragLimit       = "Frag Limit reached"
	MsgGameEndTimeLimit       = "Time Limit Hit"
	MsgGameEndTeamScoreLimit  = "Team Score Limit reached"
	MsgGameEndLastMan         = "[^O]%p[^O] is the [^B]Last Man Standing[^B]"
	MsgGameEndRoundLimit      = "Round Limit reached"


	StringSuffixWinnerPlayer  = " - [^O]%p[^O] is the winner"
	StringSuffixWinnerTeam    = " - [^O]%t wins the match"
	StringSuffixWinnerTeams   = " - [^O]%t are tied for the lead"


	StringNameFlag  = "[^B]%t Flag"
	StringNameFlags = "multiple flags"
	StringNameBomb  = "Bomb"
	StringNameCore  = "Power Core"


	StringPrefixOvertime = "O-"
	StringSuffixOvertime = ""
	StringTimeNotPlaying = "--:--"


	
	MsgSpreeStart(0) = "[%r] - %p[^O] is on a [^B]Killing Spree[^B]"
	MsgSpreeStart(1) = "[%r] - %p[^O] is on a [^B]Rampage[^B]"
	MsgSpreeStart(2) = "[%r] - %p[^O] is [^B]Dominating[^B]"
	MsgSpreeStart(3) = "[%r] - %p[^O] is [^B]Unstoppable[^B]"
	MsgSpreeStart(4) = "[%r] - %p[^O] is [^B]GODLIKE[^B]"
	MsgSpreeStart(5) = "[%r] - %p[^O] is [^B]WICKED SICK[^B]"


	MsgSpreeEndKill           = "[%r] - %p[^O]'s killing spree was ended by %o[^O]"
	MsgSpreeEndTeamKill       = "[%r] - %p[^O]'s killing spree was ended by %o[^O]"
	MsgSpreeEndSuicideFemale  = "[%r] - %o[^O] ended her own killing spree"
	MsgSpreeEndSuicideMale    = "[%r] - %o[^O] ended his own killing spree"


	MsgClientMessage = "[%r]  %m"


	MsgPlayerScoredMultiKill = "[%r] %k[^O] scored a [^B]%m[^B]"


	MsgCurrentTeamScores  = "(%r) [^B]Team Scores:[^B] %s"
	StringTeamScore       = "%t has [^B]%s[^B]"
	MsgScoreboard         = "(%r) %s"


	StringScoreTemplate = "[score]/[deaths]/[ping]ms"


	StringTableSeparator = " "
	StringTableHeader(0) = "[^U]Name"
	StringTableHeader(1) = "Score"
	StringTableHeader(2) = "Kills"
	StringTableHeader(3) = "Deaths[^O]"
	StringTableHeader(4) = " "
	StringTableHeader(5) = "[^U]Name"
	StringTableHeader(6) = "Score"
	StringTableHeader(7) = "Kills"
	StringTableHeader(8) = "Deaths[^O]"


	ColumnAlign(0) = TXTA_Left
	ColumnAlign(1) = TXTA_Right
	ColumnAlign(2) = TXTA_Right
	ColumnAlign(3) = TXTA_Right
	ColumnAlign(4) = TXTA_Center
	ColumnAlign(5) = TXTA_Left
	ColumnAlign(6) = TXTA_Right
	ColumnAlign(7) = TXTA_Right
	ColumnAlign(8) = TXTA_Right


	HandlerGroup = "Wormbot Game Handlers"


	lblGameHandler          = "(Lists) Game Handlers"
	lblReportKills          = "Report Kills"
	lblReportMultiKills     = "Report Multi Kills"
	lblReportKillingSprees  = "Report Killing Sprees"
	lblReportLocations      = "Report Locations"
	lblReportWeapons        = "Report Weapons"
	lblReportPickups        = "Report Pickups"
	lblReportSpecial        = "Report Special Events"
	lblScoreReportDelay     = "Score report delay"


	descGameHandler         = "Configure game handler classes."
	descReportKills         = "Report death messages."
	descReportMultiKills    = "Report multi kills in death messages."
	descReportKillingSprees = "Report First Blood and Killing Sprees."
	descReportLocations     = "Report location names for kills, pickups and other events."
	descReportWeapons       = "Report the weapon name in kill messages."
	descReportPickups       = "Report when super items or super weapons are picked up."
	descReportSpecial       = "Report special events like 'Flak Monkey' as well as headshots, combos or special vehicle kill messages."
	descScoreReportDelay    = "Wait this number of seconds before reporting changed scores again."


	dataReportKills   = "0;Only Carrier;1;Suicides, TK and Carrier;2;All"
	dataReportPickups = "0;None;1;Important;2;All"
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: Do 14.8.2014 09:58:29.584 - Created with UnCodeX