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

BuiltInCommand

@ConsoleExperimentalApi
interface BuiltInCommand : Command
Content copied to clipboard

Properties

description
Link copied to clipboard
abstract val description: String
Content copied to clipboard

描述, 用于显示在 BuiltInCommands.HelpCommand

overloads
Link copied to clipboard
@ConsoleExperimentalApi(message = "Property name is experimental")
@ExperimentalCommandDescriptors
abstract val overloads: List<@JvmWildcard CommandSignature>
Content copied to clipboard

指令可能的参数列表.

owner
Link copied to clipboard
abstract val owner: CommandOwner
Content copied to clipboard

指令拥有者.

permission
Link copied to clipboard
abstract val permission: Permission
Content copied to clipboard

为此指令分配的权限.

prefixOptional
Link copied to clipboard
@ExperimentalCommandDescriptors
@ConsoleExperimentalApi
abstract val prefixOptional: Boolean
Content copied to clipboard

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

primaryName
Link copied to clipboard
abstract val primaryName: String
Content copied to clipboard

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

secondaryNames
Link copied to clipboard
abstract val secondaryNames: Array<out String>
Content copied to clipboard

次要指令名

usage
Link copied to clipboard
abstract val usage: String
Content copied to clipboard

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