UE3:UIDataProvider_OnlinePartyChatList (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
UDK Object >> UIRoot >> UIDataProvider >> UIDataProvider_OnlinePlayerDataBase >> UIDataProvider_OnlinePartyChatList
Package:
Engine
Implemented interfaces:
UIListElementCellProvider

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

Properties

IsInGameSessionCol

Type: string

Modifiers: localized

The column name to display in the UI

IsInPartyVoiceCol

Type: string

Modifiers: localized

The column name to display in the UI

IsLocalCol

Type: string

Modifiers: localized

The column name to display in the UI

IsPlayingThisGameCol

Type: string

Modifiers: localized

The column name to display in the UI

IsTalkingCol

Type: string

Modifiers: localized

The column name to display in the UI

NatTypeCol

Type: string

Modifiers: localized

The column name to display in the UI

NatTypes

Type: array<string>

Modifiers: localized

The text to use for nat types

Default value: "Unknown"

NickNameCol

Type: string

Modifiers: localized

The column name to display in the UI

PartyMembersList

Type: array<OnlineSubsystem.OnlinePartyMember>

Gets a copy of the friends data from the online subsystem

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

RefreshMembersList

event RefreshMembersList ()

Re-reads the friends list to freshen any cached data

Other instance functions

OnLoginChange

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