kord-extensions/dev.kordex.core.extensions/Extension

Extension

abstract class Extension : KordExKoinComponent

Class representing a distinct set of functionality to be treated as a unit.

Override this and create your own extensions with their own event handlers and commands. This will allow you to keep distinct blocks of functionality separate, keeping the codebase clean and configurable.

Inheritors

AboutExtension

HelpExtension

SentryExtension

Constructors

Extension

constructor()

Properties

allowApplicationCommandInDMs

open val allowApplicationCommandInDMs: Boolean = true

Whether ApplicationCommands should be allowed in DMs by default.

applicationCommandRegistry

open val applicationCommandRegistry: ApplicationCommandRegistry

Slash command registry.

bot

open val bot: ExtensibleBot

The ExtensibleBot instance that this extension is installed to.

chatCommandChecks

open val chatCommandChecks: MutableList<ChatCommandCheck>

List of chat command checks.

chatCommandRegistry

open val chatCommandRegistry: ChatCommandRegistry

Message command registry.

chatCommands

open val chatCommands: MutableList<ChatCommand<out Arguments>>

List of registered commands.

eventHandlers

open val eventHandlers: MutableList<EventHandler<out Event>>

List of registered event handlers.

intents

open val intents: MutableSet<Intent>

Set of intents required by this extension's event handlers and commands.

kord

open val kord: Kord

Current Kord instance powering the bot.

loaded

open val loaded: Boolean

Check whether this extension's state is ExtensionState.LOADED.

messageCommandChecks

val messageCommandChecks: MutableList<MessageCommandCheck>

List of message command checks.

messageCommands

open val messageCommands: MutableList<MessageCommand<*, *>>

List of registered slash commands.

name

abstract val name: String

The name of this extension.

slashCommandChecks

val slashCommandChecks: MutableList<SlashCommandCheck>

List of slash command checks.

slashCommands

open val slashCommands: MutableList<SlashCommand<*, *, *>>

List of registered slash commands.

state

open var state: ExtensionState

The current loading/unloading state of the extension.

userCommandChecks

val userCommandChecks: MutableList<UserCommandCheck>

List of user command checks.

userCommands

open val userCommands: MutableList<UserCommand<*, *>>

List of registered slash commands.

Functions

addHealthCheck

suspend fun Extension.addHealthCheck(id: String, interval: Duration = 30.seconds, body: suspend HealthCheckResult.() -> Unit): HealthCheck

chatCommand

fun <T : Arguments> Extension.chatCommand(commandObj: ChatCommand<T>): ChatCommand<T>

Function for registering a custom command object.

suspend fun Extension.chatCommand(body: suspend ChatCommand<Arguments>.() -> Unit): ChatCommand<Arguments>

DSL function for easily registering a command, without arguments.

suspend fun <T : Arguments> Extension.chatCommand(arguments: () -> T, body: suspend ChatCommand<T>.() -> Unit): ChatCommand<T>

DSL function for easily registering a command.

chatCommandCheck

fun Extension.chatCommandCheck(vararg checks: ChatCommandCheck)

Define a check which must pass for the command to be executed. This check will be applied to all commands in this extension.

fun Extension.chatCommandCheck(check: ChatCommandCheck)

Overloaded check function to allow for DSL syntax.

chatGroupCommand

suspend fun Extension.chatGroupCommand(body: suspend ChatGroupCommand<Arguments>.() -> Unit): ChatGroupCommand<Arguments>

DSL function for easily registering a grouped command, without its own arguments.

suspend fun <T : Arguments> Extension.chatGroupCommand(arguments: () -> T, body: suspend ChatGroupCommand<T>.() -> Unit): ChatGroupCommand<T>

DSL function for easily registering a grouped command.

ephemeralMessageCommand

suspend fun <M : ModalForm> Extension.ephemeralMessageCommand(commandObj: EphemeralMessageCommand<M>): EphemeralMessageCommand<M>

suspend fun Extension.ephemeralMessageCommand(body: suspend EphemeralMessageCommand<ModalForm>.() -> Unit): EphemeralMessageCommand<ModalForm>

suspend fun <M : ModalForm> Extension.ephemeralMessageCommand(modal: () -> M, body: suspend EphemeralMessageCommand<M>.() -> Unit): EphemeralMessageCommand<M>

ephemeralSlashCommand

suspend fun <T : Arguments, M : ModalForm> Extension.ephemeralSlashCommand(commandObj: EphemeralSlashCommand<T, M>): EphemeralSlashCommand<T, M>

Function for registering a custom ephemeral slash command object.

suspend fun Extension.ephemeralSlashCommand(body: suspend EphemeralSlashCommand<Arguments, ModalForm>.() -> Unit): EphemeralSlashCommand<Arguments, ModalForm>

DSL function for easily registering an ephemeral slash command, without arguments.

suspend fun <T : Arguments> Extension.ephemeralSlashCommand(arguments: () -> T, body: suspend EphemeralSlashCommand<T, ModalForm>.() -> Unit): EphemeralSlashCommand<T, ModalForm>

DSL function for easily registering an ephemeral slash command, with arguments.

