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

JvmPlugin

interface JvmPlugin : Plugin, CoroutineScope, PluginFileExtensions, ResourceContainer, PermissionIdNamespace

Java, Kotlin 或其他 JVM 平台插件

See also

AbstractJvmPlugin

默认实现

Java 插件

Kotlin 插件

支持文件系统扩展

ResourceContainer

支持资源获取 (如 Jar 中的资源文件)

Inheritors

AbstractJvmPlugin

Types

object Companion

Functions

inline fun Plugin.disable()

inline fun Plugin.enable()

open fun getResource(path: String): String?

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

open fun getResource(path: String, charset: Charset): String?

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

getResourceAsStream

abstract fun getResourceAsStream(path: String): InputStream?

获取一个资源文件.

inline fun Plugin.load()

open fun onDisable()

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

open fun onEnable()

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

open fun PluginComponentStorage.onLoad()

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

inline fun JvmPlugin.onLoad(storage: PluginComponentStorage)

abstract fun permissionId(name: String): PermissionId

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

resolveConfigFile

open fun resolveConfigFile(relativePath: Path): File

open fun resolveConfigFile(relativePath: String): File

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

resolveConfigPath

open fun resolveConfigPath(relativePath: Path): Path

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

open fun resolveConfigPath(relativePath: String): Path

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

resolveDataFile

open fun resolveDataFile(relativePath: Path): File

open fun resolveDataFile(relativePath: String): File

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

resolveDataPath

open fun resolveDataPath(relativePath: Path): Path

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

open fun resolveDataPath(relativePath: String): Path

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

inline fun CommandOwner.unregisterAll()

Properties

val Plugin.author: String

获取 PluginDescription.author

abstract val configFolder: File

插件配置保存路径

configFolderPath

abstract val configFolderPath: Path

插件配置保存路径

coroutineContext

abstract val coroutineContext: CoroutineContext

abstract val dataFolder: File

数据目录. dataFolderPath.toFile()

abstract val dataFolderPath: Path

数据目录路径

val Plugin.dependencies: Set<PluginDependency>

获取 PluginDescription.dependencies

abstract val description: JvmPluginDescription

插件描述

val Plugin.description: PluginDescription

val Plugin.id: String

获取 PluginDescription.id

val Plugin.info: String

获取 PluginDescription.info

abstract val isEnabled: Boolean

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

open override val loader: JvmPluginLoader

所属插件加载器实例

abstract val logger: MiraiLogger

日志

val Plugin.name: String

获取 PluginDescription.name

parentPermission

abstract val parentPermission: Permission

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

registeredCommands

@get:JvmName(name = "registeredCommands0")

val CommandOwner.registeredCommands: List<Command>

val Plugin.version: SemVersion

获取 PluginDescription.version