Pico Unreal Platform SDK
BP_Leaderboard

Functions

static bool ReadLeaderboards (UObject *WorldContextObject, const TArray< FString > &Players, UPARAM(ref) FPicoOnlineLeaderboardRead &PicoReadObject, FPicoManagerOnReadLeaderboardsCompleteDelegate OnReadLeaderboardsCompleteDelegate)
 Get entries of a leaderboard. More...
 
static bool ReadLeaderboardsForFriends (UObject *WorldContextObject, int32 LocalUserNum, UPARAM(ref) FPicoOnlineLeaderboardRead &PicoReadObject, FPicoManagerOnReadLeaderboardsCompleteDelegate OnReadLeaderboardsCompleteDelegate)
 Get entries of a leaderboard. More...
 
static bool WriteLeaderboards (UObject *WorldContextObject, const FString &SessionName, const FString &Player, UPARAM(ref) FPicoOnlineLeaderboardWrite &PicoWriteObject)
 Writes a entry of a leaderboard. More...
 

Detailed Description

This is the BP_Leaderboard group

Function Documentation

◆ ReadLeaderboards()

bool ReadLeaderboards ( UObject *  WorldContextObject,
const TArray< FString > &  Players,
UPARAM(ref) FPicoOnlineLeaderboardRead &  PicoReadObject,
FPicoManagerOnReadLeaderboardsCompleteDelegate  OnReadLeaderboardsCompleteDelegate 
)
static

Get entries of a leaderboard.

Parameters
WorldContextObjectUsed to get the information about the current world.
PlayersIf the num of Players is bigger than zero, and the only Player in it is the logged in Player, then the value of StartAt will be ppfLeaderboard_StartAtCenteredOnViewer.
PicoReadObjectSet leaderboard name in it.
OnReadLeaderboardsCompleteDelegateExecutes this parameter after the request has been done.
Returns
Bool:
  • true: success
  • false: failure

◆ ReadLeaderboardsForFriends()

bool ReadLeaderboardsForFriends ( UObject *  WorldContextObject,
int32  LocalUserNum,
UPARAM(ref) FPicoOnlineLeaderboardRead &  PicoReadObject,
FPicoManagerOnReadLeaderboardsCompleteDelegate  OnReadLeaderboardsCompleteDelegate 
)
static

Get entries of a leaderboard.

Parameters
WorldContextObjectUsed to get the information about the current world.
LocalUserNumNot used.
PicoReadObjectSet leaderboard name in it.
OnReadLeaderboardsCompleteDelegateExecutes this parameter after the request has been done.
Returns
Bool:
  • true: success
  • false: failure

◆ WriteLeaderboards()

bool WriteLeaderboards ( UObject *  WorldContextObject,
const FString &  SessionName,
const FString &  Player,
UPARAM(ref) FPicoOnlineLeaderboardWrite &  PicoWriteObject 
)
static

Writes a entry of a leaderboard.

Parameters
WorldContextObjectUsed to get the information about the current world.
SessionNameNot used.
PlayerNeed to be the logged-in player.
PicoWriteObjectSet leaderboard name and the score in it.
Returns
Bool:
  • true: success
  • false: failure