BotCommands/io.github.freya022.botcommands.api.commands.text/TextCommandVariation

TextCommandVariation

interface TextCommandVariation : Executable, IDeclarationSiteHolder, ICommandParameterContainer, ICommandOptionContainer, IFilterContainer(source)

Represents a text command variation, see TextCommandBuilder.variation for more details.

Properties

command

abstract val command: TextCommandInfo

The text command this variation is from, a text command has one or more variations, see TextCommandBuilder.variation for details.

completePattern

abstract val completePattern: Regex?

The regex pattern which matches this text command variation with its options.

context

abstract val context: BContext

The main context.

declarationSite

abstract val declarationSite: DeclarationSite

Purely for debugging purposes, will be shown in exceptions.

description

abstract val description: String?

Description of this text command variation.

discordOptions

open override val discordOptions: List<TextCommandOption>

All options representing a Discord input.

example

abstract val example: String?

Custom example for this text command variation.

function

abstract val function: KFunction<*>

The target function of this executable.

hasMultipleQuotable

open val hasMultipleQuotable: Boolean

Whether this text command variation has multiple options which are quotable

parameters

abstract override val parameters: List<TextCommandParameter>

The parameters of this executable.

usage

abstract val usage: String?

Custom usage syntax for this text command variation.

Functions

getOptionByDeclaredName

open fun getOptionByDeclaredName(name: String): Option?

Returns the option with the supplied declared name (i.e., name of the method parameter), or null if not found.

getOptionByDisplayName

open fun getOptionByDisplayName(name: String): TextCommandOption?

Returns the option with the supplied display name (i.e., the name you see on the built-in help command), or null if not found.

getParameter

open override fun getParameter(declaredName: String): TextCommandParameter?

Returns the aggregated parameter with the supplied declared name (i.e., name of the method parameter), or null if not found.

hasFilters

abstract fun hasFilters(): Boolean

Return true if this has a one or more filters.