UE3:OnlineSubsystemPC instance functions (UDK)

Object >> OnlineSubsystem >> OnlineSubsystemCommonImpl >> OnlineSubsystemPC (instance functions)

;Other member categories for this class::

delegates

Instance functions

AcceptFriendInvite

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

Specified by: OnlinePlayerInterface.AcceptFriendInvite

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)

Specified by: OnlinePlayerInterface.AddAddFriendByNameCompleteDelegate

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

AddConnectionStatusChangeDelegate

function AddConnectionStatusChangeDelegate (delegate<OnConnectionStatusChange> ConnectionStatusDelegate)

Specified by: OnlineSystemInterface.AddConnectionStatusChangeDelegate

Adds the delegate to the list to be notified when the connection status changes

Parameters:

• ConnectionStatusDelegate - the delegate to add

AddControllerChangeDelegate

function AddControllerChangeDelegate (delegate<OnControllerChange> ControllerChangeDelegate)

Specified by: OnlineSystemInterface.AddControllerChangeDelegate

Sets the delegate used to notify the gameplay code that the controller state changed

Parameters:

• ControllerChangeDelegate - the delegate to use for notifications

AddExternalUIChangeDelegate

function AddExternalUIChangeDelegate (delegate<OnExternalUIChange> ExternalUIDelegate)

Specified by: OnlineSystemInterface.AddExternalUIChangeDelegate

Sets the delegate used to notify the gameplay code that external UI state changed (opened/closed)

Parameters:

• ExternalUIDelegate - the delegate to use for notifications

AddFlushOnlineStatsCompleteDelegate

function AddFlushOnlineStatsCompleteDelegate (delegate<OnFlushOnlineStatsComplete> FlushOnlineStatsCompleteDelegate)

Specified by: OnlineStatsInterface.AddFlushOnlineStatsCompleteDelegate

Adds the delegate used to notify the gameplay code that the stats flush has completed

Parameters:

• FlushOnlineStatsCompleteDelegate - the delegate to use for notifications

AddFriend

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

Specified by: OnlinePlayerInterface.AddFriend

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)

Specified by: OnlinePlayerInterface.AddFriendByName

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)

Specified by: OnlinePlayerInterface.AddFriendInviteReceivedDelegate

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)

Specified by: OnlinePlayerInterface.AddFriendMessageReceivedDelegate

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)

Specified by: OnlinePlayerInterface.AddFriendsChangeDelegate

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)

Specified by: OnlinePlayerInterface.AddJoinFriendGameCompleteDelegate

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)

Specified by: OnlinePlayerInterface.AddKeyboardInputDoneDelegate

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

AddLinkStatusChangeDelegate

function AddLinkStatusChangeDelegate (delegate<OnLinkStatusChange> LinkStatusDelegate)

Specified by: OnlineSystemInterface.AddLinkStatusChangeDelegate

Adds the delegate used to notify the gameplay code that link status changed

Parameters:

• LinkStatusDelegate - the delegate to use for notifications

AddLoginCancelledDelegate

function AddLoginCancelledDelegate (delegate<OnLoginCancelled> CancelledDelegate)

Specified by: OnlinePlayerInterface.AddLoginCancelledDelegate

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)

Specified by: OnlinePlayerInterface.AddLoginChangeDelegate

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)

Specified by: OnlinePlayerInterface.AddLoginFailedDelegate

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

AddLoginStatusChangeDelegate

function AddLoginStatusChangeDelegate (delegate<OnLoginStatusChange> LoginStatusDelegate, byte LocalUserNum)

Specified by: OnlinePlayerInterface.AddLoginStatusChangeDelegate

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

Parameters:

• LoginDelegate - the delegate to use for notifications
• LocalUserNum - the player to watch login status changes for

AddLogoutCompletedDelegate

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

Specified by: OnlinePlayerInterface.AddLogoutCompletedDelegate

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)

Specified by: OnlinePlayerInterface.AddMutingChangeDelegate

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

Parameters:

• MutingDelegate - the delegate to use for notifications

AddPlayerTalkingDelegate

function AddPlayerTalkingDelegate (delegate<OnPlayerTalkingStateChange> TalkerDelegate)

Specified by: OnlineVoiceInterface.AddPlayerTalkingDelegate

Adds a talker delegate to the list of notifications

Parameters:

• TalkerDelegate - the delegate to call when a player is talking

AddReadFriendsCompleteDelegate

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

Specified by: OnlinePlayerInterface.AddReadFriendsCompleteDelegate

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

AddReadOnlineStatsCompleteDelegate

function AddReadOnlineStatsCompleteDelegate (delegate<OnReadOnlineStatsComplete> ReadOnlineStatsCompleteDelegate)

