Gah - a solution with more questions. – EntropicLqd
UE3:UIDataStore_OnlinePlayerData (UT3)
Object >> UIRoot >> UIDataProvider >> UIDataStore >> UIDataStore_Remote >> UIDataStore_OnlinePlayerData |
Contents
- 1 Properties
- 1.1 bIsRankingQueryInProgress
- 1.2 ClanMatesProvider
- 1.3 ClanMatesProviderClass
- 1.4 ClanMatesProviderClassName
- 1.5 CurrentRankingQuery
- 1.6 FriendMessagesProvider
- 1.7 FriendMessagesProviderClass
- 1.8 FriendMessagesProviderClassName
- 1.9 FriendsProvider
- 1.10 FriendsProviderClass
- 1.11 FriendsProviderClassName
- 1.12 NumNewDownloads
- 1.13 NumTotalDownloads
- 1.14 Player
- 1.15 PlayerNick
- 1.16 PlayerRanking
- 1.17 PlayerRankingLastQueryTime
- 1.18 PlayerRankingQueryClass
- 1.19 PlayerRankingQueryClassName
- 1.20 PlayersProvider
- 1.21 PlayersProviderClass
- 1.22 PlayersProviderClassName
- 1.23 ProfileProvider
- 1.24 ProfileSettingsClass
- 1.25 ProfileSettingsClassName
- 1.26 Default values
- 2 Functions
- Package:
- Engine
- Implemented interfaces:
- UIListElementProvider
- 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
bIsRankingQueryInProgress
Type: bool
Are we in the middle of a query to get the player ranking
ClanMatesProvider
Type: UIDataProvider_OnlineClanMates
Provides access to the player's clan members list
ClanMatesProviderClass
Type: class<UIDataProvider_OnlineClanMates>
The class that should be created when a player is bound to this data store
Default value: Class'Engine.UIDataProvider_OnlineClanMates'
ClanMatesProviderClassName
Type: string
Modifiers: config
The name of the data provider class to use as the default for clan mates
CurrentRankingQuery
Type: OnlineStatsRead
An instance of the ranking query OnlineStatsRead class
FriendMessagesProvider
Type: UIDataProvider_OnlineFriendMessages
Provides access to any friend messages
FriendMessagesProviderClass
Type: class<UIDataProvider_OnlineFriendMessages>
The class that should be created when a player is bound to this data store
Default value: Class'UTGame.UTUIDataProvider_OnlineFriendMessages'
FriendMessagesProviderClassName
Type: string
Modifiers: config
The name of the data provider class to use as the default for messages
Default value: "UTGame.UTUIDataProvider_OnlineFriendMessages"
FriendsProvider
Type: UIDataProvider_OnlineFriends
Provides access to the player's online friends list
FriendsProviderClass
Type: class<UIDataProvider_OnlineFriends>
The class that should be created when a player is bound to this data store
Default value: Class'UTGame.UTUIDataProvider_OnlineFriends'
FriendsProviderClassName
Type: string
Modifiers: config
The name of the data provider class to use as the default for friends
Default value: "UTGame.UTUIDataProvider_OnlineFriends"
NumNewDownloads
Type: int
The number of new downloads for this player
NumTotalDownloads
Type: int
The total number of downloads for this player
Player
Type: LocalPlayer
Holds the player that this provider is getting friends for
PlayerNick
Type: string
The online nick name for the player
Default value: "PlayerNickNameHere"
PlayerRanking
Type: int
The ranking value of the logged in player
PlayerRankingLastQueryTime
Type: float
The timestamp (sec) when the PlayerRanking was last successfully recorded
PlayerRankingQueryClass
Type: class<OnlineStatsRead>
Class used to create an OnlineStatsRead object for the ranking query
Default value: Class'UTGame.UTStatReadPlayerRatingPure'
PlayerRankingQueryClassName
Type: string
Modifiers: config
The OnlineStatsRead class that will retrieve the ranking value
Default value: "UTGame.UTStatReadPlayerRatingPure"
PlayersProvider
Type: UIDataProvider_OnlinePlayers
Provides access to the player's recent online players list
PlayersProviderClass
Type: class<UIDataProvider_OnlinePlayers>
The class that should be created when a player is bound to this data store
Default value: Class'Engine.UIDataProvider_OnlinePlayers'
PlayersProviderClassName
Type: string
Modifiers: config
The name of the data provider class to use as the default for recent players list
ProfileProvider
Type: UIDataProvider_OnlineProfileSettings
Provides access to the player's profile data
ProfileSettingsClass
Type: class<OnlineProfileSettings>
The class that should be created when a player is bound to this data store
Default value: Class'UTGame.UTProfileSettings'
ProfileSettingsClassName
Type: string
Modifiers: config
The name of the OnlineProfileSettings class to use as the default
Default value: "UTGame.UTProfileSettings"
Default values
Property | Value |
---|---|
Tag | 'OnlinePlayerData' |
Functions
Native functions
StorePlayerRankingQueryValue
Stores the player rating stored in the OnlineStatsRead *
Events
OnRegister
Binds the player to this provider. Starts the async friends list gathering
Parameters:
- InPlayer - the player that we are retrieving friends for
OnUnregister
Clears our delegate for getting login change notifications
RegisterDelegates
Registers the delegates with the providers so we can know when async data changes
SaveProfileData
Forwards the call to the provider
Other instance functions
OnDownloadableContentQueryDone
Caches the downloadable content info for the player we're bound to
Parameters:
- bWasSuccessful - true if the async action completed without error, false if there was an error
OnLoginChange
Refetches the player's nick name from the online subsystem
OnPlayerDataChange
Refetches the player's nick name from the online subsystem
OnProviderChanged
Handles notification that one of our providers has changed and in turn notifies the UI system
Parameters:
- SourceProvider - the data provider that generated the notification
- PropTag - the property that changed
OnReadOnlinePlayerRankingComplete
Delegate called when a player rating stats read has completed
QueryLoggedInPlayerRanking
Queries the online system for this player's rating (1000 is new player)