Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > OnlineSubsystem > Interfaces > IOnlineLeaderboards

Light Theme

Dark Theme

IOnlineLeaderboards

Interface definition for the online services leaderboard services

Windows

MacOS

Linux

References

Module	OnlineSubsystem
Header	/Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineLeaderboardInterface.h
Include	#include "Interfaces/OnlineLeaderboardInterface.h"

Syntax

class IOnlineLeaderboards

Remarks

Interface definition for the online services leaderboard services

Variables

		Name	Description
	FOnLeaderboardF...	OnLeaderboardFlushCompleteDelegates	Delegate called when the stats flush operation has completed
	FOnLeaderboardR...	OnLeaderboardReadCompleteDelegates	Notifies the interested party that the last stats read has completed

Constructors

	Name	Description
	IOnlineLeaderboards()

Destructors

	Name	Description
	~IOnlineLeaderboards()

Functions

	Name	Description
FDelegateHan...	AddOnLeaderboardFlushCompleteDelegate_Handle ( const FOnLeaderboardFlushCompleteDe... )
FDelegateHan...	AddOnLeaderboardReadCompleteDelegate_Handle ( const FOnLeaderboardReadCompleteDel... )
void	ClearOnLeaderboardFlushCompleteDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnLeaderboardFlushCompleteDelegates ( void* Object )
void	ClearOnLeaderboardReadCompleteDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnLeaderboardReadCompleteDelegates ( void* Object )
bool	FlushLeaderboards ( const FName& SessionName )	Commits any changes in the online stats cache to the permanent storage
void	FreeStats ( FOnlineLeaderboardRead& ReadObject )	Cleans up any platform specific allocated data contained in the stats data
bool	ReadLeaderboards ( const TArray< FUniqueNetIdRef >& P..., FOnlineLeaderboardReadRef& ReadObj... )	Reads a set of stats for the specified list of players
bool	ReadLeaderboardsAroundRank ( int32 Rank, uint32 Range, FOnlineLeaderboardReadRef& ReadObj... )	Reads stats for a given rank in the leaderboard, as well as a range of stats above and below that rank.
bool	ReadLeaderboardsAroundUser ( FUniqueNetIdRef Player, uint32 Range, FOnlineLeaderboardReadRef& ReadObj... )	Reads stats for a given player in the leaderboard, as well as a range of stats above and below that user.
bool	ReadLeaderboardsForFriends ( int32 LocalUserNum, FOnlineLeaderboardReadRef& ReadObj... )	Reads a player's stats and all of that player's friends stats for the specified set of stat views.
void	TriggerOnLeaderboardFlushCompleteDelegates ( const FName& Param1, bool Param2 )
void	TriggerOnLeaderboardReadCompleteDelegates ( bool Param1 )
bool	WriteLeaderboards ( const FName& SessionName, const FUniqueNetId& Player, FOnlineLeaderboardWrite& WriteObje... )	Writes out the stats contained within the stats write object to the online subsystem's cache of stats data.
bool	WriteOnlinePlayerRatings ( const FName& SessionName, int32 LeaderboardId, const TArray< FOnlinePlayerScore > ... )	Writes the score data for the match, used for rankings/ratings

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

Take our survey

Dismiss