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

AbstractCommand

abstract class AbstractCommand @JvmOverloads constructor(val owner: CommandOwner, val primaryName: String, val secondaryNames: Array<out String>, val description: String = "<no description available>", parentPermission: Permission = owner.parentPermission) : Command

Command 的基础实现

See also

CompositeCommand

Inheritors

CompositeCommand

Constructors

AbstractCommand

constructor(owner: CommandOwner, primaryName: String, secondaryNames: Array<out String>, description: String = "<no description available>", parentPermission: Permission = owner.parentPermission)

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?

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

inline fun Command.unregister(): Boolean

Properties

val Command.allNames: Array<String>

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

open override val description: String

描述, 用于显示在 BuiltInCommands.HelpCommand

val Command.isRegistered: Boolean

@ExperimentalCommandDescriptors

abstract val overloads: List<@JvmWildcard CommandSignature>

指令可能的参数列表.

override val owner: CommandOwner

指令拥有者.

open override val permission: Permission

为此指令分配的权限.

@ExperimentalCommandDescriptors

open override val prefixOptional: Boolean

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

override val primaryName: String

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

override val secondaryNames: Array<out String>

次要指令名

open override val usage: String

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