Arguments

This page covers the argument spec you write in a command's header, the types it accepts, how DiSky resolves each one, and the expressions that read the values back in the trigger. You're assumed to have a declared command and a bot named "my-bot" logged in.

How arguments work

Everything after the command name in discord command <name> <arguments>: is a list of <type> slots. Discord entities (a user, a role, a channel...) are resolved from a mention, an id or a name before the trigger runs, on a worker thread, so arg-1 already holds a real value once your code starts; only the resolution itself can block, never the trigger.

discord command hello <user> [<n: number = 1>]:
    prefixes: "!"
    usage message: "Usage: %usage of event-discordcommand%"
    trigger:
        reply with "Hello %arg-1% x%{_n}%"

A required argument can never come after an optional one: DiSky rejects the whole command at load time (see Errors you may see).

Argument types

Discord entities resolve through DiSky's own lookup; everything else falls back to Skript's parser for that type. A plural argument resolves each token on its own, and a token that fails to resolve is dropped from the list rather than failing the whole command.

Anything else Skript itself parses in command context (number, text, timespan, boolean and the rest) works the same way, through Skript's own parser for that type.

Reading arguments

Inside the trigger, and inside on discord command used / on discord command failed, read an argument by position, by type, or by name if it has one.

discord command entities <role> <textchannel> [<who: member>]:
    prefixes: "!"
    trigger:
        reply with "role=%arg-1% channel=%arg-2% member=%{_who}%"

discord command many <users>:
    prefixes: "!"
    trigger:
        reply with "%size of arguments% users: %arg-1%"

Optional arguments and defaults

A default after = can be a literal (= 1) or a full expression; it's evaluated fresh each time the argument is left out. An optional argument without a default simply reads none instead.

!entities @role #general (no third word) replies with role=... channel=... member=<none>, since {_who} was never set.

Quoting and greedy text

Everything after the command name is split on whitespace into tokens; a double-quoted group ("two words") becomes one token, quotes stripped. A trailing single <text> argument is the exception: being greedy, it takes the untouched rest of the line instead, quotes and extra spaces included.

discord command echo <text>:
    prefixes: "!"
    trigger:
        reply with "you said: %arg-1%"

!echo a b "c" replies you said: a b "c": the double space and the quote marks survive.

When arguments are invalid

Parsing runs last, after every check on who and where (see restricting a command for the full order): a required argument that's missing, or one whose every token fails to resolve, fails with invalid arguments. Set a usage message to reply automatically; without one, DiSky sends nothing and only on discord command failed sees it.

discord command hello <user> [<n: number = 1>]:
    prefixes: "!"
    usage message: "Usage: %usage of event-discordcommand%"
    trigger:
        reply with "Hello %arg-1% x%{_n}%"

!hello alone replies Usage: hello <user> [<n: number>] (the default is left out of the generated form) and fires on discord command failed with failure reason set to invalid arguments.

Errors you may see