Specified by: OnlineStatsInterface.AddReadOnlineStatsCompleteDelegate

Adds the delegate to a list used to notify the gameplay code that the stats read has completed

Parameters:

• ReadOnlineStatsCompleteDelegate - the delegate to use for notifications

AddReadPlayerStorageCompleteDelegate

function AddReadPlayerStorageCompleteDelegate (byte LocalUserNum, delegate<OnReadPlayerStorageComplete> ReadPlayerStorageCompleteDelegate)

Specified by: OnlinePlayerInterface.AddReadPlayerStorageCompleteDelegate

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
• ReadPlayerStorageCompleteDelegate - the delegate to use for notifications

AddReadPlayerStorageForNetIdCompleteDelegate

function AddReadPlayerStorageForNetIdCompleteDelegate (OnlineSubsystem.UniqueNetId NetId, delegate<OnReadPlayerStorageForNetIdComplete> ReadPlayerStorageForNetIdCompleteDelegate)

Specified by: OnlinePlayerInterface.AddReadPlayerStorageForNetIdCompleteDelegate

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

Parameters:

• NetId - the net id for the user to watch for read complete notifications
• ReadPlayerStorageForNetIdCompleteDelegate - the delegate to use for notifications

AddReadProfileSettingsCompleteDelegate

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

Specified by: OnlinePlayerInterface.AddReadProfileSettingsCompleteDelegate

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

AddReadTitleFileCompleteDelegate

function AddReadTitleFileCompleteDelegate (delegate<OnReadTitleFileComplete> ReadTitleFileCompleteDelegate)

Specified by: OnlineSystemInterface.AddReadTitleFileCompleteDelegate

Adds the delegate to the list to be notified when a requested file has been read

Parameters:

• ReadTitleFileCompleteDelegate - the delegate to add

AddReceivedGameInviteDelegate

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

Specified by: OnlinePlayerInterface.AddReceivedGameInviteDelegate

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

AddRecognitionCompleteDelegate

function AddRecognitionCompleteDelegate (byte LocalUserNum, delegate<OnRecognitionComplete> RecognitionDelegate)

Specified by: OnlineVoiceInterface.AddRecognitionCompleteDelegate

Sets the speech recognition notification callback to use for the specified user

Parameters:

• LocalUserNum - the local user to receive notifications for
• RecognitionDelegate - the delegate to call when recognition is complete

AddRegisterHostStatGuidCompleteDelegate

function AddRegisterHostStatGuidCompleteDelegate (delegate<OnFlushOnlineStatsComplete> RegisterHostStatGuidCompleteDelegate)

Specified by: OnlineStatsInterface.AddRegisterHostStatGuidCompleteDelegate

Adds the delegate for notifying when the host guid registration is done

Parameters:

• RegisterHostStatGuidCompleteDelegate - the delegate to use for notifications

AddStorageDeviceChangeDelegate

function AddStorageDeviceChangeDelegate (delegate<OnStorageDeviceChange> StorageDeviceChangeDelegate)

Specified by: OnlineSystemInterface.AddStorageDeviceChangeDelegate

Adds the delegate to the list to be notified when a storage device changes

Parameters:

• StorageDeviceChangeDelegate - the delegate to add

AddWritePlayerStorageCompleteDelegate

function AddWritePlayerStorageCompleteDelegate (byte LocalUserNum, delegate<OnWritePlayerStorageComplete> WritePlayerStorageCompleteDelegate)

Specified by: OnlinePlayerInterface.AddWritePlayerStorageCompleteDelegate

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
• WritePlayerStorageCompleteDelegate - the delegate to use for notifications

AddWriteProfileSettingsCompleteDelegate

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

Specified by: OnlinePlayerInterface.AddWriteProfileSettingsCompleteDelegate

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

AreAnyFriends

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

Specified by: OnlinePlayerInterface.AreAnyFriends

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

Specified by: OnlinePlayerInterface.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)

Specified by: OnlinePlayerInterface.CanCommunicate

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)

Specified by: OnlinePlayerInterface.CanDownloadUserContent

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)

Specified by: OnlinePlayerInterface.CanPlayOnline

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)

Specified by: OnlinePlayerInterface.CanPurchaseContent

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)

Specified by: OnlinePlayerInterface.CanShowPresenceInformation

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)

Specified by: OnlinePlayerInterface.CanViewPlayerProfiles

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)

Specified by: OnlinePlayerInterface.ClearAddFriendByNameCompleteDelegate

Removes the delegate specified from the list

Parameters:

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

ClearConnectionStatusChangeDelegate