@JvmName(name = "ephemeralSlashCommand1")

suspend fun <M : ModalForm> Extension.ephemeralSlashCommand(modal: () -> M, body: suspend EphemeralSlashCommand<Arguments, M>.() -> Unit): EphemeralSlashCommand<Arguments, M>

suspend fun <A : Arguments, M : ModalForm> Extension.ephemeralSlashCommand(arguments: () -> A, modal: () -> M, body: suspend EphemeralSlashCommand<A, M>.() -> Unit): EphemeralSlashCommand<A, M>

DSL function for easily registering an ephemeral slash command, with a modal form.

ephemeralUserCommand

suspend fun <M : ModalForm> Extension.ephemeralUserCommand(commandObj: EphemeralUserCommand<M>): EphemeralUserCommand<M>

suspend fun Extension.ephemeralUserCommand(body: suspend EphemeralUserCommand<ModalForm>.() -> Unit): EphemeralUserCommand<ModalForm>

suspend fun <M : ModalForm> Extension.ephemeralUserCommand(modal: () -> M, body: suspend EphemeralUserCommand<M>.() -> Unit): EphemeralUserCommand<M>

event

inline suspend fun <T : Event> Extension.event(noinline constructor: (Extension) -> EventHandler<T> = ::EventHandler, noinline body: suspend EventHandler<T>.() -> Unit): EventHandler<T>

DSL function for easily registering an event handler.

getKoin

open override fun getKoin(): Koin

Get the associated Koin instance.

healthCheckState

fun Extension.healthCheckState(type: String, ordinal: Int): HealthCheckState

messageCommandCheck

fun Extension.messageCommandCheck(vararg checks: MessageCommandCheck)

Define a check which must pass for a message command to be executed. This check will be applied to all message commands in this extension.

fun Extension.messageCommandCheck(check: MessageCommandCheck)

Overloaded message command check function to allow for DSL syntax.

publicMessageCommand

suspend fun <M : ModalForm> Extension.publicMessageCommand(commandObj: PublicMessageCommand<M>): PublicMessageCommand<M>

suspend fun Extension.publicMessageCommand(body: suspend PublicMessageCommand<ModalForm>.() -> Unit): PublicMessageCommand<ModalForm>

suspend fun <M : ModalForm> Extension.publicMessageCommand(modal: () -> M, body: suspend PublicMessageCommand<M>.() -> Unit): PublicMessageCommand<M>

publicSlashCommand

suspend fun <T : Arguments, M : ModalForm> Extension.publicSlashCommand(commandObj: PublicSlashCommand<T, M>): PublicSlashCommand<T, M>

Function for registering a custom public slash command object.

suspend fun Extension.publicSlashCommand(body: suspend PublicSlashCommand<Arguments, ModalForm>.() -> Unit): PublicSlashCommand<Arguments, ModalForm>

DSL function for easily registering a public slash command, without arguments.

suspend fun <T : Arguments> Extension.publicSlashCommand(arguments: () -> T, body: suspend PublicSlashCommand<T, ModalForm>.() -> Unit): PublicSlashCommand<T, ModalForm>

DSL function for easily registering a public slash command, with arguments.

@JvmName(name = "publicSlashCommand1")

suspend fun <M : ModalForm> Extension.publicSlashCommand(modal: () -> M, body: suspend PublicSlashCommand<Arguments, M>.() -> Unit): PublicSlashCommand<Arguments, M>

DSL function for easily registering a public slash command, with a modal form.

suspend fun <A : Arguments, M : ModalForm> Extension.publicSlashCommand(arguments: () -> A, modal: () -> M, body: suspend PublicSlashCommand<A, M>.() -> Unit): PublicSlashCommand<A, M>

DSL function for easily registering a public slash command, with arguments and a modal form.

publicUserCommand

suspend fun <M : ModalForm> Extension.publicUserCommand(commandObj: PublicUserCommand<M>): PublicUserCommand<M>

suspend fun Extension.publicUserCommand(body: suspend PublicUserCommand<ModalForm>.() -> Unit): PublicUserCommand<ModalForm>

suspend fun <M : ModalForm> Extension.publicUserCommand(modal: () -> M, body: suspend PublicUserCommand<M>.() -> Unit): PublicUserCommand<M>

setState

open suspend fun setState(state: ExtensionState)

Update this extension's state, firing the extension state change event.

setup

abstract suspend fun setup()

Override this in your subclass and use it to register your commands and event handlers.

slashCommandCheck

fun Extension.slashCommandCheck(vararg checks: SlashCommandCheck)

Define a check which must pass for a slash command to be executed. This check will be applied to all slash commands in this extension.

fun Extension.slashCommandCheck(check: SlashCommandCheck)

Overloaded slash command check function to allow for DSL syntax.

unload

open suspend fun unload()

If you need to, override this function and use it to clean up your extension when it's unloaded.

userCommandCheck

fun Extension.userCommandCheck(vararg checks: UserCommandCheck)

Define a check which must pass for a user command to be executed. This check will be applied to all user commands in this extension.

fun Extension.userCommandCheck(check: UserCommandCheck)

Overloaded user command check function to allow for DSL syntax.