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

CommandSender

interface CommandSender : CoroutineScope, Permittee

指令发送者.

只有 CommandSender 才能执行指令

获得指令发送者

实现 CommandSender

在任何时候都不要实现 CommandSender (包括使用委托). 必须使用上述扩展获取 CommandSender 实例.

除了以下情况:

Console 前端可实现 ConsoleCommandSender
插件可继承 AbstractPluginCustomCommandSender

子类型

所有 CommandSender 都应继承 AbstractCommandSender.

AbstractCommandSender 是密封类, 一级子类为:

二级子类, 当指令由插件主动执行时, 插件应使用 toCommandSender 或 asCommandSender, 因此,

若在群聊环境, 对应 CommandSender 为 MemberCommandSender
若在私聊环境, 对应 CommandSender 为 FriendCommandSender
若在临时会话环境, 对应 CommandSender 为 TempCommandSender
若在陌生人会话环境, 对应 CommandSender 为 StrangerCommandSender
若在其他客户端会话环境, 对应 CommandSender 为 OtherClientCommandSender

三级子类, 当真实收到由用户执行的指令时:

若在群聊环境, 对应 CommandSender 为 MemberCommandSenderOnMessage
若在私聊环境, 对应 CommandSender 为 FriendCommandSenderOnMessage
若在临时会话环境, 对应 CommandSender 为 TempCommandSenderOnMessage
若在陌生人会话环境, 对应 CommandSender 为 StrangerCommandSenderOnMessage
若在其他客户端会话环境, 对应 CommandSender 为 OtherClientCommandSenderOnMessage

类型关系如图. 箭头指向的是父类.

                   CoroutineScope
                          ↑
                          |
       +----------> CommandSender <---------+---------------------+---------------------------------------------------+
       |                                      ↑                 |                     |                               |
       |                                      |                 |                     |                               |
    SystemCommandSender <-------+             |     UserCommandSender   GroupAwareCommandSender     CommandSenderOnMessage
       ↑                        |             |                 ↑                     ↑                               ↑
    PluginCustomCommandSender   |             |                 |                     |                               |
       ↑                        |             |                 |                     |                               |
       |          +-------------+    AbstractCommandSender      |                     |                               |
       |          |                           ↑                 |                     |                               |
       |          |                           | sealed          |                     |                               |
       |          |           +---------------+-------------+   |                     |                               |
       |          |           |               |             |   |                     |                               |
       |          |           |               |             |   |                     |                               |
       |          |           |               |             |   |                     |                               |
       |          |           |               |             |   |                     |                               |
       |          |           |               |             |   |                     |                               |
       |          |           |               |             |   |                     |                               |
       |          |           |               |             |   |                     |                               |      }
       |     ConsoleCommandSender             |          AbstractUserCommandSender    |                               |      }
       |                                      |             ↑                         |                               |      } 一级子类
     AbstractPluginCustomCommandSender -------+             |                         |                               |      }
                                                            |                         |                               |      }
                                                            |                         |                               |
                                                            |                         |                               |
                                                            | sealed                  |                               |
                                                            |                         |                               |
                                     +----------------------+                         |                               |
                                     |                      |                         |                               |
                                     |                      +------+------------+---------------+                     |
                                     |                             |                            |                     |
                                     |                             |                            |                     |      }
                             FriendCommandSender          MemberCommandSender           TempCommandSender             |      } 二级子类
                                     ↑                             ↑                            ↑                     |      }
                                     |                             |                            |                     |
                                     |                             |                            |                     |      }
                        FriendCommandSenderOnMessage  MemberCommandSenderOnMessage  TempCommandSenderOnMessage        |      } 三级子类
                                     |                             |                            |                     |      }
                                     |                             |                            |                     |
                                     +-----------------------------+----------------------------+---------------------+

Scoping: MessageScope

在处理多个消息对象时, 可通过 MessageScope 简化操作.

查看 MessageScope 以获取更多信息.

Types

Companion

object Companion

Functions

sendMessage

abstract suspend fun sendMessage(message: String): MessageReceipt<Contact>?

abstract suspend fun sendMessage(message: Message): MessageReceipt<Contact>?

立刻发送一条消息.

Properties

bot

abstract val bot: Bot?

与这个 CommandSender 相关的 Bot. 当通过控制台执行时为 null.

coroutineContext

abstract val coroutineContext: CoroutineContext

name

abstract val name: String

User.nameCardOrNick 或 ConsoleCommandSender.NAME

permitteeId

abstract val permitteeId: PermitteeId

subject

abstract val subject: Contact?

与这个 CommandSender 相关的 Contact.

user

abstract val user: User?

指令原始发送人.

Inheritors

SystemCommandSender

PluginCustomCommandSender

UserCommandSender

CommandSenderOnMessage

AbstractCommandSender

Extensions

add

suspend fun CommandSender.add( account: Long, password: String, passwordKind: AutoLoginConfig.Account.PasswordKind = PLAIN)

asMessageScope

fun CommandSender.asMessageScope(): MessageScope

cancel

suspend fun CommandSender.cancel(target: PermitteeId, permission: Permission)

cancelAll

suspend fun CommandSender.cancelAll(target: PermitteeId, permission: Permission)

clear

suspend fun CommandSender.clear()

executeCommand

@JvmName(name = "execute0")

@ExperimentalCommandDescriptors

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

解析并执行一个指令

fold

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

折叠 CommandSender 的可能性.

getBotOrNull