UE3:UIDataStore_OnlinePlayerData (UDK)

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

Package:

Engine

Implemented interfaces:

UIListElementProvider

This class in other games:

UT3

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

Properties

AchievementsProvider

Type: UIDataProvider_PlayerAchievements

Provides access to the list of achievements for this player

AchievementsProviderClass

Type: class<UIDataProvider_PlayerAchievements>

The class that should be created when a player is bound to this data store for providing achievements data to the UI

Default value: Class'Engine.UIDataProvider_PlayerAchievements'

AchievementsProviderClassName

Type: string

Modifiers: config

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

ClanMatesProvider

Type: UIDataProvider_OnlineClanMates

Provides access to the player's clan members list

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'

ClanMatesProviderClassName

Type: string

Modifiers: config

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

FriendMessagesProvider

Type: UIDataProvider_OnlineFriendMessages

Provides access to any friend messages

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'

FriendMessagesProviderClassName

Type: string

Modifiers: config

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

Default value: "UTGame.UTUIDataProvider_OnlineFriendMessages"

FriendsProvider

Type: UIDataProvider_OnlineFriends

Provides access to the player's online friends list

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'

FriendsProviderClassName

Type: string

Modifiers: config

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

Default value: "UTGame.UTUIDataProvider_OnlineFriends"

NumNewDownloads

Type: int

The number of new downloads for this player

NumTotalDownloads

Type: int

The total number of downloads for this player

PartyChatProvider

Type: UIDataProvider_OnlinePartyChatList

The provider instance for the party chat data

PartyChatProviderClass

Type: class<UIDataProvider_OnlinePartyChatList>

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

Default value: Class'Engine.UIDataProvider_OnlinePartyChatList'

PartyChatProviderClassName

Type: string

Modifiers: config

The name of the data provider class to use as the default for party chat members

Default value: "Engine.UIDataProvider_OnlinePartyChatList"

Player

Type: LocalPlayer

Holds the player that this provider is getting friends for

PlayerNick

Type: string

The online nick name for the player

Default value: "PlayerNickNameHere"

PlayersProvider

Type: UIDataProvider_OnlinePlayers

Provides access to the player's recent online players list

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'

PlayersProviderClassName

Type: string

Modifiers: config

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

PlayerStorageClass

Type: class<OnlinePlayerStorage>

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

PlayerStorageClassName

Type: string

Modifiers: config

The name of the OnlinePlayerStorage class to use as the default

ProfileProvider

Type: UIDataProvider_OnlineProfileSettings

Provides access to the player's profile data

ProfileSettingsClass

Type: class<OnlineProfileSettings>

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

Default value: Class'UTGame.UTProfileSettings'

ProfileSettingsClassName

Type: string

Modifiers: config

The name of the OnlineProfileSettings class to use as the default

Default value: "UTGame.UTProfileSettings"

StorageProvider

Type: UIDataProvider_OnlinePlayerStorage

Provides access to the player's storage data

Default values

Property	Value
Tag	'OnlinePlayerData'

Functions

Static events

GetCachedPlayerProfile

static event OnlineProfileSettings GetCachedPlayerProfile (int ControllerId)

Retrieves a player profile which has been cached by the online subsystem.

Parameters:

• ControllerId - the controller ID for the player to retrieve the profile for.

Returns:

a player profile which was previously created and cached by the online subsystem for the specified controller id.

GetCachedPlayerStorage

static event OnlinePlayerStorage GetCachedPlayerStorage (int ControllerId)

Retrieves a player storage which has been cached by the online subsystem.

Parameters:

• ControllerId - the controller ID for the player to retrieve the profile for.

Returns:

a player storage which was previously created and cached by the online subsystem for the specified controller id.

Native functions

OnSettingProviderChanged

native final function OnSettingProviderChanged (UIDataProvider SourceProvider, optional name SettingsName)

Handler for this data store internal settings data providers OnDataProviderPropertyChange delegate. When the setting associated with that provider is updated, issues a refresh notification which causes e.g. widgets to refresh their values.

Parameters:

• SourceProvider - the data provider that generated the notification
• SettingsName - the name of the setting that changed

Events

OnRegister

event OnRegister (LocalPlayer InPlayer)

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

Parameters:

• InPlayer - the player that we are retrieving friends for

OnUnregister

event OnUnregister ()

Clears our delegate for getting login change notifications

SaveProfileData

event bool SaveProfileData ()

Forwards the call to the provider

Other instance functions

ClearDelegates

function ClearDelegates ()

OnDownloadableContentQueryDone

function OnDownloadableContentQueryDone (bool bWasSuccessful)

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

OnLoginChange

function OnLoginChange (byte LocalUserNum)

Refetches the player's nick name from the online subsystem

Parameters:

• LocalUserNum - the player that logged in/out

OnPlayerDataChange

function OnPlayerDataChange ()

Refetches the player's nick name from the online subsystem

RegisterDelegates

function RegisterDelegates ()

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