kord-extensions/dev.kordex.core.extensions.impl/HelpExtension

HelpExtension

class HelpExtension : Extension, HelpProvider

Help command extension.

This extension provides a !help command listing the available commands, along with a !help <command> to get more info about a specific command.

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
class HelpArguments : Arguments

Help command arguments class.

Properties

Link copied to clipboard
open val allowApplicationCommandInDMs: Boolean = true

Whether ApplicationCommands should be allowed in DMs by default.

Link copied to clipboard
open val applicationCommandRegistry: ApplicationCommandRegistry

Slash command registry.

Link copied to clipboard
open val bot: ExtensibleBot

The ExtensibleBot instance that this extension is installed to.

Link copied to clipboard
val botSettings: ExtensibleBotBuilder

Bot settings.

Link copied to clipboard
open val chatCommandChecks: MutableList<ChatCommandCheck>

List of chat command checks.

Link copied to clipboard
open val chatCommandRegistry: ChatCommandRegistry

Message command registry.

Link copied to clipboard
open val chatCommands: MutableList<ChatCommand<out Arguments>>

List of registered commands.

Link copied to clipboard
open val eventHandlers: MutableList<EventHandler<out Event>>

List of registered event handlers.

Link copied to clipboard
open val intents: MutableSet<Intent>

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

Link copied to clipboard
open val kord: Kord

Current Kord instance powering the bot.

Link copied to clipboard
open val loaded: Boolean

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

Link copied to clipboard
val messageCommandChecks: MutableList<MessageCommandCheck>

List of message command checks.

Link copied to clipboard
open val messageCommands: MutableList<MessageCommand<*, *>>

List of registered slash commands.

Link copied to clipboard
val messageCommandsRegistry: ChatCommandRegistry

Message command registry.

Link copied to clipboard
open override val name: String

The name of this extension.

Link copied to clipboard
val settings: HelpExtensionBuilder

Help extension settings, from the bot builder.

Link copied to clipboard
val slashCommandChecks: MutableList<SlashCommandCheck>

List of slash command checks.

Link copied to clipboard
open val slashCommands: MutableList<SlashCommand<*, *, *>>

List of registered slash commands.

Link copied to clipboard
open var state: ExtensionState

The current loading/unloading state of the extension.

Link copied to clipboard
val userCommandChecks: MutableList<UserCommandCheck>

List of user command checks.

Link copied to clipboard
open val userCommands: MutableList<UserCommand<*, *>>

List of registered slash commands.

Functions

Link copied to clipboard
suspend fun Extension.addHealthCheck(id: String, interval: Duration = 30.seconds, body: suspend HealthCheckResult.() -> Unit): HealthCheck
Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
suspend fun <M : ModalForm> Extension.ephemeralMessageCommand(commandObj: EphemeralMessageCommand<M>): EphemeralMessageCommand<M>

Register a custom instance of an ephemeral message command.

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>

Register an ephemeral message command, DSL-style.

Link copied to clipboard
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.

Link copied to clipboard
suspend fun <M : ModalForm> Extension.ephemeralUserCommand(commandObj: EphemeralUserCommand<M>): EphemeralUserCommand<M>

Register a custom instance of an ephemeral user command.

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>

Register an ephemeral user command, DSL-style.

Link copied to clipboard
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.

Link copied to clipboard
open suspend fun formatCommandHelp(context: ChatCommandContext<*>, command: ChatCommand<out Arguments>, longDescription: Boolean = false): Triple<String, String, String>

Given a command object and command context, return a triple representing the formatted command name and signature, formatted command description and formatted argument list.

open suspend override fun formatCommandHelp(prefix: String, event: MessageCreateEvent, command: ChatCommand<out Arguments>, longDescription: Boolean): Triple<String, String, String>

Given a command object and command prefix string, return a triple representing the formatted command name and signature, formatted command description and formatted argument list.

Link copied to clipboard
open suspend override fun gatherCommands(event: MessageCreateEvent): List<ChatCommand<out Arguments>>

Gather all available commands (with passing checks) from the bot, and return them.

Link copied to clipboard
open suspend override fun getCommand(event: MessageCreateEvent, args: List<String>): ChatCommand<out Arguments>?

Return the MessageCommand specified in the arguments, or null if it can't be found (or the checks fail).

Link copied to clipboard
open suspend fun getCommandHelpPaginator(context: ChatCommandContext<*>, command: ChatCommand<out Arguments>?): BasePaginator
open suspend override fun getCommandHelpPaginator(context: ChatCommandContext<*>, args: List<String>): BasePaginator

Given a command context and argument list, attempt to find the command represented by the arguments and return a BasePaginator, ready to be sent.

open suspend override fun getCommandHelpPaginator(event: MessageCreateEvent, prefix: String, command: ChatCommand<out Arguments>?): BasePaginator
open suspend override fun getCommandHelpPaginator(event: MessageCreateEvent, prefix: String, args: List<String>): BasePaginator

Given an event, prefix and argument list, attempt to find the command represented by the arguments and return a BasePaginator, ready to be sent.

Link copied to clipboard
open override fun getKoin(): Koin

Get the associated Koin instance.

Link copied to clipboard
open suspend fun getMainHelpPaginator(context: ChatCommandContext<*>): BasePaginator

Given a command context, return a BasePaginator containing help information for all loaded commands with passing checks.

open suspend override fun getMainHelpPaginator(event: MessageCreateEvent, prefix: String): BasePaginator

Given an event and prefix, return a BasePaginator containing help information for all loaded commands with passing checks.

Link copied to clipboard
Link copied to clipboard
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.

Link copied to clipboard
suspend fun <M : ModalForm> Extension.publicMessageCommand(commandObj: PublicMessageCommand<M>): PublicMessageCommand<M>

Register a custom instance of a public message command.

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>

Register a public message command, DSL-style.

Link copied to clipboard
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.

Link copied to clipboard
suspend fun <M : ModalForm> Extension.publicUserCommand(commandObj: PublicUserCommand<M>): PublicUserCommand<M>

Register a custom instance of a public user command.

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>

Register a public user command, DSL-style.

Link copied to clipboard
open suspend fun setState(state: ExtensionState)

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

Link copied to clipboard
open suspend override fun setup()

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

Link copied to clipboard
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.

Link copied to clipboard
open suspend fun unload()

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

Link copied to clipboard
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.