kord-extensions/dev.kordex.core.builders/ChatCommandsBuilder

ChatCommandsBuilder

class ChatCommandsBuilder

Builder used for configuring the bot's chat command options.

Constructors

ChatCommandsBuilder

constructor()

Properties

val checkList: MutableList<ChatCommandCheck>

List of command checks.

var defaultPrefix: String

Prefix to require for command invocations on Discord. Defaults to "!".

var enabled: Boolean

Whether to register and process chat commands. Defaults to false.

var ignoreSelf: Boolean

Whether to ignore command invocations in messages sent by the bot. Defaults to true.

invokeOnMention

var invokeOnMention: Boolean

Whether to invoke commands on bot mentions, in addition to using chat prefixes. Defaults to true.

Functions

fun check(vararg checks: ChatCommandCheck)

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

fun check(check: ChatCommandCheck)

Overloaded check function to allow for DSL syntax.

fun prefix(builder: suspend MessageCreateEvent.(String) -> String)

Register a lambda that takes a MessageCreateEvent object and the default prefix, and returns the command prefix to be made use of for that message event.

fun registry(builder: () -> ChatCommandRegistry)

Register the builder used to create the ChatCommandRegistry. You can change this if you need to make use of a subclass.