BotFrame

Server actions · Workflow node

Find roles

The Find roles node as it appears in the workflow editor.

What it does

Find server roles by exact ID or name.

When the workflow reaches this node, BotFrame uses the current server details and any connected IDs to perform the Discord action. The resulting Matching roles, Match count, Only match can be connected to later nodes.

Typical use

Find a role by its exact name or ID and connect it to a role-management node.

How to use it

  1. Add it from Server actionsOpen the node library and choose Find roles from Server actions.
  2. Connect the workflow pathConnect Flow in from the previous step and Flow to the next step.
  3. Choose settings and connect valuesSet Entity, Mode, Value. Connections can also supply values produced by earlier nodes.

Settings

These are the options shown when you add this node. A connected value can replace a setting when the workflow runs.

SettingStarting valueWhat it controls
EntityroleChooses whether this node searches for a role.
ModenameChooses whether to find the role by name or ID.
ValueEmptyUsed when ID or name is not connected from an earlier node.

Value connections

Value connections pass information between nodes without changing the order of the workflow. When an input is not connected, BotFrame uses the value selected in the node or details from the starting Discord event when available.

Inputs

Guild IDServer · Defaults to the current server
Optional
ID or nameText
Required

Outputs

Matching rolesList
Optional
Match countNumber
Optional
Only matchRole
Optional

What happens when it runs

When the workflow reaches this node, BotFrame uses the current server details and any connected IDs to perform the Discord action. The resulting Matching roles, Match count, Only match can be connected to later nodes.

You can use this item in a published BotFrame workflow. You can also test it in the simulator.

These details match the node currently available in the BotFrame workflow editor.