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

MiraiConsoleImplementation

@ConsoleFrontEndImplementation

interface MiraiConsoleImplementation : CoroutineScope

实现 MiraiConsole 的接口

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

Types

BackendAccess

@ConsoleFrontEndImplementation

interface BackendAccess

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

Companion

object Companion

ConsoleCommandSenderImpl

@ConsoleFrontEndImplementation

interface ConsoleCommandSenderImpl

由 Kotlin 用户实现

ConsoleDataScope

@ConsoleFrontEndImplementation

interface ConsoleDataScope

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

ConsoleLaunchOptions

@ConsoleExperimentalApi

class ConsoleLaunchOptions

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

JConsoleCommandSenderImpl

@ConsoleFrontEndImplementation

interface JConsoleCommandSenderImpl : MiraiConsoleImplementation.ConsoleCommandSenderImpl

由 Java 用户实现

JConsoleInput

@ConsoleFrontEndImplementation

interface JConsoleInput : ConsoleInput

供 Java 用户实现 ConsoleInput

Functions

createLogger

abstract fun createLogger(identity: String?): MiraiLogger

创建一个 MiraiLogger.

createLoginSolver

abstract fun createLoginSolver(requesterBot: Long, configuration: BotConfiguration): LoginSolver

创建一个 LoginSolver

postPhase

open fun postPhase(phase: String)

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

postStart

open fun postStart()

后端在 start 后会调用此方法

prePhase

open fun prePhase(phase: String)

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

preStart

open fun preStart()

后端在 start 前会调用此方法

Properties

backendAccess

open val backendAccess: MiraiConsoleImplementation.BackendAccess

builtInPluginLoaders

abstract val builtInPluginLoaders: List<Lazy<PluginLoader<*, *>>>

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

commandManager

abstract val commandManager: CommandManager

CommandManager 实现, 建议实现为 lazy:

configStorageForBuiltIns

abstract val configStorageForBuiltIns: PluginDataStorage

configStorageForJvmPluginLoader

abstract val configStorageForJvmPluginLoader: PluginDataStorage

consoleCommandSender

abstract val consoleCommandSender: MiraiConsoleImplementation.ConsoleCommandSenderImpl

ConsoleCommandSender

consoleDataScope

abstract val consoleDataScope: MiraiConsoleImplementation.ConsoleDataScope

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

consoleInput

abstract val consoleInput: ConsoleInput

consoleLaunchOptions

@ConsoleExperimentalApi

open val consoleLaunchOptions: MiraiConsoleImplementation.ConsoleLaunchOptions

coroutineContext

abstract override val coroutineContext: CoroutineContext

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

dataStorageForBuiltIns

abstract val dataStorageForBuiltIns: PluginDataStorage

dataStorageForJvmPluginLoader

abstract val dataStorageForJvmPluginLoader: PluginDataStorage

frontEndDescription

abstract val frontEndDescription: MiraiConsoleFrontEndDescription

本前端实现的描述信息

isAnsiSupported

open val isAnsiSupported: Boolean

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

jvmPluginLoader

abstract val jvmPluginLoader: JvmPluginLoader

JvmPluginLoader 实例. 建议实现为 lazy:

loggerController

open val loggerController: LoggerController

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

rootPath

abstract val rootPath: Path

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

Extensions

start

@JvmStatic

@ConsoleFrontEndImplementation

fun MiraiConsoleImplementation.start()

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

MiraiConsoleImplementation

See also

Types

Functions

Properties

Extensions