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

Command

interface Command
Content copied to clipboard

指令

权限

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

See also

Types

Companion
Link copied to clipboard
object Companion
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.

Inheritors

AbstractCommand
Link copied to clipboard
BuiltInCommand
Link copied to clipboard
CompositeCommand
Link copied to clipboard
RawCommand
Link copied to clipboard
SimpleCommand
Link copied to clipboard
JRawCommand
Link copied to clipboard

Extensions

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

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

execute
Link copied to clipboard
@JvmName(name = "execute0")
@ExperimentalCommandDescriptors
inline suspend fun Command.execute(sender: CommandSender, vararg arguments: Message = emptyArray(), checkPermission: Boolean = true): CommandExecuteResult
Content copied to clipboard
@JvmName(name = "execute0")
@ExperimentalCommandDescriptors
inline suspend fun Command.execute(sender: CommandSender, arguments: String = "", checkPermission: Boolean = true): CommandExecuteResult
Content copied to clipboard

执行一个确切的指令

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