Skip to main content
Version: 4.24

Online ExternalUI Subsystem

This API reference documents what methods and events are supported by Online Subsystem Blueprints. For full documentation on this API, refer to the Unreal Engine documentation.

Need to use a method or event that's not currently supported? Please reach out to support.

Supported Events#

EventSupported?Unreal Engine DocsParameters
OnExternalUIChange✔Detailsbool 
OnLoginFlowUIRequired Detailsconst FString& RequestedURL
const FOnLoginRedirectURL& OnRedirectURL
const FOnLoginFlowComplete& OnLoginFlowComplete
bool& bOutShouldContinueLogin
OnCreateAccountFlowUIRequired Detailsconst FString& RequestedURL
const FOnLoginRedirectURL& OnRedirectURL
const FOnLoginFlowComplete& OnLoginFlowComplete
bool& bOutShouldContinueLogin

Supported Functions#

FunctionSupported?Unreal Engine DocsParameters
ShowLoginUI✔ 🕔Detailsconst int ControllerIndex
bool bShowOnlineOnly
bool bShowSkipButton
ShowAccountCreationUI✔ 🕔Detailsconst int ControllerIndex
ShowFriendsUI✔Detailsint32 LocalUserNum
ShowInviteUI✔Detailsint32 LocalUserNum
FName SessionName
ShowAchievementsUI✔Detailsint32 LocalUserNum
ShowLeaderboardUI✔Detailsconst FString& LeaderboardName
ShowWebURL✔ 🕔Detailsconst FString& Url
const FShowWebUrlParams& ShowParams
CloseWebURL✔Details
ShowProfileUI✔ 🕔Detailsconst FUniqueNetId& Requestor
const FUniqueNetId& Requestee
ShowAccountUpgradeUI✔Detailsconst FUniqueNetId& UniqueId
ShowStoreUI✔ 🕔Detailsint32 LocalUserNum
const FShowStoreParams& ShowParams
ShowSendMessageUI✔ 🕔Detailsint32 LocalUserNum
const FShowSendMessageParams& ShowParams
ShowPlatformMessageBox✔Detailsconst FUniqueNetId& UserId
EPlatformMessageType MessageType
ReportEnterInGameStoreUI✔Details
ReportExitInGameStoreUI✔Details