Leaderboards

Read more about the Leaderboards system in Hiro here.

Functions #

Get #

Retrieve the leaderboard configuration list for a user. The configuration is personalized for the given user if a personalizer is configured on the system.

1
2
3
4
5
6

userID := "userId"

leaderboardConfigList, err := systems.GetLeaderboardsSystem().Get(ctx, logger, nk, userID)
if err != nil {
  return err
}

Parameters

ParameterTypeDescription
ctxcontext.ContextThe request context.
loggerruntime.LoggerLogger instance.
nkruntime.NakamaModuleNakama module.
userIDstringThe ID of the user to retrieve configuration for.

Returns

ReturnTypeDescription
leaderboardConfigList*hiro.LeaderboardConfigListThe (optionally personalized) leaderboard configuration list.
errerrorNon-nil if an error occurred.