kord-extensions/dev.kordex.core.commands.chat/ChatSubCommand

ChatSubCommand

open class ChatSubCommand<T : Arguments>(extension: Extension, arguments: () -> T? = null, val parent: ChatGroupCommand<out Arguments>) : ChatCommand<T>

Class representing a subcommand.

This is used for group commands, so that subcommands are aware of their parent.

Parameters

extension

The Extension that registered this command.

parent

The ChatGroupCommand this command exists under.

Constructors

constructor(extension: Extension, arguments: () -> T? = null, parent: ChatGroupCommand<out Arguments>)

Properties

open var aliasKey: Key?

Translation key referencing a comma-separated list of command aliases.

aliasTranslationCache

open val aliasTranslationCache: MutableMap<Locale, Set<String>>

Translation cache, so we don't have to look up translations every time.

allowKeywordArguments

open var allowKeywordArguments: Boolean

Whether to allow the parser to parse keyword arguments. Defaults to true.

open val arguments: () -> T?

open var description: Key

A description of what this function and how it's intended to be used.

open var enabled: Boolean

Whether this command is enabled and can be invoked.

val extension: Extension

The extension object this command belongs to.

open var hidden: Boolean

Whether to hide this command from help command listings.

val kord: Kord

Kord instance, backing the ExtensibleBot.

open var localeFallback: Boolean

When translated, whether this command supports locale fallback when a user is trying to resolve a command by name in a locale other than the bot's configured default locale.

open override var locking: Boolean

Set this to true to lock command execution with a Mutex.

open override var mutex: Mutex?

Mutex object to use for locking.

open lateinit var name: Key

The name of this command, for invocation and help commands.

nameTranslationCache

open val nameTranslationCache: MutableMap<Locale, String>

Translation cache, so we don't have to look up translations every time.

open val parent: ChatGroupCommand<out Arguments>

val registry: ChatCommandRegistry

Chat command registry.

open val requiredPerms: MutableSet<Permission>

Permissions required to be able to run this command.

val sentry: SentryAdapter

Sentry adapter, for easy access to Sentry functions.

val settings: ExtensibleBotBuilder

Bot settings object.

open var signature: Key?

Provide a translation key here to replace the auto-generated signature string.

open var signatureCache: MutableMap<Locale, String>

Locale-based cache of generated signature strings.

translationsProvider

val translationsProvider: TranslationsProvider

Translations provider, for retrieving translations.

Functions

open fun action(action: suspend ChatCommandContext<out T>.() -> Unit)

Define what will happen when your command is invoked.

open suspend fun call(event: MessageCreateEvent, commandName: String, parser: StringParser, argString: String, skipChecks: Boolean = false, cache: MutableStringKeyedMap<Any> = mutableMapOf())

Execute this command, given a MessageCreateEvent.

open fun check(vararg checks: ChatCommandCheck)

Define a check which must pass for the command to be executed.

open fun check(check: ChatCommandCheck)

Overloaded check function to allow for DSL syntax.

open suspend fun checkBotPerms(context: CommandContext)

Checks whether the bot has the specified required permissions, throwing if it doesn't.

open suspend fun emitEventAsync(event: CommandEvent<*, *>): Job

Quick shortcut for emitting a command event without blocking.

getFullTranslatedName

open suspend fun getFullTranslatedName(locale: Locale): String

Get the full command name, translated, with parent commands taken into account.

open override fun getKoin(): Koin

Get the associated Koin instance.

open suspend fun getSignature(locale: Locale): String

Retrieve the command signature for a locale, which specifies how the command's arguments should be structured.

getTranslatedAliases

open fun getTranslatedAliases(locale: Locale): Set<String>

Return this command's aliases translated for the given locale, cached as required.

getTranslatedName

open override fun getTranslatedName(locale: Locale): String

Return this command's name translated for the given locale, cached as required.

open suspend fun lock()

Lock the mutex, if locking is enabled - suspending until it's unlocked.

requireBotPermissions

fun requireBotPermissions(perms: Permissions)

fun requireBotPermissions(vararg perms: Permission)

If your bot requires permissions to be able to execute the command, add them using this function.

open suspend override fun runChecks(event: MessageCreateEvent, sendMessage: Boolean, cache: MutableStringKeyedMap<Any>): Boolean

Run checks with the provided MessageCreateEvent. Return false if any failed, true otherwise.

open fun unlock()

Unlock the mutex, if it's locked.

open override fun validate()

An internal function used to ensure that all of a command's required arguments are present.

open suspend fun <T> withLock(body: suspend () -> T)

Lock the mutex (if locking is enabled), call the supplied callable, and unlock.