跳到主要内容

小游戏管理

1. 游戏启动参数设置​

接口原型

void setGameStartOptions(Bundle options, OnTJHostHandleListener listener)

参数说明

参数数据类型必填属性说明
optionsandroid.os.Bundle是游戏初始化参数,以下为具体参数列表
TJRuntimeConstants.LAUNCH_KEYString是游戏启动项,支持游戏列表启动项,扫码启动项和最近启动项三种。
TJRuntimeConstants.USER_IDString是游戏用户
TJConstants.GAME_ENTRY_JSString否游戏入口 JavaScript 文件名, 值仅限于 game.js 或 main.js
TJConstants.ENABLE_DEBUGGERboolean否开启调试, 默认值为 false
TJConstants.ENABLE_VCONSOLEboolean否开启 vConsole, 更改开启或关闭需重启游戏,默认值为 false
TJConstants.ENABLE_PERFORMANCE_MONITORINGboolean否开启性能监控, 默认值为 false
TJConstants.ENABLE_CPU_PROFILERboolean否开启 CPU Profile, 默认值为 false
TJConstants.ENABLE_RUNTIME_CSHARP_DEBUGGERboolean否开启 C# 代码调试, 默认值为 false
TJConstants.NETWORK_TIMEOUTlong否网络超时时间,单位为毫秒。默认值为 60000
TJConstants.BUILTIN_CUSTOM_SCRIPTS_PATHString否加载拓展接口文件 custom.js 的路径
TJConstants.SHOW_MENU_LAYOUTboolean否开启菜单胶囊按钮, 默认值为 true
TJConstants.PIXEL_RATIOfloat否设置像素比例
TJConstants.ENABLE_INSPECTORboolean否开启 Chrome DevTools 调试, 默认值为 false
TJConstants.INSPECTOR_PORTint否Chrome DevTools 调试监听端口
TJConstants.INSPECTOR_HOSTString否Chrome DevTools 调试 host
TJConstants.INSPECTOR_WAIT_FOR_INSPECTboolean否在启动时等待 DevTools 连接, 默认值为 false
TJConstants.INSPECTOR_PAGE_INSPECTIONboolean否开启 Chrome DevTools Screencast, 默认值 false
TJConstants.DOMAIN_WHITELIST_REQUESTArrayList<String>否request 合法域名, 以 https:// 开头, 可填写 300 个域名
TJConstants.DOMAIN_WHITELIST_SOCKETArrayList<String>否socket 合法域名, 以 wss:// 开头, 可填写 200 个域名
TJConstants.DOMAIN_WHITELIST_UDPArrayList<String>否udp 合法域名, 以 udp:// 开头, 可填写 200 个域名。注:经 DNS 解析得到的 ip 也能通过白名单
TJConstants.DOMAIN_WHITELIST_TCPArrayList<String>否tcp 合法域名, 以 tcp:// 开头, 可填写 200 个域名。注:经 DNS 解析得到的 ip 也能通过白名单
TJConstants.DOMAIN_WHITELIST_UPLOAD_FILEArrayList<String>否uploadFile 合法域名, 以 https:// 开头, 可填写 200 个域名
TJConstants.ENABLE_TRANSPARENT_MODEboolean否是否支持游戏背景透明
TJRuntimeConstants.SHOW_MENU_EXPLORE_BTNboolean否胶囊按钮是否展示 ··· 更多按钮
TJRuntimeConstants.SPLASH_ICON_URLString否游戏加载页图片 URL
TJRuntimeConstants.SPLASH_GAME_TITLEString否游戏加载页游戏标题
TJRuntimeConstants.SPLASH_CAPSULE_RESERVE_STATUS_BARboolean否胶囊按钮是否额外保留系统顶部状态栏高度

代码示例

private TJHostHandle hostHandle;
...
Bundle bundle = new Bundle();
bundle.putString(TJConstants.GAME_ID, "gameid");
gameHandle.setGameStartOptions(bundle, new OnTJHostHandleListener() {
@Override
public void onSuccess() {
// startGame();
}

@Override
public void onFailure(Throwable throwable) {
Log.e(TAG, "Host set game start options failure", throwable);
}
});

游戏启动参数 LAUNCH_KEY 说明​

目前,游戏支持三种启动方式:游戏列表启动、二维码扫码启动和最近游玩列表启动。

  • 游戏列表启动:在游戏列表接口返回的对象中包含有 launchKey 字段,该字段需要在启动游戏时作为启动参数传入给 LAUNCH_KEY。
    • launchKey: 67da9d2961b25a25faf0b143
  • 二维码扫码启动:扫描二维码的结果作为启动参数传入给 LAUNCH_KEY。
    • 二维码扫码结果: https://minihost.tuanjie.cn/api/game_app/67da9d2961b25a25faf0b143/temp_session/a0f06587-3def-4a3a-95b2-89286bc325fa/start
  • 最近游玩列表启动:最近游玩对象中同样包含有 launchKey 字段,该字段也是作为启动参数传入给 LAUNCH_KEY。具体参考 最近游玩列表
    • 游戏列表启动时 launchKey: 67da9d2961b25a25faf0b143
    • 扫码体验启动时 launchKey: 67da9d2961b25a25faf0b143:67dcc8227ae013b09d23ad23

2. 开始游戏​

加载、编译游戏资源,游戏界面可见但不可交互,宿主状态转为 RUNNING。

接口原型

void start(String onShowMsg, OnTJHostHandleListener listener)

参数说明

参数数据类型必填属性说明
onShowMsgString否显示字符串
listenerOnTJHostHandleListener否onSuccess/onFailure 回调

3. 运行/恢复游戏​

游戏可交互或在 app 切换至前台时恢复运行,宿主状态转为 PLAYING。

接口原型

void play(OnTJHostHandleListener listener)

参数说明

参数数据类型必填属性说明
listenerOnTJHostHandleListener否onSuccess/onFailure 回调

4. 暂停游戏​

暂停游戏,宿主状态转为 RUNNING。

接口原型

void pause(OnTJHostHandleListener listener)

参数说明

参数数据类型必填属性说明
listenerOnTJHostHandleListener否onSuccess/onFailure 回调

5. 结束游戏​

结束游戏,宿主状态转为 WAITING。

接口原型

void stop(String onHideMsg, OnTJHostHandleListener listener)

参数说明

参数数据类型必填属性说明
onHideMsgString否隐藏字符串
listenerOnTJHostHandleListener否onSuccess/onFailure 回调

6. 设置宿主首帧渲染监听​

提供宿主首帧渲染后的回调

接口原型

void setOnFirstFrameRenderedListener(OnTJFirstFrameRenderedListener listener)

参数说明

参数数据类型必填属性说明
listenerOnTJFirstFrameRenderedListener否首帧回调

7. 设置宿主游戏包下载回调​

提供宿主游戏包下载的回调机制,此回调仅会在游戏包首次被下载时触发,若仅是读取缓存中的游戏包,则不会触发该回调。

接口原型

void setOnGamePackageDownloadListener(OnTJHostGamePackageDownloadHandleListener listener)

参数说明

参数数据类型必填属性说明
listenerOnTJHostGamePackageDownloadHandleListener否游戏包下载回调