对象类型定义

最近更新时间:2020-07-03 11:08:51

PlayerInfoPara

对象描述

玩家信息参数。

参数描述

属性名 类型/值 描述
name string 玩家昵称
customPlayerStatus number 自定义玩家状态
customProfile string 自定义玩家信息

MatchPlayerInfoPara

对象描述

玩家信息参数。

参数描述

属性名 类型/值 描述
name string 玩家昵称
customPlayerStatus number 自定义玩家状态
customProfile string 自定义玩家信息
matchAttributes MGOBE.types.MatchAttribute[] 匹配属性

GameInfoPara

对象描述

初始化参数:游戏信息。

参数描述

属性名 类型/值 描述
gameId string 游戏 ID
openId string 玩家 openId
secretKey string 游戏密钥
createSignature MGOBE.types.CreateSignature 签名函数
说明:

  • 游戏密钥指控制台上的“游戏 key”。在初始化 SDK 时,secretKey、CreateSignature 两个参数传其中一个即可。如果实现了 CreateSignature 方法,则忽略 secretKey 参数。
  • CreateSignature 用于计算签名 signature,优点在于避免客户端泄露游戏密钥。

ConfigPara

对象描述

初始化参数:配置参数。

参数描述

属性名 类型/值 描述 可选
reconnectMaxTimes number 重连接次数(默认15)
reconnectInterval number 重连接时间间隔(毫秒,默认500)
resendInterval number 消息重发时间间隔(毫秒,默认1000)
resendTimeout number 消息重发超时时间(毫秒,默认20000)
url string 服务地址 -
isAutoRequestFrame boolean 是否自动补帧(默认 false)
cacertNativeUrl string 本地 CA 根证书路径(CocosNative 环境需要该参数)
说明:

服务地址指控制台上的“域名”。

Signature

对象描述

初始化签名。

参数描述

属性名 类型/值 描述
sign string 签名
nonce number 随机正整数(uint64 类型)
timestamp number 时间戳,秒(uint64 类型)
说明:

可以使用签名的方式初始化 SDK,避免客户端泄露游戏密钥。

CreateSignature

对象描述

签名函数。

参数描述

属性名 类型/值 描述
callback (signature: MGOBE.types.Signature) => any 回调函数,在该函数返回 Signature 对象
说明:

开发者如果使用签名方式初始化 SDK,需要实现该方法,并在 callback 中回调 Signature 对象。

ChangeCustomPlayerStatusPara

对象描述

修改玩家状态参数。

参数描述

属性名 类型/值 描述
customPlayerStatus number 自定义玩家状态

CreateRoomPara

对象描述

创建房间参数。

参数描述

属性名 类型/值 描述
roomName string 房间名称
roomType string 房间类型
maxPlayers number 房间最大玩家数量
isPrivate boolean 是否私有
customProperties string 自定义房间属性
playerInfo MGOBE.types.PlayerInfoPara 玩家信息

CreateTeamRoomPara

对象描述

创建团队房间参数。

参数描述

属性名 类型/值 描述
roomName string 房间名称
roomType string 房间类型
maxPlayers number 房间最大玩家数量
isPrivate boolean 是否私有
customProperties string 自定义房间属性
playerInfo MGOBE.types.PlayerInfoPara 玩家信息
teamNumber number 队伍数量

JoinRoomPara

对象描述

加入房间参数。

参数描述

属性名 类型/值 描述
playerInfo MGOBE.types.PlayerInfoPara 玩家信息

JoinTeamRoomPara

对象描述

加入团队房间参数。

参数描述

属性名 类型/值 描述
playerInfo MGOBE.types.PlayerInfoPara 玩家信息
teamId string 队伍 ID

ChangeRoomPara

对象描述

房间变更参数。

参数描述

属性名 类型/值 描述 可选
roomName string 房间名称
owner string 房主 ID
isPrivate boolean 是否私有
customProperties string 自定义房间属性
isForbidJoin boolean 是否禁止加入房间

RemovePlayerPara

对象描述

移除房间内玩家参数。

参数描述

