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

CommandManager

interface CommandManager

指令管理器

Types

object INSTANCE : CommandManager

CommandManager 实例. 转发所有调用到 MiraiConsoleImplementation.commandManager.

Functions

@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

执行一个确切的指令

findDuplicateCommand

abstract fun findDuplicateCommand(command: Command): Command?

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

getRegisteredCommands

abstract fun getRegisteredCommands(owner: CommandOwner): List<Command>

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

isCommandRegistered

abstract fun isCommandRegistered(command: Command): Boolean

当 command 已经注册时返回 true

abstract fun matchCommand(commandName: String): Command?

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

registerCommand

abstract fun registerCommand(command: Command, override: Boolean = false): Boolean

注册一个指令.

unregisterAllCommands

abstract fun unregisterAllCommands(owner: CommandOwner)

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

unregisterCommand

abstract fun unregisterCommand(command: Command): Boolean

取消注册这个指令.

Properties

allRegisteredCommands

abstract val allRegisteredCommands: List<Command>

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

abstract val commandPrefix: String

指令前缀, 如 '/'

Inheritors