kord-extensions/dev.kordex.core.commands/Command

Command

abstract class Command(val extension: Extension) : Lockable, KordExKoinComponent

Abstract base class representing the few things that command objects can have in common.

This should be used as a base class only for command types that aren't related to the other command types.

Inheritors

ApplicationCommand

ChatCommand

Constructors

Command

constructor(extension: Extension)

Properties

extension

val extension: Extension

The extension object this command belongs to.

kord

val kord: Kord

Kord instance, backing the ExtensibleBot.

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.

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.

translationsProvider

val translationsProvider: TranslationsProvider

Translations provider, for retrieving translations.

Functions

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.

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.

unlock

open fun unlock()

Unlock the mutex, if it's locked.

validate

open fun validate()

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

withLock

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

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