mirai-console/net.mamoe.mirai.console.plugin.jvm/JvmPlugin

JvmPlugin

interface JvmPlugin : Plugin, CoroutineScope, PluginFileExtensions, ResourceContainer, PermissionIdNamespace
Content copied to clipboard

Java, Kotlin 或其他 JVM 平台插件

See also

Types

Link copied to clipboard
object Companion
Content copied to clipboard

Functions

Link copied to clipboard
open fun getResource(path: String): String?
Content copied to clipboard

读取一个资源文件并以 Charsets.UTF_8 解码为 String.

open fun getResource(path: String, charset: Charset): String?
Content copied to clipboard

读取一个资源文件并以 charset 解码为 String.

Link copied to clipboard
abstract fun getResourceAsStream(path: String): InputStream?
Content copied to clipboard

获取一个资源文件.

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

在插件被关闭时调用, 可能会被调用多次

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

在插件被启用时调用, 可能会被调用多次

Link copied to clipboard
open fun PluginComponentStorage.onLoad()
Content copied to clipboard

在插件被加载时调用. 只会被调用一次.

Link copied to clipboard
abstract fun permissionId(name: String): PermissionId
Content copied to clipboard

创建一个此命名空间下的 PermitteeId.

Link copied to clipboard
open fun resolveConfigFile(relativePath: Path): File
Content copied to clipboard
open fun resolveConfigFile(relativePath: String): File
Content copied to clipboard

从配置目录获取一个文件.

Link copied to clipboard
open fun resolveConfigPath(relativePath: Path): Path
Content copied to clipboard

从配置目录获取一个文件路径.

open fun resolveConfigPath(relativePath: String): Path
Content copied to clipboard

从配置目录获取一个文件.

Link copied to clipboard
open fun resolveDataFile(relativePath: Path): File
Content copied to clipboard
open fun resolveDataFile(relativePath: String): File
Content copied to clipboard

从数据目录获取一个文件.

Link copied to clipboard
open fun resolveDataPath(relativePath: Path): Path
Content copied to clipboard

从数据目录获取一个文件路径.

open fun resolveDataPath(relativePath: String): Path
Content copied to clipboard

从数据目录获取一个文件.

Properties

Link copied to clipboard
abstract val configFolder: File
Content copied to clipboard

插件配置保存路径

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

插件配置保存路径

Link copied to clipboard
abstract val coroutineContext: CoroutineContext
Content copied to clipboard
Link copied to clipboard
abstract val dataFolder: File
Content copied to clipboard

数据目录. dataFolderPath.toFile()

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

数据目录路径

Link copied to clipboard
abstract val description: JvmPluginDescription
Content copied to clipboard

插件描述

Link copied to clipboard
abstract val isEnabled: Boolean
Content copied to clipboard

当插件已启用时返回 true, 否则表示插件未启用.

Link copied to clipboard
open override val loader: JvmPluginLoader
Content copied to clipboard

所属插件加载器实例

Link copied to clipboard
abstract val logger: MiraiLogger
Content copied to clipboard

日志

Link copied to clipboard
abstract val parentPermission: Permission
Content copied to clipboard

在构造指令时, Command.permission 默认会使用 parentPermission 作为 Permission.parent

Inheritors

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

Extensions

Link copied to clipboard
inline fun JvmPlugin.onLoad(storage: PluginComponentStorage)
Content copied to clipboard