Always snap to grid
UE3:OnlinePlayerInterface functions (UT3)
OnlinePlayerInterface (functions) |
Contents
- 1 Functions
- 1.1 Instance functions
- 1.1.1 AcceptFriendInvite
- 1.1.2 AddAddFriendByNameCompleteDelegate
- 1.1.3 AddFriend
- 1.1.4 AddFriendByName
- 1.1.5 AddFriendInviteReceivedDelegate
- 1.1.6 AddFriendMessageReceivedDelegate
- 1.1.7 AddFriendsChangeDelegate
- 1.1.8 AddJoinFriendGameCompleteDelegate
- 1.1.9 AddKeyboardInputDoneDelegate
- 1.1.10 AddLoginCancelledDelegate
- 1.1.11 AddLoginChangeDelegate
- 1.1.12 AddLoginFailedDelegate
- 1.1.13 AddLogoutCompletedDelegate
- 1.1.14 AddMutingChangeDelegate
- 1.1.15 AddReadFriendsCompleteDelegate
- 1.1.16 AddReadProfileSettingsCompleteDelegate
- 1.1.17 AddReceivedGameInviteDelegate
- 1.1.18 AddWriteProfileSettingsCompleteDelegate
- 1.1.19 AreAnyFriends
- 1.1.20 AutoLogin
- 1.1.21 CanCommunicate
- 1.1.22 CanDownloadUserContent
- 1.1.23 CanPlayOnline
- 1.1.24 CanPurchaseContent
- 1.1.25 CanShowPresenceInformation
- 1.1.26 CanViewPlayerProfiles
- 1.1.27 ClearAddFriendByNameCompleteDelegate
- 1.1.28 ClearFriendInviteReceivedDelegate
- 1.1.29 ClearFriendMessageReceivedDelegate
- 1.1.30 ClearFriendsChangeDelegate
- 1.1.31 ClearJoinFriendGameCompleteDelegate
- 1.1.32 ClearKeyboardInputDoneDelegate
- 1.1.33 ClearLoginCancelledDelegate
- 1.1.34 ClearLoginChangeDelegate
- 1.1.35 ClearLoginFailedDelegate
- 1.1.36 ClearLogoutCompletedDelegate
- 1.1.37 ClearMutingChangeDelegate
- 1.1.38 ClearReadFriendsCompleteDelegate
- 1.1.39 ClearReadProfileSettingsCompleteDelegate
- 1.1.40 ClearReceivedGameInviteDelegate
- 1.1.41 ClearWriteProfileSettingsCompleteDelegate
- 1.1.42 DeleteMessage
- 1.1.43 DenyFriendInvite
- 1.1.44 GetFriendMessages
- 1.1.45 GetFriendsList
- 1.1.46 GetKeyboardInputResults
- 1.1.47 GetLoginStatus
- 1.1.48 GetPlayerNickname
- 1.1.49 GetProfileSettings
- 1.1.50 GetUniquePlayerId
- 1.1.51 IsFriend
- 1.1.52 IsMuted
- 1.1.53 JoinFriendGame
- 1.1.54 Login
- 1.1.55 Logout
- 1.1.56 ReadFriendsList
- 1.1.57 ReadProfileSettings
- 1.1.58 RemoveFriend
- 1.1.59 SendGameInviteToFriend
- 1.1.60 SendGameInviteToFriends
- 1.1.61 SendMessageToFriend
- 1.1.62 SetOnlineStatus
- 1.1.63 ShowFriendsUI
- 1.1.64 ShowKeyboardUI
- 1.1.65 ShowLoginUI
- 1.1.66 WriteProfileSettings
- 1.1 Instance functions
- OnlinePlayerInterface functions in other games:
- UDK
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. |
Functions[edit]
Instance functions[edit]
AcceptFriendInvite[edit]
Used to accept a friend invite sent to this player
Parameters:
- LocalUserNum - the user the invite is for
- RequestingPlayer - the player the invite is from
- true - if successful, false otherwise
AddAddFriendByNameCompleteDelegate[edit]
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
AddFriend[edit]
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]
Sends a friend invite to the specified player nick
Parameters:
- LocalUserNum - the user that is sending the invite
- FriendName - the name of the player to send the invite to
- Message - the message to display to the recipient
Returns:
- true if successful, false otherwise
AddFriendInviteReceivedDelegate[edit]
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[edit]
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[edit]
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[edit]
Sets the delegate used to notify when the join friend is complete
Parameters:
- JoinFriendGameCompleteDelegate - the delegate to use for notifications
AddKeyboardInputDoneDelegate[edit]
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
AddLoginCancelledDelegate[edit]
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[edit]
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[edit]
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[edit]
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[edit]
Sets the delegate used to notify the gameplay code that a muting list changed
Parameters:
- MutingDelegate - the delegate to use for notifications
AddReadFriendsCompleteDelegate[edit]
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
AddReadProfileSettingsCompleteDelegate[edit]
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[edit]
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
AddWriteProfileSettingsCompleteDelegate[edit]
Sets the delegate used to notify the gameplay code that the last write request has completed
Parameters:
- LocalUserNum - which user to watch for write complete notifications
- WriteProfileSettingsCompleteDelegate - the delegate to use for notifications
AreAnyFriends[edit]
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]
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]
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[edit]
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[edit]
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[edit]
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[edit]
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[edit]
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[edit]
Removes the delegate specified from the list
Parameters:
- LocalUserNum - the user associated with the notification
- FriendDelegate - the delegate to use for notifications
ClearFriendInviteReceivedDelegate[edit]
Removes the delegate specified from the list
Parameters:
- LocalUserNum - the user associated with the notification
- InviteDelegate - the delegate to use for notifications
ClearFriendMessageReceivedDelegate[edit]
Removes the delegate specified from the list
Parameters:
- LocalUserNum - the user associated with the notification
- MessageDelegate - the delegate to use for notifications
ClearFriendsChangeDelegate[edit]
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
ClearJoinFriendGameCompleteDelegate[edit]
Removes the delegate from the list of notifications
Parameters:
- JoinFriendGameCompleteDelegate - the delegate to use for notifications
ClearKeyboardInputDoneDelegate[edit]
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
ClearLoginCancelledDelegate[edit]
Removes the specified delegate from the notification list
Parameters:
- CancelledDelegate - the delegate to remove fromt he list
ClearLoginChangeDelegate[edit]
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[edit]
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[edit]
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[edit]
Clears the delegate used to notify the gameplay code that a muting list changed
Parameters:
- MutingDelegate - the delegate to use for notifications
ClearReadFriendsCompleteDelegate[edit]
Clears 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
ClearReadProfileSettingsCompleteDelegate[edit]
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[edit]
Removes the delegate specified from the list
Parameters:
- LocalUserNum - the user associated with the notification
- ReceivedGameInviteDelegate - the delegate to use for notifications
ClearWriteProfileSettingsCompleteDelegate[edit]
Clears the delegate used to notify the gameplay code that the last write request has completed
Parameters:
- LocalUserNum - which user to watch for write complete notifications
- WriteProfileSettingsCompleteDelegate - the delegate to use for notifications
DeleteMessage[edit]
Deletes a message from the list of messages
Parameters:
- LocalUserNum - the user that is deleting the message
- MessageIndex - the index of the message to delete
Returns:
- true if the message was deleted, false otherwise
DenyFriendInvite[edit]
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
GetFriendMessages[edit]
Returns the list of messages for the specified player
Parameters:
- LocalUserNum - the local player wanting to join
- FriendMessages - the set of messages cached locally for the player
GetFriendsList[edit]
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
GetKeyboardInputResults[edit]
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
GetLoginStatus[edit]
Fetches the login status for a given player
Parameters:
- LocalUserNum - the controller number of the associated user
Returns:
- the enum value of their status
GetPlayerNickname[edit]
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[edit]
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[edit]
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
IsFriend[edit]
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
IsMuted[edit]
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
JoinFriendGame[edit]
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]
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]
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
ReadFriendsList[edit]
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
ReadProfileSettings[edit]
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
RemoveFriend[edit]
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
SendGameInviteToFriend[edit]
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]
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]
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]
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
ShowFriendsUI[edit]
Displays the UI that shows a user's list of friends
Parameters:
- LocalUserNum - the controller number of the associated user
Returns:
- TRUE if it was able to show the UI, FALSE if it failed
ShowKeyboardUI[edit]
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]
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
WriteProfileSettings[edit]
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