UE3:UIDataProvider_OnlineProfileSettings (UDK)

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

Package: 

Engine

This class in other games:

UT3

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

Default values

Property	Value
ProviderName	'ProfileData'

Instance functions

AddReadCompleteDelegate

function AddReadCompleteDelegate (OnlinePlayerInterface PlayerInterface, byte LocalUserNum)

Overrides: UIDataProvider_OnlinePlayerStorage.AddReadCompleteDelegate

Sets the delegate used to notify the gameplay code that the last read request has completed

Parameters:

• PlayerInterface - is the OnlinePlayerInterface used
• LocalUserNum - which user to watch for read complete notifications

ClearReadCompleteDelegate

function ClearReadCompleteDelegate (OnlinePlayerInterface PlayerInterface, byte LocalUserNum)

Overrides: UIDataProvider_OnlinePlayerStorage.ClearReadCompleteDelegate

Clears the delegate used to notify the gameplay code that the last read request has completed

Parameters:

• PlayerInterface - is the OnlinePlayerInterface used
• LocalUserNum - which user to stop watching for read complete notifications

ReadData

function bool ReadData (OnlinePlayerInterface PlayerInterface, byte LocalUserNum, OnlinePlayerStorage PlayerStorage)

Overrides: UIDataProvider_OnlinePlayerStorage.ReadData

Reads the data

Parameters:

• PlayerInterface - is the OnlinePlayerInterface used
• LocalUserNum - the user that we are reading the data for
• PlayerStorage - the object to copy the results to and contains the list of items to read

Returns:

true if the call succeeds, false otherwise

WriteData

function bool WriteData (OnlinePlayerInterface PlayerInterface, byte LocalUserNum, OnlinePlayerStorage PlayerStorage)

Overrides: UIDataProvider_OnlinePlayerStorage.WriteData

Writes the online data for a given local user to the online data store

Parameters:

• PlayerInterface - is the OnlinePlayerInterface used
• LocalUserNum - the user that we are writing the data for
• PlayerStorage - the object that contains the list of items to write

Returns:

true if the call succeeds, false otherwise