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

Engine.UIDataProvider_OnlineFriends

Extends
UIDataProvider_OnlinePlayerDataBase
Modifiers
native ( inherit ) implements ( UIListElementCellProvider ) dependson ( OnlineSubsystem ) 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.UIDataProvider_OnlinePlayerDataBase
         |   
         +-- Engine.UIDataProvider_OnlineFriends

Direct Known Subclasses:

UTUIDataProvider_OnlineFriends

Variables Summary
stringbHasVoiceSupportCol
stringbIsJoinableCol
stringbIsOnlineCol
stringbIsPlayingCol
stringbIsPlayingThisGameCol
array<OnlineFriend>FriendsList
stringNickNameCol
stringPresenceInfoCol
Inherited Variables from Engine.UIDataProvider_OnlinePlayerDataBase
Player
Inherited Variables from Engine.UIDataProvider
ProviderChangedNotifies, WriteAccessType

Enumerations Summary
Inherited Enumerations from Engine.UIDataProvider
EProviderAccessType

Structures Summary
Inherited Structures from Engine.UIDataProvider
UIDataProviderField

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


Variables Detail

bHasVoiceSupportCol Source code

var localized string bHasVoiceSupportCol;
The column name to display in the UI

bIsJoinableCol Source code

var localized string bIsJoinableCol;
The column name to display in the UI

bIsOnlineCol Source code

var localized string bIsOnlineCol;
The column name to display in the UI

bIsPlayingCol Source code

var localized string bIsPlayingCol;
The column name to display in the UI

bIsPlayingThisGameCol Source code

var localized string bIsPlayingThisGameCol;
The column name to display in the UI

FriendsList Source code

var array<OnlineFriend> FriendsList;
Gets a copy of the friends data from the online subsystem

NickNameCol Source code

var localized string NickNameCol;
The column name to display in the UI

PresenceInfoCol Source code

var localized string PresenceInfoCol;
The column name to display in the UI


Functions Detail

OnFriendsReadComplete Source code

function OnFriendsReadComplete ( bool bWasSuccessful) )
Handles the notification that the async read of the friends data is done
@param bWasSuccessful whether the call completed ok or not

OnLoginChange Source code

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

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

RefreshFriendsList Source code

event RefreshFriendsList ( ) )
Re-reads the friends list to freshen any cached data


Defaultproperties

defaultproperties
{
   NickNameCol="Name"
   PresenceInfoCol="Online Status"
   bIsOnlineCol="Is Online"
   bIsPlayingCol="Is Playing"
   bIsPlayingThisGameCol="Is Playing This Game"
   bIsJoinableCol="Is Joinable"
   bHasVoiceSupportCol="Has Voice Support"
   Name="Default__UIDataProvider_OnlineFriends"
   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.630 - Created with UnCodeX