# lock-step.createGameRoom
本接口应在服务器端调用,详细说明参见服务端API。
第三方后台创建帧同步游戏房间
# 请求地址
POST https://api.weixin.qq.com/wxa/createwxagameroom?access_token=ACCESS_TOKEN
# 请求参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
access_token / cloudbase_access_token | string | 是 | 微信后台接口调用凭证 | |
game_tick | number | 是 | 后台下发游戏逻辑帧的周期,单位ms,最小不得小于33ms | |
open_id_list | Array.<string> | 是 | 房间成员的OpenId列表 | |
udp_reliability_strategy | number | 是 | 使用的UDP可靠性策略,N:固定冗余N帧。建议值:3 | |
start_percent | number | 是 | 不填或者填0代表微信后台只要收到一次“开始游戏”指令就会开始游戏,否则微信后台会统计发送“开始游戏”指令的玩家数达到规定的百分比后才能启动游戏,填50表征50% | |
need_user_info | bool | 否 | 房间是否需要用户的头像昵称——如果填True,微信后台会去校验用户是否授权该应用获取其头像昵称的权限。如果房间需要头像昵称但是用户未授权,则用户后续加入房间的请求会返回失败;如果need_user_info为False,后续用户的加入房间操作会成功,但微信后台不会在房间信息中下发用户的头像昵称。 | |
game_last_time | number | 否 | 游戏对局时长,单位s,不得超过微信后台最大限制1个小时,如果不填或填0则默认为20分钟 | |
room_ext_info | string | 否 | 第三方自定义的房间信息,不得超过32个字节 | |
need_game_seed | bool | 否 | 是否需要在创建房间时同时生成一个随机的游戏种子 |
# 返回值
# Object
返回的 JSON 数据包
属性 | 类型 | 说明 |
---|---|---|
errcode | number | 错误码 |
errmsg | string | 错误提示信息 |
data | Object | 房间/对局访问凭证数据 |
errcode 的合法值
值 | 说明 | 最低版本 |
---|---|---|
0 | 请求成功 | |
-1 | 系统繁忙,此时请开发者稍候再试 | |
4003 | 非法的请求数据 | |
4013 | 自定义的房间信息超过指定大小 |
data 的结构
属性 | 类型 | 说明 |
---|---|---|
access_info | string | 房间/对局访问凭证 |