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

Command

interface Command

指令

权限

每个指令都会被分配一个权限 permission. 默认没有人拥有这个权限. 请通过 BuiltInCommands.PermissionCommand 赋予权限.

See also

net.mamoe.mirai.console.command.CommandManager

注册这个指令

net.mamoe.mirai.console.command.RawCommand

无参数解析, 接收原生参数的指令

net.mamoe.mirai.console.command.CompositeCommand

复合指令

net.mamoe.mirai.console.command.SimpleCommand

简单的, 支持参数自动解析的指令

net.mamoe.mirai.console.command.descriptor.CommandArgumentContextAware

Types

object Companion

Properties

abstract val description: String

描述, 用于显示在 BuiltInCommands.HelpCommand

@ConsoleExperimentalApi(message = "Property name is experimental")

@ExperimentalCommandDescriptors

abstract val overloads: List<@JvmWildcard CommandSignature>

指令可能的参数列表.

abstract val owner: CommandOwner

指令拥有者.

abstract val permission: Permission

为此指令分配的权限.

@ExperimentalCommandDescriptors

@ConsoleExperimentalApi

abstract val prefixOptional: Boolean

为 true 时表示指令前缀可选.

abstract val primaryName: String

主指令名. 将会参与构成 Permission.id.

abstract val secondaryNames: Array<out String>

次要指令名

abstract val usage: String

用法说明, 用于发送给用户. usage 一般包含 description.

Inheritors

AbstractCommand

CompositeCommand

Extensions

val Command.allNames: Array<String>

获取所有指令名称 (包含 primaryName 和 secondaryNames).

@JvmName(name = "execute0")

@ExperimentalCommandDescriptors

inline suspend fun Command.execute( sender: CommandSender, vararg arguments: Message = emptyArray(), checkPermission: Boolean = true): CommandExecuteResult

@JvmName(name = "execute0")

@ExperimentalCommandDescriptors

inline suspend fun Command.execute( sender: CommandSender, arguments: String = "", checkPermission: Boolean = true): CommandExecuteResult

执行一个确切的指令

inline fun Command.findDuplicate(): Command?

val Command.isRegistered: Boolean

inline fun Command.register(override: Boolean = false): Boolean

inline fun Command.unregister(): Boolean