Mostly Harmless

UE3:OnlineSubsystemLive delegates (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
UT3 Object >> OnlineSubsystem >> OnlineSubsystemCommonImpl >> OnlineSubsystemLive (delegates)

Contents
Other member categories for this class:
instance functions, native functions, properties
This is an auto-generated page and may need human attention.
Please remove this tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

[edit] Delegates

[edit] 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

[edit] OnArbitrationRegistrationComplete

delegate OnArbitrationRegistrationComplete (bool bWasSuccessful)

Specified by: OnlineGameInterface.OnArbitrationRegistrationComplete

Delegate fired when the online game has completed registration for arbitration

Parameters:

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

[edit] OnCancelFindOnlineGamesComplete

delegate OnCancelFindOnlineGamesComplete (bool bWasSuccessful)

Specified by: OnlineGameInterface.OnCancelFindOnlineGamesComplete

Delegate fired when the cancellation of a search for an online game has completed

Parameters:

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

[edit] 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

[edit] OnContentChange

delegate OnContentChange ()

Specified by: OnlineContentInterface.OnContentChange

Delegate used in content change (add or deletion) notifications for any user

[edit] 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)

[edit] OnCreateOnlineGameComplete

delegate OnCreateOnlineGameComplete (bool bWasSuccessful)

Specified by: OnlineGameInterface.OnCreateOnlineGameComplete

Delegate fired when a create request has completed

Parameters:

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

[edit] OnDestroyOnlineGameComplete

delegate OnDestroyOnlineGameComplete (bool bWasSuccessful)

Specified by: OnlineGameInterface.OnDestroyOnlineGameComplete

Delegate fired when a destroying an online game has completed

Parameters:

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

[edit] OnDeviceSelectionComplete

delegate OnDeviceSelectionComplete (bool bWasSuccessful)

Specified by: OnlinePlayerInterfaceEx.OnDeviceSelectionComplete

Delegate used when the device selection request has completed

Parameters:

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

[edit] OnEndOnlineGameComplete

delegate OnEndOnlineGameComplete (bool bWasSuccessful)

Specified by: OnlineGameInterface.OnEndOnlineGameComplete

Delegate fired when the online game has transitioned to the ending game state

Parameters:

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

[edit] 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

[edit] OnFindOnlineGamesComplete

delegate OnFindOnlineGamesComplete (bool bWasSuccessful)

Specified by: OnlineGameInterface.OnFindOnlineGamesComplete

Delegate fired when the search for an online game has completed

Parameters:

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

[edit] OnFlushOnlineStatsComplete

delegate OnFlushOnlineStatsComplete (bool bWasSuccessful)

Specified by: OnlineStatsInterface.OnFlushOnlineStatsComplete

Delegate called when the stats flush operation has completed

Parameters:

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

[edit] 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

Returns:

true if successful, false otherwise

[edit] 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 invite
  • SendingPlayer - the player sending the friend request
  • SendingNick - the nick of the player sending the friend request
  • Message - the message to display to the recipient

Returns:

true if successful, false otherwise

[edit] OnFriendsChange

delegate OnFriendsChange ()

Specified by: OnlinePlayerInterface.OnFriendsChange

Delegate used in friends list change notifications

[edit] OnGameInviteAccepted

delegate OnGameInviteAccepted (OnlineGameSettings InviteSettings)

Specified by: OnlineGameInterface.OnGameInviteAccepted

Called when a user accepts a game invitation. Allows the gameplay code a chance to clean up any existing state before accepting the invite. The invite must be accepted by calling AcceptGameInvite() on the OnlineGameInterface after clean up has completed

Parameters:

  • InviteSettings - the settings for the game we're joining via invite

[edit] 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

[edit] OnJoinOnlineGameComplete

delegate OnJoinOnlineGameComplete (bool bWasSuccessful)

Specified by: OnlineGameInterface.OnJoinOnlineGameComplete

Delegate fired when the joing process for an online game has completed

Parameters:

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

[edit] 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

[edit] 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

[edit] OnLoginCancelled

delegate OnLoginCancelled ()

Specified by: OnlinePlayerInterface.OnLoginCancelled

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

[edit] OnLoginChange

delegate OnLoginChange ()

Specified by: OnlinePlayerInterface.OnLoginChange

Delegate used in login notifications

[edit] 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

[edit] 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

[edit] OnMutingChange

delegate OnMutingChange ()

Specified by: OnlinePlayerInterface.OnMutingChange

Delegate used in mute list change notifications

[edit] OnPlayerTalking

delegate OnPlayerTalking (OnlineSubsystem.UniqueNetId Player)

Specified by: OnlineVoiceInterface.OnPlayerTalking

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

[edit] OnProfileDataChanged

delegate OnProfileDataChanged ()

Specified by: OnlinePlayerInterfaceEx.OnProfileDataChanged

Called when an external change to player profile data has occured

[edit] OnQueryAvailableDownloadsComplete

delegate OnQueryAvailableDownloadsComplete (bool bWasSuccessful)

Specified by: OnlineContentInterface.OnQueryAvailableDownloadsComplete

Called once the download query completes

Parameters:

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

[edit] OnReadContentComplete

delegate OnReadContentComplete (bool bWasSuccessful)

Specified by: OnlineContentInterface.OnReadContentComplete

Delegate used when the content read request has completed

Parameters:

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

[edit] 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

[edit] 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

[edit] OnReadProfileSettingsComplete

delegate OnReadProfileSettingsComplete (bool bWasSuccessful)

Specified by: OnlinePlayerInterface.OnReadProfileSettingsComplete

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

[edit] 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

[edit] 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

[edit] 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

[edit] OnRegisterPlayerComplete

delegate OnRegisterPlayerComplete (bool bWasSuccessful)

Specified by: OnlineGameInterface.OnRegisterPlayerComplete

Delegate fired when the registration process has completed

Parameters:

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

[edit] OnStartOnlineGameComplete

delegate OnStartOnlineGameComplete (bool bWasSuccessful)

Specified by: OnlineGameInterface.OnStartOnlineGameComplete

Delegate fired when the online game has transitioned to the started state

Parameters:

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

[edit] OnStorageDeviceChange

delegate OnStorageDeviceChange ()

Specified by: OnlineSystemInterface.OnStorageDeviceChange

Delegate fired when a storage device change is detected

[edit] OnUnlockAchievementComplete

delegate OnUnlockAchievementComplete (bool bWasSuccessful)

Specified by: OnlinePlayerInterfaceEx.OnUnlockAchievementComplete

Delegate used when the achievement unlocking has completed

Parameters:

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

[edit] OnUnregisterPlayerComplete

delegate OnUnregisterPlayerComplete (bool bWasSuccessful)

Specified by: OnlineGameInterface.OnUnregisterPlayerComplete

Delegate fired when the unregistration process has completed

Parameters:

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

[edit] OnWriteProfileSettingsComplete

delegate OnWriteProfileSettingsComplete (bool bWasSuccessful)

Specified by: OnlinePlayerInterface.OnWriteProfileSettingsComplete

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
Retrieved from "http://wiki.beyondunreal.com/UE3:OnlineSubsystemLive_delegates_(UT3)"