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

Package net.mamoe.mirai.console.command

Types

AbstractCommand

abstract class AbstractCommand @JvmOverloads constructor(owner: CommandOwner, primaryName: String, secondaryNames: Array<out String>, description: String, parentPermission: Permission) : Command

Command 的基础实现

AbstractCommandSender

sealed class AbstractCommandSender : CommandSender, CoroutineScope

所有 CommandSender 都必须继承自此对象.

AbstractUserCommandSender

sealed class AbstractUserCommandSender : AbstractCommandSender, UserCommandSender

UserCommandSender 的实现

BuiltInCommand

@ConsoleExperimentalApi

interface BuiltInCommand : Command

BuiltInCommands

object BuiltInCommands

内建指令列表

Command

interface Command

指令

CommandExecuteResult

@ExperimentalCommandDescriptors

sealed class CommandExecuteResult

指令的执行返回

CommandExecutionException

class CommandExecutionException(sender: CommandSender, command: Command, name: String, cause: Throwable) : RuntimeException

在 CommandManager.executeCommand 中抛出异常时包装的异常.

CommandManager

interface CommandManager

指令管理器

CommandOwner

interface CommandOwner : PermissionIdNamespace

指令的所有者.

CommandPermissionDeniedException

class CommandPermissionDeniedException(commandSender: CommandSender, command: Command) : RuntimeException

在 CommandManager.executeCommand 中, CommandSender 未拥有 Command.permission 所要求的权限时抛出的异常.

CommandSender

interface CommandSender : CoroutineScope, Permittee

指令发送者.

CommandSenderOnMessage

interface CommandSenderOnMessage<T : MessageEvent> : CommandSender

代表一个真实用户主动私聊机器人或在群内发送消息而执行指令

CompositeCommand

abstract class CompositeCommand(owner: CommandOwner, primaryName: String, secondaryNames: String, description: String, parentPermission: Permission, overrideContext: CommandArgumentContext) : AbstractCommand, Command, CommandArgumentContextAware

复合指令. 指令注册时候会通过反射构造指令解析器.

ConsoleCommandOwner

object ConsoleCommandOwner : CommandOwner

代表控制台所有者. 所有的 mirai-console 内建的指令都属于 ConsoleCommandOwner.

ConsoleCommandSender

object ConsoleCommandSender : AbstractCommandSender

控制台指令执行者. 代表由控制台执行指令

FailureReason

@ExperimentalCommandDescriptors

@ConsoleExperimentalApi

sealed class FailureReason

FriendCommandSender

open class FriendCommandSender : AbstractUserCommandSender, CoroutineScope

代表一个好友执行指令, 但不一定是通过私聊方式, 也有可能是由插件在代码直接执行 (CommandManager.executeCommand)

FriendCommandSenderOnMessage

class FriendCommandSenderOnMessage : FriendCommandSender, CommandSenderOnMessage<FriendMessageEvent>

代表一个真实的好友主动在私聊消息执行指令

GroupAwareCommandSender

interface GroupAwareCommandSender : UserCommandSender

知道 Group 环境的 UserCommandSender

GroupTempCommandSender

open class GroupTempCommandSender : TempCommandSender, CoroutineScope

代表一个群员通过临时会话执行指令, 但不一定是通过私聊方式, 也有可能是由插件在代码直接执行 (CommandManager.executeCommand)

GroupTempCommandSenderOnMessage

class GroupTempCommandSenderOnMessage : TempCommandSenderOnMessage, CommandSenderOnMessage<GroupTempMessageEvent>

代表一个群员主动在临时会话发送消息执行指令

IllegalCommandArgumentException

open class IllegalCommandArgumentException @JvmOverloads constructor(message: String, cause: Throwable?) : IllegalArgumentException

在处理参数时遇到的正常错误. 如参数不符合规范, 参数值越界等.

MemberCommandSender

open class MemberCommandSender : AbstractUserCommandSender, GroupAwareCommandSender, CoroutineScope

代表一个群员执行指令, 但不一定是通过群内发消息方式, 也有可能是由插件在代码直接执行 (CommandManager.executeCommand)

MemberCommandSenderOnMessage

class MemberCommandSenderOnMessage : MemberCommandSender, CommandSenderOnMessage<GroupMessageEvent>

代表一个真实的群员主动在群内发送消息执行指令.

OtherClientCommandSender

