Skip to content

$hoistedRole

$hoistedRole will return the highest hoisted role of an user.

Usage

$hoistedRole[userID?;guildID?;option?]

Parameters

FieldTypeDescriptionRequired
userID?numberThe ID of the user.false
guildID?numberthe ID of the guild.false
option?stringThe option how to return the role
1. name
2. id (default)
3. mention
false

Example(s)

This will return the name of your highest hoisted role:

1
client.command({
2
name: "hoistedRole",
3
code: `
4
$hoistedRole[$authorID;$guildID;name]
5
`
6
});