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

BuiltInCommand

@ConsoleExperimentalApi

interface BuiltInCommand : Command

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.