Engine.OnlinePlayerInterfaceEx

Modifiers

dependson ( OnlineSubsystem )

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.

Engine.OnlinePlayerInterfaceEx

Delegates Summary
		OnDeviceSelectionComplete (bool bWasSuccessful)
		OnProfileDataChanged ()
		OnUnlockAchievementComplete (bool bWasSuccessful)

Functions Summary
		AddDeviceSelectionDoneDelegate (byte LocalUserNum, elegate<OnDeviceSelectionComplete> DeviceDelegate)
		AddProfileDataChangedDelegate (byte LocalUserNum, elegate<OnProfileDataChanged> ProfileDataChangedDelegate)
		AddUnlockAchievementCompleteDelegate (byte LocalUserNum, elegate<OnUnlockAchievementComplete> UnlockAchievementCompleteDelegate)
		ClearDeviceSelectionDoneDelegate (byte LocalUserNum, elegate<OnDeviceSelectionComplete> DeviceDelegate)
		ClearProfileDataChangedDelegate (byte LocalUserNum, elegate<OnProfileDataChanged> ProfileDataChangedDelegate)
		ClearUnlockAchievementCompleteDelegate (byte LocalUserNum, elegate<OnUnlockAchievementComplete> UnlockAchievementCompleteDelegate)
	int	GetDeviceSelectionResults (byte LocalUserNum, ut string DeviceName)
	bool	IsAchievementUnlocked (int AchievementId)
	bool	IsDeviceValid (int DeviceId)
	bool	ShowAchievementsUI (byte LocalUserNum)
	bool	ShowContentMarketplaceUI (byte LocalUserNum)
	bool	ShowDeviceSelectionUI (byte LocalUserNum, nt SizeNeeded, ool bForceShowUI = false)
	bool	ShowFeedbackUI (byte LocalUserNum, niqueNetId PlayerId)
	bool	ShowFriendsInviteUI (byte LocalUserNum, niqueNetId PlayerId)
	bool	ShowGamerCardUI (byte LocalUserNum, niqueNetId PlayerId)
	bool	ShowInviteUI (byte LocalUserNum, ptional string InviteText)
	bool	ShowMembershipMarketplaceUI (byte LocalUserNum)
	bool	ShowMessagesUI (byte LocalUserNum)
	bool	ShowPlayersUI (byte LocalUserNum)
	bool	UnlockAchievement (byte LocalUserNum, nt AchievementId)
	bool	UnlockGamerPicture (byte LocalUserNum, nt PictureId)

OnDeviceSelectionComplete Source code

Delegate used when the device selection request has completed
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnProfileDataChanged Source code

Called when an external change to player profile data has occured

OnUnlockAchievementComplete Source code

Delegate used when the achievement unlocking has completed
@param bWasSuccessful true if the async action completed without error, false if there was an error

AddDeviceSelectionDoneDelegate Source code

Adds the delegate used to notify the gameplay code that the user has completed their device selection
@param DeviceDelegate the delegate to use for notifications

AddProfileDataChangedDelegate Source code

Sets the delegate used to notify the gameplay code that someone has changed their profile data externally
@param LocalUserNum the user the delegate is interested in
@param ProfileDataChangedDelegate the delegate to use for notifications

AddUnlockAchievementCompleteDelegate Source code

Adds the delegate used to notify the gameplay code that the achievement unlocking has completed
@param LocalUserNum which user to watch for read complete notifications
@param UnlockAchievementCompleteDelegate the delegate to use for notifications

ClearDeviceSelectionDoneDelegate Source code

Removes the specified delegate from the list of callbacks
@param DeviceDelegate the delegate to use for notifications

ClearProfileDataChangedDelegate Source code

Clears the delegate used to notify the gameplay code that someone has changed their profile data externally
@param LocalUserNum the user the delegate is interested in
@param ProfileDataChangedDelegate the delegate to use for notifications

ClearUnlockAchievementCompleteDelegate Source code

Clears the delegate used to notify the gameplay code that the achievement unlocking has completed
@param LocalUserNum which user to watch for read complete notifications
@param UnlockAchievementCompleteDelegate the delegate to use for notifications

GetDeviceSelectionResults Source code

Fetches the results of the device selection
@param LocalUserNum the player to check the results for
@param DeviceName out param that gets a copy of the string
@return the ID of the device that was selected NOTE: Zero means the user hasn't selected one

IsAchievementUnlocked Source code

Returns whether or not an achievement has been unlocked
@return true if the achievement is already unlocked, false otherwise

IsDeviceValid Source code

Checks the device id to determine if it is still valid (could be removed)
@param DeviceId the device to check
@return true if valid, false otherwise

ShowAchievementsUI Source code

Displays the achievements UI for a player
@param LocalUserNum the controller number of the associated user
@return TRUE if it was able to show the UI, FALSE if it failed

ShowContentMarketplaceUI Source code

Displays the marketplace UI for content
@param LocalUserNum the local user viewing available content

ShowDeviceSelectionUI Source code

Displays the UI that allows the user to choose which device to save content to
@param LocalUserNum the controller number of the associated user
@param SizeNeeded the size of the data to be saved in bytes
@param bForceShowUI true to always show the UI, false to only show the UI if there are multiple valid choices
@return TRUE if it was able to show the UI, FALSE if it failed

ShowFeedbackUI Source code

Displays the UI that allows a player to give feedback on another player
@param LocalUserNum the controller number of the associated user
@param PlayerId the id of the player having feedback given for
@return TRUE if it was able to show the UI, FALSE if it failed

ShowFriendsInviteUI Source code

Displays the UI that shows a user's list of friends
@param LocalUserNum the controller number of the associated user
@param PlayerId the id of the player being invited
@return TRUE if it was able to show the UI, FALSE if it failed

ShowGamerCardUI Source code

Displays the gamer card UI for the specified player
@param LocalUserNum the controller number of the associated user
@param PlayerId the id of the player to show the gamer card of
@return TRUE if it was able to show the UI, FALSE if it failed

ShowInviteUI Source code

Displays the invite ui
@param LocalUserNum the local user sending the invite
@param InviteText the string to prefill the UI with

ShowMembershipMarketplaceUI Source code

Displays the marketplace UI for memberships
@param LocalUserNum the local user viewing available memberships

ShowMessagesUI Source code

Displays the messages UI for a player
@param LocalUserNum the controller number of the associated user
@return TRUE if it was able to show the UI, FALSE if it failed

ShowPlayersUI Source code

Displays the UI that shows the player list
@param LocalUserNum the controller number of the associated user
@return TRUE if it was able to show the UI, FALSE if it failed

UnlockAchievement Source code

Unlocks the specified achievement for the specified user
@param LocalUserNum the controller number of the associated user
@param AchievementId the id of the achievement to unlock
@return TRUE if the call worked, FALSE otherwise

UnlockGamerPicture Source code

Unlocks a gamer picture for the local user
@param LocalUserNum the user to unlock the picture for
@param PictureId the id of the picture to unlock

defaultproperties
{
   Name="Default__OnlinePlayerInterfaceEx"
   ObjectArchetype=Interface'Core.Default__Interface'
}