PICO Unreal Platform SDK
FOnlineLeaderboardPico Class Reference

#include <OnlineLeaderboardInterfacePico.h>

Public Member Functions

virtual bool ReadLeaderboardsForFriends (int32 LocalUserNum, FOnlineLeaderboardReadRef &ReadObject) override
 Gets the entries of a leaderboard. More...
 
virtual bool WriteLeaderboards (const FName &SessionName, const FUniqueNetId &Player, FOnlineLeaderboardWrite &WriteObject) override
 Writes an entry to a leaderboard for the current logged-in user. More...
 
virtual bool FlushLeaderboards (const FName &SessionName) override
 Executes developer-defined functions. More...
 

Detailed Description

IOnlineLeaderboard - Interface class for Leaderboard

Member Function Documentation

◆ FlushLeaderboards()

virtual bool FlushLeaderboards ( const FName &  SessionName)
overridevirtual

Executes developer-defined functions.

Parameters
SessionNameThe parameter of LeaderboardFlushCompleteDelegates.
Returns
Bool:
  • true: success
  • false: failure

◆ ReadLeaderboardsForFriends()

virtual bool ReadLeaderboardsForFriends ( int32  LocalUserNum,
FOnlineLeaderboardReadRef &  ReadObject 
)
overridevirtual

Gets the entries of a leaderboard.

Parameters
PlayersDefines how the entries are returned:
  • If you leave this parameter empty, StartAt will be none, indicating that all entries of the leaderboard will be returned, and the rank starts from top 1 to the last.
  • If you pass the ID of the current logged-in user, StartAt will be CenteredOnViewer, indicating that the current logged-in user's entry will be placed in the middle of the list on the first page.
ReadObjectSet the leaderboard name in it.
Returns
Bool:
  • true: success
  • false: failure

Gets the entries of the friends of the current logged-in user on a leaderboard.

Parameters
LocalUserNumnot used
PicoReadObjectSet the leaderboard name in it.
Returns
Bool:
  • true: success
  • false: failure

◆ WriteLeaderboards()

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

Writes an entry to a leaderboard for the current logged-in user.

Parameters
SessionNamenot used
PlayerThe ID of the current logged-in user to write an entry for.
WriteObjectSet the leaderboard name and the score in it.
Returns
Bool:
  • true: success
  • false: failure