mirai-console/net.mamoe.mirai.console.command/BuiltInCommands/HelpCommand

HelpCommand

object HelpCommand : SimpleCommand, BuiltInCommandInternal

Functions

generateDefaultHelp

fun generateDefaultHelp(permitteeId: PermitteeId): String

suspend fun CommandSender.handle()

Properties

open override val context: CommandArgumentContext

指令参数环境. 默认为 CommandArgumentContext.Builtins+overrideContext

abstract val description: String

描述, 用于显示在 BuiltInCommands.HelpCommand

@ExperimentalCommandDescriptors

override val overloads: List<@JvmWildcard CommandSignatureFromKFunction>

指令可能的参数列表.

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>

次要指令名

open override val usage: String

自动根据带有 Handler 注解的函数签名生成 usage. 也可以被覆盖.