Navigation
API > API/Plugins > API/Plugins/OnlineSubsystem
Interface definition for the online services external UIs Any online service that provides extra UI overlays will implement the relevant functions
| Name | IOnlineExternalUI |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineExternalUIInterface.h |
| Include Path | #include "Interfaces/OnlineExternalUIInterface.h" |
Syntax
class IOnlineExternalUI
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
IOnlineExternalUI() |
Interfaces/OnlineExternalUIInterface.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IOnlineExternalUI() |
Interfaces/OnlineExternalUIInterface.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnCreateAccountFlowUIRequiredDelegates | FOnCreateAccountFlowUIRequired | Delegate called when the online subsystem requires an external UI to handle account creation | Interfaces/OnlineExternalUIInterface.h | |
| OnExternalUIChangeDelegates | FOnExternalUIChange | Delegate called when the external UI is opened or closed | Interfaces/OnlineExternalUIInterface.h | |
| OnLoginFlowUIRequiredDelegates | FOnLoginFlowUIRequired | Delegate called when the online subsystem requires an external UI to handle login flow | Interfaces/OnlineExternalUIInterface.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FDelegateHandle AddOnCreateAccountFlowUIRequiredDelegate_Handle
(
const FOnCreateAccountFlowUIRequiredDelegate& Delegate |
Interfaces/OnlineExternalUIInterface.h | ||
virtual FDelegateHandle AddOnExternalUIChangeDelegate_Handle
(
const FOnExternalUIChangeDelegate& Delegate |
Interfaces/OnlineExternalUIInterface.h | ||
virtual FDelegateHandle AddOnLoginFlowUIRequiredDelegate_Handle
(
const FOnLoginFlowUIRequiredDelegate& Delegate |
Interfaces/OnlineExternalUIInterface.h | ||
virtual void ClearOnCreateAccountFlowUIRequiredDelegate_Handle
(
FDelegateHandle& Handle |
Interfaces/OnlineExternalUIInterface.h | ||
virtual void ClearOnCreateAccountFlowUIRequiredDelegates
(
FDelegateUserObject Object |
Interfaces/OnlineExternalUIInterface.h | ||
virtual void ClearOnExternalUIChangeDelegate_Handle
(
FDelegateHandle& Handle |
Interfaces/OnlineExternalUIInterface.h | ||
virtual void ClearOnExternalUIChangeDelegates
(
FDelegateUserObject Object |
Interfaces/OnlineExternalUIInterface.h | ||
virtual void ClearOnLoginFlowUIRequiredDelegate_Handle
(
FDelegateHandle& Handle |
Interfaces/OnlineExternalUIInterface.h | ||
virtual void ClearOnLoginFlowUIRequiredDelegates
(
FDelegateUserObject Object |
Interfaces/OnlineExternalUIInterface.h | ||
bool CloseWebURL() |
Closes the currently active web external UI | Interfaces/OnlineExternalUIInterface.h | |
virtual void ReportEnterInGameStoreUI() |
Tell the system that you've entered into a screen considered in-game store. | Interfaces/OnlineExternalUIInterface.h | |
virtual void ReportExitInGameStoreUI() |
Tell the system that you've entered into a screen considered in-game store. | Interfaces/OnlineExternalUIInterface.h | |
bool ShowAccountCreationUI
(
const int ControllerIndex, |
Displays the UI that prompts the user to create an account | Interfaces/OnlineExternalUIInterface.h | |
bool ShowAccountUpgradeUI
(
const FUniqueNetId& UniqueId |
Displays a system dialog to purchase user account upgrades. | Interfaces/OnlineExternalUIInterface.h | |
bool ShowAchievementsUI
(
int32 LocalUserNum |
Displays the UI that shows a user's list of achievements | Interfaces/OnlineExternalUIInterface.h | |
bool ShowFriendsUI
(
int32 LocalUserNum |
Displays the UI that shows a user's list of friends | Interfaces/OnlineExternalUIInterface.h | |
bool ShowInviteUI
(
int32 LocalUserNum, |
Displays the UI that shows a user's list of friends to invite | Interfaces/OnlineExternalUIInterface.h | |
bool ShowLeaderboardUI
(
const FString& LeaderboardName |
Displays the UI that shows a specific leaderboard | Interfaces/OnlineExternalUIInterface.h | |
bool ShowLoginUI
(
const int ControllerIndex, |
Displays the UI that prompts the user for their login credentials. | Interfaces/OnlineExternalUIInterface.h | |
virtual bool ShowPlatformMessageBox
(
const FUniqueNetId& UserId, |
Displays an informational system dialog. | Interfaces/OnlineExternalUIInterface.h | |
bool ShowProfileUI
(
const FUniqueNetId& Requestor, |
Displays a user's profile card. | Interfaces/OnlineExternalUIInterface.h | |
virtual bool ShowSendMessageToUserUI
(
int32 LocalUserNum, |
Display the platform UI for sending a mailbox message to the specified user. | Interfaces/OnlineExternalUIInterface.h | |
bool ShowSendMessageUI
(
int32 LocalUserNum, |
Display the platform UI for sending a mailbox message to another user | Interfaces/OnlineExternalUIInterface.h | |
bool ShowStoreUI
(
int32 LocalUserNum, |
Display the platform UI for browsing available products for purchase | Interfaces/OnlineExternalUIInterface.h | |
bool ShowWebURL
(
const FString& Url, |
Displays a web page in the external UI | Interfaces/OnlineExternalUIInterface.h | |
virtual void TriggerOnCreateAccountFlowUIRequiredDelegates
(
const FString& Param1, |
Interfaces/OnlineExternalUIInterface.h | ||
virtual void TriggerOnExternalUIChangeDelegates
(
bool Param1 |
Interfaces/OnlineExternalUIInterface.h | ||
virtual void TriggerOnLoginFlowUIRequiredDelegates
(
const FString& Param1, |
Interfaces/OnlineExternalUIInterface.h |