Engine.OnlinePlayerInterface

Modifiers

dependson ( OnlineSubsystem )

This interface provides accessors to the platform specific player methods. NOTE: All players are referenced by their controller number, which is zero on the PC.

Engine.OnlinePlayerInterface

Delegates Summary
		OnAddFriendByNameComplete (bool bWasSuccessful)
		OnFriendInviteReceived (byte LocalUserNum, niqueNetId RequestingPlayer, tring RequestingNick, tring Message)
		OnFriendMessageReceived (byte LocalUserNum, niqueNetId SendingPlayer, tring SendingNick, tring Message)
		OnFriendsChange ()
		OnJoinFriendGameComplete (bool bWasSuccessful)
		OnKeyboardInputComplete (bool bWasSuccessful)
		OnLoginCancelled ()
		OnLoginChange ()
		OnLoginFailed (byte LocalUserNum, OnlineServerConnectionStatus ErrorCode)
		OnLogoutCompleted (bool bWasSuccessful)
		OnMutingChange ()
		OnReadFriendsComplete (bool bWasSuccessful)
		OnReadProfileSettingsComplete (bool bWasSuccessful)
		OnReceivedGameInvite (byte LocalUserNum, tring InviterName)
		OnWriteProfileSettingsComplete (bool bWasSuccessful)

