Mostly Harmless

UE2:UT2K4SPTab_LadderBase (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT2004 Object >> GUI >> GUIComponent >> GUIMultiComponent >> GUIPanel >> GUITabPanel >> UT2K4TabPanel >> UT2K4SPTab_Base >> UT2K4SPTab_LadderBase
Package: 
GUI2K4
Direct subclasses:
UT2K4SPTab_Ladder, UT2K4SPTab_SingleLadder

Base class for the ladders (Qualify, Team Qualify and Tournament)

Written by Michiel Hendriks (c) 2003, 2004, Epic Games, Inc. All Rights Reserved

Properties[edit]

ActiveMap[edit]

Type: CacheManager.MapRecord


AnimTime[edit]

Type: float

duration of the button animation

Default value: 1.0

BalanceLabel[edit]

Type: string

Modifiers: localized


Default value: "Balance:"

btnChallengeMap[edit]

Type: GUIButton

Modifiers: automated


Default value: GUIButton'SPLbtnChallengeMap'

clEntryFail[edit]

Type: Object.Color

colors used for the entry fee

Default value:

Member Value
A 255
B 96
G 96
R 255

clEntryMatch[edit]

Type: Object.Color

colors used for the entry fee

Default value:

Member Value
A 255
B 103
G 207
R 185

EntryFee[edit]

Type: string

Modifiers: localized


Default value: "Entry fee:"

imgMatchShot[edit]

Type: GUIImage

Modifiers: automated


Default value: GUIImage'SPLimgMatchShot'

lblBalance[edit]

Type: GUILabel

Modifiers: automated


Default value: GUILabel'SPLlblBalance'

lblMatchEntryFee[edit]

Type: GUILabel

Modifiers: automated


Default value: GUILabel'SPLlblMatchEntryFee'

lblMatchPrice[edit]

Type: GUILabel

Modifiers: automated


Default value: GUILabel'SPLlblMatchPrice'

lblNoMoney[edit]

Type: GUILabel

Modifiers: automated


Default value: GUILabel'SPLlblNoMoney'

MapChallengeWindow[edit]

Type: string

The map challenge window

Default value: "GUI2K4.UT2K4SP_MapChallenge"

NotEnoughPlayers[edit]

Type: string

Modifiers: localized


Default value: "You do not have enough healthy team mates for this match.|%teammates% healthy team mates are required, you only have %healthy%."

PrizeMoney[edit]

Type: string

Modifiers: localized


Default value: "Prize money:"

RoleWindow[edit]

Type: UT2K4SP_TeamRoles


sbDetails[edit]

Type: GUIScrollTextBox

Modifiers: automated


Default value: GUIScrollTextBox'SPPsbDetails'

sbgDetail[edit]

Type: GUISectionBackground

Modifiers: automated


Default value: AltSectionBackground'SPPsbgDetail'

sbgMatch[edit]

Type: GUISectionBackground

Modifiers: automated


Default value: AltSectionBackground'SPPsbgMatch'

SelectedMatch[edit]

Type: UT2K4LadderButton


TeamRoleWindow[edit]

Type: string

This window will be displayed before each team match to assign the roles of the team mates

Default value: "GUI2K4.UT2K4SP_TeamRoles"

Default values[edit]

See UT2K4SPTab_LadderBase defaults.

Structs[edit]

AnimData[edit]

used for button animation

float
float

Instance functions[edit]

CreateHButtons[edit]

function array<UT2K4LadderButtonCreateHButtons (int ladderId, float LadderTop, float LadderLeft, float LadderWidth, optional bool bHidden)

Create the ladder buttons, horizontal layout Should be called during InitComponent()

CreateVButtons[edit]

function array<UT2K4LadderButtonCreateVButtons (int ladderId, float LadderTop, float LadderLeft, float LadderHeight, optional bool bHidden)

Create the ladder buttons Should be called during InitComponent()

DoAnimate[edit]

function DoAnimate (array<UT2K4LadderButtonbuttons, array<AnimDatadata, optional bool reset)

animate the button

GetLadderProgress[edit]

function int GetLadderProgress (int ladderindex)


GetMapDecription[edit]

function string GetMapDecription (CacheManager.MapRecord MR)

return the map description

getMatchCaption[edit]

function string getMatchCaption (UT2K4MatchInfo mi)


InitAnimData[edit]

function array<AnimDataInitAnimData (array<UT2K4LadderButtonbuttons)

initialize buttons for animation

LadderButtonOnArrival[edit]

function LadderButtonOnArrival (GUIComponent Sender, GUI.EAnimationType Type)

to show the progress bar again

MapChallengeUpdate[edit]

function MapChallengeUpdate ()


moveMatchInfo[edit]

function moveMatchInfo (optional float topDelta, optional float leftDelta)

Move the match information components to a new location

OnMapChallenge[edit]

function bool OnMapChallenge (GUIComponent Sender)


onMatchClick[edit]

function bool onMatchClick (GUIComponent Sender)


onMatchDblClick[edit]

function bool onMatchDblClick (GUIComponent Sender)

Double click -> play match

onPlayClick[edit]

function bool onPlayClick ()

Overrides: UT2K4SPTab_Base.onPlayClick

Play the selected match, first check if we need to assign team mates

selectNextMatch[edit]

function selectNextMatch ()

Select next match should be overwritten in subclasses

showMatchDetails[edit]

function showMatchDetails (UT2K4MatchInfo mi)

Show the match details

ShowPanel[edit]

function ShowPanel (bool bShow)

Overrides: UT2K4SPTab_Base.ShowPanel

make sure the main window is set

StartMatch[edit]

function StartMatch ()

Start the selected match

UpdateBalance[edit]

function UpdateBalance ()

update the balance label

updateButton[edit]

function updateButton (UT2K4LadderButton btn, int ladderId, int matchId)

Update a single button. buttun style is not updated, this takes quite some time, call SetState when the button is shown