| Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation |
| previous class next class | frames no frames | |||||
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
UTDataStore_OnlineStats
| 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 | ||
|---|---|---|
![]() | Init ())) | |
![]() | OnReadComplete (bool bWasSuccessful)) | |
![]() | bool | RefreshStats (byte ControllerIndex)) |
![]() | SetStatsReadInfo ())) | |
![]() | bool | ShowGamercard (byte ConrollerIndex, nt ListIndex)) |
![]() | SortResultsByRank () | |
| Inherited Functions from Engine.UIDataStore |
|---|
| GetDataStoreClient, NotifyGameSessionEnded, OnCommit, RefreshSubscribers, Registered, SubscriberAttached, SubscriberDetached, Unregistered |
| Variables Detail |
|---|
The current type to read
The player interface to use for performing player specific functions
Cached FName for faster compares
The stats interface to use for reading stats data
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
The OnlineStatsRead derived classes to load and populate the UI with
Cached FName for faster compares
The set of stats read objects that will be used for display purposes
Cached FName for faster compares
| Enumerations Detail |
|---|
The types of stats to fetch
| Structures Detail |
|---|
var localized string PlayerNickColumnName;};
var const name PlayerNickName;
PlayerNickColumnName:The name displayed in column headings in the UIPlayerNickName:Cached FName for faster compares
RankColumnName:The name displayed in column headings in the UIRankName:Cached FName for faster compares
| Functions Detail |
|---|
Init Source codeGrabs the interface pointers and sets the read delegate
OnReadComplete Source codeCalled by the online subsystem when the stats read has completed
@param bWasSuccessful whether the stats read was successful or not
RefreshStats Source codeTells 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 codeThis 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 codeDisplays 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 codeSorts 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 | UnrealScript Documentation |
| previous class next class | frames no frames | |||||