DiscordKt/me.jakejmattson.discordkt.dsl

Package-level declarations

Primary builders and events used to develop bots.

Types

class Bot(token: String, packageName: String)

Backing class for bot function.

data class BotConfiguration(val packageName: String, val mentionAsPrefix: Boolean, val logStartup: Boolean, val documentCommands: Boolean, val recommendCommands: Boolean, val searchCommands: Boolean, val deleteInvocation: Boolean, val dualRegistry: Boolean, val commandReaction: DiscordEmoji?, val theme: Color?, val intents: Intents, val defaultPermissions: Permissions, val entitySupplyStrategy: EntitySupplyStrategy<*>, prefix: suspend (DiscordContext) -> String, mentionEmbed: Pair<String?, suspend EmbedBuilder.(DiscordContext) -> Unit?>, exceptionHandler: suspend DktException<*>.() -> Unit)

Contains all properties configured when the bot is created.

CommandException

class CommandException<T : Exception>(exception: T, val event: CommandEvent<*>) : DktException<T>

Contains an exception thrown from a command event.

Data

@Serializable

abstract class Data

A serializable class that represents some data.

DktButton

interface DktButton

Used internally to represent a button.

DktException

sealed class DktException<T : Exception>

Shared interface for handling exceptions.

ListenerException

class ListenerException<T : Exception>(exception: T, val event: Event) : DktException<T>

Contains an exception thrown from a listener.

Listeners

class Listeners(collector: ListenerBuilder.() -> Unit) : BuilderRegister

This is not for you...

data class Menu(pages: MutableList<EmbedBuilder>, buttons: MutableList<MutableList<DktButton>>)

Contains menu data and navigation functions.

MenuBuilder

class MenuBuilder

Type-safe builder for creating paginated embeds with button components.

MenuButtonRowBuilder

class MenuButtonRowBuilder

Builder functions for menu buttons.

Precondition

class Precondition(priority: Int, construct: suspend PreconditionBuilder.() -> Unit) : BuilderRegister

This is not for you...

Responder

interface Responder

An interface for responding to input in a given context.

SimpleConfiguration

data class SimpleConfiguration(var mentionAsPrefix: Boolean = true, var logStartup: Boolean = true, var documentCommands: Boolean = true, var recommendCommands: Boolean = true, var searchCommands: Boolean = true, var deleteInvocation: Boolean = true, var dualRegistry: Boolean = true, var commandReaction: DiscordEmoji? = Emojis.eyes, var theme: Color? = null, var intents: Intents = Intents.NONE, var defaultPermissions: Permissions = Permissions(Permission.UseApplicationCommands), var entitySupplyStrategy: EntitySupplyStrategy<*> = EntitySupplyStrategy.cacheWithCachingRestFallback)

Simple configuration values that don't require a builder.

SlashResponder

interface SlashResponder : Responder

A modified responder for slash commands.

Functions

bot

fun bot(token: String?, configure: suspend Bot.() -> Unit)

Create an instance of your Discord bot! You can use the following blocks to modify bot configuration: prefix, configure, mentionEmbed, presence, localeOf, onStart

edit

fun <T : Data> T.edit(edits: T.() -> Unit)

Apply an edit to a Data and save to file.

suspend fun Message.edit(menu: Menu): Message

Replace an existing message with a Menu.

listeners

fun listeners(construct: ListenerBuilder.() -> Unit): Listeners

Create a block for registering listeners.

suspend fun menu(menuBuilder: suspend MenuBuilder.() -> Unit): Menu

Create a Menu

precondition

fun precondition(priority: Int = 5, construct: suspend PreconditionBuilder.() -> Unit): Precondition

Create a block for registering preconditions.