Worst-case scenario: the UEd Goblin wipes the map and burns down your house.

Difference between revisions of "UE3:UIDataProvider OnlinePartyChatList (UDK)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(Talk)
 
m (1 revision: class descriptions for UDK January update (part 5))
 
(No difference)

Latest revision as of 06:49, 17 January 2010

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

IsInGameSessionCol[edit]

Type: string

Modifiers: localized

The column name to display in the UI

IsInPartyVoiceCol[edit]

Type: string

Modifiers: localized

The column name to display in the UI

IsLocalCol[edit]

Type: string

Modifiers: localized

The column name to display in the UI

IsPlayingThisGameCol[edit]

Type: string

Modifiers: localized

The column name to display in the UI

IsTalkingCol[edit]

Type: string

Modifiers: localized

The column name to display in the UI

NatTypeCol[edit]

Type: string

Modifiers: localized

The column name to display in the UI

NatTypes[edit]

Type: array<string>

Modifiers: localized

The text to use for nat types

Default value: "Unknown"

NickNameCol[edit]

Type: string

Modifiers: localized

The column name to display in the UI

PartyMembersList[edit]

Type: array<OnlineSubsystem.OnlinePartyMember>

Gets a copy of the friends data from the online subsystem

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

RefreshMembersList[edit]

event RefreshMembersList ()

Re-reads the friends list to freshen any cached data

Other instance functions[edit]

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