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

Package net.mamoe.mirai.console.data

Types

AbstractPluginData

abstract class AbstractPluginData : PluginDataImpl, PluginData

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

AutoSavePluginConfig

open class AutoSavePluginConfig(saveName: String) : AutoSavePluginData, PluginConfig

链接自动保存的 PluginConfig.

AutoSavePluginData

open class AutoSavePluginData : AbstractPluginData

链接自动保存的 PluginData.

AutoSavePluginDataHolder

@ConsoleExperimentalApi

interface AutoSavePluginDataHolder : PluginDataHolder, CoroutineScope

可以持有相关 AutoSavePluginData 的对象.

BooleanValue

@ConsoleExperimentalApi

interface BooleanValue : PrimitiveValue<Boolean>

表示一个不可空 Boolean.

ByteValue

@ConsoleExperimentalApi

interface ByteValue : PrimitiveValue<Byte>

表示一个不可空 Byte.

CharValue

@ConsoleExperimentalApi

interface CharValue : PrimitiveValue<Char>

表示一个不可空 Char.

CompositeListValue

@ConsoleExperimentalApi

interface CompositeListValue<E> : ListValue<E>

复合数据类型的 List

CompositeMapValue

@ConsoleExperimentalApi

interface CompositeMapValue<K, V> : MapValue<K, V>

CompositeSetValue

@ConsoleExperimentalApi

interface CompositeSetValue<E> : SetValue<E>

复合数据类型 Set

CompositeValue

@ConsoleExperimentalApi

interface CompositeValue<T> : Value<T>

复合数据类型实现

DoubleValue

@ConsoleExperimentalApi

interface DoubleValue : PrimitiveValue<Double>

表示一个不可空 Double.

FloatValue

@ConsoleExperimentalApi

interface FloatValue : PrimitiveValue<Float>

表示一个不可空 Float.

IntValue

@ConsoleExperimentalApi

interface IntValue : PrimitiveValue<Int>

表示一个不可空 Int.

ListValue

interface ListValue<E> : CompositeValue<List<E>>

LongValue

@ConsoleExperimentalApi

interface LongValue : PrimitiveValue<Long>

表示一个不可空 Long.

MapValue

@ConsoleExperimentalApi

interface MapValue<K, V> : CompositeValue<Map<K, V>>

MemoryPluginDataStorage

@ConsoleExperimentalApi

interface MemoryPluginDataStorage : PluginDataStorage

在内存存储所有 PluginData 实例的 PluginDataStorage. 在内存数据丢失后相关 PluginData 实例也会丢失.

MultiFilePluginDataStorage

@ConsoleExperimentalApi

interface MultiFilePluginDataStorage : PluginDataStorage

用多个文件存储 PluginData 实例的 PluginDataStorage.

PluginConfig

interface PluginConfig : PluginData

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

PluginData

@NotStableForInheritance

interface PluginData

一个插件内部的, 对用户隐藏的数据对象. 可包含对多个 Value 的值变更的跟踪. 典型的实现为 AbstractPluginData.

PluginDataExtensions

object PluginDataExtensions

PluginData 相关一些扩展

PluginDataHolder

@ConsoleExperimentalApi

interface PluginDataHolder

可以持有相关 PluginData 实例的对象, 作为 PluginData 实例的拥有者.

PluginDataStorage

@ConsoleExperimentalApi

interface PluginDataStorage

数据对象存储仓库.

PrimitiveIntIntMapValue

@ConsoleExperimentalApi

interface PrimitiveIntIntMapValue : PrimitiveMapValue<Int, Int>

PrimitiveIntListValue

@ConsoleExperimentalApi

interface PrimitiveIntListValue : PrimitiveListValue<Int>

PrimitiveIntLongMapValue

@ConsoleExperimentalApi

interface PrimitiveIntLongMapValue : PrimitiveMapValue<Int, Long>

PrimitiveIntSetValue

@ConsoleExperimentalApi

interface PrimitiveIntSetValue : PrimitiveSetValue<Int>

PrimitiveListValue

@ConsoleExperimentalApi

interface PrimitiveListValue<E> : ListValue<E>

针对基础类型优化的 List

PrimitiveLongListValue

@ConsoleExperimentalApi

interface PrimitiveLongListValue : PrimitiveListValue<Long>

PrimitiveLongSetValue

@ConsoleExperimentalApi

interface PrimitiveLongSetValue : PrimitiveSetValue<Long>

PrimitiveMapValue

@ConsoleExperimentalApi

interface PrimitiveMapValue<K, V> : MapValue<K, V>

PrimitiveSetValue

@ConsoleExperimentalApi

interface PrimitiveSetValue<E> : SetValue<E>

基础数据类型 Set

PrimitiveValue

@ConsoleExperimentalApi

interface PrimitiveValue<T> : Value<T>

基础数据类型 Value

ReadOnlyPluginConfig

open class ReadOnlyPluginConfig(saveName: String) : ReadOnlyPluginData, PluginConfig

只读的 PluginConfig. 插件只能读取其值, 但值可能在后台被前端 (用户) 修改.

ReadOnlyPluginData

open class ReadOnlyPluginData : AbstractPluginData

只读的 PluginData. 插件只能读取其值, 但值可能在后台被前端 (用户) 修改.

ReferenceValue

@ConsoleExperimentalApi

interface ReferenceValue<T> : Value<T>

SerializableValue

class SerializableValue<T>(delegate: Value<T>, val serializer: KSerializer<Unit>) : Value<T> , SerializerAwareValue<T>

可被序列化的 Value.

SerializerAwareValue

interface SerializerAwareValue<T> : Value<T>

带有显式序列化器的 Value.

SetValue

@ConsoleExperimentalApi

interface SetValue<E> : CompositeValue<Set<E>>

ShortValue

@ConsoleExperimentalApi

interface ShortValue : PrimitiveValue<Short>

表示一个不可空 Short.

StringValue

@ConsoleExperimentalApi

interface StringValue : PrimitiveValue<String>

表示一个不可空 String.

Value

interface Value<T> : ReadWriteProperty<Any?, T>

表示一个值代理.

ValueDescription

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.CLASS])

annotation class ValueDescription(val value: String)

序列化之后的注释.

ValueName

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.CLASS])

annotation class ValueName(val value: String)

序列化之后的名称.

Functions

findBackingFieldValue

@ConsoleExperimentalApi

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

@ConsoleExperimentalApi

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

获取这个 KProperty 委托的 Value

findBackingFieldValueNode

@ConsoleExperimentalApi

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

获取这个 KProperty 委托的 Value

value

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, 并设置初始值.

valueFromKType

@ConsoleExperimentalApi

fun <T> PluginData.valueFromKType(type: KType, default: T): SerializerAwareValue<T>

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

Package net.mamoe.mirai.console.data

Types

Functions

Properties