Difference between revisions of "UE3:UTDataStore OnlineStats (UDK)"

Revision as of 11:47, 6 November 2009 (edit) (Talk)		Latest revision as of 06:30, 17 January 2010 (edit) (undo) Wormbo (Talk | contribs) (class was removed)
Line 10:		Line 10:
	| interface2 = UIListElementProvider		| interface2 = UIListElementProvider
	}}		}}
−	{{autogenerated}}	+	{{delete|class no longer exists}}
	Specific derivation of UIDataStore_OnlineStats to expose the TDM leaderboards		Specific derivation of UIDataStore_OnlineStats to expose the TDM leaderboards

---

Latest revision as of 06:30, 17 January 2010

Package: 

UTGame

Implemented interfaces: 

UIListElementCellProvider, UIListElementProvider

This class in other games:

UT3

This page has been proposed for deletion. The reason given is: class no longer exists If you think this page should be kept, please state a reason on its talk page.

Specific derivation of UIDataStore_OnlineStats to expose the TDM leaderboards

Constants[edit]

See UTDataStore_OnlineStats constants.

Properties[edit]

bInQueuePump[edit]

Type: bool

Modifiers: transient

Whether or not we are currently pumping the read queue.

bInRead[edit]

Type: bool

Modifiers: transient

Whether or not we are currently in a read.

CurrentDetailsReadType[edit]

Type: EStatsDetailsReadType

Modifiers: transient

DetailedStatsRowIndex[edit]

Type: int

Modifiers: transient

Row index to use for detailed stats info

DetailsPlayerNetId[edit]

Type: OnlineSubsystem.UniqueNetId

Modifiers: transient

NetId of the player we are retrieving detailed stats on.

DetailsPlayerNick[edit]

Type: string

Modifiers: transient

Nick of the player we are retrieving detailed stats on.

GameModeId[edit]

Type: int

Modifiers: transient

Game mode we are currently displaying stats for

GeneralProvider[edit]

Type: UTUIDataProvider_StatsGeneral

Modifiers: transient

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

LeaderboardSettings[edit]

Type: Settings

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

LeaderboardSettingsClass[edit]

Type: class<Settings>

The class to load and instance

Default value: Class'UTGame.UTLeaderboardSettings'

MatchTypeId[edit]

Type: int

Modifiers: transient

Match Type we are currently displaying stats for

ReadQueue[edit]

Type: array<OnlineStatsRead>

Modifiers: transient

Array of stat events to read in order.

RewardsProvider[edit]

Type: UTUIDataProvider_StatsRewards

Modifiers: transient

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

SettingsProvider[edit]

Type: UIDataProvider_Settings

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

StatsReadObjectStartIndex[edit]

Type: int

Modifiers: transient

Start index for this set of online stats currently being read

VehiclesProvider[edit]

Type: UTUIDataProvider_StatsVehicles

Modifiers: transient

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

VehicleWeaponsProvider[edit]

Type: UTUIDataProvider_StatsVehicleWeapons

Modifiers: transient

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

WeaponsProvider[edit]

Type: UTUIDataProvider_StatsWeapons

Modifiers: transient

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

Default values[edit]

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

EStatsDetailsReadType[edit]

Different read types.

UTSR_GeneralAndRewards 

UTSR_Weapons 

UTSR_Vehicles 

UTSR_VehicleWeapons 

Delegates[edit]

OnStatsReadComplete[edit]

Delegate used to notify the caller when stats read has completed

Functions[edit]

Events[edit]

GetElementProviderFromName[edit]

RefreshStats[edit]

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

AddToReadQueue[edit]

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

Parameters:

• ReadObj - Object to add to queue.

GetReadObjectFromType[edit]

Parameters:

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

Returns:

Returns a read object depending on the current match settings.

GetReadObjectIndex[edit]

Returns:

Returns the current read object index.

OnReadComplete[edit]

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

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

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

SetStatsReadInfo[edit]

Overrides: UIDataStore_OnlineStats.SetStatsReadInfo

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

TryPumpingQueue[edit]

Attempts to start a stats read using the queue.