Entity Info
lowestRole
$lowestRole
The function $lowestRole returns the ID of the lowest role in the role hierarchy. Without argument it looks at all the roles of the server; with a user ID it looks at the roles of that member. The @everyone role is not excluded: it is always last in the ordering, so it is the role returned.
Syntax
$lowestRole[(userID)]
Parameters
| Parameter | Description |
|---|---|
userID |
(Optional) The ID of a member. A value that is not a positive integer raises Invalid user ID. If omitted, all roles of the server are considered. |
Return Value
- Type : Snowflake (numeric string)
- The ID of the last role in the hierarchy. Because
@everyonealways sorts last and is always among the candidates, this is the ID of@everyone(which is the ID of the server) whenever Discord returns that role. - An empty string if there is no candidate role.
Behavior
- Roles are sorted by their Discord position, highest first;
@everyoneis always last.$lowestRoletakes the last one of the sorted list. - To exclude
@everyoneyou have to compare the result with$guildID.
Examples
Show the role hierarchy
$title[Role Hierarchy]
$description[
**User:** $userName
**Highest Role:** $roleName[$highestRole[$authorID]]
**Lowest Role:** $roleName[$lowestRole[$authorID]]
]
$color[#5865F2]
Check the lowest role
$sendMessage[Your lowest role is: $roleName[$lowestRole[$authorID]] (ID: $lowestRole[$authorID])]
Notes
$lowestRoledoes not exclude the@everyonerole.- To retrieve a role with specific permissions, use
$lowestRoleWithPerms[].
Try it
Paste an example into the playground to preview its message (functions that act on Discord are not run), or build the same thing with blocks.