DiscordKt/me.jakejmattson.discordkt.arguments/IntegerRangeArg

IntegerRangeArg

open class IntegerRangeArg( min: Int, max: Int, val name: String = "Integer (", val description: String = internalLocale.integerRangeArgDescription.inject(min.toString(), max.toString())) : IntegerArgument<Int>

Accepts an integer within a pre-defined range.

Constructors

IntegerRangeArg

fun IntegerRangeArg( min: Int, max: Int, name: String = "Integer (", description: String = internalLocale.integerRangeArgDescription.inject(min.toString(), max.toString()))

Functions

autocomplete

open fun autocomplete(choices: suspend AutocompleteData.() -> List<Int>): AutocompleteArg<Int, Int>

Offer autocomplete options for this argument.

generateExamples

open suspend override fun generateExamples(context: DiscordContext): List<String>

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

isOptional

open fun isOptional(): Boolean

Utility function to check that this Argument is an OptionalArg.

multiple

open fun multiple(): MultipleArg<Int, Int>

Accept multiple inputs of this Argument.

optional

open fun optional(default: Int): OptionalArg<Int, Int, Int>

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

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

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

optionalNullable

open fun optionalNullable(default: Int? = null): OptionalArg<Int, Int, Int?>

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

open fun optionalNullable(default: suspend (DiscordContext) -> Int?): OptionalArg<Int, Int, Int?>

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

parse

open suspend override fun parse(args: MutableList<String>, discord: Discord): Int?

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

transform

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

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

Properties

description

open override val description: String

A description of the data that this type represents.

name

open override val name: String

The display name for this type in documentations and examples.