属性名 类型/值 描述
removePlayerId string 被移除玩家 ID

GetRoomListPara

对象描述

获取房间列表参数。

参数描述

属性名 类型/值 描述 可选
pageNo number 页号,从1开始
pageSize number 每页数量,最大为10
roomType string 房间类型
isDesc boolean 是否按照房间创建时间倒序

GetRoomByRoomIdPara

对象描述

获取房间参数。

参数描述

属性名 类型/值 描述
roomId string 房间 ID

MatchPlayersPara

对象描述

玩家匹配参数。

参数描述

属性名 类型/值 描述
matchCode string 匹配 Code
playerInfo MGOBE.types.MatchPlayerInfoPara 玩家信息
说明:

匹配 Code 需要在控制台创建匹配获得。

MatchRoomPara

对象描述

房间匹配参数。

参数描述

属性名 类型/值 描述
playerInfo MGOBE.types.PlayerInfoPara 玩家信息
maxPlayers number 房间最大玩家数量
roomType string 房间的类型

MatchGroupPlayerInfoPara

对象描述

组队匹配玩家信息参数。

参数描述

属性名 类型/值 描述
id string 玩家 ID
name string 玩家昵称
customPlayerStatus number 自定义玩家状态
customProfile string 自定义玩家信息
matchAttributes MGOBE.types.MatchAttribute[] 匹配属性

MatchGroupPara

对象描述

组队匹配参数。

参数描述

属性名 类型/值 描述
matchCode string 匹配 Code
playerInfoList[] MGOBE.types.MatchGroupPlayerInfoPara[] 队员信息
说明:

匹配 code 请前往控制台创建匹配并获得。

MatchBst

对象描述

组队匹配结束广播回调参数。

参数描述

属性名 类型/值 描述
roomInfo MGOBE.types.RoomInfo 房间信息
errCode number 错误码

CancelMatchBst

对象描述

组队匹配取消广播回调参数。

参数描述

属性名 类型/值 描述
matchCode string 匹配 Code
playerId string 发起取消匹配的玩家 ID

CancelPlayerMatchPara

对象描述

取消匹配参数。

参数描述

属性名 类型/值 描述
matchType MGOBE.types.MatchType 匹配类型

SendFramePara

对象描述

发送帧数据参数。

参数描述

属性名 类型/值 描述
data object 帧数据

RequestFramePara

对象描述

请求补帧参数。

参数描述

属性名 类型/值 描述
beginFrameId number 起始帧号
endFrameId number 结束帧号
说明:

补帧范围大于等于 beginFrameId,小于等于 endFrameId。

RecvType

对象描述

消息接收者类型。

参数描述

属性名 类型/值 描述
ROOM_ALL 1 全部玩家
ROOM_OTHERS 2 除自己外的其他玩家
ROOM_SOME 3 房间中部分玩家

SendToClientPara

对象描述

发送房间内消息参数。

参数描述

属性名 类型/值 描述
recvPlayerList string[] 接收消息玩家 ID 列表
msg string 消息内容
recvType MGOBE.types.RecvType 消息接收者类型

SendToGameSvrPara

对象描述

发自定义服务消息参数。

参数描述

属性名 类型/值 描述
data object 消息内容

RecvFromGameSvrBst

对象描述

自定义服务消息广播回调参数。

参数描述

属性名 类型/值 描述
roomId number 房间 ID
recvPlayerIdList string[] 接收消息玩家 ID 列表
data object 消息内容

FrameItem

对象描述

帧内容。

参数描述

属性名 类型/值 描述
playerId string 玩家 ID
data object 玩家帧内容
timestamp number 时间戳,各玩家本地发送帧的时间

Frame

对象描述

帧数据。

参数描述

