kord-extensions/dev.kordex.core

Package-level declarations

Types

open class ArgumentParsingException(val reason: Key, val argument: Argument<*>?, val arguments: Arguments, val parser: StringParser?) : DiscordRelayedException

Thrown when something happens during argument parsing.

CommandRegistrationException

class CommandRegistrationException(val name: Key, val reason: String) : KordExException

Thrown when an attempt to register a ChatCommand fails.

DiscordRelayedException

open class DiscordRelayedException(val reason: Key) : KordExException

Thrown when something exceptional happens that the actioning user on Discord needs to be aware of.

EventHandlerRegistrationException

class EventHandlerRegistrationException(val handler: EventHandler<*>, val reason: String) : KordExException

Thrown when an attempt to register a EventHandler fails.

ExtensibleBot

open class ExtensibleBot(val settings: ExtensibleBotBuilder, token: String) : KordExKoinComponent, Lockable

An extensible bot, wrapping a Kord instance.

InvalidArgumentException

class InvalidArgumentException(val builder: ConverterBuilder<*>, val reason: String) : KordExException

Exception thrown when a converter builder hasn't been set up properly.

InvalidCommandException

class InvalidCommandException(val name: Key?, val reason: String) : KordExException

Thrown when a command could not be validated.

InvalidEventHandlerException

class InvalidEventHandlerException(val handler: EventHandler<*>, val reason: String) : KordExException

Thrown when an EventHandler could not be validated.

InvalidExtensionException

class InvalidExtensionException(val clazz: KClass<out Extension>, val reason: String?) : KordExException

Thrown when an attempt to load an Extension fails.

KordExException

open class KordExException : Exception

A base class for all custom exceptions in our bot framework.

Properties

BOT_VERSION

val BOT_VERSION: String?

Bot version, as provided by the bot's kordex.properties resource.

COLLECTION_STATE_LOCATION

val COLLECTION_STATE_LOCATION: String

Location of the data collection state file.

DATA_COLLECTION

val DATA_COLLECTION: DataCollection

Data collection setting, defaulting to Standard if not set.

DATA_COLLECTION_UUID

val DATA_COLLECTION_UUID: UUID?

Data collection UUID, if you need to specify one instead of having the storage system take care of it.

DEV_MODE

val DEV_MODE: Boolean

Dev-mode configuration based on properties and env vars.

DISCORD_BLACK

val DISCORD_BLACK: Color

Colour representing Discord's new black colour.

DISCORD_BLURPLE

val DISCORD_BLURPLE: Color

Colour representing Discord's new blurple colour.

DISCORD_FUCHSIA

val DISCORD_FUCHSIA: Color

Colour representing Discord's new fuchsia colour.

DISCORD_GREEN

val DISCORD_GREEN: Color

Colour representing Discord's new green colour.

DISCORD_LIGHT_BLURPLE

val DISCORD_LIGHT_BLURPLE: Color

Colour representing Discord's new light blurple colour.

DISCORD_RED

val DISCORD_RED: Color

Colour representing Discord's new red colour.

DISCORD_WHITE

val DISCORD_WHITE: Color

Colour representing Discord's new white colour.

DISCORD_YELLOW

val DISCORD_YELLOW: Color

Colour representing Discord's new yellow colour.

KORD_VERSION

val KORD_VERSION: String

Current Kord version.

KORDEX_MODULES

val KORDEX_MODULES: List<String>

Configured first-party KordEx modules.

kordexBuildProps

val kordexBuildProps: Properties?

Convenient access to the properties stored within kordex-build.properties in your bot's resources.

kordexProps

val kordexProps: Properties?

Convenient access to the properties stored within kordex.properties in your bot's resources.

Functions

ExtensibleBot

suspend fun ExtensibleBot(token: String, builder: suspend ExtensibleBotBuilder.() -> Unit): ExtensibleBot

DSL function for creating a bot instance. This is the Kord Extensions entrypoint.