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

MiraiConsoleImplementation

@ConsoleFrontEndImplementation
interface MiraiConsoleImplementation : CoroutineScope
Content copied to clipboard

实现 MiraiConsole 的接口

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

See also

Types

Link copied to clipboard
@ConsoleFrontEndImplementation
interface BackendAccess
Content copied to clipboard

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

Link copied to clipboard
@ConsoleFrontEndImplementation
object Companion
Content copied to clipboard
Link copied to clipboard
@ConsoleFrontEndImplementation
interface ConsoleCommandSenderImpl
Content copied to clipboard

由 Kotlin 用户实现

Link copied to clipboard
@ConsoleFrontEndImplementation
@NotStableForInheritance
interface ConsoleDataScope
Content copied to clipboard

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

Link copied to clipboard
@ConsoleExperimentalApi
class ConsoleLaunchOptions
Content copied to clipboard

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

Link copied to clipboard
@ConsoleFrontEndImplementation
interface FrontendLoggingInitContext
Content copied to clipboard

前端 MiraiLogger.Factory 加载的上下文

Link copied to clipboard
Link copied to clipboard
@ConsoleFrontEndImplementation
interface JConsoleInput : ConsoleInput
Content copied to clipboard

供 Java 用户实现 ConsoleInput

Functions

Link copied to clipboard
abstract fun createLogger(identity: String?): MiraiLogger
Content copied to clipboard

创建一个 MiraiLogger.

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

创建一个 LoginSolver

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

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

Link copied to clipboard
open fun postStart()
Content copied to clipboard

后端在 start 后会调用此方法

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

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

Link copied to clipboard
open fun preStart()
Content copied to clipboard

后端在 start 前会调用此方法

Properties

Link copied to clipboard
open val backendAccess: MiraiConsoleImplementation.BackendAccess
Content copied to clipboard
Link copied to clipboard
abstract val builtInPluginLoaders: List<Lazy<PluginLoader<*, *>>>
Content copied to clipboard

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

Link copied to clipboard
abstract val commandManager: CommandManager
Content copied to clipboard

CommandManager 实现, 建议实现为 lazy:

Link copied to clipboard
abstract val configStorageForBuiltIns: PluginDataStorage
Content copied to clipboard
Link copied to clipboard
abstract val configStorageForJvmPluginLoader: PluginDataStorage
Content copied to clipboard
Link copied to clipboard
Link copied to clipboard
abstract val consoleDataScope: MiraiConsoleImplementation.ConsoleDataScope
Content copied to clipboard

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

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

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

Link copied to clipboard
abstract val dataStorageForBuiltIns: PluginDataStorage
Content copied to clipboard
Link copied to clipboard
abstract val dataStorageForJvmPluginLoader: PluginDataStorage
Content copied to clipboard
Link copied to clipboard
abstract val frontEndDescription: MiraiConsoleFrontEndDescription
Content copied to clipboard

本前端实现的描述信息

Link copied to clipboard
open val isAnsiSupported: Boolean
Content copied to clipboard

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

Link copied to clipboard
abstract val jvmPluginLoader: JvmPluginLoader
Content copied to clipboard

JvmPluginLoader 实例. 建议实现为 lazy:

Link copied to clipboard
open val loggerController: LoggerController
Content copied to clipboard

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

Link copied to clipboard
open val origin: MiraiConsoleImplementation
Content copied to clipboard

获取原始 MiraiConsoleImplementation 实例.

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

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

Extensions

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

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