Navigation
API > API/Plugins > API/Plugins/OnlineSubsystem > API/Plugins/OnlineSubsystem/IOnlineExternalUI
Description
Displays the UI that prompts the user for their login credentials. Each platform handles the authentication of the user's data.
| Name | ShowLoginUI |
| Type | function |
| Header File | /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineExternalUIInterface.h |
| Include Path | #include "Interfaces/OnlineExternalUIInterface.h" |
bool ShowLoginUI
(
const int ControllerIndex,
bool bShowOnlineOnly,
bool bShowSkipButton,
const FOnLoginUIClosedDelegate & Delegate
)
true if it was able to show the UI, false if it failed
Parameters
| Name | Remarks |
|---|---|
| ControllerIndex | The controller that prompted showing the login UI. If the platform supports it, it will pair the signed-in user with this controller. |
| bShowOnlineOnly | whether to only display online enabled profiles or not |
| bShowSkipButton | On platforms that support it, display the "Skip" button |
| Delegate | The delegate to execute when the user closes the login UI. |