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

KotlinPlugin

abstract class KotlinPlugin @JvmOverloads constructor(val description: JvmPluginDescription, parentCoroutineContext: CoroutineContext = EmptyCoroutineContext) : AbstractJvmPlugin, JvmPlugin

Kotlin 插件的父类.

Constructors

KotlinPlugin

@JvmOverloads

fun KotlinPlugin(description: JvmPluginDescription, parentCoroutineContext: CoroutineContext = EmptyCoroutineContext)

Functions

getResource

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?

获取一个资源文件.

onDisable

open fun onDisable()

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

onEnable

open fun onEnable()

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

onLoad

open fun PluginComponentStorage.onLoad()

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

permissionId

abstract fun permissionId(name: String): PermissionId

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

reload

@JvmName(name = "reloadPluginConfig")

fun <T : PluginConfig> T.reload()

重载 PluginConfig

@JvmName(name = "reloadPluginData")

fun <T : PluginData> T.reload()

重载 PluginData

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

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

save

@JvmName(name = "savePluginConfig")

fun <T : PluginConfig> T.save()

立即保存 PluginConfig

@JvmName(name = "savePluginData")

fun <T : PluginData> T.save()

立即保存 PluginData

Properties

autoSaveIntervalMillis

@ConsoleExperimentalApi

open override val autoSaveIntervalMillis: LongRange

AutoSavePluginData 每次自动保存时间间隔

configFolder

abstract val configFolder: File

插件配置保存路径

configFolderPath

abstract val configFolderPath: Path

插件配置保存路径

coroutineContext

abstract val coroutineContext: CoroutineContext

dataFolder

abstract val dataFolder: File

数据目录. dataFolderPath.toFile()

dataFolderPath

abstract val dataFolderPath: Path

数据目录路径

dataHolderName

@ConsoleExperimentalApi

override val dataHolderName: String

保存时使用的分类名

description

override val description: JvmPluginDescription

插件描述

isEnabled

abstract val isEnabled: Boolean

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

loader

open override val loader: JvmPluginLoader

所属插件加载器实例

logger

abstract val logger: MiraiLogger

日志

parentPermission

abstract val parentPermission: Permission

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