There is no spoon

From Unreal Wiki, The Unreal Engine Documentation Site

Object >> UIRoot >> UIDataProvider >> UIDataStore >> UIDataStore_Remote >> UIDataStore_OnlinePlayerData

Package: 

Engine

Implemented interfaces: 

UIListElementProvider

This class in other games:

UDK

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

[edit] Properties

[edit] bIsRankingQueryInProgress

Type: bool

Are we in the middle of a query to get the player ranking

[edit] ClanMatesProvider

Type: UIDataProvider_OnlineClanMates

Provides access to the player's clan members list

[edit] ClanMatesProviderClass

Type: class<UIDataProvider_OnlineClanMates>

The class that should be created when a player is bound to this data store

Default value: Class'Engine.UIDataProvider_OnlineClanMates'

[edit] ClanMatesProviderClassName

Type: string

Modifiers: config

The name of the data provider class to use as the default for clan mates

[edit] CurrentRankingQuery

Type: OnlineStatsRead

An instance of the ranking query OnlineStatsRead class

[edit] FriendMessagesProvider

Type: UIDataProvider_OnlineFriendMessages

Provides access to any friend messages

[edit] FriendMessagesProviderClass

Type: class<UIDataProvider_OnlineFriendMessages>

The class that should be created when a player is bound to this data store

Default value: Class'UTGame.UTUIDataProvider_OnlineFriendMessages'

[edit] FriendMessagesProviderClassName

Type: string

Modifiers: config

The name of the data provider class to use as the default for messages

Default value: "UTGame.UTUIDataProvider_OnlineFriendMessages"

[edit] FriendsProvider

Type: UIDataProvider_OnlineFriends

Provides access to the player's online friends list

[edit] FriendsProviderClass

Type: class<UIDataProvider_OnlineFriends>

The class that should be created when a player is bound to this data store

Default value: Class'UTGame.UTUIDataProvider_OnlineFriends'

[edit] FriendsProviderClassName

Type: string

Modifiers: config

The name of the data provider class to use as the default for friends

Default value: "UTGame.UTUIDataProvider_OnlineFriends"

[edit] NumNewDownloads

Type: int

The number of new downloads for this player

[edit] NumTotalDownloads

Type: int

The total number of downloads for this player

[edit] Player

Type: LocalPlayer

Holds the player that this provider is getting friends for

[edit] PlayerNick

Type: string

The online nick name for the player

Default value: "PlayerNickNameHere"

[edit] PlayerRanking

Type: int

The ranking value of the logged in player

[edit] PlayerRankingLastQueryTime

Type: float

The timestamp (sec) when the PlayerRanking was last successfully recorded

[edit] PlayerRankingQueryClass

Type: class<OnlineStatsRead>

Class used to create an OnlineStatsRead object for the ranking query

Default value: Class'UTGame.UTStatReadPlayerRatingPure'

[edit] PlayerRankingQueryClassName

Type: string

Modifiers: config

The OnlineStatsRead class that will retrieve the ranking value

Default value: "UTGame.UTStatReadPlayerRatingPure"

[edit] PlayersProvider

Type: UIDataProvider_OnlinePlayers

Provides access to the player's recent online players list

[edit] PlayersProviderClass

Type: class<UIDataProvider_OnlinePlayers>

The class that should be created when a player is bound to this data store

Default value: Class'Engine.UIDataProvider_OnlinePlayers'

[edit] PlayersProviderClassName

Type: string

Modifiers: config

The name of the data provider class to use as the default for recent players list

[edit] ProfileProvider

Type: UIDataProvider_OnlineProfileSettings

Provides access to the player's profile data

[edit] ProfileSettingsClass

Type: class<OnlineProfileSettings>

The class that should be created when a player is bound to this data store

Default value: Class'UTGame.UTProfileSettings'

[edit] ProfileSettingsClassName

Type: string

Modifiers: config

The name of the OnlineProfileSettings class to use as the default

Default value: "UTGame.UTProfileSettings"

[edit] Default values

[edit] Functions

[edit] Native functions

[edit] StorePlayerRankingQueryValue

Stores the player rating stored in the OnlineStatsRead *

[edit] Events

[edit] OnRegister

Binds the player to this provider. Starts the async friends list gathering

Parameters:

• InPlayer - the player that we are retrieving friends for

[edit] OnUnregister

Clears our delegate for getting login change notifications

[edit] RegisterDelegates

Registers the delegates with the providers so we can know when async data changes

[edit] SaveProfileData

Forwards the call to the provider

[edit] Other instance functions

[edit] OnDownloadableContentQueryDone

Caches the downloadable content info for the player we're bound to

Parameters:

• bWasSuccessful - true if the async action completed without error, false if there was an error

[edit] OnLoginChange

Refetches the player's nick name from the online subsystem

[edit] OnPlayerDataChange

Refetches the player's nick name from the online subsystem

[edit] OnProviderChanged

Handles notification that one of our providers has changed and in turn notifies the UI system

Parameters:

• SourceProvider - the data provider that generated the notification
• PropTag - the property that changed

[edit] OnReadOnlinePlayerRankingComplete

Delegate called when a player rating stats read has completed

[edit] QueryLoggedInPlayerRanking

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