Gah - a solution with more questions. – EntropicLqd

UE3:OnlineSubsystemGameSpy delegates (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search

;Other member categories for this class::instance functions, native functions, properties

Delegates[edit]

OnAddFriendByNameComplete[edit]

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

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

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)

OnCreateOnlineAccountCompleted[edit]

delegate OnCreateOnlineAccountCompleted (OnlineSubsystem.EOnlineAccountCreateStatus ErrorStatus)

Specified by: OnlineAccountInterface.OnCreateOnlineAccountCompleted

Delegate used in notifying the UI/game that the account creation completed

Parameters:

  • ErrorStatus - whether the account created successfully or not

OnDeviceSelectionComplete[edit]

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

OnExternalUIChange[edit]

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

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

OnFriendInviteReceived[edit]

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

OnFriendMessageReceived[edit]

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

OnFriendsChange[edit]

delegate OnFriendsChange ()

Specified by: OnlinePlayerInterface.OnFriendsChange

Delegate used in friends list change notifications

OnJoinFriendGameComplete[edit]

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

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

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

delegate OnLoginCancelled ()

Specified by: OnlinePlayerInterface.OnLoginCancelled

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

OnLoginChange[edit]

delegate OnLoginChange ()

Specified by: OnlinePlayerInterface.OnLoginChange

Delegate used in login notifications

OnLoginFailed[edit]

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

OnLogoutCompleted[edit]

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

delegate OnMutingChange ()

Specified by: OnlinePlayerInterface.OnMutingChange

Delegate used in mute list change notifications

OnPlayerTalking[edit]

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

OnProfileDataChanged[edit]

delegate OnProfileDataChanged ()

Specified by: OnlinePlayerInterfaceEx.OnProfileDataChanged

Called when an external change to player profile data has occured

OnReadContentAnnouncementsCompleted[edit]

delegate OnReadContentAnnouncementsCompleted (bool bWasSuccessful)

Specified by: OnlineNewsInterface.OnReadContentAnnouncementsCompleted

Delegate used in notifying the UI/game that the content announcements read operation completed

Parameters:

  • bWasSuccessful - true if the read completed ok, false otherwise

OnReadFriendsComplete[edit]

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

OnReadGameNewsCompleted[edit]

delegate OnReadGameNewsCompleted (bool bWasSuccessful)

Specified by: OnlineNewsInterface.OnReadGameNewsCompleted

Delegate used in notifying the UI/game that the news read operation completed

Parameters:

  • bWasSuccessful - true if the read completed ok, false otherwise

OnReadOnlineStatsComplete[edit]

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

OnReadProfileSettingsComplete[edit]

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

OnReceivedGameInvite[edit]

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

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

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

delegate OnStorageDeviceChange ()

Specified by: OnlineSystemInterface.OnStorageDeviceChange

Delegate fired when a storage device change is detected

OnUnlockAchievementComplete[edit]

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

OnWriteProfileSettingsComplete[edit]

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