属性名 类型/值 描述
frameId number 帧 ID
items MGOBE.types.FrameItem[] 帧内容
ext MGOBE.types.FrameExtInfo 附加信息
roomId number 房间 ID
time number 该帧到达客户端时间
isReplay boolean 是否为补帧
说明:

  • 附加信息包含一个 number 类型随机种子,开发者可以使用帧 ID 与随机种子组合成一个值来初始化 RandomUtil 工具。
  • time 为 SDK 拟合出来的时间,目的是使每一帧到达客户端的时间尽量均匀分布,并且时间间隔尽量接近帧率的倒数。
  • isReplay 表示该帧是否为自动补帧产生的帧,自动补帧需要在初始化 Listener 时设置。
  • items 数组表示各个客户端发送的帧消息,按照到达服务器时间先后进行排序(数组中第0个为最先到服务器)。

RecvFrameBst

对象描述

帧广播回调参数。

参数描述

属性名 类型/值 描述
frame MGOBE.types.Frame 帧数据

RequestFrameRsp

对象描述

请求补帧回调参数。

参数描述

属性名 类型/值 描述
frames MGOBE.types.Frame[] 帧数据数组

JoinRoomBst

对象描述

玩家加入房间广播回调参数。

参数描述

属性名 类型/值 描述
roomInfo MGOBE.types.RoomInfo 房间信息
joinPlayerId string 加房玩家 ID

LeaveRoomBst

对象描述

玩家退出房间广播回调参数。

参数描述

属性名 类型/值 描述
roomInfo MGOBE.types.RoomInfo 房间信息
leavePlayerId string 退房玩家 ID

DismissRoomBst

对象描述

房间被解散广播回调参数。

参数描述

属性名 类型/值 描述
roomInfo MGOBE.types.RoomInfo 房间解散前的信息

ChangeRoomBst

对象描述

房间属性变更广播回调参数。

参数描述

属性名 类型/值 描述
roomInfo MGOBE.types.RoomInfo 房间信息

RemovePlayerBst

对象描述

房间内玩家被移除广播回调参数。

参数描述

属性名 类型/值 描述
roomInfo MGOBE.types.RoomInfo 房间信息
removePlayerId string 被移除玩家 ID

RecvFromClientBst

对象描述

房间消息广播回调参数。

参数描述

属性名 类型/值 描述
roomId number 房间 ID
sendPlayerId string 发送者 ID
msg string 消息内容

ChangePlayerNetworkStateBst

对象描述

房间内玩家网络状态变化广播回调参数。

参数描述

属性名 类型/值 描述
changePlayerId string 玩家 ID
networkState MGOBE.types.NetworkState 网络状态
roomInfo MGOBE.types.RoomInfo 房间信息

ChangeCustomPlayerStatusBst

对象描述

玩家自定义状态变化广播回调参数。

参数描述

属性名 类型/值 描述
changePlayerId string 玩家 ID
customPlayerStatus number 自定义玩家信息
roomInfo MGOBE.types.RoomInfo 房间信息

StartFrameSyncBst

对象描述

开始帧同步广播回调参数。

参数描述

属性名 类型/值 描述
roomInfo MGOBE.types.RoomInfo 房间信息

StopFrameSyncBst

对象描述

停止帧同步广播回调参数。

参数描述

属性名 类型/值 描述
roomInfo MGOBE.types.RoomInfo 房间信息

RoomInfo

对象描述

房间属性。

参数描述

属性名 类型/值 描述
id string 房间 ID
name string 房间名称
type string 房间类型
createType MGOBE.types.CreateRoomType 创建房间方式
maxPlayers number 房间最大玩家数量
owner string 房主 ID
isPrivate boolean 是否私有
customProperties string 房间自定义属性
playerList MGOBE.types.PlayerInfo[] 玩家列表
teamList MGOBE.types.TeamInfo[] 团队属性
frameSyncState MGOBE.types.FrameSyncState 房间帧同步状态
frameRate number 帧率
routeId string 路由 ID
createTime number 房间创建时的时间戳(单位:秒)
startGameTime number 开始帧同步时的时间戳(单位:秒)
isForbidJoin boolean 是否禁止加入房间
说明:

isPrivate 属性为 true 表示该房间为私有房间,不能被 matchRoom 接口匹配到。

ChangeCustomPlayerStatusRsp

对象描述

修改玩家状态回调参数。

参数描述

属性名 类型/值 描述
roomInfo MGOBE.types.RoomInfo 房间信息

