Logo
Bot Creator
Français Download
Logo
Bot Creator
Variables getLeaderboardValue

$getLeaderboardValue[]

Returns the value (score, points, etc.) associated with the current position in the active leaderboard.

Syntax
$getLeaderboardValue

$getLeaderboardValue

The function $getLeaderboardValue returns the value associated with the current position in the active leaderboard. This can be a score, a number of coins, XP points, or any other variable the ranking is based on.

This function only makes sense in the context of iterating through a leaderboard — that is, after calling $globalUserLeaderboard, $serverLeaderboard or $userLeaderboard and while iterating through their results with $textSplit.

How It Works

When iterating through a leaderboard, each entry contains an identifier (user) and a value (the score). $getLeaderboardValue exposes this value for the entry currently being processed.

The returned value corresponds to the internal variable ((leaderboard.value)) which is resolved at runtime by the dedicated leaderboard action.

Use Cases

  • Display each player’s score in a ranking
  • Compare values between different positions
  • Trigger rewards based on the score reached
  • Format congratulation messages with the score

Important

  • $getLeaderboardValue returns nothing outside the context of an active leaderboard.
  • The function takes no parameters.
  • It is almost always used with $getLeaderboardPosition for a complete display (rank + value).
  • The returned value depends on the variable the leaderboard was built on (for example, if the leaderboard is based on coins, the value will be the number of coins).

See Also