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

Engine.UIDataStore_OnlinePlayerData

Extends
UIDataStore_Remote
Modifiers
native ( inherit ) implements ( UIListElementProvider ) config ( Engine ) transient

This class is responsible for retrieving the friends list from the online subsystem and populating the UI with that data.

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

Variables Summary
boolbIsRankingQueryInProgress
UIDataProvider_OnlineClanMatesClanMatesProvider
class<UIDataProvider_OnlineClanMates>ClanMatesProviderClass
stringClanMatesProviderClassName
OnlineStatsReadCurrentRankingQuery
UIDataProvider_OnlineFriendMessagesFriendMessagesProvider
class<UIDataProvider_OnlineFriendMessages>FriendMessagesProviderClass
stringFriendMessagesProviderClassName
UIDataProvider_OnlineFriendsFriendsProvider
class<UIDataProvider_OnlineFriends>FriendsProviderClass
stringFriendsProviderClassName
intNumNewDownloads
intNumTotalDownloads
LocalPlayerPlayer
stringPlayerNick
intPlayerRanking
floatPlayerRankingLastQueryTime
class<OnlineStatsRead>PlayerRankingQueryClass
stringPlayerRankingQueryClassName
UIDataProvider_OnlinePlayersPlayersProvider
class<UIDataProvider_OnlinePlayers>PlayersProviderClass
stringPlayersProviderClassName
UIDataProvider_OnlineProfileSettingsProfileProvider
class<OnlineProfileSettings>ProfileSettingsClass
stringProfileSettingsClassName
Inherited Variables from Engine.UIDataStore
RefreshSubscriberNotifies, Tag

Functions Summary
function OnDownloadableContentQueryDone (bool bWasSuccessful))
function OnLoginChange ()))
function OnPlayerDataChange ()))
function OnProviderChanged (UIDataProvider SourceProvider, optional name PropTag))
function OnReadOnlinePlayerRankingComplete (bool bWasSuccessful))
event OnRegister (LocalPlayer InPlayer))
event OnUnregister ()))
functionbool QueryLoggedInPlayerRanking ()))
event RegisterDelegates ()))
eventbool SaveProfileData ()))
function StorePlayerRankingQueryValue (OnlineStatsRead RankingQuery)
Inherited Functions from Engine.UIDataStore
GetDataStoreClient, NotifyGameSessionEnded, OnCommit, RefreshSubscribers, Registered, SubscriberAttached, SubscriberDetached, Unregistered


Variables Detail

bIsRankingQueryInProgress Source code

var bool bIsRankingQueryInProgress;
Are we in the middle of a query to get the player ranking

ClanMatesProvider Source code

var UIDataProvider_OnlineClanMates ClanMatesProvider;
Provides access to the player's clan members list

ClanMatesProviderClass Source code

var class<UIDataProvider_OnlineClanMates> ClanMatesProviderClass;
The class that should be created when a player is bound to this data store

ClanMatesProviderClassName Source code

var config string ClanMatesProviderClassName;
The name of the data provider class to use as the default for clan mates

CurrentRankingQuery Source code

var OnlineStatsRead CurrentRankingQuery;
An instance of the ranking query OnlineStatsRead class

FriendMessagesProvider Source code

var UIDataProvider_OnlineFriendMessages FriendMessagesProvider;
Provides access to any friend messages

FriendMessagesProviderClass Source code

var class<UIDataProvider_OnlineFriendMessages> FriendMessagesProviderClass;
The class that should be created when a player is bound to this data store

FriendMessagesProviderClassName Source code

var config string FriendMessagesProviderClassName;
The name of the data provider class to use as the default for messages

FriendsProvider Source code

var UIDataProvider_OnlineFriends FriendsProvider;
Provides access to the player's online friends list

FriendsProviderClass Source code

var class<UIDataProvider_OnlineFriends> FriendsProviderClass;
The class that should be created when a player is bound to this data store

FriendsProviderClassName Source code

var config string FriendsProviderClassName;
The name of the data provider class to use as the default for friends

NumNewDownloads Source code

var int NumNewDownloads;
The number of new downloads for this player

NumTotalDownloads Source code

var int NumTotalDownloads;
The total number of downloads for this player

Player Source code

var LocalPlayer Player;
Holds the player that this provider is getting friends for

PlayerNick Source code

