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

Functions Summary
		ClearDelegates ()))
	OnlineProfileSettings	GetCachedPlayerProfile (int ControllerId ))
	OnlinePlayerStorage	GetCachedPlayerStorage (int ControllerId ))
		OnLoginChange (byte LocalUserNum))
		OnPlayerDataChange ()))
		OnRegister (LocalPlayer InPlayer))
		OnSettingProviderChanged (UIDataProvider SourceProvider, optional name SettingsName)
		OnUnregister ()))
		RegisterDelegates ()))

AchievementsProvider Source code

Provides access to the list of achievements for this player

AchievementsProviderClass Source code

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

AchievementsProviderClassName Source code

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

FriendMessagesProvider Source code

Provides access to any friend messages

FriendMessagesProviderClass Source code

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

FriendMessagesProviderClassName Source code

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

FriendsProvider Source code

Provides access to the player's online friends list

FriendsProviderClass Source code

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

FriendsProviderClassName Source code

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

PartyChatProvider Source code

The provider instance for the party chat data

PartyChatProviderClass Source code

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

PartyChatProviderClassName Source code

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

PlayerControllerId Source code

Holds the player controller that this data store is associated with

PlayerNick Source code

The online nick name for the player

PlayerStorageClass Source code

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

PlayerStorageClassName Source code

The name of the OnlinePlayerStorage class to use as the default

ProfileProvider Source code

Provides access to the player's profile data

ProfileProviderClass Source code

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

ProfileProviderClassName Source code

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

ProfileSettingsClass Source code

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

ProfileSettingsClassName Source code

The name of the OnlineProfileSettings class to use as the default

StorageProvider Source code

Provides access to the player's storage data

StorageProviderClass Source code

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

StorageProviderClassName Source code

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

ClearDelegates Source code

GetCachedPlayerProfile Source code

Retrieves a player profile which has been cached by the online subsystem.
@param ControllerId the controller ID for the player to retrieve the profile for.
@return a player profile which was previously created and cached by the online subsystem for the specified controller id.

GetCachedPlayerStorage Source code

Retrieves a player storage which has been cached by the online subsystem.
@param ControllerId the controller ID for the player to retrieve the profile for.
@return a player storage which was previously created and cached by the online subsystem for the specified controller id.

OnLoginChange Source code

Refetches the player's nick name from the online subsystem
@param LocalUserNum the player that logged in/out

OnPlayerDataChange Source code

Refetches the player's nick name from the online subsystem

OnRegister Source code

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

OnSettingProviderChanged Source code

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.
@param SourceProvider the data provider that generated the notification
@param SettingsName the name of the setting that changed

OnUnregister Source code

Clears our delegate for getting login change notifications

RegisterDelegates Source code

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

defaultproperties
{
	Tag=OnlinePlayerData
	
	PlayerNick="PlayerNickNameHere"
	PlayerControllerId=-1
}