Engine.UIDataProvider_OnlineProfileSettings

Extends

UIDataProvider_OnlinePlayerStorage

Modifiers

config ( Game ) native ( inherit ) dependson ( OnlineSubsystem ) transient

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

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIDataProvider
      |   
      +-- Engine.UIDataProvider_OnlinePlayerDataBase
         |   
         +-- Engine.UIDataProvider_OnlinePlayerStorage
            |   
            +-- Engine.UIDataProvider_OnlineProfileSettings

Functions Summary
		AddReadCompleteDelegate (OnlinePlayerInterface PlayerInterface, byte LocalUserNum))
		ClearReadCompleteDelegate (OnlinePlayerInterface PlayerInterface, byte LocalUserNum))
	bool	GetData (OnlinePlayerInterface PlayerInterface, byte LocalUserNum))
	bool	ReadData (OnlinePlayerInterface PlayerInterface, byte LocalUserNum, int DeviceId, OnlinePlayerStorage PlayerStorage))
		RefreshStorageData ()))
	bool	WriteData (OnlinePlayerInterface PlayerInterface, byte LocalUserNum, int DeviceId, OnlinePlayerStorage PlayerStorage))

AddReadCompleteDelegate Source code

Sets the delegate used to notify the gameplay code that the last read request has completed
@param PlayerInterface is the OnlinePlayerInterface used
@param LocalUserNum which user to watch for read complete notifications

ClearReadCompleteDelegate Source code

Clears the delegate used to notify the gameplay code that the last read request has completed
@param PlayerInterface is the OnlinePlayerInterface used
@param LocalUserNum which user to stop watching for read complete notifications

GetData Source code

Fetches the requested object from the online layer's cache
@param PlayerInterface is the OnlinePlayerInterface used
@param LocalUserNum the user that we are writing the data for
@param PlayerStorage the object that contains the list of items to write
@return true if the call succeeds, false otherwise

ReadData Source code

Reads the data
@param PlayerInterface is the OnlinePlayerInterface used
@param LocalUserNum the user that we are reading the data for
@param DeviceId device for local read of player data (-1 for no device)
@param PlayerStorage the object to copy the results to and contains the list of items to read
@return true if the call succeeds, false otherwise

RefreshStorageData Source code

Reads this user's storage data from the online subsystem.

WriteData Source code

Writes the online data for a given local user to the online data store
@param PlayerInterface is the OnlinePlayerInterface used
@param LocalUserNum the user that we are writing the data for
@param DeviceId device for local write of player data (-1 for no device)
@param PlayerStorage the object that contains the list of items to write
@return true if the call succeeds, false otherwise

defaultproperties
{
	ProviderName=ProfileData
	WriteAccessType=ACCESS_WriteAll
}