MiraiConsole

interface MiraiConsole : CoroutineScope

Mirai Console 后端功能入口.

使用 Mirai Console

获取 Mirai Console 后端实例

一般插件开发者只能通过 MiraiConsole.INSTANCE 获得 MiraiConsole 实例.

Mirai Console 生命周期

MiraiConsole 实现协程作用域. MiraiConsole 生命周期与该协程作用域的相同.

MiraiConsole 实例构造后就视为已开始生存. 随后才会正式启动 (初始化和加载插件等).

取消 Job 时会同时停止 MiraiConsole, 并进行清理工作 (例如调用 JvmPlugin.onDisable.

获取插件管理器等功能实例

MiraiConsole 是后端功能入口, 可调用其 MiraiConsole.pluginManager 获取到 PluginManager 等实例.

实现 Mirai Console

实现 Mirai Console 后端

MiraiConsole 不可直接实现.

要实现 Mirai Console 后端, 需实现接口 MiraiConsoleImplementation 为一个 class 切勿实现为 object(单例或静态).

启动 Mirai Console 后端

Mirai Console 后端 (即本 MiraiConsole 类实例) 不可单独 (直接) 启动, 需要配合一个任意的前端实现.

Mirai Console 的启动时机由前端决定. 前端可在恰当的时机调用 MiraiConsoleImplementation.start 来启动一个 MiraiConsoleImplementation.

MiraiConsoleImplementation 将会由 bridge 转接为 MiraiConsole 实现. 对 MiraiConsole 的调用都会被转发到前端实现的 MiraiConsoleImplementation.

See also

Inheritors

Types

Link copied to clipboard

MiraiConsole 唯一实例. 一般插件开发者只能通过 MiraiConsole.INSTANCE 获得 MiraiConsole 实例.

Functions

Link copied to clipboard

创建一个 logger. 已弃用. 请使用 MiraiLogger.Factory.create.

Link copied to clipboard
inline suspend fun MiraiConsole.requestInput(hint: String): String

Properties

Link copied to clipboard
abstract val buildDate: Instant

此 Console 后端构建时间

Link copied to clipboard

内建加载器列表, 一般需要包含 JvmPluginLoader.

Link copied to clipboard
Link copied to clipboard

是否支持使用 Ansi 输出彩色信息

Link copied to clipboard

Console 主日志.

Link copied to clipboard
Link copied to clipboard

PluginManager 实例. 在 MiraiConsole 生命周期内应保持不变.

Link copied to clipboard
Link copied to clipboard
abstract val rootPath: Path

Console 运行根目录, 由前端决定确切路径.

Link copied to clipboard
abstract val version: SemVersion

此 Console 后端版本号