UE3:UIDataProvider_OnlineFriendMessages (UDK)

Object >> UIRoot >> UIDataProvider >> UIDataProvider_OnlinePlayerDataBase >> UIDataProvider_OnlineFriendMessages

Package: 

Engine

Implemented interfaces: 

UIListElementCellProvider

Direct subclass:

UTUIDataProvider_OnlineFriendMessages

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

bIsFriendInviteCol

Type: string

Modifiers: localized

The column name to display in the UI

Default value: "Friend Invitation"

bWasAcceptedCol

Type: string

Modifiers: localized

The column name to display in the UI

Default value: "Friend Was Accepted"

bWasDeniedCol

Type: string

Modifiers: localized

The column name to display in the UI

Default value: "Friend Was Denied"

LastInviteFrom

Type: string

The person that sent the last invite

MessageCol

Type: string

Modifiers: localized

The column name to display in the UI

Default value: "Message"

Messages

Type: array<OnlineSubsystem.OnlineFriendMessage>

Gets a copy of the friends messages from the online subsystem

SendingPlayerNameCol

Type: string

Modifiers: localized

The column name to display in the UI

Default value: "Sender's Name"

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

Other instance functions

OnFriendInviteReceived

function OnFriendInviteReceived (byte LocalUserNum, OnlineSubsystem.UniqueNetId RequestingPlayer, string RequestingNick, string Message)

Called when a friend invite arrives for a local player

Parameters:

• LocalUserNum - the user that is receiving the invite
• RequestingPlayer - the player sending the friend request
• RequestingNick - the nick of the player sending the friend request
• Message - the message to display to the recipient

OnFriendMessageReceived

function OnFriendMessageReceived (byte LocalUserNum, OnlineSubsystem.UniqueNetId SendingPlayer, string SendingNick, string Message)

Handles the notification that a friend message was received

Parameters:

• LocalUserNum - the user that is receiving the message
• SendingPlayer - the player sending the message
• SendingNick - the nick of the player sending the message
• Message - the message to display to the recipient

OnGameInviteReceived

function OnGameInviteReceived (byte LocalUserNum, string InviterName)

Handles the notification that a game invite has arrived

Parameters:

• LocalUserNum - the user that is receiving the invite
• InviterName - the nick name of the person sending the invite

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

ReadMessages

function ReadMessages ()

Copies the messages from the subsystem