function ClearConnectionStatusChangeDelegate (delegate<OnConnectionStatusChange> ConnectionStatusDelegate)

Specified by: OnlineSystemInterface.ClearConnectionStatusChangeDelegate

Removes the delegate from the notify list

Parameters:

• ConnectionStatusDelegate - the delegate to remove

ClearControllerChangeDelegate

function ClearControllerChangeDelegate (delegate<OnControllerChange> ControllerChangeDelegate)

Specified by: OnlineSystemInterface.ClearControllerChangeDelegate

Removes the delegate used to notify the gameplay code that the controller state changed

Parameters:

• ControllerChangeDelegate - the delegate to remove

ClearExternalUIChangeDelegate

function ClearExternalUIChangeDelegate (delegate<OnExternalUIChange> ExternalUIDelegate)

Specified by: OnlineSystemInterface.ClearExternalUIChangeDelegate

Removes the delegate from the notification list

Parameters:

• ExternalUIDelegate - the delegate to remove

ClearFlushOnlineStatsCompleteDelegate

function ClearFlushOnlineStatsCompleteDelegate (delegate<OnFlushOnlineStatsComplete> FlushOnlineStatsCompleteDelegate)

Specified by: OnlineStatsInterface.ClearFlushOnlineStatsCompleteDelegate

Clears the delegate used to notify the gameplay code that the stats flush has completed

Parameters:

• FlushOnlineStatsCompleteDelegate - the delegate to use for notifications

ClearFriendInviteReceivedDelegate

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

Specified by: OnlinePlayerInterface.ClearFriendInviteReceivedDelegate

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)

Specified by: OnlinePlayerInterface.ClearFriendMessageReceivedDelegate

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)

Specified by: OnlinePlayerInterface.ClearFriendsChangeDelegate

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

Parameters:

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

ClearJoinFriendGameCompleteDelegate

function ClearJoinFriendGameCompleteDelegate (delegate<OnJoinFriendGameComplete> JoinFriendGameCompleteDelegate)

Specified by: OnlinePlayerInterface.ClearJoinFriendGameCompleteDelegate

Removes the delegate from the list of notifications

Parameters:

• JoinFriendGameCompleteDelegate - the delegate to use for notifications

ClearKeyboardInputDoneDelegate

function ClearKeyboardInputDoneDelegate (delegate<OnKeyboardInputComplete> InputDelegate)

Specified by: OnlinePlayerInterface.ClearKeyboardInputDoneDelegate

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

ClearLinkStatusChangeDelegate

function ClearLinkStatusChangeDelegate (delegate<OnLinkStatusChange> LinkStatusDelegate)

Specified by: OnlineSystemInterface.ClearLinkStatusChangeDelegate

Removes the delegate from the notify list

Parameters:

• LinkStatusDelegate - the delegate to remove

ClearLoginCancelledDelegate

function ClearLoginCancelledDelegate (delegate<OnLoginCancelled> CancelledDelegate)

Specified by: OnlinePlayerInterface.ClearLoginCancelledDelegate

Removes the specified delegate from the notification list

Parameters:

• CancelledDelegate - the delegate to remove fromt he list

ClearLoginChangeDelegate

function ClearLoginChangeDelegate (delegate<OnLoginChange> LoginDelegate)

Specified by: OnlinePlayerInterface.ClearLoginChangeDelegate

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)

Specified by: OnlinePlayerInterface.ClearLoginFailedDelegate

Removes the specified delegate from the notification list

Parameters:

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

ClearLoginStatusChangeDelegate

function ClearLoginStatusChangeDelegate (delegate<OnLoginStatusChange> LoginStatusDelegate, byte LocalUserNum)

Specified by: OnlinePlayerInterface.ClearLoginStatusChangeDelegate

Removes the specified delegate from the notification list

Parameters:

• LoginDelegate - the delegate to use for notifications
• LocalUserNum - the player to watch login status changes for

ClearLogoutCompletedDelegate

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

Specified by: OnlinePlayerInterface.ClearLogoutCompletedDelegate

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<OnFriendsChange> MutingDelegate)

Specified by: OnlinePlayerInterface.ClearMutingChangeDelegate

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

Parameters:

• FriendsDelegate - the delegate to use for notifications

ClearPlayerTalkingDelegate

function ClearPlayerTalkingDelegate (delegate<OnPlayerTalkingStateChange> TalkerDelegate)

Specified by: OnlineVoiceInterface.ClearPlayerTalkingDelegate

Removes a talker delegate to the list of notifications

Parameters:

• TalkerDelegate - the delegate to remove from the notification list

ClearReadFriendsCompleteDelegate

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

