Navigation
API > API/Plugins > API/Plugins/OnlineSubsystem > API/Plugins/OnlineSubsystem/IOnlineLeaderboards
Description
Reads a player's stats and all of that player's friends stats for the specified set of stat views. This allows you to easily compare a player's stats to their friends.
| Name | ReadLeaderboardsForFriends |
| Type | function |
| Header File | /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineLeaderboardInterface.h |
| Include Path | #include "Interfaces/OnlineLeaderboardInterface.h" |
bool ReadLeaderboardsForFriends
(
int32 LocalUserNum,
FOnlineLeaderboardReadRef & ReadObject
)
true if the call is successful, false otherwise
Parameters
| Name | Remarks |
|---|---|
| LocalUserNum | the local player having their stats and friend's stats read for |
| ReadObject | holds the definitions of the tables to read the data from and results are copied into the specified object |