CommandArg

open class CommandArg(val name: String = "Command", val description: String = internalLocale.commandArgDescription) : StringArgument<Command>

Accepts a DiscordKt command by name.

Constructors

constructor(name: String = "Command", description: String = internalLocale.commandArgDescription)

Accepts a DiscordKt command by name.

open override val description: String

A description of the data that this type represents.

open override val name: String

The display name for this type in documentations and examples.

Offer autocomplete options for this argument.

open suspend override fun generateExamples(context: DiscordContext): List<String>

A function called whenever an example of this type is needed.

Utility function to check that this Argument is an OptionalArg.

Accept multiple inputs of this Argument.

Make this argument optional and fall back to the default value if the conversion fails.

Make this argument optional and fall back to the default value if the conversion fails. Exposes a CommandEvent.

Make this argument optional and fall back to the default value if the conversion fails.

Make this argument optional and fall back to the default value if the conversion fails. Exposes a CommandEvent.

open suspend override fun parse(args: MutableList<String>, discord: Discord): String?

Parse string input into the correct type handled by this argument.

open suspend override fun transform(input: String, context: DiscordContext): Result<Command>

Transforms a value produced by a slash command or by the parse function.