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 > IOnlineLeaderboards::ReadLeaderboardsForFriends

Light Theme

Dark Theme

IOnlineLeaderboards::ReadLeaderboardsForFriends

Reads a player's stats and all of that player's friends stats for the specified set of stat views.

Windows

MacOS

Linux

References

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

Syntax

bool ReadLeaderboardsForFriends
(
int32 LocalUserNum,
FOnlineLeaderboardReadRef & ReadObject
)

Remarks

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.

Returns

true if the call is successful, false otherwise

Parameters

Parameter	Description
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

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

Take our survey

Dismiss