I'm a doctor, not a mechanic
UE3:OnlinePlayerInterfaceEx (UDK)
Interface >> OnlinePlayerInterfaceEx |
Contents
- 1 Delegates
- 2 Instance functions
- 2.1 AddDeviceSelectionDoneDelegate
- 2.2 AddProfileDataChangedDelegate
- 2.3 AddReadAchievementsCompleteDelegate
- 2.4 AddUnlockAchievementCompleteDelegate
- 2.5 ClearDeviceSelectionDoneDelegate
- 2.6 ClearProfileDataChangedDelegate
- 2.7 ClearReadAchievementsCompleteDelegate
- 2.8 ClearUnlockAchievementCompleteDelegate
- 2.9 GetAchievements
- 2.10 GetDeviceSelectionResults
- 2.11 IsDeviceValid
- 2.12 ReadAchievements
- 2.13 ShowAchievementsUI
- 2.14 ShowContentMarketplaceUI
- 2.15 ShowCustomPlayersUI
- 2.16 ShowDeviceSelectionUI
- 2.17 ShowFeedbackUI
- 2.18 ShowFriendsInviteUI
- 2.19 ShowGamerCardUI
- 2.20 ShowInviteUI
- 2.21 ShowMembershipMarketplaceUI
- 2.22 ShowMessagesUI
- 2.23 ShowPlayersUI
- 2.24 UnlockAchievement
- 2.25 UnlockGamerPicture
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 interface provides extended player functionality not supported by all platforms. The OnlineSubsystem will return NULL when requesting this interface on a platform where it is not supporeted.
Delegates[edit]
OnDeviceSelectionComplete[edit]
Delegate used when the device selection request has completed
Parameters:
- bWasSuccessful - true if the async action completed without error, false if there was an error
OnProfileDataChanged[edit]
Called when an external change to player profile data has occured
OnReadAchievementsComplete[edit]
Called when the async achievements read has completed
Parameters:
- TitleId - the title id that the read was for (0 means current title)
OnUnlockAchievementComplete[edit]
Delegate used when the achievement unlocking has completed
Parameters:
- bWasSuccessful - true if the async action completed without error, false if there was an error
Instance functions[edit]
AddDeviceSelectionDoneDelegate[edit]
Adds the delegate used to notify the gameplay code that the user has completed their device selection
Parameters:
- DeviceDelegate - the delegate to use for notifications
AddProfileDataChangedDelegate[edit]
Sets the delegate used to notify the gameplay code that someone has changed their profile data externally
Parameters:
- LocalUserNum - the user the delegate is interested in
- ProfileDataChangedDelegate - the delegate to use for notifications
AddReadAchievementsCompleteDelegate[edit]
Sets the delegate used to notify the gameplay code that the achievements read request has completed
Parameters:
- LocalUserNum - the user to read the achievements list for
- ReadAchievementsCompleteDelegate - the delegate to use for notifications
AddUnlockAchievementCompleteDelegate[edit]
Adds the delegate used to notify the gameplay code that the achievement unlocking has completed
Parameters:
- LocalUserNum - which user to watch for read complete notifications
- UnlockAchievementCompleteDelegate - the delegate to use for notifications
ClearDeviceSelectionDoneDelegate[edit]
Removes the specified delegate from the list of callbacks
Parameters:
- DeviceDelegate - the delegate to use for notifications
ClearProfileDataChangedDelegate[edit]
Clears the delegate used to notify the gameplay code that someone has changed their profile data externally
Parameters:
- LocalUserNum - the user the delegate is interested in
- ProfileDataChangedDelegate - the delegate to use for notifications
ClearReadAchievementsCompleteDelegate[edit]
Clears the delegate used to notify the gameplay code that the achievements read request has completed
Parameters:
- LocalUserNum - the user to read the achievements list for
- ReadAchievementsCompleteDelegate - the delegate to use for notifications
ClearUnlockAchievementCompleteDelegate[edit]
Clears the delegate used to notify the gameplay code that the achievement unlocking has completed
Parameters:
- LocalUserNum - which user to watch for read complete notifications
- UnlockAchievementCompleteDelegate - the delegate to use for notifications
GetAchievements[edit]
Copies the list of achievements for the specified player and title id
Parameters:
- LocalUserNum - the user to read the friends list of
- Achievements - the out array that receives the copied data
- TitleId - the title id of the game that these were read for
Returns:
- OERS_Done if the read has completed, otherwise one of the other states
GetDeviceSelectionResults[edit]
Fetches the results of the device selection
Parameters:
- LocalUserNum - the player to check the results for
- DeviceName - out param that gets a copy of the string
Returns:
- the ID of the device that was selected NOTE: Zero means the user hasn't selected one
IsDeviceValid[edit]
Checks the device id to determine if it is still valid (could be removed) and/or if there is enough space on the specified device
Parameters:
- DeviceId - the device to check
- SizeNeeded - the amount of space requested
Returns:
- true if valid, false otherwise
ReadAchievements[edit]
Starts an async read for the achievement list
Parameters:
- LocalUserNum - the controller number of the associated user
- TitleId - the title id of the game the achievements are to be read for
- bShouldReadText - whether to fetch the text strings or not
- bShouldReadImages - whether to fetch the image data or not
Returns:
- TRUE if the task starts, FALSE if it failed
ShowAchievementsUI[edit]
Displays the achievements UI for a player
Parameters:
- LocalUserNum - the controller number of the associated user
Returns:
- TRUE if it was able to show the UI, FALSE if it failed
ShowContentMarketplaceUI[edit]
Displays the marketplace UI for content
Parameters:
- LocalUserNum - the local user viewing available content
- CategoryMask - the bitmask to use to filter content by type
- OfferId - a specific offer that you want shown
ShowCustomPlayersUI[edit]
Shows a custom players UI for the specified list of players
Parameters:
- LocalUserNum - the controller number of the associated user
- Players - the list of players to show in the custom UI
- Title - the title to use for the UI
- Description - the text to show at the top of the UI
Returns:
- TRUE if it was able to show the UI, FALSE if it failed
ShowDeviceSelectionUI[edit]
Displays the UI that allows the user to choose which device to save content to
Parameters:
- LocalUserNum - the controller number of the associated user
- SizeNeeded - the size of the data to be saved in bytes
- bForceShowUI - true to always show the UI, false to only show the UI if there are multiple valid choices
- bManageStorage - whether to allow the user to manage their storage or not
Returns:
- TRUE if it was able to show the UI, FALSE if it failed
ShowFeedbackUI[edit]
Displays the UI that allows a player to give feedback on another player
Parameters:
- LocalUserNum - the controller number of the associated user
- PlayerId - the id of the player having feedback given for
Returns:
- TRUE if it was able to show the UI, FALSE if it failed
ShowFriendsInviteUI[edit]
Displays the UI that shows a user's list of friends
Parameters:
- LocalUserNum - the controller number of the associated user
- PlayerId - the id of the player being invited
Returns:
- TRUE if it was able to show the UI, FALSE if it failed
ShowGamerCardUI[edit]
Displays the gamer card UI for the specified player
Parameters:
- LocalUserNum - the controller number of the associated user
- PlayerId - the id of the player to show the gamer card of
Returns:
- TRUE if it was able to show the UI, FALSE if it failed
ShowInviteUI[edit]
Displays the invite ui
Parameters:
- LocalUserNum - the local user sending the invite
- InviteText - the string to prefill the UI with
ShowMembershipMarketplaceUI[edit]
Displays the marketplace UI for memberships
Parameters:
- LocalUserNum - the local user viewing available memberships
ShowMessagesUI[edit]
Displays the messages UI for a player
Parameters:
- LocalUserNum - the controller number of the associated user
Returns:
- TRUE if it was able to show the UI, FALSE if it failed
ShowPlayersUI[edit]
Displays the UI that shows the player list
Parameters:
- LocalUserNum - the controller number of the associated user
Returns:
- TRUE if it was able to show the UI, FALSE if it failed
UnlockAchievement[edit]
Unlocks the specified achievement for the specified user
Parameters:
- LocalUserNum - the controller number of the associated user
- AchievementId - the id of the achievement to unlock
Returns:
- TRUE if the call worked, FALSE otherwise
UnlockGamerPicture[edit]
Unlocks a gamer picture for the local user
Parameters:
- LocalUserNum - the user to unlock the picture for
- PictureId - the id of the picture to unlock