Merge new documentation

This commit is contained in:
2022-04-09 01:37:12 +08:00
parent c3fbaf553f
commit a455eec5de
52 changed files with 8270 additions and 104 deletions

View File

@@ -0,0 +1,59 @@
## PrefsData [class]
```kotlin
data class PrefsData<T>(var key: String, var value: T)
```
<b>变更记录</b>
`v1.0.67` `新增`
<b>功能描述</b>
> 键值对存储构造类。
这个类是对 `YukiHookModulePrefs` 的一个扩展用法。
<b>功能示例</b>
建立一个模板类定义模块与宿主需要使用的键值数据。
> 示例如下
```kotlin
object DataConst {
val TEST_KV_DATA_1 = PrefsData("test_data_1", "defalut value")
val TEST_KV_DATA_2 = PrefsData("test_data_2", false)
val TEST_KV_DATA_3 = PrefsData("test_data_3", 0)
}
```
键值数据定义后,你就可以方便地在模块和宿主中调用所需要的数据。
> 模块示例如下
```kotlin
// 读取
val data = modulePrefs.get(DataConst.TEST_KV_DATA_1)
// 写入
modulePrefs.put(DataConst.TEST_KV_DATA_1, "written value")
```
> 宿主示例如下
```kotlin
// 读取 String
val dataString = prefs.get(DataConst.TEST_KV_DATA_1)
// 读取 Boolean
val dataBoolean = prefs.get(DataConst.TEST_KV_DATA_2)
```
你依然可以不使用模板定义的默认值,随时修改你的默认值。
> 示例如下
```kotlin
// 读取 - 此时 data 取到的默认值将会是 2 - 并不是模板提供的 0
val data = prefs.get(DataConst.TEST_KV_DATA_3, 2)
```