MultipleArg

class MultipleArg<Input, Output>(    val type: Argument<Input, Output>,     val name: String = type.name,     description: String = "") : WrappedArgument<Input, Output, List<Input>, List<Output>>

Accepts multiple arguments of the given type. Returns a list.

Parameters

type

The Argument that you expect to be used to create the list.

Constructors

Link copied to clipboard
fun <Input, Output> MultipleArg(    type: Argument<Input, Output>,     name: String = type.name,     description: String = "")

Functions

Link copied to clipboard
open suspend override fun generateExamples(context: DiscordContext): List<String>

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

Link copied to clipboard
open fun isOptional(): Boolean

Utility function to check that this Argument is an OptionalArg.

Link copied to clipboard
open fun multiple(): MultipleArg<List<Input>, List<Output>>

Accept multiple inputs of this Argument.

Link copied to clipboard
open fun optional(default: List<Output>): OptionalArg<List<Input>, List<Output>, List<Output>>

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

open fun optional(default: suspend (DiscordContext) -> List<Output>): OptionalArg<List<Input>, List<Output>, List<Output>>

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

Link copied to clipboard
open fun optionalNullable(default: List<Output>? = null): OptionalArg<List<Input>, List<Output>, List<Output>?>

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

open fun optionalNullable(default: suspend (DiscordContext) -> List<Output>?): OptionalArg<List<Input>, List<Output>, List<Output>?>

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

Link copied to clipboard
open suspend override fun parse(args: MutableList<String>, discord: Discord): List<Input>?

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

Link copied to clipboard
open suspend override fun transform(input: List<Input>, context: DiscordContext): Result<List<Output>>

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

Properties

Link copied to clipboard
open override val description: String

A description of the data that this type represents.

Link copied to clipboard
open val innerType: Argument<Input, Output>

Get the innermost/raw type inside this argument.

Link copied to clipboard
open override val name: String

The display name for this type in documentations and examples.

Link copied to clipboard
open override val type: Argument<Input, Output>