UE3:UIDataProvider_OnlineProfileSettings (UT3)

Object >> UIRoot >> UIDataProvider >> UIDataProvider_OnlinePlayerDataBase >> UIDataProvider_OnlineProfileSettings

Package: 

Engine

This class in other games:

UDK

This class is responsible for mapping properties in an OnlineGameSettings object to something that the UI system can consume.

Properties

bWasErrorLastRead

Type: bool

If there was an error, it was possible the read was already in progress. This indicates to re-read upon a good completion

Profile

Type: OnlineProfileSettings

The profile settings that are used to load/save with the online subsystem

ProfileSettingsArrayProviders

Type: array<ProfileSettingsArrayProvider>

The list of mappings from settings id to their provider

ProviderName

Type: name

Modifiers: const

For displaying in the provider tree

Default value: 'ProfileData'

Default values

Property	Value
WriteAccessType	ACCESS_WriteAll

Structs

ProfileSettingsArrayProvider

Modifiers: native

Keeps a list of providers for each profile settings id

int ProfileSettingsId 

The profile settings id that this provider is for

name ProfileSettingsName 

Cached to avoid extra look ups

UIDataProvider_OnlineProfileSettingsArray Provider 

The provider object to expose the data with

Functions

Events

OnRegister

event OnRegister (LocalPlayer InPlayer)

Overrides: UIDataProvider_OnlinePlayerDataBase.OnRegister

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 ()

Overrides: UIDataProvider_OnlinePlayerDataBase.OnUnregister

Clears our delegate for getting login change notifications

SaveProfileData

event bool SaveProfileData ()

Writes the profile data to the online subsystem for this user

Other instance functions

OnLoginChange

function OnLoginChange ()

Executes a refetching of the profile data when the login for this player changes

OnReadProfileComplete

function OnReadProfileComplete (bool bWasSuccessful)

Handles the notification that the async read of the profile data is done

Parameters:

• bWasSuccessful - whether the call succeeded or not