DiscordKt/me.jakejmattson.discordkt.arguments/BooleanArg

BooleanArg

open class BooleanArg(val name: String = "Boolean", val truthValue: String = "true", val falseValue: String = "false", val description: String = internalLocale.booleanArgDescription.inject(truthValue, falseValue)) : BooleanArgument<Boolean>

Accepts either of two values. Defaults to true/false.

Parameters

truthValue

The string value that results in true.

falseValue

The string value that results in false.

Inheritors

Companion

Constructors

BooleanArg

constructor(name: String = "Boolean", truthValue: String = "true", falseValue: String = "false", description: String = internalLocale.booleanArgDescription.inject(truthValue, falseValue))

Types

Companion

object Companion : BooleanArg

Accepts either true or false.

Properties

description

open override val description: String

A description of the data that this type represents.

falseValue

override val falseValue: String

name

open override val name: String

The display name for this type in documentations and examples.

truthValue

override val truthValue: String

Functions

autocomplete

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

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

Accept multiple inputs of this Argument.

optional

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

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

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

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

optionalNullable

open fun optionalNullable(default: Boolean?): OptionalArg<Boolean, Boolean, Boolean?>

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

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

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

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

transform

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

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