Functions Summary
	bool	AcceptFriendInvite (byte LocalUserNum, niqueNetId RequestingPlayer)
		AddAddFriendByNameCompleteDelegate (byte LocalUserNum, elegate<OnAddFriendByNameComplete> FriendDelegate)
	bool	AddFriend (byte LocalUserNum, niqueNetId NewFriend, ptional string Message)
	bool	AddFriendByName (byte LocalUserNum, tring FriendName, ptional string Message)
		AddFriendInviteReceivedDelegate (byte LocalUserNum, elegate<OnFriendInviteReceived> InviteDelegate)
		AddFriendMessageReceivedDelegate (byte LocalUserNum, elegate<OnFriendMessageReceived> MessageDelegate)
		AddFriendsChangeDelegate (byte LocalUserNum, elegate<OnFriendsChange> FriendsDelegate)
		AddJoinFriendGameCompleteDelegate (delegate<OnJoinFriendGameComplete> JoinFriendGameCompleteDelegate)
		AddKeyboardInputDoneDelegate (delegate<OnKeyboardInputComplete> InputDelegate)
		AddLoginCancelledDelegate (delegate<OnLoginCancelled> CancelledDelegate)
		AddLoginChangeDelegate (delegate<OnLoginChange> LoginDelegate, ptional byte LocalUserNum = 255)
		AddLoginFailedDelegate (byte LocalUserNum, elegate<OnLoginFailed> LoginDelegate)
		AddLogoutCompletedDelegate (byte LocalUserNum, elegate<OnLogoutCompleted> LogoutDelegate)
		AddMutingChangeDelegate (delegate<OnMutingChange> MutingDelegate)
		AddReadFriendsCompleteDelegate (byte LocalUserNum, elegate<OnReadFriendsComplete> ReadFriendsCompleteDelegate)
		AddReadProfileSettingsCompleteDelegate (byte LocalUserNum, elegate<OnReadProfileSettingsComplete> ReadProfileSettingsCompleteDelegate)
		AddReceivedGameInviteDelegate (byte LocalUserNum, elegate<OnReceivedGameInvite> ReceivedGameInviteDelegate)
		AddWriteProfileSettingsCompleteDelegate (byte LocalUserNum, elegate<OnWriteProfileSettingsComplete> WriteProfileSettingsCompleteDelegate)
	bool	AreAnyFriends (byte LocalUserNum, ut array<FriendsQuery> Query)
	bool	AutoLogin ()
	EFeaturePrivilegeLevel	CanCommunicate (byte LocalUserNum)
	EFeaturePrivilegeLevel	CanDownloadUserContent (byte LocalUserNum)
	EFeaturePrivilegeLevel	CanPlayOnline (byte LocalUserNum)
	EFeaturePrivilegeLevel	CanPurchaseContent (byte LocalUserNum)
	EFeaturePrivilegeLevel	CanShowPresenceInformation (byte LocalUserNum)
	EFeaturePrivilegeLevel	CanViewPlayerProfiles (byte LocalUserNum)
		ClearAddFriendByNameCompleteDelegate (byte LocalUserNum, elegate<OnAddFriendByNameComplete> FriendDelegate)
		ClearFriendInviteReceivedDelegate (byte LocalUserNum, elegate<OnFriendInviteReceived> InviteDelegate)
		ClearFriendMessageReceivedDelegate (byte LocalUserNum, elegate<OnFriendMessageReceived> MessageDelegate)
		ClearFriendsChangeDelegate (byte LocalUserNum, elegate<OnFriendsChange> FriendsDelegate)
		ClearJoinFriendGameCompleteDelegate (delegate<OnJoinFriendGameComplete> JoinFriendGameCompleteDelegate)
		ClearKeyboardInputDoneDelegate (delegate<OnKeyboardInputComplete> InputDelegate)
		ClearLoginCancelledDelegate (delegate<OnLoginCancelled> CancelledDelegate)
		ClearLoginChangeDelegate (delegate<OnLoginChange> LoginDelegate, ptional byte LocalUserNum = 255)
		ClearLoginFailedDelegate (byte LocalUserNum, elegate<OnLoginFailed> LoginDelegate)
		ClearLogoutCompletedDelegate (byte LocalUserNum, elegate<OnLogoutCompleted> LogoutDelegate)
		ClearMutingChangeDelegate (delegate<OnMutingChange> MutingDelegate)
		ClearReadFriendsCompleteDelegate (byte LocalUserNum, elegate<OnReadFriendsComplete> ReadFriendsCompleteDelegate)
		ClearReadProfileSettingsCompleteDelegate (byte LocalUserNum, elegate<OnReadProfileSettingsComplete> ReadProfileSettingsCompleteDelegate)
		ClearReceivedGameInviteDelegate (byte LocalUserNum, elegate<OnReceivedGameInvite> ReceivedGameInviteDelegate)
		ClearWriteProfileSettingsCompleteDelegate (byte LocalUserNum, elegate<OnWriteProfileSettingsComplete> WriteProfileSettingsCompleteDelegate)
	bool	DeleteMessage (byte LocalUserNum, nt MessageIndex)
	bool	DenyFriendInvite (byte LocalUserNum, niqueNetId RequestingPlayer)
		GetFriendMessages (byte LocalUserNum, ut array<OnlineFriendMessage> FriendMessages)
	EOnlineEnumerationReadState	GetFriendsList (byte LocalUserNum, ut array<OnlineFriend> Friends, ptional int Count, ptional int StartingAt)
	string	GetKeyboardInputResults (out byte bWasCanceled)
	ELoginStatus	GetLoginStatus (byte LocalUserNum)
	string	GetPlayerNickname (byte LocalUserNum)
	OnlineProfileSettings	GetProfileSettings (byte LocalUserNum)
	bool	GetUniquePlayerId (byte LocalUserNum, ut UniqueNetId PlayerId)
	bool	IsFriend (byte LocalUserNum, niqueNetId PlayerId)
	bool	IsMuted (byte LocalUserNum, niqueNetId PlayerId)
	bool	JoinFriendGame (byte LocalUserNum, niqueNetId Friend)
	bool	Login (byte LocalUserNum, tring LoginName, tring Password, ptional bool bWantsLocalOnly)
	bool	Logout (byte LocalUserNum)
	bool	ReadFriendsList (byte LocalUserNum, ptional int Count, ptional int StartingAt)
	bool	ReadProfileSettings (byte LocalUserNum, nlineProfileSettings ProfileSettings)
	bool	RemoveFriend (byte LocalUserNum, niqueNetId FormerFriend)
	bool	SendGameInviteToFriend (byte LocalUserNum, niqueNetId Friend, ptional string Text)
	bool	SendGameInviteToFriends (byte LocalUserNum, rray<UniqueNetId> Friends, ptional string Text)
	bool	SendMessageToFriend (byte LocalUserNum, niqueNetId Friend, tring Message)
		SetOnlineStatus (byte LocalUserNum, nt StatusId, onst out array<LocalizedStringSetting> LocalizedStringSettings, onst out array<SettingsProperty> Properties)
	bool	ShowFriendsUI (byte LocalUserNum)
	bool	ShowKeyboardUI (byte LocalUserNum, tring TitleText, tring DescriptionText, optional bool bIsPassword = false, optional bool bShouldValidate = true, optional string DefaultText, optional int MaxResultLength = 256)
	bool	ShowLoginUI (optional bool bShowOnlineOnly = false)
	bool	WriteProfileSettings (byte LocalUserNum, nlineProfileSettings ProfileSettings)

