UE3:OnlinePlayerInterface functions (UT3)

OnlinePlayerInterface (functions)

OnlinePlayerInterface functions in other games:

UDK

Functions

Instance functions

AcceptFriendInvite

function bool AcceptFriendInvite (byte LocalUserNum, OnlineSubsystem.UniqueNetId RequestingPlayer)

Used to accept a friend invite sent to this player

Parameters:

• LocalUserNum - the user the invite is for
• RequestingPlayer - the player the invite is from
• true - if successful, false otherwise

AddAddFriendByNameCompleteDelegate

function AddAddFriendByNameCompleteDelegate (byte LocalUserNum, delegate<OnAddFriendByNameComplete> FriendDelegate)

Adds the delegate used to notify the gameplay code that the user has received a friend invite

Parameters:

• LocalUserNum - the user associated with the notification
• FriendDelegate - the delegate to use for notifications

AddFriend

function bool AddFriend (byte LocalUserNum, OnlineSubsystem.UniqueNetId NewFriend, optional string Message)

Sends a friend invite to the specified player

Parameters:

• LocalUserNum - the user that is sending the invite
• NewFriend - the player to send the friend request to
• Message - the message to display to the recipient

Returns:

true if successful, false otherwise

AddFriendByName

function bool AddFriendByName (byte LocalUserNum, string FriendName, optional string Message)

Sends a friend invite to the specified player nick

Parameters:

• LocalUserNum - the user that is sending the invite
• FriendName - the name of the player to send the invite to
• Message - the message to display to the recipient

Returns:

true if successful, false otherwise

AddFriendInviteReceivedDelegate

function AddFriendInviteReceivedDelegate (byte LocalUserNum, delegate<OnFriendInviteReceived> InviteDelegate)

Adds the delegate used to notify the gameplay code that the user has received a friend invite

Parameters:

• LocalUserNum - the user associated with the notification
• InviteDelegate - the delegate to use for notifications

AddFriendMessageReceivedDelegate

function AddFriendMessageReceivedDelegate (byte LocalUserNum, delegate<OnFriendMessageReceived> MessageDelegate)

Adds the delegate used to notify the gameplay code that the user has received a friend invite

Parameters:

• LocalUserNum - the user associated with the notification
• MessageDelegate - the delegate to use for notifications

AddFriendsChangeDelegate

function AddFriendsChangeDelegate (byte LocalUserNum, delegate<OnFriendsChange> FriendsDelegate)

Sets the delegate used to notify the gameplay code that a friends list changed

Parameters:

• LocalUserNum - the user to read the friends list of
• FriendsDelegate - the delegate to use for notifications

AddJoinFriendGameCompleteDelegate

function AddJoinFriendGameCompleteDelegate (delegate<OnJoinFriendGameComplete> JoinFriendGameCompleteDelegate)

Sets the delegate used to notify when the join friend is complete

Parameters:

• JoinFriendGameCompleteDelegate - the delegate to use for notifications

AddKeyboardInputDoneDelegate

function AddKeyboardInputDoneDelegate (delegate<OnKeyboardInputComplete> InputDelegate)

Adds the delegate used to notify the gameplay code that the user has completed their keyboard input

Parameters:

• InputDelegate - the delegate to use for notifications

AddLoginCancelledDelegate

function AddLoginCancelledDelegate (delegate<OnLoginCancelled> CancelledDelegate)

Adds a delegate to the list of delegates that are fired when a login is cancelled

Parameters:

• CancelledDelegate - the delegate to add to the list

AddLoginChangeDelegate

function AddLoginChangeDelegate (delegate<OnLoginChange> LoginDelegate, optional byte LocalUserNum)

Sets the delegate used to notify the gameplay code that a login changed

Parameters:

• LoginDelegate - the delegate to use for notifications
• LocalUserNum - whether to watch for changes on a specific slot or all slots

AddLoginFailedDelegate

function AddLoginFailedDelegate (byte LocalUserNum, delegate<OnLoginFailed> LoginDelegate)

Sets the delegate used to notify the gameplay code that a login failed

Parameters:

• LocalUserNum - the controller number of the associated user
• LoginDelegate - the delegate to use for notifications

AddLogoutCompletedDelegate

function AddLogoutCompletedDelegate (byte LocalUserNum, delegate<OnLogoutCompleted> LogoutDelegate)

Sets the delegate used to notify the gameplay code that a logout completed

Parameters:

• LocalUserNum - the controller number of the associated user
• LogoutDelegate - the delegate to use for notifications

