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

HelpCommand

object HelpCommand : SimpleCommand, BuiltInCommandInternal

Functions

@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?

generateDefaultHelp

fun generateDefaultHelp(permitteeId: PermitteeId): String

suspend fun CommandSender.handle()

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

inline fun Command.unregister(): Boolean

Properties

val Command.allNames: Array<String>

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

open override val context: CommandArgumentContext

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

abstract val description: String

描述, 用于显示在 BuiltInCommands.HelpCommand

val Command.isRegistered: Boolean

@ExperimentalCommandDescriptors

override val overloads: List<@JvmWildcard CommandSignatureFromKFunction>

指令可能的参数列表.

abstract val owner: CommandOwner

指令拥有者.

abstract val permission: Permission

为此指令分配的权限.

@ExperimentalCommandDescriptors

abstract val prefixOptional: Boolean

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

abstract val primaryName: String

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

abstract val secondaryNames: Array<out String>

次要指令名

open override val usage: String

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