kord-extensions/dev.kordex.core.commands.converters/ListConverter

ListConverter

abstract class ListConverter<T : Any>(required: Boolean = true, var validator: Validator<List<T>> = null) : MultiNamedInputConverter<List<T>, List<T>, Int> , SlashCommandConverter

Abstract base class for a multi converter.

List converters take a list of multiple arguments, consuming as many arguments as it can to produce a list of resulting values. Upon reaching an argument that can't be consumed, the converter stores everything it could convert and tells the parser how many arguments it managed to consume. The parser will continue processing the unused arguments, passing them to the remaining converters.

You can create a list converter of your own by extending this class.

Inheritors

SingleToListConverter

Constructors

constructor(required: Boolean = true, validator: Validator<List<T>> = null)

Properties

open lateinit var argumentObj: Argument<*>

Argument object containing this converter and its metadata.

open val bot: ExtensibleBot

Current instance of the bot.

open lateinit var builder: ListConverterBuilder<T>

Access to the converter builder, perhaps a bit more hacky than it should be but whatever.

open val errorType: Key?

If the signatureType isn't sufficient, you can optionally provide a translation key pointing to a longer type string to use for error messages.

val kord: Kord

Kord instance, backing the ExtensibleBot.

open override var parsed: List<T>

The parsed value.

var parseSuccess: Boolean

This will be set to true by the argument parser if the conversion succeeded.

open override val required: Boolean

showTypeInSignature

open val showTypeInSignature: Boolean

For commands with generated signatures, set whether the type string should be shown in the signature.

abstract val signatureType: Key

Translation key pointing to a short string describing the type of data this converter handles. Should be very short.

open override var validator: Validator<List<T>>

Validation lambda, which may throw a DiscordRelayedException if required.

Functions

open suspend fun getErrorKey(): Key

Return a Key representing a pre-translated error string.

open suspend fun getErrorString(context: CommandContext): String

Return a translated, formatted error string.

open override fun getKoin(): Koin

Get the associated Koin instance.

operator fun getValue(thisRef: Arguments, property: KProperty<*>): List<T>

For delegation, retrieve the parsed value if it's been set, or null if it hasn't.

open suspend fun handleError(t: Throwable, context: CommandContext): Key

Given a Throwable encountered during the parse function, return a human-readable string to display on Discord.

open suspend fun mutate(context: CommandContext): List<T>

Call the mutator lambda, if one was provided.

abstract suspend fun parse(parser: StringParser?, context: CommandContext, named: List<String>? = null): Int

Process the string in the given parser, converting it into a new value.

abstract suspend fun parseOption(context: CommandContext, option: OptionValue<*>): Boolean

Use the given option taken straight from the slash command invocation to fill the converter.

abstract suspend fun toSlashOption(arg: Argument<*>): OptionWrapper<*>

open suspend fun validate(context: CommandContext)

Call the validator lambda, if one was provided.