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

RawCommand

abstract class RawCommand(owner: CommandOwner, primaryName: String, secondaryNames: String, usage: String, description: String, parentPermission: Permission, prefixOptional: Boolean) : Command

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

指令执行流程

继 CommandManager.executeCommand 所述第 3 步, RawCommand 不会对参数做任何解析.

Constructors

RawCommand

fun RawCommand(owner: CommandOwner, primaryName: String, vararg secondaryNames: String, usage: String = "<no usages given>", description: String = "<no descriptions given>", parentPermission: Permission = owner.parentPermission, prefixOptional: Boolean = false)

Functions

onCommand

abstract suspend fun CommandSender.onCommand(args: MessageChain)

在指令被执行时调用.

Properties

description

open override val description: String

指令描述, 用于显示在 BuiltInCommands.HelpCommand

overloads

@ExperimentalCommandDescriptors

open override val overloads: List<@JvmWildcard CommandSignature>

指令可能的参数列表.

owner

open override val owner: CommandOwner

指令拥有者.

permission

open override val permission: Permission

为此指令分配的权限.

prefixOptional

open override val prefixOptional: Boolean = false

为 true 时表示指令前缀可选

primaryName

open override val primaryName: String

主指令名.

secondaryNames

open override val secondaryNames: Array<out String>

次要指令名.

usage

open override val usage: String

用法说明, 用于发送给用户

RawCommand

指令执行流程

See also

Constructors

Functions

Properties