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

DefaultingConverter

abstract class DefaultingConverter<T : Any>(defaultValue: T, val outputError: Boolean = false, var validator: Validator<T> = null) : SingleNamedInputConverter<T, T, Boolean> , SlashCommandConverter

Abstract base class for a defaulting converter.

Single converters take a single string argument, transforming it into a single resulting value. A default value will be provided in case parsing fails.

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

Inheritors

SingleToDefaultingConverter

Constructors

DefaultingConverter

constructor(defaultValue: T, outputError: Boolean = false, validator: Validator<T> = null)

Properties

argumentObj

open lateinit var argumentObj: Argument<*>

Argument object containing this converter and its metadata.

bot

open val bot: ExtensibleBot

Current instance of the bot.

builder

open lateinit var builder: DefaultingConverterBuilder<T>

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

errorType

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.

kord

val kord: Kord

Kord instance, backing the ExtensibleBot.

outputError

val outputError: Boolean = false

Whether the argument parser should output parsing errors on invalid arguments.

parsed

open override var parsed: T

The parsed value.

parseSuccess

var parseSuccess: Boolean

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

required

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.

signatureType

abstract val signatureType: Key

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

validator

open override var validator: Validator<T>

Validation lambda, which may throw a DiscordRelayedException if required.

Functions

getErrorKey

open suspend fun getErrorKey(): Key

Return a Key representing a pre-translated error string.

getErrorString

open suspend fun getErrorString(context: CommandContext): String

Return a translated, formatted error string.

getKoin

open override fun getKoin(): Koin

Get the associated Koin instance.

getValue

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

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

handleError

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.

mutate

open suspend fun mutate(context: CommandContext): T

Call the mutator lambda, if one was provided.

parse

abstract suspend fun parse(parser: StringParser?, context: CommandContext, named: String? = null): Boolean

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

parseOption

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

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

toSlashOption

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

validate

open suspend fun validate(context: CommandContext)

Call the validator lambda, if one was provided.