AddMutingChangeDelegate

function AddMutingChangeDelegate (delegate<OnMutingChange> MutingDelegate)

Sets the delegate used to notify the gameplay code that a muting list changed

Parameters:

• MutingDelegate - the delegate to use for notifications

AddReadFriendsCompleteDelegate

function AddReadFriendsCompleteDelegate (byte LocalUserNum, delegate<OnReadFriendsComplete> ReadFriendsCompleteDelegate)

Sets the delegate used to notify the gameplay code that the friends read request has completed

Parameters:

• LocalUserNum - the user to read the friends list of
• ReadFriendsCompleteDelegate - the delegate to use for notifications

AddReadProfileSettingsCompleteDelegate

function AddReadProfileSettingsCompleteDelegate (byte LocalUserNum, delegate<OnReadProfileSettingsComplete> ReadProfileSettingsCompleteDelegate)

Sets the delegate used to notify the gameplay code that the last read request has completed

Parameters:

• LocalUserNum - which user to watch for read complete notifications
• ReadProfileSettingsCompleteDelegate - the delegate to use for notifications

AddReceivedGameInviteDelegate

function AddReceivedGameInviteDelegate (byte LocalUserNum, delegate<OnReceivedGameInvite> ReceivedGameInviteDelegate)

Adds the delegate used to notify the gameplay code that the user has received a game invite

Parameters:

• LocalUserNum - the user associated with the notification
• ReceivedGameInviteDelegate - the delegate to use for notifications

AddWriteProfileSettingsCompleteDelegate

function AddWriteProfileSettingsCompleteDelegate (byte LocalUserNum, delegate<OnWriteProfileSettingsComplete> WriteProfileSettingsCompleteDelegate)

Sets the delegate used to notify the gameplay code that the last write request has completed

Parameters:

• LocalUserNum - which user to watch for write complete notifications
• WriteProfileSettingsCompleteDelegate - the delegate to use for notifications

AreAnyFriends

function bool AreAnyFriends (byte LocalUserNum, out array<OnlineSubsystem.FriendsQuery> Query)

Checks that whether a group of player ids are among the specified player's friends

Parameters:

• LocalUserNum - the controller number of the associated user
• Query - an array of players to check for being included on the friends list

Returns:

TRUE if the call succeeded, FALSE otherwise

AutoLogin

function bool AutoLogin ()

Logs the player into the online service using parameters passed on the command line. Expects -Login=<UserName> -Password=<password>. If either are missing, the function returns false and doesn't start the login process

Returns:

true if the async call started ok, false otherwise

CanCommunicate

function OnlineSubsystem.EFeaturePrivilegeLevel CanCommunicate (byte LocalUserNum)

Determines whether the player is allowed to use voice or text chat online

Parameters:

• LocalUserNum - the controller number of the associated user

Returns:

the Privilege level that is enabled

CanDownloadUserContent

function OnlineSubsystem.EFeaturePrivilegeLevel CanDownloadUserContent (byte LocalUserNum)

Determines whether the player is allowed to download user created content

Parameters:

• LocalUserNum - the controller number of the associated user

Returns:

the Privilege level that is enabled

CanPlayOnline

function OnlineSubsystem.EFeaturePrivilegeLevel CanPlayOnline (byte LocalUserNum)

Determines whether the player is allowed to play online

Parameters:

• LocalUserNum - the controller number of the associated user

Returns:

the Privilege level that is enabled

CanPurchaseContent

function OnlineSubsystem.EFeaturePrivilegeLevel CanPurchaseContent (byte LocalUserNum)

Determines whether the player is allowed to buy content online

Parameters:

• LocalUserNum - the controller number of the associated user

Returns:

the Privilege level that is enabled

CanShowPresenceInformation

function OnlineSubsystem.EFeaturePrivilegeLevel CanShowPresenceInformation (byte LocalUserNum)

Determines whether the player is allowed to have their online presence information shown to remote clients

Parameters:

• LocalUserNum - the controller number of the associated user

Returns:

the Privilege level that is enabled

CanViewPlayerProfiles

function OnlineSubsystem.EFeaturePrivilegeLevel CanViewPlayerProfiles (byte LocalUserNum)

Determines whether the player is allowed to view other people's player profile

Parameters:

• LocalUserNum - the controller number of the associated user

Returns:

the Privilege level that is enabled

ClearAddFriendByNameCompleteDelegate

function ClearAddFriendByNameCompleteDelegate (byte LocalUserNum, delegate<OnAddFriendByNameComplete> FriendDelegate)

