mirai-console/net.mamoe.mirai.console.data/AbstractPluginData

AbstractPluginData

abstract class AbstractPluginData : PluginDataImpl, PluginData

PluginData 的默认实现. 支持使用 by value() 等委托方法创建 Value 并跟踪其改动.

实现注意

此类型处于实验性阶段. 使用其中定义的属性和函数是安全的, 但将来可能会新增成员抽象函数.

Constructors

AbstractPluginData

fun AbstractPluginData()

Types

ValueNode

@ConsoleExperimentalApi

data class ValueNode<T>(valueName: String, value: Value<out T>, annotations: List<Annotation>, updaterSerializer: KSerializer<Unit>)

由 track 创建, 来自一个通过 by value 初始化的属性节点.

Functions

onInit

@ConsoleExperimentalApi

open override fun onInit(owner: PluginDataHolder, storage: PluginDataStorage)

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

onValueChanged

@ConsoleExperimentalApi

open override fun onValueChanged(value: Value<*>)

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

provideDelegate

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

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

track

@ConsoleExperimentalApi

open fun <T : SerializerAwareValue<*>> track(value: T, valueName: String, annotations: List<Annotation>): T

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

Properties

saveName

abstract override val saveName: String

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

serializersModule

@ConsoleExperimentalApi

open override val serializersModule: SerializersModule

用于支持多态序列化.

updaterSerializer

@ConsoleExperimentalApi

override val updaterSerializer: KSerializer<Unit>

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

valueNodes

@ConsoleExperimentalApi

val valueNodes: MutableList<AbstractPluginData.ValueNode<*>>

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

Inheritors

AutoSavePluginData

ReadOnlyPluginData

Extensions

findBackingFieldValue

@ConsoleExperimentalApi

fun <T> AbstractPluginData.findBackingFieldValue(property: KProperty<T>): Value<out T>?

@ConsoleExperimentalApi

fun <T> AbstractPluginData.findBackingFieldValue(propertyValueName: String): Value<out T>?

获取这个 KProperty 委托的 Value

findBackingFieldValueNode

@ConsoleExperimentalApi

fun <T> AbstractPluginData.findBackingFieldValueNode(property: KProperty<T>): AbstractPluginData.ValueNode<out T>?

获取这个 KProperty 委托的 Value

AbstractPluginData

实现注意

See also

Constructors

Types

Functions

Properties

Inheritors

Extensions