OnAddFriendByNameComplete Source code

Called when a friend invite arrives for a local player
@param bWasSuccessful true if successfully added, false if not found or failed

OnFriendInviteReceived Source code

Called when a friend invite arrives for a local player
@param LocalUserNum the user that is receiving the invite
@param RequestingPlayer the player sending the friend request
@param RequestingNick the nick of the player sending the friend request
@param Message the message to display to the recipient

OnFriendMessageReceived Source code

Called when a friend invite arrives for a local player
@param LocalUserNum the user that is receiving the message
@param SendingPlayer the player sending the message
@param SendingNick the nick of the player sending the message
@param Message the message to display to the recipient

OnFriendsChange Source code

Delegate used in friends list change notifications

OnJoinFriendGameComplete Source code

Called once the join task has completed
@param bWasSuccessful the session was found and is joinable, false otherwise

OnKeyboardInputComplete Source code

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

OnLoginCancelled Source code

Delegate used to notify when a login request was cancelled by the user

OnLoginChange Source code

Delegate used in login notifications

OnLoginFailed Source code

Delegate used in notifying the UI/game that the manual login failed
@param LocalUserNum the controller number of the associated user
@param ErrorCode the async error code that occurred

OnLogoutCompleted Source code

Delegate used in notifying the UI/game that the manual logout completed
@param bWasSuccessful whether the async call completed properly or not

OnMutingChange Source code

Delegate used in mute list change notifications

OnReadFriendsComplete Source code

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

OnReadProfileSettingsComplete Source code

Delegate used when the last read profile settings request has completed
@param bWasSuccessful true if the async action completed without error, false if there was an error

OnReceivedGameInvite Source code

Called when the online system receives a game invite that needs handling
@param LocalUserNum the user that is receiving the invite
@param InviterName the nick name of the person sending the invite

OnWriteProfileSettingsComplete Source code

Delegate used when the last write profile settings request has completed
@param bWasSuccessful true if the async action completed without error, false if there was an error

AcceptFriendInvite Source code

Used to accept a friend invite sent to this player
@param LocalUserNum the user the invite is for
@param RequestingPlayer the player the invite is from
@param true if successful, false otherwise

AddAddFriendByNameCompleteDelegate Source code

Adds the delegate used to notify the gameplay code that the user has received a friend invite
@param LocalUserNum the user associated with the notification
@param FriendDelegate the delegate to use for notifications

AddFriend Source code

Sends a friend invite to the specified player
@param LocalUserNum the user that is sending the invite
@param NewFriend the player to send the friend request to
@param Message the message to display to the recipient
@return true if successful, false otherwise

AddFriendByName Source code

Sends a friend invite to the specified player nick
@param LocalUserNum the user that is sending the invite
@param FriendName the name of the player to send the invite to
@param Message the message to display to the recipient
@return true if successful, false otherwise

AddFriendInviteReceivedDelegate Source code

Adds the delegate used to notify the gameplay code that the user has received a friend invite
@param LocalUserNum the user associated with the notification
@param InviteDelegate the delegate to use for notifications

AddFriendMessageReceivedDelegate Source code

Adds the delegate used to notify the gameplay code that the user has received a friend invite
@param LocalUserNum the user associated with the notification
@param MessageDelegate the delegate to use for notifications

AddFriendsChangeDelegate Source code

Sets the delegate used to notify the gameplay code that a friends list changed
@param LocalUserNum the user to read the friends list of
@param FriendsDelegate the delegate to use for notifications

