UE3:UTDataStore_OnlineStats (UT3)

Object >> UIRoot >> UIDataProvider >> UIDataStore >> UIDataStore_Remote >> UIDataStore_OnlineStats >> UTDataStore_OnlineStats

Package: 

UTGame

Implemented interfaces: 

UIListElementCellProvider, UIListElementProvider

This class in other games:

UDK

Specific derivation of UIDataStore_OnlineStats to expose the TDM leaderboards

Constants

See UTDataStore_OnlineStats constants.

Properties

bInQueuePump

Type: bool

Modifiers: transient

Whether or not we are currently pumping the read queue.

bInRead

Type: bool

Modifiers: transient

Whether or not we are currently in a read.

CurrentDetailsReadType

Type: EStatsDetailsReadType

Modifiers: transient

DetailedStatsRowIndex

Type: int

Modifiers: transient

Row index to use for detailed stats info

DetailsPlayerNetId

Type: OnlineSubsystem.UniqueNetId

Modifiers: transient

NetId of the player we are retrieving detailed stats on.

DetailsPlayerNick

Type: string

Modifiers: transient

Nick of the player we are retrieving detailed stats on.

GameModeId

Type: int

Modifiers: transient

Game mode we are currently displaying stats for

GeneralProvider

Type: UTUIDataProvider_StatsGeneral

Modifiers: transient

Reference to the dataprovider that will provide general stats details for a stats row.

LeaderboardSettings

Type: Settings

The set of settings that are to be exposed to the UI for filtering the leaderboards

LeaderboardSettingsClass

Type: class<Settings>

The class to load and instance

Default value: Class'UTGame.UTLeaderboardSettings'

MatchTypeId

Type: int

Modifiers: transient

Match Type we are currently displaying stats for

ReadQueue

Type: array<OnlineStatsRead>

Modifiers: transient

Array of stat events to read in order.

RewardsProvider

Type: UTUIDataProvider_StatsRewards

Modifiers: transient

Reference to the dataprovider that will provide rewards stats details for a stats row.

SettingsProvider

Type: UIDataProvider_Settings

The data provider that will expose the leaderboard settings to the ui

StatsReadObjectStartIndex

Type: int

Modifiers: transient

Start index for this set of online stats currently being read

VehiclesProvider

Type: UTUIDataProvider_StatsVehicles

Modifiers: transient

Reference to the dataprovider that will provide Vehicle stats details for a stats row.

VehicleWeaponsProvider

Type: UTUIDataProvider_StatsVehicleWeapons

Modifiers: transient

Reference to the dataprovider that will provide Vehicle Weapons stats details for a stats row.

WeaponsProvider

Type: UTUIDataProvider_StatsWeapons

Modifiers: transient

Reference to the dataprovider that will provide weapons details for a stats row.

Default values

Property	Value
StatsReadClasses[0]	Class'UTGame.UTLeaderboardReadDM'
StatsReadClasses[1]	Class'UTGame.UTLeaderboardReadWeaponsDM'
StatsReadClasses[2]	Class'UTGame.UTLeaderboardReadVehiclesDM'
StatsReadClasses[3]	Class'UTGame.UTLeaderboardReadVehicleWeaponsDM'
StatsReadClasses[4]	Class'UTGame.UTLeaderboardReadPureDM'
StatsReadClasses[5]	Class'UTGame.UTLeaderboardReadWeaponsPureDM'
StatsReadClasses[6]	Class'UTGame.UTLeaderboardReadVehiclesPureDM'
StatsReadClasses[7]	Class'UTGame.UTLeaderboardReadVehicleWeaponsPureDM'
Tag	'UTLeaderboards'

Enums

EStatsDetailsReadType

Different read types.

UTSR_GeneralAndRewards 

UTSR_Weapons 

UTSR_Vehicles 

UTSR_VehicleWeapons 

Delegates

OnStatsReadComplete

delegate OnStatsReadComplete (bool bWasSuccessful)

Delegate used to notify the caller when stats read has completed

Functions

Events

GetElementProviderFromName

event UTUIDataProvider_StatsElementProvider GetElementProviderFromName (name FieldName)

Parameters:

• FieldName - Name of the field to return the provider for.

Returns:

Returns a stats element provider given its field name.

RefreshStats

event bool RefreshStats (byte ControllerIndex)

Overrides: UIDataStore_OnlineStats.RefreshStats

Tells the online subsystem to re-read the stats data using the current read mode and the current object to add the results to

Other instance functions

AddToReadQueue

function AddToReadQueue (OnlineStatsRead ReadObj)

Adds a read object to the queue of stuff to read.

Parameters:

• ReadObj - Object to add to queue.

GetReadObjectFromType

function OnlineStatsRead GetReadObjectFromType (EStatsDetailsReadType InStatsType)

Parameters:

• InStatsType - Type to use to determine which read object to return.

Returns:

Returns a read object depending on the current match settings.

GetReadObjectIndex

function int GetReadObjectIndex ()

Returns:

Returns the current read object index.

OnReadComplete

function OnReadComplete (bool bWasSuccessful)

Overrides: UIDataStore_OnlineStats.OnReadComplete

Called by the online subsystem when the stats read has completed

Parameters:

• bWasSuccessful - whether the stats read was successful or not

ResetToDefaultRead

function ResetToDefaultRead ()

Resets the stats read object to use the general provider so that the data exposed to the UI is the full list of stats.

SetDetailedStatsRowIndex

function SetDetailedStatsRowIndex (int InIndex)

Sets the index for the current player, so we know which stats row to use for results.

SetStatsReadInfo

function SetStatsReadInfo ()

Overrides: UIDataStore_OnlineStats.SetStatsReadInfo

Game specific function that figures out what type of search to do

TryPumpingQueue

function TryPumpingQueue ()

Attempts to start a stats read using the queue.