@defold-typescript/library-types 0.24.0 → 0.26.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/NOTICE +2 -3
- package/api-doc/boom.json +2 -0
- package/api-doc/checkpoint.json +127 -0
- package/api-doc/deftest.json +4 -0
- package/api-doc/nakama.session.json +315 -0
- package/api-doc/nakama.socket.json +3356 -0
- package/api-doc/shutter.json +551 -0
- package/authored-targets.json +44 -14
- package/generated/checkpoint.d.ts +62 -0
- package/generated/nakama.session.d.ts +95 -0
- package/generated/nakama.socket.d.ts +706 -0
- package/generated/proto.d.ts +4 -4
- package/generated/shutter.d.ts +183 -0
- package/package.json +2 -2
- package/scripts/extract-api-doc.ts +25 -4
- package/api-doc/starly.json +0 -488
- package/generated/starly.d.ts +0 -148
|
@@ -0,0 +1,3356 @@
|
|
|
1
|
+
{
|
|
2
|
+
"info": {
|
|
3
|
+
"namespace": "nakama.socket",
|
|
4
|
+
"brief": "",
|
|
5
|
+
"description": ""
|
|
6
|
+
},
|
|
7
|
+
"elements": [
|
|
8
|
+
{
|
|
9
|
+
"type": "VARIABLE",
|
|
10
|
+
"name": "CHANNELTYPE_UNSPECIFIED",
|
|
11
|
+
"brief": "Unspecified channel type. The server treats it as a room.",
|
|
12
|
+
"description": "Unspecified channel type. The server treats it as a room.",
|
|
13
|
+
"types": [
|
|
14
|
+
"0"
|
|
15
|
+
]
|
|
16
|
+
},
|
|
17
|
+
{
|
|
18
|
+
"type": "VARIABLE",
|
|
19
|
+
"name": "CHANNELTYPE_ROOM",
|
|
20
|
+
"brief": "A room anyone can join to chat in.",
|
|
21
|
+
"description": "A room anyone can join to chat in.",
|
|
22
|
+
"types": [
|
|
23
|
+
"1"
|
|
24
|
+
]
|
|
25
|
+
},
|
|
26
|
+
{
|
|
27
|
+
"type": "VARIABLE",
|
|
28
|
+
"name": "CHANNELTYPE_DIRECT_MESSAGE",
|
|
29
|
+
"brief": "A private channel for one-to-one chat.",
|
|
30
|
+
"description": "A private channel for one-to-one chat.",
|
|
31
|
+
"types": [
|
|
32
|
+
"2"
|
|
33
|
+
]
|
|
34
|
+
},
|
|
35
|
+
{
|
|
36
|
+
"type": "VARIABLE",
|
|
37
|
+
"name": "CHANNELTYPE_GROUP",
|
|
38
|
+
"brief": "A channel for group chat.",
|
|
39
|
+
"description": "A channel for group chat.",
|
|
40
|
+
"types": [
|
|
41
|
+
"3"
|
|
42
|
+
]
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
"type": "VARIABLE",
|
|
46
|
+
"name": "ERROR_RUNTIME_EXCEPTION",
|
|
47
|
+
"brief": "An unexpected result from the server.",
|
|
48
|
+
"description": "An unexpected result from the server.",
|
|
49
|
+
"types": [
|
|
50
|
+
"0"
|
|
51
|
+
]
|
|
52
|
+
},
|
|
53
|
+
{
|
|
54
|
+
"type": "VARIABLE",
|
|
55
|
+
"name": "ERROR_UNRECOGNIZED_PAYLOAD",
|
|
56
|
+
"brief": "The server received a message it does not recognise.",
|
|
57
|
+
"description": "The server received a message it does not recognise.",
|
|
58
|
+
"types": [
|
|
59
|
+
"1"
|
|
60
|
+
]
|
|
61
|
+
},
|
|
62
|
+
{
|
|
63
|
+
"type": "VARIABLE",
|
|
64
|
+
"name": "ERROR_MISSING_PAYLOAD",
|
|
65
|
+
"brief": "A message was expected but contains no content.",
|
|
66
|
+
"description": "A message was expected but contains no content.",
|
|
67
|
+
"types": [
|
|
68
|
+
"2"
|
|
69
|
+
]
|
|
70
|
+
},
|
|
71
|
+
{
|
|
72
|
+
"type": "VARIABLE",
|
|
73
|
+
"name": "ERROR_BAD_INPUT",
|
|
74
|
+
"brief": "Fields in the message have an invalid format.",
|
|
75
|
+
"description": "Fields in the message have an invalid format.",
|
|
76
|
+
"types": [
|
|
77
|
+
"3"
|
|
78
|
+
]
|
|
79
|
+
},
|
|
80
|
+
{
|
|
81
|
+
"type": "VARIABLE",
|
|
82
|
+
"name": "ERROR_MATCH_NOT_FOUND",
|
|
83
|
+
"brief": "The match id was not found.",
|
|
84
|
+
"description": "The match id was not found.",
|
|
85
|
+
"types": [
|
|
86
|
+
"4"
|
|
87
|
+
]
|
|
88
|
+
},
|
|
89
|
+
{
|
|
90
|
+
"type": "VARIABLE",
|
|
91
|
+
"name": "ERROR_MATCH_JOIN_REJECTED",
|
|
92
|
+
"brief": "The match join was rejected.",
|
|
93
|
+
"description": "The match join was rejected.",
|
|
94
|
+
"types": [
|
|
95
|
+
"5"
|
|
96
|
+
]
|
|
97
|
+
},
|
|
98
|
+
{
|
|
99
|
+
"type": "VARIABLE",
|
|
100
|
+
"name": "ERROR_RUNTIME_FUNCTION_NOT_FOUND",
|
|
101
|
+
"brief": "The runtime function does not exist on the server.",
|
|
102
|
+
"description": "The runtime function does not exist on the server.",
|
|
103
|
+
"types": [
|
|
104
|
+
"6"
|
|
105
|
+
]
|
|
106
|
+
},
|
|
107
|
+
{
|
|
108
|
+
"type": "VARIABLE",
|
|
109
|
+
"name": "ERROR_RUNTIME_FUNCTION_EXCEPTION",
|
|
110
|
+
"brief": "The runtime function executed with an error.",
|
|
111
|
+
"description": "The runtime function executed with an error.",
|
|
112
|
+
"types": [
|
|
113
|
+
"7"
|
|
114
|
+
]
|
|
115
|
+
},
|
|
116
|
+
{
|
|
117
|
+
"type": "FUNCTION",
|
|
118
|
+
"name": "create",
|
|
119
|
+
"brief": "Creates a realtime socket for a client, and binds every other export of this module",
|
|
120
|
+
"description": "Creates a realtime socket for a client, and binds every other export of this module\nonto it. `nakama.create_socket` is the same call reached through the core module.",
|
|
121
|
+
"parameters": [
|
|
122
|
+
{
|
|
123
|
+
"name": "client",
|
|
124
|
+
"doc": "A client created with `nakama.create_client`.",
|
|
125
|
+
"types": [
|
|
126
|
+
"unknown"
|
|
127
|
+
],
|
|
128
|
+
"is_optional": "False"
|
|
129
|
+
}
|
|
130
|
+
],
|
|
131
|
+
"returnvalues": [
|
|
132
|
+
{
|
|
133
|
+
"name": "",
|
|
134
|
+
"doc": "",
|
|
135
|
+
"types": [
|
|
136
|
+
"Socket"
|
|
137
|
+
]
|
|
138
|
+
}
|
|
139
|
+
]
|
|
140
|
+
},
|
|
141
|
+
{
|
|
142
|
+
"type": "FUNCTION",
|
|
143
|
+
"name": "connect",
|
|
144
|
+
"brief": "Opens the socket's websocket connection to the server.",
|
|
145
|
+
"description": "Opens the socket's websocket connection to the server.",
|
|
146
|
+
"parameters": [
|
|
147
|
+
{
|
|
148
|
+
"name": "socket",
|
|
149
|
+
"doc": "A socket created with `create`.",
|
|
150
|
+
"types": [
|
|
151
|
+
"Socket"
|
|
152
|
+
],
|
|
153
|
+
"is_optional": "False"
|
|
154
|
+
},
|
|
155
|
+
{
|
|
156
|
+
"name": "callback",
|
|
157
|
+
"doc": "Receives whether the connection succeeded, and the error if it did not.",
|
|
158
|
+
"types": [
|
|
159
|
+
"(success: boolean, error?: string) => void"
|
|
160
|
+
],
|
|
161
|
+
"is_optional": "True"
|
|
162
|
+
}
|
|
163
|
+
],
|
|
164
|
+
"returnvalues": [
|
|
165
|
+
{
|
|
166
|
+
"name": "",
|
|
167
|
+
"doc": "The result, when no callback is given.",
|
|
168
|
+
"types": [
|
|
169
|
+
"unknown"
|
|
170
|
+
]
|
|
171
|
+
}
|
|
172
|
+
]
|
|
173
|
+
},
|
|
174
|
+
{
|
|
175
|
+
"type": "FUNCTION",
|
|
176
|
+
"name": "send",
|
|
177
|
+
"brief": "Sends a prepared message table on the socket. The calls below build their own",
|
|
178
|
+
"description": "Sends a prepared message table on the socket. The calls below build their own\nmessage tables and pass them through here.",
|
|
179
|
+
"parameters": [
|
|
180
|
+
{
|
|
181
|
+
"name": "socket",
|
|
182
|
+
"doc": "A socket created with `create`.",
|
|
183
|
+
"types": [
|
|
184
|
+
"Socket"
|
|
185
|
+
],
|
|
186
|
+
"is_optional": "False"
|
|
187
|
+
},
|
|
188
|
+
{
|
|
189
|
+
"name": "message",
|
|
190
|
+
"doc": "The message table to send.",
|
|
191
|
+
"types": [
|
|
192
|
+
"unknown"
|
|
193
|
+
],
|
|
194
|
+
"is_optional": "False"
|
|
195
|
+
},
|
|
196
|
+
{
|
|
197
|
+
"name": "callback",
|
|
198
|
+
"doc": "Receives the server's response.",
|
|
199
|
+
"types": [
|
|
200
|
+
"(message: unknown) => void"
|
|
201
|
+
],
|
|
202
|
+
"is_optional": "True"
|
|
203
|
+
}
|
|
204
|
+
],
|
|
205
|
+
"returnvalues": [
|
|
206
|
+
{
|
|
207
|
+
"name": "",
|
|
208
|
+
"doc": "The response, when no callback is given.",
|
|
209
|
+
"types": [
|
|
210
|
+
"unknown"
|
|
211
|
+
]
|
|
212
|
+
}
|
|
213
|
+
]
|
|
214
|
+
},
|
|
215
|
+
{
|
|
216
|
+
"type": "FUNCTION",
|
|
217
|
+
"name": "on_disconnect",
|
|
218
|
+
"brief": "Registers the function to call when the connection drops. It is called with no",
|
|
219
|
+
"description": "Registers the function to call when the connection drops. It is called with no\narguments, and replaces the socket's bound `on_disconnect` method.",
|
|
220
|
+
"parameters": [
|
|
221
|
+
{
|
|
222
|
+
"name": "socket",
|
|
223
|
+
"doc": "A socket created with `create`.",
|
|
224
|
+
"types": [
|
|
225
|
+
"Socket"
|
|
226
|
+
],
|
|
227
|
+
"is_optional": "False"
|
|
228
|
+
},
|
|
229
|
+
{
|
|
230
|
+
"name": "fn",
|
|
231
|
+
"doc": "Called on disconnect.",
|
|
232
|
+
"types": [
|
|
233
|
+
"() => void"
|
|
234
|
+
],
|
|
235
|
+
"is_optional": "False"
|
|
236
|
+
}
|
|
237
|
+
],
|
|
238
|
+
"returnvalues": []
|
|
239
|
+
},
|
|
240
|
+
{
|
|
241
|
+
"type": "FUNCTION",
|
|
242
|
+
"name": "channel_join",
|
|
243
|
+
"brief": "Joins a chat channel.",
|
|
244
|
+
"description": "Joins a chat channel.",
|
|
245
|
+
"parameters": [
|
|
246
|
+
{
|
|
247
|
+
"name": "socket",
|
|
248
|
+
"doc": "A socket created with `create`.",
|
|
249
|
+
"types": [
|
|
250
|
+
"Socket"
|
|
251
|
+
],
|
|
252
|
+
"is_optional": "False"
|
|
253
|
+
},
|
|
254
|
+
{
|
|
255
|
+
"name": "target",
|
|
256
|
+
"doc": "The room name, group id or user id to join, depending on `type`.",
|
|
257
|
+
"types": [
|
|
258
|
+
"string"
|
|
259
|
+
],
|
|
260
|
+
"is_optional": "False"
|
|
261
|
+
},
|
|
262
|
+
{
|
|
263
|
+
"name": "type",
|
|
264
|
+
"doc": "One of the `CHANNELTYPE_*` constants.",
|
|
265
|
+
"types": [
|
|
266
|
+
"number"
|
|
267
|
+
],
|
|
268
|
+
"is_optional": "False"
|
|
269
|
+
},
|
|
270
|
+
{
|
|
271
|
+
"name": "persistence",
|
|
272
|
+
"doc": "Store the channel's messages on the server.",
|
|
273
|
+
"types": [
|
|
274
|
+
"boolean"
|
|
275
|
+
],
|
|
276
|
+
"is_optional": "False"
|
|
277
|
+
},
|
|
278
|
+
{
|
|
279
|
+
"name": "hidden",
|
|
280
|
+
"doc": "Join without appearing in the channel's presence list.",
|
|
281
|
+
"types": [
|
|
282
|
+
"boolean"
|
|
283
|
+
],
|
|
284
|
+
"is_optional": "False"
|
|
285
|
+
},
|
|
286
|
+
{
|
|
287
|
+
"name": "callback",
|
|
288
|
+
"doc": "Receives the server's response.",
|
|
289
|
+
"types": [
|
|
290
|
+
"(message: unknown) => void"
|
|
291
|
+
],
|
|
292
|
+
"is_optional": "True"
|
|
293
|
+
}
|
|
294
|
+
],
|
|
295
|
+
"returnvalues": [
|
|
296
|
+
{
|
|
297
|
+
"name": "",
|
|
298
|
+
"doc": "The response, when no callback is given.",
|
|
299
|
+
"types": [
|
|
300
|
+
"unknown"
|
|
301
|
+
]
|
|
302
|
+
}
|
|
303
|
+
]
|
|
304
|
+
},
|
|
305
|
+
{
|
|
306
|
+
"type": "FUNCTION",
|
|
307
|
+
"name": "channel_leave",
|
|
308
|
+
"brief": "Leaves a chat channel.",
|
|
309
|
+
"description": "Leaves a chat channel.",
|
|
310
|
+
"parameters": [
|
|
311
|
+
{
|
|
312
|
+
"name": "socket",
|
|
313
|
+
"doc": "A socket created with `create`.",
|
|
314
|
+
"types": [
|
|
315
|
+
"Socket"
|
|
316
|
+
],
|
|
317
|
+
"is_optional": "False"
|
|
318
|
+
},
|
|
319
|
+
{
|
|
320
|
+
"name": "channel_id",
|
|
321
|
+
"doc": "The channel to leave.",
|
|
322
|
+
"types": [
|
|
323
|
+
"string"
|
|
324
|
+
],
|
|
325
|
+
"is_optional": "False"
|
|
326
|
+
},
|
|
327
|
+
{
|
|
328
|
+
"name": "callback",
|
|
329
|
+
"doc": "Receives the server's response.",
|
|
330
|
+
"types": [
|
|
331
|
+
"(message: unknown) => void"
|
|
332
|
+
],
|
|
333
|
+
"is_optional": "True"
|
|
334
|
+
}
|
|
335
|
+
],
|
|
336
|
+
"returnvalues": [
|
|
337
|
+
{
|
|
338
|
+
"name": "",
|
|
339
|
+
"doc": "The response, when no callback is given.",
|
|
340
|
+
"types": [
|
|
341
|
+
"unknown"
|
|
342
|
+
]
|
|
343
|
+
}
|
|
344
|
+
]
|
|
345
|
+
},
|
|
346
|
+
{
|
|
347
|
+
"type": "FUNCTION",
|
|
348
|
+
"name": "channel_message_send",
|
|
349
|
+
"brief": "Sends a message to a joined chat channel.",
|
|
350
|
+
"description": "Sends a message to a joined chat channel.",
|
|
351
|
+
"parameters": [
|
|
352
|
+
{
|
|
353
|
+
"name": "socket",
|
|
354
|
+
"doc": "A socket created with `create`.",
|
|
355
|
+
"types": [
|
|
356
|
+
"Socket"
|
|
357
|
+
],
|
|
358
|
+
"is_optional": "False"
|
|
359
|
+
},
|
|
360
|
+
{
|
|
361
|
+
"name": "channel_id",
|
|
362
|
+
"doc": "The channel to send to.",
|
|
363
|
+
"types": [
|
|
364
|
+
"string"
|
|
365
|
+
],
|
|
366
|
+
"is_optional": "False"
|
|
367
|
+
},
|
|
368
|
+
{
|
|
369
|
+
"name": "content",
|
|
370
|
+
"doc": "The message content, as a JSON string.",
|
|
371
|
+
"types": [
|
|
372
|
+
"string"
|
|
373
|
+
],
|
|
374
|
+
"is_optional": "False"
|
|
375
|
+
},
|
|
376
|
+
{
|
|
377
|
+
"name": "callback",
|
|
378
|
+
"doc": "Receives the server's response.",
|
|
379
|
+
"types": [
|
|
380
|
+
"(message: unknown) => void"
|
|
381
|
+
],
|
|
382
|
+
"is_optional": "True"
|
|
383
|
+
}
|
|
384
|
+
],
|
|
385
|
+
"returnvalues": [
|
|
386
|
+
{
|
|
387
|
+
"name": "",
|
|
388
|
+
"doc": "The response, when no callback is given.",
|
|
389
|
+
"types": [
|
|
390
|
+
"unknown"
|
|
391
|
+
]
|
|
392
|
+
}
|
|
393
|
+
]
|
|
394
|
+
},
|
|
395
|
+
{
|
|
396
|
+
"type": "FUNCTION",
|
|
397
|
+
"name": "channel_message_remove",
|
|
398
|
+
"brief": "Removes a message previously sent to a chat channel.",
|
|
399
|
+
"description": "Removes a message previously sent to a chat channel.",
|
|
400
|
+
"parameters": [
|
|
401
|
+
{
|
|
402
|
+
"name": "socket",
|
|
403
|
+
"doc": "A socket created with `create`.",
|
|
404
|
+
"types": [
|
|
405
|
+
"Socket"
|
|
406
|
+
],
|
|
407
|
+
"is_optional": "False"
|
|
408
|
+
},
|
|
409
|
+
{
|
|
410
|
+
"name": "channel_id",
|
|
411
|
+
"doc": "The channel the message is in.",
|
|
412
|
+
"types": [
|
|
413
|
+
"string"
|
|
414
|
+
],
|
|
415
|
+
"is_optional": "False"
|
|
416
|
+
},
|
|
417
|
+
{
|
|
418
|
+
"name": "message_id",
|
|
419
|
+
"doc": "The message to remove.",
|
|
420
|
+
"types": [
|
|
421
|
+
"string"
|
|
422
|
+
],
|
|
423
|
+
"is_optional": "False"
|
|
424
|
+
},
|
|
425
|
+
{
|
|
426
|
+
"name": "callback",
|
|
427
|
+
"doc": "Receives the server's response.",
|
|
428
|
+
"types": [
|
|
429
|
+
"(message: unknown) => void"
|
|
430
|
+
],
|
|
431
|
+
"is_optional": "True"
|
|
432
|
+
}
|
|
433
|
+
],
|
|
434
|
+
"returnvalues": [
|
|
435
|
+
{
|
|
436
|
+
"name": "",
|
|
437
|
+
"doc": "The response, when no callback is given.",
|
|
438
|
+
"types": [
|
|
439
|
+
"unknown"
|
|
440
|
+
]
|
|
441
|
+
}
|
|
442
|
+
]
|
|
443
|
+
},
|
|
444
|
+
{
|
|
445
|
+
"type": "FUNCTION",
|
|
446
|
+
"name": "channel_message_update",
|
|
447
|
+
"brief": "Replaces the content of a message previously sent to a chat channel.",
|
|
448
|
+
"description": "Replaces the content of a message previously sent to a chat channel.",
|
|
449
|
+
"parameters": [
|
|
450
|
+
{
|
|
451
|
+
"name": "socket",
|
|
452
|
+
"doc": "A socket created with `create`.",
|
|
453
|
+
"types": [
|
|
454
|
+
"Socket"
|
|
455
|
+
],
|
|
456
|
+
"is_optional": "False"
|
|
457
|
+
},
|
|
458
|
+
{
|
|
459
|
+
"name": "channel_id",
|
|
460
|
+
"doc": "The channel the message is in.",
|
|
461
|
+
"types": [
|
|
462
|
+
"string"
|
|
463
|
+
],
|
|
464
|
+
"is_optional": "False"
|
|
465
|
+
},
|
|
466
|
+
{
|
|
467
|
+
"name": "message_id",
|
|
468
|
+
"doc": "The message to update.",
|
|
469
|
+
"types": [
|
|
470
|
+
"string"
|
|
471
|
+
],
|
|
472
|
+
"is_optional": "False"
|
|
473
|
+
},
|
|
474
|
+
{
|
|
475
|
+
"name": "content",
|
|
476
|
+
"doc": "The replacement content, as a JSON string.",
|
|
477
|
+
"types": [
|
|
478
|
+
"string"
|
|
479
|
+
],
|
|
480
|
+
"is_optional": "False"
|
|
481
|
+
},
|
|
482
|
+
{
|
|
483
|
+
"name": "callback",
|
|
484
|
+
"doc": "Receives the server's response.",
|
|
485
|
+
"types": [
|
|
486
|
+
"(message: unknown) => void"
|
|
487
|
+
],
|
|
488
|
+
"is_optional": "True"
|
|
489
|
+
}
|
|
490
|
+
],
|
|
491
|
+
"returnvalues": [
|
|
492
|
+
{
|
|
493
|
+
"name": "",
|
|
494
|
+
"doc": "The response, when no callback is given.",
|
|
495
|
+
"types": [
|
|
496
|
+
"unknown"
|
|
497
|
+
]
|
|
498
|
+
}
|
|
499
|
+
]
|
|
500
|
+
},
|
|
501
|
+
{
|
|
502
|
+
"type": "FUNCTION",
|
|
503
|
+
"name": "match_data_send",
|
|
504
|
+
"brief": "Sends data to a joined match. The data is base64-encoded on the way out and decoded",
|
|
505
|
+
"description": "Sends data to a joined match. The data is base64-encoded on the way out and decoded\nagain for the receiving `on_match_data` listener.",
|
|
506
|
+
"parameters": [
|
|
507
|
+
{
|
|
508
|
+
"name": "socket",
|
|
509
|
+
"doc": "A socket created with `create`.",
|
|
510
|
+
"types": [
|
|
511
|
+
"Socket"
|
|
512
|
+
],
|
|
513
|
+
"is_optional": "False"
|
|
514
|
+
},
|
|
515
|
+
{
|
|
516
|
+
"name": "match_id",
|
|
517
|
+
"doc": "The match to send to.",
|
|
518
|
+
"types": [
|
|
519
|
+
"string"
|
|
520
|
+
],
|
|
521
|
+
"is_optional": "False"
|
|
522
|
+
},
|
|
523
|
+
{
|
|
524
|
+
"name": "op_code",
|
|
525
|
+
"doc": "The application-defined operation code.",
|
|
526
|
+
"types": [
|
|
527
|
+
"number"
|
|
528
|
+
],
|
|
529
|
+
"is_optional": "False"
|
|
530
|
+
},
|
|
531
|
+
{
|
|
532
|
+
"name": "data",
|
|
533
|
+
"doc": "The payload.",
|
|
534
|
+
"types": [
|
|
535
|
+
"string"
|
|
536
|
+
],
|
|
537
|
+
"is_optional": "False"
|
|
538
|
+
},
|
|
539
|
+
{
|
|
540
|
+
"name": "presences",
|
|
541
|
+
"doc": "The presences to send to, or nil for everyone in the match.",
|
|
542
|
+
"types": [
|
|
543
|
+
"unknown"
|
|
544
|
+
],
|
|
545
|
+
"is_optional": "False"
|
|
546
|
+
},
|
|
547
|
+
{
|
|
548
|
+
"name": "reliable",
|
|
549
|
+
"doc": "Send over the reliable channel.",
|
|
550
|
+
"types": [
|
|
551
|
+
"boolean"
|
|
552
|
+
],
|
|
553
|
+
"is_optional": "False"
|
|
554
|
+
},
|
|
555
|
+
{
|
|
556
|
+
"name": "callback",
|
|
557
|
+
"doc": "Receives the server's response.",
|
|
558
|
+
"types": [
|
|
559
|
+
"(message: unknown) => void"
|
|
560
|
+
],
|
|
561
|
+
"is_optional": "True"
|
|
562
|
+
}
|
|
563
|
+
],
|
|
564
|
+
"returnvalues": [
|
|
565
|
+
{
|
|
566
|
+
"name": "",
|
|
567
|
+
"doc": "The response, when no callback is given.",
|
|
568
|
+
"types": [
|
|
569
|
+
"unknown"
|
|
570
|
+
]
|
|
571
|
+
}
|
|
572
|
+
]
|
|
573
|
+
},
|
|
574
|
+
{
|
|
575
|
+
"type": "FUNCTION",
|
|
576
|
+
"name": "match_create",
|
|
577
|
+
"brief": "Creates a new authoritative-relayed match.",
|
|
578
|
+
"description": "Creates a new authoritative-relayed match.",
|
|
579
|
+
"parameters": [
|
|
580
|
+
{
|
|
581
|
+
"name": "socket",
|
|
582
|
+
"doc": "A socket created with `create`.",
|
|
583
|
+
"types": [
|
|
584
|
+
"Socket"
|
|
585
|
+
],
|
|
586
|
+
"is_optional": "False"
|
|
587
|
+
},
|
|
588
|
+
{
|
|
589
|
+
"name": "name",
|
|
590
|
+
"doc": "The match name, or nil to let the server generate one.",
|
|
591
|
+
"types": [
|
|
592
|
+
"string | undefined"
|
|
593
|
+
],
|
|
594
|
+
"is_optional": "False"
|
|
595
|
+
},
|
|
596
|
+
{
|
|
597
|
+
"name": "callback",
|
|
598
|
+
"doc": "Receives the server's response.",
|
|
599
|
+
"types": [
|
|
600
|
+
"(message: unknown) => void"
|
|
601
|
+
],
|
|
602
|
+
"is_optional": "True"
|
|
603
|
+
}
|
|
604
|
+
],
|
|
605
|
+
"returnvalues": [
|
|
606
|
+
{
|
|
607
|
+
"name": "",
|
|
608
|
+
"doc": "The response, when no callback is given.",
|
|
609
|
+
"types": [
|
|
610
|
+
"unknown"
|
|
611
|
+
]
|
|
612
|
+
}
|
|
613
|
+
]
|
|
614
|
+
},
|
|
615
|
+
{
|
|
616
|
+
"type": "FUNCTION",
|
|
617
|
+
"name": "match_join",
|
|
618
|
+
"brief": "Joins a match by id, or by the token a matchmaker result carried. Exactly one of the",
|
|
619
|
+
"description": "Joins a match by id, or by the token a matchmaker result carried. Exactly one of the\ntwo identifiers is set; the other is nil.",
|
|
620
|
+
"parameters": [
|
|
621
|
+
{
|
|
622
|
+
"name": "socket",
|
|
623
|
+
"doc": "A socket created with `create`.",
|
|
624
|
+
"types": [
|
|
625
|
+
"Socket"
|
|
626
|
+
],
|
|
627
|
+
"is_optional": "False"
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
"name": "match_id",
|
|
631
|
+
"doc": "The match to join.",
|
|
632
|
+
"types": [
|
|
633
|
+
"string | undefined"
|
|
634
|
+
],
|
|
635
|
+
"is_optional": "False"
|
|
636
|
+
},
|
|
637
|
+
{
|
|
638
|
+
"name": "token",
|
|
639
|
+
"doc": "The match token, when joining a matchmaker result.",
|
|
640
|
+
"types": [
|
|
641
|
+
"string | undefined"
|
|
642
|
+
],
|
|
643
|
+
"is_optional": "False"
|
|
644
|
+
},
|
|
645
|
+
{
|
|
646
|
+
"name": "metadata",
|
|
647
|
+
"doc": "Metadata to present to the match's other members.",
|
|
648
|
+
"types": [
|
|
649
|
+
"unknown"
|
|
650
|
+
],
|
|
651
|
+
"is_optional": "False"
|
|
652
|
+
},
|
|
653
|
+
{
|
|
654
|
+
"name": "callback",
|
|
655
|
+
"doc": "Receives the server's response.",
|
|
656
|
+
"types": [
|
|
657
|
+
"(message: unknown) => void"
|
|
658
|
+
],
|
|
659
|
+
"is_optional": "True"
|
|
660
|
+
}
|
|
661
|
+
],
|
|
662
|
+
"returnvalues": [
|
|
663
|
+
{
|
|
664
|
+
"name": "",
|
|
665
|
+
"doc": "The response, when no callback is given.",
|
|
666
|
+
"types": [
|
|
667
|
+
"unknown"
|
|
668
|
+
]
|
|
669
|
+
}
|
|
670
|
+
]
|
|
671
|
+
},
|
|
672
|
+
{
|
|
673
|
+
"type": "FUNCTION",
|
|
674
|
+
"name": "match_leave",
|
|
675
|
+
"brief": "Leaves a joined match.",
|
|
676
|
+
"description": "Leaves a joined match.",
|
|
677
|
+
"parameters": [
|
|
678
|
+
{
|
|
679
|
+
"name": "socket",
|
|
680
|
+
"doc": "A socket created with `create`.",
|
|
681
|
+
"types": [
|
|
682
|
+
"Socket"
|
|
683
|
+
],
|
|
684
|
+
"is_optional": "False"
|
|
685
|
+
},
|
|
686
|
+
{
|
|
687
|
+
"name": "match_id",
|
|
688
|
+
"doc": "The match to leave.",
|
|
689
|
+
"types": [
|
|
690
|
+
"string"
|
|
691
|
+
],
|
|
692
|
+
"is_optional": "False"
|
|
693
|
+
},
|
|
694
|
+
{
|
|
695
|
+
"name": "callback",
|
|
696
|
+
"doc": "Receives the server's response.",
|
|
697
|
+
"types": [
|
|
698
|
+
"(message: unknown) => void"
|
|
699
|
+
],
|
|
700
|
+
"is_optional": "True"
|
|
701
|
+
}
|
|
702
|
+
],
|
|
703
|
+
"returnvalues": [
|
|
704
|
+
{
|
|
705
|
+
"name": "",
|
|
706
|
+
"doc": "The response, when no callback is given.",
|
|
707
|
+
"types": [
|
|
708
|
+
"unknown"
|
|
709
|
+
]
|
|
710
|
+
}
|
|
711
|
+
]
|
|
712
|
+
},
|
|
713
|
+
{
|
|
714
|
+
"type": "FUNCTION",
|
|
715
|
+
"name": "matchmaker_add",
|
|
716
|
+
"brief": "Joins the matchmaker pool. The ticket the server returns is what",
|
|
717
|
+
"description": "Joins the matchmaker pool. The ticket the server returns is what\n`matchmaker_remove` cancels with, and a match arrives through `on_matchmaker_matched`.",
|
|
718
|
+
"parameters": [
|
|
719
|
+
{
|
|
720
|
+
"name": "socket",
|
|
721
|
+
"doc": "A socket created with `create`.",
|
|
722
|
+
"types": [
|
|
723
|
+
"Socket"
|
|
724
|
+
],
|
|
725
|
+
"is_optional": "False"
|
|
726
|
+
},
|
|
727
|
+
{
|
|
728
|
+
"name": "min_count",
|
|
729
|
+
"doc": "The smallest acceptable match size.",
|
|
730
|
+
"types": [
|
|
731
|
+
"number"
|
|
732
|
+
],
|
|
733
|
+
"is_optional": "False"
|
|
734
|
+
},
|
|
735
|
+
{
|
|
736
|
+
"name": "max_count",
|
|
737
|
+
"doc": "The largest acceptable match size.",
|
|
738
|
+
"types": [
|
|
739
|
+
"number"
|
|
740
|
+
],
|
|
741
|
+
"is_optional": "False"
|
|
742
|
+
},
|
|
743
|
+
{
|
|
744
|
+
"name": "query",
|
|
745
|
+
"doc": "The matchmaker query to filter candidates by.",
|
|
746
|
+
"types": [
|
|
747
|
+
"string"
|
|
748
|
+
],
|
|
749
|
+
"is_optional": "False"
|
|
750
|
+
},
|
|
751
|
+
{
|
|
752
|
+
"name": "string_properties",
|
|
753
|
+
"doc": "This user's string properties, for other queries to match on.",
|
|
754
|
+
"types": [
|
|
755
|
+
"unknown"
|
|
756
|
+
],
|
|
757
|
+
"is_optional": "False"
|
|
758
|
+
},
|
|
759
|
+
{
|
|
760
|
+
"name": "numeric_properties",
|
|
761
|
+
"doc": "This user's numeric properties, for other queries to match on.",
|
|
762
|
+
"types": [
|
|
763
|
+
"unknown"
|
|
764
|
+
],
|
|
765
|
+
"is_optional": "False"
|
|
766
|
+
},
|
|
767
|
+
{
|
|
768
|
+
"name": "count_multiple",
|
|
769
|
+
"doc": "Only form matches whose size is a multiple of this.",
|
|
770
|
+
"types": [
|
|
771
|
+
"number"
|
|
772
|
+
],
|
|
773
|
+
"is_optional": "False"
|
|
774
|
+
},
|
|
775
|
+
{
|
|
776
|
+
"name": "callback",
|
|
777
|
+
"doc": "Receives the server's response.",
|
|
778
|
+
"types": [
|
|
779
|
+
"(message: unknown) => void"
|
|
780
|
+
],
|
|
781
|
+
"is_optional": "True"
|
|
782
|
+
}
|
|
783
|
+
],
|
|
784
|
+
"returnvalues": [
|
|
785
|
+
{
|
|
786
|
+
"name": "",
|
|
787
|
+
"doc": "The response, when no callback is given.",
|
|
788
|
+
"types": [
|
|
789
|
+
"unknown"
|
|
790
|
+
]
|
|
791
|
+
}
|
|
792
|
+
]
|
|
793
|
+
},
|
|
794
|
+
{
|
|
795
|
+
"type": "FUNCTION",
|
|
796
|
+
"name": "matchmaker_remove",
|
|
797
|
+
"brief": "Leaves the matchmaker pool.",
|
|
798
|
+
"description": "Leaves the matchmaker pool.",
|
|
799
|
+
"parameters": [
|
|
800
|
+
{
|
|
801
|
+
"name": "socket",
|
|
802
|
+
"doc": "A socket created with `create`.",
|
|
803
|
+
"types": [
|
|
804
|
+
"Socket"
|
|
805
|
+
],
|
|
806
|
+
"is_optional": "False"
|
|
807
|
+
},
|
|
808
|
+
{
|
|
809
|
+
"name": "ticket",
|
|
810
|
+
"doc": "The ticket `matchmaker_add` returned.",
|
|
811
|
+
"types": [
|
|
812
|
+
"string"
|
|
813
|
+
],
|
|
814
|
+
"is_optional": "False"
|
|
815
|
+
},
|
|
816
|
+
{
|
|
817
|
+
"name": "callback",
|
|
818
|
+
"doc": "Receives the server's response.",
|
|
819
|
+
"types": [
|
|
820
|
+
"(message: unknown) => void"
|
|
821
|
+
],
|
|
822
|
+
"is_optional": "True"
|
|
823
|
+
}
|
|
824
|
+
],
|
|
825
|
+
"returnvalues": [
|
|
826
|
+
{
|
|
827
|
+
"name": "",
|
|
828
|
+
"doc": "The response, when no callback is given.",
|
|
829
|
+
"types": [
|
|
830
|
+
"unknown"
|
|
831
|
+
]
|
|
832
|
+
}
|
|
833
|
+
]
|
|
834
|
+
},
|
|
835
|
+
{
|
|
836
|
+
"type": "FUNCTION",
|
|
837
|
+
"name": "party_create",
|
|
838
|
+
"brief": "Creates a party and makes this user its leader.",
|
|
839
|
+
"description": "Creates a party and makes this user its leader.",
|
|
840
|
+
"parameters": [
|
|
841
|
+
{
|
|
842
|
+
"name": "socket",
|
|
843
|
+
"doc": "A socket created with `create`.",
|
|
844
|
+
"types": [
|
|
845
|
+
"Socket"
|
|
846
|
+
],
|
|
847
|
+
"is_optional": "False"
|
|
848
|
+
},
|
|
849
|
+
{
|
|
850
|
+
"name": "open",
|
|
851
|
+
"doc": "Let users join without a join request.",
|
|
852
|
+
"types": [
|
|
853
|
+
"boolean"
|
|
854
|
+
],
|
|
855
|
+
"is_optional": "False"
|
|
856
|
+
},
|
|
857
|
+
{
|
|
858
|
+
"name": "max_size",
|
|
859
|
+
"doc": "The largest number of members the party accepts.",
|
|
860
|
+
"types": [
|
|
861
|
+
"number"
|
|
862
|
+
],
|
|
863
|
+
"is_optional": "False"
|
|
864
|
+
},
|
|
865
|
+
{
|
|
866
|
+
"name": "callback",
|
|
867
|
+
"doc": "Receives the server's response.",
|
|
868
|
+
"types": [
|
|
869
|
+
"(message: unknown) => void"
|
|
870
|
+
],
|
|
871
|
+
"is_optional": "True"
|
|
872
|
+
}
|
|
873
|
+
],
|
|
874
|
+
"returnvalues": [
|
|
875
|
+
{
|
|
876
|
+
"name": "",
|
|
877
|
+
"doc": "The response, when no callback is given.",
|
|
878
|
+
"types": [
|
|
879
|
+
"unknown"
|
|
880
|
+
]
|
|
881
|
+
}
|
|
882
|
+
]
|
|
883
|
+
},
|
|
884
|
+
{
|
|
885
|
+
"type": "FUNCTION",
|
|
886
|
+
"name": "party_join",
|
|
887
|
+
"brief": "Joins a party, or requests to join one that is not open.",
|
|
888
|
+
"description": "Joins a party, or requests to join one that is not open.",
|
|
889
|
+
"parameters": [
|
|
890
|
+
{
|
|
891
|
+
"name": "socket",
|
|
892
|
+
"doc": "A socket created with `create`.",
|
|
893
|
+
"types": [
|
|
894
|
+
"Socket"
|
|
895
|
+
],
|
|
896
|
+
"is_optional": "False"
|
|
897
|
+
},
|
|
898
|
+
{
|
|
899
|
+
"name": "party_id",
|
|
900
|
+
"doc": "The party to join.",
|
|
901
|
+
"types": [
|
|
902
|
+
"string"
|
|
903
|
+
],
|
|
904
|
+
"is_optional": "False"
|
|
905
|
+
},
|
|
906
|
+
{
|
|
907
|
+
"name": "callback",
|
|
908
|
+
"doc": "Receives the server's response.",
|
|
909
|
+
"types": [
|
|
910
|
+
"(message: unknown) => void"
|
|
911
|
+
],
|
|
912
|
+
"is_optional": "True"
|
|
913
|
+
}
|
|
914
|
+
],
|
|
915
|
+
"returnvalues": [
|
|
916
|
+
{
|
|
917
|
+
"name": "",
|
|
918
|
+
"doc": "The response, when no callback is given.",
|
|
919
|
+
"types": [
|
|
920
|
+
"unknown"
|
|
921
|
+
]
|
|
922
|
+
}
|
|
923
|
+
]
|
|
924
|
+
},
|
|
925
|
+
{
|
|
926
|
+
"type": "FUNCTION",
|
|
927
|
+
"name": "party_leave",
|
|
928
|
+
"brief": "Leaves a party.",
|
|
929
|
+
"description": "Leaves a party.",
|
|
930
|
+
"parameters": [
|
|
931
|
+
{
|
|
932
|
+
"name": "socket",
|
|
933
|
+
"doc": "A socket created with `create`.",
|
|
934
|
+
"types": [
|
|
935
|
+
"Socket"
|
|
936
|
+
],
|
|
937
|
+
"is_optional": "False"
|
|
938
|
+
},
|
|
939
|
+
{
|
|
940
|
+
"name": "party_id",
|
|
941
|
+
"doc": "The party to leave.",
|
|
942
|
+
"types": [
|
|
943
|
+
"string"
|
|
944
|
+
],
|
|
945
|
+
"is_optional": "False"
|
|
946
|
+
},
|
|
947
|
+
{
|
|
948
|
+
"name": "callback",
|
|
949
|
+
"doc": "Receives the server's response.",
|
|
950
|
+
"types": [
|
|
951
|
+
"(message: unknown) => void"
|
|
952
|
+
],
|
|
953
|
+
"is_optional": "True"
|
|
954
|
+
}
|
|
955
|
+
],
|
|
956
|
+
"returnvalues": [
|
|
957
|
+
{
|
|
958
|
+
"name": "",
|
|
959
|
+
"doc": "The response, when no callback is given.",
|
|
960
|
+
"types": [
|
|
961
|
+
"unknown"
|
|
962
|
+
]
|
|
963
|
+
}
|
|
964
|
+
]
|
|
965
|
+
},
|
|
966
|
+
{
|
|
967
|
+
"type": "FUNCTION",
|
|
968
|
+
"name": "party_promote",
|
|
969
|
+
"brief": "Promotes a party member to leader.",
|
|
970
|
+
"description": "Promotes a party member to leader.",
|
|
971
|
+
"parameters": [
|
|
972
|
+
{
|
|
973
|
+
"name": "socket",
|
|
974
|
+
"doc": "A socket created with `create`.",
|
|
975
|
+
"types": [
|
|
976
|
+
"Socket"
|
|
977
|
+
],
|
|
978
|
+
"is_optional": "False"
|
|
979
|
+
},
|
|
980
|
+
{
|
|
981
|
+
"name": "party_id",
|
|
982
|
+
"doc": "The party the member is in.",
|
|
983
|
+
"types": [
|
|
984
|
+
"string"
|
|
985
|
+
],
|
|
986
|
+
"is_optional": "False"
|
|
987
|
+
},
|
|
988
|
+
{
|
|
989
|
+
"name": "presence",
|
|
990
|
+
"doc": "The member's presence.",
|
|
991
|
+
"types": [
|
|
992
|
+
"unknown"
|
|
993
|
+
],
|
|
994
|
+
"is_optional": "False"
|
|
995
|
+
},
|
|
996
|
+
{
|
|
997
|
+
"name": "callback",
|
|
998
|
+
"doc": "Receives the server's response.",
|
|
999
|
+
"types": [
|
|
1000
|
+
"(message: unknown) => void"
|
|
1001
|
+
],
|
|
1002
|
+
"is_optional": "True"
|
|
1003
|
+
}
|
|
1004
|
+
],
|
|
1005
|
+
"returnvalues": [
|
|
1006
|
+
{
|
|
1007
|
+
"name": "",
|
|
1008
|
+
"doc": "The response, when no callback is given.",
|
|
1009
|
+
"types": [
|
|
1010
|
+
"unknown"
|
|
1011
|
+
]
|
|
1012
|
+
}
|
|
1013
|
+
]
|
|
1014
|
+
},
|
|
1015
|
+
{
|
|
1016
|
+
"type": "FUNCTION",
|
|
1017
|
+
"name": "party_accept",
|
|
1018
|
+
"brief": "Accepts a pending join request, as party leader.",
|
|
1019
|
+
"description": "Accepts a pending join request, as party leader.",
|
|
1020
|
+
"parameters": [
|
|
1021
|
+
{
|
|
1022
|
+
"name": "socket",
|
|
1023
|
+
"doc": "A socket created with `create`.",
|
|
1024
|
+
"types": [
|
|
1025
|
+
"Socket"
|
|
1026
|
+
],
|
|
1027
|
+
"is_optional": "False"
|
|
1028
|
+
},
|
|
1029
|
+
{
|
|
1030
|
+
"name": "party_id",
|
|
1031
|
+
"doc": "The party the request is for.",
|
|
1032
|
+
"types": [
|
|
1033
|
+
"string"
|
|
1034
|
+
],
|
|
1035
|
+
"is_optional": "False"
|
|
1036
|
+
},
|
|
1037
|
+
{
|
|
1038
|
+
"name": "presence",
|
|
1039
|
+
"doc": "The requesting user's presence.",
|
|
1040
|
+
"types": [
|
|
1041
|
+
"unknown"
|
|
1042
|
+
],
|
|
1043
|
+
"is_optional": "False"
|
|
1044
|
+
},
|
|
1045
|
+
{
|
|
1046
|
+
"name": "callback",
|
|
1047
|
+
"doc": "Receives the server's response.",
|
|
1048
|
+
"types": [
|
|
1049
|
+
"(message: unknown) => void"
|
|
1050
|
+
],
|
|
1051
|
+
"is_optional": "True"
|
|
1052
|
+
}
|
|
1053
|
+
],
|
|
1054
|
+
"returnvalues": [
|
|
1055
|
+
{
|
|
1056
|
+
"name": "",
|
|
1057
|
+
"doc": "The response, when no callback is given.",
|
|
1058
|
+
"types": [
|
|
1059
|
+
"unknown"
|
|
1060
|
+
]
|
|
1061
|
+
}
|
|
1062
|
+
]
|
|
1063
|
+
},
|
|
1064
|
+
{
|
|
1065
|
+
"type": "FUNCTION",
|
|
1066
|
+
"name": "party_remove",
|
|
1067
|
+
"brief": "Removes a member from the party, or rejects a pending join request.",
|
|
1068
|
+
"description": "Removes a member from the party, or rejects a pending join request.",
|
|
1069
|
+
"parameters": [
|
|
1070
|
+
{
|
|
1071
|
+
"name": "socket",
|
|
1072
|
+
"doc": "A socket created with `create`.",
|
|
1073
|
+
"types": [
|
|
1074
|
+
"Socket"
|
|
1075
|
+
],
|
|
1076
|
+
"is_optional": "False"
|
|
1077
|
+
},
|
|
1078
|
+
{
|
|
1079
|
+
"name": "party_id",
|
|
1080
|
+
"doc": "The party to remove from.",
|
|
1081
|
+
"types": [
|
|
1082
|
+
"string"
|
|
1083
|
+
],
|
|
1084
|
+
"is_optional": "False"
|
|
1085
|
+
},
|
|
1086
|
+
{
|
|
1087
|
+
"name": "presence",
|
|
1088
|
+
"doc": "The member's presence.",
|
|
1089
|
+
"types": [
|
|
1090
|
+
"unknown"
|
|
1091
|
+
],
|
|
1092
|
+
"is_optional": "False"
|
|
1093
|
+
},
|
|
1094
|
+
{
|
|
1095
|
+
"name": "callback",
|
|
1096
|
+
"doc": "Receives the server's response.",
|
|
1097
|
+
"types": [
|
|
1098
|
+
"(message: unknown) => void"
|
|
1099
|
+
],
|
|
1100
|
+
"is_optional": "True"
|
|
1101
|
+
}
|
|
1102
|
+
],
|
|
1103
|
+
"returnvalues": [
|
|
1104
|
+
{
|
|
1105
|
+
"name": "",
|
|
1106
|
+
"doc": "The response, when no callback is given.",
|
|
1107
|
+
"types": [
|
|
1108
|
+
"unknown"
|
|
1109
|
+
]
|
|
1110
|
+
}
|
|
1111
|
+
]
|
|
1112
|
+
},
|
|
1113
|
+
{
|
|
1114
|
+
"type": "FUNCTION",
|
|
1115
|
+
"name": "party_close",
|
|
1116
|
+
"brief": "Closes the party to new members and disbands it, as party leader.",
|
|
1117
|
+
"description": "Closes the party to new members and disbands it, as party leader.",
|
|
1118
|
+
"parameters": [
|
|
1119
|
+
{
|
|
1120
|
+
"name": "socket",
|
|
1121
|
+
"doc": "A socket created with `create`.",
|
|
1122
|
+
"types": [
|
|
1123
|
+
"Socket"
|
|
1124
|
+
],
|
|
1125
|
+
"is_optional": "False"
|
|
1126
|
+
},
|
|
1127
|
+
{
|
|
1128
|
+
"name": "party_id",
|
|
1129
|
+
"doc": "The party to close.",
|
|
1130
|
+
"types": [
|
|
1131
|
+
"string"
|
|
1132
|
+
],
|
|
1133
|
+
"is_optional": "False"
|
|
1134
|
+
},
|
|
1135
|
+
{
|
|
1136
|
+
"name": "callback",
|
|
1137
|
+
"doc": "Receives the server's response.",
|
|
1138
|
+
"types": [
|
|
1139
|
+
"(message: unknown) => void"
|
|
1140
|
+
],
|
|
1141
|
+
"is_optional": "True"
|
|
1142
|
+
}
|
|
1143
|
+
],
|
|
1144
|
+
"returnvalues": [
|
|
1145
|
+
{
|
|
1146
|
+
"name": "",
|
|
1147
|
+
"doc": "The response, when no callback is given.",
|
|
1148
|
+
"types": [
|
|
1149
|
+
"unknown"
|
|
1150
|
+
]
|
|
1151
|
+
}
|
|
1152
|
+
]
|
|
1153
|
+
},
|
|
1154
|
+
{
|
|
1155
|
+
"type": "FUNCTION",
|
|
1156
|
+
"name": "party_join_request_list",
|
|
1157
|
+
"brief": "Lists the party's pending join requests.",
|
|
1158
|
+
"description": "Lists the party's pending join requests.",
|
|
1159
|
+
"parameters": [
|
|
1160
|
+
{
|
|
1161
|
+
"name": "socket",
|
|
1162
|
+
"doc": "A socket created with `create`.",
|
|
1163
|
+
"types": [
|
|
1164
|
+
"Socket"
|
|
1165
|
+
],
|
|
1166
|
+
"is_optional": "False"
|
|
1167
|
+
},
|
|
1168
|
+
{
|
|
1169
|
+
"name": "party_id",
|
|
1170
|
+
"doc": "The party to list requests for.",
|
|
1171
|
+
"types": [
|
|
1172
|
+
"string"
|
|
1173
|
+
],
|
|
1174
|
+
"is_optional": "False"
|
|
1175
|
+
},
|
|
1176
|
+
{
|
|
1177
|
+
"name": "callback",
|
|
1178
|
+
"doc": "Receives the server's response.",
|
|
1179
|
+
"types": [
|
|
1180
|
+
"(message: unknown) => void"
|
|
1181
|
+
],
|
|
1182
|
+
"is_optional": "True"
|
|
1183
|
+
}
|
|
1184
|
+
],
|
|
1185
|
+
"returnvalues": [
|
|
1186
|
+
{
|
|
1187
|
+
"name": "",
|
|
1188
|
+
"doc": "The response, when no callback is given.",
|
|
1189
|
+
"types": [
|
|
1190
|
+
"unknown"
|
|
1191
|
+
]
|
|
1192
|
+
}
|
|
1193
|
+
]
|
|
1194
|
+
},
|
|
1195
|
+
{
|
|
1196
|
+
"type": "FUNCTION",
|
|
1197
|
+
"name": "party_matchmaker_add",
|
|
1198
|
+
"brief": "Joins the matchmaker pool as a whole party, as party leader.",
|
|
1199
|
+
"description": "Joins the matchmaker pool as a whole party, as party leader.",
|
|
1200
|
+
"parameters": [
|
|
1201
|
+
{
|
|
1202
|
+
"name": "socket",
|
|
1203
|
+
"doc": "A socket created with `create`.",
|
|
1204
|
+
"types": [
|
|
1205
|
+
"Socket"
|
|
1206
|
+
],
|
|
1207
|
+
"is_optional": "False"
|
|
1208
|
+
},
|
|
1209
|
+
{
|
|
1210
|
+
"name": "party_id",
|
|
1211
|
+
"doc": "The party to match with.",
|
|
1212
|
+
"types": [
|
|
1213
|
+
"string"
|
|
1214
|
+
],
|
|
1215
|
+
"is_optional": "False"
|
|
1216
|
+
},
|
|
1217
|
+
{
|
|
1218
|
+
"name": "min_count",
|
|
1219
|
+
"doc": "The smallest acceptable match size.",
|
|
1220
|
+
"types": [
|
|
1221
|
+
"number"
|
|
1222
|
+
],
|
|
1223
|
+
"is_optional": "False"
|
|
1224
|
+
},
|
|
1225
|
+
{
|
|
1226
|
+
"name": "max_count",
|
|
1227
|
+
"doc": "The largest acceptable match size.",
|
|
1228
|
+
"types": [
|
|
1229
|
+
"number"
|
|
1230
|
+
],
|
|
1231
|
+
"is_optional": "False"
|
|
1232
|
+
},
|
|
1233
|
+
{
|
|
1234
|
+
"name": "query",
|
|
1235
|
+
"doc": "The matchmaker query to filter candidates by.",
|
|
1236
|
+
"types": [
|
|
1237
|
+
"string"
|
|
1238
|
+
],
|
|
1239
|
+
"is_optional": "False"
|
|
1240
|
+
},
|
|
1241
|
+
{
|
|
1242
|
+
"name": "string_properties",
|
|
1243
|
+
"doc": "The party's string properties, for other queries to match on.",
|
|
1244
|
+
"types": [
|
|
1245
|
+
"unknown"
|
|
1246
|
+
],
|
|
1247
|
+
"is_optional": "False"
|
|
1248
|
+
},
|
|
1249
|
+
{
|
|
1250
|
+
"name": "numeric_properties",
|
|
1251
|
+
"doc": "The party's numeric properties, for other queries to match on.",
|
|
1252
|
+
"types": [
|
|
1253
|
+
"unknown"
|
|
1254
|
+
],
|
|
1255
|
+
"is_optional": "False"
|
|
1256
|
+
},
|
|
1257
|
+
{
|
|
1258
|
+
"name": "count_multiple",
|
|
1259
|
+
"doc": "Only form matches whose size is a multiple of this.",
|
|
1260
|
+
"types": [
|
|
1261
|
+
"number"
|
|
1262
|
+
],
|
|
1263
|
+
"is_optional": "False"
|
|
1264
|
+
},
|
|
1265
|
+
{
|
|
1266
|
+
"name": "callback",
|
|
1267
|
+
"doc": "Receives the server's response.",
|
|
1268
|
+
"types": [
|
|
1269
|
+
"(message: unknown) => void"
|
|
1270
|
+
],
|
|
1271
|
+
"is_optional": "True"
|
|
1272
|
+
}
|
|
1273
|
+
],
|
|
1274
|
+
"returnvalues": [
|
|
1275
|
+
{
|
|
1276
|
+
"name": "",
|
|
1277
|
+
"doc": "The response, when no callback is given.",
|
|
1278
|
+
"types": [
|
|
1279
|
+
"unknown"
|
|
1280
|
+
]
|
|
1281
|
+
}
|
|
1282
|
+
]
|
|
1283
|
+
},
|
|
1284
|
+
{
|
|
1285
|
+
"type": "FUNCTION",
|
|
1286
|
+
"name": "party_matchmaker_remove",
|
|
1287
|
+
"brief": "Takes the party back out of the matchmaker pool.",
|
|
1288
|
+
"description": "Takes the party back out of the matchmaker pool.",
|
|
1289
|
+
"parameters": [
|
|
1290
|
+
{
|
|
1291
|
+
"name": "socket",
|
|
1292
|
+
"doc": "A socket created with `create`.",
|
|
1293
|
+
"types": [
|
|
1294
|
+
"Socket"
|
|
1295
|
+
],
|
|
1296
|
+
"is_optional": "False"
|
|
1297
|
+
},
|
|
1298
|
+
{
|
|
1299
|
+
"name": "party_id",
|
|
1300
|
+
"doc": "The party to cancel for.",
|
|
1301
|
+
"types": [
|
|
1302
|
+
"string"
|
|
1303
|
+
],
|
|
1304
|
+
"is_optional": "False"
|
|
1305
|
+
},
|
|
1306
|
+
{
|
|
1307
|
+
"name": "ticket",
|
|
1308
|
+
"doc": "The ticket `party_matchmaker_add` returned.",
|
|
1309
|
+
"types": [
|
|
1310
|
+
"string"
|
|
1311
|
+
],
|
|
1312
|
+
"is_optional": "False"
|
|
1313
|
+
},
|
|
1314
|
+
{
|
|
1315
|
+
"name": "callback",
|
|
1316
|
+
"doc": "Receives the server's response.",
|
|
1317
|
+
"types": [
|
|
1318
|
+
"(message: unknown) => void"
|
|
1319
|
+
],
|
|
1320
|
+
"is_optional": "True"
|
|
1321
|
+
}
|
|
1322
|
+
],
|
|
1323
|
+
"returnvalues": [
|
|
1324
|
+
{
|
|
1325
|
+
"name": "",
|
|
1326
|
+
"doc": "The response, when no callback is given.",
|
|
1327
|
+
"types": [
|
|
1328
|
+
"unknown"
|
|
1329
|
+
]
|
|
1330
|
+
}
|
|
1331
|
+
]
|
|
1332
|
+
},
|
|
1333
|
+
{
|
|
1334
|
+
"type": "FUNCTION",
|
|
1335
|
+
"name": "party_data_send",
|
|
1336
|
+
"brief": "Sends data to every member of a party.",
|
|
1337
|
+
"description": "Sends data to every member of a party.",
|
|
1338
|
+
"parameters": [
|
|
1339
|
+
{
|
|
1340
|
+
"name": "socket",
|
|
1341
|
+
"doc": "A socket created with `create`.",
|
|
1342
|
+
"types": [
|
|
1343
|
+
"Socket"
|
|
1344
|
+
],
|
|
1345
|
+
"is_optional": "False"
|
|
1346
|
+
},
|
|
1347
|
+
{
|
|
1348
|
+
"name": "party_id",
|
|
1349
|
+
"doc": "The party to send to.",
|
|
1350
|
+
"types": [
|
|
1351
|
+
"string"
|
|
1352
|
+
],
|
|
1353
|
+
"is_optional": "False"
|
|
1354
|
+
},
|
|
1355
|
+
{
|
|
1356
|
+
"name": "op_code",
|
|
1357
|
+
"doc": "The application-defined operation code.",
|
|
1358
|
+
"types": [
|
|
1359
|
+
"number"
|
|
1360
|
+
],
|
|
1361
|
+
"is_optional": "False"
|
|
1362
|
+
},
|
|
1363
|
+
{
|
|
1364
|
+
"name": "data",
|
|
1365
|
+
"doc": "The payload.",
|
|
1366
|
+
"types": [
|
|
1367
|
+
"string"
|
|
1368
|
+
],
|
|
1369
|
+
"is_optional": "False"
|
|
1370
|
+
},
|
|
1371
|
+
{
|
|
1372
|
+
"name": "callback",
|
|
1373
|
+
"doc": "Receives the server's response.",
|
|
1374
|
+
"types": [
|
|
1375
|
+
"(message: unknown) => void"
|
|
1376
|
+
],
|
|
1377
|
+
"is_optional": "True"
|
|
1378
|
+
}
|
|
1379
|
+
],
|
|
1380
|
+
"returnvalues": [
|
|
1381
|
+
{
|
|
1382
|
+
"name": "",
|
|
1383
|
+
"doc": "The response, when no callback is given.",
|
|
1384
|
+
"types": [
|
|
1385
|
+
"unknown"
|
|
1386
|
+
]
|
|
1387
|
+
}
|
|
1388
|
+
]
|
|
1389
|
+
},
|
|
1390
|
+
{
|
|
1391
|
+
"type": "FUNCTION",
|
|
1392
|
+
"name": "status_follow",
|
|
1393
|
+
"brief": "Subscribes to the status updates of the given users.",
|
|
1394
|
+
"description": "Subscribes to the status updates of the given users.",
|
|
1395
|
+
"parameters": [
|
|
1396
|
+
{
|
|
1397
|
+
"name": "socket",
|
|
1398
|
+
"doc": "A socket created with `create`.",
|
|
1399
|
+
"types": [
|
|
1400
|
+
"Socket"
|
|
1401
|
+
],
|
|
1402
|
+
"is_optional": "False"
|
|
1403
|
+
},
|
|
1404
|
+
{
|
|
1405
|
+
"name": "user_ids",
|
|
1406
|
+
"doc": "The user ids to follow.",
|
|
1407
|
+
"types": [
|
|
1408
|
+
"string"
|
|
1409
|
+
],
|
|
1410
|
+
"is_optional": "False"
|
|
1411
|
+
},
|
|
1412
|
+
{
|
|
1413
|
+
"name": "usernames",
|
|
1414
|
+
"doc": "The usernames to follow.",
|
|
1415
|
+
"types": [
|
|
1416
|
+
"string"
|
|
1417
|
+
],
|
|
1418
|
+
"is_optional": "False"
|
|
1419
|
+
},
|
|
1420
|
+
{
|
|
1421
|
+
"name": "callback",
|
|
1422
|
+
"doc": "Receives the server's response.",
|
|
1423
|
+
"types": [
|
|
1424
|
+
"(message: unknown) => void"
|
|
1425
|
+
],
|
|
1426
|
+
"is_optional": "True"
|
|
1427
|
+
}
|
|
1428
|
+
],
|
|
1429
|
+
"returnvalues": [
|
|
1430
|
+
{
|
|
1431
|
+
"name": "",
|
|
1432
|
+
"doc": "The response, when no callback is given.",
|
|
1433
|
+
"types": [
|
|
1434
|
+
"unknown"
|
|
1435
|
+
]
|
|
1436
|
+
}
|
|
1437
|
+
]
|
|
1438
|
+
},
|
|
1439
|
+
{
|
|
1440
|
+
"type": "FUNCTION",
|
|
1441
|
+
"name": "status_unfollow",
|
|
1442
|
+
"brief": "Unsubscribes from the status updates of the given users.",
|
|
1443
|
+
"description": "Unsubscribes from the status updates of the given users.",
|
|
1444
|
+
"parameters": [
|
|
1445
|
+
{
|
|
1446
|
+
"name": "socket",
|
|
1447
|
+
"doc": "A socket created with `create`.",
|
|
1448
|
+
"types": [
|
|
1449
|
+
"Socket"
|
|
1450
|
+
],
|
|
1451
|
+
"is_optional": "False"
|
|
1452
|
+
},
|
|
1453
|
+
{
|
|
1454
|
+
"name": "user_ids",
|
|
1455
|
+
"doc": "The user ids to unfollow.",
|
|
1456
|
+
"types": [
|
|
1457
|
+
"string"
|
|
1458
|
+
],
|
|
1459
|
+
"is_optional": "False"
|
|
1460
|
+
},
|
|
1461
|
+
{
|
|
1462
|
+
"name": "callback",
|
|
1463
|
+
"doc": "Receives the server's response.",
|
|
1464
|
+
"types": [
|
|
1465
|
+
"(message: unknown) => void"
|
|
1466
|
+
],
|
|
1467
|
+
"is_optional": "True"
|
|
1468
|
+
}
|
|
1469
|
+
],
|
|
1470
|
+
"returnvalues": [
|
|
1471
|
+
{
|
|
1472
|
+
"name": "",
|
|
1473
|
+
"doc": "The response, when no callback is given.",
|
|
1474
|
+
"types": [
|
|
1475
|
+
"unknown"
|
|
1476
|
+
]
|
|
1477
|
+
}
|
|
1478
|
+
]
|
|
1479
|
+
},
|
|
1480
|
+
{
|
|
1481
|
+
"type": "FUNCTION",
|
|
1482
|
+
"name": "status_update",
|
|
1483
|
+
"brief": "Sets this user's status message, or clears it when the status is empty.",
|
|
1484
|
+
"description": "Sets this user's status message, or clears it when the status is empty.",
|
|
1485
|
+
"parameters": [
|
|
1486
|
+
{
|
|
1487
|
+
"name": "socket",
|
|
1488
|
+
"doc": "A socket created with `create`.",
|
|
1489
|
+
"types": [
|
|
1490
|
+
"Socket"
|
|
1491
|
+
],
|
|
1492
|
+
"is_optional": "False"
|
|
1493
|
+
},
|
|
1494
|
+
{
|
|
1495
|
+
"name": "status",
|
|
1496
|
+
"doc": "The status message to publish to followers.",
|
|
1497
|
+
"types": [
|
|
1498
|
+
"string"
|
|
1499
|
+
],
|
|
1500
|
+
"is_optional": "False"
|
|
1501
|
+
},
|
|
1502
|
+
{
|
|
1503
|
+
"name": "callback",
|
|
1504
|
+
"doc": "Receives the server's response.",
|
|
1505
|
+
"types": [
|
|
1506
|
+
"(message: unknown) => void"
|
|
1507
|
+
],
|
|
1508
|
+
"is_optional": "True"
|
|
1509
|
+
}
|
|
1510
|
+
],
|
|
1511
|
+
"returnvalues": [
|
|
1512
|
+
{
|
|
1513
|
+
"name": "",
|
|
1514
|
+
"doc": "The response, when no callback is given.",
|
|
1515
|
+
"types": [
|
|
1516
|
+
"unknown"
|
|
1517
|
+
]
|
|
1518
|
+
}
|
|
1519
|
+
]
|
|
1520
|
+
},
|
|
1521
|
+
{
|
|
1522
|
+
"type": "FUNCTION",
|
|
1523
|
+
"name": "on_channel_presence_event",
|
|
1524
|
+
"brief": "Registers the function to call when someone joins or leaves a joined chat channel.",
|
|
1525
|
+
"description": "Registers the function to call when someone joins or leaves a joined chat channel.",
|
|
1526
|
+
"parameters": [
|
|
1527
|
+
{
|
|
1528
|
+
"name": "socket",
|
|
1529
|
+
"doc": "A socket created with `create`.",
|
|
1530
|
+
"types": [
|
|
1531
|
+
"Socket"
|
|
1532
|
+
],
|
|
1533
|
+
"is_optional": "False"
|
|
1534
|
+
},
|
|
1535
|
+
{
|
|
1536
|
+
"name": "fn",
|
|
1537
|
+
"doc": "Receives the channel presence event.",
|
|
1538
|
+
"types": [
|
|
1539
|
+
"(message: unknown) => void"
|
|
1540
|
+
],
|
|
1541
|
+
"is_optional": "False"
|
|
1542
|
+
}
|
|
1543
|
+
],
|
|
1544
|
+
"returnvalues": []
|
|
1545
|
+
},
|
|
1546
|
+
{
|
|
1547
|
+
"type": "FUNCTION",
|
|
1548
|
+
"name": "on_match_presence_event",
|
|
1549
|
+
"brief": "Registers the function to call when someone joins or leaves a joined match.",
|
|
1550
|
+
"description": "Registers the function to call when someone joins or leaves a joined match.",
|
|
1551
|
+
"parameters": [
|
|
1552
|
+
{
|
|
1553
|
+
"name": "socket",
|
|
1554
|
+
"doc": "A socket created with `create`.",
|
|
1555
|
+
"types": [
|
|
1556
|
+
"Socket"
|
|
1557
|
+
],
|
|
1558
|
+
"is_optional": "False"
|
|
1559
|
+
},
|
|
1560
|
+
{
|
|
1561
|
+
"name": "fn",
|
|
1562
|
+
"doc": "Receives the match presence event.",
|
|
1563
|
+
"types": [
|
|
1564
|
+
"(message: unknown) => void"
|
|
1565
|
+
],
|
|
1566
|
+
"is_optional": "False"
|
|
1567
|
+
}
|
|
1568
|
+
],
|
|
1569
|
+
"returnvalues": []
|
|
1570
|
+
},
|
|
1571
|
+
{
|
|
1572
|
+
"type": "FUNCTION",
|
|
1573
|
+
"name": "on_match_data",
|
|
1574
|
+
"brief": "Registers the function to call when match data arrives. The payload is",
|
|
1575
|
+
"description": "Registers the function to call when match data arrives. The payload is\nbase64-decoded before the listener sees it.",
|
|
1576
|
+
"parameters": [
|
|
1577
|
+
{
|
|
1578
|
+
"name": "socket",
|
|
1579
|
+
"doc": "A socket created with `create`.",
|
|
1580
|
+
"types": [
|
|
1581
|
+
"Socket"
|
|
1582
|
+
],
|
|
1583
|
+
"is_optional": "False"
|
|
1584
|
+
},
|
|
1585
|
+
{
|
|
1586
|
+
"name": "fn",
|
|
1587
|
+
"doc": "Receives the match data.",
|
|
1588
|
+
"types": [
|
|
1589
|
+
"(message: unknown) => void"
|
|
1590
|
+
],
|
|
1591
|
+
"is_optional": "False"
|
|
1592
|
+
}
|
|
1593
|
+
],
|
|
1594
|
+
"returnvalues": []
|
|
1595
|
+
},
|
|
1596
|
+
{
|
|
1597
|
+
"type": "FUNCTION",
|
|
1598
|
+
"name": "on_match",
|
|
1599
|
+
"brief": "Registers the function to call when a match is created or joined.",
|
|
1600
|
+
"description": "Registers the function to call when a match is created or joined.",
|
|
1601
|
+
"parameters": [
|
|
1602
|
+
{
|
|
1603
|
+
"name": "socket",
|
|
1604
|
+
"doc": "A socket created with `create`.",
|
|
1605
|
+
"types": [
|
|
1606
|
+
"Socket"
|
|
1607
|
+
],
|
|
1608
|
+
"is_optional": "False"
|
|
1609
|
+
},
|
|
1610
|
+
{
|
|
1611
|
+
"name": "fn",
|
|
1612
|
+
"doc": "Receives the match.",
|
|
1613
|
+
"types": [
|
|
1614
|
+
"(message: unknown) => void"
|
|
1615
|
+
],
|
|
1616
|
+
"is_optional": "False"
|
|
1617
|
+
}
|
|
1618
|
+
],
|
|
1619
|
+
"returnvalues": []
|
|
1620
|
+
},
|
|
1621
|
+
{
|
|
1622
|
+
"type": "FUNCTION",
|
|
1623
|
+
"name": "on_matchmaker_matched",
|
|
1624
|
+
"brief": "Registers the function to call when the matchmaker finds a match. Its token is what",
|
|
1625
|
+
"description": "Registers the function to call when the matchmaker finds a match. Its token is what\n`match_join` takes.",
|
|
1626
|
+
"parameters": [
|
|
1627
|
+
{
|
|
1628
|
+
"name": "socket",
|
|
1629
|
+
"doc": "A socket created with `create`.",
|
|
1630
|
+
"types": [
|
|
1631
|
+
"Socket"
|
|
1632
|
+
],
|
|
1633
|
+
"is_optional": "False"
|
|
1634
|
+
},
|
|
1635
|
+
{
|
|
1636
|
+
"name": "fn",
|
|
1637
|
+
"doc": "Receives the matchmaker result.",
|
|
1638
|
+
"types": [
|
|
1639
|
+
"(message: unknown) => void"
|
|
1640
|
+
],
|
|
1641
|
+
"is_optional": "False"
|
|
1642
|
+
}
|
|
1643
|
+
],
|
|
1644
|
+
"returnvalues": []
|
|
1645
|
+
},
|
|
1646
|
+
{
|
|
1647
|
+
"type": "FUNCTION",
|
|
1648
|
+
"name": "on_notifications",
|
|
1649
|
+
"brief": "Registers the function to call when notifications arrive for this user.",
|
|
1650
|
+
"description": "Registers the function to call when notifications arrive for this user.",
|
|
1651
|
+
"parameters": [
|
|
1652
|
+
{
|
|
1653
|
+
"name": "socket",
|
|
1654
|
+
"doc": "A socket created with `create`.",
|
|
1655
|
+
"types": [
|
|
1656
|
+
"Socket"
|
|
1657
|
+
],
|
|
1658
|
+
"is_optional": "False"
|
|
1659
|
+
},
|
|
1660
|
+
{
|
|
1661
|
+
"name": "fn",
|
|
1662
|
+
"doc": "Receives the notifications.",
|
|
1663
|
+
"types": [
|
|
1664
|
+
"(message: unknown) => void"
|
|
1665
|
+
],
|
|
1666
|
+
"is_optional": "False"
|
|
1667
|
+
}
|
|
1668
|
+
],
|
|
1669
|
+
"returnvalues": []
|
|
1670
|
+
},
|
|
1671
|
+
{
|
|
1672
|
+
"type": "FUNCTION",
|
|
1673
|
+
"name": "on_party_presence_event",
|
|
1674
|
+
"brief": "Registers the function to call when someone joins or leaves a joined party.",
|
|
1675
|
+
"description": "Registers the function to call when someone joins or leaves a joined party.",
|
|
1676
|
+
"parameters": [
|
|
1677
|
+
{
|
|
1678
|
+
"name": "socket",
|
|
1679
|
+
"doc": "A socket created with `create`.",
|
|
1680
|
+
"types": [
|
|
1681
|
+
"Socket"
|
|
1682
|
+
],
|
|
1683
|
+
"is_optional": "False"
|
|
1684
|
+
},
|
|
1685
|
+
{
|
|
1686
|
+
"name": "fn",
|
|
1687
|
+
"doc": "Receives the party presence event.",
|
|
1688
|
+
"types": [
|
|
1689
|
+
"(message: unknown) => void"
|
|
1690
|
+
],
|
|
1691
|
+
"is_optional": "False"
|
|
1692
|
+
}
|
|
1693
|
+
],
|
|
1694
|
+
"returnvalues": []
|
|
1695
|
+
},
|
|
1696
|
+
{
|
|
1697
|
+
"type": "FUNCTION",
|
|
1698
|
+
"name": "on_party",
|
|
1699
|
+
"brief": "Registers the function to call when a party is created or joined.",
|
|
1700
|
+
"description": "Registers the function to call when a party is created or joined.",
|
|
1701
|
+
"parameters": [
|
|
1702
|
+
{
|
|
1703
|
+
"name": "socket",
|
|
1704
|
+
"doc": "A socket created with `create`.",
|
|
1705
|
+
"types": [
|
|
1706
|
+
"Socket"
|
|
1707
|
+
],
|
|
1708
|
+
"is_optional": "False"
|
|
1709
|
+
},
|
|
1710
|
+
{
|
|
1711
|
+
"name": "fn",
|
|
1712
|
+
"doc": "Receives the party.",
|
|
1713
|
+
"types": [
|
|
1714
|
+
"(message: unknown) => void"
|
|
1715
|
+
],
|
|
1716
|
+
"is_optional": "False"
|
|
1717
|
+
}
|
|
1718
|
+
],
|
|
1719
|
+
"returnvalues": []
|
|
1720
|
+
},
|
|
1721
|
+
{
|
|
1722
|
+
"type": "FUNCTION",
|
|
1723
|
+
"name": "on_party_data",
|
|
1724
|
+
"brief": "Registers the function to call when party data arrives.",
|
|
1725
|
+
"description": "Registers the function to call when party data arrives.",
|
|
1726
|
+
"parameters": [
|
|
1727
|
+
{
|
|
1728
|
+
"name": "socket",
|
|
1729
|
+
"doc": "A socket created with `create`.",
|
|
1730
|
+
"types": [
|
|
1731
|
+
"Socket"
|
|
1732
|
+
],
|
|
1733
|
+
"is_optional": "False"
|
|
1734
|
+
},
|
|
1735
|
+
{
|
|
1736
|
+
"name": "fn",
|
|
1737
|
+
"doc": "Receives the party data.",
|
|
1738
|
+
"types": [
|
|
1739
|
+
"(message: unknown) => void"
|
|
1740
|
+
],
|
|
1741
|
+
"is_optional": "False"
|
|
1742
|
+
}
|
|
1743
|
+
],
|
|
1744
|
+
"returnvalues": []
|
|
1745
|
+
},
|
|
1746
|
+
{
|
|
1747
|
+
"type": "FUNCTION",
|
|
1748
|
+
"name": "on_party_join_request",
|
|
1749
|
+
"brief": "Registers the function to call when someone asks to join a party this user leads.",
|
|
1750
|
+
"description": "Registers the function to call when someone asks to join a party this user leads.",
|
|
1751
|
+
"parameters": [
|
|
1752
|
+
{
|
|
1753
|
+
"name": "socket",
|
|
1754
|
+
"doc": "A socket created with `create`.",
|
|
1755
|
+
"types": [
|
|
1756
|
+
"Socket"
|
|
1757
|
+
],
|
|
1758
|
+
"is_optional": "False"
|
|
1759
|
+
},
|
|
1760
|
+
{
|
|
1761
|
+
"name": "fn",
|
|
1762
|
+
"doc": "Receives the join request.",
|
|
1763
|
+
"types": [
|
|
1764
|
+
"(message: unknown) => void"
|
|
1765
|
+
],
|
|
1766
|
+
"is_optional": "False"
|
|
1767
|
+
}
|
|
1768
|
+
],
|
|
1769
|
+
"returnvalues": []
|
|
1770
|
+
},
|
|
1771
|
+
{
|
|
1772
|
+
"type": "FUNCTION",
|
|
1773
|
+
"name": "on_party_leader",
|
|
1774
|
+
"brief": "Registers the function to call when a party changes leader.",
|
|
1775
|
+
"description": "Registers the function to call when a party changes leader.",
|
|
1776
|
+
"parameters": [
|
|
1777
|
+
{
|
|
1778
|
+
"name": "socket",
|
|
1779
|
+
"doc": "A socket created with `create`.",
|
|
1780
|
+
"types": [
|
|
1781
|
+
"Socket"
|
|
1782
|
+
],
|
|
1783
|
+
"is_optional": "False"
|
|
1784
|
+
},
|
|
1785
|
+
{
|
|
1786
|
+
"name": "fn",
|
|
1787
|
+
"doc": "Receives the new leader.",
|
|
1788
|
+
"types": [
|
|
1789
|
+
"(message: unknown) => void"
|
|
1790
|
+
],
|
|
1791
|
+
"is_optional": "False"
|
|
1792
|
+
}
|
|
1793
|
+
],
|
|
1794
|
+
"returnvalues": []
|
|
1795
|
+
},
|
|
1796
|
+
{
|
|
1797
|
+
"type": "FUNCTION",
|
|
1798
|
+
"name": "on_status_presence_event",
|
|
1799
|
+
"brief": "Registers the function to call when a followed user comes online or goes offline.",
|
|
1800
|
+
"description": "Registers the function to call when a followed user comes online or goes offline.",
|
|
1801
|
+
"parameters": [
|
|
1802
|
+
{
|
|
1803
|
+
"name": "socket",
|
|
1804
|
+
"doc": "A socket created with `create`.",
|
|
1805
|
+
"types": [
|
|
1806
|
+
"Socket"
|
|
1807
|
+
],
|
|
1808
|
+
"is_optional": "False"
|
|
1809
|
+
},
|
|
1810
|
+
{
|
|
1811
|
+
"name": "fn",
|
|
1812
|
+
"doc": "Receives the status presence event.",
|
|
1813
|
+
"types": [
|
|
1814
|
+
"(message: unknown) => void"
|
|
1815
|
+
],
|
|
1816
|
+
"is_optional": "False"
|
|
1817
|
+
}
|
|
1818
|
+
],
|
|
1819
|
+
"returnvalues": []
|
|
1820
|
+
},
|
|
1821
|
+
{
|
|
1822
|
+
"type": "FUNCTION",
|
|
1823
|
+
"name": "on_status",
|
|
1824
|
+
"brief": "Registers the function to call when a followed user changes their status message.",
|
|
1825
|
+
"description": "Registers the function to call when a followed user changes their status message.",
|
|
1826
|
+
"parameters": [
|
|
1827
|
+
{
|
|
1828
|
+
"name": "socket",
|
|
1829
|
+
"doc": "A socket created with `create`.",
|
|
1830
|
+
"types": [
|
|
1831
|
+
"Socket"
|
|
1832
|
+
],
|
|
1833
|
+
"is_optional": "False"
|
|
1834
|
+
},
|
|
1835
|
+
{
|
|
1836
|
+
"name": "fn",
|
|
1837
|
+
"doc": "Receives the status.",
|
|
1838
|
+
"types": [
|
|
1839
|
+
"(message: unknown) => void"
|
|
1840
|
+
],
|
|
1841
|
+
"is_optional": "False"
|
|
1842
|
+
}
|
|
1843
|
+
],
|
|
1844
|
+
"returnvalues": []
|
|
1845
|
+
},
|
|
1846
|
+
{
|
|
1847
|
+
"type": "FUNCTION",
|
|
1848
|
+
"name": "on_stream_data",
|
|
1849
|
+
"brief": "Registers the function to call when data arrives on a subscribed stream.",
|
|
1850
|
+
"description": "Registers the function to call when data arrives on a subscribed stream.",
|
|
1851
|
+
"parameters": [
|
|
1852
|
+
{
|
|
1853
|
+
"name": "socket",
|
|
1854
|
+
"doc": "A socket created with `create`.",
|
|
1855
|
+
"types": [
|
|
1856
|
+
"Socket"
|
|
1857
|
+
],
|
|
1858
|
+
"is_optional": "False"
|
|
1859
|
+
},
|
|
1860
|
+
{
|
|
1861
|
+
"name": "fn",
|
|
1862
|
+
"doc": "Receives the stream data.",
|
|
1863
|
+
"types": [
|
|
1864
|
+
"(message: unknown) => void"
|
|
1865
|
+
],
|
|
1866
|
+
"is_optional": "False"
|
|
1867
|
+
}
|
|
1868
|
+
],
|
|
1869
|
+
"returnvalues": []
|
|
1870
|
+
},
|
|
1871
|
+
{
|
|
1872
|
+
"type": "FUNCTION",
|
|
1873
|
+
"name": "on_error",
|
|
1874
|
+
"brief": "Registers the function to call when the server reports an error. Its code is one of",
|
|
1875
|
+
"description": "Registers the function to call when the server reports an error. Its code is one of\nthe `ERROR_*` constants.",
|
|
1876
|
+
"parameters": [
|
|
1877
|
+
{
|
|
1878
|
+
"name": "socket",
|
|
1879
|
+
"doc": "A socket created with `create`.",
|
|
1880
|
+
"types": [
|
|
1881
|
+
"Socket"
|
|
1882
|
+
],
|
|
1883
|
+
"is_optional": "False"
|
|
1884
|
+
},
|
|
1885
|
+
{
|
|
1886
|
+
"name": "fn",
|
|
1887
|
+
"doc": "Receives the error.",
|
|
1888
|
+
"types": [
|
|
1889
|
+
"(message: unknown) => void"
|
|
1890
|
+
],
|
|
1891
|
+
"is_optional": "False"
|
|
1892
|
+
}
|
|
1893
|
+
],
|
|
1894
|
+
"returnvalues": []
|
|
1895
|
+
},
|
|
1896
|
+
{
|
|
1897
|
+
"type": "FUNCTION",
|
|
1898
|
+
"name": "on_channel_message",
|
|
1899
|
+
"brief": "Registers the function to call when a message arrives on a joined chat channel.",
|
|
1900
|
+
"description": "Registers the function to call when a message arrives on a joined chat channel.",
|
|
1901
|
+
"parameters": [
|
|
1902
|
+
{
|
|
1903
|
+
"name": "socket",
|
|
1904
|
+
"doc": "A socket created with `create`.",
|
|
1905
|
+
"types": [
|
|
1906
|
+
"Socket"
|
|
1907
|
+
],
|
|
1908
|
+
"is_optional": "False"
|
|
1909
|
+
},
|
|
1910
|
+
{
|
|
1911
|
+
"name": "fn",
|
|
1912
|
+
"doc": "Receives the channel message.",
|
|
1913
|
+
"types": [
|
|
1914
|
+
"(message: unknown) => void"
|
|
1915
|
+
],
|
|
1916
|
+
"is_optional": "False"
|
|
1917
|
+
}
|
|
1918
|
+
],
|
|
1919
|
+
"returnvalues": []
|
|
1920
|
+
},
|
|
1921
|
+
{
|
|
1922
|
+
"type": "TYPEDEF",
|
|
1923
|
+
"name": "Socket",
|
|
1924
|
+
"functions": [
|
|
1925
|
+
{
|
|
1926
|
+
"type": "FUNCTION",
|
|
1927
|
+
"name": "connect",
|
|
1928
|
+
"brief": "",
|
|
1929
|
+
"description": "",
|
|
1930
|
+
"parameters": [
|
|
1931
|
+
{
|
|
1932
|
+
"name": "callback",
|
|
1933
|
+
"doc": "",
|
|
1934
|
+
"types": [
|
|
1935
|
+
"(success: boolean, error?: string) => void"
|
|
1936
|
+
],
|
|
1937
|
+
"is_optional": "True"
|
|
1938
|
+
}
|
|
1939
|
+
],
|
|
1940
|
+
"returnvalues": [
|
|
1941
|
+
{
|
|
1942
|
+
"name": "",
|
|
1943
|
+
"doc": "",
|
|
1944
|
+
"types": [
|
|
1945
|
+
"unknown"
|
|
1946
|
+
]
|
|
1947
|
+
}
|
|
1948
|
+
]
|
|
1949
|
+
},
|
|
1950
|
+
{
|
|
1951
|
+
"type": "FUNCTION",
|
|
1952
|
+
"name": "send",
|
|
1953
|
+
"brief": "",
|
|
1954
|
+
"description": "",
|
|
1955
|
+
"parameters": [
|
|
1956
|
+
{
|
|
1957
|
+
"name": "message",
|
|
1958
|
+
"doc": "",
|
|
1959
|
+
"types": [
|
|
1960
|
+
"unknown"
|
|
1961
|
+
],
|
|
1962
|
+
"is_optional": "False"
|
|
1963
|
+
},
|
|
1964
|
+
{
|
|
1965
|
+
"name": "callback",
|
|
1966
|
+
"doc": "",
|
|
1967
|
+
"types": [
|
|
1968
|
+
"(message: unknown) => void"
|
|
1969
|
+
],
|
|
1970
|
+
"is_optional": "True"
|
|
1971
|
+
}
|
|
1972
|
+
],
|
|
1973
|
+
"returnvalues": [
|
|
1974
|
+
{
|
|
1975
|
+
"name": "",
|
|
1976
|
+
"doc": "",
|
|
1977
|
+
"types": [
|
|
1978
|
+
"unknown"
|
|
1979
|
+
]
|
|
1980
|
+
}
|
|
1981
|
+
]
|
|
1982
|
+
},
|
|
1983
|
+
{
|
|
1984
|
+
"type": "FUNCTION",
|
|
1985
|
+
"name": "on_disconnect",
|
|
1986
|
+
"brief": "",
|
|
1987
|
+
"description": "",
|
|
1988
|
+
"parameters": [
|
|
1989
|
+
{
|
|
1990
|
+
"name": "fn",
|
|
1991
|
+
"doc": "",
|
|
1992
|
+
"types": [
|
|
1993
|
+
"() => void"
|
|
1994
|
+
],
|
|
1995
|
+
"is_optional": "False"
|
|
1996
|
+
}
|
|
1997
|
+
],
|
|
1998
|
+
"returnvalues": []
|
|
1999
|
+
},
|
|
2000
|
+
{
|
|
2001
|
+
"type": "FUNCTION",
|
|
2002
|
+
"name": "channel_join",
|
|
2003
|
+
"brief": "",
|
|
2004
|
+
"description": "",
|
|
2005
|
+
"parameters": [
|
|
2006
|
+
{
|
|
2007
|
+
"name": "target",
|
|
2008
|
+
"doc": "",
|
|
2009
|
+
"types": [
|
|
2010
|
+
"string"
|
|
2011
|
+
],
|
|
2012
|
+
"is_optional": "False"
|
|
2013
|
+
},
|
|
2014
|
+
{
|
|
2015
|
+
"name": "type",
|
|
2016
|
+
"doc": "",
|
|
2017
|
+
"types": [
|
|
2018
|
+
"number"
|
|
2019
|
+
],
|
|
2020
|
+
"is_optional": "False"
|
|
2021
|
+
},
|
|
2022
|
+
{
|
|
2023
|
+
"name": "persistence",
|
|
2024
|
+
"doc": "",
|
|
2025
|
+
"types": [
|
|
2026
|
+
"boolean"
|
|
2027
|
+
],
|
|
2028
|
+
"is_optional": "False"
|
|
2029
|
+
},
|
|
2030
|
+
{
|
|
2031
|
+
"name": "hidden",
|
|
2032
|
+
"doc": "",
|
|
2033
|
+
"types": [
|
|
2034
|
+
"boolean"
|
|
2035
|
+
],
|
|
2036
|
+
"is_optional": "False"
|
|
2037
|
+
},
|
|
2038
|
+
{
|
|
2039
|
+
"name": "callback",
|
|
2040
|
+
"doc": "",
|
|
2041
|
+
"types": [
|
|
2042
|
+
"(message: unknown) => void"
|
|
2043
|
+
],
|
|
2044
|
+
"is_optional": "True"
|
|
2045
|
+
}
|
|
2046
|
+
],
|
|
2047
|
+
"returnvalues": [
|
|
2048
|
+
{
|
|
2049
|
+
"name": "",
|
|
2050
|
+
"doc": "",
|
|
2051
|
+
"types": [
|
|
2052
|
+
"unknown"
|
|
2053
|
+
]
|
|
2054
|
+
}
|
|
2055
|
+
]
|
|
2056
|
+
},
|
|
2057
|
+
{
|
|
2058
|
+
"type": "FUNCTION",
|
|
2059
|
+
"name": "channel_leave",
|
|
2060
|
+
"brief": "",
|
|
2061
|
+
"description": "",
|
|
2062
|
+
"parameters": [
|
|
2063
|
+
{
|
|
2064
|
+
"name": "channel_id",
|
|
2065
|
+
"doc": "",
|
|
2066
|
+
"types": [
|
|
2067
|
+
"string"
|
|
2068
|
+
],
|
|
2069
|
+
"is_optional": "False"
|
|
2070
|
+
},
|
|
2071
|
+
{
|
|
2072
|
+
"name": "callback",
|
|
2073
|
+
"doc": "",
|
|
2074
|
+
"types": [
|
|
2075
|
+
"(message: unknown) => void"
|
|
2076
|
+
],
|
|
2077
|
+
"is_optional": "True"
|
|
2078
|
+
}
|
|
2079
|
+
],
|
|
2080
|
+
"returnvalues": [
|
|
2081
|
+
{
|
|
2082
|
+
"name": "",
|
|
2083
|
+
"doc": "",
|
|
2084
|
+
"types": [
|
|
2085
|
+
"unknown"
|
|
2086
|
+
]
|
|
2087
|
+
}
|
|
2088
|
+
]
|
|
2089
|
+
},
|
|
2090
|
+
{
|
|
2091
|
+
"type": "FUNCTION",
|
|
2092
|
+
"name": "channel_message_send",
|
|
2093
|
+
"brief": "",
|
|
2094
|
+
"description": "",
|
|
2095
|
+
"parameters": [
|
|
2096
|
+
{
|
|
2097
|
+
"name": "channel_id",
|
|
2098
|
+
"doc": "",
|
|
2099
|
+
"types": [
|
|
2100
|
+
"string"
|
|
2101
|
+
],
|
|
2102
|
+
"is_optional": "False"
|
|
2103
|
+
},
|
|
2104
|
+
{
|
|
2105
|
+
"name": "content",
|
|
2106
|
+
"doc": "",
|
|
2107
|
+
"types": [
|
|
2108
|
+
"string"
|
|
2109
|
+
],
|
|
2110
|
+
"is_optional": "False"
|
|
2111
|
+
},
|
|
2112
|
+
{
|
|
2113
|
+
"name": "callback",
|
|
2114
|
+
"doc": "",
|
|
2115
|
+
"types": [
|
|
2116
|
+
"(message: unknown) => void"
|
|
2117
|
+
],
|
|
2118
|
+
"is_optional": "True"
|
|
2119
|
+
}
|
|
2120
|
+
],
|
|
2121
|
+
"returnvalues": [
|
|
2122
|
+
{
|
|
2123
|
+
"name": "",
|
|
2124
|
+
"doc": "",
|
|
2125
|
+
"types": [
|
|
2126
|
+
"unknown"
|
|
2127
|
+
]
|
|
2128
|
+
}
|
|
2129
|
+
]
|
|
2130
|
+
},
|
|
2131
|
+
{
|
|
2132
|
+
"type": "FUNCTION",
|
|
2133
|
+
"name": "channel_message_remove",
|
|
2134
|
+
"brief": "",
|
|
2135
|
+
"description": "",
|
|
2136
|
+
"parameters": [
|
|
2137
|
+
{
|
|
2138
|
+
"name": "channel_id",
|
|
2139
|
+
"doc": "",
|
|
2140
|
+
"types": [
|
|
2141
|
+
"string"
|
|
2142
|
+
],
|
|
2143
|
+
"is_optional": "False"
|
|
2144
|
+
},
|
|
2145
|
+
{
|
|
2146
|
+
"name": "message_id",
|
|
2147
|
+
"doc": "",
|
|
2148
|
+
"types": [
|
|
2149
|
+
"string"
|
|
2150
|
+
],
|
|
2151
|
+
"is_optional": "False"
|
|
2152
|
+
},
|
|
2153
|
+
{
|
|
2154
|
+
"name": "callback",
|
|
2155
|
+
"doc": "",
|
|
2156
|
+
"types": [
|
|
2157
|
+
"(message: unknown) => void"
|
|
2158
|
+
],
|
|
2159
|
+
"is_optional": "True"
|
|
2160
|
+
}
|
|
2161
|
+
],
|
|
2162
|
+
"returnvalues": [
|
|
2163
|
+
{
|
|
2164
|
+
"name": "",
|
|
2165
|
+
"doc": "",
|
|
2166
|
+
"types": [
|
|
2167
|
+
"unknown"
|
|
2168
|
+
]
|
|
2169
|
+
}
|
|
2170
|
+
]
|
|
2171
|
+
},
|
|
2172
|
+
{
|
|
2173
|
+
"type": "FUNCTION",
|
|
2174
|
+
"name": "channel_message_update",
|
|
2175
|
+
"brief": "",
|
|
2176
|
+
"description": "",
|
|
2177
|
+
"parameters": [
|
|
2178
|
+
{
|
|
2179
|
+
"name": "channel_id",
|
|
2180
|
+
"doc": "",
|
|
2181
|
+
"types": [
|
|
2182
|
+
"string"
|
|
2183
|
+
],
|
|
2184
|
+
"is_optional": "False"
|
|
2185
|
+
},
|
|
2186
|
+
{
|
|
2187
|
+
"name": "message_id",
|
|
2188
|
+
"doc": "",
|
|
2189
|
+
"types": [
|
|
2190
|
+
"string"
|
|
2191
|
+
],
|
|
2192
|
+
"is_optional": "False"
|
|
2193
|
+
},
|
|
2194
|
+
{
|
|
2195
|
+
"name": "content",
|
|
2196
|
+
"doc": "",
|
|
2197
|
+
"types": [
|
|
2198
|
+
"string"
|
|
2199
|
+
],
|
|
2200
|
+
"is_optional": "False"
|
|
2201
|
+
},
|
|
2202
|
+
{
|
|
2203
|
+
"name": "callback",
|
|
2204
|
+
"doc": "",
|
|
2205
|
+
"types": [
|
|
2206
|
+
"(message: unknown) => void"
|
|
2207
|
+
],
|
|
2208
|
+
"is_optional": "True"
|
|
2209
|
+
}
|
|
2210
|
+
],
|
|
2211
|
+
"returnvalues": [
|
|
2212
|
+
{
|
|
2213
|
+
"name": "",
|
|
2214
|
+
"doc": "",
|
|
2215
|
+
"types": [
|
|
2216
|
+
"unknown"
|
|
2217
|
+
]
|
|
2218
|
+
}
|
|
2219
|
+
]
|
|
2220
|
+
},
|
|
2221
|
+
{
|
|
2222
|
+
"type": "FUNCTION",
|
|
2223
|
+
"name": "match_data_send",
|
|
2224
|
+
"brief": "",
|
|
2225
|
+
"description": "",
|
|
2226
|
+
"parameters": [
|
|
2227
|
+
{
|
|
2228
|
+
"name": "match_id",
|
|
2229
|
+
"doc": "",
|
|
2230
|
+
"types": [
|
|
2231
|
+
"string"
|
|
2232
|
+
],
|
|
2233
|
+
"is_optional": "False"
|
|
2234
|
+
},
|
|
2235
|
+
{
|
|
2236
|
+
"name": "op_code",
|
|
2237
|
+
"doc": "",
|
|
2238
|
+
"types": [
|
|
2239
|
+
"number"
|
|
2240
|
+
],
|
|
2241
|
+
"is_optional": "False"
|
|
2242
|
+
},
|
|
2243
|
+
{
|
|
2244
|
+
"name": "data",
|
|
2245
|
+
"doc": "",
|
|
2246
|
+
"types": [
|
|
2247
|
+
"string"
|
|
2248
|
+
],
|
|
2249
|
+
"is_optional": "False"
|
|
2250
|
+
},
|
|
2251
|
+
{
|
|
2252
|
+
"name": "presences",
|
|
2253
|
+
"doc": "",
|
|
2254
|
+
"types": [
|
|
2255
|
+
"unknown"
|
|
2256
|
+
],
|
|
2257
|
+
"is_optional": "False"
|
|
2258
|
+
},
|
|
2259
|
+
{
|
|
2260
|
+
"name": "reliable",
|
|
2261
|
+
"doc": "",
|
|
2262
|
+
"types": [
|
|
2263
|
+
"boolean"
|
|
2264
|
+
],
|
|
2265
|
+
"is_optional": "False"
|
|
2266
|
+
},
|
|
2267
|
+
{
|
|
2268
|
+
"name": "callback",
|
|
2269
|
+
"doc": "",
|
|
2270
|
+
"types": [
|
|
2271
|
+
"(message: unknown) => void"
|
|
2272
|
+
],
|
|
2273
|
+
"is_optional": "True"
|
|
2274
|
+
}
|
|
2275
|
+
],
|
|
2276
|
+
"returnvalues": [
|
|
2277
|
+
{
|
|
2278
|
+
"name": "",
|
|
2279
|
+
"doc": "",
|
|
2280
|
+
"types": [
|
|
2281
|
+
"unknown"
|
|
2282
|
+
]
|
|
2283
|
+
}
|
|
2284
|
+
]
|
|
2285
|
+
},
|
|
2286
|
+
{
|
|
2287
|
+
"type": "FUNCTION",
|
|
2288
|
+
"name": "match_create",
|
|
2289
|
+
"brief": "",
|
|
2290
|
+
"description": "",
|
|
2291
|
+
"parameters": [
|
|
2292
|
+
{
|
|
2293
|
+
"name": "name",
|
|
2294
|
+
"doc": "",
|
|
2295
|
+
"types": [
|
|
2296
|
+
"string | undefined"
|
|
2297
|
+
],
|
|
2298
|
+
"is_optional": "False"
|
|
2299
|
+
},
|
|
2300
|
+
{
|
|
2301
|
+
"name": "callback",
|
|
2302
|
+
"doc": "",
|
|
2303
|
+
"types": [
|
|
2304
|
+
"(message: unknown) => void"
|
|
2305
|
+
],
|
|
2306
|
+
"is_optional": "True"
|
|
2307
|
+
}
|
|
2308
|
+
],
|
|
2309
|
+
"returnvalues": [
|
|
2310
|
+
{
|
|
2311
|
+
"name": "",
|
|
2312
|
+
"doc": "",
|
|
2313
|
+
"types": [
|
|
2314
|
+
"unknown"
|
|
2315
|
+
]
|
|
2316
|
+
}
|
|
2317
|
+
]
|
|
2318
|
+
},
|
|
2319
|
+
{
|
|
2320
|
+
"type": "FUNCTION",
|
|
2321
|
+
"name": "match_join",
|
|
2322
|
+
"brief": "",
|
|
2323
|
+
"description": "",
|
|
2324
|
+
"parameters": [
|
|
2325
|
+
{
|
|
2326
|
+
"name": "match_id",
|
|
2327
|
+
"doc": "",
|
|
2328
|
+
"types": [
|
|
2329
|
+
"string | undefined"
|
|
2330
|
+
],
|
|
2331
|
+
"is_optional": "False"
|
|
2332
|
+
},
|
|
2333
|
+
{
|
|
2334
|
+
"name": "token",
|
|
2335
|
+
"doc": "",
|
|
2336
|
+
"types": [
|
|
2337
|
+
"string | undefined"
|
|
2338
|
+
],
|
|
2339
|
+
"is_optional": "False"
|
|
2340
|
+
},
|
|
2341
|
+
{
|
|
2342
|
+
"name": "metadata",
|
|
2343
|
+
"doc": "",
|
|
2344
|
+
"types": [
|
|
2345
|
+
"unknown"
|
|
2346
|
+
],
|
|
2347
|
+
"is_optional": "False"
|
|
2348
|
+
},
|
|
2349
|
+
{
|
|
2350
|
+
"name": "callback",
|
|
2351
|
+
"doc": "",
|
|
2352
|
+
"types": [
|
|
2353
|
+
"(message: unknown) => void"
|
|
2354
|
+
],
|
|
2355
|
+
"is_optional": "True"
|
|
2356
|
+
}
|
|
2357
|
+
],
|
|
2358
|
+
"returnvalues": [
|
|
2359
|
+
{
|
|
2360
|
+
"name": "",
|
|
2361
|
+
"doc": "",
|
|
2362
|
+
"types": [
|
|
2363
|
+
"unknown"
|
|
2364
|
+
]
|
|
2365
|
+
}
|
|
2366
|
+
]
|
|
2367
|
+
},
|
|
2368
|
+
{
|
|
2369
|
+
"type": "FUNCTION",
|
|
2370
|
+
"name": "match_leave",
|
|
2371
|
+
"brief": "",
|
|
2372
|
+
"description": "",
|
|
2373
|
+
"parameters": [
|
|
2374
|
+
{
|
|
2375
|
+
"name": "match_id",
|
|
2376
|
+
"doc": "",
|
|
2377
|
+
"types": [
|
|
2378
|
+
"string"
|
|
2379
|
+
],
|
|
2380
|
+
"is_optional": "False"
|
|
2381
|
+
},
|
|
2382
|
+
{
|
|
2383
|
+
"name": "callback",
|
|
2384
|
+
"doc": "",
|
|
2385
|
+
"types": [
|
|
2386
|
+
"(message: unknown) => void"
|
|
2387
|
+
],
|
|
2388
|
+
"is_optional": "True"
|
|
2389
|
+
}
|
|
2390
|
+
],
|
|
2391
|
+
"returnvalues": [
|
|
2392
|
+
{
|
|
2393
|
+
"name": "",
|
|
2394
|
+
"doc": "",
|
|
2395
|
+
"types": [
|
|
2396
|
+
"unknown"
|
|
2397
|
+
]
|
|
2398
|
+
}
|
|
2399
|
+
]
|
|
2400
|
+
},
|
|
2401
|
+
{
|
|
2402
|
+
"type": "FUNCTION",
|
|
2403
|
+
"name": "matchmaker_add",
|
|
2404
|
+
"brief": "",
|
|
2405
|
+
"description": "",
|
|
2406
|
+
"parameters": [
|
|
2407
|
+
{
|
|
2408
|
+
"name": "min_count",
|
|
2409
|
+
"doc": "",
|
|
2410
|
+
"types": [
|
|
2411
|
+
"number"
|
|
2412
|
+
],
|
|
2413
|
+
"is_optional": "False"
|
|
2414
|
+
},
|
|
2415
|
+
{
|
|
2416
|
+
"name": "max_count",
|
|
2417
|
+
"doc": "",
|
|
2418
|
+
"types": [
|
|
2419
|
+
"number"
|
|
2420
|
+
],
|
|
2421
|
+
"is_optional": "False"
|
|
2422
|
+
},
|
|
2423
|
+
{
|
|
2424
|
+
"name": "query",
|
|
2425
|
+
"doc": "",
|
|
2426
|
+
"types": [
|
|
2427
|
+
"string"
|
|
2428
|
+
],
|
|
2429
|
+
"is_optional": "False"
|
|
2430
|
+
},
|
|
2431
|
+
{
|
|
2432
|
+
"name": "string_properties",
|
|
2433
|
+
"doc": "",
|
|
2434
|
+
"types": [
|
|
2435
|
+
"unknown"
|
|
2436
|
+
],
|
|
2437
|
+
"is_optional": "False"
|
|
2438
|
+
},
|
|
2439
|
+
{
|
|
2440
|
+
"name": "numeric_properties",
|
|
2441
|
+
"doc": "",
|
|
2442
|
+
"types": [
|
|
2443
|
+
"unknown"
|
|
2444
|
+
],
|
|
2445
|
+
"is_optional": "False"
|
|
2446
|
+
},
|
|
2447
|
+
{
|
|
2448
|
+
"name": "count_multiple",
|
|
2449
|
+
"doc": "",
|
|
2450
|
+
"types": [
|
|
2451
|
+
"number"
|
|
2452
|
+
],
|
|
2453
|
+
"is_optional": "False"
|
|
2454
|
+
},
|
|
2455
|
+
{
|
|
2456
|
+
"name": "callback",
|
|
2457
|
+
"doc": "",
|
|
2458
|
+
"types": [
|
|
2459
|
+
"(message: unknown) => void"
|
|
2460
|
+
],
|
|
2461
|
+
"is_optional": "True"
|
|
2462
|
+
}
|
|
2463
|
+
],
|
|
2464
|
+
"returnvalues": [
|
|
2465
|
+
{
|
|
2466
|
+
"name": "",
|
|
2467
|
+
"doc": "",
|
|
2468
|
+
"types": [
|
|
2469
|
+
"unknown"
|
|
2470
|
+
]
|
|
2471
|
+
}
|
|
2472
|
+
]
|
|
2473
|
+
},
|
|
2474
|
+
{
|
|
2475
|
+
"type": "FUNCTION",
|
|
2476
|
+
"name": "matchmaker_remove",
|
|
2477
|
+
"brief": "",
|
|
2478
|
+
"description": "",
|
|
2479
|
+
"parameters": [
|
|
2480
|
+
{
|
|
2481
|
+
"name": "ticket",
|
|
2482
|
+
"doc": "",
|
|
2483
|
+
"types": [
|
|
2484
|
+
"string"
|
|
2485
|
+
],
|
|
2486
|
+
"is_optional": "False"
|
|
2487
|
+
},
|
|
2488
|
+
{
|
|
2489
|
+
"name": "callback",
|
|
2490
|
+
"doc": "",
|
|
2491
|
+
"types": [
|
|
2492
|
+
"(message: unknown) => void"
|
|
2493
|
+
],
|
|
2494
|
+
"is_optional": "True"
|
|
2495
|
+
}
|
|
2496
|
+
],
|
|
2497
|
+
"returnvalues": [
|
|
2498
|
+
{
|
|
2499
|
+
"name": "",
|
|
2500
|
+
"doc": "",
|
|
2501
|
+
"types": [
|
|
2502
|
+
"unknown"
|
|
2503
|
+
]
|
|
2504
|
+
}
|
|
2505
|
+
]
|
|
2506
|
+
},
|
|
2507
|
+
{
|
|
2508
|
+
"type": "FUNCTION",
|
|
2509
|
+
"name": "party_create",
|
|
2510
|
+
"brief": "",
|
|
2511
|
+
"description": "",
|
|
2512
|
+
"parameters": [
|
|
2513
|
+
{
|
|
2514
|
+
"name": "open",
|
|
2515
|
+
"doc": "",
|
|
2516
|
+
"types": [
|
|
2517
|
+
"boolean"
|
|
2518
|
+
],
|
|
2519
|
+
"is_optional": "False"
|
|
2520
|
+
},
|
|
2521
|
+
{
|
|
2522
|
+
"name": "max_size",
|
|
2523
|
+
"doc": "",
|
|
2524
|
+
"types": [
|
|
2525
|
+
"number"
|
|
2526
|
+
],
|
|
2527
|
+
"is_optional": "False"
|
|
2528
|
+
},
|
|
2529
|
+
{
|
|
2530
|
+
"name": "callback",
|
|
2531
|
+
"doc": "",
|
|
2532
|
+
"types": [
|
|
2533
|
+
"(message: unknown) => void"
|
|
2534
|
+
],
|
|
2535
|
+
"is_optional": "True"
|
|
2536
|
+
}
|
|
2537
|
+
],
|
|
2538
|
+
"returnvalues": [
|
|
2539
|
+
{
|
|
2540
|
+
"name": "",
|
|
2541
|
+
"doc": "",
|
|
2542
|
+
"types": [
|
|
2543
|
+
"unknown"
|
|
2544
|
+
]
|
|
2545
|
+
}
|
|
2546
|
+
]
|
|
2547
|
+
},
|
|
2548
|
+
{
|
|
2549
|
+
"type": "FUNCTION",
|
|
2550
|
+
"name": "party_join",
|
|
2551
|
+
"brief": "",
|
|
2552
|
+
"description": "",
|
|
2553
|
+
"parameters": [
|
|
2554
|
+
{
|
|
2555
|
+
"name": "party_id",
|
|
2556
|
+
"doc": "",
|
|
2557
|
+
"types": [
|
|
2558
|
+
"string"
|
|
2559
|
+
],
|
|
2560
|
+
"is_optional": "False"
|
|
2561
|
+
},
|
|
2562
|
+
{
|
|
2563
|
+
"name": "callback",
|
|
2564
|
+
"doc": "",
|
|
2565
|
+
"types": [
|
|
2566
|
+
"(message: unknown) => void"
|
|
2567
|
+
],
|
|
2568
|
+
"is_optional": "True"
|
|
2569
|
+
}
|
|
2570
|
+
],
|
|
2571
|
+
"returnvalues": [
|
|
2572
|
+
{
|
|
2573
|
+
"name": "",
|
|
2574
|
+
"doc": "",
|
|
2575
|
+
"types": [
|
|
2576
|
+
"unknown"
|
|
2577
|
+
]
|
|
2578
|
+
}
|
|
2579
|
+
]
|
|
2580
|
+
},
|
|
2581
|
+
{
|
|
2582
|
+
"type": "FUNCTION",
|
|
2583
|
+
"name": "party_leave",
|
|
2584
|
+
"brief": "",
|
|
2585
|
+
"description": "",
|
|
2586
|
+
"parameters": [
|
|
2587
|
+
{
|
|
2588
|
+
"name": "party_id",
|
|
2589
|
+
"doc": "",
|
|
2590
|
+
"types": [
|
|
2591
|
+
"string"
|
|
2592
|
+
],
|
|
2593
|
+
"is_optional": "False"
|
|
2594
|
+
},
|
|
2595
|
+
{
|
|
2596
|
+
"name": "callback",
|
|
2597
|
+
"doc": "",
|
|
2598
|
+
"types": [
|
|
2599
|
+
"(message: unknown) => void"
|
|
2600
|
+
],
|
|
2601
|
+
"is_optional": "True"
|
|
2602
|
+
}
|
|
2603
|
+
],
|
|
2604
|
+
"returnvalues": [
|
|
2605
|
+
{
|
|
2606
|
+
"name": "",
|
|
2607
|
+
"doc": "",
|
|
2608
|
+
"types": [
|
|
2609
|
+
"unknown"
|
|
2610
|
+
]
|
|
2611
|
+
}
|
|
2612
|
+
]
|
|
2613
|
+
},
|
|
2614
|
+
{
|
|
2615
|
+
"type": "FUNCTION",
|
|
2616
|
+
"name": "party_promote",
|
|
2617
|
+
"brief": "",
|
|
2618
|
+
"description": "",
|
|
2619
|
+
"parameters": [
|
|
2620
|
+
{
|
|
2621
|
+
"name": "party_id",
|
|
2622
|
+
"doc": "",
|
|
2623
|
+
"types": [
|
|
2624
|
+
"string"
|
|
2625
|
+
],
|
|
2626
|
+
"is_optional": "False"
|
|
2627
|
+
},
|
|
2628
|
+
{
|
|
2629
|
+
"name": "presence",
|
|
2630
|
+
"doc": "",
|
|
2631
|
+
"types": [
|
|
2632
|
+
"unknown"
|
|
2633
|
+
],
|
|
2634
|
+
"is_optional": "False"
|
|
2635
|
+
},
|
|
2636
|
+
{
|
|
2637
|
+
"name": "callback",
|
|
2638
|
+
"doc": "",
|
|
2639
|
+
"types": [
|
|
2640
|
+
"(message: unknown) => void"
|
|
2641
|
+
],
|
|
2642
|
+
"is_optional": "True"
|
|
2643
|
+
}
|
|
2644
|
+
],
|
|
2645
|
+
"returnvalues": [
|
|
2646
|
+
{
|
|
2647
|
+
"name": "",
|
|
2648
|
+
"doc": "",
|
|
2649
|
+
"types": [
|
|
2650
|
+
"unknown"
|
|
2651
|
+
]
|
|
2652
|
+
}
|
|
2653
|
+
]
|
|
2654
|
+
},
|
|
2655
|
+
{
|
|
2656
|
+
"type": "FUNCTION",
|
|
2657
|
+
"name": "party_accept",
|
|
2658
|
+
"brief": "",
|
|
2659
|
+
"description": "",
|
|
2660
|
+
"parameters": [
|
|
2661
|
+
{
|
|
2662
|
+
"name": "party_id",
|
|
2663
|
+
"doc": "",
|
|
2664
|
+
"types": [
|
|
2665
|
+
"string"
|
|
2666
|
+
],
|
|
2667
|
+
"is_optional": "False"
|
|
2668
|
+
},
|
|
2669
|
+
{
|
|
2670
|
+
"name": "presence",
|
|
2671
|
+
"doc": "",
|
|
2672
|
+
"types": [
|
|
2673
|
+
"unknown"
|
|
2674
|
+
],
|
|
2675
|
+
"is_optional": "False"
|
|
2676
|
+
},
|
|
2677
|
+
{
|
|
2678
|
+
"name": "callback",
|
|
2679
|
+
"doc": "",
|
|
2680
|
+
"types": [
|
|
2681
|
+
"(message: unknown) => void"
|
|
2682
|
+
],
|
|
2683
|
+
"is_optional": "True"
|
|
2684
|
+
}
|
|
2685
|
+
],
|
|
2686
|
+
"returnvalues": [
|
|
2687
|
+
{
|
|
2688
|
+
"name": "",
|
|
2689
|
+
"doc": "",
|
|
2690
|
+
"types": [
|
|
2691
|
+
"unknown"
|
|
2692
|
+
]
|
|
2693
|
+
}
|
|
2694
|
+
]
|
|
2695
|
+
},
|
|
2696
|
+
{
|
|
2697
|
+
"type": "FUNCTION",
|
|
2698
|
+
"name": "party_remove",
|
|
2699
|
+
"brief": "",
|
|
2700
|
+
"description": "",
|
|
2701
|
+
"parameters": [
|
|
2702
|
+
{
|
|
2703
|
+
"name": "party_id",
|
|
2704
|
+
"doc": "",
|
|
2705
|
+
"types": [
|
|
2706
|
+
"string"
|
|
2707
|
+
],
|
|
2708
|
+
"is_optional": "False"
|
|
2709
|
+
},
|
|
2710
|
+
{
|
|
2711
|
+
"name": "presence",
|
|
2712
|
+
"doc": "",
|
|
2713
|
+
"types": [
|
|
2714
|
+
"unknown"
|
|
2715
|
+
],
|
|
2716
|
+
"is_optional": "False"
|
|
2717
|
+
},
|
|
2718
|
+
{
|
|
2719
|
+
"name": "callback",
|
|
2720
|
+
"doc": "",
|
|
2721
|
+
"types": [
|
|
2722
|
+
"(message: unknown) => void"
|
|
2723
|
+
],
|
|
2724
|
+
"is_optional": "True"
|
|
2725
|
+
}
|
|
2726
|
+
],
|
|
2727
|
+
"returnvalues": [
|
|
2728
|
+
{
|
|
2729
|
+
"name": "",
|
|
2730
|
+
"doc": "",
|
|
2731
|
+
"types": [
|
|
2732
|
+
"unknown"
|
|
2733
|
+
]
|
|
2734
|
+
}
|
|
2735
|
+
]
|
|
2736
|
+
},
|
|
2737
|
+
{
|
|
2738
|
+
"type": "FUNCTION",
|
|
2739
|
+
"name": "party_close",
|
|
2740
|
+
"brief": "",
|
|
2741
|
+
"description": "",
|
|
2742
|
+
"parameters": [
|
|
2743
|
+
{
|
|
2744
|
+
"name": "party_id",
|
|
2745
|
+
"doc": "",
|
|
2746
|
+
"types": [
|
|
2747
|
+
"string"
|
|
2748
|
+
],
|
|
2749
|
+
"is_optional": "False"
|
|
2750
|
+
},
|
|
2751
|
+
{
|
|
2752
|
+
"name": "callback",
|
|
2753
|
+
"doc": "",
|
|
2754
|
+
"types": [
|
|
2755
|
+
"(message: unknown) => void"
|
|
2756
|
+
],
|
|
2757
|
+
"is_optional": "True"
|
|
2758
|
+
}
|
|
2759
|
+
],
|
|
2760
|
+
"returnvalues": [
|
|
2761
|
+
{
|
|
2762
|
+
"name": "",
|
|
2763
|
+
"doc": "",
|
|
2764
|
+
"types": [
|
|
2765
|
+
"unknown"
|
|
2766
|
+
]
|
|
2767
|
+
}
|
|
2768
|
+
]
|
|
2769
|
+
},
|
|
2770
|
+
{
|
|
2771
|
+
"type": "FUNCTION",
|
|
2772
|
+
"name": "party_join_request_list",
|
|
2773
|
+
"brief": "",
|
|
2774
|
+
"description": "",
|
|
2775
|
+
"parameters": [
|
|
2776
|
+
{
|
|
2777
|
+
"name": "party_id",
|
|
2778
|
+
"doc": "",
|
|
2779
|
+
"types": [
|
|
2780
|
+
"string"
|
|
2781
|
+
],
|
|
2782
|
+
"is_optional": "False"
|
|
2783
|
+
},
|
|
2784
|
+
{
|
|
2785
|
+
"name": "callback",
|
|
2786
|
+
"doc": "",
|
|
2787
|
+
"types": [
|
|
2788
|
+
"(message: unknown) => void"
|
|
2789
|
+
],
|
|
2790
|
+
"is_optional": "True"
|
|
2791
|
+
}
|
|
2792
|
+
],
|
|
2793
|
+
"returnvalues": [
|
|
2794
|
+
{
|
|
2795
|
+
"name": "",
|
|
2796
|
+
"doc": "",
|
|
2797
|
+
"types": [
|
|
2798
|
+
"unknown"
|
|
2799
|
+
]
|
|
2800
|
+
}
|
|
2801
|
+
]
|
|
2802
|
+
},
|
|
2803
|
+
{
|
|
2804
|
+
"type": "FUNCTION",
|
|
2805
|
+
"name": "party_matchmaker_add",
|
|
2806
|
+
"brief": "",
|
|
2807
|
+
"description": "",
|
|
2808
|
+
"parameters": [
|
|
2809
|
+
{
|
|
2810
|
+
"name": "party_id",
|
|
2811
|
+
"doc": "",
|
|
2812
|
+
"types": [
|
|
2813
|
+
"string"
|
|
2814
|
+
],
|
|
2815
|
+
"is_optional": "False"
|
|
2816
|
+
},
|
|
2817
|
+
{
|
|
2818
|
+
"name": "min_count",
|
|
2819
|
+
"doc": "",
|
|
2820
|
+
"types": [
|
|
2821
|
+
"number"
|
|
2822
|
+
],
|
|
2823
|
+
"is_optional": "False"
|
|
2824
|
+
},
|
|
2825
|
+
{
|
|
2826
|
+
"name": "max_count",
|
|
2827
|
+
"doc": "",
|
|
2828
|
+
"types": [
|
|
2829
|
+
"number"
|
|
2830
|
+
],
|
|
2831
|
+
"is_optional": "False"
|
|
2832
|
+
},
|
|
2833
|
+
{
|
|
2834
|
+
"name": "query",
|
|
2835
|
+
"doc": "",
|
|
2836
|
+
"types": [
|
|
2837
|
+
"string"
|
|
2838
|
+
],
|
|
2839
|
+
"is_optional": "False"
|
|
2840
|
+
},
|
|
2841
|
+
{
|
|
2842
|
+
"name": "string_properties",
|
|
2843
|
+
"doc": "",
|
|
2844
|
+
"types": [
|
|
2845
|
+
"unknown"
|
|
2846
|
+
],
|
|
2847
|
+
"is_optional": "False"
|
|
2848
|
+
},
|
|
2849
|
+
{
|
|
2850
|
+
"name": "numeric_properties",
|
|
2851
|
+
"doc": "",
|
|
2852
|
+
"types": [
|
|
2853
|
+
"unknown"
|
|
2854
|
+
],
|
|
2855
|
+
"is_optional": "False"
|
|
2856
|
+
},
|
|
2857
|
+
{
|
|
2858
|
+
"name": "count_multiple",
|
|
2859
|
+
"doc": "",
|
|
2860
|
+
"types": [
|
|
2861
|
+
"number"
|
|
2862
|
+
],
|
|
2863
|
+
"is_optional": "False"
|
|
2864
|
+
},
|
|
2865
|
+
{
|
|
2866
|
+
"name": "callback",
|
|
2867
|
+
"doc": "",
|
|
2868
|
+
"types": [
|
|
2869
|
+
"(message: unknown) => void"
|
|
2870
|
+
],
|
|
2871
|
+
"is_optional": "True"
|
|
2872
|
+
}
|
|
2873
|
+
],
|
|
2874
|
+
"returnvalues": [
|
|
2875
|
+
{
|
|
2876
|
+
"name": "",
|
|
2877
|
+
"doc": "",
|
|
2878
|
+
"types": [
|
|
2879
|
+
"unknown"
|
|
2880
|
+
]
|
|
2881
|
+
}
|
|
2882
|
+
]
|
|
2883
|
+
},
|
|
2884
|
+
{
|
|
2885
|
+
"type": "FUNCTION",
|
|
2886
|
+
"name": "party_matchmaker_remove",
|
|
2887
|
+
"brief": "",
|
|
2888
|
+
"description": "",
|
|
2889
|
+
"parameters": [
|
|
2890
|
+
{
|
|
2891
|
+
"name": "party_id",
|
|
2892
|
+
"doc": "",
|
|
2893
|
+
"types": [
|
|
2894
|
+
"string"
|
|
2895
|
+
],
|
|
2896
|
+
"is_optional": "False"
|
|
2897
|
+
},
|
|
2898
|
+
{
|
|
2899
|
+
"name": "ticket",
|
|
2900
|
+
"doc": "",
|
|
2901
|
+
"types": [
|
|
2902
|
+
"string"
|
|
2903
|
+
],
|
|
2904
|
+
"is_optional": "False"
|
|
2905
|
+
},
|
|
2906
|
+
{
|
|
2907
|
+
"name": "callback",
|
|
2908
|
+
"doc": "",
|
|
2909
|
+
"types": [
|
|
2910
|
+
"(message: unknown) => void"
|
|
2911
|
+
],
|
|
2912
|
+
"is_optional": "True"
|
|
2913
|
+
}
|
|
2914
|
+
],
|
|
2915
|
+
"returnvalues": [
|
|
2916
|
+
{
|
|
2917
|
+
"name": "",
|
|
2918
|
+
"doc": "",
|
|
2919
|
+
"types": [
|
|
2920
|
+
"unknown"
|
|
2921
|
+
]
|
|
2922
|
+
}
|
|
2923
|
+
]
|
|
2924
|
+
},
|
|
2925
|
+
{
|
|
2926
|
+
"type": "FUNCTION",
|
|
2927
|
+
"name": "party_data_send",
|
|
2928
|
+
"brief": "",
|
|
2929
|
+
"description": "",
|
|
2930
|
+
"parameters": [
|
|
2931
|
+
{
|
|
2932
|
+
"name": "party_id",
|
|
2933
|
+
"doc": "",
|
|
2934
|
+
"types": [
|
|
2935
|
+
"string"
|
|
2936
|
+
],
|
|
2937
|
+
"is_optional": "False"
|
|
2938
|
+
},
|
|
2939
|
+
{
|
|
2940
|
+
"name": "op_code",
|
|
2941
|
+
"doc": "",
|
|
2942
|
+
"types": [
|
|
2943
|
+
"number"
|
|
2944
|
+
],
|
|
2945
|
+
"is_optional": "False"
|
|
2946
|
+
},
|
|
2947
|
+
{
|
|
2948
|
+
"name": "data",
|
|
2949
|
+
"doc": "",
|
|
2950
|
+
"types": [
|
|
2951
|
+
"string"
|
|
2952
|
+
],
|
|
2953
|
+
"is_optional": "False"
|
|
2954
|
+
},
|
|
2955
|
+
{
|
|
2956
|
+
"name": "callback",
|
|
2957
|
+
"doc": "",
|
|
2958
|
+
"types": [
|
|
2959
|
+
"(message: unknown) => void"
|
|
2960
|
+
],
|
|
2961
|
+
"is_optional": "True"
|
|
2962
|
+
}
|
|
2963
|
+
],
|
|
2964
|
+
"returnvalues": [
|
|
2965
|
+
{
|
|
2966
|
+
"name": "",
|
|
2967
|
+
"doc": "",
|
|
2968
|
+
"types": [
|
|
2969
|
+
"unknown"
|
|
2970
|
+
]
|
|
2971
|
+
}
|
|
2972
|
+
]
|
|
2973
|
+
},
|
|
2974
|
+
{
|
|
2975
|
+
"type": "FUNCTION",
|
|
2976
|
+
"name": "status_follow",
|
|
2977
|
+
"brief": "",
|
|
2978
|
+
"description": "",
|
|
2979
|
+
"parameters": [
|
|
2980
|
+
{
|
|
2981
|
+
"name": "user_ids",
|
|
2982
|
+
"doc": "",
|
|
2983
|
+
"types": [
|
|
2984
|
+
"string"
|
|
2985
|
+
],
|
|
2986
|
+
"is_optional": "False"
|
|
2987
|
+
},
|
|
2988
|
+
{
|
|
2989
|
+
"name": "usernames",
|
|
2990
|
+
"doc": "",
|
|
2991
|
+
"types": [
|
|
2992
|
+
"string"
|
|
2993
|
+
],
|
|
2994
|
+
"is_optional": "False"
|
|
2995
|
+
},
|
|
2996
|
+
{
|
|
2997
|
+
"name": "callback",
|
|
2998
|
+
"doc": "",
|
|
2999
|
+
"types": [
|
|
3000
|
+
"(message: unknown) => void"
|
|
3001
|
+
],
|
|
3002
|
+
"is_optional": "True"
|
|
3003
|
+
}
|
|
3004
|
+
],
|
|
3005
|
+
"returnvalues": [
|
|
3006
|
+
{
|
|
3007
|
+
"name": "",
|
|
3008
|
+
"doc": "",
|
|
3009
|
+
"types": [
|
|
3010
|
+
"unknown"
|
|
3011
|
+
]
|
|
3012
|
+
}
|
|
3013
|
+
]
|
|
3014
|
+
},
|
|
3015
|
+
{
|
|
3016
|
+
"type": "FUNCTION",
|
|
3017
|
+
"name": "status_unfollow",
|
|
3018
|
+
"brief": "",
|
|
3019
|
+
"description": "",
|
|
3020
|
+
"parameters": [
|
|
3021
|
+
{
|
|
3022
|
+
"name": "user_ids",
|
|
3023
|
+
"doc": "",
|
|
3024
|
+
"types": [
|
|
3025
|
+
"string"
|
|
3026
|
+
],
|
|
3027
|
+
"is_optional": "False"
|
|
3028
|
+
},
|
|
3029
|
+
{
|
|
3030
|
+
"name": "callback",
|
|
3031
|
+
"doc": "",
|
|
3032
|
+
"types": [
|
|
3033
|
+
"(message: unknown) => void"
|
|
3034
|
+
],
|
|
3035
|
+
"is_optional": "True"
|
|
3036
|
+
}
|
|
3037
|
+
],
|
|
3038
|
+
"returnvalues": [
|
|
3039
|
+
{
|
|
3040
|
+
"name": "",
|
|
3041
|
+
"doc": "",
|
|
3042
|
+
"types": [
|
|
3043
|
+
"unknown"
|
|
3044
|
+
]
|
|
3045
|
+
}
|
|
3046
|
+
]
|
|
3047
|
+
},
|
|
3048
|
+
{
|
|
3049
|
+
"type": "FUNCTION",
|
|
3050
|
+
"name": "status_update",
|
|
3051
|
+
"brief": "",
|
|
3052
|
+
"description": "",
|
|
3053
|
+
"parameters": [
|
|
3054
|
+
{
|
|
3055
|
+
"name": "status",
|
|
3056
|
+
"doc": "",
|
|
3057
|
+
"types": [
|
|
3058
|
+
"string"
|
|
3059
|
+
],
|
|
3060
|
+
"is_optional": "False"
|
|
3061
|
+
},
|
|
3062
|
+
{
|
|
3063
|
+
"name": "callback",
|
|
3064
|
+
"doc": "",
|
|
3065
|
+
"types": [
|
|
3066
|
+
"(message: unknown) => void"
|
|
3067
|
+
],
|
|
3068
|
+
"is_optional": "True"
|
|
3069
|
+
}
|
|
3070
|
+
],
|
|
3071
|
+
"returnvalues": [
|
|
3072
|
+
{
|
|
3073
|
+
"name": "",
|
|
3074
|
+
"doc": "",
|
|
3075
|
+
"types": [
|
|
3076
|
+
"unknown"
|
|
3077
|
+
]
|
|
3078
|
+
}
|
|
3079
|
+
]
|
|
3080
|
+
},
|
|
3081
|
+
{
|
|
3082
|
+
"type": "FUNCTION",
|
|
3083
|
+
"name": "on_channel_presence_event",
|
|
3084
|
+
"brief": "",
|
|
3085
|
+
"description": "",
|
|
3086
|
+
"parameters": [
|
|
3087
|
+
{
|
|
3088
|
+
"name": "fn",
|
|
3089
|
+
"doc": "",
|
|
3090
|
+
"types": [
|
|
3091
|
+
"(message: unknown) => void"
|
|
3092
|
+
],
|
|
3093
|
+
"is_optional": "False"
|
|
3094
|
+
}
|
|
3095
|
+
],
|
|
3096
|
+
"returnvalues": []
|
|
3097
|
+
},
|
|
3098
|
+
{
|
|
3099
|
+
"type": "FUNCTION",
|
|
3100
|
+
"name": "on_match_presence_event",
|
|
3101
|
+
"brief": "",
|
|
3102
|
+
"description": "",
|
|
3103
|
+
"parameters": [
|
|
3104
|
+
{
|
|
3105
|
+
"name": "fn",
|
|
3106
|
+
"doc": "",
|
|
3107
|
+
"types": [
|
|
3108
|
+
"(message: unknown) => void"
|
|
3109
|
+
],
|
|
3110
|
+
"is_optional": "False"
|
|
3111
|
+
}
|
|
3112
|
+
],
|
|
3113
|
+
"returnvalues": []
|
|
3114
|
+
},
|
|
3115
|
+
{
|
|
3116
|
+
"type": "FUNCTION",
|
|
3117
|
+
"name": "on_match_data",
|
|
3118
|
+
"brief": "",
|
|
3119
|
+
"description": "",
|
|
3120
|
+
"parameters": [
|
|
3121
|
+
{
|
|
3122
|
+
"name": "fn",
|
|
3123
|
+
"doc": "",
|
|
3124
|
+
"types": [
|
|
3125
|
+
"(message: unknown) => void"
|
|
3126
|
+
],
|
|
3127
|
+
"is_optional": "False"
|
|
3128
|
+
}
|
|
3129
|
+
],
|
|
3130
|
+
"returnvalues": []
|
|
3131
|
+
},
|
|
3132
|
+
{
|
|
3133
|
+
"type": "FUNCTION",
|
|
3134
|
+
"name": "on_match",
|
|
3135
|
+
"brief": "",
|
|
3136
|
+
"description": "",
|
|
3137
|
+
"parameters": [
|
|
3138
|
+
{
|
|
3139
|
+
"name": "fn",
|
|
3140
|
+
"doc": "",
|
|
3141
|
+
"types": [
|
|
3142
|
+
"(message: unknown) => void"
|
|
3143
|
+
],
|
|
3144
|
+
"is_optional": "False"
|
|
3145
|
+
}
|
|
3146
|
+
],
|
|
3147
|
+
"returnvalues": []
|
|
3148
|
+
},
|
|
3149
|
+
{
|
|
3150
|
+
"type": "FUNCTION",
|
|
3151
|
+
"name": "on_matchmaker_matched",
|
|
3152
|
+
"brief": "",
|
|
3153
|
+
"description": "",
|
|
3154
|
+
"parameters": [
|
|
3155
|
+
{
|
|
3156
|
+
"name": "fn",
|
|
3157
|
+
"doc": "",
|
|
3158
|
+
"types": [
|
|
3159
|
+
"(message: unknown) => void"
|
|
3160
|
+
],
|
|
3161
|
+
"is_optional": "False"
|
|
3162
|
+
}
|
|
3163
|
+
],
|
|
3164
|
+
"returnvalues": []
|
|
3165
|
+
},
|
|
3166
|
+
{
|
|
3167
|
+
"type": "FUNCTION",
|
|
3168
|
+
"name": "on_notifications",
|
|
3169
|
+
"brief": "",
|
|
3170
|
+
"description": "",
|
|
3171
|
+
"parameters": [
|
|
3172
|
+
{
|
|
3173
|
+
"name": "fn",
|
|
3174
|
+
"doc": "",
|
|
3175
|
+
"types": [
|
|
3176
|
+
"(message: unknown) => void"
|
|
3177
|
+
],
|
|
3178
|
+
"is_optional": "False"
|
|
3179
|
+
}
|
|
3180
|
+
],
|
|
3181
|
+
"returnvalues": []
|
|
3182
|
+
},
|
|
3183
|
+
{
|
|
3184
|
+
"type": "FUNCTION",
|
|
3185
|
+
"name": "on_party_presence_event",
|
|
3186
|
+
"brief": "",
|
|
3187
|
+
"description": "",
|
|
3188
|
+
"parameters": [
|
|
3189
|
+
{
|
|
3190
|
+
"name": "fn",
|
|
3191
|
+
"doc": "",
|
|
3192
|
+
"types": [
|
|
3193
|
+
"(message: unknown) => void"
|
|
3194
|
+
],
|
|
3195
|
+
"is_optional": "False"
|
|
3196
|
+
}
|
|
3197
|
+
],
|
|
3198
|
+
"returnvalues": []
|
|
3199
|
+
},
|
|
3200
|
+
{
|
|
3201
|
+
"type": "FUNCTION",
|
|
3202
|
+
"name": "on_party",
|
|
3203
|
+
"brief": "",
|
|
3204
|
+
"description": "",
|
|
3205
|
+
"parameters": [
|
|
3206
|
+
{
|
|
3207
|
+
"name": "fn",
|
|
3208
|
+
"doc": "",
|
|
3209
|
+
"types": [
|
|
3210
|
+
"(message: unknown) => void"
|
|
3211
|
+
],
|
|
3212
|
+
"is_optional": "False"
|
|
3213
|
+
}
|
|
3214
|
+
],
|
|
3215
|
+
"returnvalues": []
|
|
3216
|
+
},
|
|
3217
|
+
{
|
|
3218
|
+
"type": "FUNCTION",
|
|
3219
|
+
"name": "on_party_data",
|
|
3220
|
+
"brief": "",
|
|
3221
|
+
"description": "",
|
|
3222
|
+
"parameters": [
|
|
3223
|
+
{
|
|
3224
|
+
"name": "fn",
|
|
3225
|
+
"doc": "",
|
|
3226
|
+
"types": [
|
|
3227
|
+
"(message: unknown) => void"
|
|
3228
|
+
],
|
|
3229
|
+
"is_optional": "False"
|
|
3230
|
+
}
|
|
3231
|
+
],
|
|
3232
|
+
"returnvalues": []
|
|
3233
|
+
},
|
|
3234
|
+
{
|
|
3235
|
+
"type": "FUNCTION",
|
|
3236
|
+
"name": "on_party_join_request",
|
|
3237
|
+
"brief": "",
|
|
3238
|
+
"description": "",
|
|
3239
|
+
"parameters": [
|
|
3240
|
+
{
|
|
3241
|
+
"name": "fn",
|
|
3242
|
+
"doc": "",
|
|
3243
|
+
"types": [
|
|
3244
|
+
"(message: unknown) => void"
|
|
3245
|
+
],
|
|
3246
|
+
"is_optional": "False"
|
|
3247
|
+
}
|
|
3248
|
+
],
|
|
3249
|
+
"returnvalues": []
|
|
3250
|
+
},
|
|
3251
|
+
{
|
|
3252
|
+
"type": "FUNCTION",
|
|
3253
|
+
"name": "on_party_leader",
|
|
3254
|
+
"brief": "",
|
|
3255
|
+
"description": "",
|
|
3256
|
+
"parameters": [
|
|
3257
|
+
{
|
|
3258
|
+
"name": "fn",
|
|
3259
|
+
"doc": "",
|
|
3260
|
+
"types": [
|
|
3261
|
+
"(message: unknown) => void"
|
|
3262
|
+
],
|
|
3263
|
+
"is_optional": "False"
|
|
3264
|
+
}
|
|
3265
|
+
],
|
|
3266
|
+
"returnvalues": []
|
|
3267
|
+
},
|
|
3268
|
+
{
|
|
3269
|
+
"type": "FUNCTION",
|
|
3270
|
+
"name": "on_status_presence_event",
|
|
3271
|
+
"brief": "",
|
|
3272
|
+
"description": "",
|
|
3273
|
+
"parameters": [
|
|
3274
|
+
{
|
|
3275
|
+
"name": "fn",
|
|
3276
|
+
"doc": "",
|
|
3277
|
+
"types": [
|
|
3278
|
+
"(message: unknown) => void"
|
|
3279
|
+
],
|
|
3280
|
+
"is_optional": "False"
|
|
3281
|
+
}
|
|
3282
|
+
],
|
|
3283
|
+
"returnvalues": []
|
|
3284
|
+
},
|
|
3285
|
+
{
|
|
3286
|
+
"type": "FUNCTION",
|
|
3287
|
+
"name": "on_status",
|
|
3288
|
+
"brief": "",
|
|
3289
|
+
"description": "",
|
|
3290
|
+
"parameters": [
|
|
3291
|
+
{
|
|
3292
|
+
"name": "fn",
|
|
3293
|
+
"doc": "",
|
|
3294
|
+
"types": [
|
|
3295
|
+
"(message: unknown) => void"
|
|
3296
|
+
],
|
|
3297
|
+
"is_optional": "False"
|
|
3298
|
+
}
|
|
3299
|
+
],
|
|
3300
|
+
"returnvalues": []
|
|
3301
|
+
},
|
|
3302
|
+
{
|
|
3303
|
+
"type": "FUNCTION",
|
|
3304
|
+
"name": "on_stream_data",
|
|
3305
|
+
"brief": "",
|
|
3306
|
+
"description": "",
|
|
3307
|
+
"parameters": [
|
|
3308
|
+
{
|
|
3309
|
+
"name": "fn",
|
|
3310
|
+
"doc": "",
|
|
3311
|
+
"types": [
|
|
3312
|
+
"(message: unknown) => void"
|
|
3313
|
+
],
|
|
3314
|
+
"is_optional": "False"
|
|
3315
|
+
}
|
|
3316
|
+
],
|
|
3317
|
+
"returnvalues": []
|
|
3318
|
+
},
|
|
3319
|
+
{
|
|
3320
|
+
"type": "FUNCTION",
|
|
3321
|
+
"name": "on_error",
|
|
3322
|
+
"brief": "",
|
|
3323
|
+
"description": "",
|
|
3324
|
+
"parameters": [
|
|
3325
|
+
{
|
|
3326
|
+
"name": "fn",
|
|
3327
|
+
"doc": "",
|
|
3328
|
+
"types": [
|
|
3329
|
+
"(message: unknown) => void"
|
|
3330
|
+
],
|
|
3331
|
+
"is_optional": "False"
|
|
3332
|
+
}
|
|
3333
|
+
],
|
|
3334
|
+
"returnvalues": []
|
|
3335
|
+
},
|
|
3336
|
+
{
|
|
3337
|
+
"type": "FUNCTION",
|
|
3338
|
+
"name": "on_channel_message",
|
|
3339
|
+
"brief": "",
|
|
3340
|
+
"description": "",
|
|
3341
|
+
"parameters": [
|
|
3342
|
+
{
|
|
3343
|
+
"name": "fn",
|
|
3344
|
+
"doc": "",
|
|
3345
|
+
"types": [
|
|
3346
|
+
"(message: unknown) => void"
|
|
3347
|
+
],
|
|
3348
|
+
"is_optional": "False"
|
|
3349
|
+
}
|
|
3350
|
+
],
|
|
3351
|
+
"returnvalues": []
|
|
3352
|
+
}
|
|
3353
|
+
]
|
|
3354
|
+
}
|
|
3355
|
+
]
|
|
3356
|
+
}
|