AddJoinFriendGameCompleteDelegate Source code

Sets the delegate used to notify when the join friend is complete
@param JoinFriendGameCompleteDelegate the delegate to use for notifications

AddKeyboardInputDoneDelegate Source code

Adds the delegate used to notify the gameplay code that the user has completed their keyboard input
@param InputDelegate the delegate to use for notifications

AddLoginCancelledDelegate Source code

Adds a delegate to the list of delegates that are fired when a login is cancelled
@param CancelledDelegate the delegate to add to the list

AddLoginChangeDelegate Source code

Sets the delegate used to notify the gameplay code that a login changed
@param LoginDelegate the delegate to use for notifications
@param LocalUserNum whether to watch for changes on a specific slot or all slots

AddLoginFailedDelegate Source code

Sets the delegate used to notify the gameplay code that a login failed
@param LocalUserNum the controller number of the associated user
@param LoginDelegate the delegate to use for notifications

AddLogoutCompletedDelegate Source code

Sets the delegate used to notify the gameplay code that a logout completed
@param LocalUserNum the controller number of the associated user
@param LogoutDelegate the delegate to use for notifications

AddMutingChangeDelegate Source code

Sets the delegate used to notify the gameplay code that a muting list changed
@param MutingDelegate the delegate to use for notifications

AddReadFriendsCompleteDelegate Source code

Sets the delegate used to notify the gameplay code that the friends read request has completed
@param LocalUserNum the user to read the friends list of
@param ReadFriendsCompleteDelegate the delegate to use for notifications

AddReadProfileSettingsCompleteDelegate Source code

Sets the delegate used to notify the gameplay code that the last read request has completed
@param LocalUserNum which user to watch for read complete notifications
@param ReadProfileSettingsCompleteDelegate the delegate to use for notifications

AddReceivedGameInviteDelegate Source code

Adds the delegate used to notify the gameplay code that the user has received a game invite
@param LocalUserNum the user associated with the notification
@param ReceivedGameInviteDelegate the delegate to use for notifications

AddWriteProfileSettingsCompleteDelegate Source code

Sets the delegate used to notify the gameplay code that the last write request has completed
@param LocalUserNum which user to watch for write complete notifications
@param WriteProfileSettingsCompleteDelegate the delegate to use for notifications

AreAnyFriends Source code

Checks that whether a group of player ids are among the specified player's friends
@param LocalUserNum the controller number of the associated user
@param Query an array of players to check for being included on the friends list
@return TRUE if the call succeeded, FALSE otherwise

AutoLogin Source code

Logs the player into the online service using parameters passed on the command line. Expects -Login= -Password=. If either are missing, the function returns false and doesn't start the login process
@return true if the async call started ok, false otherwise

CanCommunicate Source code

Determines whether the player is allowed to use voice or text chat online
@param LocalUserNum the controller number of the associated user
@return the Privilege level that is enabled

CanDownloadUserContent Source code

Determines whether the player is allowed to download user created content
@param LocalUserNum the controller number of the associated user
@return the Privilege level that is enabled

CanPlayOnline Source code

Determines whether the player is allowed to play online
@param LocalUserNum the controller number of the associated user
@return the Privilege level that is enabled

CanPurchaseContent Source code

Determines whether the player is allowed to buy content online
@param LocalUserNum the controller number of the associated user
@return the Privilege level that is enabled

CanShowPresenceInformation Source code

Determines whether the player is allowed to have their online presence information shown to remote clients
@param LocalUserNum the controller number of the associated user
@return the Privilege level that is enabled

CanViewPlayerProfiles Source code

Determines whether the player is allowed to view other people's player profile
@param LocalUserNum the controller number of the associated user
@return the Privilege level that is enabled

ClearAddFriendByNameCompleteDelegate Source code

Removes the delegate specified from the list
@param LocalUserNum the user associated with the notification
@param FriendDelegate the delegate to use for notifications

ClearFriendInviteReceivedDelegate Source code

Removes the delegate specified from the list
@param LocalUserNum the user associated with the notification
@param InviteDelegate the delegate to use for notifications