CreateRoomRsp

对象描述

创建房间回调参数。

参数描述

属性名 类型/值 描述
roomInfo MGOBE.types.RoomInfo 房间信息

JoinRoomRsp

对象描述

加入房间回调参数。

参数描述

属性名 类型/值 描述
roomInfo MGOBE.types.RoomInfo 房间信息

LeaveRoomRsp

对象描述

退出房间回调参数。

参数描述

属性名 类型/值 描述
roomInfo MGOBE.types.RoomInfo 房间信息

DismissRoomRsp

对象描述

解散房间回调参数。

参数描述

ChangeRoomRsp

对象描述

修改房间回调参数。

参数描述

属性名 类型/值 描述
roomInfo MGOBE.types.RoomInfo 房间信息

RemovePlayerRsp

对象描述

移除房间内玩家回调参数。

参数描述

属性名 类型/值 描述
roomInfo MGOBE.types.RoomInfo 房间信息

GetRoomByRoomIdRsp

对象描述

获取房间信息回调参数。

参数描述

属性名 类型/值 描述
roomInfo MGOBE.types.RoomInfo 房间信息

GetRoomListRsp

对象描述

获取房间列表回调参数。

参数描述

属性名 类型/值 描述
roomList MGOBE.types.RoomInfo[] 房间列表
total number 房间总数

MatchPlayersRsp

对象描述

玩家匹配回调参数。

参数描述

属性名 类型/值 描述
matchType MGOBE.types.MatchType 匹配类型
roomInfo MGOBE.types.RoomInfo 房间信息

MatchRoomSimpleRsp

对象描述

房间匹配回调参数。

参数描述

属性名 类型/值 描述
roomInfo MGOBE.types.RoomInfo 房间信息

MatchGroupRsp

对象描述

组队匹配回调参数。

参数描述

属性名 类型/值 描述
matchCode string 匹配 Code

CancelPlayerMatchRsp

对象描述

取消匹配回调参数。

参数描述

StartFrameSyncRsp

对象描述

开始帧同步回调参数。

参数描述

StopFrameSyncRsp

对象描述

停止帧同步回调参数。

参数描述

SendFrameRsp

对象描述

发送帧同步数据回调参数。

参数描述

SendToClientRsp

对象描述

房间内发送消息回调参数。

参数描述

SendToGameSvrRsp

对象描述

发送自定义服务消息回调参数。

参数描述

MatchAttribute

对象描述

匹配属性。

参数描述

属性名 类型/值 描述
name string 属性名称
value number 属性值

MatchType

对象描述

匹配类型。

参数描述

属性名 类型/值 描述
ROOM_SIMPLE 1 房间匹配
PLAYER_COMPLEX 2 玩家匹配

FrameExtInfo

对象描述

帧数据附加信息。

参数描述

属性名 类型/值 描述
seed number 随机数种子

CreateRoomType

对象描述

创建房间方式。

参数描述

属性名 类型/值 描述
COMMON_CREATE 0 普通创建
MATCH_CREATE 1 匹配创建

NetworkState

对象描述

网络状态。

参数描述

属性名 类型/值 描述
COMMON_OFFLINE 0 房间/队组中玩家掉线
COMMON_ONLINE 1 房间/队组中玩家在线
RELAY_OFFLINE 2 帧同步中玩家掉线
RELAY_ONLINE 3 帧同步中玩家在线

FrameSyncState

对象描述

房间帧同步状态。

参数描述

属性名 类型/值 描述
STOP 0 未开始帧同步
START 1 已开始帧同步

PlayerInfo

对象描述

玩家信息。

参数描述

属性名 类型/值 描述
id string 玩家 ID
name string 玩家昵称
teamId string 队伍 ID
customPlayerStatus number 自定义玩家状态
customProfile string 自定义玩家信息
commonNetworkState MGOBE.types.NetworkState 玩家在房间的网络状态
relayNetworkState MGOBE.types.NetworkState 玩家在游戏中的网络状态
isRobot boolean 玩家是否为机器人
matchAttributes MGOBE.types.MatchAttribute[] 玩家匹配属性列表(isRobot 为 true 时生效)

