Syntax

$mentionedChannels[index;(returnCurrent)]

Parameters

Parameter	Description
index	Required. Position of the mention: a positive integer (1 is the first), < for the first, > for the last. Any other value (including 0, a negative number or text) raises Mention index must be positive, < or >.
returnCurrent	Optional (yes/no, true/false). If no channel is mentioned at this position, return the ID of the current channel instead. Defaults to no. Any other value raises Mention fallback must be yes or no. The value is trimmed and case-insensitive. The current channel ID is taken from the channel.id context variable.

Return Value

• Type : Snowflake (numeric string) or empty string
• ID of the channel mentioned at the requested position
• Empty string if there is no such mention (or the current channel ID when returnCurrent is yes)

Behavior

• $mentionedChannels requires at least one argument: a bare $mentionedChannels is invalid.
• Reads the channel mentions of the message; it raises the error Use message options for slash commands. in a slash command (use the command options instead).
• The mentions are read from the message.channelMentions context variable supplied by the host (a comma-separated list of channel IDs).
• Returns a single ID per call; call it with several indexes to read several channels.

Examples

Check mentioned channels

$if[$mentionedChannels[1]!=]
  $sendMessage[At least one channel is mentioned.]
$else
  $sendMessage[No channels mentioned in this message.]
$endif

Act on the first mentioned channel

$if[$mentionedChannels[1]!=]
  $sendMessage[First channel mentioned: <#$mentionedChannels[1]>]
$endif

Last mentioned channel

$if[$mentionedChannels[>]!=]
  $sendMessage[Last channel mentioned: <#$mentionedChannels[>]>]
$endif

Notes

• To get the name of a channel from its ID, use $channelName[ID].