OptionalArg

class OptionalArg<I, O, O2>(val name: String, val type: Argument<I, O>, default: suspend DiscordContext.() -> O2) : WrappedArgument<I, O, I, O2>

An optional argument with a default value.

Constructors

constructor(name: String, type: Argument<I, O>, default: suspend DiscordContext.() -> O2)

open override val description: String

A description of the data that this type represents.

Get the innermost/raw type inside this argument.

open override val name: String

The display name for this type in documentations and examples.

open override val type: Argument<I, O>

The Argument that is wrapped.

Perform a nested search on this wrapped argument to check for a certain type.

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.

open fun optional(default: O2): OptionalArg<I, O2, O2>

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

open fun optional(default: suspend (DiscordContext) -> O2): OptionalArg<I, O2, O2>

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): I?

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

open suspend override fun transform(input: I, context: DiscordContext): Result<O2>

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