Removes the delegate specified from the list

Parameters:

• LocalUserNum - the user associated with the notification
• FriendDelegate - the delegate to use for notifications

ClearFriendInviteReceivedDelegate

function ClearFriendInviteReceivedDelegate (byte LocalUserNum, delegate<OnFriendInviteReceived> InviteDelegate)

Removes the delegate specified from the list

Parameters:

• LocalUserNum - the user associated with the notification
• InviteDelegate - the delegate to use for notifications

ClearFriendMessageReceivedDelegate

function ClearFriendMessageReceivedDelegate (byte LocalUserNum, delegate<OnFriendMessageReceived> MessageDelegate)

Removes the delegate specified from the list

Parameters:

• LocalUserNum - the user associated with the notification
• MessageDelegate - the delegate to use for notifications

ClearFriendsChangeDelegate

function ClearFriendsChangeDelegate (byte LocalUserNum, delegate<OnFriendsChange> FriendsDelegate)

Sets the delegate used to notify the gameplay code that a friends list changed

Parameters:

• LocalUserNum - the user to read the friends list of
• FriendsDelegate - the delegate to use for notifications

ClearJoinFriendGameCompleteDelegate

function ClearJoinFriendGameCompleteDelegate (delegate<OnJoinFriendGameComplete> JoinFriendGameCompleteDelegate)

Removes the delegate from the list of notifications

Parameters:

• JoinFriendGameCompleteDelegate - the delegate to use for notifications

ClearKeyboardInputDoneDelegate

function ClearKeyboardInputDoneDelegate (delegate<OnKeyboardInputComplete> InputDelegate)

Clears the delegate used to notify the gameplay code that the user has completed their keyboard input

Parameters:

• InputDelegate - the delegate to use for notifications

ClearLoginCancelledDelegate

function ClearLoginCancelledDelegate (delegate<OnLoginCancelled> CancelledDelegate)

Removes the specified delegate from the notification list

Parameters:

• CancelledDelegate - the delegate to remove fromt he list

ClearLoginChangeDelegate

function ClearLoginChangeDelegate (delegate<OnLoginChange> LoginDelegate, optional byte LocalUserNum)

Removes the specified delegate from the notification list

Parameters:

• LoginDelegate - the delegate to use for notifications
• LocalUserNum - whether to watch for changes on a specific slot or all slots

ClearLoginFailedDelegate

function ClearLoginFailedDelegate (byte LocalUserNum, delegate<OnLoginFailed> LoginDelegate)

Removes the specified delegate from the notification list

Parameters:

• LocalUserNum - the controller number of the associated user
• LoginDelegate - the delegate to use for notifications

ClearLogoutCompletedDelegate

function ClearLogoutCompletedDelegate (byte LocalUserNum, delegate<OnLogoutCompleted> LogoutDelegate)

Removes the specified delegate from the notification list

Parameters:

• LocalUserNum - the controller number of the associated user
• LogoutDelegate - the delegate to use for notifications

ClearMutingChangeDelegate

function ClearMutingChangeDelegate (delegate<OnMutingChange> MutingDelegate)

Clears the delegate used to notify the gameplay code that a muting list changed

Parameters:

• MutingDelegate - the delegate to use for notifications

ClearReadFriendsCompleteDelegate

function ClearReadFriendsCompleteDelegate (byte LocalUserNum, delegate<OnReadFriendsComplete> ReadFriendsCompleteDelegate)

Clears the delegate used to notify the gameplay code that the friends read request has completed

Parameters:

• LocalUserNum - the user to read the friends list of
• ReadFriendsCompleteDelegate - the delegate to use for notifications

ClearReadProfileSettingsCompleteDelegate

function ClearReadProfileSettingsCompleteDelegate (byte LocalUserNum, delegate<OnReadProfileSettingsComplete> ReadProfileSettingsCompleteDelegate)

Searches the existing set of delegates for the one specified and removes it from the list

Parameters:

• LocalUserNum - which user to watch for read complete notifications
• ReadProfileSettingsCompleteDelegate - the delegate to find and clear

ClearReceivedGameInviteDelegate

function ClearReceivedGameInviteDelegate (byte LocalUserNum, delegate<OnReceivedGameInvite> ReceivedGameInviteDelegate)

Removes the delegate specified from the list

Parameters:

• LocalUserNum - the user associated with the notification
• ReceivedGameInviteDelegate - the delegate to use for notifications

ClearWriteProfileSettingsCompleteDelegate