Specified by: OnlinePlayerInterface.ClearReadFriendsCompleteDelegate

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
• ReadFriendsCompleteDelegate - the delegate to find and clear

ClearReadOnlineStatsCompleteDelegate

function ClearReadOnlineStatsCompleteDelegate (delegate<OnReadOnlineStatsComplete> ReadOnlineStatsCompleteDelegate)

Specified by: OnlineStatsInterface.ClearReadOnlineStatsCompleteDelegate

Removes the delegate from the notify list

Parameters:

• ReadOnlineStatsCompleteDelegate - the delegate to use for notifications

ClearReadPlayerStorageCompleteDelegate

function ClearReadPlayerStorageCompleteDelegate (byte LocalUserNum, delegate<OnReadPlayerStorageComplete> ReadPlayerStorageCompleteDelegate)

Specified by: OnlinePlayerInterface.ClearReadPlayerStorageCompleteDelegate

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
• ReadPlayerStorageCompleteDelegate - the delegate to find and clear

ClearReadPlayerStorageForNetIdCompleteDelegate

function ClearReadPlayerStorageForNetIdCompleteDelegate (OnlineSubsystem.UniqueNetId NetId, delegate<OnReadPlayerStorageForNetIdComplete> ReadPlayerStorageForNetIdCompleteDelegate)

Specified by: OnlinePlayerInterface.ClearReadPlayerStorageForNetIdCompleteDelegate

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

Parameters:

• NetId - the net id for the user to watch for read complete notifications
• ReadPlayerStorageForNetIdCompleteDelegate - the delegate to find and clear

ClearReadProfileSettingsCompleteDelegate

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

Specified by: OnlinePlayerInterface.ClearReadProfileSettingsCompleteDelegate

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

ClearReadTitleFileCompleteDelegate

function ClearReadTitleFileCompleteDelegate (delegate<OnReadTitleFileComplete> ReadTitleFileCompleteDelegate)

Specified by: OnlineSystemInterface.ClearReadTitleFileCompleteDelegate

Removes the delegate from the notify list

Parameters:

• ReadTitleFileCompleteDelegate - the delegate to remove

ClearReceivedGameInviteDelegate

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

Specified by: OnlinePlayerInterface.ClearReceivedGameInviteDelegate

Removes the delegate specified from the list

Parameters:

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

ClearRecognitionCompleteDelegate

function ClearRecognitionCompleteDelegate (byte LocalUserNum, delegate<OnRecognitionComplete> RecognitionDelegate)

Specified by: OnlineVoiceInterface.ClearRecognitionCompleteDelegate

Clears the speech recognition notification callback to use for the specified user

Parameters:

• LocalUserNum - the local user to receive notifications for
• RecognitionDelegate - the delegate to call when recognition is complete

ClearRegisterHostStatGuidCompleteDelegateDelegate

function ClearRegisterHostStatGuidCompleteDelegateDelegate (delegate<OnFlushOnlineStatsComplete> RegisterHostStatGuidCompleteDelegate)

Specified by: OnlineStatsInterface.ClearRegisterHostStatGuidCompleteDelegateDelegate

Clears the delegate used to notify the gameplay code

Parameters:

• RegisterHostStatGuidCompleteDelegate - the delegate to use for notifications

ClearStorageDeviceChangeDelegate

function ClearStorageDeviceChangeDelegate (delegate<OnStorageDeviceChange> StorageDeviceChangeDelegate)

Specified by: OnlineSystemInterface.ClearStorageDeviceChangeDelegate

Removes the delegate from the notify list

Parameters:

• ConnectionStatusDelegate - the delegate to remove

ClearWritePlayerStorageCompleteDelegate

function ClearWritePlayerStorageCompleteDelegate (byte LocalUserNum, delegate<OnWritePlayerStorageComplete> WritePlayerStorageCompleteDelegate)

Specified by: OnlinePlayerInterface.ClearWritePlayerStorageCompleteDelegate

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
• WritePlayerStorageCompleteDelegate - the delegate to use for notifications

ClearWriteProfileSettingsCompleteDelegate

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

Specified by: OnlinePlayerInterface.ClearWriteProfileSettingsCompleteDelegate

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

DeleteMessage

function bool DeleteMessage (byte LocalUserNum, int MessageIndex)

Specified by: OnlinePlayerInterface.DeleteMessage

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)

Specified by: OnlinePlayerInterface.DenyFriendInvite

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

FlushOnlineStats

function bool FlushOnlineStats (name SessionName)

Specified by: OnlineStatsInterface.FlushOnlineStats

Commits any changes in the online stats cache to the permanent storage

Parameters:

• SessionName - the name of the session having stats flushed

