Syntax

$mentionedRoles

Return Value

• Type : List of snowflakes separated by commas
• Example: 123456789,987654321
• Empty string if no roles are mentioned

Behavior

• $mentionedRoles takes no arguments.
• Detects role mentions formatted as @role-name.
• Only mentionable roles (where the role’s “@mention this role” setting is enabled) are detected.

Examples

Check mentioned roles

$if[$mentionedRoles!=]
  $var[roles;$splitText[$mentionedRoles;,]]
  $var[count;$arrayCount[$var[roles]]]
  $sendMessage[$var[count] role(s) mentioned.]
$else
  $sendMessage[No roles mentioned.]
$endif

Add a mentioned role

$if[$mentionedRoles!=]
  $var[firstRole;$splitText[$mentionedRoles;,;1]]
  $giveRole[$mentioned;$var[firstRole]]
  $sendMessage[Role <@&$var[firstRole]> added to <@$mentioned>!]
$else
  $sendMessage[Mention a role to assign.]
$endif

List mentioned roles

$if[$mentionedRoles!=]
  $var[roles;$splitText[$mentionedRoles;,]]
  $var[i;0]
  $var[total;$arrayCount[$var[roles]]]
  $var[output;]
  $while[$var[i]<$var[total]]
    $var[roleID;$arrayGet[$var[roles];$var[i]]]
    $var[output;$var[output] - <@&$var[roleID]>
]
    $var[i;$sum[$var[i];1]]
  $endwhile
  $sendMessage[Mentioned roles:
$var[output]]
$endif

Notes

• A role must have the “Allow anyone to @mention this role” option enabled to be detected.
• The returned IDs are numeric snowflakes.
• To get the name of a role from its ID, use $roleName[ID].