Syntax

$getRole[(userID);(index);(guildID)]

Parameters

Parameter	Description
userID	Optional. The ID of the user. Defaults to the author of the command (also when empty).
index	Optional. The position of the role (1 = highest, 2 = second…). Defaults to 1; a non-numeric value is also treated as 1.
guildID	Optional. Accepted but ignored: roles are always read in the current server.

Return Value

Type	Description
snowflake (string)	The ID of the role at the given position, or "" if the index is less than 1 or beyond the number of roles of the user. An error is raised if the user ID is invalid.

Examples

Highest role

$sendMessage[Your highest role: $roleName[$getRole[$authorID;1]]]

Check if admin

$if[$getRole[$authorID;1]==$roleID[Admin]]
  $sendMessage[You are an administrator!]
$else
  $sendMessage[You are not an administrator.]
$endif

Secondary role

$sendMessage[Your second role: $roleName[$getRole[$authorID;2]]]

Color of the main role

$title[Profile]
$description[Color of your main role]
$color[$getRoleColor[$getRole[$authorID;1]]]

Role of another user

$sendMessage[Main role of <@$mentioned[1]>: $roleName[$getRole[$mentioned[1];1]]]

Notes

• The index starts at 1 (not 0).
• The roles are ordered by server hierarchy (not in the order stored by Discord). If the user has no roles (only @everyone), $getRole returns an empty string.
• To list the names of all roles of a user, use $userRoles[userID].