IOnlineLeaderboards::ReadLeaderboardsAroundUser

Reads stats for a given player in the leaderboard, as well as a range of stats above and below that user.

Windows
MacOS
Linux

References

Module

OnlineSubsystem

Header

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

Include

#include "Interfaces/OnlineLeaderboardInterface.h"

Syntax

bool ReadLeaderboardsAroundUser
(
    FUniqueNetIdRef Player,
    uint32 Range,
    FOnlineLeaderboardReadRef & ReadObject
)

Remarks

Reads stats for a given player in the leaderboard, as well as a range of stats above and below that user. For example, if the player is 100th in the leaderboard and Range = 10, entries for ranks 90-110 will be returned.

Returns

true if the call is successful, false otherwise

Parameters

Parameter

Description

Player

the player for which stats should be returned Range the range above and below the player's rank to return as well

ReadObject

holds the definitions of the tables to read the data from and results are copied into the specified object

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