Mostly Harmless
UE3:OnlineSubsystemGameSpy native functions (UT3)
Object >> OnlineSubsystem >> OnlineSubsystemCommonImpl >> OnlineSubsystemGameSpy (native functions) |
Contents
- 1 Native functions
- 1.1 Init
- 1.2 AcceptFriendInvite
- 1.3 AddFriend
- 1.4 AddFriendByName
- 1.5 AreAnyFriends
- 1.6 AutoLogin
- 1.7 CanCommunicate
- 1.8 CanPlayOnline
- 1.9 CreateOnlineAccount
- 1.10 DenyFriendInvite
- 1.11 FlushOnlineStats
- 1.12 FreeStats
- 1.13 GetClientStatGuid
- 1.14 GetFriendsList
- 1.15 GetHostStatGuid
- 1.16 GetLoginStatus
- 1.17 GetNATType
- 1.18 GetRecognitionResults
- 1.19 HasLinkConnection
- 1.20 IsAchievementUnlocked
- 1.21 IsControllerConnected
- 1.22 IsFriend
- 1.23 IsHeadsetPresent
- 1.24 IsKeyValid
- 1.25 IsLocalPlayerTalking
- 1.26 IsRemotePlayerTalking
- 1.27 JoinFriendGame
- 1.28 Login
- 1.29 Logout
- 1.30 MuteRemoteTalker
- 1.31 ReadContentAnnouncements
- 1.32 ReadFriendMessages
- 1.33 ReadFriendsList
- 1.34 ReadGameNews
- 1.35 ReadOnlineStats
- 1.36 ReadOnlineStatsByRank
- 1.37 ReadOnlineStatsByRankAroundPlayer
- 1.38 ReadOnlineStatsForFriends
- 1.39 ReadProfileSettings
- 1.40 RegisterHostStatGuid
- 1.41 RegisterLocalTalker
- 1.42 RegisterRemoteTalker
- 1.43 RegisterStatGuid
- 1.44 RemoveFriend
- 1.45 SaveKey
- 1.46 SelectVocabulary
- 1.47 SendGameInviteToFriend
- 1.48 SendGameInviteToFriends
- 1.49 SendMessageToFriend
- 1.50 SetOnlineStatus
- 1.51 SetRemoteTalkerPriority
- 1.52 SetSpeechRecognitionObject
- 1.53 ShowKeyboardUI
- 1.54 ShowLoginUI
- 1.55 StartNetworkedVoice
- 1.56 StartSpeechRecognition
- 1.57 StopNetworkedVoice
- 1.58 StopSpeechRecognition
- 1.59 UnlockAchievement
- 1.60 UnmuteRemoteTalker
- 1.61 UnregisterLocalTalker
- 1.62 UnregisterRemoteTalker
- 1.63 WriteFriendMessages
- 1.64 WriteOnlinePlayerScores
- 1.65 WriteOnlineStats
- 1.66 WriteProfileSettings
;Other member categories for this class::delegates, instance functions, properties
This is an auto-generated page and may need human attention. Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete. |
Native functions[edit]
Init[edit]
Overrides: OnlineSubsystem.Init
Called from engine start up code to allow the subsystem to initialize
Returns:
- TRUE if the initialization was successful, FALSE otherwise
AcceptFriendInvite[edit]
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
AddFriend[edit]
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[edit]
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
AreAnyFriends[edit]
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[edit]
Specified by: OnlinePlayerInterface.AutoLogin
Logs the player into the online service using parameters passed on the command line. Expects -Login=<UserName> -Password=<password>. If either are missing, the function returns false and doesn't start the login process
Returns:
- true if the async call started ok, false otherwise
CanCommunicate[edit]
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
CanPlayOnline[edit]
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
CreateOnlineAccount[edit]
Specified by: OnlineAccountInterface.CreateOnlineAccount
Creates a network enabled account on the online service
Parameters:
- UserName - the unique nickname of the account
- Password - the password securing the account
- EmailAddress - the address used to send password hints to
- ProductKey -
DenyFriendInvite[edit]
Specified by: OnlinePlayerInterface.DenyFriendInvite
Used to deny a friend request sent to this player
Parameters:
- LocalUserNum - the user the invite is for
- RequestingPlayer - the player the invite is from
- true - if successful, false otherwise
FlushOnlineStats[edit]
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
FreeStats[edit]
Specified by: OnlineStatsInterface.FreeStats
Cleans up any platform specific allocated data contained in the stats data
Parameters:
- StatsRead - the object to handle per platform clean up on
GetClientStatGuid[edit]
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
GetFriendsList[edit]
Specified by: OnlinePlayerInterface.GetFriendsList
Copies the list of friends for the player previously retrieved from the online service. The list can be retrieved in whole or in part.
Parameters:
- LocalUserNum - the user to read the friends list of
- Friends - the out array that receives the copied data
- Count - the number of friends to read or zero for all
- StartingAt - the index of the friends list to start at (for pulling partial lists)
Returns:
- OERS_Done if the read has completed, otherwise one of the other states
GetHostStatGuid[edit]
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
GetLoginStatus[edit]
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[edit]
Specified by: OnlineSystemInterface.GetNATType
Determines the NAT type the player is using
GetRecognitionResults[edit]
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
HasLinkConnection[edit]
Specified by: OnlineSystemInterface.HasLinkConnection
Determines if the ethernet link is connected or not
IsAchievementUnlocked[edit]
Specified by: OnlinePlayerInterfaceEx.IsAchievementUnlocked
Returns whether or not an achievement has been unlocked
Returns:
- true if the achievement is already unlocked, false otherwise
IsControllerConnected[edit]
Specified by: OnlineSystemInterface.IsControllerConnected
Determines if the specified controller is connected or not
Parameters:
- ControllerId - the controller to query
Returns:
- true if connected, false otherwise
IsFriend[edit]
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[edit]
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
IsKeyValid[edit]
Specified by: OnlineAccountInterface.IsKeyValid
Returns:
- true if the product key is valid, false if it is invalid
IsLocalPlayerTalking[edit]
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
IsRemotePlayerTalking[edit]
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[edit]
Specified by: OnlinePlayerInterface.JoinFriendGame
Allows the local player to follow a friend into a game
Parameters:
- LocalUserNum - the local player wanting to join
- Friend - the player that is being followed
Returns:
- true if the async call worked, false otherwise
Login[edit]
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[edit]
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[edit]
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
ReadContentAnnouncements[edit]
Specified by: OnlineNewsInterface.ReadContentAnnouncements
Reads the game specific content announcements from the online subsystem
Parameters:
- LocalUserNum - the local user the request is for
Returns:
- true if the async task was successfully started, false otherwise
ReadFriendMessages[edit]
Starts an blocking task that reads in the array of friend messages from disk
Parameters:
- LocalUserNum - the user to read the messages for
Returns:
- true if the read request was successful, false otherwise
ReadFriendsList[edit]
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
ReadGameNews[edit]
Specified by: OnlineNewsInterface.ReadGameNews
Reads the game specific news from the online subsystem
Parameters:
- LocalUserNum - the local user the news is being read for
Returns:
- true if the async task was successfully started, false otherwise
ReadOnlineStats[edit]
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[edit]
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[edit]
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[edit]
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[edit]
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
RegisterHostStatGuid[edit]
Specified by: OnlineStatsInterface.RegisterHostStatGuid
Registers the host's stat guid with the client for verification they are part of the stat. Note this is an async task for any backend communication that needs to happen before the registration is deemed complete
Parameters:
- HostStatGuid - the host's stat guid
Returns:
- TRUE if the call is successful, FALSE otherwise
RegisterLocalTalker[edit]
Specified by: OnlineVoiceInterface.RegisterLocalTalker
Registers the user as a talker
Parameters:
- LocalUserNum - the local player index that is a talker
Returns:
- TRUE if the call succeeded, FALSE otherwise
RegisterRemoteTalker[edit]
Specified by: OnlineVoiceInterface.RegisterRemoteTalker
Registers a remote player as a talker
Parameters:
- PlayerId - the unique id of the remote player that is a talker
Returns:
- TRUE if the call succeeded, FALSE otherwise
RegisterStatGuid[edit]
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[edit]
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
SaveKey[edit]
Specified by: OnlineAccountInterface.SaveKey
Saves the product key
Parameters:
- ProductKey - the product key the user entered
Returns:
- true if the key was stored successfully, false otherwise
SelectVocabulary[edit]
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[edit]
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[edit]
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[edit]
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
SetOnlineStatus[edit]
Specified by: OnlinePlayerInterface.SetOnlineStatus
Sets the online status information to use for the specified player. Used to tell other players what the player is doing (playing, menus, away, etc.)
Parameters:
- LocalUserNum - the controller number of the associated user
- StatusId - the status id to use (maps to strings where possible)
- LocalizedStringSettings - the list of localized string settings to set
- Properties - the list of properties to set
SetRemoteTalkerPriority[edit]
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[edit]
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
ShowKeyboardUI[edit]
Specified by: OnlinePlayerInterface.ShowKeyboardUI
Displays the UI that shows the keyboard for inputing text
Parameters:
- LocalUserNum - the controller number of the associated user
- TitleText - the title to display to the user
- DescriptionText - the text telling the user what to input
- bIsPassword - whether the item being entered is a password or not
- bShouldValidate - whether to apply the string validation API after input or not
- DefaultText - the default string to display
- MaxResultLength - the maximum length string expected to be filled in
Returns:
- TRUE if it was able to show the UI, FALSE if it failed
ShowLoginUI[edit]
Specified by: OnlinePlayerInterface.ShowLoginUI
Displays the UI that prompts the user for their login credentials. Each platform handles the authentication of the user's data.
Parameters:
- bShowOnlineOnly - whether to only display online enabled profiles or not
Returns:
- TRUE if it was able to show the UI, FALSE if it failed
StartNetworkedVoice[edit]
Specified by: OnlineVoiceInterface.StartNetworkedVoice
Tells the voice layer that networked processing of the voice data is allowed for the specified player. This allows for push-to-talk style voice communication
Parameters:
- LocalUserNum - the local user to allow network transimission for
StartSpeechRecognition[edit]
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[edit]
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[edit]
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[edit]
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
UnmuteRemoteTalker[edit]
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[edit]
Specified by: OnlineVoiceInterface.UnregisterLocalTalker
Unregisters the user as a talker
Parameters:
- LocalUserNum - the local player index to be removed
Returns:
- TRUE if the call succeeded, FALSE otherwise
UnregisterRemoteTalker[edit]
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
WriteFriendMessages[edit]
Starts an blocking task that writes the array of friend messages out to disk
Parameters:
- LocalUserNum - the user to write the messages for
Returns:
- true if the write request was successful, false otherwise
WriteOnlinePlayerScores[edit]
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[edit]
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[edit]
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