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

CoalescingToDefaultingConverter

class CoalescingToDefaultingConverter<T : Any>(val coalescingConverter: CoalescingConverter<T>, defaultValue: T, outputError: Boolean = false, newSignatureType: Key? = null, newShowTypeInSignature: Boolean? = null, newErrorType: Key? = null, var validator: Validator<T> = null) : DefaultingCoalescingConverter<T>

A special OptionalConverter that wraps a SingleConverter, effectively turning it into an optional converter with the same logic.

The behaviours specified in OptionalConverter also apply to this converter, so it's worth reading about it.

Parameters

coalescingConverter

The SingleConverter to wrap.

newSignatureTypeString

An optional signature type string to override the one set in coalescingConverter.

newShowTypeInSignature

An optional boolean to override the showTypeInSignature setting set in coalescingConverter.

newErrorTypeString

An optional error type string to override the one set in coalescingConverter.

Constructors

CoalescingToDefaultingConverter

constructor(coalescingConverter: CoalescingConverter<T>, defaultValue: T, outputError: Boolean = false, newSignatureType: Key? = null, newShowTypeInSignature: Boolean? = null, newErrorType: Key? = null, validator: Validator<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: DefaultingCoalescingConverterBuilder<T>

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

coalescingConverter

val coalescingConverter: CoalescingConverter<T>

open override 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.

val outputError: Boolean

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

open override var parsed: 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 override val showTypeInSignature: Boolean

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

open override 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<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<*>): T

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

open suspend override 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): T

Call the mutator lambda, if one was provided.

open suspend override fun parse(parser: StringParser?, context: CommandContext, named: List<String>?): Int

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

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

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

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

open suspend fun validate(context: CommandContext)

Call the validator lambda, if one was provided.