mirai-console/net.mamoe.mirai.console.data.java/JavaAutoSavePluginConfig

JavaAutoSavePluginConfig

abstract class JavaAutoSavePluginConfig(saveName: String) : JavaAutoSavePluginData, PluginConfig

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

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

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

实现

在 JavaAutoSavePluginData 的示例基础上, 修改类定义

// 原
public class AccountPluginData extends JavaAutoSavePluginData {
// 修改为
public class AccountPluginConfig extends JavaAutoSavePluginConfig {
Content copied to clipboard

即可将一个 PluginData 变更为 PluginConfig.

Since

2.11

See also

Constructors

Link copied to clipboard
constructor(saveName: String)

Functions

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@ConsoleExperimentalApi
open override fun onInit(owner: PluginDataHolder, storage: PluginDataStorage)

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

Link copied to clipboard
@ConsoleExperimentalApi
override fun onValueChanged(value: Value<*>)

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

Link copied to clipboard
operator fun <T : SerializerAwareValue<*>> T.provideDelegate(thisRef: Any?, property: KProperty<*>): T

使用 by value() 时自动调用此方法, 添加对 Value 的值修改的跟踪, 并创建 ValueNode 加入 valueNodes

Link copied to clipboard
@ConsoleExperimentalApi
open fun <T : SerializerAwareValue<*>> track(value: T, valueName: String, annotations: List<Annotation>): T

供手动实现时值跟踪使用 (如 Java 用户). 一般 Kotlin 用户需使用 provideDelegate

Link copied to clipboard
@JvmOverloads
fun <T : Any> typedValue(name: String, type: KType, default: T? = null): SerializerAwareValue<T>

创建一个支持泛型的 Value.

Link copied to clipboard
fun value(name: String, default: Boolean): SerializerAwareValue<Boolean>

创建一个名称为 name, 类型为 Boolean 的 Value, 并设置初始值为 default.

fun value(name: String, default: Byte): SerializerAwareValue<Byte>

创建一个名称为 name, 类型为 Byte 的 Value, 并设置初始值为 default.

fun value(name: String, default: Char): SerializerAwareValue<Char>

创建一个名称为 name, 类型为 Char 的 Value, 并设置初始值为 default.

fun value(name: String, default: Double): SerializerAwareValue<Double>

创建一个名称为 name, 类型为 Double 的 Value, 并设置初始值为 default.

fun value(name: String, default: Float): SerializerAwareValue<Float>

创建一个名称为 name, 类型为 Float 的 Value, 并设置初始值为 default.

fun value(name: String, default: Int): SerializerAwareValue<Int>

创建一个名称为 name, 类型为 Int 的 Value, 并设置初始值为 default.

fun value(name: String, default: Long): SerializerAwareValue<Long>

创建一个名称为 name, 类型为 Long 的 Value, 并设置初始值为 default.

fun value(name: String, default: Short): SerializerAwareValue<Short>

创建一个名称为 name, 类型为 Short 的 Value, 并设置初始值为 default.

fun value(name: String, default: String): SerializerAwareValue<String>

创建一个名称为 name, 类型为 String 的 Value, 并设置初始值为 default.

Link copied to clipboard
fun PluginData.value(default: Boolean): SerializerAwareValue<Boolean>

创建一个 Boolean 类型的 Value, 并设置初始值为 default

fun PluginData.value(default: Byte): SerializerAwareValue<Byte>

创建一个 Byte 类型的 Value, 并设置初始值为 default

fun PluginData.value(default: Char): SerializerAwareValue<Char>

创建一个 Char 类型的 Value, 并设置初始值为 default

fun PluginData.value(default: Double): SerializerAwareValue<Double>

创建一个 Double 类型的 Value, 并设置初始值为 default

fun PluginData.value(default: Float): SerializerAwareValue<Float>

创建一个 Float 类型的 Value, 并设置初始值为 default

inline fun <T> PluginData.value(apply: T.() -> Unit = {}): SerializerAwareValue<T>

通过具体化类型创建一个 SerializerAwareValue.

fun PluginData.value(default: Int): SerializerAwareValue<Int>

创建一个 Int 类型的 Value, 并设置初始值为 default

fun PluginData.value(default: Long): SerializerAwareValue<Long>

创建一个 Long 类型的 Value, 并设置初始值为 default

fun PluginData.value(default: Short): SerializerAwareValue<Short>

创建一个 Short 类型的 Value, 并设置初始值为 default

fun PluginData.value(default: String): SerializerAwareValue<String>

创建一个 String 类型的 Value, 并设置初始值为 default

inline fun <T> PluginData.value(default: T, crossinline apply: T.() -> Unit = {}): SerializerAwareValue<T>

通过具体化类型创建一个 SerializerAwareValue, 并设置初始值.

Link copied to clipboard
@ConsoleExperimentalApi
fun <T> PluginData.valueFromKType(type: KType, default: T): SerializerAwareValue<T>

通过一个特定的 KType 创建 Value, 并设置初始值.

Properties

Link copied to clipboard
@ConsoleExperimentalApi
override val saveName: String

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

Link copied to clipboard
@ConsoleExperimentalApi
open val saveType: PluginData.SaveType

决定这个 PluginData 序列化时使用的格式, 默认为 YAML. 具体实现格式由 PluginDataStorage 决定.

Link copied to clipboard
open override val serializersModule: SerializersModule

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

Link copied to clipboard
@ConsoleExperimentalApi
override val updaterSerializer: KSerializer<Unit>

所有 valueNodes 更新和保存序列化器.

Link copied to clipboard
@ConsoleExperimentalApi
val valueNodes: MutableList<AbstractPluginData.ValueNode<*>>

添加了追踪的 ValueNode 列表, 即通过 by value 初始化的属性列表.