Navigation
API > API/Plugins > API/Plugins/OnlineSubsystem
Interface definition for the online services leaderboard services
| Name | IOnlineLeaderboards |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineLeaderboardInterface.h |
| Include Path | #include "Interfaces/OnlineLeaderboardInterface.h" |
Syntax
class IOnlineLeaderboards
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
IOnlineLeaderboards() |
Interfaces/OnlineLeaderboardInterface.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IOnlineLeaderboards() |
Interfaces/OnlineLeaderboardInterface.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnLeaderboardFlushCompleteDelegates | FOnLeaderboardFlushComplete | Delegate called when the stats flush operation has completed | Interfaces/OnlineLeaderboardInterface.h | |
| OnLeaderboardReadCompleteDelegates | FOnLeaderboardReadComplete | Notifies the interested party that the last stats read has completed | Interfaces/OnlineLeaderboardInterface.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FDelegateHandle AddOnLeaderboardFlushCompleteDelegate_Handle
(
const FOnLeaderboardFlushCompleteDelegate& Delegate |
Interfaces/OnlineLeaderboardInterface.h | ||
virtual FDelegateHandle AddOnLeaderboardReadCompleteDelegate_Handle
(
const FOnLeaderboardReadCompleteDelegate& Delegate |
Interfaces/OnlineLeaderboardInterface.h | ||
virtual void ClearOnLeaderboardFlushCompleteDelegate_Handle
(
FDelegateHandle& Handle |
Interfaces/OnlineLeaderboardInterface.h | ||
virtual void ClearOnLeaderboardFlushCompleteDelegates
(
FDelegateUserObject Object |
Interfaces/OnlineLeaderboardInterface.h | ||
virtual void ClearOnLeaderboardReadCompleteDelegate_Handle
(
FDelegateHandle& Handle |
Interfaces/OnlineLeaderboardInterface.h | ||
virtual void ClearOnLeaderboardReadCompleteDelegates
(
FDelegateUserObject Object |
Interfaces/OnlineLeaderboardInterface.h | ||
bool FlushLeaderboards
(
const FName& SessionName |
Commits any changes in the online stats cache to the permanent storage | Interfaces/OnlineLeaderboardInterface.h | |
void FreeStats
(
FOnlineLeaderboardRead& ReadObject |
Cleans up any platform specific allocated data contained in the stats data | Interfaces/OnlineLeaderboardInterface.h | |
bool ReadLeaderboards
(
const TArray< FUniqueNetIdRef >& Players, |
Reads a set of stats for the specified list of players | Interfaces/OnlineLeaderboardInterface.h | |
bool ReadLeaderboardsAroundRank
(
int32 Rank, |
Reads stats for a given rank in the leaderboard, as well as a range of stats above and below that rank. | Interfaces/OnlineLeaderboardInterface.h | |
bool ReadLeaderboardsAroundUser
(
FUniqueNetIdRef Player, |
Reads stats for a given player in the leaderboard, as well as a range of stats above and below that user. | Interfaces/OnlineLeaderboardInterface.h | |
bool ReadLeaderboardsForFriends
(
int32 LocalUserNum, |
Reads a player's stats and all of that player's friends stats for the specified set of stat views. | Interfaces/OnlineLeaderboardInterface.h | |
virtual void TriggerOnLeaderboardFlushCompleteDelegates
(
const FName& Param1, |
Interfaces/OnlineLeaderboardInterface.h | ||
virtual void TriggerOnLeaderboardReadCompleteDelegates
(
bool Param1 |
Interfaces/OnlineLeaderboardInterface.h | ||
bool WriteLeaderboards
(
const FName& SessionName, |
Writes out the stats contained within the stats write object to the online subsystem's cache of stats data. | Interfaces/OnlineLeaderboardInterface.h | |
bool WriteOnlinePlayerRatings
(
const FName& SessionName, |
Writes the score data for the match, used for rankings/ratings | Interfaces/OnlineLeaderboardInterface.h |