mirai-console/net.mamoe.mirai.console.command/CommandManager

CommandManager

interface CommandManager

指令管理器

Inheritors

Types

Link copied to clipboard

Functions

Link copied to clipboard
@ExperimentalCommandDescriptors
open suspend fun executeCommand(caller: CommandSender, message: Message, checkPermission: Boolean = true): CommandExecuteResult

解析并执行一个指令.

@ConsoleExperimentalApi
@JvmName(name = "executeCommand")
@ExperimentalCommandDescriptors
open suspend fun executeCommand(sender: CommandSender, command: Command, arguments: Message = emptyMessageChain(), checkPermission: Boolean = true): CommandExecuteResult

执行一个确切的指令

Link copied to clipboard
abstract fun findDuplicateCommand(command: Command): Command?

查找并返回重名的指令. 返回重名指令.

Link copied to clipboard
abstract fun getRegisteredCommands(owner: CommandOwner): List<Command>

获取已经注册了的属于这个 CommandOwner 的指令列表.

Link copied to clipboard
abstract fun isCommandRegistered(command: Command): Boolean

当 command 已经 注册 时返回 true

Link copied to clipboard
abstract fun matchCommand(commandName: String): Command?

从 指令名称 匹配对应的 Command.

Link copied to clipboard
abstract fun registerCommand(command: Command, override: Boolean = false): Boolean

注册一个指令.

Link copied to clipboard
abstract fun unregisterAllCommands(owner: CommandOwner)

取消注册所有属于 owner 的指令

Link copied to clipboard
abstract fun unregisterCommand(command: Command): Boolean

取消注册这个指令.

Properties

Link copied to clipboard
abstract val allRegisteredCommands: List<Command>

获取所有已经注册了指令列表.

Link copied to clipboard
abstract val commandPrefix: String

指令前缀, 如 '/'