Returns:

TRUE if the call is successful, FALSE otherwise

FreeStats

function FreeStats (OnlineStatsRead StatsRead)

Specified by: OnlineStatsInterface.FreeStats

Cleans up any platform specific allocated data contained in the stats data

Parameters:

• StatsRead - the object to handle per platform clean up on

GetClientStatGuid

function string GetClientStatGuid ()

Specified by: OnlineStatsInterface.GetClientStatGuid

Reads the client's stat guid that was generated by registering the host's guid Used for synching up stats. Only valid on the client. Only callable after the host registration has completed

Returns:

the client's stat guid

GetFriendMessages

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

Specified by: OnlinePlayerInterface.GetFriendMessages

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)

Specified by: OnlinePlayerInterface.GetFriendsList

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

GetHostStatGuid

function string GetHostStatGuid ()

Specified by: OnlineStatsInterface.GetHostStatGuid

Reads the host's stat guid for synching up stats. Only valid on the host.

Returns:

the host's stat guid

GetKeyboardInputResults

function string GetKeyboardInputResults (out byte bWasCanceled)

Specified by: OnlinePlayerInterface.GetKeyboardInputResults

Fetches the results of the input

Parameters:

• bWasCancelled - whether the user canceled 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)

Specified by: OnlinePlayerInterface.GetLoginStatus

Fetches the login status for a given player

Parameters:

• LocalUserNum - the controller number of the associated user

Returns:

the enum value of their status

GetNATType

function OnlineSubsystem.ENATType GetNATType ()

Specified by: OnlineSystemInterface.GetNATType

Determines the NAT type the player is using

GetNetworkNotificationPosition

function OnlineSubsystem.ENetworkNotificationPosition GetNetworkNotificationPosition ()

Specified by: OnlineSystemInterface.GetNetworkNotificationPosition

Determines the current notification position setting

GetPlayerNickname

function string GetPlayerNickname (byte LocalUserNum)

Specified by: OnlinePlayerInterface.GetPlayerNickname

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

GetPlayerStorage

function OnlinePlayerStorage GetPlayerStorage (byte LocalUserNum)

Specified by: OnlinePlayerInterface.GetPlayerStorage

Returns the online player storage for a given local user

Parameters:

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

Returns:

the player storage object

GetProfileSettings

function OnlineProfileSettings GetProfileSettings (byte LocalUserNum)

Specified by: OnlinePlayerInterface.GetProfileSettings

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

GetRecognitionResults

function bool GetRecognitionResults (byte LocalUserNum, out array<OnlineSubsystem.SpeechRecognizedWord> Words)

Specified by: OnlineVoiceInterface.GetRecognitionResults

Gets the results of the voice recognition

Parameters:

• LocalUserNum - the local user to read the results of
• Words - the set of words that were recognized by the voice analyzer

Returns:

true upon success, false otherwise

GetTitleFileContents

function bool GetTitleFileContents (string FileName, out array<byte> FileContents)

Specified by: OnlineSystemInterface.GetTitleFileContents

Copies the file data into the specified buffer for the specified file

Parameters:

• FileName - the name of the file to read
• FileContents - the out buffer to copy the data into

Returns:

true if the data was copied, false otherwise

GetTitleFileState

function OnlineSubsystem.EOnlineEnumerationReadState GetTitleFileState (string FileName)

Specified by: OnlineSystemInterface.GetTitleFileState

Determines the async state of the tile file read operation

Parameters:

• FileName - the name of the file to check on

Returns:

the async state of the file read

GetUniquePlayerId

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

Specified by: OnlinePlayerInterface.GetUniquePlayerId

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

HasLinkConnection

function bool HasLinkConnection ()

Specified by: OnlineSystemInterface.HasLinkConnection

Determines if the ethernet link is connected or not

IsControllerConnected

function bool IsControllerConnected (int ControllerId)

Specified by: OnlineSystemInterface.IsControllerConnected

Determines if the specified controller is connected or not

Parameters:

• ControllerId - the controller to query

Returns:

true if connected, false otherwise

IsFriend

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

Specified by: OnlinePlayerInterface.IsFriend

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

IsGuestLogin

function bool IsGuestLogin (byte LocalUserNum)

Specified by: OnlinePlayerInterface.IsGuestLogin

Determines whether the specified user is a guest login or not

Parameters:

• LocalUserNum - the controller number of the associated user

Returns:

true if a guest, false otherwise

IsHeadsetPresent

function bool IsHeadsetPresent (byte LocalUserNum)

Specified by: OnlineVoiceInterface.IsHeadsetPresent

Determines if the specified player has a headset connected

Parameters:

