UE3:OnlineSubsystemLive native functions (UT3)

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

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

Native functions

Init

native event bool Init ()

Overrides: OnlineSubsystem.Init

Called from engine start up code to allow the subsystem to initialize

Returns:

TRUE if the initialization was successful, FALSE otherwise

AcceptGameInvite

native function bool AcceptGameInvite (byte LocalUserNum)

Specified by: OnlineGameInterface.AcceptGameInvite

Tells the online subsystem to accept the game invite that is currently pending

Parameters:

• LocalUserNum - the local user accepting the invite

AreAnyFriends

native 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

native 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

CancelFindOnlineGames

native function bool CancelFindOnlineGames ()

Specified by: OnlineGameInterface.CancelFindOnlineGames

Cancels the current search in progress if possible for that search type

Returns:

true if successful searching for sessions, false otherwise

CanCommunicate

native 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

native 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

native 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

native 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

native 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

native 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

CreateOnlineGame

native function bool CreateOnlineGame (byte HostingPlayerNum, OnlineGameSettings NewGameSettings)

Specified by: OnlineGameInterface.CreateOnlineGame

Creates an online game based upon the settings object specified

Parameters:

• HostingPlayerNum - the index of the player hosting the match
• NewGameSettings - the settings to use for the new game session

Returns:

true if successful creating the session, false otherwsie

DestroyOnlineGame

native function bool DestroyOnlineGame ()

Specified by: OnlineGameInterface.DestroyOnlineGame

Destroys the current online game

Returns:

true if successful destroying the session, false otherwsie

EndOnlineGame

native function bool EndOnlineGame ()

Specified by: OnlineGameInterface.EndOnlineGame

Marks an online game as having been ended

Returns:

true if the call succeeds, false otherwise

FindOnlineGames

native function bool FindOnlineGames (byte SearchingPlayerNum, OnlineGameSearch SearchSettings)

Specified by: OnlineGameInterface.FindOnlineGames

Searches for games matching the settings specified

Parameters:

• SearchingPlayerNum - the index of the player searching for a match
• SearchSettings - the desired settings that the returned sessions will have

Returns:

true if successful destroying the session, false otherwsie

FlushOnlineStats

native function bool FlushOnlineStats ()

Specified by: OnlineStatsInterface.FlushOnlineStats

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

Returns:

TRUE if the call is successful, FALSE otherwise

FreeSearchResults

native function bool FreeSearchResults (optional OnlineGameSearch Search)

Specified by: OnlineGameInterface.FreeSearchResults

Cleans up any platform specific allocated data contained in the search results

Parameters:

• Search - the object to free search results for

Returns:

true if successful, false otherwise

FreeStats

native 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

GetContentList

native function OnlineSubsystem.EOnlineEnumerationReadState GetContentList (byte LocalUserNum, out array<OnlineSubsystem.OnlineContent> ContentList)

Specified by: OnlineContentInterface.GetContentList

Retrieve the list of content the given user has downloaded or otherwise retrieved to the local console.

Parameters:

• LocalUserNum - The user to read the content list of
• ContentList - The out array that receives the list of all content

Returns:

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

GetDeviceSelectionResults

native function int GetDeviceSelectionResults (byte LocalPlayerNum, out string DeviceName)

Specified by: OnlinePlayerInterfaceEx.GetDeviceSelectionResults

Fetches the results of the device selection

Parameters:

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

GetFriendsList

native 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:

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

GetLoginStatus

native 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

native function OnlineSubsystem.ENATType GetNATType ()

Specified by: OnlineSystemInterface.GetNATType

Determines the NAT type the player is using

GetPlayerNickname

native 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

GetRecognitionResults

native 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

GetResolvedConnectString

native function bool GetResolvedConnectString (out string ConnectInfo)

Specified by: OnlineGameInterface.GetResolvedConnectString

Returns the platform specific connection information for joining the match. Call this function from the delegate of join completion

Parameters:

• ConnectInfo - the out var containing the platform specific connection information

Returns:

true if the call was successful, false otherwise

GetUniquePlayerId

native 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

native function bool HasLinkConnection ()

Specified by: OnlineSystemInterface.HasLinkConnection

Determines if the ethernet link is connected or not

IsControllerConnected

native 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

IsDeviceValid

native 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

IsFriend

native 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

IsHeadsetPresent

native 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

IsLocalPlayerTalking

native 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

native 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

native 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

native 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

JoinOnlineGame

native function bool JoinOnlineGame (byte PlayerNum, const out OnlineGameSearch.OnlineGameSearchResult DesiredGame)

Specified by: OnlineGameInterface.JoinOnlineGame

Joins the game specified

Parameters:

• PlayerNum - the index of the player searching for a match
• DesiredGame - the desired game to join

Returns:

true if the call was successful, false otherwise

Login

native 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

native 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

MuteRemoteTalker

native 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

QueryAvailableDownloads

native function bool QueryAvailableDownloads (byte LocalUserNum)

Specified by: OnlineContentInterface.QueryAvailableDownloads

Asks the online system for the number of new and total content downloads

Parameters:

• LocalUserNum - the user to check the content download availability for

Returns:

TRUE if the call succeeded, FALSE otherwise

ReadContentList

native function bool ReadContentList (byte LocalUserNum)

Specified by: OnlineContentInterface.ReadContentList

