UE3:OnlinePlayerInterface (UT3)

Interface >> OnlinePlayerInterface

Package: 

Engine

Known implementing classes:

OnlineSubsystemGameSpy, OnlineSubsystemLive

This interface in other games:

UDK

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

OnAddFriendByNameComplete

delegate OnAddFriendByNameComplete (bool bWasSuccessful)

Called when a friend invite arrives for a local player

Parameters:

• bWasSuccessful - true if successfully added, false if not found or failed

OnFriendInviteReceived

delegate OnFriendInviteReceived (byte LocalUserNum, OnlineSubsystem.UniqueNetId RequestingPlayer, string RequestingNick, string Message)

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

delegate OnFriendMessageReceived (byte LocalUserNum, OnlineSubsystem.UniqueNetId SendingPlayer, string SendingNick, string Message)

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

delegate OnFriendsChange ()

Delegate used in friends list change notifications

OnJoinFriendGameComplete

delegate OnJoinFriendGameComplete (bool bWasSuccessful)

Called once the join task has completed

Parameters:

• bWasSuccessful - the session was found and is joinable, false otherwise

OnKeyboardInputComplete

delegate OnKeyboardInputComplete (bool bWasSuccessful)

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

delegate OnLoginCancelled ()

Delegate used to notify when a login request was cancelled by the user

OnLoginChange

delegate OnLoginChange ()

Delegate used in login notifications

OnLoginFailed

delegate OnLoginFailed (byte LocalUserNum, OnlineSubsystem.EOnlineServerConnectionStatus ErrorCode)

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

delegate OnLogoutCompleted (bool bWasSuccessful)

Delegate used in notifying the UI/game that the manual logout completed

Parameters:

• bWasSuccessful - whether the async call completed properly or not

OnMutingChange

delegate OnMutingChange ()

Delegate used in mute list change notifications

OnReadFriendsComplete

delegate OnReadFriendsComplete (bool bWasSuccessful)

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

delegate OnReadProfileSettingsComplete (bool bWasSuccessful)

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

delegate OnReceivedGameInvite (byte LocalUserNum, string InviterName)

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

delegate OnWriteProfileSettingsComplete (bool bWasSuccessful)

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

Functions

See OnlinePlayerInterface functions.