$userLeaderBoard
$userLeaderBoard
will return a leaderboard of a user variable.
Usage
$userLeaderBoard[guildID;variable;order?;custom?;list?;page?;table?]
Parameters
Field | Type | Description | Required |
---|---|---|---|
guildID | number | Guild ID. | true |
variable | string | Variable name. | true |
type? | string | In which order it will be returned 1. asc (ascending / default) 2. dsc (descending) | false |
custom? | string | Formatting. | false |
list? | number | How many to list. | false |
page? | number | Which page to list. | false |
table? | string | Variable table. | false |
Options | Returns | |
---|---|---|
{top} | number | Returns the position of the user. |
{username} | string | Returns the username. |
{tag} | string | Returns the username and discriminator. |
{id} | number | Returns the user ID. |
{value} | number | Returns the variable value. |
Example(s)
This will returns a leaderboard of the “Example” variable:
1client.command({2 name: "userLeaderBoard",3 code: `4 $userLeaderBoard[$guildID;Example;asc;{top} - {username} - {value};10;1;main]5 `6});