Starts an async task that retrieves the list of downloaded content for the player.

Parameters:

• LocalUserNum - The user to read the content list of

Returns:

true if the read request was issued successfully, false otherwise

ReadFriendsList

native 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

native 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

native 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

native 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

native 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

ReadProfileSettings

native function bool ReadProfileSettings (byte LocalUserNum, OnlineProfileSettings ProfileSettings)

Specified by: OnlinePlayerInterface.ReadProfileSettings

Reads the online profile settings for a given user

Parameters:

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

Returns:

true if the call succeeds, false otherwise

RecalculateSkillRating

native function bool RecalculateSkillRating (const out array<OnlineSubsystem.UniqueNetId> Players)

Specified by: OnlineGameInterface.RecalculateSkillRating

Updates the current session's skill rating using the list of players' skills

Parameters:

• Players - the set of players to use in the skill calculation

Returns:

true if the update succeeded, false otherwise

RegisterForArbitration

native function bool RegisterForArbitration ()

Specified by: OnlineGameInterface.RegisterForArbitration

Tells the game to register with the underlying arbitration server if available

RegisterLocalTalker

native 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

RegisterPlayer

native function bool RegisterPlayer (OnlineSubsystem.UniqueNetId PlayerId, bool bWasInvited)

Specified by: OnlineGameInterface.RegisterPlayer

Registers a player with the online service as being part of the online game

Parameters:

• PlayerId - the player to register with the online service
• bWasInvited - whether the player was invited or is coming via a search

Returns:

true if the call succeeds, false otherwise

RegisterRemoteTalker

native 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

SelectVocabulary

native 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

native 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

native 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

native 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

native 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

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

Specified by: OnlinePlayerInterface.SetOnlineStatus

Sets a rich presence information to use for the specified player

Parameters:

• LocalUserNum - the controller number of the associated user
• PresenceMode - the rich presence mode to use
• LocalizedStringSettings - the list of localized string settings to set
• Properties - the list of properties to set

SetRemoteTalkerPriority

native 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

native 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

ShowAchievementsUI

native 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

native function bool ShowContentMarketplaceUI (byte LocalUserNum)

Specified by: OnlinePlayerInterfaceEx.ShowContentMarketplaceUI

Displays the marketplace UI for content

Parameters:

• LocalUserNum - the local user viewing available content

ShowDeviceSelectionUI

native 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

native 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

native 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

native 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

native 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

native 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

ShowKeyboardUI

native 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 entry 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

native 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

ShowMembershipMarketplaceUI

native function bool ShowMembershipMarketplaceUI (byte LocalUserNum)

Specified by: OnlinePlayerInterfaceEx.ShowMembershipMarketplaceUI

Displays the marketplace UI for memberships

Parameters:

• LocalUserNum - the local user viewing available memberships

ShowMessagesUI

native 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

native 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

StartNetworkedVoice

native 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

StartOnlineGame

native function bool StartOnlineGame ()

Specified by: OnlineGameInterface.StartOnlineGame

Marks an online game as in progress (as opposed to being in lobby)

Returns:

true if the call succeeds, false otherwise

StartSpeechRecognition

native 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

native 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

native 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

UnlockAchievement

native function bool UnlockAchievement (byte LocalUserNum, int AchievementId)

Specified by: OnlinePlayerInterfaceEx.UnlockAchievement

Unlocks the specified achievement for the specified user

Parameters:

• LocalUserNum - the controller number of the associated user
• AchievementId - the id of the achievement to unlock

Returns:

TRUE if the call worked, FALSE otherwise

UnlockGamerPicture

native 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

UnmuteRemoteTalker

native 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

native 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

UnregisterPlayer

native function bool UnregisterPlayer (OnlineSubsystem.UniqueNetId PlayerId)

Specified by: OnlineGameInterface.UnregisterPlayer

Unregisters a player with the online service as being part of the online game

Parameters:

• PlayerId - the player to unregister with the online service

Returns:

true if the call succeeds, false otherwise

UnregisterRemoteTalker

native 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

UpdateOnlineGame

native function bool UpdateOnlineGame (OnlineGameSettings UpdatedGameSettings)

Specified by: OnlineGameInterface.UpdateOnlineGame

Updates the localized settings/properties for the game in question. Updates the QoS packet if needed (starting & restarting QoS).

Parameters:

• UpdatedGameSettings - the object to update the game settings with

Returns:

true if successful creating the session, false otherwsie

WriteOnlinePlayerScores

native function bool WriteOnlinePlayerScores (const out array<OnlineSubsystem.OnlinePlayerScore> PlayerScores)

Specified by: OnlineStatsInterface.WriteOnlinePlayerScores

Writes the score data for the match

Parameters:

• PlayerScores - the list of players, teams, and scores they earned

Returns:

TRUE if the call is successful, FALSE otherwise

WriteOnlineStats

native function bool WriteOnlineStats (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:

• Player - the player to write stats for
• StatsWrite - the object containing the information to write

Returns:

TRUE if the call is successful, FALSE otherwise

WriteProfileSettings

native function bool WriteProfileSettings (byte LocalUserNum, OnlineProfileSettings ProfileSettings)

Specified by: OnlinePlayerInterface.WriteProfileSettings

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

Parameters:

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

Returns:

true if the call succeeds, false otherwise