Slash options

This page covers what goes inside the <name: type> slots of a slash command header: the type words Discord understands, how to describe an option and give it choices, autocomplete, and the bounds only a builder option can set. You're assumed to have a bot named "my-bot" logged in and a slash command header in front of you.

How options work

Every <name: type> in a slash command <path> <arguments>: header is one option. Discord shows it as a typed field in the client and validates it before the interaction ever reaches the bot, so {_name} already holds a real value, a member, a role, a number, never raw text left to parse.

slash command mod ban <target: member> [<reason: string>]:
    description: Ban a member
    trigger:
        reply with hidden "Would ban %{_target}% for %{_reason}%"

<target: member> is required; [<reason: string>] is optional and {_reason} reads none when the user leaves it out. A required option can never follow an optional one, the same rule the header itself enforces (see Slash commands). An option takes exactly one value: there's no plural form, and Discord has no notion of a default, so <name: type = x> isn't valid here the way it is for a discord command.

Option types

The type word decides both the Discord option Skript sends and what {_name} holds back.

The same words also build a typed slash option on a builder, outside a structure's header:

set {_target} to a new typed member option named "target" with description "Who"

Describing options

An arguments: section on the structure describes each option by name: a plain line for a one-line description, or a sub-section when an option also needs choices.

slash command mod ban <target: member> [<reason: string>]:
    description: Ban a member
    arguments:
        target: Who to ban
        reason:
            description: Why
            choices:
                Spam: spam
                Rude: rude
    trigger:
        reply with hidden "Would ban %{_target}% for %{_reason}%"

An option left out of arguments: entirely, or without a description: line, keeps Discord's own placeholder: No description provided. choices: is a section of Name: value lines, up to 25, and only valid on a string, integer or number option; the value on the right must parse as that option's type (a number for integer or number, anything for string). Once an option has choices, Discord only lets the user pick from that list.

Autocomplete

An argument with an on completion request: section instead of choices: is flagged auto-complete: the section runs on every keystroke, and return choices answers it and stops the trigger there, up to 25 suggestions.

slash command fruit <name: string>:
    description: Pick a fruit
    arguments:
        name:
            description: The fruit
            on completion request:
                send "[CMD] completion for %current argument%" to console
                return choices "apple", "banana" and "cherry"
    trigger:
        reply with hidden "You picked %{_name}%"

current argument names the option Discord is asking about (useful once a command has more than one auto-complete option); return choices takes plain texts or numbers, used as both the label and the value, or a new choice named "..." with value ... when they need to differ.

Without an on completion request: section, a typed option (color, player, offlineplayer, or an enum past 25 constants) still autocompletes on its own, from its built-in list. An option can't have both choices: and on completion request: (see Errors below).

A builder-declared option with auto complete set has no structure section to answer it in: the generic on slash completion event plus return choices handles it instead, the same way command builders answer their commands generically.

Reading options anywhere

slash option "name" reads any option by name, structure or builder, wherever a slash interaction is in scope.

on slash command:
    set {_target} to slash option "target"
    send "%used slash command% option target=%{_target}%" to console

slash option only resolves inside on slash command, on slash completion or on slash command cooldown; used elsewhere it's a load error. It works the same whether the command behind it came from a slash command structure or a builder, which is why the generic events see both.

Bounds and channel kinds

A slash command header's <name: type> has no entry for bounds: a numeric range, a text length or a restricted set of channel kinds only exist on a builder option, a new <type> slash option or a new typed ... slash option.

set {_sides} to a new integer option named "sides" with description "How many sides"
set min value of {_sides} to 2
set max value of {_sides} to 100

set channel types of {_opt} to text and voice narrows a channel option the same way declaring it as textchannel does, but lets it accept more than one kind. See Command builders for building and pushing the option itself.

Errors you may see