function ClearWriteProfileSettingsCompleteDelegate (byte LocalUserNum, delegate<OnWriteProfileSettingsComplete> WriteProfileSettingsCompleteDelegate)

Clears the delegate used to notify the gameplay code that the last write request has completed

Parameters:

• LocalUserNum - which user to watch for write complete notifications
• WriteProfileSettingsCompleteDelegate - the delegate to use for notifications

DeleteMessage

function bool DeleteMessage (byte LocalUserNum, int MessageIndex)

Deletes a message from the list of messages

Parameters:

• LocalUserNum - the user that is deleting the message
• MessageIndex - the index of the message to delete

Returns:

true if the message was deleted, false otherwise

DenyFriendInvite

function bool DenyFriendInvite (byte LocalUserNum, OnlineSubsystem.UniqueNetId RequestingPlayer)

Used to deny a friend request sent to this player

Parameters:

• LocalUserNum - the user the invite is for
• RequestingPlayer - the player the invite is from
• true - if successful, false otherwise

GetFriendMessages

function GetFriendMessages (byte LocalUserNum, out array<OnlineSubsystem.OnlineFriendMessage> FriendMessages)

Returns the list of messages for the specified player

Parameters:

• LocalUserNum - the local player wanting to join
• FriendMessages - the set of messages cached locally for the player

GetFriendsList

function OnlineSubsystem.EOnlineEnumerationReadState GetFriendsList (byte LocalUserNum, out array<OnlineSubsystem.OnlineFriend> Friends, optional int Count, optional int StartingAt)

Copies the list of friends for the player previously retrieved from the online service. The list can be retrieved in whole or in part.

Parameters:

• LocalUserNum - the user to read the friends list of
• Friends - the out array that receives the copied data
• Count - the number of friends to read or zero for all
• StartingAt - the index of the friends list to start at (for pulling partial lists)

Returns:

OERS_Done if the read has completed, otherwise one of the other states

GetKeyboardInputResults

function string GetKeyboardInputResults (out byte bWasCanceled)

Fetches the results of the input

Parameters:

• bWasCanceled - whether the user cancelled the input or not

Returns:

the string entered by the user. Note the string will be empty if it fails validation

GetLoginStatus

function OnlineSubsystem.ELoginStatus GetLoginStatus (byte LocalUserNum)

Fetches the login status for a given player

Parameters:

• LocalUserNum - the controller number of the associated user

Returns:

the enum value of their status

GetPlayerNickname

function string GetPlayerNickname (byte LocalUserNum)

Reads the player's nick name from the online service

Parameters:

• LocalUserNum - the controller number of the associated user

Returns:

a string containing the players nick name

GetProfileSettings

function OnlineProfileSettings GetProfileSettings (byte LocalUserNum)

Returns the online profile settings for a given user

Parameters:

• LocalUserNum - the user that we are reading the data for

Returns:

the profile settings object

GetUniquePlayerId

function bool GetUniquePlayerId (byte LocalUserNum, out OnlineSubsystem.UniqueNetId PlayerId)

Gets the platform specific unique id for the specified player

Parameters:

• LocalUserNum - the controller number of the associated user
• PlayerId - the byte array that will receive the id

Returns:

TRUE if the call succeeded, FALSE otherwise

IsFriend

function bool IsFriend (byte LocalUserNum, OnlineSubsystem.UniqueNetId PlayerId)

Checks that a unique player id is part of the specified user's friends list

Parameters:

• LocalUserNum - the controller number of the associated user
• PlayerId - the id of the player being checked

Returns:

TRUE if a member of their friends list, FALSE otherwise

IsMuted

function bool IsMuted (byte LocalUserNum, OnlineSubsystem.UniqueNetId PlayerId)

Checks that a unique player id is on the specified user's mute list

Parameters:

• LocalUserNum - the controller number of the associated user
• PlayerId - the id of the player being checked

Returns:

TRUE if the player should be muted, FALSE otherwise

JoinFriendGame

function bool JoinFriendGame (byte LocalUserNum, OnlineSubsystem.UniqueNetId Friend)

Allows the local player to follow a friend into a game

Parameters:

• LocalUserNum - the local player wanting to join
• Friend - the player that is being followed

Returns:

true if the async call worked, false otherwise

Login

function bool Login (byte LocalUserNum, string LoginName, string Password, optional bool bWantsLocalOnly)

Logs the player into the online service. If this fails, it generates a OnLoginFailed notification

Parameters:

• LocalUserNum - the controller number of the associated user
• LoginName - the unique identifier for the player
• Password - the password for this account
• bWantsLocalOnly - whether the player wants to sign in locally only or not

