UE3:OnlineSubsystemGameSpy instance functions (UT3)

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

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

Instance functions

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

AddCreateOnlineAccountCompletedDelegate

function AddCreateOnlineAccountCompletedDelegate (delegate<OnCreateOnlineAccountCompleted> AccountCreateDelegate)

Specified by: OnlineAccountInterface.AddCreateOnlineAccountCompletedDelegate

Sets the delegate used to notify the gameplay code that account creation completed

Parameters:

• AccountCreateDelegate - the delegate to use for notifications

AddDeviceSelectionDoneDelegate

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

Specified by: OnlinePlayerInterfaceEx.AddDeviceSelectionDoneDelegate

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

Parameters:

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

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

AddReadContentAnnouncementsCompletedDelegate

function AddReadContentAnnouncementsCompletedDelegate (delegate<OnReadContentAnnouncementsCompleted> ReadContentAnnouncementsDelegate)

Specified by: OnlineNewsInterface.AddReadContentAnnouncementsCompletedDelegate

Sets the delegate used to notify the gameplay code that content announcements reading has completed

Parameters:

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

AddReadGameNewsCompletedDelegate

function AddReadGameNewsCompletedDelegate (delegate<OnReadGameNewsCompleted> ReadGameNewsDelegate)

Specified by: OnlineNewsInterface.AddReadGameNewsCompletedDelegate

Sets the delegate used to notify the gameplay code that news reading has completed

Parameters:

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

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

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

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

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

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

ClearCreateOnlineAccountCompletedDelegate

function ClearCreateOnlineAccountCompletedDelegate (delegate<OnCreateOnlineAccountCompleted> AccountCreateDelegate)

Specified by: OnlineAccountInterface.ClearCreateOnlineAccountCompletedDelegate

Removes the specified delegate from the notification list

Parameters:

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

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

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

ClearReadContentAnnouncementsCompletedDelegate

function ClearReadContentAnnouncementsCompletedDelegate (delegate<OnReadContentAnnouncementsCompleted> ReadContentAnnouncementsDelegate)

Specified by: OnlineNewsInterface.ClearReadContentAnnouncementsCompletedDelegate

Removes the specified delegate from the notification list

Parameters:

• ReadContentAnnouncementsDelegate - the delegate to use for notifications

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

ClearReadGameNewsCompletedDelegate

function ClearReadGameNewsCompletedDelegate (delegate<OnReadGameNewsCompleted> ReadGameNewsDelegate)

Specified by: OnlineNewsInterface.ClearReadGameNewsCompletedDelegate

Removes the specified delegate from the notification list

Parameters:

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

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

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

CreateLocalAccount

function bool CreateLocalAccount (string UserName, optional string Password)

Specified by: OnlineAccountInterface.CreateLocalAccount

Creates a non-networked account on the local system. Password is only used when supplied. Otherwise the account is not secured.

Parameters:

• UserName - the unique nickname of the account
• Password - the password securing the account

Returns:

true if the account was created, false otherwise

DeleteLocalAccount

function bool DeleteLocalAccount (string UserName, optional string Password)

Specified by: OnlineAccountInterface.DeleteLocalAccount

Deletes a local account if the password matches

Parameters:

• UserName - the unique nickname of the account
• Password - the password securing the account

Returns:

true if the account was deleted, false otherwise

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

GetContentAnnouncements

function string GetContentAnnouncements (byte LocalUserNum)

Specified by: OnlineNewsInterface.GetContentAnnouncements

Returns the game specific content announcements from the cache

Parameters:

• LocalUserNum - the local user the content announcements is being read for

Returns:

an empty string if no data was read, otherwise the contents of the read

GetDeviceSelectionResults

function int GetDeviceSelectionResults (byte LocalUserNum, out string DeviceName)

Specified by: OnlinePlayerInterfaceEx.GetDeviceSelectionResults

Fetches the results of the device selection

Parameters:

• LocalUserNum - the player to check the results for
• DeviceName - out param that gets a copy of the string

Returns:

the ID of the device that was selected NOTE: Zero means the user hasn't selected one

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

GetGameNews

function string GetGameNews (byte LocalUserNum)

Specified by: OnlineNewsInterface.GetGameNews

Returns the game specific news from the cache

Parameters:

• LocalUserNum - the local user the news is being read for

Returns:

