Gah - a solution with more questions. – EntropicLqd

UE3:UTUIFrontEnd_Leaderboards (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
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[edit]

bAreButtonsDisabled[edit]

Type: bool

If buttons are disabled due to pending online queries

CurrentPlayerIndex[edit]

Type: int

Index of the player we went to get detailed stats about

DetailsScene[edit]

Type: string

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

Default value: "UI_Scenes_FrontEnd.Scenes.PlayerStatsDetails"

MatchTypeLabel[edit]

Type: UILabel

Modifiers: transient

MatchType label.

RefreshingLabel[edit]

Type: UILabel

Modifiers: transient

Refreshing label.

StatsDataStore[edit]

Type: UTDataStore_OnlineStats

Modifiers: transient

Reference to the stats datastore.

StatsInterface[edit]

Type: OnlineStatsInterface

Modifiers: transient

Reference to the stats interface.

StatsList[edit]

Type: UIList

Modifiers: transient

List of stats results.

ViewTypeLabel[edit]

Type: UILabel

Modifiers: transient

ViewType label.

Subobjects[edit]

SceneEventComponent[edit]

Class: Engine.UIComp_Event

Inherits from: UTUIFrontEnd.SceneEventComponent

No new values.

Functions[edit]

Events[edit]

PostInitialize[edit]

event PostInitialize ()

Overrides: UTUIFrontEnd.PostInitialize

PostInitialize event - Sets delegates for the scene.

SceneActivated[edit]

event SceneActivated (bool bInitialActivation)

Overrides: UTUIFrontEnd.SceneActivated

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

Other instance functions[edit]

HandleInputKey[edit]

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[edit]

function OnBack ()

Callback for when the user wants to exit the scene.

OnButtonBar_Back[edit]

function bool OnButtonBar_Back (UIScreenObject InButton, int PlayerIndex)

Buttonbar Callbacks.

OnButtonBar_Details[edit]

function bool OnButtonBar_Details (UIScreenObject InButton, int PlayerIndex)


OnButtonBar_ToggleGameMode[edit]

function bool OnButtonBar_ToggleGameMode (UIScreenObject InButton, int PlayerIndex)


OnButtonBar_ToggleMatchType[edit]

function bool OnButtonBar_ToggleMatchType (UIScreenObject InButton, int PlayerIndex)


OnButtonBar_ToggleView[edit]

function bool OnButtonBar_ToggleView (UIScreenObject InButton, int PlayerIndex)


OnDetails[edit]

function OnDetails ()

Displays the details page for the currently selected leaderboard player.

OnRankListChanged[edit]

function OnRankListChanged ()


OnStatsList_SubmitSelection[edit]

function OnStatsList_SubmitSelection (UIList Sender, optional int PlayerIndex)

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

OnStatsReadComplete[edit]

function OnStatsReadComplete (bool bWasSuccessful)

Callback for when the stats read has completed.

OnToggleGameMode[edit]

function OnToggleGameMode ()

Toggles the current game mode.

OnToggleMatchType[edit]

function OnToggleMatchType ()

Toggles the current match type.

OnToggleView[edit]

function OnToggleView ()

Toggles the current view type

RefreshStats[edit]

function RefreshStats ()

Refreshes the leaderboard stats list.

SetupButtonBar[edit]

function SetupButtonBar ()

Overrides: UTUIFrontEnd.SetupButtonBar

Setup the scene's button bar.