• LocalUserNum - the local player index being queried

Returns:

TRUE if the player has a headset plugged in, FALSE otherwise

IsLocalLogin

function bool IsLocalLogin (byte LocalUserNum)

Specified by: OnlinePlayerInterface.IsLocalLogin

Determines whether the specified user is a local (non-online) login or not

Parameters:

• LocalUserNum - the controller number of the associated user

Returns:

true if a local profile, false otherwise

IsLocalPlayerTalking

function bool IsLocalPlayerTalking (byte LocalUserNum)

Specified by: OnlineVoiceInterface.IsLocalPlayerTalking

Determines if the specified player is actively talking into the mic

Parameters:

• LocalUserNum - the local player index being queried

Returns:

TRUE if the player is talking, FALSE otherwise

IsMuted

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

Specified by: OnlinePlayerInterface.IsMuted

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

IsRemotePlayerTalking

function bool IsRemotePlayerTalking (OnlineSubsystem.UniqueNetId PlayerId)

Specified by: OnlineVoiceInterface.IsRemotePlayerTalking

Determines if the specified remote player is actively talking into the mic NOTE: Network latencies will make this not 100% accurate

Parameters:

• PlayerId - the unique id of the remote player being queried

Returns:

TRUE if the player is talking, FALSE otherwise

JoinFriendGame

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

Specified by: OnlinePlayerInterface.JoinFriendGame

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)

Specified by: OnlinePlayerInterface.Login

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)

Specified by: OnlinePlayerInterface.Logout

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

MuteAll

function bool MuteAll (byte LocalUserNum, bool bAllowFriends)

Specified by: OnlineVoiceInterface.MuteAll

Mutes all voice or all but friends

Parameters:

• LocalUserNum - the local user that is making the change
• bAllowFriends - whether to mute everyone or allow friends

MuteRemoteTalker

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

Specified by: OnlineVoiceInterface.MuteRemoteTalker

Mutes a remote talker for the specified local player. NOTE: This is separate from the user's permanent online mute list

Parameters:

• LocalUserNum - the user that is muting the remote talker
• PlayerId - the remote talker that is being muted

Returns:

TRUE if the function succeeds, FALSE otherwise

ReadFriendsList

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

Specified by: OnlinePlayerInterface.ReadFriendsList

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

ReadOnlineStats

function bool ReadOnlineStats (const out array<OnlineSubsystem.UniqueNetId> Players, OnlineStatsRead StatsRead)

Specified by: OnlineStatsInterface.ReadOnlineStats

Reads a set of stats for the specified list of players

Parameters:

• Players - the array of unique ids to read stats for
• StatsRead - holds the definitions of the tables to read the data from and results are copied into the specified object

Returns:

TRUE if the call is successful, FALSE otherwise

ReadOnlineStatsByRank

function bool ReadOnlineStatsByRank (OnlineStatsRead StatsRead, optional int StartIndex, optional int NumToRead)

Specified by: OnlineStatsInterface.ReadOnlineStatsByRank

Reads stats by ranking. This grabs the rows starting at StartIndex through NumToRead and places them in the StatsRead object.

Parameters:

• StatsRead - holds the definitions of the tables to read the data from and results are copied into the specified object
• StartIndex - the starting rank to begin reads at (1 for top)
• NumToRead - the number of rows to read (clamped at 100 underneath)

Returns:

TRUE if the call is successful, FALSE otherwise

ReadOnlineStatsByRankAroundPlayer

function bool ReadOnlineStatsByRankAroundPlayer (byte LocalUserNum, OnlineStatsRead StatsRead, optional int NumRows)

Specified by: OnlineStatsInterface.ReadOnlineStatsByRankAroundPlayer

Reads stats by ranking centered around a player. This grabs a set of rows above and below the player's current rank

Parameters:

• LocalUserNum - the local player having their stats being centered upon
• StatsRead - holds the definitions of the tables to read the data from and results are copied into the specified object
• NumRows - the number of rows to read above and below the player's rank

Returns:

TRUE if the call is successful, FALSE otherwise

ReadOnlineStatsForFriends

function bool ReadOnlineStatsForFriends (byte LocalUserNum, OnlineStatsRead StatsRead)

Specified by: OnlineStatsInterface.ReadOnlineStatsForFriends

Reads a player's stats and all of that player's friends stats for the specified set of stat views. This allows you to easily compare a player's stats to their friends.

Parameters:

• LocalUserNum - the local player having their stats and friend's stats read for
• StatsRead - holds the definitions of the tables to read the data from and results are copied into the specified object

Returns:

TRUE if the call is successful, FALSE otherwise

ReadPlayerStorage

