前言
egret版本仅提供typescript版本代码,若游戏方使用javascript开发,请使用编译工具将ts版本编译成js版本使用。
引入代码文件
将脚本放入项目目录中,游戏代码可访问到插件模块对象mgpluin
。
实例化插件并插入到游戏场景
游戏场景中创建插件入口节点entrance和红点节点reddot,节点要求为继承egret.DisplayObject的类型即可。
调用下面代码创建插件实例节点:
let recommendUI = new mgplugin.RecommendUI({
appid: 'wxd0e8g3dfhrryrt',
openid: 'as34fd2u55lzxfs',
onClose: function(): void {
console.log('close');
}
})
传入的options对象有三个参数:
- appid: 游戏appid
- openid: 当前用户openid
- onClose: 可选参数,插件游戏UI隐藏时的回调。
v1.0.4
版本开始,新增插件入口和红点显示控制功能。需要在游戏场景中创建插件入口按钮节点entrance
和红点节点reddot
,节点要求为Sprite的类型即可。(目前尚未发布)
let recommendUI = new mgplugin.RecommendUI({
appid: 'wxd0e8g3dfhrryrt',
openid: 'as34fd2u55lzxfs',
entranceNode: entrance,
reddotNode: reddot,
onClose: function(): void {
console.log('close');
}
})
将节点插入到游戏场景:
this.addChild(recommendUI); // this为游戏场景节点
创建入口按钮并绑定事件
插件由游戏方创建一个入口按钮控制其显示,通过绑定点击事件调用实例的show方法:
button.addEventListener(egret.TouchEvent.TOUCH_TAP, function(): void {
recommendUI.show();
}, this);
建议游戏方对插件的显示通过运营管理端进行配置,这样如果插件部分出问题,可以通过管理端配置立即关闭游戏插件的显示,避免影响用户体验。
数据上报验证
接入完成后需通知腾讯的产品同学(Yalihuang、linlinyang、yeetian)进行数据上报验证,验证完毕后方可发布上线。
另外,接入完成后请游戏侧进行适配测试,重点关注iphoneX适配问题。