var string PlayerNick;
The online nick name for the player

PlayerRanking Source code

var int PlayerRanking;
The ranking value of the logged in player

PlayerRankingLastQueryTime Source code

var float PlayerRankingLastQueryTime;
The timestamp (sec) when the PlayerRanking was last successfully recorded

PlayerRankingQueryClass Source code

var class<OnlineStatsRead> PlayerRankingQueryClass;
Class used to create an OnlineStatsRead object for the ranking query

PlayerRankingQueryClassName Source code

var config string PlayerRankingQueryClassName;
The OnlineStatsRead class that will retrieve the ranking value

PlayersProvider Source code

var UIDataProvider_OnlinePlayers PlayersProvider;
Provides access to the player's recent online players list

PlayersProviderClass Source code

var class<UIDataProvider_OnlinePlayers> PlayersProviderClass;
The class that should be created when a player is bound to this data store

PlayersProviderClassName Source code

var config string PlayersProviderClassName;
The name of the data provider class to use as the default for recent players list

ProfileProvider Source code

var UIDataProvider_OnlineProfileSettings ProfileProvider;
Provides access to the player's profile data

ProfileSettingsClass Source code

var class<OnlineProfileSettings> ProfileSettingsClass;
The class that should be created when a player is bound to this data store

ProfileSettingsClassName Source code

var config string ProfileSettingsClassName;
The name of the OnlineProfileSettings class to use as the default


Functions Detail

OnDownloadableContentQueryDone Source code

function OnDownloadableContentQueryDone ( bool bWasSuccessful) )
Caches the downloadable content info for the player we're bound to
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnLoginChange Source code

function OnLoginChange ( ) )
Refetches the player's nick name from the online subsystem

OnPlayerDataChange Source code

function OnPlayerDataChange ( ) )
Refetches the player's nick name from the online subsystem

OnProviderChanged Source code

function OnProviderChanged ( UIDataProvider SourceProvider, optional name PropTag) )
Handles notification that one of our providers has changed and in turn notifies the UI system
@param SourceProvider the data provider that generated the notification
@param PropTag the property that changed

OnReadOnlinePlayerRankingComplete Source code

function OnReadOnlinePlayerRankingComplete ( bool bWasSuccessful) )
Delegate called when a player rating stats read has completed

OnRegister Source code

event OnRegister ( LocalPlayer InPlayer) )
Binds the player to this provider. Starts the async friends list gathering
@param InPlayer the player that we are retrieving friends for

OnUnregister Source code

event OnUnregister ( ) )
Clears our delegate for getting login change notifications

QueryLoggedInPlayerRanking Source code

function bool QueryLoggedInPlayerRanking ( ) )
Queries the online system for this player's rating (1000 is new player)

RegisterDelegates Source code

event RegisterDelegates ( ) )
Registers the delegates with the providers so we can know when async data changes

SaveProfileData Source code

event bool SaveProfileData ( ) )
Forwards the call to the provider

StorePlayerRankingQueryValue Source code

native function StorePlayerRankingQueryValue ( OnlineStatsRead RankingQuery )
Stores the player rating stored in the OnlineStatsRead


Defaultproperties

defaultproperties
{
   PlayerNick="PlayerNickNameHere"
   PlayerRankingQueryClassName="UTGame.UTStatReadPlayerRatingPure"
   PlayerRankingQueryClass=Class'UTGame.UTStatReadPlayerRatingPure'
   ProfileSettingsClassName="UTGame.UTProfileSettings"
   ProfileSettingsClass=Class'UTGame.UTProfileSettings'
   FriendsProviderClassName="UTGame.UTUIDataProvider_OnlineFriends"
   FriendsProviderClass=Class'UTGame.UTUIDataProvider_OnlineFriends'
   PlayersProviderClass=Class'Engine.UIDataProvider_OnlinePlayers'
   ClanMatesProviderClass=Class'Engine.UIDataProvider_OnlineClanMates'
   FriendMessagesProviderClassName="UTGame.UTUIDataProvider_OnlineFriendMessages"
   FriendMessagesProviderClass=Class'UTGame.UTUIDataProvider_OnlineFriendMessages'
   Tag="OnlinePlayerData"
   Name="Default__UIDataStore_OnlinePlayerData"
   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.870 - Created with UnCodeX