function bool ReadPlayerStorage (byte LocalUserNum, OnlinePlayerStorage PlayerStorage)

Specified by: OnlinePlayerInterface.ReadPlayerStorage

Reads the online player storage data for a given local user

Parameters:

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

Returns:

true if the call succeeds, false otherwise

ReadPlayerStorageForNetId

function bool ReadPlayerStorageForNetId (OnlineSubsystem.UniqueNetId NetId, OnlinePlayerStorage PlayerStorage)

Specified by: OnlinePlayerInterface.ReadPlayerStorageForNetId

Reads the online player storage data for a given net user

Parameters:

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

Returns:

true if the call succeeds, false otherwise

ReadTitleFile

function bool ReadTitleFile (string FileToRead)

Specified by: OnlineSystemInterface.ReadTitleFile

Starts an asynchronous read of the specified file from the network platform's title specific file store

Parameters:

• FileToRead - the name of the file to read

Returns:

true if the calls starts successfully, false otherwise

RegisterHostStatGuid

function bool RegisterHostStatGuid (const out string HostStatGuid)

Specified by: OnlineStatsInterface.RegisterHostStatGuid

Registers the host's stat guid with the client for verification they are part of the stat. Note this is an async task for any backend communication that needs to happen before the registration is deemed complete

Parameters:

• HostStatGuid - the host's stat guid

Returns:

TRUE if the call is successful, FALSE otherwise

RegisterLocalTalker

function bool RegisterLocalTalker (byte LocalUserNum)

Specified by: OnlineVoiceInterface.RegisterLocalTalker

Registers the user as a talker

Parameters:

• LocalUserNum - the local player index that is a talker

Returns:

TRUE if the call succeeded, FALSE otherwise

RegisterRemoteTalker

function bool RegisterRemoteTalker (OnlineSubsystem.UniqueNetId PlayerId)

Specified by: OnlineVoiceInterface.RegisterRemoteTalker

Registers a remote player as a talker

Parameters:

• PlayerId - the unique id of the remote player that is a talker

Returns:

TRUE if the call succeeded, FALSE otherwise

RegisterStatGuid

function bool RegisterStatGuid (OnlineSubsystem.UniqueNetId PlayerId, const out string ClientStatGuid)

Specified by: OnlineStatsInterface.RegisterStatGuid

Registers the client's stat guid on the host to validate that the client was in the stat. Used for synching up stats. Only valid on the host.

Parameters:

• PlayerId - the client's unique net id
• ClientStatGuid - the client's stat guid

Returns:

TRUE if the call is successful, FALSE otherwise

RemoveFriend

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

Specified by: OnlinePlayerInterface.RemoveFriend

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

SelectVocabulary

function bool SelectVocabulary (byte LocalUserNum, int VocabularyId)

Specified by: OnlineVoiceInterface.SelectVocabulary

Changes the vocabulary id that is currently being used

Parameters:

• LocalUserNum - the local user that is making the change
• VocabularyId - the new id to use

Returns:

true if successful, false otherwise

SendGameInviteToFriend

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

Specified by: OnlinePlayerInterface.SendGameInviteToFriend

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)

Specified by: OnlinePlayerInterface.SendGameInviteToFriends

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)

Specified by: OnlinePlayerInterface.SendMessageToFriend

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

SetNetworkNotificationPosition

function SetNetworkNotificationPosition (OnlineSubsystem.ENetworkNotificationPosition NewPos)

Specified by: OnlineSystemInterface.SetNetworkNotificationPosition

Sets a new position for the network notification icons/images

Parameters:

• NewPos - the new location to use

SetOnlineStatus

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

Specified by: OnlinePlayerInterface.SetOnlineStatus

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

SetRemoteTalkerPriority

function bool SetRemoteTalkerPriority (byte LocalUserNum, OnlineSubsystem.UniqueNetId PlayerId, int Priority)

Specified by: OnlineVoiceInterface.SetRemoteTalkerPriority

Sets the relative priority for a remote talker. 0 is highest

Parameters:

• LocalUserNum - the user that controls the relative priority
• PlayerId - the remote talker that is having their priority changed for
• Priority - the relative priority to use (0 highest, < 0 is muted)

Returns:

TRUE if the function succeeds, FALSE otherwise

SetSpeechRecognitionObject

function bool SetSpeechRecognitionObject (byte LocalUserNum, SpeechRecognition SpeechRecogObj)

Specified by: OnlineVoiceInterface.SetSpeechRecognitionObject

Changes the object that is in use to the one specified

Parameters:

• LocalUserNum - the local user that is making the change
• SpeechRecogObj - the new object use
• true - if successful, false otherwise

ShowFriendsUI

