mirai-console/net.mamoe.mirai.console/MiraiConsoleImplementation

MiraiConsoleImplementation

@ConsoleFrontEndImplementation
interface MiraiConsoleImplementation : CoroutineScope

实现 MiraiConsole 的接口

注意: 随着 Console 的更新, 在版本号 x.y.z 的 y 修改时此接口可能就会发生 ABI 变动. 意味着前端实现着需要跟随 Console 更新.

See also

启动

Types

Link copied to clipboard
@ConsoleFrontEndImplementation
interface BackendAccess

前端访问后端内部实现的桥

Link copied to clipboard
Link copied to clipboard
@ConsoleFrontEndImplementation
interface ConsoleCommandSenderImpl

由 Kotlin 用户实现

Link copied to clipboard
@ConsoleFrontEndImplementation
@NotStableForInheritance
interface ConsoleDataScope

Mirai Console 内置的一些 PluginConfig 和 PluginData 的管理器.

Link copied to clipboard
class ConsoleLaunchOptions

Console 启动参数, 修改参数会改变默认行为

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
Link copied to clipboard
abstract fun createLoginSolver(requesterBot: Long, configuration: BotConfiguration): LoginSolver

创建一个 LoginSolver

Link copied to clipboard
Link copied to clipboard
open fun postPhase(phase: String)

后端 在 phase 阶段执行后会调用此方法, 如果此方法抛出了一个错误会直接中断 console 初始化

Link copied to clipboard
open fun postStart()

后端在 start 后会调用此方法

Link copied to clipboard
open fun prePhase(phase: String)

后端 在 phase 阶段执行前会调用此方法, 如果此方法抛出了一个错误会直接中断 console 初始化

Link copied to clipboard
open fun preStart()

后端在 start 前会调用此方法

Link copied to clipboard
@JvmStatic
@ConsoleFrontEndImplementation
fun MiraiConsoleImplementation.start()

由前端调用, 初始化 MiraiConsole 实例并启动

Properties

Link copied to clipboard
Link copied to clipboard
abstract val builtInPluginLoaders: List<Lazy<PluginLoader<*, *>>>

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

Link copied to clipboard
abstract val commandManager: CommandManager

CommandManager 实现, 建议实现为 lazy:

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
abstract val consoleDataScope: MiraiConsoleImplementation.ConsoleDataScope

Mirai Console 内置的一些 PluginConfig 和 PluginData 的管理器.

Link copied to clipboard
abstract val consoleInput: ConsoleInput
Link copied to clipboard
Link copied to clipboard
abstract override val coroutineContext: CoroutineContext

MiraiConsole 的 CoroutineScope.coroutineContext, 必须拥有如下元素

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
abstract val frontEndDescription: MiraiConsoleFrontEndDescription

本前端实现的描述信息

Link copied to clipboard
open val isAnsiSupported: Boolean

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

Link copied to clipboard
abstract val jvmPluginLoader: JvmPluginLoader

JvmPluginLoader 实例. 建议实现为 lazy:

Link copied to clipboard
@ConsoleExperimentalApi
open val loggerController: LoggerController

前端预先定义的 LoggerController, 以允许前端使用自己的配置系统

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

Console 运行根目录绝对路径 (否则可能会被一些 native 插件覆盖相对路径)