# GameServerManager

> 基础库 2.8.0 开始支持，低版本需做[兼容处理](1003706)。

游戏服务管理器，可通过 [wx.getGameServerManager](/minigame/dev/api/game-server-manager/wx.getGameServerManager) 获取。注意：`GameServerManager.inviteFriend`、`GameServerManager.onStateUpdate`、`GameServerManager.offStateUpdate`、`GameServerManager.getFriendsStateData` 这几个接口只允许在开放数据域内使用，其他接口则只允许在游戏域内使用。

## 方法

### [Promise GameServerManager.broadcastInRoom(object object)](/minigame/dev/api/game-server-manager/GameServerManager.broadcastInRoom)

在房间内广播

### [Promise GameServerManager.cancelMatch(object object)](/minigame/dev/api/game-server-manager/GameServerManager.cancelMatch)

取消游戏匹配

### [Promise GameServerManager.changeSeat(object object)](/minigame/dev/api/game-server-manager/GameServerManager.changeSeat)

玩家换座位

### [Promise GameServerManager.createRoom(object object)](/minigame/dev/api/game-server-manager/GameServerManager.createRoom)

创建游戏房间

### [Promise GameServerManager.endGame()](/minigame/dev/api/game-server-manager/GameServerManager.endGame)

结束帧同步

### [Promise GameServerManager.endStateService()](/minigame/dev/api/game-server-manager/GameServerManager.endStateService)

结束游戏状态同步服务

### [GameServerManager.getFriendsStateData()](/minigame/dev/api/game-server-manager/GameServerManager.getFriendsStateData)

获取所有好友的在线状态及信息。该接口需要用户授权，且只在开放数据域下可用。

### [Promise GameServerManager.getJoinVoIPChatSignature(object object)](/minigame/dev/api/game-server-manager/GameServerManager.getJoinVoIPChatSignature)

获取实时语音签名，签名的 groupId 与当前房间服务的房间 ID 绑定

### [Promise GameServerManager.getLastRoomInfo()](/minigame/dev/api/game-server-manager/GameServerManager.getLastRoomInfo)

获取最近参与房间的 accessInfo

### [Promise GameServerManager.getLostFrames(object object)](/minigame/dev/api/game-server-manager/GameServerManager.getLostFrames)

补帧，补帧区间为 [beginFrameId, endFrameId)，即左闭右合。

### [Promise GameServerManager.getRoomInfo()](/minigame/dev/api/game-server-manager/GameServerManager.getRoomInfo)

获取房间详情

### [GameServerManager.inviteFriend(object object)](/minigame/dev/api/game-server-manager/GameServerManager.inviteFriend)

邀请好友，该好友的系统状态必须为在线（该接口需要在开放数据域使用）该接口没有回调也没有返回值

### [Promise GameServerManager.joinRoom(object object)](/minigame/dev/api/game-server-manager/GameServerManager.joinRoom)

加入游戏房间

### [Promise GameServerManager.kickoutMember(object object)](/minigame/dev/api/game-server-manager/GameServerManager.kickoutMember)

把一名玩家踢出房间（仅房主有权限）

### [Promise GameServerManager.login()](/minigame/dev/api/game-server-manager/GameServerManager.login)

登录游戏服务

### [Promise GameServerManager.logout()](/minigame/dev/api/game-server-manager/GameServerManager.logout)

登出游戏服务

### [Promise GameServerManager.memberLeaveRoom(object object)](/minigame/dev/api/game-server-manager/GameServerManager.memberLeaveRoom)

普通成员退出房间

### [Promise GameServerManager.ownerLeaveRoom(object object)](/minigame/dev/api/game-server-manager/GameServerManager.ownerLeaveRoom)

房主退出房间，`assign_owner_to_pos_num` 参数被优先处理，其次是 `assign_to_min_pos_num`，如果二者都没有被设置，则房主退出且房间销毁。

### [Promise GameServerManager.reconnect(object object)](/minigame/dev/api/game-server-manager/GameServerManager.reconnect)

重连游戏服务。如果此时连接并未断开或游戏未开始，会直接成功；如果游戏已开始并且连接已断开，会进行重连，并返回此时服务器的最大帧号。

### [Promise GameServerManager.restart()](/minigame/dev/api/game-server-manager/GameServerManager.restart)

重启游戏并进入"组队中"的状态。如果当前房间游戏已结束，调用可进入"组队中"状态并重置所有玩家的准备状态；如果当前房间已经在"组队中"状态，调用不改变状态；如果当前房间游戏进行中，调用失败。

### [boolean GameServerManager.setInviteData(string data)](/minigame/dev/api/game-server-manager/GameServerManager.setInviteData)

设置邀请好友附带的数据

### [Promise GameServerManager.setState(object object)](/minigame/dev/api/game-server-manager/GameServerManager.setState)

更新玩家状态信息

### [GameServerManager.startGame()](/minigame/dev/api/game-server-manager/GameServerManager.startGame)

启动帧同步

### [Promise GameServerManager.startMatch(object object)](/minigame/dev/api/game-server-manager/GameServerManager.startMatch)

