Worst-case scenario: the UEd Goblin wipes the map and burns down your house.
UE3:UIDataProvider_OnlineFriendMessages (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 the {{autogenerated}} 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.
Properties[edit]
bIsFriendInviteCol[edit]
Type: string
Modifiers: localized
The column name to display in the UI
Default value: "Friend Invitation"
bWasAcceptedCol[edit]
Type: string
Modifiers: localized
The column name to display in the UI
Default value: "Friend Was Accepted"
bWasDeniedCol[edit]
Type: string
Modifiers: localized
The column name to display in the UI
Default value: "Friend Was Denied"
LastInviteFrom[edit]
Type: string
The person that sent the last invite
MessageCol[edit]
Type: string
Modifiers: localized
The column name to display in the UI
Default value: "Message"
Messages[edit]
Type: array<OnlineSubsystem.OnlineFriendMessage>
Gets a copy of the friends messages from the online subsystem
SendingPlayerNameCol[edit]
Type: string
Modifiers: localized
The column name to display in the UI
Default value: "Sender's Name"
Functions[edit]
Events[edit]
OnRegister[edit]
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]
Overrides: UIDataProvider_OnlinePlayerDataBase.OnUnregister
Clears our delegate for getting login change notifications
Other instance functions[edit]
OnFriendInviteReceived[edit]
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[edit]
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[edit]
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[edit]
Executes a refetching of the friends data when the login for this player changes
ReadMessages[edit]
Copies the messages from the subsystem