function bool ShowFriendsUI (byte LocalUserNum)

Specified by: OnlinePlayerInterface.ShowFriendsUI

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)

Specified by: OnlinePlayerInterface.ShowKeyboardUI

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)

Specified by: OnlinePlayerInterface.ShowLoginUI

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

StartNetworkedVoice

function StartNetworkedVoice (byte LocalUserNum)

Specified by: OnlineVoiceInterface.StartNetworkedVoice

Tells the voice layer that networked processing of the voice data is allowed for the specified player. This allows for push-to-talk style voice communication

Parameters:

• LocalUserNum - the local user to allow network transimission for

StartSpeechRecognition

function bool StartSpeechRecognition (byte LocalUserNum)

Specified by: OnlineVoiceInterface.StartSpeechRecognition

Tells the voice system to start tracking voice data for speech recognition

Parameters:

• LocalUserNum - the local user to recognize voice data for

Returns:

true upon success, false otherwise

StopNetworkedVoice

function StopNetworkedVoice (byte LocalUserNum)

Specified by: OnlineVoiceInterface.StopNetworkedVoice

Tells the voice layer to stop processing networked voice support for the specified player. This allows for push-to-talk style voice communication

Parameters:

• LocalUserNum - the local user to disallow network transimission for

StopSpeechRecognition

function bool StopSpeechRecognition (byte LocalUserNum)

Specified by: OnlineVoiceInterface.StopSpeechRecognition

Tells the voice system to stop tracking voice data for speech recognition

Parameters:

• LocalUserNum - the local user to recognize voice data for

Returns:

true upon success, false otherwise

UnmuteAll

function bool UnmuteAll (byte LocalUserNum)

Specified by: OnlineVoiceInterface.UnmuteAll

Allows all speakers to send voice

Parameters:

• LocalUserNum - the local user that is making the change

UnmuteRemoteTalker

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

Specified by: OnlineVoiceInterface.UnmuteRemoteTalker

Allows a remote talker to talk to the specified local player. NOTE: This call will fail for remote talkers on the user's permanent online mute list

Parameters:

• LocalUserNum - the user that is allowing the remote talker to talk
• PlayerId - the remote talker that is being restored to talking

Returns:

TRUE if the function succeeds, FALSE otherwise

UnregisterLocalTalker

function bool UnregisterLocalTalker (byte LocalUserNum)

Specified by: OnlineVoiceInterface.UnregisterLocalTalker

Unregisters the user as a talker

Parameters:

• LocalUserNum - the local player index to be removed

Returns:

TRUE if the call succeeded, FALSE otherwise

UnregisterRemoteTalker

function bool UnregisterRemoteTalker (OnlineSubsystem.UniqueNetId PlayerId)

Specified by: OnlineVoiceInterface.UnregisterRemoteTalker

Unregisters a remote player as a talker

Parameters:

• PlayerId - the unique id of the remote player to be removed

Returns:

TRUE if the call succeeded, FALSE otherwise

WriteOnlinePlayerScores

function bool WriteOnlinePlayerScores (name SessionName, int LeaderboardId, const out array<OnlineSubsystem.OnlinePlayerScore> PlayerScores)

Specified by: OnlineStatsInterface.WriteOnlinePlayerScores

Writes the score data for the match

Parameters:

• SessionName - the name of the session to write scores for
• LeaderboardId - the leaderboard to write the score information to
• PlayerScores - the list of players, teams, and scores they earned

Returns:

TRUE if the call is successful, FALSE otherwise

WriteOnlineStats

function bool WriteOnlineStats (name SessionName, OnlineSubsystem.UniqueNetId Player, OnlineStatsWrite StatsWrite)

Specified by: OnlineStatsInterface.WriteOnlineStats

Writes out the stats contained within the stats write object to the online subsystem's cache of stats data. Note the new data replaces the old. It does not write the data to the permanent storage until a FlushOnlineStats() call or a session ends. Stats cannot be written without a session or the write request is ignored. No more than 5 stats views can be written to at a time or the write request is ignored.

Parameters:

• SessionName - the name of the session to write stats for
• Player - the player to write stats for
• StatsWrite - the object containing the information to write

Returns:

TRUE if the call is successful, FALSE otherwise

WritePlayerStorage

function bool WritePlayerStorage (byte LocalUserNum, OnlinePlayerStorage PlayerStorage)

Specified by: OnlinePlayerInterface.WritePlayerStorage

Writes the online player storage data for a given local user to the online data store

Parameters:

• LocalUserNum - the user that we are writing the data for
• PlayerStorage - the object that contains the list of items to write

Returns:

true if the call succeeds, false otherwise