Mostly Harmless
UE3:UIDataProvider_OnlineFriends (UT3)
From Unreal Wiki, The Unreal Engine Documentation Site
 |
Object >> UIRoot >> UIDataProvider >> UIDataProvider_OnlinePlayerDataBase >> UIDataProvider_OnlineFriends |
Contents |
- Package:
- Engine
- Implemented interfaces:
- UIListElementCellProvider
- Direct subclass:
- UTUIDataProvider_OnlineFriends
- 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] bHasVoiceSupportCol
Type: string
Modifiers: localized
The column name to display in the UI
Default value: "Has Voice Support"
[edit] bIsJoinableCol
Type: string
Modifiers: localized
The column name to display in the UI
Default value: "Is Joinable"
[edit] bIsOnlineCol
Type: string
Modifiers: localized
The column name to display in the UI
Default value: "Is Online"
[edit] bIsPlayingCol
Type: string
Modifiers: localized
The column name to display in the UI
Default value: "Is Playing"
[edit] bIsPlayingThisGameCol
Type: string
Modifiers: localized
The column name to display in the UI
Default value: "Is Playing This Game"
[edit] FriendsList
Type: array<OnlineSubsystem.OnlineFriend>
Gets a copy of the friends data from the online subsystem
[edit] NickNameCol
Type: string
Modifiers: localized
The column name to display in the UI
Default value: "Name"
[edit] PresenceInfoCol
Type: string
Modifiers: localized
The column name to display in the UI
Default value: "Online Status"
[edit] Functions
[edit] Events
[edit] OnRegister
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
Overrides: UIDataProvider_OnlinePlayerDataBase.OnUnregister
Clears our delegate for getting login change notifications
[edit] RefreshFriendsList
Re-reads the friends list to freshen any cached data
[edit] Other instance functions
[edit] OnFriendsReadComplete
Handles the notification that the async read of the friends data is done
Parameters:
- bWasSuccessful - whether the call completed ok or not
[edit] OnLoginChange
Executes a refetching of the friends data when the login for this player changes
