生命周期
swan.getLaunchOptionsSync()
获得小游戏启动参数。
返回值:
Object
:
属性 | 类型 | 描述 |
---|---|---|
scene | number | 场景值 |
query | Object | 启动参数 |
referrerInfo | Object | 来源信息 |
referrerInfo 的结构
属性 | 类型 | 描述 |
---|---|---|
appId | string | 调起小游戏的 appId |
extraData | Object | 额外的信息 |
示例:
1 | const launchInfo = swan.getLaunchOptionsSync(); |
swan.onShow()
监听小游戏回到前台。
1 | swan.onShow(callback) |
参数值:
参数 | 类型 | 描述 |
---|---|---|
callback | function | 回调函数 |
参数
Object res
属性 | 类型 | 描述 |
---|---|---|
scene | number | 场景值 |
query | Object | 启动参数 |
shareTicket | string | shareTicket |
referrerInfo | Object | 由从另一个小程序或小游戏打开此小游戏时,返回此字段 |
referrerInfo 的结构
属性 | 类型 | 描述 |
---|---|---|
appKey | string | 来源小程序或小游戏的 appKey |
extraData | Object | 来源小程序或小游戏传过来的信息 |
swan.offShow()
撤销监听小游戏回到前台。
1 | swan.offShow(callback) |
参数值:
参数 | 类型 | 描述 |
---|---|---|
callback | function | 调用 swan.onShow() 时传入的回调函数 |
swan.onHide()
监听小游戏退到后台。
1 | swan.onHide(callback) |
参数值:
参数 | 类型 | 描述 |
---|---|---|
callback | function | 回调函数 |
swan.offHide()
撤销监听小游戏退到后台。
1 | swan.offHide(callback) |
参数值:
参数 | 类型 | 描述 |
---|---|---|
callback | function | 调用 swan.onHide() 时传入的回调函数 |
swan.reload()
从基础库 swan-game.js 1.10.x 开始支持。
重载小游戏。
1 | swan.reload(opts) |
参数值:
属性 | 类型 | 默认值 | 是否必填 | 描述 |
---|---|---|---|---|
opts | Object | - | - | 调用时,要传入的对象参数 |
opts.content | 将重新加载小游戏,确认? | 否 | 提示的内容 | |
opts.success | function | - | 否 | 接口调用成功的回调函数 |
opts.fail | function | - | 否 | 接口调用失败的回调函数 |
opts.complete | function | - | 否 | 接口调用完成的回调函数,无论失败成功都会调用 |
success
回调函数:
形如 function (res) {...}
,其中:
属性 | 类型 | 描述 |
---|---|---|
res.confirm | boolean | 为 true 时,表示用户点击了确定按钮(小游戏将会开始重启) |
res.cancel | boolean | 为 true 时,表示用户点击了取消按钮(弹窗消失,不会重启游戏) |
fail
回调函数:reload 弹窗未被调起,详情可打印 res.errMsg
。
示例:
1 | swan.reload({ |
swan.exit()
退出小游戏。
1 | swan.exit(opts) |
参数值:
属性 | 类型 | 描述 |
---|---|---|
opts | Object | 调用该时,要传入的对象参数 |
opts.success | function | 接口调用成功的回调函数 |
opts.fail | function | 接口调用失败的回调函数 |
opts.complete | function | 接口调用完成的回调函数,无论失败成功都会调用 |
swan.onDisplay()
从 基础库 1.11.3 开始支持
监听小游戏首次绘制上屏,此时loading页面会消失,看到游戏首页,首帧绘制逻辑不能放在该监听内部,否则因为没有任何绘制导致该API不回调,造成死锁。
1 | swan.onDisplay(function(res) { |
参数值:
参数 | 类型 | 描述 |
---|---|---|
callback | function | 回调函数 |
参数
Object res
属性 | 类型 | 描述 |
---|---|---|
startupTime | number | 小游戏启动时长,单位ms |
swan.offDisplay()
从 基础库 1.11.3 开始支持
取消监听小游戏首次绘制上屏。
1 | swan.offDisplay(callback) |
参数值:
参数 | 类型 | 描述 |
---|---|---|
callback | function | 调用 swan.onDispaly() 时传入的回调函数 |