BotCommands/io.github.freya022.botcommands.api.commands.text.options/TextCommandOption

TextCommandOption

interface TextCommandOption : CommandOption(source)

Represents a Discord input of a text command.

Properties

Link copied to clipboard
open override val command: TextCommandVariation

The executable command this parameter is from.

Link copied to clipboard
open val context: BContext

The main context.

Link copied to clipboard
abstract val declaredName: String

The name of this option in the command/aggregator.

Link copied to clipboard
open override val executable: TextCommandVariation

The executable this option is from.

Link copied to clipboard
abstract val helpExample: String?

Example input for the text command option, displayed on the "Example" part of the built-in help command.

Link copied to clipboard
abstract val helpName: String

Name of the text command option, also displayed on the "Usage" part of the built-in help command.

Link copied to clipboard
abstract val index: Int

The index of this option in the command/aggregator.

Link copied to clipboard
abstract val isId: Boolean

Whether this option needs to be considered as a snowflake ID.

Link copied to clipboard
abstract val isNullable: Boolean

Whether this option's value can be null.

Link copied to clipboard
abstract val isOptional: Boolean

Whether this option's value can be omitted.

Link copied to clipboard
open val isOptionalOrNullable: Boolean

Whether this option's value can either be omitted or null

Link copied to clipboard
abstract val isQuotable: Boolean

Whether this option's resolver supports quotes.

Link copied to clipboard
open val isRequired: Boolean

Whether this option's value is required.

Link copied to clipboard
abstract val isVararg: Boolean

Whether this option is part of vararg parameter.

Link copied to clipboard
abstract val kParameter: KParameter

A parameter from either the command function, or from an aggregation function.

Link copied to clipboard
abstract val nullValue: Any?

Fallback value when this option's resolver returned null.

Link copied to clipboard
abstract override val parent: TextCommandParameter

The aggregated parameter this option is from.

Link copied to clipboard
abstract val type: KType

Generified type of the option.

Functions

Link copied to clipboard
abstract fun getResolverHelpExample(event: BaseCommandEvent): String

Returns a help example for this option, from this option's TextParameterResolver.