DoubleArg

open class DoubleArg(val name: String = "Double", val description: String = internalLocale.doubleArgDescription) : DoubleArgument<Double>

Accept a decimal number in the double range.

Constructors

Link copied to clipboard
fun DoubleArg(name: String = "Double", description: String = internalLocale.doubleArgDescription)

Types

Link copied to clipboard
object Companion : DoubleArg

Accept a decimal number in the double range.

Functions

Link copied to clipboard
open fun autocomplete(choices: suspend AutocompleteData.() -> List<Double>): AutocompleteArg<Double, Double>

Offer autocomplete options for this argument.

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<Double, Double>

Accept multiple inputs of this Argument.

Link copied to clipboard
open fun optional(default: Double): OptionalArg<Double, Double, Double>

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

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

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: Double? = null): OptionalArg<Double, Double, Double?>

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

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

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): Double?

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

Link copied to clipboard
open suspend fun transform(input: Double, context: DiscordContext): Result<Double>

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 override val name: String

The display name for this type in documentations and examples.

Inheritors

Link copied to clipboard