Skip to content

$rawLeaderboard

$rawLeaderboard will return a leaderboard of the given type.

Usage

$rawLeaderboard[variable;order?;type?;custom?;list?;page?;table?]

Parameters

FieldTypeDescriptionRequired
variablestringVariable name.true
typestringVariable type
1. globalUser
2. user
3. server
4. channel
true
orderstringIn which order it will be returned
1. asc (ascending / default)
2. dsc (descending)
true
custom?stringFormatting.false
list?numberHow many to list.false
page?numberWhich page to list.false
table?stringVariable table.false
OptionsReturns
{top}numberReturns the position of the user.
{name}stringReturns the username.
{tag}stringReturns the username and discriminator.
{id}numberReturns the user ID.
{value}numberReturns the variable value.

Example(s)

This will return a leaderboard of the “Example” variable:

1
client.command({
2
name: "rawLeaderboard",
3
code: `
4
$rawLeaderboard[Example;asc;globalUser;{top} - {username} - {value};10;1;main]
5
`
6
});