I search for solutions in this order: Past Code, Unreal Source, Wiki, BUF, groups.yahoo, google, screaming at monitor. – RegularX

UE3:UIDataStore_OnlineStats (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
UT3 Object >> UIRoot >> UIDataProvider >> UIDataStore >> UIDataStore_Remote >> UIDataStore_OnlineStats

Contents

Package: 
Engine
Implemented interfaces
UIListElementCellProvider, UIListElementProvider
Direct subclass:
UTDataStore_OnlineStats
This class in other games:
UDK

This class is responsible for mapping properties in an OnlineStatsRead class to the UI. It maintains a set of different read objects that are switched between at run time. This allows you to show leaderboards by age (one week, month, year, etc.) from the same UI by having this data store just use different query objects

NOTE: Each game needs to derive at least one class from this one in order to expose the game's specific stats class(es)

[edit] Properties

[edit] CurrentReadType

Type: EStatsFetchType

The current type to read

[edit] PlayerInterface

Type: OnlinePlayerInterface

The player interface to use for performing player specific functions

[edit] PlayerNickData

Type: PlayerNickMetaData

Modifiers: const


Default value:

Member Value
PlayerNickColumnName "Player Nick"
PlayerNickName 'Player Nick'

[edit] RankNameMetaData

Type: RankMetaData

Modifiers: const

Cached FName for faster compares

Default value:

Member Value
RankColumnName "Rank"
RankName 'Rank'

[edit] StatsInterface

Type: OnlineStatsInterface

The stats interface to use for reading stats data

[edit] StatsRead

Type: OnlineStatsRead

The OnlineStatsRead object that will be exposed to the UI. One of the objects from the array above. The game specific version of this class needs to change the current setting based on its rules

[edit] StatsReadClasses

Type: array<class<OnlineStatsRead> >

The OnlineStatsRead derived classes to load and populate the UI with

[edit] StatsReadName

Type: name

Modifiers: const

Cached FName for faster compares

Default value: 'StatsReadResults'

[edit] StatsReadObjects

Type: array<OnlineStatsRead>

The set of stats read objects that will be used for display purposes

[edit] TotalRowsName

Type: name

Modifiers: const

Cached FName for faster compares

Default value: 'TotalRows'

[edit] Default values

Property Value
Tag 'OnlineStats'

[edit] Enums

[edit] EStatsFetchType

The types of stats to fetch

SFT_Player 
The player's stats
SFT_CenteredOnPlayer 
The player and people above/below them
SFT_Friends 
The player's frinds list and them
SFT_TopRankings 
The top n ranked players

[edit] Structs

[edit] PlayerNickMetaData

Modifiers: native

name PlayerNickName 
Cached FName for faster compares
string PlayerNickColumnName 
The name displayed in column headings in the UI

[edit] RankMetaData

Modifiers: native

name RankName 
Cached FName for faster compares
string RankColumnName 
The name displayed in column headings in the UI

[edit] Functions

[edit] Native functions

[edit] SortResultsByRank

native function SortResultsByRank ()

Sorts the returned results by their rank (lowest to highest)

[edit] Events

[edit] Init

event Init ()

Grabs the interface pointers and sets the read delegate

[edit] RefreshStats

event bool RefreshStats (byte ControllerIndex)

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

[edit] ShowGamercard

event bool ShowGamercard (byte ConrollerIndex, int ListIndex)

Displays the gamercard for the specified list index

Parameters:

  • ConrollerIndex - the ControllerId for the player displaying the gamercard
  • ListIndex - the item in the list to display the gamercard for

[edit] Other instance functions

[edit] OnReadComplete

function OnReadComplete (bool bWasSuccessful)

Called by the online subsystem when the stats read has completed

Parameters:

  • bWasSuccessful - whether the stats read was successful or not

[edit] SetStatsReadInfo

function SetStatsReadInfo ()

This function should be overloaded with a game specific version. It is used to determine which search class to use and in which mode