The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall
UE3:OnlinePlayerInterface (UT3)
 |
Interface >> OnlinePlayerInterface |
Contents
- 1 Delegates
- 1.1 OnAddFriendByNameComplete
- 1.2 OnFriendInviteReceived
- 1.3 OnFriendMessageReceived
- 1.4 OnFriendsChange
- 1.5 OnJoinFriendGameComplete
- 1.6 OnKeyboardInputComplete
- 1.7 OnLoginCancelled
- 1.8 OnLoginChange
- 1.9 OnLoginFailed
- 1.10 OnLogoutCompleted
- 1.11 OnMutingChange
- 1.12 OnReadFriendsComplete
- 1.13 OnReadProfileSettingsComplete
- 1.14 OnReceivedGameInvite
- 1.15 OnWriteProfileSettingsComplete
- 2 Functions
- Package:
- Engine
- Known implementing classes:
- OnlineSubsystemGameSpy, OnlineSubsystemLive
- This interface 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. |
This interface provides accessors to the platform specific player methods. NOTE: All players are referenced by their controller number, which is zero on the PC.
Delegates[edit]
OnAddFriendByNameComplete[edit]
Called when a friend invite arrives for a local player
Parameters:
- bWasSuccessful - true if successfully added, false if not found or failed
OnFriendInviteReceived[edit]
Called when a friend invite arrives for a local player
Parameters:
- LocalUserNum - the user that is receiving the invite
- RequestingPlayer - the player sending the friend request
- RequestingNick - the nick of the player sending the friend request
- Message - the message to display to the recipient
OnFriendMessageReceived[edit]
Called when a friend invite arrives for a local player
Parameters:
- LocalUserNum - the user that is receiving the message
- SendingPlayer - the player sending the message
- SendingNick - the nick of the player sending the message
- Message - the message to display to the recipient
OnFriendsChange[edit]
Delegate used in friends list change notifications
OnJoinFriendGameComplete[edit]
Called once the join task has completed
Parameters:
- bWasSuccessful - the session was found and is joinable, false otherwise
OnKeyboardInputComplete[edit]
Delegate used when the keyboard input request has completed
Parameters:
- bWasSuccessful - true if the async action completed without error, false if there was an error
OnLoginCancelled[edit]
Delegate used to notify when a login request was cancelled by the user
OnLoginChange[edit]
Delegate used in login notifications
OnLoginFailed[edit]
Delegate used in notifying the UI/game that the manual login failed
Parameters:
- LocalUserNum - the controller number of the associated user
- ErrorCode - the async error code that occurred
OnLogoutCompleted[edit]
Delegate used in notifying the UI/game that the manual logout completed
Parameters:
- bWasSuccessful - whether the async call completed properly or not
OnMutingChange[edit]
Delegate used in mute list change notifications
OnReadFriendsComplete[edit]
Delegate used when the friends read request has completed
Parameters:
- bWasSuccessful - true if the async action completed without error, false if there was an error
OnReadProfileSettingsComplete[edit]
Delegate used when the last read profile settings request has completed
Parameters:
- bWasSuccessful - true if the async action completed without error, false if there was an error
OnReceivedGameInvite[edit]
Called when the online system receives a game invite that needs handling
Parameters:
- LocalUserNum - the user that is receiving the invite
- InviterName - the nick name of the person sending the invite
OnWriteProfileSettingsComplete[edit]
Delegate used when the last write profile settings request has completed
Parameters:
- bWasSuccessful - true if the async action completed without error, false if there was an error
