Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

Engine.UIDataProvider_OnlineFriendMessages

Extends
UIDataProvider_OnlinePlayerDataBase
Modifiers
native ( inherit ) implements ( UIListElementCellProvider ) dependson ( OnlineSubsystem ) transient

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

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIDataProvider
      |   
      +-- Engine.UIDataProvider_OnlinePlayerDataBase
         |   
         +-- Engine.UIDataProvider_OnlineFriendMessages

Direct Known Subclasses:

UTUIDataProvider_OnlineFriendMessages

Variables Summary
stringbIsFriendInviteCol
stringbWasAcceptedCol
stringbWasDeniedCol
stringLastInviteFrom
stringMessageCol
array<OnlineFriendMessage>Messages
stringSendingPlayerNameCol
Inherited Variables from Engine.UIDataProvider_OnlinePlayerDataBase
Player
Inherited Variables from Engine.UIDataProvider
ProviderChangedNotifies, WriteAccessType

Enumerations Summary
Inherited Enumerations from Engine.UIDataProvider
EProviderAccessType

Structures Summary
Inherited Structures from Engine.UIDataProvider
UIDataProviderField

Functions Summary
function OnFriendInviteReceived (byte LocalUserNum, niqueNetId RequestingPlayer, tring RequestingNick, tring Message))
function OnFriendMessageReceived (byte LocalUserNum, niqueNetId SendingPlayer, tring SendingNick, tring Message))
function OnGameInviteReceived (byte LocalUserNum, tring InviterName))
function OnLoginChange ()))
event OnRegister (LocalPlayer InPlayer))
event OnUnregister ()))
function ReadMessages ()))
Inherited Functions from Engine.UIDataProvider_OnlinePlayerDataBase
OnRegister, OnUnregister
Inherited Functions from Engine.UIDataProvider
AddPropertyNotificationChangeRequest, GenerateFillerData, GenerateScriptMarkupString, GetFieldValue, GetSupportedScriptFields, NotifyPropertyChanged, RemovePropertyNotificationChangeRequest, SetFieldValue


Variables Detail

bIsFriendInviteCol Source code

var localized string bIsFriendInviteCol;
The column name to display in the UI

bWasAcceptedCol Source code

var localized string bWasAcceptedCol;
The column name to display in the UI

bWasDeniedCol Source code

var localized string bWasDeniedCol;
The column name to display in the UI

LastInviteFrom Source code

var string LastInviteFrom;
The person that sent the last invite

MessageCol Source code

var localized string MessageCol;
The column name to display in the UI

Messages Source code

var array<OnlineFriendMessage> Messages;
Gets a copy of the friends messages from the online subsystem

SendingPlayerNameCol Source code

var localized string SendingPlayerNameCol;
The column name to display in the UI


Functions Detail

OnFriendInviteReceived Source code

function OnFriendInviteReceived ( byte LocalUserNum,UniqueNetId RequestingPlayer,string RequestingNick,string Message) )
Called when a friend invite arrives for a local player
@param LocalUserNum the user that is receiving the invite
@param RequestingPlayer the player sending the friend request
@param RequestingNick the nick of the player sending the friend request
@param Message the message to display to the recipient

OnFriendMessageReceived Source code

function OnFriendMessageReceived ( byte LocalUserNum,UniqueNetId SendingPlayer,string SendingNick,string Message) )
Handles the notification that a friend message was received
@param LocalUserNum the user that is receiving the message
@param SendingPlayer the player sending the message
@param SendingNick the nick of the player sending the message
@param Message the message to display to the recipient

OnGameInviteReceived Source code

function OnGameInviteReceived ( byte LocalUserNum,string InviterName) )
Handles the notification that a game invite has arrived
@param LocalUserNum the user that is receiving the invite
@param InviterName the nick name of the person sending the invite

OnLoginChange Source code

function OnLoginChange ( ) )
Executes a refetching of the friends data when the login for this player changes

OnRegister Source code

event OnRegister ( LocalPlayer InPlayer) )
Binds the player to this provider. Starts the async friends list gathering
@param InPlayer the player that we are retrieving friends for

OnUnregister Source code

event OnUnregister ( ) )
Clears our delegate for getting login change notifications

ReadMessages Source code

function ReadMessages ( ) )
Copies the messages from the subsystem


Defaultproperties

defaultproperties
{
   SendingPlayerNameCol="Sender's Name"
   bIsFriendInviteCol="Friend Invitation"
   bWasAcceptedCol="Friend Was Accepted"
   bWasDeniedCol="Friend Was Denied"
   MessageCol="Message"
   Name="Default__UIDataProvider_OnlineFriendMessages"
   ObjectArchetype=UIDataProvider_OnlinePlayerDataBase'Engine.Default__UIDataProvider_OnlinePlayerDataBase'
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:46.619 - Created with UnCodeX