Skip to main content
Version: 4.24

Online Leaderboards 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
OnLeaderboardReadComplete✔Detailsbool bWasSuccessful
OnLeaderboardFlushComplete✔Detailsconst FName& SessionName
bool bWasSuccessful

Supported Functions#

FunctionSupported?Unreal Engine DocsParameters
ReadLeaderboards✔ 🕔Detailsconst TArray<TSharedRef<const FUniqueNetId>>& Players
FOnlineLeaderboardReadRef& ReadObject
ReadLeaderboardsForFriends✔ 🕔Detailsint32 LocalUserNum
FOnlineLeaderboardReadRef& ReadObject
ReadLeaderboardsAroundRank✔ 🕔Detailsint32 Rank
uint32 Range
FOnlineLeaderboardReadRef& ReadObject
ReadLeaderboardsAroundUser✔ 🕔DetailsTSharedRef<const FUniqueNetId> Player
uint32 Range
FOnlineLeaderboardReadRef& ReadObject
FreeStats✔DetailsFOnlineLeaderboardRead& ReadObject
WriteLeaderboards✔Detailsconst FName& SessionName
const FUniqueNetId& Player
FOnlineLeaderboardWrite& WriteObject
FlushLeaderboards✔Detailsconst FName& SessionName