1. Epic GamesDeveloper
  3. IOnlineLeaderboards

IOnlineLeaderboards

Interface definition for the online services leaderboard services

API > API/Plugins > API/Plugins/OnlineSubsystem > API/Plugins/OnlineSubsystem/Interfaces

References

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

Syntax

class IOnlineLeaderboards

Remarks

Interface definition for the online services leaderboard services

Variables

  Type Name Description
Public variable FOnLeaderboardFlushComplete OnLeaderboardFlushCompleteDelegates Delegate called when the stats flush operation has completed
Public variable FOnLeaderboardReadComplete OnLeaderboardReadCompleteDelegates Notifies the interested party that the last stats read has completed

Constructors

  Type Name Description
Protected function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function bool

FlushLeaderboards ( const FName& SessionName
)

 Commits any changes in the online stats cache to the permanent storage
Public function void Cleans up any platform specific allocated data contained in the stats data
Public function bool

ReadLeaderboards ( const TArray< FUniqueNetIdRef >& Players,
FOnlineLeaderboardReadRef& ReadObject
)

 Reads a set of stats for the specified list of players
Public function bool

ReadLeaderboardsAroundRank ( int32 Rank,
uint32 Range,
FOnlineLeaderboardReadRef& ReadObject
)

 Reads stats for a given rank in the leaderboard, as well as a range of stats above and below that rank.
Public function bool

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

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

ReadLeaderboardsForFriends ( int32 LocalUserNum,
FOnlineLeaderboardReadRef& ReadObject
)

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

TriggerOnLeaderboardFlushCompleteDelegates ( const FName& Param1,
bool Param2
)

  
Public function Virtual void  
Public function bool

WriteLeaderboards ( const FName& SessionName,
const FUniqueNetId& Player,
FOnlineLeaderboardWrite& WriteObject
)

 Writes out the stats contained within the stats write object to the online subsystem's cache of stats data.
Public function bool

WriteOnlinePlayerRatings ( const FName& SessionName,
int32 LeaderboardId,
const TArray< FOnlinePlayerScore >& PlayerScores
)

 Writes the score data for the match, used for rankings/ratings

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page