Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > OnlineSubsystem > Interfaces > IOnlineExternalUI

Light Theme

Dark Theme

IOnlineExternalUI

Interface definition for the online services external UIs Any online service that provides extra UI overlays will implement the relevant functions

Windows

MacOS

Linux

References

Module	OnlineSubsystem
Header	/Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineExternalUIInterface.h
Include	#include "Interfaces/OnlineExternalUIInterface.h"

Syntax

class IOnlineExternalUI

Remarks

Interface definition for the online services external UIs Any online service that provides extra UI overlays will implement the relevant functions

Variables

	Name	Description
FOnCreateAccoun...	OnCreateAccountFlowUIRequiredDelegates	Delegate called when the online subsystem requires an external UI to handle account creation
FOnExternalUICh...	OnExternalUIChangeDelegates	Delegate called when the external UI is opened or closed
FOnLoginFlowUIR...	OnLoginFlowUIRequiredDelegates	Delegate called when the online subsystem requires an external UI to handle login flow

Constructors

	Name	Description
	IOnlineExternalUI()

Destructors

	Name	Description
	~IOnlineExternalUI()

Functions

	Name	Description
FDelegateHan...	AddOnCreateAccountFlowUIRequiredDelegate_Handle ( const FOnCreateAccountFlowUIRequire... )
FDelegateHan...	AddOnExternalUIChangeDelegate_Handle ( const FOnExternalUIChangeDelegate&... )
FDelegateHan...	AddOnLoginFlowUIRequiredDelegate_Handle ( const FOnLoginFlowUIRequiredDelegat... )
void	ClearOnCreateAccountFlowUIRequiredDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnCreateAccountFlowUIRequiredDelegates ( void* Object )
void	ClearOnExternalUIChangeDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnExternalUIChangeDelegates ( void* Object )
void	ClearOnLoginFlowUIRequiredDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnLoginFlowUIRequiredDelegates ( void* Object )
bool	CloseWebURL()	Closes the currently active web external UI
void	ReportEnterInGameStoreUI()	Tell the system that you've entered into a screen considered in-game store.
void	ReportExitInGameStoreUI()	Tell the system that you've entered into a screen considered in-game store.
bool	ShowAccountCreationUI ( const int ControllerIndex, const FOnAccountCreationUIClosedDel... )	Displays the UI that prompts the user to create an account
bool	ShowAccountUpgradeUI ( const FUniqueNetId& UniqueId )	Displays a system dialog to purchase user account upgrades.
bool	ShowAchievementsUI ( int32 LocalUserNum )	Displays the UI that shows a user's list of achievements
bool	ShowFriendsUI ( int32 LocalUserNum )	Displays the UI that shows a user's list of friends
bool	ShowInviteUI ( int32 LocalUserNum, FName SessionName )	Displays the UI that shows a user's list of friends to invite
bool	ShowLeaderboardUI ( const FString& LeaderboardName )	Displays the UI that shows a specific leaderboard
bool	ShowLoginUI ( const int ControllerIndex, bool bShowOnlineOnly, bool bShowSkipButton, const FOnLoginUIClosedDelegate& De... )	Displays the UI that prompts the user for their login credentials.
bool	ShowPlatformMessageBox ( const FUniqueNetId& UserId, EPlatformMessageType MessageType )	Displays an informational system dialog.
bool	ShowProfileUI ( const FUniqueNetId& Requestor, const FUniqueNetId& Requestee, const FOnProfileUIClosedDelegate& ... )	Displays a user's profile card.
bool	ShowSendMessageToUserUI ( int32 LocalUserNum, const FUniqueNetId& Recipient, const FShowSendMessageParams& Show..., const FOnShowSendMessageUIClosedDel... )	Display the platform UI for sending a mailbox message to the specified user.
bool	ShowSendMessageUI ( int32 LocalUserNum, const FShowSendMessageParams& Show..., const FOnShowSendMessageUIClosedDel... )	Display the platform UI for sending a mailbox message to another user
bool	ShowStoreUI ( int32 LocalUserNum, const FShowStoreParams& ShowParams, const FOnShowStoreUIClosedDelegate ... )	Display the platform UI for browsing available products for purchase
bool	ShowWebURL ( const FString& Url, const FShowWebUrlParams& ShowParam..., const FOnShowWebUrlClosedDelegate&... )	Displays a web page in the external UI
void	TriggerOnCreateAccountFlowUIRequiredDelegates ( const FString& Param1, const FOnLoginRedirectURL& Param2, const FOnLoginFlowComplete& Param3, bool& Param4 )
void	TriggerOnExternalUIChangeDelegates ( bool Param1 )
void	TriggerOnLoginFlowUIRequiredDelegates ( const FString& Param1, const FOnLoginRedirectURL& Param2, const FOnLoginFlowComplete& Param3, bool& Param4 )

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss