DiscordKt/me.jakejmattson.discordkt.commands/CommandEvent

CommandEvent

open class CommandEvent<T : TypeContainer>(val rawInputs: RawInputs, val discord: Discord, val message: Message?, val author: User, val channel: MessageChannel, val guild: Guild?) : Responder

A generic command execution event.

Inheritors

GuildCommandEvent

DmCommandEvent

SlashCommandEvent

Constructors

CommandEvent

constructor(rawInputs: RawInputs, discord: Discord, message: Message?, author: User, channel: MessageChannel, guild: Guild?)

Properties

args

lateinit var args: T

The parsed input to the command.

author

open val author: User

The User who invoked this command.

channel

open override val channel: MessageChannel

The MessageChannel this command was invoked in.

command

val command: Command?

The Command that is resolved from the invocation.

context

val context: DiscordContext

The DiscordContext of this event.

discord

open val discord: Discord

The Discord instance.

guild

open val guild: Guild?

The (nullable) guild this command was invoked in.

message

open val message: Message?

The Message that invoked this command.

rawInputs

open val rawInputs: RawInputs

The RawInputs of the command.

Functions

clone

open fun clone(input: RawInputs): CommandEvent<T>

Clone this event's context data with new inputs.

getMember

suspend fun getMember(): Member?

Try to resolve the member from the user/guild data.

prefix

suspend fun prefix(): String

Determine the relevant prefix in the current context.

reactWith

suspend fun reactWith(emoji: DiscordEmoji): Unit?

Add a reaction to the command invocation message.

respond

open suspend fun respond(message: Any = "", embed: suspend EmbedBuilder.() -> Unit? = null): Message?

Create a response message with text and/or an embed.

respondMenu

open suspend fun respondMenu(menuBuilder: suspend MenuBuilder.() -> Unit): Message

Respond with a Menu.