UE3:OnlineSubsystemLive instance functions (UT3)

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

;Other member categories for this class::delegates, native functions, properties

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

AddArbitrationRegistrationCompleteDelegate

function AddArbitrationRegistrationCompleteDelegate (delegate<OnArbitrationRegistrationComplete> ArbitrationRegistrationCompleteDelegate)

Specified by: OnlineGameInterface.AddArbitrationRegistrationCompleteDelegate

Sets the notification callback to use when arbitration registration has completed

Parameters:

• ArbitrationRegistrationCompleteDelegate - the delegate to use for notifications

AddCancelFindOnlineGamesCompleteDelegate

function AddCancelFindOnlineGamesCompleteDelegate (delegate<OnCancelFindOnlineGamesComplete> CancelFindOnlineGamesCompleteDelegate)

Specified by: OnlineGameInterface.AddCancelFindOnlineGamesCompleteDelegate

Adds the delegate to the list to notify with

Parameters:

• CancelFindOnlineGamesCompleteDelegate - 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

AddContentChangeDelegate

function AddContentChangeDelegate (delegate<OnContentChange> ContentDelegate, optional byte LocalUserNum)

Specified by: OnlineContentInterface.AddContentChangeDelegate

Sets the delegate used to notify the gameplay code that (downloaded) content changed

Parameters:

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

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

AddCreateOnlineGameCompleteDelegate

function AddCreateOnlineGameCompleteDelegate (delegate<OnCreateOnlineGameComplete> CreateOnlineGameCompleteDelegate)

Specified by: OnlineGameInterface.AddCreateOnlineGameCompleteDelegate

Sets the delegate used to notify the gameplay code that the online game they created has completed the creation process

Parameters:

• CreateOnlineGameCompleteDelegate - the delegate to use for notifications

AddDestroyOnlineGameCompleteDelegate

function AddDestroyOnlineGameCompleteDelegate (delegate<OnDestroyOnlineGameComplete> DestroyOnlineGameCompleteDelegate)

Specified by: OnlineGameInterface.AddDestroyOnlineGameCompleteDelegate

Sets the delegate used to notify the gameplay code that the online game they destroyed has completed the destruction process

Parameters:

• DestroyOnlineGameCompleteDelegate - the delegate to use for notifications

AddDeviceSelectionDoneDelegate

function AddDeviceSelectionDoneDelegate (byte LocalUserNum, delegate<OnDeviceSelectionComplete> DeviceDelegate)

Specified by: OnlinePlayerInterfaceEx.AddDeviceSelectionDoneDelegate

Sets the delegate used to notify the gameplay code that the user has completed their device selection

Parameters:

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

AddEndOnlineGameCompleteDelegate

function AddEndOnlineGameCompleteDelegate (delegate<OnEndOnlineGameComplete> EndOnlineGameCompleteDelegate)

Specified by: OnlineGameInterface.AddEndOnlineGameCompleteDelegate

Sets the delegate used to notify the gameplay code that the online game has transitioned to the ending state.

Parameters:

• EndOnlineGameCompleteDelegate - 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

AddFindOnlineGamesCompleteDelegate

function AddFindOnlineGamesCompleteDelegate (delegate<OnFindOnlineGamesComplete> FindOnlineGamesCompleteDelegate)

Specified by: OnlineGameInterface.AddFindOnlineGamesCompleteDelegate

Adds the delegate used to notify the gameplay code that the search they kicked off has completed

Parameters:

• FindOnlineGamesCompleteDelegate - 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:

• FriendsDelegate - the delegate to use for notifications

AddGameInviteAcceptedDelegate

function AddGameInviteAcceptedDelegate (byte LocalUserNum, delegate<OnGameInviteAccepted> GameInviteAcceptedDelegate)

Specified by: OnlineGameInterface.AddGameInviteAcceptedDelegate

Sets the delegate used to notify the gameplay code when a game invite has been accepted

Parameters:

• LocalUserNum - the user to request notification for
• GameInviteAcceptedDelegate - 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

AddJoinOnlineGameCompleteDelegate

function AddJoinOnlineGameCompleteDelegate (delegate<OnJoinOnlineGameComplete> JoinOnlineGameCompleteDelegate)

Specified by: OnlineGameInterface.AddJoinOnlineGameCompleteDelegate

Sets the delegate used to notify the gameplay code that the join request they kicked off has completed

Parameters:

• JoinOnlineGameCompleteDelegate - 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

