Skip to content

$userLeaderBoard

$userLeaderBoard will return a leaderboard of a user variable.

Usage

$userLeaderBoard[guildID;variable;order?;custom?;list?;page?;table?]

Parameters

FieldTypeDescriptionRequired
guildIDnumberGuild ID.true
variablestringVariable name.true
type?stringIn which order it will be returned
1. asc (ascending / default)
2. desc (descending)
false
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.
{username}stringReturns the username.
{tag}stringReturns the username and discriminator.
{id}numberReturns the user ID.
{value}numberReturns the variable value.

Example(s)

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

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