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

JavaPlugin

abstract class JavaPlugin : AbstractJvmPlugin, JvmPlugin

Java 插件的父类

Constructors

Link copied to clipboard
@JvmOverloads
constructor(description: JvmPluginDescription, parentCoroutineContext: CoroutineContext = EmptyCoroutineContext)

通过一个指定的 JvmPluginDescription 构造插件示例

@JvmOverloads
constructor(parentCoroutineContext: CoroutineContext = EmptyCoroutineContext)

通过插件内置的 plugin.yml 构造插件实例

Functions

Link copied to clipboard
inline fun Plugin.disable()
Link copied to clipboard
inline fun Plugin.enable()
Link copied to clipboard
open fun getResource(path: String): String?

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

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

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

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

获取一个资源文件.

Link copied to clipboard
inline fun Plugin.load()
Link copied to clipboard
open fun onDisable()

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

Link copied to clipboard
open fun onEnable()

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

Link copied to clipboard
open fun PluginComponentStorage.onLoad()

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

inline fun JvmPlugin.onLoad(storage: PluginComponentStorage)
Link copied to clipboard
abstract fun permissionId(name: String): PermissionId

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

Link copied to clipboard
@JvmName(name = "reloadPluginConfig")
fun <T : PluginConfig> T.reload()

重载 PluginConfig

@JvmName(name = "reloadPluginData")
fun <T : PluginData> T.reload()

重载 PluginData

Link copied to clipboard
Link copied to clipboard
inline fun AbstractJvmPlugin.reloadPluginData(instance: PluginData)

重载一个 PluginData

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

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

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

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

open fun resolveConfigPath(relativePath: String): Path

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

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

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

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

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

open fun resolveDataPath(relativePath: String): Path

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

Link copied to clipboard
@JvmName(name = "savePluginConfig")
fun <T : PluginConfig> T.save()

立即保存 PluginConfig

@JvmName(name = "savePluginData")
fun <T : PluginData> T.save()

立即保存 PluginData

Link copied to clipboard
inline fun AbstractJvmPlugin.savePluginConfig(instance: PluginConfig)

立即保存 PluginConfig

Link copied to clipboard
inline fun AbstractJvmPlugin.savePluginData(instance: PluginData)

立即保存 PluginData

Link copied to clipboard

Properties

Link copied to clipboard
Link copied to clipboard
@ConsoleExperimentalApi
open override val autoSaveIntervalMillis: LongRange

AutoSavePluginData 每次自动保存时间间隔

Link copied to clipboard
abstract val configFolder: File

插件配置保存路径

Link copied to clipboard
abstract val configFolderPath: Path

插件配置保存路径

Link copied to clipboard
Link copied to clipboard
abstract val dataFolder: File

数据目录. dataFolderPath.toFile()

Link copied to clipboard
abstract val dataFolderPath: Path

数据目录路径

Link copied to clipboard
@ConsoleExperimentalApi
override val dataHolderName: String

保存时使用的分类名

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

插件描述

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

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

Link copied to clipboard
open override val loader: JvmPluginLoader

所属插件加载器实例

Link copied to clipboard
abstract val logger: MiraiLogger

日志

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

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

Link copied to clipboard
@get:JvmName(name = "registeredCommands0")
val CommandOwner.registeredCommands: List<Command>
Link copied to clipboard
val scheduler: JavaPluginScheduler

Java API Scheduler

Link copied to clipboard