Sets 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, optional byte LocalUserNum)

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

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

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<OnPlayerTalking> 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

AddProfileDataChangedDelegate

function AddProfileDataChangedDelegate (byte LocalUserNum, delegate<OnProfileDataChanged> ProfileDataChangedDelegate)

Specified by: OnlinePlayerInterfaceEx.AddProfileDataChangedDelegate

Sets the delegate used to notify the gameplay code that someone has changed their profile data externally

Parameters:

• LocalUserNum - the user the delegate is interested in
• ProfileDataChangedDelegate - the delegate to use for notifications

AddQueryAvailableDownloadsComplete

function AddQueryAvailableDownloadsComplete (byte LocalUserNum, delegate<OnQueryAvailableDownloadsComplete> QueryDownloadsDelegate)

Specified by: OnlineContentInterface.AddQueryAvailableDownloadsComplete

Sets the delegate used to notify the gameplay code that the content download query has completed

Parameters:

• LocalUserNum - the user to check the content download availability for
• ReadContentCompleteDelegate - the delegate to use for notifications

AddReadContentComplete

function AddReadContentComplete (byte LocalUserNum, delegate<OnReadContentComplete> ReadContentCompleteDelegate)

Specified by: OnlineContentInterface.AddReadContentComplete

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

Parameters:

• LocalUserNum - the user to read the content list of
• ReadContentCompleteDelegate - the delegate to use for notifications

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 used to notify the gameplay code that the stats read has completed

Parameters:

• ReadOnlineStatsCompleteDelegate - 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

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

AddRegisterPlayerCompleteDelegate

function AddRegisterPlayerCompleteDelegate (delegate<OnRegisterPlayerComplete> RegisterPlayerCompleteDelegate)

Specified by: OnlineGameInterface.AddRegisterPlayerCompleteDelegate

Sets the delegate used to notify the gameplay code that the player registration request they submitted has completed

Parameters:

• RegisterPlayerCompleteDelegate - the delegate to use for notifications

AddStartOnlineGameCompleteDelegate

function AddStartOnlineGameCompleteDelegate (delegate<OnStartOnlineGameComplete> StartOnlineGameCompleteDelegate)

Specified by: OnlineGameInterface.AddStartOnlineGameCompleteDelegate

Sets the delegate used to notify the gameplay code that the online game has transitioned to the started state.

Parameters:

• StartOnlineGameCompleteDelegate - 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

AddUnlockAchievementCompleteDelegate

function AddUnlockAchievementCompleteDelegate (byte LocalUserNum, delegate<OnUnlockAchievementComplete> UnlockAchievementCompleteDelegate)

Specified by: OnlinePlayerInterfaceEx.AddUnlockAchievementCompleteDelegate

Adds the delegate used to notify the gameplay code that the achievement unlocking has completed

Parameters:

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

AddUnregisterPlayerCompleteDelegate

function AddUnregisterPlayerCompleteDelegate (delegate<OnUnregisterPlayerComplete> UnregisterPlayerCompleteDelegate)

Specified by: OnlineGameInterface.AddUnregisterPlayerCompleteDelegate

Sets the delegate used to notify the gameplay code that the player Unregistration request they submitted has completed

Parameters:

• UnregisterPlayerCompleteDelegate - 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

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

ClearArbitrationRegistrationCompleteDelegate

function ClearArbitrationRegistrationCompleteDelegate (delegate<OnArbitrationRegistrationComplete> ArbitrationRegistrationCompleteDelegate)

Specified by: OnlineGameInterface.ClearArbitrationRegistrationCompleteDelegate

Removes the notification callback to use when arbitration registration has completed

Parameters:

• ArbitrationRegistrationCompleteDelegate - the delegate to use for notifications

ClearCancelFindOnlineGamesCompleteDelegate

function ClearCancelFindOnlineGamesCompleteDelegate (delegate<OnCancelFindOnlineGamesComplete> CancelFindOnlineGamesCompleteDelegate)

Specified by: OnlineGameInterface.ClearCancelFindOnlineGamesCompleteDelegate

Removes the delegate from the notify list

Parameters:

• CancelFindOnlineGamesCompleteDelegate - 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

ClearContentChangeDelegate

function ClearContentChangeDelegate (delegate<OnContentChange> ContentDelegate, optional byte LocalUserNum)

Specified by: OnlineContentInterface.ClearContentChangeDelegate

Sets the delegate used to notify the gameplay code that (downloaded) content changed