TeamInfo

对象描述

队伍信息。

参数描述

属性名 类型/值 描述
id string 队伍 ID
name string 队伍名称
minPlayers number 队伍最小人数
maxPlayers number 队伍最大人数

GroupType

对象描述

队组类型。

参数描述

属性名 类型/值 描述
GROUP_LIMITED 0 玩家只能同时存在于1个该类型队组。该类型的队组人数上限:100。
GROUP_MANY 1 玩家可以同时存在于多个(上限为5)该类型队组。该类型的队组人数上限:300。

GroupInfo

对象描述

队组信息。

参数描述

属性名 类型/值 描述
id string 队组 ID
name string 队组名称
type MGOBE.types.GroupType 队组类型
maxPlayers number 队组最大玩家数量
owner string 队长 ID
customProperties string 自定义队组属性
createTime number 创建队组时间
isForbidJoin boolean 是否禁止加入队组
isPersistent boolean 是否持久化
groupPlayerList MGOBE.types.GroupPlayerInfo[] 队组内的玩家列表
说明:

  • 对于非持久化队组(isPersistent为false),当队组解散,或者队组内没有玩家,或者队组玩家全部掉线超过60分钟,或者队组存在时间超过24小时后,队组会被销毁。
  • 对于持久化队组(isPersistent为true),只有当主动解散队组后,队组会被销毁。
  • 玩家可以加入多个 GROUP_MANY 类型队组(type 为 GroupType.GROUP_MANY),同时加入的数量上限为5个。
  • 玩家最多只能加入1个 GROUP_LIMITED 类型队组(type 为 GroupType.GROUP_LIMITED)。

GroupPlayerInfo

对象描述

队组玩家信息。

参数描述

属性名 类型/值 描述
id string 玩家 ID
name string 玩家昵称
customGroupPlayerStatus number 自定义玩家状态
customGroupPlayerProfile string 自定义玩家信息
commonGroupNetworkState MGOBE.types.NetworkState 玩家网络状态

JoinGroupBst

对象描述

玩家加入队组广播回调参数。

参数描述

属性名 类型/值 描述
groupInfo MGOBE.types.GroupInfo 队组信息
joinPlayerId string 加入队组玩家 ID

LeaveGroupBst

对象描述

玩家退出队组广播回调参数。

参数描述

属性名 类型/值 描述
groupInfo MGOBE.types.GroupInfo 队组信息
leavePlayerId string 退出队组玩家 ID

DismissGroupBst

对象描述

队组解散广播回调参数。

参数描述

属性名 类型/值 描述
groupInfo MGOBE.types.GroupInfo 队组信息

ChangeGroupBst

对象描述

队组属性变更广播回调参数。

参数描述

属性名 类型/值 描述
groupInfo MGOBE.types.GroupInfo 队组信息

RemoveGroupPlayerBst

对象描述

队组内玩家被移除广播回调参数。

参数描述

属性名 类型/值 描述
groupInfo MGOBE.types.GroupInfo 队组信息
removePlayerId string 被移除玩家ID

ChangeGroupPlayerNetworkStateBst

对象描述

队组内玩家网络状态变化广播回调参数。

参数描述

属性名 类型/值 描述
groupInfo MGOBE.types.GroupInfo 队组信息
changePlayerId string 玩家 ID
networkState MGOBE.types.NetworkState 玩家网络状态

ChangeCustomGroupPlayerStatusBst

对象描述

队组内玩家自定义状态变化广播回调参数。

参数描述

属性名 类型/值 描述
groupInfo MGOBE.types.GroupInfo 队组信息
changePlayerId string 玩家 ID
customGroupPlayerStatus number 自定义玩家状态

RecvFromGroupClientBst

对象描述

队组内消息广播回调参数。

参数描述

属性名 类型/值 描述
groupId string 队组 ID
sendPlayerId string 消息发送者 ID
msg string 消息内容

GetGroupByGroupIdPara

对象描述

获取队组信息参数。

参数描述

属性名 类型/值 描述
groupId string 队组 ID

