Package io.facet.chatcommands

Types

ChatCommand

abstract class ChatCommand(name: String, aliases: Set<String>, scope: Scope, category: String, description: String?, discordPermsRequired: PermissionSet, usage: CommandUsage?)

ChatCommandSource

class ChatCommandSource(event: MessageCreateEvent, command: String, prefixUsed: String, scope: CoroutineScope) : CoroutineScope

Command source for chat commands. Provides easy access to the message event objects.

CommandUsage

class CommandUsage(usageMap: Map<String, String>) : Iterable<CommandUsage.Pair>

CommandUsageBuilder

class CommandUsageBuilder

DSLCommandNode

interface DSLCommandNode<S>

Scope

enum Scope : Enum<Scope>

SuspendCommand

interface SuspendCommand<S> : Command<S>

Functions

commandUsage

fun commandUsage(block: CommandUsageBuilder.() -> Unit): CommandUsage

Note: this DSL is experimental and subject to change.

executesSuspend

~~fun~~ <S, T : ArgumentBuilder<S, T>> ArgumentBuilder<S, T>.~~executesSuspend~~(~~command~~: suspend (context: CommandContext<S>) -> Unit): T

executeSuspend

suspend fun CommandDispatcher<ChatCommandSource>.executeSuspend(parseResults: ParseResults<ChatCommandSource>): Int

get

inline fun <T> CommandContext<ChatCommandSource>.get(name: String): T

getBool

fun CommandContext<ChatCommandSource>.getBool(name: String): Boolean

getChannels

fun CommandContext<ChatCommandSource>.getChannels(name: String): TextChannelSelector

getDouble

fun CommandContext<ChatCommandSource>.getDouble(name: String): Double

getFloat

fun CommandContext<ChatCommandSource>.getFloat(name: String): Float

getInt

fun CommandContext<ChatCommandSource>.getInt(name: String): Int

getLong

fun CommandContext<ChatCommandSource>.getLong(name: String): Long

getMembers

fun CommandContext<ChatCommandSource>.getMembers(name: String): MemberSelector

getRoles

fun CommandContext<ChatCommandSource>.getRoles(name: String): RoleSelector

getSnowflake

fun CommandContext<ChatCommandSource>.getSnowflake(name: String): Snowflake

getString

fun CommandContext<ChatCommandSource>.getString(name: String): String

literal

fun <T> CommandDispatcher<T>.literal(name: String, setup: DSLCommandNode<T>.() -> Unit): CommandNode<T>

adds an Literal (non argument/subcommand) node

plus

operator fun SuggestionsBuilder.plus(suggestion: Int): SuggestionsBuilder

operator fun SuggestionsBuilder.plus(suggestion: String): SuggestionsBuilder

requiresSuspend

~~fun~~ <S, T : ArgumentBuilder<S, T>> ArgumentBuilder<S, T>.~~requiresSuspend~~(~~requirement~~: suspend (S) -> Boolean): T

respondEmbed

~~suspend~~ ~~fun~~ ChatCommandSource.~~respondEmbed~~(~~spec~~: EmbedCreateSpec): Message

Sends an embed based on the EmbedCreateSpec in the channel that the command was invoked in.

suspend fun ChatCommandSource.respondEmbed(builder: EmbedBuilder.() -> Unit): Message

Builds an EmbedCreateSpec and sends it in the channel that the command was invoked in.

respondMessage

suspend fun ChatCommandSource.respondMessage(template: MessageCreateSpec): Message

Sends a message based on the MessageCreateSpec in the channel that the command was invoked in.

suspend fun ChatCommandSource.respondMessage(vararg specs: EmbedCreateSpec): Message

Sends an embed based on the EmbedCreateSpec in the channel that the command was invoked in.

suspend fun ChatCommandSource.respondMessage(builder: MessageBuilder.() -> Unit): Message

Builds a MessageCreateSpec and sends it in the channel that the command was invoked in.

suspend fun ChatCommandSource.respondMessage(content: String): Message

Builds a message spec with only content and sends it in the channel the command was invoked in.

runs

fun <T> DSLCommandNode<T>.runs(executed: suspend T.(context: CommandContext<T>) -> Unit)

Like executes but always return 0, so there is no need to return.

Properties

aliasUsed

val CommandContext<ChatCommandSource>.aliasUsed: String

Get the name of the command alias used.