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

Variables Summary
string	AwayText
string	bHasInvitedYouCol
string	bHasVoiceSupportCol
string	bHaveInvitedCol
string	bIsJoinableCol
string	bIsOnlineCol
string	bIsPlayingCol
string	bIsPlayingThisGameCol
string	BusyText
array<OnlineFriend>	FriendsList
string	FriendStateCol
string	NickNameCol
string	OfflineText
string	OnlineText
string	PresenceInfoCol

Inherited Variables from Engine.UIDataProvider_OnlinePlayerDataBase
PlayerControllerId

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
		OnFriendsReadComplete (bool bWasSuccessful))
		OnLoginChange (byte LocalUserNum))
		OnRegister (LocalPlayer InPlayer))
		OnUnregister ()))
		RefreshFriendsList ()))

Inherited Functions from Engine.UIDataProvider_OnlinePlayerDataBase
OnRegister, OnUnregister

Inherited Functions from Engine.UIDataProvider
AddPropertyNotificationChangeRequest, AllowPublishingToField, GenerateFillerData, GenerateScriptMarkupString, GetFieldValue, GetProviderFieldType, GetSupportedScriptFields, IsCollectionDataType, IsProviderDisabled, NotifyPropertyChanged, ParseArrayDelimiter, ParseTagArrayDelimiter, RemovePropertyNotificationChangeRequest, SetFieldValue

Variables Detail

AwayText Source code

var localized string AwayText;

The text to use when away

bHasInvitedYouCol Source code

var localized string bHasInvitedYouCol;

The column name to display in the UI

bHasVoiceSupportCol Source code

var localized string bHasVoiceSupportCol;

The column name to display in the UI

bHaveInvitedCol Source code

var localized string bHaveInvitedCol;

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

BusyText Source code

var localized string BusyText;

The text to use when busy

FriendsList Source code

var array<OnlineFriend> FriendsList;

Gets a copy of the friends data from the online subsystem

FriendStateCol Source code

var localized string FriendStateCol;

The column name to display in the UI

NickNameCol Source code

var localized string NickNameCol;

The column name to display in the UI

OfflineText Source code

var localized string OfflineText;

The text to use when offline

OnlineText Source code

var localized string OnlineText;

The text to use when online

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

Executes a refetching of the friends data when the login for this player changes
@param LocalUserNum the player that logged in/out

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

Creation time: ti 22-3-2011 19:56:58.684 - Created with UnCodeX