Components & Interactions
getUserSelectUserIDs
$getUserSelectUserIDs
$getUserSelectUserIDs[] returns all the user IDs selected in the user select menu that triggered the current interaction, joined by a separator.
Syntax
$getUserSelectUserIDs[separator;(limit)]
Parameters
| Parameter | Description |
|---|---|
separator |
Text inserted between the items. Required, not trimmed; an empty separator concatenates the items without anything between them. |
limit |
Optional. Maximum number of items returned, taken from the first selected. A positive integer, otherwise Selection limit must be a positive integer.; empty or omitted means no limit. |
Return Value
- Type: String
- The selected user IDs, in selection order, joined by
separator. - An empty string when nothing was selected.
Behavior
- It raises
Select values require a component callback.outside of a component interaction (interaction type 3), andThis callback has no userSelect selection.when the interaction that triggered the script is not a user select menu. - The IDs are those of the users picked in the menu.
- The number of selected items is returned by
$getUserSelectUserCount. - Without brackets (
$getUserSelectUserIDs) the engine refuses the call (Invalid argument count).
Examples
All selections
Users: $getUserSelectUserIDs[, ]
Limit the number of items
First two IDs: $getUserSelectUserIDs[, ;2]
In an interaction handler
$if[$customID==my_menu]
Users: $getUserSelectUserIDs[, ]
$endif
Notes
- For a single value, use
$getUserSelectUserID[index]. - With a menu that allows one selection only, the list contains at most one item.
- The menu is created with
$addUserSelect.
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.