3
3
* @Author : Ville
4
4
* @Date : 2018-04-17 17:46:35
5
5
* @LastEditors : Ville
6
- * @LastEditTime : 2018-12-21 16:37:21
6
+ * @LastEditTime : 2019-01-30 14:25:25
7
7
* @Version : Develop v3.7.5.+
8
8
* @Description : Matchvs skd .d.ts define files for typescrip
9
9
*/
@@ -18,7 +18,8 @@ declare namespace MVS{
18
18
public startIndex :number ;
19
19
public timestamp :string ;
20
20
public enableGS :number ;
21
- constructor ( frameRate :number , startIndex :number , timestamp :string , enableGS :number ) ;
21
+ public cacheFrameMS :number ;
22
+ constructor ( frameRate :number , startIndex :number , timestamp :string , enableGS :number , cacheFrameMS :number ) ;
22
23
}
23
24
24
25
/**
@@ -157,7 +158,7 @@ declare namespace MVS{
157
158
* @param {MsTeamMatchCond } cond 队伍匹配参数设置
158
159
* @memberof MsTeamMatchInfo
159
160
*/
160
- constructor ( roomName : string , maxPlayer : number , canWatch : number , mode : number , visibility : number , roomProperty : string , watchSet : MsWatchSet , cond : MsTeamMatchCond ) ;
161
+ constructor ( roomName : string , maxPlayer : number , canWatch : number , mode : number , visibility : number , roomProperty : string , cond : MsTeamMatchCond , watchSet : MsWatchSet ) ;
161
162
}
162
163
163
164
class MsJoinTeamInfo {
@@ -1137,14 +1138,9 @@ declare class MatchvsResponse {
1137
1138
* @param {number } rsp.status 配置的状态,200 成功,422 超时
1138
1139
* @param {Array<any> } rsp.brigades 配置到队伍,大队伍列表信息
1139
1140
* @param {number } rsp.brigades.brigadeID 大队伍ID号
1140
- * @param {Array<any> } rsp.brigades.teamList 小队伍列表
1141
- * @param {string } rsp.brigades.teamList.teamID 小队伍ID号
1142
- * @param {number } rsp.brigades.teamList.capacity 小队伍容量
1143
- * @param {number } rsp.brigades.teamList.mode 小队伍模式,开发者自定义数据
1144
- * @param {number } rsp.brigades.teamList.owner 小队伍队长
1145
- * @param {Array<any> } rsp.brigades.teamList.playerList 小队伍玩家列表
1146
- * @param {number } rsp.brigades.teamList.playerList.userID 小队伍玩家ID
1147
- * @param {string } rsp.brigades.teamList.playerList.userProfile 小队伍玩家自定义数据
1141
+ * @param {Array<any> } rsp.brigades.playerList 小队伍玩家列表
1142
+ * @param {number } rsp.brigades.playerList.userID 小队伍玩家ID
1143
+ * @param {string } rsp.brigades.playerList.userProfile 小队伍玩家自定义数据
1148
1144
* @memberof MatchvsResponse
1149
1145
*/
1150
1146
teamMatchResultNotify ( rsp :any ) :void
@@ -1156,6 +1152,68 @@ declare class MatchvsResponse {
1156
1152
* @memberof MatchvsResponse
1157
1153
*/
1158
1154
teamMatchStartNotify ( rsp :any ) :void
1155
+
1156
+ /**
1157
+ *
1158
+ * @param {number } rsp.status 状态值
1159
+ * @param {number } rsp.frameCount 帧数量
1160
+ * @param {number } rsp.msgCount 消息数量
1161
+ */
1162
+ getOffLineDataResponse ( rsp :any ) ;
1163
+
1164
+ /**
1165
+ * 取消组队匹配返回,但调用 cancelTeamMatch 接口后,通过这个接口接收服务的结果
1166
+ * @param {number } rsp.status
1167
+ */
1168
+ cancelTeamMatchResponse ( rsp :any ) ;
1169
+
1170
+ /**
1171
+ * 取消组队匹配时
1172
+ * @param {any } notify
1173
+ * @param {number } notify.userID 取消组队匹配的玩家ID
1174
+ * @param {string } notify.teamID 当前的队伍号
1175
+ * @param {string } notify.cpProto 取消时附带的消息
1176
+ */
1177
+ cancelTeamMatchNotify ( notify :any ) ;
1178
+
1179
+ /**
1180
+ * 在队伍中发送消息回调,调用sendTeamEvent 接口后,这个接口收到发送的结果
1181
+ * @param {any } rsp
1182
+ * @param {number } rsp.status 发送队伍消息的结果,200 成功。
1183
+ * @param {Array<number> } rsp.dstUserIDs 发送消息给了哪些玩家。
1184
+ */
1185
+ sendTeamEventResponse ( rsp :any ) ;
1186
+
1187
+ /**
1188
+ * 接收忘记发送队伍消息,当其他玩家在队伍中发送消息时,其他指定的玩家就能收到这个接口的回调
1189
+ * @param {any } notify
1190
+ * @param {any } notify.userID 发送消息的玩家ID
1191
+ * @param {any } notify.teamID 当前队伍号
1192
+ * @param {string } notify.cpProto 收到的数据
1193
+ */
1194
+ sendTeamEventNotify ( notify :any ) ;
1195
+
1196
+ /**
1197
+ * 调用 kickTeamMember 接口后,通过这个接口获取服务的结果
1198
+ * @param {any } rsp
1199
+ * @param {number } rsp.status 状态 200 表示成功
1200
+ * @param {Array<number> } rsp.members 队伍内剩下的玩家
1201
+ * @param {number } rsp.owner 当前队伍中队长
1202
+ * @param {string } rsp.teamID 当前队伍号
1203
+ */
1204
+ kickTeamMemberResponse ( rsp :any ) ;
1205
+
1206
+ /**
1207
+ * 收到踢人通知,当队伍中有人触发踢人接口,其他人就会收到这个接口的通知
1208
+ * @param {any } notify
1209
+ * @param {string } notify.teamID 当前队伍号
1210
+ * @param {number } notify.userID 当前发起踢人的玩家号
1211
+ * @param {number } notify.dstUserID 被踢的玩家号
1212
+ * @param {number } notify.owner 当前队伍的队长
1213
+ * @param {Array<number> } notify.members 队伍中剩下的玩家
1214
+ * @param {string } notify.cpProto 踢人时携带的消息
1215
+ */
1216
+ kickTeamMemberNotify ( notify :any ) ;
1159
1217
}
1160
1218
1161
1219
@@ -1176,31 +1234,31 @@ declare class MatchvsEngine {
1176
1234
* @param {string } pChannel 默认填写 "Matchvs"
1177
1235
* @param {string } pPlatform 有 release和alpha 两个值,对应两个不同环境。
1178
1236
* @param {number } gameID 游戏ID,官网生成
1237
+ * @param {number } appKey 游戏 App key 官网生成
1238
+ * @param {number } gameVersion 游戏版本,自定义,用于隔离匹配空间
1179
1239
* @returns {number }
1180
1240
*/
1181
- init ( pResponse : MatchvsResponse , pChannel : string , pPlatform : string , gameID : number ) : number
1241
+ init ( pResponse : MatchvsResponse , pChannel : string , pPlatform : string , gameID : number , appKey : string , gameVersion : number ) : number
1182
1242
1183
1243
/**
1184
1244
* 用于独立部署的初始化接口,初始化,后续收到的回调是都是由该对象初始化的pResponse对象控制。
1185
1245
* @param {MatchvsResponse } pResponse 这个参数需要保证全局唯一,避免在重定MatchvsResponse类型值时收不到 相关接口的
1186
1246
* @param {string } endPoint matchvs 服务部署的地址 有端口就要加上端口号,例如:www.matchvs.com:12345
1187
1247
* @param {number } gameID 独立部署配置的 游戏ID
1248
+ * @param {number } appKey 游戏 App key 官网生成
1188
1249
* @returns {number } 0-成功
1189
1250
*/
1190
- premiseInit ( pResponse : MatchvsResponse , endPoint :string , gameID :number ) : number
1251
+ premiseInit ( pResponse : MatchvsResponse , endPoint :string , gameID :number , appKey : string ) : number
1191
1252
1192
1253
/**
1193
1254
* 登录
1194
1255
* @param {number } pUserID 用户ID,该值必须使用 registerUser接口回调的用户ID
1195
1256
* @param {string } pToken 用户验证字段,用于验证 userID
1196
- * @param {number } pGameID 游戏ID,由 matchvs 官网生成
1197
- * @param {number } pGameVersion 开发者自定义 默认 1
1198
- * @param {string } pAppkey 游戏key 由 matchvs 官网生成
1199
1257
* @param pDeviceID 用于区分 用户在不同设备登录情况,用户只能在一个设备登录,默认填1,如果允许一个设备登录就要开发者
1200
1258
* 自定义唯一值,或者获取 设备ID值
1201
1259
* @returns {number }
1202
1260
*/
1203
- login ( pUserID : number , pToken : string , pGameID : number , pGameVersion : number , pAppkey : string , pDeviceID : string ) : number
1261
+ login ( pUserID : number , pToken : string , pDeviceID : string ) : number
1204
1262
1205
1263
/**
1206
1264
* 用户网关速度,暂时不用
@@ -1325,10 +1383,11 @@ declare class MatchvsEngine {
1325
1383
* frameRate ex:10/s . = 0 is off,>0 is on.
1326
1384
* @param {number } frameRate
1327
1385
* @param {number } enableGS 0-gs不参与帧同步 1-gs参与帧同步
1328
- * @param {number } other 其他数据
1386
+ * @param {any } other 其他数据
1387
+ * @param {any } other.cacheFrameMS 其他数据
1329
1388
* @returns {number }
1330
1389
*/
1331
- setFrameSync ( frameRate :number , enableGS ?:number ) :number
1390
+ setFrameSync ( frameRate :number , enableGS ?:number , other ?: any ) :number
1332
1391
1333
1392
1334
1393
/**
@@ -1356,9 +1415,9 @@ declare class MatchvsEngine {
1356
1415
1357
1416
/**
1358
1417
* 发送消息的扩展,sequence 的用途和 sendEvent 返回的 sequence 相同
1359
- * @param {number } msgType 0-包含destUids 1-排除destUids
1418
+ * @param {number } msgType 0-客户端+not GameServer 1-not客户端 + GameServer 2-客户端 + GameServer
1360
1419
* @param {string } data 要发送的数据
1361
- * @param {number } desttype 0-客户端+not CPS 1-not客户端+ CPS 2-客户端 + CPS
1420
+ * @param {number } desttype 0-包含destUids 1-排除destUids
1362
1421
* @param {Array<number> } userIDs 玩家ID集合 [1,2,3,4,5]
1363
1422
* @returns {{sequence: number, result: number} }
1364
1423
*/
@@ -1454,17 +1513,36 @@ declare class MatchvsEngine {
1454
1513
* @memberof MatchvsEngine
1455
1514
*/
1456
1515
teamMatch ( matchInfo :MVS . MsTeamMatchInfo ) :number
1457
- }
1458
1516
1459
- declare class md5 {
1460
- constructor ( ) ; //构造函数
1461
- /**
1462
- *
1463
- */
1464
- hex_md5 ( s :string ) :string
1465
- }
1517
+ /**
1518
+ * 获取断线期间的帧数据,只有开启的帧同步功能才能有效
1519
+ * @param cacheFrameMS
1520
+ */
1521
+ getOffLineData ( cacheFrameMS :number ) :number
1466
1522
1467
- declare class MatchvsHttp {
1468
- constructor ( callBack ) ; //构造函数
1469
- get ( url ) ;
1523
+ /**
1524
+ * 取消组队匹配,只有在组队匹配的时候才能调用这个接口
1525
+ * @param {object } args
1526
+ * @param {string } args.cpProto 取消组队匹配时携带的消息 长度不能超过 1024/B
1527
+ */
1528
+ cancelTeamMatch ( args :object ) :number
1529
+
1530
+ /**
1531
+ * 组队时,进入到同一个队伍中的玩家,可以通过这个接口来发送消息。这个消息发送频率是有限制 50ms/条。
1532
+ * @param {object } args
1533
+ * @param {number } args.dstType 0-包含dstUids 1-排除dstUids
1534
+ * @param {number } args.msgType 0-只发client 1-只发gs 2-client和 gs 都发
1535
+ * @param {Array<number> } args.dstUserIDs 指定的用户列表 配合 dstType 使用
1536
+ * @param {string } args.data 发送的数据 长度不能超过 1024/B
1537
+ */
1538
+ sendTeamEvent ( args :object ) :number
1539
+
1540
+ /**
1541
+ * 剔除队伍中的指定玩家,队伍中任何人都可以剔除任意人,但是不能剔除自己。
1542
+ * @param {object } args
1543
+ * @param {number } args.userID 要剔除的玩家
1544
+ * @param {number } args.cpProto 剔除玩家时携带的信息,长度不能超过 1024/B
1545
+ */
1546
+ kickTeamMember ( args :object ) :number
1470
1547
}
1548
+
0 commit comments