UE3:OnlineSubsystemPC delegates (UDK)

Object >> OnlineSubsystem >> OnlineSubsystemCommonImpl >> OnlineSubsystemPC (delegates)

;Other member categories for this class::instance functions

Delegates

OnAddFriendByNameComplete

delegate OnAddFriendByNameComplete (bool bWasSuccessful)

Specified by: OnlinePlayerInterface.OnAddFriendByNameComplete

Called when a friend invite arrives for a local player

Parameters:

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

OnConnectionStatusChange

delegate OnConnectionStatusChange (OnlineSubsystem.EOnlineServerConnectionStatus ConnectionStatus)

Specified by: OnlineSystemInterface.OnConnectionStatusChange

Delegate fire when the online server connection state changes

Parameters:

• ConnectionStatus - the new connection status

OnControllerChange

delegate OnControllerChange (int ControllerId, bool bIsConnected)

Specified by: OnlineSystemInterface.OnControllerChange

Delegate fired when the controller becomes dis/connected

Parameters:

• ControllerId - the id of the controller that changed connection state
• bIsConnected - whether the controller connected (true) or disconnected (false)

OnExternalUIChange

delegate OnExternalUIChange (bool bIsOpening)

Specified by: OnlineSystemInterface.OnExternalUIChange

Delegate fired when an external UI display state changes (opening/closing)

Parameters:

• bIsOpening - whether the external UI is opening or closing

OnFlushOnlineStatsComplete

delegate OnFlushOnlineStatsComplete (name SessionName, bool bWasSuccessful)

Specified by: OnlineStatsInterface.OnFlushOnlineStatsComplete

Delegate called when the stats flush operation has completed

Parameters:

• SessionName - the name of the session having stats flushed
• bWasSuccessful - true if the async action completed without error, false if there was an error

OnFriendInviteReceived

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

Specified by: OnlinePlayerInterface.OnFriendInviteReceived

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)

Specified by: OnlinePlayerInterface.OnFriendMessageReceived

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 ()

Specified by: OnlinePlayerInterface.OnFriendsChange

Delegate used in friends list change notifications

OnJoinFriendGameComplete

delegate OnJoinFriendGameComplete (bool bWasSuccessful)

Specified by: OnlinePlayerInterface.OnJoinFriendGameComplete

Called once the join task has completed

Parameters:

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

OnKeyboardInputComplete

delegate OnKeyboardInputComplete (bool bWasSuccessful)

Specified by: OnlinePlayerInterface.OnKeyboardInputComplete

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

OnLinkStatusChange

delegate OnLinkStatusChange (bool bIsConnected)

Specified by: OnlineSystemInterface.OnLinkStatusChange

Delegate fired when the network link status changes

Parameters:

• bIsConnected - whether the link is currently connected or not

OnLoginCancelled

delegate OnLoginCancelled ()

Specified by: OnlinePlayerInterface.OnLoginCancelled

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

OnLoginChange

delegate OnLoginChange (byte LocalUserNum)

Specified by: OnlinePlayerInterface.OnLoginChange

Delegate used in login notifications

Parameters:

• LocalUserNum - the player that had the login change

OnLoginFailed

delegate OnLoginFailed (byte LocalUserNum, OnlineSubsystem.EOnlineServerConnectionStatus ErrorCode)

Specified by: OnlinePlayerInterface.OnLoginFailed

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

OnLoginStatusChange

delegate OnLoginStatusChange (OnlineSubsystem.ELoginStatus NewStatus, OnlineSubsystem.UniqueNetId NewId)

Specified by: OnlinePlayerInterface.OnLoginStatusChange

Delegate called when a player's status changes but doesn't change profiles

Parameters:

• NewStatus - the new login status for the user
• NewId - the new id to associate with the user

OnLogoutCompleted

delegate OnLogoutCompleted (bool bWasSuccessful)

Specified by: OnlinePlayerInterface.OnLogoutCompleted

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 ()

Specified by: OnlinePlayerInterface.OnMutingChange

Delegate used in mute list change notifications

OnPlayerTalkingStateChange

delegate OnPlayerTalkingStateChange (OnlineSubsystem.UniqueNetId Player, bool bIsTalking)

