IOnlineExternalUI::ShowLoginUI

Displays the UI that prompts the user for their login credentials.

Windows
MacOS
Linux

References

Module

OnlineSubsystem

Header

/Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineExternalUIInterface.h

Include

#include "Interfaces/OnlineExternalUIInterface.h"

Syntax

bool ShowLoginUI
(
    const int ControllerIndex,
    bool bShowOnlineOnly,
    bool bShowSkipButton,
    const FOnLoginUIClosedDelegate & Delegate
)

Remarks

Displays the UI that prompts the user for their login credentials. Each platform handles the authentication of the user's data.

Returns

true if it was able to show the UI, false if it failed

Parameters

Parameter

Description

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.

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