Mostly Harmless

UE3:UIDataProvider_OnlineFriends (UDK)

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

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

Properties[edit]

AwayText[edit]

Type: string

Modifiers: localized

The text to use when away

Default value: "Away"

bHasInvitedYouCol[edit]

Type: string

Modifiers: localized

The column name to display in the UI

bHasVoiceSupportCol[edit]

Type: string

Modifiers: localized

The column name to display in the UI

Default value: "Has Voice Support"

bHaveInvitedCol[edit]

Type: string

Modifiers: localized

The column name to display in the UI

bIsJoinableCol[edit]

Type: string

Modifiers: localized

The column name to display in the UI

Default value: "Is Joinable"

bIsOnlineCol[edit]

Type: string

Modifiers: localized

The column name to display in the UI

Default value: "Is Online"

bIsPlayingCol[edit]

Type: string

Modifiers: localized

The column name to display in the UI

Default value: "Is Playing"

bIsPlayingThisGameCol[edit]

Type: string

Modifiers: localized

The column name to display in the UI

Default value: "Is Playing This Game"

BusyText[edit]

Type: string

Modifiers: localized

The text to use when busy

Default value: "Busy"

FriendsList[edit]

Type: array<OnlineSubsystem.OnlineFriend>

Gets a copy of the friends data from the online subsystem

FriendStateCol[edit]

Type: string

Modifiers: localized

The column name to display in the UI

NickNameCol[edit]

Type: string

Modifiers: localized

The column name to display in the UI

Default value: "Name"

OfflineText[edit]

Type: string

Modifiers: localized

The text to use when offline

Default value: "Offline"

OnlineText[edit]

Type: string

Modifiers: localized

The text to use when online

Default value: "Online"

PresenceInfoCol[edit]

Type: string

Modifiers: localized

The column name to display in the UI

Default value: "Online Status"

Functions[edit]

Events[edit]

OnRegister[edit]

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[edit]

event OnUnregister ()

Overrides: UIDataProvider_OnlinePlayerDataBase.OnUnregister

Clears our delegate for getting login change notifications

RefreshFriendsList[edit]

event RefreshFriendsList ()

Re-reads the friends list to freshen any cached data

Other instance functions[edit]

OnFriendsReadComplete[edit]

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[edit]

function OnLoginChange (byte LocalUserNum)

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

Parameters:

  • LocalUserNum - the player that logged in/out