ClearFriendMessageReceivedDelegate Source code

Removes the delegate specified from the list
@param LocalUserNum the user associated with the notification
@param MessageDelegate the delegate to use for notifications

ClearFriendsChangeDelegate Source code

Sets the delegate used to notify the gameplay code that a friends list changed
@param LocalUserNum the user to read the friends list of
@param FriendsDelegate the delegate to use for notifications

ClearJoinFriendGameCompleteDelegate Source code

Removes the delegate from the list of notifications
@param JoinFriendGameCompleteDelegate the delegate to use for notifications

ClearKeyboardInputDoneDelegate Source code

Clears the delegate used to notify the gameplay code that the user has completed their keyboard input
@param InputDelegate the delegate to use for notifications

ClearLoginCancelledDelegate Source code

Removes the specified delegate from the notification list
@param CancelledDelegate the delegate to remove fromt he list

ClearLoginChangeDelegate Source code

Removes the specified delegate from the notification list
@param LoginDelegate the delegate to use for notifications
@param LocalUserNum whether to watch for changes on a specific slot or all slots

ClearLoginFailedDelegate Source code

Removes the specified delegate from the notification list
@param LocalUserNum the controller number of the associated user
@param LoginDelegate the delegate to use for notifications

ClearLogoutCompletedDelegate Source code

Removes the specified delegate from the notification list
@param LocalUserNum the controller number of the associated user
@param LogoutDelegate the delegate to use for notifications

ClearMutingChangeDelegate Source code

Clears the delegate used to notify the gameplay code that a muting list changed
@param MutingDelegate the delegate to use for notifications

ClearReadFriendsCompleteDelegate Source code

Clears the delegate used to notify the gameplay code that the friends read request has completed
@param LocalUserNum the user to read the friends list of
@param ReadFriendsCompleteDelegate the delegate to use for notifications

ClearReadProfileSettingsCompleteDelegate Source code

Searches the existing set of delegates for the one specified and removes it from the list
@param LocalUserNum which user to watch for read complete notifications
@param ReadProfileSettingsCompleteDelegate the delegate to find and clear

ClearReceivedGameInviteDelegate Source code

Removes the delegate specified from the list
@param LocalUserNum the user associated with the notification
@param ReceivedGameInviteDelegate the delegate to use for notifications

ClearWriteProfileSettingsCompleteDelegate Source code

Clears the delegate used to notify the gameplay code that the last write request has completed
@param LocalUserNum which user to watch for write complete notifications
@param WriteProfileSettingsCompleteDelegate the delegate to use for notifications

DeleteMessage Source code

Deletes a message from the list of messages
@param LocalUserNum the user that is deleting the message
@param MessageIndex the index of the message to delete
@return true if the message was deleted, false otherwise

DenyFriendInvite Source code

Used to deny a friend request sent to this player
@param LocalUserNum the user the invite is for
@param RequestingPlayer the player the invite is from
@param true if successful, false otherwise

GetFriendMessages Source code

Returns the list of messages for the specified player
@param LocalUserNum the local player wanting to join
@param FriendMessages the set of messages cached locally for the player

GetFriendsList Source code

Copies the list of friends for the player previously retrieved from the online service. The list can be retrieved in whole or in part.
@param LocalUserNum the user to read the friends list of
@param Friends the out array that receives the copied data
@param Count the number of friends to read or zero for all
@param StartingAt the index of the friends list to start at (for pulling partial lists)
@return OERS_Done if the read has completed, otherwise one of the other states

GetKeyboardInputResults Source code

Fetches the results of the input
@param bWasCanceled whether the user cancelled the input or not
@return the string entered by the user. Note the string will be empty if it fails validation

GetLoginStatus Source code

Fetches the login status for a given player
@param LocalUserNum the controller number of the associated user
@return the enum value of their status

GetPlayerNickname Source code

Reads the player's nick name from the online service
@param LocalUserNum the controller number of the associated user
@return a string containing the players nick name

GetProfileSettings Source code

Returns the online profile settings for a given user
@param LocalUserNum the user that we are reading the data for
@return the profile settings object

