$usersWithRole

The $usersWithRole function returns the list of members who have a specific role on the server.

Syntax

$usersWithRole[roleID;(separator);(guildID)]

Parameters

Parameter	Description
roleID	The ID of the role. Required.
separator	Optional. Separator between the members. Default: , .
guildID	Optional. The ID of the target server.

Return Value

Type	Description
string	List of members having the role (format depends on configuration).

Examples

List admins

$sendMessage[**Administrators:** $usersWithRole[$roleID[Admin]]]

List with line breaks

$sendMessage[
**Members with the VIP role:**
$usersWithRole[$roleID[VIP];
]]

Count members

$sendMessage[There are $length[$usersWithRole[$roleID[Member];,]] members with the Member role.]

Check if a role is empty

$if[$usersWithRole[$roleID[Old]]==]
  $sendMessage[No member has the Old role.]
$endif

Notify admins

$sendMessage[$usersWithRole[$roleID[Admin]] New important alert!]

Notes

• Members are generally returned in the form of mentions.
• The exact format may vary depending on the version of BDFD.
• Useful for targeted announcements or community management.