开始游戏匹配。在调用 startMatch 之前，需要先调用后台接口 [gamematch.setMatchIdOpenState](https://developers.weixin.qq.com/minigame/dev/api-backend/open-api/gamematch/gamematch.setMatchIdOpenState.html) 把 matchId 设置为打开状态。

### [Promise GameServerManager.startStateService(object object)](/minigame/dev/api/game-server-manager/GameServerManager.startStateService)

开启状态管理服务，只有开启状态管理服务，才能获取在线好友列表以及接收好友邀请

### [Promise GameServerManager.updateReadyStatus(object object)](/minigame/dev/api/game-server-manager/GameServerManager.updateReadyStatus)

更新玩家准备信息

### [Promise GameServerManager.uploadFrame(object object)](/minigame/dev/api/game-server-manager/GameServerManager.uploadFrame)

上传游戏帧

### [GameServerManager.onLogout(function listener)](/minigame/dev/api/game-server-manager/GameServerManager.onLogout)

监听用户登出游戏服务事件，可能是主动登出也可能是其他原因被动登出

### [GameServerManager.offLogout(function listener)](/minigame/dev/api/game-server-manager/GameServerManager.offLogout)

移除用户登出游戏服务事件的监听函数

### [GameServerManager.onBeKickedOut(function listener)](/minigame/dev/api/game-server-manager/GameServerManager.onBeKickedOut)

监听自己被踢出当前房间

### [GameServerManager.offBeKickedOut(function listener)](/minigame/dev/api/game-server-manager/GameServerManager.offBeKickedOut)

移除自己被踢出当前房间的监听函数

### [GameServerManager.onBroadcast(function listener)](/minigame/dev/api/game-server-manager/GameServerManager.onBroadcast)

监听收到同个房间内的广播消息

### [GameServerManager.offBroadcast(function listener)](/minigame/dev/api/game-server-manager/GameServerManager.offBroadcast)

移除收到同个房间内的广播消息的监听函数

### [GameServerManager.onDisconnect(function listener)](/minigame/dev/api/game-server-manager/GameServerManager.onDisconnect)

监听断开连接，收到此事件后，需要调用 `GameServerManager.reconnect` 进行重连

### [GameServerManager.offDisconnect(function listener)](/minigame/dev/api/game-server-manager/GameServerManager.offDisconnect)

移除断开连接，收到此事件的监听函数

### [GameServerManager.onGameStart(function listener)](/minigame/dev/api/game-server-manager/GameServerManager.onGameStart)

监听帧同步游戏开始

### [GameServerManager.offGameStart(function listener)](/minigame/dev/api/game-server-manager/GameServerManager.offGameStart)

移除帧同步游戏开始的监听函数

### [GameServerManager.onGameEnd(function listener)](/minigame/dev/api/game-server-manager/GameServerManager.onGameEnd)

监听帧同步游戏结束

### [GameServerManager.offGameEnd(function listener)](/minigame/dev/api/game-server-manager/GameServerManager.offGameEnd)

移除帧同步游戏结束的监听函数

### [GameServerManager.onInvite(function listener)](/minigame/dev/api/game-server-manager/GameServerManager.onInvite)

监听接收邀请，当用户确认邀请之后会收到此事件

### [GameServerManager.offInvite(function listener)](/minigame/dev/api/game-server-manager/GameServerManager.offInvite)

移除接收邀请，当用户确认邀请之后会收到此事件的监听函数

### [GameServerManager.onLockStepError(function listener)](/minigame/dev/api/game-server-manager/GameServerManager.onLockStepError)

监听帧同步出错

### [GameServerManager.offLockStepError(function listener)](/minigame/dev/api/game-server-manager/GameServerManager.offLockStepError)

移除帧同步出错的监听函数

### [GameServerManager.onMatch(function listener)](/minigame/dev/api/game-server-manager/GameServerManager.onMatch)

监听游戏匹配成功的事件

### [GameServerManager.offMatch(function listener)](/minigame/dev/api/game-server-manager/GameServerManager.offMatch)

移除游戏匹配成功的事件的监听函数

### [GameServerManager.onRoomInfoChange(function listener)](/minigame/dev/api/game-server-manager/GameServerManager.onRoomInfoChange)

监听房间信息更新

### [GameServerManager.offRoomInfoChange(function listener)](/minigame/dev/api/game-server-manager/GameServerManager.offRoomInfoChange)

移除房间信息更新的监听函数

### [GameServerManager.onStateUpdate(function listener)](/minigame/dev/api/game-server-manager/GameServerManager.onStateUpdate)

监听好友在线状态变更（该接口需要在开放数据域使用）

### [GameServerManager.offStateUpdate(function listener)](/minigame/dev/api/game-server-manager/GameServerManager.offStateUpdate)

移除好友在线状态变更（该接口需要在开放数据域使用）的监听函数

### [GameServerManager.onSyncFrame(function listener)](/minigame/dev/api/game-server-manager/GameServerManager.onSyncFrame)

监听收到同个房间的帧同步消息

### [GameServerManager.offSyncFrame(function listener)](/minigame/dev/api/game-server-manager/GameServerManager.offSyncFrame)

移除收到同个房间的帧同步消息的监听函数