GetUniquePlayerId Source code

Gets the platform specific unique id for the specified player
@param LocalUserNum the controller number of the associated user
@param PlayerId the byte array that will receive the id
@return TRUE if the call succeeded, FALSE otherwise

IsFriend Source code

Checks that a unique player id is part of the specified user's friends list
@param LocalUserNum the controller number of the associated user
@param PlayerId the id of the player being checked
@return TRUE if a member of their friends list, FALSE otherwise

IsMuted Source code

Checks that a unique player id is on the specified user's mute list
@param LocalUserNum the controller number of the associated user
@param PlayerId the id of the player being checked
@return TRUE if the player should be muted, FALSE otherwise

JoinFriendGame Source code

Allows the local player to follow a friend into a game
@param LocalUserNum the local player wanting to join
@param Friend the player that is being followed
@return true if the async call worked, false otherwise

Login Source code

Logs the player into the online service. If this fails, it generates a OnLoginFailed notification
@param LocalUserNum the controller number of the associated user
@param LoginName the unique identifier for the player
@param Password the password for this account
@param bWantsLocalOnly whether the player wants to sign in locally only or not
@return true if the async call started ok, false otherwise

Logout Source code

Signs the player out of the online service
@param LocalUserNum the controller number of the associated user
@return TRUE if the call succeeded, FALSE otherwise

ReadFriendsList Source code

Starts an async task that retrieves the list of friends for the player from the online service. The list can be retrieved in whole or in part.
@param LocalUserNum the user to read the friends list of
@param Count the number of friends to read or zero for all
@param StartingAt the index of the friends list to start at (for pulling partial lists)
@return true if the read request was issued successfully, false otherwise

ReadProfileSettings Source code

Reads the online profile settings for a given user
@param LocalUserNum the user that we are reading the data for
@param ProfileSettings the object to copy the results to and contains the list of items to read
@return true if the call succeeds, false otherwise

RemoveFriend Source code

Removes a friend from the player's friend list
@param LocalUserNum the user that is removing the friend
@param FormerFriend the player to remove from the friend list
@return true if successful, false otherwise

SendGameInviteToFriend Source code

Sends an invitation to play in the player's current session
@param LocalUserNum the user that is sending the invite
@param Friend the player to send the invite to
@param Text the text of the message for the invite
@return true if successful, false otherwise

SendGameInviteToFriends Source code

Sends invitations to play in the player's current session
@param LocalUserNum the user that is sending the invite
@param Friends the player to send the invite to
@param Text the text of the message for the invite
@return true if successful, false otherwise

SendMessageToFriend Source code

Sends a message to a friend
@param LocalUserNum the user that is sending the message
@param Friend the player to send the message to
@param Message the message to display to the recipient
@return true if successful, false otherwise

SetOnlineStatus Source code

Sets the online status information to use for the specified player. Used to tell other players what the player is doing (playing, menus, away, etc.)
@param LocalUserNum the controller number of the associated user
@param StatusId the status id to use (maps to strings where possible)
@param LocalizedStringSettings the list of localized string settings to set
@param Properties the list of properties to set

ShowFriendsUI Source code

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

ShowKeyboardUI Source code

Displays the UI that shows the keyboard for inputing text
@param LocalUserNum the controller number of the associated user
@param TitleText the title to display to the user
@param DescriptionText the text telling the user what to input
@param bIsPassword whether the item being entered is a password or not
@param bShouldValidate whether to apply the string validation API after input or not
@param DefaultText the default string to display
@param MaxResultLength the maximum length string expected to be filled in
@return TRUE if it was able to show the UI, FALSE if it failed

ShowLoginUI Source code

Displays the UI that prompts the user for their login credentials. Each platform handles the authentication of the user's data.
@param bShowOnlineOnly whether to only display online enabled profiles or not
@return TRUE if it was able to show the UI, FALSE if it failed

WriteProfileSettings Source code

Writes the online profile settings for a given user to the online data store
@param LocalUserNum the user that we are writing the data for
@param ProfileSettings the list of settings to write out
@return true if the call succeeds, false otherwise

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