Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

Engine.UIDataProvider_OnlineProfileSettings

Extends
UIDataProvider_OnlinePlayerDataBase
Modifiers
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_OnlineProfileSettings

Variables Summary
boolbWasErrorLastRead
OnlineProfileSettingsProfile
array<ProfileSettingsArrayProvider>ProfileSettingsArrayProviders
nameProviderName
Inherited Variables from Engine.UIDataProvider_OnlinePlayerDataBase
Player
Inherited Variables from Engine.UIDataProvider
ProviderChangedNotifies, WriteAccessType

Enumerations Summary
Inherited Enumerations from Engine.UIDataProvider
EProviderAccessType

Structures Summary
ProfileSettingsArrayProvider
ProfileSettingsId, ProfileSettingsName, Provider
Inherited Structures from Engine.UIDataProvider
UIDataProviderField

Functions Summary
function OnLoginChange ()))
function OnReadProfileComplete (bool bWasSuccessful))
event OnRegister (LocalPlayer InPlayer))
event OnUnregister ()))
eventbool SaveProfileData ()))
Inherited Functions from Engine.UIDataProvider_OnlinePlayerDataBase
OnRegister, OnUnregister
Inherited Functions from Engine.UIDataProvider
AddPropertyNotificationChangeRequest, GenerateFillerData, GenerateScriptMarkupString, GetFieldValue, GetSupportedScriptFields, NotifyPropertyChanged, RemovePropertyNotificationChangeRequest, SetFieldValue


Variables Detail

bWasErrorLastRead Source code

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

Profile Source code

var OnlineProfileSettings Profile;
The profile settings that are used to load/save with the online subsystem

ProfileSettingsArrayProviders Source code

var array<ProfileSettingsArrayProvider> ProfileSettingsArrayProviders;
The list of mappings from settings id to their provider

ProviderName Source code

var const name ProviderName;
For displaying in the provider tree


Structures Detail

ProfileSettingsArrayProvider Source code

struct ProfileSettingsArrayProvider
{
var int ProfileSettingsId;
var name ProfileSettingsName;
var UIDataProvider_OnlineProfileSettingsArray Provider;
};
Keeps a list of providers for each profile settings id
ProfileSettingsId:
The profile settings id that this provider is for
ProfileSettingsName:
Cached to avoid extra look ups
Provider:
The provider object to expose the data with


Functions Detail

OnLoginChange Source code

function OnLoginChange ( ) )
Executes a refetching of the profile data when the login for this player changes

OnReadProfileComplete Source code

function OnReadProfileComplete ( bool bWasSuccessful) )
Handles the notification that the async read of the profile data is done
@param bWasSuccessful whether the call succeeded or not

OnRegister Source code

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

OnUnregister Source code

event OnUnregister ( ) )
Clears our delegate for getting login change notifications

SaveProfileData Source code

event bool SaveProfileData ( ) )
Writes the profile data to the online subsystem for this user


Defaultproperties

defaultproperties
{
   ProviderName="ProfileData"
   WriteAccessType=ACCESS_WriteAll
   Name="Default__UIDataProvider_OnlineProfileSettings"
   ObjectArchetype=UIDataProvider_OnlinePlayerDataBase'Engine.Default__UIDataProvider_OnlinePlayerDataBase'
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:46.658 - Created with UnCodeX