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

TextCommandsContext

@InterfacedService(acceptMultiple = false)

interface TextCommandsContext(source)

Helps to get the registered text commands.

Properties

defaultEmbedFooterIconSupplier

abstract val defaultEmbedFooterIconSupplier: DefaultEmbedFooterIconSupplier

Returns the DefaultEmbedFooterIconSupplier service.

defaultEmbedSupplier

abstract val defaultEmbedSupplier: DefaultEmbedSupplier

Returns the DefaultEmbedSupplier service.

helpBuilderConsumer

abstract val helpBuilderConsumer: HelpBuilderConsumer?

Returns the consumer that customizes the built-in help command's content.

open val ~~isPingAsPrefix~~: Boolean

open val ~~prefixes~~: List<String>

Returns the full list of prefixes used to trigger the bot.

abstract val rootCommands: Collection<TopLevelTextCommandInfo>

abstract val textConfig: BTextConfig

Functions

findTextCommand

abstract fun findTextCommand(words: List<String>): TextCommandInfo?

findTextSubcommands

abstract fun findTextSubcommands(words: List<String>): Collection<TextCommandInfo>

getDefaultPrefixes

abstract fun getDefaultPrefixes(): List<String>

Returns the configured prefixes and the bot mention if enabled.

getEffectivePrefixes

abstract fun getEffectivePrefixes(channel: GuildMessageChannel): List<String>

Returns the prefixes this bot responds to in the specified guild, or an empty list if the bot shouldn't respond to anything.

getPreferredPrefix

open fun ~~getPreferredPrefix~~(jda: JDA): String?

Returns the preferred prefix for triggering this bot, or null if BTextConfig.usePingAsPrefix is disabled and no prefix was added in BTextConfig.prefixes.

abstract fun getPreferredPrefix(channel: GuildMessageChannel): String?

Returns the preferred prefix this bot is able to respond to, in the specified guild, or null if no prefix could be determined, in which case text commands are not usable.