DiscordKt/me.jakejmattson.discordkt.arguments/SplitterArg

SplitterArg

open class SplitterArg( splitter: String = "|", val name: String = "TextWithSplitter", val description: String = internalLocale.splitterArgDescription.inject(splitter)) : StringArgument<List<String>>

Consumes all arguments and returns a list of the results (split by splitter character).

Parameters

splitter

The character used to split the input.

Constructors

SplitterArg

fun SplitterArg( splitter: String = "|", name: String = "TextWithSplitter", description: String = internalLocale.splitterArgDescription.inject(splitter))

Types

Companion

object Companion : SplitterArg

Consumes all arguments and returns a list of the results (split by splitter character).

Functions

autocomplete

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

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<String, List<String>>

Accept multiple inputs of this Argument.

optional

open fun optional(default: List<String>): OptionalArg<String, List<String>, List<String>>

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

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

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

optionalNullable

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

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

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

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

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

transform

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

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.

Inheritors

Companion