索引
| 接口 | 端 | 描述 |
|---|---|---|
| SetModRenderAttrByKey | 双端 | 设置存储于实体数据新的值(仅限于本存档) |
| GetModRenderAttrByKey | 双端 | 获取存储于实体数据的值 |
| LocalConfigData | 客户端 | 存储或获取本地存储数据 |
| GetModConfigValue | 客户端 | 获取模组设置的值，没有则返回None |
SetModRenderAttrByKey
双端
-
描述
设置存储于实体数据新的值(仅限于本存档) -
服务端参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| EntityId | str | 实体id |
| DataKey | str | 数据Key |
| Value | dict | 数据值 |
- 客户端参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| EntityId | str | 实体id |
| DataKey | str | 数据Key |
| Value | dict | 数据值 |
-
返回值
无 -
备注
- 当EntityId为自定义str时，存档效果将失效。
- 客户端使用该接口时，仅客户端缓存数据，不存档！
-
示例 空
GetModRenderAttrByKey
双端
-
描述
获取存储于实体数据的值 -
参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| EntityId | str | 实体id |
| DataKey | str | 数据Key |
| OnlyClient | bool | 用于获取仅客户端缓存的数据，默认为False |
-
返回值
- SetModRenderAttrByKey存储的数据(dict)
- UseServerApi开启OnlyClient返回的数据(any)
-
备注
无 -
示例 空
LocalConfigData
客户端
-
描述
存储或获取本地存储数据 -
参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| Key | str | 数据的名称，用于区别不同的本地数据 |
| Dict | dict | 数据内容，默认为None则为获取并返回该Key的数据，反之不为None则是存储数据 |
| IsGlobal | bool | 为True时是全局配置，否则为存档配置，默认为False |
-
返回值
存储或获取本地存储数据 (dict) -
备注
无 -
示例 空
GetModConfigValue
客户端
-
描述
获取模组设置的值 -
参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ModName | str | 指config.ModName |
| Key | str | 对应设置配置数据中的Key，默认为None，则获取该模组所有的设置值 |
-
返回值
模组设置的值，没有则返回None (bool, float, int, str) -
备注
无 -
示例 空
