Syntax

$rolePosition[roleID]

Parameters

Parameter	Description
roleID	The ID of the role in the current server. Required. An invalid ID raises “Invalid role ID.”; an unknown role raises “Role not found.”.

Return Value

Type	Description
integer	The rank of the role in the hierarchy (1 = highest role, @everyone is always last).

Examples

Display the position

$sendMessage[Position of the Admin role: $rolePosition[$roleID[Admin]]]

Compare two roles

$if[$rolePosition[$roleID[Admin]]<$rolePosition[$roleID[Mod]]]
  $sendMessage[The Admin role is hierarchically superior to Mod.]
$else
  $sendMessage[Mod is superior or equal to Admin.]
$endif

Check if one role can manage another

$if[$rolePosition[$getRole[$authorID;1]]<$rolePosition[$roleID[Target]]]
  $sendMessage[Your role is superior.]
$else
  $sendMessage[You cannot act because your role is inferior or equal.]
$endif

Get the highest role

$sendMessage[Highest role of the server: $roleName[$highestRole]]

Notes

• The position is the rank in the hierarchy (a smaller number means a higher role); @everyone always has the largest number.
• Ranks are unique: if two roles have the same Discord position, the older role (smaller ID) ranks higher.