Specified by: OnlineVoiceInterface.OnPlayerTalkingStateChange

Called when a player is talking either locally or remote. This will be called once for each active talker each frame.

Parameters:

• Player - the player that is talking
• bIsTalking - if true, the player is now talking, if false they are no longer talking

OnReadFriendsComplete

delegate OnReadFriendsComplete (bool bWasSuccessful)

Specified by: OnlinePlayerInterface.OnReadFriendsComplete

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

OnReadOnlineStatsComplete

delegate OnReadOnlineStatsComplete (bool bWasSuccessful)

Specified by: OnlineStatsInterface.OnReadOnlineStatsComplete

Notifies the interested party that the last stats read has completed

Parameters:

• bWasSuccessful - true if the async action completed without error, false if there was an error

OnReadPlayerStorageComplete

delegate OnReadPlayerStorageComplete (byte LocalUserNum, bool bWasSuccessful)

Specified by: OnlinePlayerInterface.OnReadPlayerStorageComplete

Delegate used when the last read of online player storage data request has completed

Parameters:

• LocalUserNum - the controller index of the player who's read just completed
• bWasSuccessful - true if the async action completed without error, false if there was an error

OnReadPlayerStorageForNetIdComplete

delegate OnReadPlayerStorageForNetIdComplete (OnlineSubsystem.UniqueNetId NetId, bool bWasSuccessful)

Specified by: OnlinePlayerInterface.OnReadPlayerStorageForNetIdComplete

Delegate used when the last read of online player storage data request has completed

Parameters:

• NetId - the net id for the user who's read just completed
• bWasSuccessful - true if the async action completed without error, false if there was an error

OnReadProfileSettingsComplete

delegate OnReadProfileSettingsComplete (byte LocalUserNum, bool bWasSuccessful)

Specified by: OnlinePlayerInterface.OnReadProfileSettingsComplete

Delegate used when the last read profile settings request has completed

Parameters:

• LocalUserNum - the controller index of the player who's read just completed
• bWasSuccessful - true if the async action completed without error, false if there was an error

OnReadTitleFileComplete

delegate OnReadTitleFileComplete (bool bWasSuccessful, string FileName)

Specified by: OnlineSystemInterface.OnReadTitleFileComplete

Delegate fired when a file read from the network platform's title specific storage is complete

Parameters:

• bWasSuccessful - whether the file read was successful or not
• FileName - the name of the file this was for

OnReceivedGameInvite

delegate OnReceivedGameInvite (byte LocalUserNum, string InviterName)

Specified by: OnlinePlayerInterface.OnReceivedGameInvite

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

OnRecognitionComplete

delegate OnRecognitionComplete ()

Specified by: OnlineVoiceInterface.OnRecognitionComplete

Called when speech recognition for a given player has completed. The consumer of the notification can call GetRecognitionResults() to get the words that were recognized

OnRegisterHostStatGuidComplete

delegate OnRegisterHostStatGuidComplete (bool bWasSuccessful)

Specified by: OnlineStatsInterface.OnRegisterHostStatGuidComplete

Called when the host stat guid registration is complete

Parameters:

• bWasSuccessful - whether the registration has completed or not

OnStorageDeviceChange

delegate OnStorageDeviceChange ()

Specified by: OnlineSystemInterface.OnStorageDeviceChange

Delegate fired when a storage device change is detected

OnWritePlayerStorageComplete

delegate OnWritePlayerStorageComplete (byte LocalUserNum, bool bWasSuccessful)

Specified by: OnlinePlayerInterface.OnWritePlayerStorageComplete

Delegate used when the last write online player storage request has completed

Parameters:

• LocalUserNum - the controller index of the player who's write just completed
• bWasSuccessful - true if the async action completed without error, false if there was an error

OnWriteProfileSettingsComplete

delegate OnWriteProfileSettingsComplete (byte LocalUserNum, bool bWasSuccessful)

Specified by: OnlinePlayerInterface.OnWriteProfileSettingsComplete

Delegate used when the last write profile settings request has completed

Parameters:

• LocalUserNum - the controller index of the player who's write just completed
• bWasSuccessful - true if the async action completed without error, false if there was an error