typescript版本接入
接入前配置
若项目为typescript项目,在ts.config.json
的lib
字段中加入下面依赖:
{
"compilerOptions": {
"target": "es5",
"outDir": "bin-debug",
"experimentalDecorators": true,
"lib": [
"es5",
"dom",
"es2015.promise"
],
"types": []
},
"include": [
"src",
"libs"
]
}
引入插件脚本
将RecommendUI.ts放到工程目录文件夹中。全局可访问到mgplugin
对象。
创建插件实例并插入到场景节点
如代码所示:
let t:mplugin.RecommendUI = new mgplugin.RecommendUI({
appid: 'wx8dfsfd23ea24tf3',
openid: 'u7i90dfjh3sd0fw3',
onHide: function(): void {
console.log('hide');
}
});
Laya.stage.addChild(t);
参数分别为:
- appid: 游戏appid
- openid: 当前用户openid
- onHide: 插件UI隐藏时执行的回调
onHide参数也可通过onHide方法注册
t.onHide(function(): void {
console.log('hide');
})
v1.0.3
版本后,新增插件入口和红点显示控制功能。需要在游戏场景中创建插件入口按钮节点entrance
和红点节点reddot
,节点要求为Laya.Sprite的类型即可。
let t:mplugin.RecommendUI = new mgplugin.RecommendUI({
appid: 'wx8dfsfd23ea24tf3',
openid: 'u7i90dfjh3sd0fw3',
entranceNode:entrance,
reddotNode: reddot,
onHide: function(): void {
console.log('hide');
}
});
Laya.stage.addChild(t);
最后游戏方需要提供一个插件显示入口按钮,按钮绑定点击事件回调,调用show方法显示插件UI:
t.show()
actionscript版本接入
将RecommendUI.ts放到工程目录文件夹中,并引入mgplugin模块:
import mgpluin.RecommendUI
创建插件实例并插入到场景节点
let t:RecommendUI = new RecommendUI({
appid: 'wx8dfsfd23ea24tf3',
openid: 'u7i90dfjh3sd0fw3',
onHide: function(): void {
console.log('hide');
}
});
Laya.stage.addChild(t);
参数与typescript版本相同。
v1.0.3
版本开始,新增插件入口和红点显示控制功能。需要在游戏场景中创建插件入口按钮节点entrance
和红点节点reddot
,节点要求为Laya.Sprite的类型即可。(目前尚未发布)
let t:RecommendUI = new RecommendUI({
appid: 'wx8dfsfd23ea24tf3',
openid: 'u7i90dfjh3sd0fw3',
entranceNode:entrance,
reddotNode: reddot,
onHide: function(): void {
console.log('hide');
}
});
Laya.stage.addChild(t);
同样游戏方需要提供插件显示入口按钮,调用show方法显示插件。
注意
插件入口的显示控制
建议游戏方对插件的显示通过运营管理端进行配置,这样如果插件部分出问题,可以通过管理端配置立即关闭游戏插件的显示,避免影响用户体验。
插件的节点管理
一般插件的实例都只有一个,请注意插件节点的生命周期管理,避免插件被意外销毁或意外创建多个实例节点。
数据上报验证
接入完成后需通知腾讯的产品同学(Yalihuang、linlinyang、yeetian)进行数据上报验证,验证完毕后方可发布上线。
另外,接入完成后请游戏侧进行适配测试,重点关注iphoneX适配问题。