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

Command

interface Command

指令

权限

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

See also

注册这个指令

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

复合指令

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

Inheritors

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
@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

执行一个确切的指令

Link copied to clipboard
inline fun Command.findDuplicate(): Command?
Link copied to clipboard
inline fun Command.register(override: Boolean = false): Boolean
Link copied to clipboard
inline fun Command.unregister(): Boolean

Properties

Link copied to clipboard
@JvmStatic
val Command.allNames: Array<String>

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

Link copied to clipboard
abstract val description: String

描述, 用于显示在 BuiltInCommands.HelpCommand

Link copied to clipboard
Link copied to clipboard
@ExperimentalCommandDescriptors
abstract val overloads: List<@JvmWildcard CommandSignature>

指令可能的参数列表.

Link copied to clipboard
abstract val owner: CommandOwner

指令拥有者.

Link copied to clipboard
abstract val permission: Permission

为此指令分配的权限.

Link copied to clipboard
@ExperimentalCommandDescriptors
abstract val prefixOptional: Boolean

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

Link copied to clipboard
abstract val primaryName: String

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

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

次要指令名

Link copied to clipboard
abstract val usage: String

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