UE3:UTUIFrontEnd_Leaderboards (UT3)

Object >> UIRoot >> UIScreenObject >> UIScene >> UTUIScene >> UTUIFrontEnd >> UTUIFrontEnd_Leaderboards

Package: 

UTGame

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Leaderboards scene for UT3.

Properties

bAreButtonsDisabled

Type: bool

If buttons are disabled due to pending online queries

CurrentPlayerIndex

Type: int

Index of the player we went to get detailed stats about

DetailsScene

Type: string

Reference to the scene to show when displaying details for a player.

Default value: "UI_Scenes_FrontEnd.Scenes.PlayerStatsDetails"

MatchTypeLabel

Type: UILabel

Modifiers: transient

MatchType label.

RefreshingLabel

Type: UILabel

Modifiers: transient

Refreshing label.

StatsDataStore

Type: UTDataStore_OnlineStats

Modifiers: transient

Reference to the stats datastore.

StatsInterface

Type: OnlineStatsInterface

Modifiers: transient

Reference to the stats interface.

StatsList

Type: UIList

Modifiers: transient

List of stats results.

ViewTypeLabel

Type: UILabel

Modifiers: transient

ViewType label.

Subobjects

SceneEventComponent

Class: Engine.UIComp_Event

Inherits from: UTUIFrontEnd.SceneEventComponent

No new values.

Functions

Events

PostInitialize

event PostInitialize ()

Overrides: UTUIFrontEnd.PostInitialize

PostInitialize event - Sets delegates for the scene.

SceneActivated

event SceneActivated (bool bInitialActivation)

Overrides: UTUIFrontEnd.SceneActivated

Activated event for the scene, should set focus to the main list.

Other instance functions

HandleInputKey

function bool HandleInputKey (const out UIRoot.InputEventParameters EventParms)

Overrides: UTUIFrontEnd.HandleInputKey

Provides a hook for unrealscript to respond to input using actual input key names (i.e. Left, Tab, etc.)

Called when an input key event is received which this widget responds to and is in the correct state to process. The keys and states widgets receive input for is managed through the UI editor's key binding dialog (F8).

This delegate is called BEFORE kismet is given a chance to process the input.

Parameters:

• EventParms - information about the input event.

Returns:

TRUE to indicate that this input key was processed; no further processing will occur on this input key event.

OnBack

function OnBack ()

Callback for when the user wants to exit the scene.

OnButtonBar_Back

function bool OnButtonBar_Back (UIScreenObject InButton, int PlayerIndex)

Buttonbar Callbacks.

OnButtonBar_Details

function bool OnButtonBar_Details (UIScreenObject InButton, int PlayerIndex)

OnButtonBar_ToggleGameMode

function bool OnButtonBar_ToggleGameMode (UIScreenObject InButton, int PlayerIndex)

OnButtonBar_ToggleMatchType

function bool OnButtonBar_ToggleMatchType (UIScreenObject InButton, int PlayerIndex)

OnButtonBar_ToggleView

function bool OnButtonBar_ToggleView (UIScreenObject InButton, int PlayerIndex)

OnDetails

function OnDetails ()

Displays the details page for the currently selected leaderboard player.

OnRankListChanged

function OnRankListChanged ()

OnStatsList_SubmitSelection

function OnStatsList_SubmitSelection (UIList Sender, optional int PlayerIndex)

Callback for when the user submits the currently selected list item.

OnStatsReadComplete

function OnStatsReadComplete (bool bWasSuccessful)

Callback for when the stats read has completed.

OnToggleGameMode

function OnToggleGameMode ()

Toggles the current game mode.

OnToggleMatchType

function OnToggleMatchType ()

Toggles the current match type.

OnToggleView

function OnToggleView ()

Toggles the current view type

RefreshStats

function RefreshStats ()

Refreshes the leaderboard stats list.

SetupButtonBar

function SetupButtonBar ()

Overrides: UTUIFrontEnd.SetupButtonBar

Setup the scene's button bar.