BK.Room 房间

游戏管理类

成员变量

成员方法

createAndJoinRoom(gameId,masterOpenId,callback)

房主创建并加入房间

参数：

返回值：无

例子：

var game = new BK.Room();
BK.Director.ticker.add(function(ts,duration){
    game.updateSocket();
});
game.createAndJoinRoom(gameId,masterOpenId,function (statusCode,room) {
if(statusCode == 0){
    BK.Script.log(0,0,"加入房间成功");
    BK.Script.log(0,0,"当前玩家：");
    room.currentPlayers.forEach(function(player) {
        BK.Script.log(1,1,"recvJoinRoom opeid:"+player["openId"] ); //openid
        BK.Script.log(1,1,"recvJoinRoom joinTs:"+player["joinTs"] );//加入的时间戳
        BK.Script.log(1,1,"recvJoinRoom status:"+player["status"] );//玩家状态 1用户在游戏中 2 用户加入后离开 3 用户等待加入
    }, this);
}); 

createAndJoinFixedRoom(gameId,masterOpenId,fixedRoomId,callback)

房主使用固定房间号创建房间。environment属性需设置为 NETWORK_ENVIRONMENT_DEMO_DEV 才可使用

参数：

返回值： 无

例子：

var game = new BK.Room();
game.isDebug = true;
//添加到ticker中进行定时刷新
BK.Director.ticker.add(function(ts,duration){
    game.updateSocket();
});
var fixedRoomId = 231;
game.createAndJoinFixedRoom(gameId,masterOpenId,fixedRoomId,function (statusCode,room) {
    if(statusCode == 0){
        BK.Script.log(0,0,"固定房间号-加入房间成功");
        BK.Script.log(0,0,"当前玩家：");
        room.currentPlayers.forEach(function(player) {
            BK.Script.log(1,1,"recvJoinRoom opeid:"+player["openId"] );
            BK.Script.log(1,1,"recvJoinRoom joinTs:"+player["joinTs"] );
            BK.Script.log(1,1,"recvJoinRoom status:"+player["status"] );
        }, this);
})

queryAndJoinRoom(gameId,roomId,joinerOpenId,callback)

参加者加入房间

参数：

返回值： 无

例子：

 var game2 = new BK.Room();
 game2.isDebug = true;
 var roomId =  255235804494484; //
 //添加到ticker中进行定时刷新
 BK.Director.ticker.add(function(ts,duration){
     game2.updateSocket();
 });
 //PS:. 房主在参加者加入房前 ，不能startGame,否则无法加入房间
 game2.queryAndJoinRoom(gameId,roomId,joinerOpenId,function(statusCode,room){
     if(statusCode == 0){
         BK.Script.log(0,0,"queryAndJoinRoom statusCode:"+ statusCode);
        BK.Script.log(0,0,"当前玩家：");
        room.currentPlayers.forEach(function(player) {
                                    BK.Script.log(1,1,"recvJoinRoom opeid:"+player["openId"] );
                                    BK.Script.log(1,1,"recvJoinRoom joinTs:"+player["joinTs"] );
                                    BK.Script.log(1,1,"recvJoinRoom status:"+player["status"] );
                                }, this);
     }else{
         BK.Script.log(0,0,"加入房间失败。statusCode:"+statusCode);
     }
 });

startGame(callback)

开始游戏

参数：

返回值：无

例子：

 game.startGame(function (statusCode) {
  BK.Script.log(0,0,"开始游戏！statusCode:"+statusCode);
};

setStartGameCallback(callback)

监听开始游戏事件

参数：

返回值：无

例子：

 game.setStartGameCallback(function (statusCode) {
  BK.Script.log(0,0,"开始游戏！statusCode:"+statusCode);
};    

leaveRoom(callback)

离开游戏

参数：

返回值：无

例子：

 game.leaveRoom(function (statusCode, leaveInfo) {
  BK.Script.log(0,0,"离开游戏！statusCode:"+statusCode);
};

syncOpt(statusBuf,optBuf,extendBuf,itemListBuf,callback)

发送帧同步操作命令

参数：

返回值：无

例子：

 //预留字段，暂时填0
var status = new BK.Buffer(1,1);
status.writeUint8Buffer(0);
//用户定义的字段
var str = "ABC";
//往buffer中写入string时，需多申请3个字节大小
var opt = new BK.Buffer(str.length+3,1);
opt.writeStringBuffer(str);
BK.Script.log(1,1,"sync !!!!!send frame  1");
//预留字段
var extend = new BK.Buffer(1,1);
extend.writeUint8Buffer(0);
//send 
game.syncOpt(status,opt,extend,undefined,function(ackSeq){
    BK.Script.log(1,1,"sync !!!!!后台确认号recv ack= "+ackSeq);
});    

setFrameSyncListener(listener)

设置帧同步监听函数

参数：

其中监听函数中frameDataArray为一个二维数组。第一维 代表当前推送有n帧第二维 代表当前帧中有m个用户的操作

返回值：无

例子：

game.setFrameSyncListener(function (frameDataArray) {
    var frameCount = frameDataArray.length;
    for (var index = 0; index < frameDataArray.length; index++) {
        var playersOpt  =frameDataArray[index];
        if(playersOpt){
            for (var i = 0; i < playersOpt.length; i++) {
                var player = playersOpt[i];
                   var openId = player.openId;   //用户openid
                    var itemId = player.itemId;   // 用户使用的道具id
                    var buff =  player.dataBuffer.;// BK.Buffer对象。用户发送的自定义对象.
                    //此处的dataBuffer即是 sendSyncOpt例子中所说的 ope。此处使用readUint8Buffer后，取出的值便是 1111
                     var  cmd = player.dataBuffer.readUint8Buffer();
            }
        }
    }
};

queryFrameData(beginFrame, count, callback)

查询指定帧的帧数据

参数：

其中监听函数中frameDataArray为一个二维数组。第一维 代表当前推送有n帧第二维 代表当前帧中有m个用户的操作

返回值：无

例子：

game.queryFrameData(beginFrame, count, function (errCode,frameDataArray) {
    if(errCode != 0){
        //错误返回
    }else{
        //正常返回
        var frameCount = frameDataArray.length;
        for (var index = 0; index < frameDataArray.length; index++) {
            var playersOpt  =frameDataArray[index];
            if(playersOpt){
                for (var i = 0; i < playersOpt.length; i++) {
                    var player = playersOpt[i];
                       var openId = player.openId;   //用户openid
                        var itemId = player.itemId;   // 用户使用的道具id
                        var buff =  player.dataBuffer.;// BK.Buffer对象。用户发送的自定义对象.
                        //此处的dataBuffer即是 sendSyncOpt例子中所说的 ope。此处使用readUint8Buffer后，取出的值便是 1111
                         var  cmd = player.dataBuffer.readUint8Buffer();
                }
            }
        }
    }
});

sendBroadcastData(buff)

向房间内所有玩家发送广播消息

返回值：无

例子:

 var req = 'This is a message!';
 //当BK.Buffer作为网络传输载体，且可能混杂多种不同类型数据时，需要额外分配3个自己
var data = new BK.Buffer(req.length+3);
data.writeStringBuffer(req);
game.sendBroadcastData(data);

setBroadcastDataCallBack(callback)

监听广播消息

参数：

返回值：无

例子:

game.setBroadcastDataCallBack(function (fromId,))

setUserData(buff,callback)

设置当前游戏云端存储目前为每个用户每个游戏可存储的大小为64K空间。如需扩容，需联系腾讯后台开发人员

返回值：无

例子:

 game.setUserData(userDataBuf,function(retCode){
        BK.Script.log(1,1,"设置云端存储 返回 = "+retCode );
});

getUserData(roomId,callback)

获取当前游戏云端存储

参数：

返回值：无

例子:

//获取云端存储数据
game.getUserData(room.roomId,function (retCode,buf) {
    BK.Script.log(1,1,"设置云端存储 返回 = "+retCode );
});

matchGame(gameId,OpenId,callBack)

开始陌生人匹配

参数：

这里的callback是匹配之后后台直接返回加入匹配队列成功，真正匹配成功还需要使用查询接口做轮询

返回值：无

例子(结合查询接口)：

var isMatchGame = 3;//GameStatusInfo.gameMode;  这里的gameMode=3表示游戏启动方式是陌生人匹配
var shouldQueryMatch = false;
var tickerCount = 0;
if(isMatchGame == 3){
    game.matchGame(GameStatusInfo.gameId,GameStatusInfo.openId,function(statusCode){
        if(statusCode == 0){
            shouldQueryMatch = true;
            BK.Script.log(1,1,"matchGame callBack");
        }
    });
}
//添加到ticker中进行定时刷新
BK.Director.ticker.add(function(ts,duration){
    tickerCount++;
    if(shouldQueryMatch && tickerCount%180 == 0){
        game.queryMatchGame(GameStatusInfo.gameId,GameStatusInfo.openId,function(statusCode){
            if(statusCode == 2011){
                shouldQueryMatch = false;
                BK.Script.log(1,1,"queryMatchGame callBack fail----timeout");
                return;
            }
            if(game.roomId > 0){  //每180帧去轮询一把  如果匹配成功，房间号会直接写入game.roomId，再拿这个roomId走正常查询房间流程
                shouldQueryMatch = false;
                BK.Script.log(1,1,"queryMatchGame callBack succ");
            } else{
                BK.Script.log(1,1,"queryMatchGame callBack fail");
            }
        });
    }
    game.updateSocket();
});

queryMatchGame(gameId,openId,callBack)

查询匹配

参数：

这里是在加入匹配队列后去轮询,回调函数里面的timeout如果为1代表匹配超时了，应该取消轮询，如果没有超时则判断game.roomId的值，这个值为0则继续轮询，如果大于0则进入查询房间的正常流程

例子： 同matchGame的例子

quitMatchGame(gameId,openId,callBack)

退出匹配

参数：

这里是在玩家加入加入游戏匹配后，退出匹配时通知给服务器。需要注意退出后，玩家需要通过queryRoom接口查询获取是否有玩家退出匹配。

例子：

game2.quitMatchGame(gameId,masterOpenId,function(status)
{
    if (status == 0)
        BK.Script.log(0,0," quit math success");
});
//获取有无玩家退出或退出玩家数量
game2.queryRoom(gameId,roomId,masterOpenId,function(status,roominfo)
{
    if (status ==0) {
        BK.Script.log(0,0," game2.queryRoom  "+ + "  退出人数:"+roominfo.ext_num);
    }
    else
    {
        BK.Script.log(0,0," game2.queryRoom  "+status );
    }
})

sendKeepAlive()

发送心跳

参数：无返回值：无

setDisconnectNetCallBack(callback)

监听网络断线

参数：

返回值：无

例子：

var room = new BK.Room();
...
room.setDisconnectNetCallBack(function(){
    //断线逻辑
});

reConnectAndJoinRoom()

重新连接房间注意事项：网络断线后，请求重连房间的操作由游戏侧去管理。游戏侧需要控制请求的频率。而频率不可过于频繁，如1秒钟发起1000次重连请求。

参数：无

返回值：无

例子：

var room = new BK.Room();
...
room.setDisconnectNetCallBack(function(){
    //请求重连。切记请求重连频率不可以过于频繁
    room.reConnectAndJoinRoom()
});

setReJoinRoomCallBack(callback)

监听重连结果调用BK.Room.reConnectAndJoinRoom()后，重连结果回调

参数：

返回值：无

例子：

var room = new BK.Room();
...
room.setReJoinRoomCallBack(function(statueCode){
    //断线重连结果
});
room.setDisconnectNetCallBack(function(){
    //请求重连。切记请求重连频率不可以过于频繁
    room.reConnectAndJoinRoom()
});

后台错误码

例子

位置：script/Demo/net/frameSync_demo.js**

原文: https://hudong.qq.com/docs/engine/api/BK.Room.html