Components & Interactions
getUserSelectUserID
$getUserSelectUserID
$getUserSelectUserID[] returns one selected user ID of the user select menu that triggered the current interaction.
Syntax
$getUserSelectUserID[index]
Parameters
| Parameter | Description |
|---|---|
index |
Position of the selected user ID, starting at 1. Required: a positive integer, otherwise Selection index must be a positive integer. |
Return Value
- Type: String
- The selected user ID at that position.
- An empty string when
indexis greater than the number of selected items.
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 (
$getUserSelectUserID) the engine refuses the call (Invalid argument count).
Examples
First selection
Selected user: <@$getUserSelectUserID[1]>
Second selection (empty if there is only one)
Second user: <@$getUserSelectUserID[2]>
In an interaction handler
$if[$customID==my_menu]
Selected user: <@$getUserSelectUserID[1]>
$endif
Notes
- The index starts at 1 (0 is an error).
- For all the selections at once, use
$getUserSelectUserIDs[separator;(limit)]. - 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.