Parameters:

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

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

ClearCreateOnlineGameCompleteDelegate

function ClearCreateOnlineGameCompleteDelegate (delegate<OnCreateOnlineGameComplete> CreateOnlineGameCompleteDelegate)

Specified by: OnlineGameInterface.ClearCreateOnlineGameCompleteDelegate

Sets the delegate used to notify the gameplay code that the online game they created has completed the creation process

Parameters:

• CreateOnlineGameCompleteDelegate - the delegate to use for notifications

ClearDestroyOnlineGameCompleteDelegate

function ClearDestroyOnlineGameCompleteDelegate (delegate<OnDestroyOnlineGameComplete> DestroyOnlineGameCompleteDelegate)

Specified by: OnlineGameInterface.ClearDestroyOnlineGameCompleteDelegate

Removes the delegate from the notification list

Parameters:

• DestroyOnlineGameCompleteDelegate - the delegate to use for notifications

ClearDeviceSelectionDoneDelegate

function ClearDeviceSelectionDoneDelegate (byte LocalUserNum, delegate<OnDeviceSelectionComplete> DeviceDelegate)

Specified by: OnlinePlayerInterfaceEx.ClearDeviceSelectionDoneDelegate

Removes the specified delegate from the list of callbacks

Parameters:

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

ClearEndOnlineGameCompleteDelegate

function ClearEndOnlineGameCompleteDelegate (delegate<OnEndOnlineGameComplete> EndOnlineGameCompleteDelegate)

Specified by: OnlineGameInterface.ClearEndOnlineGameCompleteDelegate

Removes the delegate from the notify list

Parameters:

• EndOnlineGameCompleteDelegate - the delegate to use for notifications

ClearExternalUIChangeDelegate

function ClearExternalUIChangeDelegate (delegate<OnExternalUIChange> ExternalUIDelegate)

Specified by: OnlineSystemInterface.ClearExternalUIChangeDelegate

Removes the delegate from the notification list

Parameters:

• ExternalUIDelegate - the delegate to remove

ClearFindOnlineGamesCompleteDelegate

function ClearFindOnlineGamesCompleteDelegate (delegate<OnFindOnlineGamesComplete> FindOnlineGamesCompleteDelegate)

Specified by: OnlineGameInterface.ClearFindOnlineGamesCompleteDelegate

Removes the delegate from the notify list

Parameters:

• FindOnlineGamesCompleteDelegate - the delegate to use for notifications

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

Removes the delegate from the list of notifications

Parameters:

• FriendsDelegate - the delegate to use for notifications

ClearGameInviteAcceptedDelegate

function ClearGameInviteAcceptedDelegate (byte LocalUserNum, delegate<OnGameInviteAccepted> GameInviteAcceptedDelegate)

Specified by: OnlineGameInterface.ClearGameInviteAcceptedDelegate

Removes the delegate used to notify the gameplay code when a game invite has been accepted

Parameters:

• LocalUserNum - the user to request notification for
• GameInviteAcceptedDelegate - 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

ClearJoinOnlineGameCompleteDelegate

function ClearJoinOnlineGameCompleteDelegate (delegate<OnJoinOnlineGameComplete> JoinOnlineGameCompleteDelegate)

Specified by: OnlineGameInterface.ClearJoinOnlineGameCompleteDelegate

Removes the delegate from the notify list

Parameters:

• JoinOnlineGameCompleteDelegate - 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, optional byte LocalUserNum)

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

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

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

Specified by: OnlinePlayerInterface.ClearMutingChangeDelegate

Removes the delegate from the list of notifications

Parameters:

• MutingDelegate - the delegate to use for notifications

ClearPlayerTalkingDelegate

function ClearPlayerTalkingDelegate (delegate<OnPlayerTalking> TalkerDelegate)

Specified by: OnlineVoiceInterface.ClearPlayerTalkingDelegate

Removes a talker delegate to the list of notifications

Parameters:

• TalkerDelegate - the delegate to remove from the notification list

ClearProfileDataChangedDelegate

function ClearProfileDataChangedDelegate (byte LocalUserNum, delegate<OnProfileDataChanged> ProfileDataChangedDelegate)

Specified by: OnlinePlayerInterfaceEx.ClearProfileDataChangedDelegate

Clears the delegate used to notify the gameplay code that someone has changed their profile data externally

Parameters:

• LocalUserNum - the user the delegate is interested in
• ProfileDataChangedDelegate - the delegate to use for notifications

