mirai-console/net.mamoe.mirai.console/MiraiConsole/INSTANCE

INSTANCE

object INSTANCE : MiraiConsole

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

对象以 bridge 实现, 将会桥接特定前端实现的 MiraiConsoleImplementation 到 MiraiConsole.

Functions

addBot

@ConsoleExperimentalApi(message = "This is a low-level API and might be removed in the future.")

fun addBot( id: Long, password: ByteArray, configuration: BotConfiguration.() -> Unit = {}): Bot

@ConsoleExperimentalApi(message = "This is a low-level API and might be removed in the future.")

fun addBot( id: Long, password: String, configuration: BotConfiguration.() -> Unit = {}): Bot

添加一个 Bot 实例到全局 Bot 列表, 但不登录.

createLogger

@ConsoleExperimentalApi

~~open~~ ~~override~~ ~~fun~~ ~~createLogger~~(identity: String?): MiraiLogger

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

newProcessProgress

@ConsoleExperimentalApi

@JvmStatic

fun newProcessProgress(): ProcessProgress

创建一个新的处理进度, 此进度将会在前端显示, 并且此进度需要手动关闭

shutdown

@ConsoleExperimentalApi

@JvmStatic

fun shutdown()

停止 Console 运行

Properties

buildDate

open override val buildDate: Instant

此 Console 后端构建时间

builtInPluginLoaders

open override val builtInPluginLoaders: List<Lazy<PluginLoader<*, *>>>

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

coroutineContext

open override val coroutineContext: CoroutineContext

isActive

@ConsoleExperimentalApi(message = "This is a low-level API and might be removed in the future.")

val isActive: Boolean

isAnsiSupported

@ConsoleExperimentalApi

open override val isAnsiSupported: Boolean

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

job

val job: Job

获取 MiraiConsole 的 Job

mainLogger

@ConsoleInternalApi

open override val mainLogger: MiraiLogger

Console 主日志.

pluginCenter

@ConsoleExperimentalApi

open override val pluginCenter: PluginCenter

pluginManager

open override val pluginManager: PluginManager

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

rootPath

open override val rootPath: Path

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

version

open override val version: SemVersion

此 Console 后端版本号