Skip to main content
Version: 4.24

Online User 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
OnQueryUserInfoComplete✔Detailsbool bWasSuccessful
const TArray<TSharedRef<const FUniqueNetId>>& UserIds
const FString& ErrorStr

Supported Functions#

FunctionSupported?Unreal Engine DocsParameters
QueryUserInfo✔ 🕔Detailsint32 LocalUserNum
const TArray<TSharedRef<const FUniqueNetId>>& UserIds
GetAllUserInfo✔Detailsint32 LocalUserNum
TArray<TSharedRef<class FOnlineUser>>& OutUsers
GetUserInfo✔Detailsint32 LocalUserNum
const class FUniqueNetId& UserId
QueryUserIdMapping✔ 🕔Detailsconst FUniqueNetId& UserId
const FString& DisplayNameOrEmail
QueryExternalIdMappings✔ 🕔Detailsconst FUniqueNetId& UserId
const FExternalIdQueryOptions& QueryOptions
const TArray<FString>& ExternalIds
GetExternalIdMappings✔Detailsconst FExternalIdQueryOptions& QueryOptions
const TArray<FString>& ExternalIds
TArray<TSharedPtr<const FUniqueNetId>>& OutIds
GetExternalIdMapping✔Detailsconst FExternalIdQueryOptions& QueryOptions
const FString& ExternalId