Returns:

true if the async call started ok, false otherwise

Logout

function bool Logout (byte LocalUserNum)

Signs the player out of the online service

Parameters:

• LocalUserNum - the controller number of the associated user

Returns:

TRUE if the call succeeded, FALSE otherwise

ReadFriendsList

function bool ReadFriendsList (byte LocalUserNum, optional int Count, optional int StartingAt)

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.

Parameters:

• LocalUserNum - the user to read the friends list of
• Count - the number of friends to read or zero for all
• StartingAt - the index of the friends list to start at (for pulling partial lists)

Returns:

true if the read request was issued successfully, false otherwise

ReadProfileSettings

function bool ReadProfileSettings (byte LocalUserNum, OnlineProfileSettings ProfileSettings)

Reads the online profile settings for a given user

Parameters:

• LocalUserNum - the user that we are reading the data for
• ProfileSettings - the object to copy the results to and contains the list of items to read

Returns:

true if the call succeeds, false otherwise

RemoveFriend

function bool RemoveFriend (byte LocalUserNum, OnlineSubsystem.UniqueNetId FormerFriend)

Removes a friend from the player's friend list

Parameters:

• LocalUserNum - the user that is removing the friend
• FormerFriend - the player to remove from the friend list

Returns:

true if successful, false otherwise

SendGameInviteToFriend

function bool SendGameInviteToFriend (byte LocalUserNum, OnlineSubsystem.UniqueNetId Friend, optional string Text)

Sends an invitation to play in the player's current session

Parameters:

• LocalUserNum - the user that is sending the invite
• Friend - the player to send the invite to
• Text - the text of the message for the invite

Returns:

true if successful, false otherwise

SendGameInviteToFriends

function bool SendGameInviteToFriends (byte LocalUserNum, array<OnlineSubsystem.UniqueNetId> Friends, optional string Text)

Sends invitations to play in the player's current session

Parameters:

• LocalUserNum - the user that is sending the invite
• Friends - the player to send the invite to
• Text - the text of the message for the invite

Returns:

true if successful, false otherwise

SendMessageToFriend

function bool SendMessageToFriend (byte LocalUserNum, OnlineSubsystem.UniqueNetId Friend, string Message)

Sends a message to a friend

Parameters:

• LocalUserNum - the user that is sending the message
• Friend - the player to send the message to
• Message - the message to display to the recipient

Returns:

true if successful, false otherwise

SetOnlineStatus

function SetOnlineStatus (byte LocalUserNum, int StatusId, const out array<Settings.LocalizedStringSetting> LocalizedStringSettings, const out array<Settings.SettingsProperty> Properties)

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.)

Parameters:

• LocalUserNum - the controller number of the associated user
• StatusId - the status id to use (maps to strings where possible)
• LocalizedStringSettings - the list of localized string settings to set
• Properties - the list of properties to set

ShowFriendsUI

function bool ShowFriendsUI (byte LocalUserNum)

Displays the UI that shows a user's list of friends

Parameters:

• LocalUserNum - the controller number of the associated user

Returns:

TRUE if it was able to show the UI, FALSE if it failed

ShowKeyboardUI

function bool ShowKeyboardUI (byte LocalUserNum, string TitleText, string DescriptionText, optional bool bIsPassword, optional bool bShouldValidate, optional string DefaultText, optional int MaxResultLength)

Displays the UI that shows the keyboard for inputing text

Parameters:

• LocalUserNum - the controller number of the associated user
• TitleText - the title to display to the user
• DescriptionText - the text telling the user what to input
• bIsPassword - whether the item being entered is a password or not
• bShouldValidate - whether to apply the string validation API after input or not
• DefaultText - the default string to display
• MaxResultLength - the maximum length string expected to be filled in

Returns:

TRUE if it was able to show the UI, FALSE if it failed

ShowLoginUI

function bool ShowLoginUI (optional bool bShowOnlineOnly)

Displays the UI that prompts the user for their login credentials. Each platform handles the authentication of the user's data.

Parameters:

• bShowOnlineOnly - whether to only display online enabled profiles or not

Returns:

TRUE if it was able to show the UI, FALSE if it failed

WriteProfileSettings

function bool WriteProfileSettings (byte LocalUserNum, OnlineProfileSettings ProfileSettings)

Writes the online profile settings for a given user to the online data store

Parameters:

• LocalUserNum - the user that we are writing the data for
• ProfileSettings - the list of settings to write out

Returns:

true if the call succeeds, false otherwise