GetGroupByGroupIdRsp

对象描述

获取队组信息回调参数。

参数描述

属性名 类型/值 描述
groupInfo MGOBE.types.GroupInfo 队组信息

GetMyGroupsRsp

对象描述

获取当前玩家队组信息回调参数。

参数描述

属性名 类型/值 描述
groupInfoList MGOBE.types.GroupInfo[] 队组信息列表

GroupPlayerInfoPara

对象描述

队组玩家信息参数。

参数描述

属性名 类型/值 描述
name string 玩家昵称(字符串长度上限为32)
customGroupPlayerStatus number 自定义玩家状态(取值范围为[0,99999])
customGroupPlayerProfile string 自定义玩家信息(字符串长度上限为1024)

CreateGroupPara

对象描述

创建队组参数。

参数描述

属性名 类型/值 描述
groupName string 队组名称(字符串长度上限为32)
groupType MGOBE.types.GroupType 队组类型
maxPlayers number 队组最大玩家数量
customProperties string 自定义队组属性(字符串长度上限为1024)
playerInfo MGOBE.types.GroupPlayerInfoPara 玩家信息
isForbidJoin boolean 是否禁止加入队组
isPersistent boolean 是否持久化
说明:

  • 对于持久化队组(isPersistent 为 true),maxPlayers 上限为100。
  • 对于非持久化队组(isPersistent 为 false),maxPlayers 上限为300。
  • 每个游戏可以创建的持久化队组数量上限为3个。

CreateGroupRsp

对象描述

创建队组回调参数。

参数描述

属性名 类型/值 描述
groupInfo MGOBE.types.GroupInfo 队组信息

JoinGroupPara

对象描述

加入队组参数。

参数描述

属性名 类型/值 描述
playerInfo MGOBE.types.GroupPlayerInfoPara 玩家信息

JoinGroupRsp

对象描述

加入队组回调参数。

参数描述

属性名 类型/值 描述
groupInfo MGOBE.types.GroupInfo 队组信息

LeaveGroupRsp

对象描述

离开队组回调参数。

参数描述

属性名 类型/值 描述
groupInfo MGOBE.types.GroupInfo 队组信息

DismissGroupRsp

对象描述

解散队组回调参数。

参数描述

ChangeGroupPara

对象描述

更新队组参数。

参数描述

属性名 类型/值 描述 可选
groupName string 队组名称
owner string 队长 ID
customProperties string 自定义队组属性
isForbidJoin boolean 是否禁止加入队组

ChangeGroupRsp

对象描述

更新队组回调参数。

参数描述

属性名 类型/值 描述
groupInfo MGOBE.types.GroupInfo 队组信息

RemoveGroupPlayerPara

对象描述

移除队组玩家参数。

参数描述

属性名 类型/值 描述
removePlayerId string 被移除玩家 ID

RemoveGroupPlayerRsp

对象描述

移除队组玩家回调参数。

参数描述

属性名 类型/值 描述
groupInfo MGOBE.types.GroupInfo 队组信息

ChangeCustomGroupPlayerStatusPara

对象描述

修改队组玩家状态参数。

参数描述

属性名 类型/值 描述
customGroupPlayerStatus number 自定义玩家状态(取值范围为[0,99999])

ChangeCustomGroupPlayerStatusRsp

对象描述

修改队组玩家状态回调参数。

参数描述

属性名 类型/值 描述
groupInfo MGOBE.types.GroupInfo 队组信息

GroupRecvType

对象描述

消息接收者类型。

参数描述

属性名 类型/值 描述
GROUP_ALL 1 全部玩家
GROUP_OTHERS 2 除自己外的其他玩家
GROUP_SOME 3 队组中部分玩家

SendToGroupClientPara

对象描述

发送队组内消息参数。

参数描述

属性名 类型/值 描述
recvPlayerList string[] 接收消息玩家 ID 列表
msg string 消息内容
recvType MGOBE.types.GroupRecvType 消息接收者类型

SendToGroupClientRsp

对象描述

发送队组内消息回调参数。

参数描述

目录