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

ChatCommand

open class ChatCommand<T : Arguments>(val extension: Extension, val arguments: () -> T? = null) : Command

Class representing a chat command.

You shouldn't need to use this class directly - instead, create an Extension and use the chatCommand function to register your command, by overriding the Extension.setup function.

Parameters

extension

The Extension that registered this command.

arguments

Arguments object builder for this command, if it has arguments.

Inheritors

ChatGroupCommand

ChatSubCommand

Constructors

ChatCommand

constructor(extension: Extension, arguments: () -> T? = null)

Properties

aliasKey

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.

arguments

open val arguments: () -> T? = null

description

open var description: Key

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

enabled

open var enabled: Boolean

Whether this command is enabled and can be invoked.

extension

val extension: Extension

The extension object this command belongs to.

hidden

open var hidden: Boolean

Whether to hide this command from help command listings.

kord

val kord: Kord

Kord instance, backing the ExtensibleBot.

localeFallback

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.

locking

open override var locking: Boolean

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

mutex

open override var mutex: Mutex?

Mutex object to use for locking.

name

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.

registry

val registry: ChatCommandRegistry

Chat command registry.

requiredPerms

open val requiredPerms: MutableSet<Permission>

Permissions required to be able to run this command.

sentry

val sentry: SentryAdapter

Sentry adapter, for easy access to Sentry functions.

settings

val settings: ExtensibleBotBuilder

Bot settings object.

signature

open var signature: Key?

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

signatureCache

open var signatureCache: MutableMap<Locale, String>

Locale-based cache of generated signature strings.

translationsProvider

val translationsProvider: TranslationsProvider

Translations provider, for retrieving translations.

Functions

action

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

Define what will happen when your command is invoked.

call

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.

check

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.

checkBotPerms

open suspend fun checkBotPerms(context: CommandContext)

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

emitEventAsync

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

Quick shortcut for emitting a command event without blocking.

getKoin

open override fun getKoin(): Koin

Get the associated Koin instance.

getSignature

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 fun getTranslatedName(locale: Locale): String

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

lock

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.

runChecks

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

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

unlock

open fun unlock()

Unlock the mutex, if it's locked.

validate

open override fun validate()

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

withLock

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

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