I search for solutions in this order: Past Code, Unreal Source, Wiki, BUF, groups.yahoo, google, screaming at monitor. – RegularX

UE3:UIDataProvider_OnlineFriends (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Object >> UIRoot >> UIDataProvider >> UIDataProvider_OnlinePlayerDataBase >> UIDataProvider_OnlineFriends
Package: 
Engine
Implemented interfaces
UIListElementCellProvider
Direct subclass:
UTUIDataProvider_OnlineFriends
This class in other games:
UDK

This class is responsible for retrieving the friends list from the online subsystem and populating the UI with that data.

Properties

bHasVoiceSupportCol

Type: string

Modifiers: localized

The column name to display in the UI

Default value: "Has Voice Support"

bIsJoinableCol

Type: string

Modifiers: localized

The column name to display in the UI

Default value: "Is Joinable"

bIsOnlineCol

Type: string

Modifiers: localized

The column name to display in the UI

Default value: "Is Online"

bIsPlayingCol

Type: string

Modifiers: localized

The column name to display in the UI

Default value: "Is Playing"

bIsPlayingThisGameCol

Type: string

Modifiers: localized

The column name to display in the UI

Default value: "Is Playing This Game"

FriendsList

Type: array<OnlineSubsystem.OnlineFriend>

Gets a copy of the friends data from the online subsystem

NickNameCol

Type: string

Modifiers: localized

The column name to display in the UI

Default value: "Name"

PresenceInfoCol

Type: string

Modifiers: localized

The column name to display in the UI

Default value: "Online Status"

Functions

Events

OnRegister

event OnRegister (LocalPlayer InPlayer)

Overrides: UIDataProvider_OnlinePlayerDataBase.OnRegister

Binds the player to this provider. Starts the async friends list gathering

Parameters:

  • InPlayer - the player that we are retrieving friends for

OnUnregister

event OnUnregister ()

Overrides: UIDataProvider_OnlinePlayerDataBase.OnUnregister

Clears our delegate for getting login change notifications

RefreshFriendsList

event RefreshFriendsList ()

Re-reads the friends list to freshen any cached data

Other instance functions

OnFriendsReadComplete

function OnFriendsReadComplete (bool bWasSuccessful)

Handles the notification that the async read of the friends data is done

Parameters:

  • bWasSuccessful - whether the call completed ok or not

OnLoginChange

function OnLoginChange ()

Executes a refetching of the friends data when the login for this player changes