core/io.facet.core.features/ChatCommands

ChatCommands

class ChatCommands(config: ChatCommands.Config)
Content copied to clipboard

Instance of the ChatCommands feature.

Constructors

ChatCommands
Link copied to clipboard
fun ChatCommands(config: ChatCommands.Config)
Content copied to clipboard

Types

Companion
Link copied to clipboard
object Companion : EventDispatcherFeature<ChatCommands.Config, ChatCommands>
Content copied to clipboard

Adds the functionality to the DiscordClient to easily listen to and parse user commands. Must be configured with command prefix and commands.

Config
Link copied to clipboard
class Config
Content copied to clipboard

Functions

registerCommand
Link copied to clipboard
fun registerCommand(command: ChatCommand): Boolean
Content copied to clipboard
registerCommands
Link copied to clipboard
fun registerCommands(vararg commands: ChatCommand): Map<ChatCommand, Boolean>
Content copied to clipboard

Properties

commandMap
Link copied to clipboard
val commandMap: Map<String, ChatCommand>
Content copied to clipboard

Lookup map for the command object for a given alias.

commandPrefixFor
Link copied to clipboard
val commandPrefixFor: suspend (guildId: Snowflake?) -> String
Content copied to clipboard

Function that gets the command prefix for the specified guild.

commands
Link copied to clipboard
val commands: Set<ChatCommand>
Content copied to clipboard

Commands that have been registered with this feature.

dispatcher
Link copied to clipboard
val dispatcher: CommandDispatcher<ChatCommandSource>
Content copied to clipboard

Command dispatcher instance

Sources

jvm source
Link copied to clipboard