Cogito, ergo sum
UE3:UIDataStore_OnlinePlayerData (UDK)
 |
Object >> UIRoot >> UIDataProvider >> UIDataStore >> UIDataStore_Remote >> UIDataStore_OnlinePlayerData |
Contents
- 1 Properties
- 1.1 AchievementsProvider
- 1.2 AchievementsProviderClass
- 1.3 AchievementsProviderClassName
- 1.4 ClanMatesProvider
- 1.5 ClanMatesProviderClass
- 1.6 ClanMatesProviderClassName
- 1.7 FriendMessagesProvider
- 1.8 FriendMessagesProviderClass
- 1.9 FriendMessagesProviderClassName
- 1.10 FriendsProvider
- 1.11 FriendsProviderClass
- 1.12 FriendsProviderClassName
- 1.13 NumNewDownloads
- 1.14 NumTotalDownloads
- 1.15 PartyChatProvider
- 1.16 PartyChatProviderClass
- 1.17 PartyChatProviderClassName
- 1.18 Player
- 1.19 PlayerNick
- 1.20 PlayersProvider
- 1.21 PlayersProviderClass
- 1.22 PlayersProviderClassName
- 1.23 PlayerStorageClass
- 1.24 PlayerStorageClassName
- 1.25 ProfileProvider
- 1.26 ProfileSettingsClass
- 1.27 ProfileSettingsClassName
- 1.28 StorageProvider
- 1.29 Default values
- 2 Functions
- Package:
- Engine
- Implemented interfaces:
- UIListElementProvider
- This class in other games:
- UT3
| 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]
AchievementsProvider[edit]
Type: UIDataProvider_PlayerAchievements
Provides access to the list of achievements for this player
AchievementsProviderClass[edit]
Type: class<UIDataProvider_PlayerAchievements>
The class that should be created when a player is bound to this data store for providing achievements data to the UI
Default value: Class'Engine.UIDataProvider_PlayerAchievements'
AchievementsProviderClassName[edit]
Type: string
Modifiers: config
The name of the data provider class to use as the default for enumerating achievements
ClanMatesProvider[edit]
Type: UIDataProvider_OnlineClanMates
Provides access to the player's clan members list
ClanMatesProviderClass[edit]
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[edit]
Type: string
Modifiers: config
The name of the data provider class to use as the default for clan mates
FriendMessagesProvider[edit]
Type: UIDataProvider_OnlineFriendMessages
Provides access to any friend messages
FriendMessagesProviderClass[edit]
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[edit]
Type: string
Modifiers: config
The name of the data provider class to use as the default for messages
Default value: "UTGame.UTUIDataProvider_OnlineFriendMessages"
FriendsProvider[edit]
Type: UIDataProvider_OnlineFriends
Provides access to the player's online friends list
FriendsProviderClass[edit]
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[edit]
Type: string
Modifiers: config
The name of the data provider class to use as the default for friends
Default value: "UTGame.UTUIDataProvider_OnlineFriends"
NumNewDownloads[edit]
Type: int
The number of new downloads for this player
NumTotalDownloads[edit]
Type: int
The total number of downloads for this player
PartyChatProvider[edit]
Type: UIDataProvider_OnlinePartyChatList
The provider instance for the party chat data
PartyChatProviderClass[edit]
Type: class<UIDataProvider_OnlinePartyChatList>
The class that should be created when a player is bound to this data store
Default value: Class'Engine.UIDataProvider_OnlinePartyChatList'
PartyChatProviderClassName[edit]
Type: string
Modifiers: config
The name of the data provider class to use as the default for party chat members
Default value: "Engine.UIDataProvider_OnlinePartyChatList"
Player[edit]
Type: LocalPlayer
Holds the player that this provider is getting friends for
PlayerNick[edit]
Type: string
The online nick name for the player
Default value: "PlayerNickNameHere"
PlayersProvider[edit]
Type: UIDataProvider_OnlinePlayers
Provides access to the player's recent online players list
PlayersProviderClass[edit]
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[edit]
Type: string
Modifiers: config
The name of the data provider class to use as the default for recent players list
PlayerStorageClass[edit]
Type: class<OnlinePlayerStorage>
The class that should be created when a player is bound to this data store
PlayerStorageClassName[edit]
Type: string
Modifiers: config
The name of the OnlinePlayerStorage class to use as the default
ProfileProvider[edit]
Type: UIDataProvider_OnlineProfileSettings
Provides access to the player's profile data
ProfileSettingsClass[edit]
Type: class<OnlineProfileSettings>
The class that should be created when a player is bound to this data store
Default value: Class'UTGame.UTProfileSettings'
ProfileSettingsClassName[edit]
Type: string
Modifiers: config
The name of the OnlineProfileSettings class to use as the default
Default value: "UTGame.UTProfileSettings"
StorageProvider[edit]
Type: UIDataProvider_OnlinePlayerStorage
Provides access to the player's storage data
Default values[edit]
| Property | Value |
|---|---|
| Tag | 'OnlinePlayerData' |
Functions[edit]
Static events[edit]
GetCachedPlayerProfile[edit]
Retrieves a player profile which has been cached by the online subsystem.
Parameters:
- ControllerId - the controller ID for the player to retrieve the profile for.
Returns:
- a player profile which was previously created and cached by the online subsystem for the specified controller id.
GetCachedPlayerStorage[edit]
Retrieves a player storage which has been cached by the online subsystem.
Parameters:
- ControllerId - the controller ID for the player to retrieve the profile for.
Returns:
- a player storage which was previously created and cached by the online subsystem for the specified controller id.
Native functions[edit]
OnSettingProviderChanged[edit]
Handler for this data store internal settings data providers OnDataProviderPropertyChange delegate. When the setting associated with that provider is updated, issues a refresh notification which causes e.g. widgets to refresh their values.
Parameters:
- SourceProvider - the data provider that generated the notification
- SettingsName - the name of the setting that changed
Events[edit]
OnRegister[edit]
Binds the player to this provider. Starts the async friends list gathering
Parameters:
- InPlayer - the player that we are retrieving friends for
OnUnregister[edit]
Clears our delegate for getting login change notifications
SaveProfileData[edit]
Forwards the call to the provider
Other instance functions[edit]
ClearDelegates[edit]
OnDownloadableContentQueryDone[edit]
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[edit]
Refetches the player's nick name from the online subsystem
Parameters:
- LocalUserNum - the player that logged in/out
OnPlayerDataChange[edit]
Refetches the player's nick name from the online subsystem
RegisterDelegates[edit]
Registers the delegates with the providers so we can know when async data changes
