PluginConfig

interface PluginConfig : PluginData

一个插件的配置数据, 用于和用户交互.

用户可通过 mirai-console 前端 (如在 Android 中可视化实现) 修改这些配置, 修改会自动写入这个对象中.

提示: 插件内部的数据应用 PluginData 存储, 而不能使用 PluginConfig.

实现

对使用者来说, PluginConfigPluginData 实现几乎相同. 目前仅需在 PluginData 使用的基础上添加接口实现即可.

Kotlin

PluginData 的示例基础上, 修改对象定义

// 原
object MyPluginData : AutoSavePluginData()
// 修改为
object MyPluginConfig : AutoSavePluginConfig()

即可将一个 PluginData 变更为 PluginConfig.

Java

JAutoSavePluginConfig

See also

Functions

onInit
Link copied to clipboard
abstract fun onInit(owner: PluginDataHolder, storage: PluginDataStorage)

当这个 PluginData 被放入一个 PluginDataStorage 时调用

onValueChanged
Link copied to clipboard
abstract fun onValueChanged(value: Value<*>)

当所属于这个 PluginDataValue 被修改时被调用. 调用者为 Value 的实现.

Properties

saveName
Link copied to clipboard
abstract val saveName: String

这个 PluginData 保存时使用的名称.

serializersModule
Link copied to clipboard
abstract val serializersModule: SerializersModule

用于支持多态序列化.

updaterSerializer
Link copied to clipboard
abstract val updaterSerializer: KSerializer<Unit>

Inheritors

AutoSavePluginConfig
Link copied to clipboard
ReadOnlyPluginConfig
Link copied to clipboard
JAutoSavePluginConfig
Link copied to clipboard
JAutoSavePluginData
Link copied to clipboard