My program doesn't have bugs. It just develops random features.

UE3:UIDataProvider_OnlineFriendMessages (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
UT3 Object >> UIRoot >> UIDataProvider >> UIDataProvider_OnlinePlayerDataBase >> UIDataProvider_OnlineFriendMessages

Contents
Package: 
Engine
Implemented interfaces: 
UIListElementCellProvider
Direct subclass:
UTUIDataProvider_OnlineFriendMessages
This class in other games:
UDK
This is an auto-generated page and may need human attention.
Please remove this tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

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

[edit] Properties

[edit] bIsFriendInviteCol

Type: string

Modifiers: localized

The column name to display in the UI

Default value: "Friend Invitation"

[edit] bWasAcceptedCol

Type: string

Modifiers: localized

The column name to display in the UI

Default value: "Friend Was Accepted"

[edit] bWasDeniedCol

Type: string

Modifiers: localized

The column name to display in the UI

Default value: "Friend Was Denied"

[edit] LastInviteFrom

Type: string

The person that sent the last invite

[edit] MessageCol

Type: string

Modifiers: localized

The column name to display in the UI

Default value: "Message"

[edit] Messages

Type: array<OnlineSubsystem.OnlineFriendMessage>

Gets a copy of the friends messages from the online subsystem

[edit] SendingPlayerNameCol

Type: string

Modifiers: localized

The column name to display in the UI

Default value: "Sender's Name"

[edit] Functions

[edit] Events

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

[edit] OnUnregister

event OnUnregister ()

Overrides: UIDataProvider_OnlinePlayerDataBase.OnUnregister

Clears our delegate for getting login change notifications

[edit] Other instance functions

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

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

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

[edit] OnLoginChange

function OnLoginChange ()

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

[edit] ReadMessages

function ReadMessages ()

Copies the messages from the subsystem

Retrieved from "http://wiki.beyondunreal.com/UE3:UIDataProvider_OnlineFriendMessages_(UT3)"
Personal tools