Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

Engine.UIDataStore_OnlineStats

Extends
UIDataStore_Remote
Modifiers
native ( inherit ) implements ( UIListElementProvider , UIListElementCellProvider ) abstract transient

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)

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIDataProvider
      |   
      +-- Engine.UIDataStore
         |   
         +-- Engine.UIDataStore_Remote
            |   
            +-- Engine.UIDataStore_OnlineStats

Direct Known Subclasses:

UTDataStore_OnlineStats

Variables Summary
EStatsFetchTypeCurrentReadType
OnlinePlayerInterfacePlayerInterface
PlayerNickMetaDataPlayerNickData
RankMetaDataRankNameMetaData
OnlineStatsInterfaceStatsInterface
OnlineStatsReadStatsRead
array<class<OnlineStatsRead>>StatsReadClasses
nameStatsReadName
array<OnlineStatsRead>StatsReadObjects
nameTotalRowsName
Inherited Variables from Engine.UIDataStore
RefreshSubscriberNotifies, Tag

Enumerations Summary
EStatsFetchType
SFT_Player, SFT_CenteredOnPlayer, SFT_Friends, SFT_TopRankings,

Structures Summary
PlayerNickMetaData
PlayerNickName, PlayerNickColumnName
RankMetaData
RankName, RankColumnName

Functions Summary
event Init ()))
function OnReadComplete (bool bWasSuccessful))
eventbool RefreshStats (byte ControllerIndex))
function SetStatsReadInfo ()))
eventbool ShowGamercard (byte ConrollerIndex, nt ListIndex))
function SortResultsByRank ()
Inherited Functions from Engine.UIDataStore
GetDataStoreClient, NotifyGameSessionEnded, OnCommit, RefreshSubscribers, Registered, SubscriberAttached, SubscriberDetached, Unregistered


Variables Detail

CurrentReadType Source code

var EStatsFetchType CurrentReadType;
The current type to read

PlayerInterface Source code

var OnlinePlayerInterface PlayerInterface;
The player interface to use for performing player specific functions

PlayerNickData Source code

var const PlayerNickMetaData PlayerNickData;

RankNameMetaData Source code

var const RankMetaData RankNameMetaData;
Cached FName for faster compares

StatsInterface Source code

var OnlineStatsInterface StatsInterface;
The stats interface to use for reading stats data

StatsRead Source code

var OnlineStatsRead StatsRead;
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

StatsReadClasses Source code

var array<class<OnlineStatsRead>> StatsReadClasses;
The OnlineStatsRead derived classes to load and populate the UI with

StatsReadName Source code

var const name StatsReadName;
Cached FName for faster compares

StatsReadObjects Source code

var array<OnlineStatsRead> StatsReadObjects;
The set of stats read objects that will be used for display purposes

TotalRowsName Source code

var const name TotalRowsName;
Cached FName for faster compares


Enumerations Detail

EStatsFetchType Source code

enum EStatsFetchType
{
SFT_Player, SFT_CenteredOnPlayer, SFT_Friends, SFT_TopRankings,
};
The types of stats to fetch


Structures Detail

PlayerNickMetaData Source code

struct PlayerNickMetaData
{
var localized string PlayerNickColumnName;
var const name PlayerNickName;
};

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

RankMetaData Source code

struct RankMetaData
{
var localized string RankColumnName;
var const name RankName;
};

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


Functions Detail

Init Source code

event Init ( ) )
Grabs the interface pointers and sets the read delegate

OnReadComplete Source code

function OnReadComplete ( bool bWasSuccessful) )
Called by the online subsystem when the stats read has completed
@param bWasSuccessful whether the stats read was successful or not

RefreshStats Source code

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

SetStatsReadInfo Source code

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

ShowGamercard Source code

event bool ShowGamercard ( byte ConrollerIndex,int ListIndex) )
Displays the gamercard for the specified list index
@param ConrollerIndex the ControllerId for the player displaying the gamercard
@param ListIndex the item in the list to display the gamercard for

SortResultsByRank Source code

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


Defaultproperties

defaultproperties
{
   StatsReadName="StatsReadResults"
   PlayerNickData=(PlayerNickName="Player Nick",PlayerNickColumnName="Player Nick")
   RankNameMetaData=(RankName="Rank",RankColumnName="Rank")
   TotalRowsName="TotalRows"
   Tag="OnlineStats"
   Name="Default__UIDataStore_OnlineStats"
   ObjectArchetype=UIDataStore_Remote'Engine.Default__UIDataStore_Remote'
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:46.881 - Created with UnCodeX