an empty string if no news was read, otherwise the contents of the read

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

GetLocalAccountNames

function bool GetLocalAccountNames (out array<string> Accounts)

Specified by: OnlineAccountInterface.GetLocalAccountNames

Fetches a list of local accounts

Parameters:

• Accounts - the array that is populated with the accounts

Returns:

true if the list was read, false otherwise

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

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

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

IsDeviceValid

function bool IsDeviceValid (int DeviceId)

Specified by: OnlinePlayerInterfaceEx.IsDeviceValid

Checks the device id to determine if it is still valid (could be removed)

Parameters:

• DeviceId - the device to check

Returns:

true if valid, 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

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

RenameLocalAccount

function bool RenameLocalAccount (string NewUserName, string OldUserName, optional string Password)

Specified by: OnlineAccountInterface.RenameLocalAccount

Changes the name of a local account

Parameters:

• UserName - the unique nickname of the account
• Password - the password securing the account

Returns:

true if the account was renamed, 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

ShowAchievementsUI

function bool ShowAchievementsUI (byte LocalUserNum)

Specified by: OnlinePlayerInterfaceEx.ShowAchievementsUI

Displays the achievements UI for a player

Parameters:

• LocalUserNum - the controller number of the associated user

Returns:

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

ShowContentMarketplaceUI

function bool ShowContentMarketplaceUI (byte LocalUserNum)

Specified by: OnlinePlayerInterfaceEx.ShowContentMarketplaceUI

Displays the marketplace UI for content

Parameters:

• LocalUserNum - the local user viewing available content

ShowDeviceSelectionUI

function bool ShowDeviceSelectionUI (byte LocalUserNum, int SizeNeeded, bool bForceShowUI)

Specified by: OnlinePlayerInterfaceEx.ShowDeviceSelectionUI

Displays the UI that allows the user to choose which device to save content to

Parameters:

• LocalUserNum - the controller number of the associated user
• SizeNeeded - the size of the data to be saved in bytes
• bForceShowUI - true to always show the UI, false to only show the UI if there are multiple valid choices

Returns:

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

ShowFeedbackUI

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

Specified by: OnlinePlayerInterfaceEx.ShowFeedbackUI

Displays the UI that allows a player to give feedback on another player

Parameters:

• LocalUserNum - the controller number of the associated user
• PlayerId - the id of the player having feedback given for

Returns:

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

ShowFriendsInviteUI

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

Specified by: OnlinePlayerInterfaceEx.ShowFriendsInviteUI

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

Parameters:

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

Returns:

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

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

ShowGamerCardUI

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

Specified by: OnlinePlayerInterfaceEx.ShowGamerCardUI

Displays the gamer card UI for the specified player

Parameters:

• LocalUserNum - the controller number of the associated user
• PlayerId - the id of the player to show the gamer card of

Returns:

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

ShowInviteUI

function bool ShowInviteUI (byte LocalUserNum, optional string InviteText)

Specified by: OnlinePlayerInterfaceEx.ShowInviteUI

Displays the invite ui

Parameters:

• LocalUserNum - the local user sending the invite
• InviteText - the string to prefill the UI with

ShowMembershipMarketplaceUI

function bool ShowMembershipMarketplaceUI (byte LocalUserNum)

Specified by: OnlinePlayerInterfaceEx.ShowMembershipMarketplaceUI

Displays the marketplace UI for memberships

Parameters:

• LocalUserNum - the local user viewing available memberships

ShowMessagesUI

function bool ShowMessagesUI (byte LocalUserNum)

Specified by: OnlinePlayerInterfaceEx.ShowMessagesUI

Displays the messages UI for a player

Parameters:

• LocalUserNum - the controller number of the associated user

Returns:

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

ShowPlayersUI

function bool ShowPlayersUI (byte LocalUserNum)

Specified by: OnlinePlayerInterfaceEx.ShowPlayersUI

Displays the UI that shows the player list

Parameters:

• LocalUserNum - the controller number of the associated user

Returns:

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

UnlockGamerPicture

function bool UnlockGamerPicture (byte LocalUserNum, int PictureId)

Specified by: OnlinePlayerInterfaceEx.UnlockGamerPicture

Unlocks a gamer picture for the local user

Parameters:

• LocalUserNum - the user to unlock the picture for
• PictureId - the id of the picture to unlock

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