ClearQueryAvailableDownloadsComplete

function ClearQueryAvailableDownloadsComplete (byte LocalUserNum, delegate<OnQueryAvailableDownloadsComplete> QueryDownloadsDelegate)

Specified by: OnlineContentInterface.ClearQueryAvailableDownloadsComplete

Sets the delegate used to notify the gameplay code that the content download query has completed

Parameters:

• LocalUserNum - the user to check the content download availability for
• ReadContentCompleteDelegate - the delegate to use for notifications

ClearReadContentComplete

function ClearReadContentComplete (byte LocalUserNum, delegate<OnReadContentComplete> ReadContentCompleteDelegate)

Specified by: OnlineContentInterface.ClearReadContentComplete

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

Parameters:

• LocalUserNum - the user to read the content list of
• ReadContentCompleteDelegate - the delegate to use for notifications

ClearReadFriendsCompleteDelegate

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

Specified by: OnlinePlayerInterface.ClearReadFriendsCompleteDelegate

Removes the delegate from the list of notifications

Parameters:

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

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

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

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

ClearRegisterPlayerCompleteDelegate

function ClearRegisterPlayerCompleteDelegate (delegate<OnRegisterPlayerComplete> RegisterPlayerCompleteDelegate)

Specified by: OnlineGameInterface.ClearRegisterPlayerCompleteDelegate

Removes the specified delegate from the notification list

Parameters:

• RegisterPlayerCompleteDelegate - the delegate to use for notifications

ClearStartOnlineGameCompleteDelegate

function ClearStartOnlineGameCompleteDelegate (delegate<OnStartOnlineGameComplete> StartOnlineGameCompleteDelegate)

Specified by: OnlineGameInterface.ClearStartOnlineGameCompleteDelegate

Removes the delegate from the notify list

Parameters:

• StartOnlineGameCompleteDelegate - 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

ClearUnlockAchievementCompleteDelegate

function ClearUnlockAchievementCompleteDelegate (byte LocalUserNum, delegate<OnUnlockAchievementComplete> UnlockAchievementCompleteDelegate)

Specified by: OnlinePlayerInterfaceEx.ClearUnlockAchievementCompleteDelegate

Clears the delegate used to notify the gameplay code that the achievement unlocking has completed

Parameters:

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

ClearUnregisterPlayerCompleteDelegate

function ClearUnregisterPlayerCompleteDelegate (delegate<OnUnregisterPlayerComplete> UnregisterPlayerCompleteDelegate)

Specified by: OnlineGameInterface.ClearUnregisterPlayerCompleteDelegate

Removes the specified delegate from the notification list

Parameters:

• UnregisterPlayerCompleteDelegate - 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

GetArbitratedPlayers

function array<OnlineSubsystem.OnlineArbitrationRegistrant> GetArbitratedPlayers ()

Specified by: OnlineGameInterface.GetArbitratedPlayers

Returns the list of arbitrated players for the arbitrated session

GetAvailableDownloadCounts

function GetAvailableDownloadCounts (byte LocalUserNum, out int NewDownloads, out int TotalDownloads)

Specified by: OnlineContentInterface.GetAvailableDownloadCounts

Returns the number of new and total downloads available for the user

Parameters:

• LocalUserNum - the user to check the content download availability for
• NewDownloads - out value of the number of new downloads available
• TotalDownloads - out value of the number of total downloads available

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

GetGameSearch

function OnlineGameSearch GetGameSearch ()

Specified by: OnlineGameInterface.GetGameSearch

Returns the currently set game search object

GetGameSettings

function OnlineGameSettings GetGameSettings ()

Specified by: OnlineGameInterface.GetGameSettings

Returns the currently set game settings

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:

• 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

GetNetworkNotificationPosition

function OnlineSubsystem.ENetworkNotificationPosition GetNetworkNotificationPosition ()

Specified by: OnlineSystemInterface.GetNetworkNotificationPosition

Determines the current notification position setting

GetOnlineGameState

function OnlineSubsystem.EOnlineGameState GetOnlineGameState ()

Specified by: OnlineGameInterface.GetOnlineGameState

Returns the current state of the online game

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

MulticastReadOnlineStatsComplete

function MulticastReadOnlineStatsComplete (bool bWasSuccessful)

Local version of the delegate that sends to the array of subscribers

Parameters:

• bWasSuccessful - whether the call completed or not

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

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

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

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