PluginConfig

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

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

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

实现

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

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

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

即可将一个 PluginData 变更为 PluginConfig.

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

abstract fun onValueChanged(value: Value<*>)

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

abstract val saveName: String

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

abstract val serializersModule: SerializersModule

序列化本对象数据时使用的 SerializersModule. 用于支持多态序列化等. 在序列化时会先使用 PluginData.serializersModule, 再对无法找到 serializer 的类型使用 MessageSerializers.serializersModule.

abstract val updaterSerializer: KSerializer<Unit>