Entity Info
channelPosition
$channelPosition
The $channelPosition function returns the position value that Discord reports for a server channel.
Syntax
$channelPosition[(channelID)]
Parameters
| Parameter | Description |
|---|---|
channelID |
Optional. The ID of the target channel. If omitted, the current channel is used. An ID that is not a positive number raises Invalid channel ID., an unknown channel raises Channel not found. |
Return value
| Type | Description |
|---|---|
integer |
The position of the channel as given by Discord. An empty string for a channel that has no position (for example a direct message). |
Examples
Display the position
$sendMessage[This channel is at position $channelPosition]
Compare positions
$if[$channelPosition==0]
$sendMessage[This channel has position 0.]
$else
$sendMessage[This channel is at position #$channelPosition]
$endif
Notes
- The value is the raw Discord
positionof the channel; the engine does not renumber it. - The position can change if an administrator reorganizes the channels.
Try it
Paste an example into the playground to preview its message (functions that act on Discord are not run), or build the same thing with blocks.