Navigation
API > API/Plugins > API/Plugins/OnlineSubsystem > API/Plugins/OnlineSubsystem/IOnlineLeaderboards
Description
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.
| Name | ReadLeaderboardsAroundUser |
| Type | function |
| Header File | /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineLeaderboardInterface.h |
| Include Path | #include "Interfaces/OnlineLeaderboardInterface.h" |
bool ReadLeaderboardsAroundUser
(
FUniqueNetIdRef Player,
uint32 Range,
FOnlineLeaderboardReadRef & ReadObject
)
true if the call is successful, false otherwise
Parameters
| Name | Remarks |
|---|---|
| Player | the player for which stats should be returned @Param 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 |