[单脚本][MyClearAttrGo] 玩家/全局属性管理器

厌倦了繁杂的数据单双端处理同步？
搞不清存档怎么从服务端透传到客户端显示？
不知道咋做数据变化监听？
是时候试试MyClearAttrGo了！一个全新的玩家/全局属性管理器！
支持四类常见数据的初始化、维护、获取、监听变化，
让你的游戏数据处理不再繁杂~
1. 下载导入MyClearAttrGo
MyClearAttrGo.ts (75.21 KB, 下载次数: 144)

2023-12-23 21:44 上传

点击文件名下载附件
* 版本：v0.1.5 2023.12.23
* 更新日志：
* 1. 修正玩家登录过于频繁时的处理
* 2. 修复changeNumberAttr中userid未传入的bug
* 3. 修复登录间隔检测导致初始化失败的bug
* 4. 修复玩家相关数据初始化时，未能触发onchange的bug
* 5. 修复含有玩家临时变量时崩溃的问题
* 6. 添加[双端]当玩家顺利加入游戏(服务端已下发存档信息，客户端已经可以获取存档信息)方法 onPlayerJoinGameSuccess
* 7. 增加根据PIE智能设置setTemporaryStorage，防止上线后游戏存不上的bug

* 8. 修复changeNumber改玩家相关值时出错的问题

下载后导入到编辑器中，并拖到场景里生效
2. 配置MyClearAttrGo
2.1. 添加自定义属性
格式如下
属性分类|属性名|属性类型|默认值
属性分类：玩家临时，玩家存档，全局临时，全局存档
属性名：属性名称，开发者自定义
变量类型：变量的类型，number，string，boolean
默认值：这个属性初始化时的默认值

玩家临时：进游戏时就初始化为默认值，离开后清除，不涉及玩家的存档，客户端监听范围：公开
玩家存档：进游戏时就读取存档，读取失败就踢出玩家，读取为空就初始化，发生变化就走小火车往数据库存，每隔一段时间(7s)往数据库存，离开时存一次，客户端监听范围：仅自己
全局临时：进游戏时就初始化，与具体玩家无关，客户端监听范围：公开
全局存档：进游戏时就读取数据库，读取为空就初始化并存入，其他时间只取不存作为一种“开关”，隔一段时间取一下(因为多个ds存的话很难确保准确性

举例：
玩家临时|Health|number|100
玩家存档|Money|number|50
全局临时|CurMap|string|只因乐园
      全局存档|DoubleEXP|boolean|false
1.2. 强制更新间隔

服务器定期向所有客户端强制同步下发所有临时属性，<0就不强制更新，建议间隔不宜太频繁
1.3. 退游重进间隔


一个玩家从游戏中退出(包含断线重连)后，必须经过多少秒后，才能再连入服务器获取存档
建议设置在7秒以上，防止退出时存档没存好就又在另一个房间获取存档
这种操作经常理论上能无限刷金币、道具等物品
不过也不宜设置过长，以免影响玩家游玩体验


2. 实用接口与拓展
这里还提供了一些实用的接口，方便大家进行接入和二创~
2.1. 功能方法

方法名	方法解释	调用端	参数	参数含义	返回值	返回值含义
getAttrValue	获取一个属性的值	双端	Key	属性名称	any	返回属性值
			userID	[选填]玩家userId
setAttrValue	设置一个属性的值	仅服务器	Key	属性名称	string	返回操作结果
			Value	该属性的值
			userID	[选填]玩家userId
changeNumberAttr	修改一个number类型属性的值	仅服务器	Key	属性名称	无	无返回值
			deltaNum	需要变化的值，正加负减
			userID	[选填]玩家userId

2.2. 事件接口

事件名	事件解释	调用端	参数	参数含义
onPlayerJoinGameSuccess	当玩家顺利加入游戏((服务端已下发存档信息，客户端已经可以获取存档信息))	双端	无
onAttrChange	当属性成功发生改变	双端	typeOfAttr	属性分类：玩家临时，玩家存档，全局临时，全局存档
			attrName	属性名：属性名称，开发者自定义
			attrInstanceType	变量的类型，number，string，boolean
			userID	玩家id，如果是系统变量就会返回"SystemAttr"
			newValue	这个属性变化后的值
			oldValue	[可选]这个属性变化前的值

3. 代码示例
以截图为例
S端改变某值 S端和C端都收到修改值的回调

import MyClearAttrGo from "./MyClearAttrGo";



@Component

export default class NewScript extends Script {

    /** 当脚本被实例后，会在第一帧更新前调用此函数 */

    protected onStart(): void {

        // 如果是服务器

        if (SystemUtil.isServer()) {

            // 服务器写属性改变的监听

            MyClearAttrGo.onAttrChange.push((typeOfAttr: string, attrName: string, attrInstanceType: string, userID: string, newValue: any, oldValue?: any) => {

                // 打印log

                console.log(attrName + "由" + oldValue + "变为" + newValue);

            })



            // 7秒后更改一下curmap

            setTimeout(() => {

                // 只有服务器有权限改值

                MyClearAttrGo.setAttrValue("curmap", "新地图")

            }, 7000);

        }

        // 如果是客户端

        else if (SystemUtil.isClient()) {

            // 给客户端增加监听，如果属性改变后客户端可以做动作如修改UI

            MyClearAttrGo.onAttrChange.push((typeOfAttr: string, attrName: string, attrInstanceType: string, userID: string, newValue: any, oldValue?: any) => {

                // 打印log

                console.log(attrName + "由" + oldValue + "变为" + newValue);

            })

        }

    }

}

偶发报错：
OnMyPlayerStateChange方法下的报错，不是一个function。

if (MyClearAttrGo.instance.Map_attrSettingNode.has(key)) {

解决方案：
在OnMyPlayerStateChange中对长度做个判断，如果为0，不执行。

if(MyClearAttrGo.instance.Map_attrSettingNode.size === 0) {

        return

      }