open class OtherClientCommandSender : AbstractCommandSender, CoroutineScope

代表一个其他客户端通过私聊执行指令, 但不一定是通过私聊方式, 也有可能是由插件在代码直接执行 (CommandManager.executeCommand)

OtherClientCommandSenderOnMessage

class OtherClientCommandSenderOnMessage : OtherClientCommandSender, CommandSenderOnMessage<OtherClientMessageEvent>

代表一个其他客户端主动在私聊发送消息执行指令

RawCommand

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

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

SimpleCommand

abstract class SimpleCommand(owner: CommandOwner, primaryName: String, secondaryNames: String, description: String, parentPermission: Permission, overrideContext: CommandArgumentContext) : AbstractCommand, Command, CommandArgumentContextAware

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

StrangerCommandSender

open class StrangerCommandSender : AbstractUserCommandSender, CoroutineScope

代表一个陌生人通过私聊执行指令, 但不一定是通过私聊方式, 也有可能是由插件在代码直接执行 (CommandManager.executeCommand)

StrangerCommandSenderOnMessage

class StrangerCommandSenderOnMessage : StrangerCommandSender, CommandSenderOnMessage<StrangerMessageEvent>

代表一个陌生人主动在私聊发送消息执行指令

TempCommandSender

~~sealed~~ ~~class~~ ~~TempCommandSender~~ : ~~AbstractUserCommandSender~~, ~~GroupAwareCommandSender~~, ~~CoroutineScope~~

代表一个群员通过临时会话执行指令, 但不一定是通过私聊方式, 也有可能是由插件在代码直接执行 (CommandManager.executeCommand)

TempCommandSenderOnMessage

~~sealed~~ ~~class~~ ~~TempCommandSenderOnMessage~~ : ~~GroupTempCommandSender~~, ~~CommandSenderOnMessage~~<GroupTempMessageEvent>

代表一个群员主动在临时会话发送消息执行指令

UnmatchedCommandSignature

@ExperimentalCommandDescriptors

@ConsoleExperimentalApi

class UnmatchedCommandSignature(signature: CommandSignature, failureReason: FailureReason)

UserCommandSender

interface UserCommandSender : CommandSender

代表一个用户执行指令

Functions

execute

@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

执行一个确切的指令

executeCommand

@JvmName(name = "execute0")

@ExperimentalCommandDescriptors

inline suspend fun CommandSender.executeCommand(message: String, checkPermission: Boolean = true): CommandExecuteResult

解析并执行一个指令

fold

inline fun <R> CommandSender.fold(ifIsConsole: ConsoleCommandSender.() -> R, ifIsUser: UserCommandSender.() -> R, otherwise: CommandSender.() -> R = { error("CommandSender ${this::class.qualifiedName} is not supported") }): R

折叠 AbstractCommandSender 的可能性.

foldContext

@ConsoleExperimentalApi

inline fun <R> UserCommandSender.foldContext(inGroup: MemberCommandSender.() -> R, inPrivate: UserCommandSender.() -> R): R

折叠 AbstractCommandSender 的两种可能性, 即在群内发送或在私聊环境发送.

getBotOrNull

fun CommandSender.getBotOrNull(): Bot?

尝试获取 Group.

getGroupOrNull

fun CommandSender.getGroupOrNull(): Group?

尝试获取 Group.

isConsole

fun CommandSender.isConsole(): Boolean

当 this 为 ConsoleCommandSender 时返回 true

isFailure

@ExperimentalCommandDescriptors

fun CommandExecuteResult.isFailure(): Boolean

当 this 为 CommandExecuteResult.ExecutionFailed, CommandExecuteResult.IllegalArgument , CommandExecuteResult.UnmatchedSignature 或 CommandExecuteResult.UnresolvedCommand 时返回 true

isNotConsole

fun CommandSender.isNotConsole(): Boolean

当 this 不为 ConsoleCommandSender 时返回 true

isNotUser

fun CommandSender.isNotUser(): Boolean

当 this 不为 UserCommandSender, 即为 ConsoleCommandSender 时返回 true

isSuccess

@ExperimentalCommandDescriptors

fun CommandExecuteResult.isSuccess(): Boolean

当 this 为 CommandExecuteResult.Success 时返回 true

isUser

fun CommandSender.isUser(): Boolean

当 this 为 UserCommandSender 时返回 true