@defold-typescript/library-types 0.22.0 → 0.24.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.
Files changed (145) hide show
  1. package/api-doc/boom.json +3870 -0
  2. package/api-doc/{bridge.bridge.json → bridge.json} +754 -844
  3. package/api-doc/bzAnim.json +338 -0
  4. package/api-doc/decore.json +23 -23
  5. package/api-doc/defcon.json +150 -0
  6. package/api-doc/{defmath.defmath.json → defmath.json} +6 -46
  7. package/api-doc/defsave.json +518 -0
  8. package/api-doc/deftest.json +741 -0
  9. package/api-doc/{dicebag.dicebag.json → dicebag.json} +19 -1
  10. package/api-doc/druid.json +249 -1846
  11. package/api-doc/event.json +1074 -0
  12. package/api-doc/gooey.json +2050 -0
  13. package/api-doc/immutable.json +65 -0
  14. package/api-doc/in.accelerometer.json +75 -1
  15. package/api-doc/in.button.json +17 -10
  16. package/api-doc/in.cursor.json +26 -0
  17. package/api-doc/in.gesture.json +401 -6
  18. package/api-doc/in.keyboard.json +2 -0
  19. package/api-doc/in.mapper.json +12 -8
  20. package/api-doc/in.onscreen.json +61 -5
  21. package/api-doc/in.state.json +61 -13
  22. package/api-doc/in.textbox.json +23 -12
  23. package/api-doc/in.triggers.json +336 -0
  24. package/api-doc/lang.json +528 -0
  25. package/api-doc/{event.event.json → log.json} +96 -101
  26. package/api-doc/metrics.fps.json +61 -2
  27. package/api-doc/metrics.mem.json +61 -2
  28. package/api-doc/monarch.monarch.json +249 -7
  29. package/api-doc/monarch.transitions.easings.json +19 -26
  30. package/api-doc/monarch.transitions.gui.json +782 -79
  31. package/api-doc/nakama.engine.defold.json +31 -18
  32. package/api-doc/{nakama.nakama.json → nakama.json} +4752 -2554
  33. package/api-doc/nakama.util.log.json +32 -4
  34. package/api-doc/narrator.json +647 -0
  35. package/api-doc/openapi/nakama.nakama.json +7680 -0
  36. package/api-doc/orthographic.camera.json +96 -98
  37. package/api-doc/orthographic.json +602 -0
  38. package/api-doc/panthera.json +1183 -0
  39. package/api-doc/{persist.persist.json → persist.json} +26 -1
  40. package/api-doc/{platypus.platypus.json → platypus.json} +68 -14
  41. package/api-doc/proto.json +995 -0
  42. package/api-doc/{rendy.rendy.json → rendy.json} +46 -99
  43. package/api-doc/richtext.color.json +77 -0
  44. package/api-doc/richtext.richtext.json +375 -5
  45. package/api-doc/saver.saver.json +714 -263
  46. package/api-doc/saver.storage.json +283 -52
  47. package/api-doc/squid.json +846 -0
  48. package/api-doc/{starly.starly.json → starly.json} +1 -1
  49. package/api-doc/tweener.json +277 -0
  50. package/api-doc/{yagames.yagames.json → yagames.json} +784 -189
  51. package/api-doc/{zzfx.api.json → zzfx.json} +9 -9
  52. package/authored-targets.json +403 -0
  53. package/generated/{boom.boom.d.ts → boom.d.ts} +14 -0
  54. package/generated/bridge.d.ts +468 -0
  55. package/generated/{bzAnim.bzLibrary.d.ts → bzAnim.d.ts} +6 -0
  56. package/generated/decore.d.ts +37 -37
  57. package/generated/defcon.d.ts +43 -0
  58. package/generated/{defmath.defmath.d.ts → defmath.d.ts} +3 -2
  59. package/generated/defsave.d.ts +144 -0
  60. package/generated/{dicebag.dicebag.d.ts → dicebag.d.ts} +25 -0
  61. package/generated/druid.d.ts +198 -502
  62. package/generated/event.d.ts +318 -0
  63. package/generated/{gooey.gooey.d.ts → gooey.d.ts} +61 -6
  64. package/generated/immutable.d.ts +13 -0
  65. package/generated/in.onscreen.d.ts +5 -0
  66. package/generated/in.textbox.d.ts +4 -0
  67. package/generated/lang.d.ts +101 -0
  68. package/generated/log.d.ts +36 -0
  69. package/generated/metrics.fps.d.ts +19 -1
  70. package/generated/metrics.mem.d.ts +19 -1
  71. package/generated/monarch.monarch.d.ts +44 -1
  72. package/generated/monarch.transitions.easings.d.ts +0 -1
  73. package/generated/monarch.transitions.gui.d.ts +96 -12
  74. package/generated/nakama.d.ts +1158 -0
  75. package/generated/nakama.engine.defold.d.ts +3 -1
  76. package/generated/nakama.util.log.d.ts +6 -0
  77. package/generated/narrator.d.ts +121 -0
  78. package/generated/openapi/nakama.nakama.d.ts +884 -0
  79. package/generated/orthographic.camera.d.ts +24 -38
  80. package/generated/orthographic.d.ts +155 -0
  81. package/generated/panthera.d.ts +170 -0
  82. package/generated/{persist.persist.d.ts → persist.d.ts} +3 -0
  83. package/generated/{platypus.platypus.d.ts → platypus.d.ts} +9 -0
  84. package/generated/proto.d.ts +146 -0
  85. package/generated/{rendy.rendy.d.ts → rendy.d.ts} +33 -80
  86. package/generated/richtext.color.d.ts +15 -0
  87. package/generated/saver.saver.d.ts +289 -42
  88. package/generated/saver.storage.d.ts +79 -14
  89. package/generated/squid.d.ts +127 -0
  90. package/generated/tweener.d.ts +42 -0
  91. package/generated/{yagames.yagames.d.ts → yagames.d.ts} +151 -29
  92. package/generated/{zzfx.api.d.ts → zzfx.d.ts} +7 -0
  93. package/library-classification.json +0 -227
  94. package/library-targets.json +1 -284
  95. package/luals-targets.json +168 -1
  96. package/openapi-targets.json +17 -0
  97. package/package.json +9 -88
  98. package/script-api-targets.json +15 -0
  99. package/scripts/__snapshots__/parse-luals.test.ts.snap +504 -85
  100. package/scripts/apply-luals-overrides.ts +95 -0
  101. package/scripts/authored-parity.ts +718 -0
  102. package/scripts/emit-library-dts.ts +177 -19
  103. package/scripts/extract-api-doc.ts +189 -38
  104. package/scripts/fidelity-floor.ts +178 -0
  105. package/scripts/import-upstream-docs.ts +125 -0
  106. package/scripts/lower-api-doc.ts +69 -19
  107. package/scripts/luals-fidelity.ts +22 -10
  108. package/scripts/map-luals-types.ts +86 -22
  109. package/scripts/parse-lua-surface.ts +187 -0
  110. package/scripts/parse-luals.ts +473 -22
  111. package/scripts/parse-markdown-api.ts +247 -0
  112. package/scripts/parse-openapi-api.ts +313 -0
  113. package/scripts/sync-authored-types.ts +249 -0
  114. package/scripts/sync-library-types.ts +99 -3
  115. package/scripts/sync-luals-types.ts +29 -2
  116. package/scripts/sync-markdown-types.ts +761 -0
  117. package/scripts/sync-openapi-types.ts +308 -0
  118. package/scripts/sync-script-api-types.ts +367 -0
  119. package/api-doc/boom.boom.json +0 -26
  120. package/api-doc/bzAnim.bzLibrary.json +0 -156
  121. package/api-doc/defcon.console.json +0 -109
  122. package/api-doc/defsave.defsave.json +0 -175
  123. package/api-doc/deftest.deftest.json +0 -71
  124. package/api-doc/gooey.gooey.json +0 -963
  125. package/api-doc/immutable.immutable.json +0 -63
  126. package/api-doc/lang.lang.json +0 -411
  127. package/api-doc/log.log.json +0 -50
  128. package/api-doc/narrator.narrator.json +0 -150
  129. package/api-doc/proto.proto.json +0 -355
  130. package/api-doc/squid.squid.json +0 -660
  131. package/api-doc/tweener.tweener.json +0 -419
  132. package/generated/bridge.bridge.d.ts +0 -533
  133. package/generated/defcon.console.d.ts +0 -24
  134. package/generated/defsave.defsave.d.ts +0 -31
  135. package/generated/event.event.d.ts +0 -54
  136. package/generated/immutable.immutable.d.ts +0 -13
  137. package/generated/lang.lang.d.ts +0 -33
  138. package/generated/log.log.d.ts +0 -40
  139. package/generated/nakama.nakama.d.ts +0 -594
  140. package/generated/narrator.narrator.d.ts +0 -66
  141. package/generated/proto.proto.d.ts +0 -36
  142. package/generated/squid.squid.d.ts +0 -106
  143. package/generated/tweener.tweener.d.ts +0 -151
  144. /package/generated/{deftest.deftest.d.ts → deftest.d.ts} +0 -0
  145. /package/generated/{starly.starly.d.ts → starly.d.ts} +0 -0
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "info": {
3
- "namespace": "yagames.yagames",
3
+ "namespace": "yagames",
4
4
  "brief": "",
5
5
  "description": ""
6
6
  },
@@ -16,8 +16,9 @@
16
16
  {
17
17
  "type": "FUNCTION",
18
18
  "name": "init",
19
- "brief": "",
20
- "description": "",
19
+ "brief": "Initializes YaGames extension and waits for Yandex.Games SDK initialization",
20
+ "description": "Initializes YaGames extension and waits for Yandex.Games SDK initialization",
21
+ "docSource": "upstream",
21
22
  "parameters": [
22
23
  {
23
24
  "name": "callback",
@@ -33,8 +34,9 @@
33
34
  {
34
35
  "type": "FUNCTION",
35
36
  "name": "adv_show_fullscreen_adv",
36
- "brief": "",
37
- "description": "",
37
+ "brief": "Calls the fullscreen ad.",
38
+ "description": "Calls the fullscreen ad.\nFullscreen ad block - advertising blocks that completely cover the game background and are shown\nwhen a player waits for something (for example, when switching to the next level of the game).",
39
+ "docSource": "upstream",
38
40
  "parameters": [
39
41
  {
40
42
  "name": "callbacks",
@@ -50,8 +52,9 @@
50
52
  {
51
53
  "type": "FUNCTION",
52
54
  "name": "adv_show_rewarded_video",
53
- "brief": "",
54
- "description": "",
55
+ "brief": "Calls the rewarded video ad.",
56
+ "description": "Calls the rewarded video ad.\nRewarded videos are video ad blocks used to monetize games and earn a reward or in-game currency.",
57
+ "docSource": "upstream",
55
58
  "parameters": [
56
59
  {
57
60
  "name": "callbacks",
@@ -64,11 +67,74 @@
64
67
  ],
65
68
  "returnvalues": []
66
69
  },
70
+ {
71
+ "type": "TYPEDEF",
72
+ "name": "StickyBannerCallback"
73
+ },
74
+ {
75
+ "type": "FUNCTION",
76
+ "name": "adv_get_banner_adv_status",
77
+ "brief": "Receives Sticky-banner ad status.",
78
+ "description": "Receives Sticky-banner ad status.",
79
+ "docSource": "upstream",
80
+ "parameters": [
81
+ {
82
+ "name": "callback",
83
+ "doc": "",
84
+ "types": [
85
+ "StickyBannerCallback"
86
+ ],
87
+ "is_optional": "False"
88
+ }
89
+ ],
90
+ "returnvalues": []
91
+ },
92
+ {
93
+ "type": "FUNCTION",
94
+ "name": "adv_show_banner_adv",
95
+ "brief": "Shows Sticky-banner.",
96
+ "description": "Shows Sticky-banner.",
97
+ "docSource": "upstream",
98
+ "parameters": [
99
+ {
100
+ "name": "callback",
101
+ "doc": "",
102
+ "types": [
103
+ "StickyBannerCallback"
104
+ ],
105
+ "is_optional": "True"
106
+ }
107
+ ],
108
+ "returnvalues": []
109
+ },
110
+ {
111
+ "type": "TYPEDEF",
112
+ "name": "StickyBannerHideCallback"
113
+ },
114
+ {
115
+ "type": "FUNCTION",
116
+ "name": "adv_hide_banner_adv",
117
+ "brief": "Hides Sticky-banner.",
118
+ "description": "Hides Sticky-banner.",
119
+ "docSource": "upstream",
120
+ "parameters": [
121
+ {
122
+ "name": "callback",
123
+ "doc": "",
124
+ "types": [
125
+ "StickyBannerHideCallback"
126
+ ],
127
+ "is_optional": "True"
128
+ }
129
+ ],
130
+ "returnvalues": []
131
+ },
67
132
  {
68
133
  "type": "FUNCTION",
69
134
  "name": "auth_open_auth_dialog",
70
- "brief": "",
71
- "description": "",
135
+ "brief": "Opens the login dialog box.",
136
+ "description": "Opens the login dialog box.",
137
+ "docSource": "upstream",
72
138
  "parameters": [
73
139
  {
74
140
  "name": "callback",
@@ -84,8 +150,9 @@
84
150
  {
85
151
  "type": "FUNCTION",
86
152
  "name": "player_init",
87
- "brief": "",
88
- "description": "",
153
+ "brief": "Initializes the \"player\" system.",
154
+ "description": "Initializes the \"player\" system.",
155
+ "docSource": "upstream",
89
156
  "parameters": [
90
157
  {
91
158
  "name": "options",
@@ -109,8 +176,9 @@
109
176
  {
110
177
  "type": "FUNCTION",
111
178
  "name": "player_set_data",
112
- "brief": "",
113
- "description": "",
179
+ "brief": "Saves user data. The maximum data size should not exceed 200 KB.",
180
+ "description": "Saves user data. The maximum data size should not exceed 200 KB.",
181
+ "docSource": "upstream",
114
182
  "parameters": [
115
183
  {
116
184
  "name": "data",
@@ -142,8 +210,9 @@
142
210
  {
143
211
  "type": "FUNCTION",
144
212
  "name": "player_get_data",
145
- "brief": "",
146
- "description": "",
213
+ "brief": "Asynchronously returns the in-game user data stored in the Yandex database.",
214
+ "description": "Asynchronously returns the in-game user data stored in the Yandex database.",
215
+ "docSource": "upstream",
147
216
  "parameters": [
148
217
  {
149
218
  "name": "keys",
@@ -167,8 +236,9 @@
167
236
  {
168
237
  "type": "FUNCTION",
169
238
  "name": "player_set_stats",
170
- "brief": "",
171
- "description": "",
239
+ "brief": "Save the user's numeric data. The maximum data size must not exceed 10 KB.",
240
+ "description": "Save the user's numeric data. The maximum data size must not exceed 10 KB.",
241
+ "docSource": "upstream",
172
242
  "parameters": [
173
243
  {
174
244
  "name": "stats",
@@ -192,8 +262,9 @@
192
262
  {
193
263
  "type": "FUNCTION",
194
264
  "name": "player_increment_stats",
195
- "brief": "",
196
- "description": "",
265
+ "brief": "Change in-game user data. The maximum data size must not exceed 10 KB.",
266
+ "description": "Change in-game user data. The maximum data size must not exceed 10 KB.",
267
+ "docSource": "upstream",
197
268
  "parameters": [
198
269
  {
199
270
  "name": "stats",
@@ -217,8 +288,9 @@
217
288
  {
218
289
  "type": "FUNCTION",
219
290
  "name": "player_get_stats",
220
- "brief": "",
221
- "description": "",
291
+ "brief": "Asynchronously returns the user's numeric data.",
292
+ "description": "Asynchronously returns the user's numeric data.",
293
+ "docSource": "upstream",
222
294
  "parameters": [
223
295
  {
224
296
  "name": "keys",
@@ -242,8 +314,9 @@
242
314
  {
243
315
  "type": "FUNCTION",
244
316
  "name": "player_get_id",
245
- "brief": "",
246
- "description": "",
317
+ "brief": "Return the user's ID.",
318
+ "description": "Return the user's ID.",
319
+ "docSource": "upstream",
247
320
  "parameters": [],
248
321
  "returnvalues": [
249
322
  {
@@ -253,13 +326,15 @@
253
326
  "string"
254
327
  ]
255
328
  }
256
- ]
329
+ ],
330
+ "deprecated": "Use `player_get_unique_id` instead."
257
331
  },
258
332
  {
259
333
  "type": "FUNCTION",
260
334
  "name": "player_get_unique_id",
261
- "brief": "",
262
- "description": "",
335
+ "brief": "Returns the user's unique permanent ID.",
336
+ "description": "Returns the user's unique permanent ID.",
337
+ "docSource": "upstream",
263
338
  "parameters": [],
264
339
  "returnvalues": [
265
340
  {
@@ -274,8 +349,9 @@
274
349
  {
275
350
  "type": "FUNCTION",
276
351
  "name": "player_get_name",
277
- "brief": "",
278
- "description": "",
352
+ "brief": "Return the user's name.",
353
+ "description": "Return the user's name.",
354
+ "docSource": "upstream",
279
355
  "parameters": [],
280
356
  "returnvalues": [
281
357
  {
@@ -294,8 +370,9 @@
294
370
  {
295
371
  "type": "FUNCTION",
296
372
  "name": "player_get_ids_per_game",
297
- "brief": "",
298
- "description": "",
373
+ "brief": "Return table (=array), where the user IDs are specified in all developer games in which",
374
+ "description": "Return table (=array), where the user IDs are specified in all developer games in which\nthe user has explicitly consented to the transfer of their personal data.",
375
+ "docSource": "upstream",
299
376
  "parameters": [
300
377
  {
301
378
  "name": "callback",
@@ -311,8 +388,9 @@
311
388
  {
312
389
  "type": "FUNCTION",
313
390
  "name": "player_get_photo",
314
- "brief": "",
315
- "description": "",
391
+ "brief": "Return the URL of the user's avatar.",
392
+ "description": "Return the URL of the user's avatar.",
393
+ "docSource": "upstream",
316
394
  "parameters": [
317
395
  {
318
396
  "name": "size",
@@ -333,11 +411,102 @@
333
411
  }
334
412
  ]
335
413
  },
414
+ {
415
+ "type": "FUNCTION",
416
+ "name": "player_get_paying_status",
417
+ "brief": "Returns four possible values (type: string) depending on the frequency and volume of the user's purchases.",
418
+ "description": "Returns four possible values (type: string) depending on the frequency and volume of the user's purchases.",
419
+ "docSource": "upstream",
420
+ "parameters": [],
421
+ "returnvalues": [
422
+ {
423
+ "name": "",
424
+ "doc": "",
425
+ "types": [
426
+ "'paying' | 'partially_paying' | 'not_paying' | 'unknown'"
427
+ ]
428
+ }
429
+ ]
430
+ },
431
+ {
432
+ "type": "TYPEDEF",
433
+ "name": "PlayerPersonalInfo"
434
+ },
435
+ {
436
+ "type": "FUNCTION",
437
+ "name": "player_get_personal_info",
438
+ "brief": "Returns a table with player data",
439
+ "description": "Returns a table with player data",
440
+ "docSource": "upstream",
441
+ "parameters": [],
442
+ "returnvalues": [
443
+ {
444
+ "name": "",
445
+ "doc": "",
446
+ "types": [
447
+ "PlayerPersonalInfo | undefined"
448
+ ]
449
+ }
450
+ ]
451
+ },
452
+ {
453
+ "type": "FUNCTION",
454
+ "name": "player_get_signature",
455
+ "brief": "Returns string with the user's data from player's Yandex profile and the signature.",
456
+ "description": "Returns string with the user's data from player's Yandex profile and the signature.\nIt consists of two Base64-encoded strings.",
457
+ "docSource": "upstream",
458
+ "parameters": [],
459
+ "returnvalues": [
460
+ {
461
+ "name": "",
462
+ "doc": "",
463
+ "types": [
464
+ "string | undefined"
465
+ ]
466
+ }
467
+ ]
468
+ },
469
+ {
470
+ "type": "FUNCTION",
471
+ "name": "player_get_mode",
472
+ "brief": "Return the user's auth mode.",
473
+ "description": "Return the user's auth mode.",
474
+ "docSource": "upstream",
475
+ "parameters": [],
476
+ "returnvalues": [
477
+ {
478
+ "name": "",
479
+ "doc": "",
480
+ "types": [
481
+ "'lite' | ''"
482
+ ]
483
+ }
484
+ ],
485
+ "deprecated": "Use `player_is_authorized` instead."
486
+ },
487
+ {
488
+ "type": "FUNCTION",
489
+ "name": "player_is_authorized",
490
+ "brief": "Return the user's auth mode.",
491
+ "description": "Return the user's auth mode.",
492
+ "docSource": "upstream",
493
+ "parameters": [],
494
+ "returnvalues": [
495
+ {
496
+ "name": "",
497
+ "doc": "",
498
+ "types": [
499
+ "boolean"
500
+ ]
501
+ }
502
+ ]
503
+ },
336
504
  {
337
505
  "type": "FUNCTION",
338
506
  "name": "payments_init",
339
- "brief": "",
340
- "description": "",
507
+ "brief": "Initializes the in-game purchases system.",
508
+ "description": "Initializes the in-game purchases system.",
509
+ "docSource": "upstream",
341
510
  "parameters": [
342
511
  {
343
512
  "name": "options",
@@ -365,8 +534,9 @@
365
534
  {
366
535
  "type": "FUNCTION",
367
536
  "name": "payments_purchase",
368
- "brief": "",
369
- "description": "",
537
+ "brief": "Activate an in-game purchase.",
538
+ "description": "Activate an in-game purchase.",
539
+ "docSource": "upstream",
370
540
  "parameters": [
371
541
  {
372
542
  "name": "options",
@@ -394,8 +564,9 @@
394
564
  {
395
565
  "type": "FUNCTION",
396
566
  "name": "payments_get_purchases",
397
- "brief": "",
398
- "description": "",
567
+ "brief": "Find out what purchases a player already made.",
568
+ "description": "Find out what purchases a player already made.",
569
+ "docSource": "upstream",
399
570
  "parameters": [
400
571
  {
401
572
  "name": "callback",
@@ -415,9 +586,18 @@
415
586
  {
416
587
  "type": "FUNCTION",
417
588
  "name": "payments_get_catalog",
418
- "brief": "",
419
- "description": "",
589
+ "brief": "Get a list of available purchases and their cost.",
590
+ "description": "Get a list of available purchases and their cost.",
591
+ "docSource": "upstream",
420
592
  "parameters": [
593
+ {
594
+ "name": "options",
595
+ "doc": "",
596
+ "types": [
597
+ "PaymentsCatalogOptions | undefined"
598
+ ],
599
+ "is_optional": "False"
600
+ },
421
601
  {
422
602
  "name": "callback",
423
603
  "doc": "",
@@ -432,8 +612,9 @@
432
612
  {
433
613
  "type": "FUNCTION",
434
614
  "name": "payments_consume_purchase",
435
- "brief": "",
436
- "description": "",
615
+ "brief": "Consume an in-game purchase.",
616
+ "description": "Consume an in-game purchase.\nThere are two types of purchases: permanent (such as for disabling ads) and consumable (such as in-game currency).\nTo process consumable purchases, use this function.",
617
+ "docSource": "upstream",
437
618
  "parameters": [
438
619
  {
439
620
  "name": "purchase_token",
@@ -457,8 +638,9 @@
457
638
  {
458
639
  "type": "FUNCTION",
459
640
  "name": "leaderboards_init",
460
- "brief": "",
461
- "description": "",
641
+ "brief": "Initializes the leaderboards subsystem.",
642
+ "description": "Initializes the leaderboards subsystem.",
643
+ "docSource": "upstream",
462
644
  "parameters": [
463
645
  {
464
646
  "name": "callback",
@@ -469,7 +651,8 @@
469
651
  "is_optional": "False"
470
652
  }
471
653
  ],
472
- "returnvalues": []
654
+ "returnvalues": [],
655
+ "deprecated": "The leaderboards subsystem no longer needs initializing; the other\n`leaderboards_*` functions work without it."
473
656
  },
474
657
  {
475
658
  "type": "TYPEDEF",
@@ -478,8 +661,9 @@
478
661
  {
479
662
  "type": "FUNCTION",
480
663
  "name": "leaderboards_get_description",
481
- "brief": "",
482
- "description": "",
664
+ "brief": "Get a description of a leaderboard by name.",
665
+ "description": "Get a description of a leaderboard by name.",
666
+ "docSource": "upstream",
483
667
  "parameters": [
484
668
  {
485
669
  "name": "leaderboard_name",
@@ -503,8 +687,9 @@
503
687
  {
504
688
  "type": "FUNCTION",
505
689
  "name": "leaderboards_get_player_entry",
506
- "brief": "",
507
- "description": "",
690
+ "brief": "Get a player's ranking.",
691
+ "description": "Get a player's ranking.",
692
+ "docSource": "upstream",
508
693
  "parameters": [
509
694
  {
510
695
  "name": "leaderboard_name",
@@ -540,8 +725,9 @@
540
725
  {
541
726
  "type": "FUNCTION",
542
727
  "name": "leaderboards_get_entries",
543
- "brief": "",
544
- "description": "",
728
+ "brief": "Gets player's rankings.",
729
+ "description": "Gets player's rankings.",
730
+ "docSource": "upstream",
545
731
  "parameters": [
546
732
  {
547
733
  "name": "leaderboard_name",
@@ -573,8 +759,9 @@
573
759
  {
574
760
  "type": "FUNCTION",
575
761
  "name": "leaderboards_set_score",
576
- "brief": "",
577
- "description": "",
762
+ "brief": "Sets a new score for a player.",
763
+ "description": "Sets a new score for a player.",
764
+ "docSource": "upstream",
578
765
  "parameters": [
579
766
  {
580
767
  "name": "leaderboard_name",
@@ -611,6 +798,85 @@
611
798
  ],
612
799
  "returnvalues": []
613
800
  },
801
+ {
802
+ "type": "FUNCTION",
803
+ "name": "features_loadingapi_ready",
804
+ "brief": "Informs the SDK that the game has loaded and is ready to play.",
805
+ "description": "Informs the SDK that the game has loaded and is ready to play.",
806
+ "docSource": "upstream",
807
+ "parameters": [],
808
+ "returnvalues": []
809
+ },
810
+ {
811
+ "type": "FUNCTION",
812
+ "name": "features_gameplayapi_start",
813
+ "brief": "The method should be called when the player starts or resumes gameplay.",
814
+ "description": "The method should be called when the player starts or resumes gameplay.",
815
+ "docSource": "upstream",
816
+ "parameters": [],
817
+ "returnvalues": []
818
+ },
819
+ {
820
+ "type": "FUNCTION",
821
+ "name": "features_gameplayapi_stop",
822
+ "brief": "The method should be called when the player stops or pauses gameplay.",
823
+ "description": "The method should be called when the player stops or pauses gameplay.",
824
+ "docSource": "upstream",
825
+ "parameters": [],
826
+ "returnvalues": []
827
+ },
828
+ {
829
+ "type": "TYPEDEF",
830
+ "name": "GamesApiAllGamesCallback"
831
+ },
832
+ {
833
+ "type": "FUNCTION",
834
+ "name": "features_gamesapi_get_all_games",
835
+ "brief": "Get information about all your games available on the current platform and domain.",
836
+ "description": "Get information about all your games available on the current platform and domain.",
837
+ "docSource": "upstream",
838
+ "parameters": [
839
+ {
840
+ "name": "callback",
841
+ "doc": "",
842
+ "types": [
843
+ "GamesApiAllGamesCallback"
844
+ ],
845
+ "is_optional": "False"
846
+ }
847
+ ],
848
+ "returnvalues": []
849
+ },
850
+ {
851
+ "type": "TYPEDEF",
852
+ "name": "GamesApiGameByIdCallback"
853
+ },
854
+ {
855
+ "type": "FUNCTION",
856
+ "name": "features_gamesapi_get_game_by_id",
857
+ "brief": "Get a game by ID.",
858
+ "description": "Get a game by ID.",
859
+ "docSource": "upstream",
860
+ "parameters": [
861
+ {
862
+ "name": "app_id",
863
+ "doc": "",
864
+ "types": [
865
+ "number"
866
+ ],
867
+ "is_optional": "False"
868
+ },
869
+ {
870
+ "name": "callback",
871
+ "doc": "",
872
+ "types": [
873
+ "GamesApiGameByIdCallback"
874
+ ],
875
+ "is_optional": "False"
876
+ }
877
+ ],
878
+ "returnvalues": []
879
+ },
614
880
  {
615
881
  "type": "TYPEDEF",
616
882
  "name": "FeedbackCanReviewCallback"
@@ -618,8 +884,9 @@
618
884
  {
619
885
  "type": "FUNCTION",
620
886
  "name": "feedback_can_review",
621
- "brief": "",
622
- "description": "",
887
+ "brief": "Finds out if it is possible to request a feedback window for the game.",
888
+ "description": "Finds out if it is possible to request a feedback window for the game.",
889
+ "docSource": "upstream",
623
890
  "parameters": [
624
891
  {
625
892
  "name": "callback",
@@ -639,8 +906,9 @@
639
906
  {
640
907
  "type": "FUNCTION",
641
908
  "name": "feedback_request_review",
642
- "brief": "",
643
- "description": "",
909
+ "brief": "Offers the user to rate the game.",
910
+ "description": "Offers the user to rate the game.",
911
+ "docSource": "upstream",
644
912
  "parameters": [
645
913
  {
646
914
  "name": "callback",
@@ -656,8 +924,9 @@
656
924
  {
657
925
  "type": "FUNCTION",
658
926
  "name": "clipboard_write_text",
659
- "brief": "",
660
- "description": "",
927
+ "brief": "Writes a string to the clipboard.",
928
+ "description": "Writes a string to the clipboard.",
929
+ "docSource": "upstream",
661
930
  "parameters": [
662
931
  {
663
932
  "name": "text",
@@ -681,8 +950,9 @@
681
950
  {
682
951
  "type": "FUNCTION",
683
952
  "name": "device_info_type",
684
- "brief": "",
685
- "description": "",
953
+ "brief": "Returns the type of the user's device.",
954
+ "description": "Returns the type of the user's device.",
955
+ "docSource": "upstream",
686
956
  "parameters": [],
687
957
  "returnvalues": [
688
958
  {
@@ -697,8 +967,9 @@
697
967
  {
698
968
  "type": "FUNCTION",
699
969
  "name": "device_info_is_desktop",
700
- "brief": "",
701
- "description": "",
970
+ "brief": "Checks the user's device and returns \"true\" if it's a desktop.",
971
+ "description": "Checks the user's device and returns \"true\" if it's a desktop.",
972
+ "docSource": "upstream",
702
973
  "parameters": [],
703
974
  "returnvalues": [
704
975
  {
@@ -713,8 +984,9 @@
713
984
  {
714
985
  "type": "FUNCTION",
715
986
  "name": "device_info_is_mobile",
716
- "brief": "",
717
- "description": "",
987
+ "brief": "Checks the user's device and returns \"true\" if it's a mobile.",
988
+ "description": "Checks the user's device and returns \"true\" if it's a mobile.",
989
+ "docSource": "upstream",
718
990
  "parameters": [],
719
991
  "returnvalues": [
720
992
  {
@@ -729,8 +1001,26 @@
729
1001
  {
730
1002
  "type": "FUNCTION",
731
1003
  "name": "device_info_is_tablet",
732
- "brief": "",
733
- "description": "",
1004
+ "brief": "Checks the user's device and returns \"true\" if it's a tablet.",
1005
+ "description": "Checks the user's device and returns \"true\" if it's a tablet.",
1006
+ "docSource": "upstream",
1007
+ "parameters": [],
1008
+ "returnvalues": [
1009
+ {
1010
+ "name": "",
1011
+ "doc": "",
1012
+ "types": [
1013
+ "boolean"
1014
+ ]
1015
+ }
1016
+ ]
1017
+ },
1018
+ {
1019
+ "type": "FUNCTION",
1020
+ "name": "device_info_is_tv",
1021
+ "brief": "Checks the user's device and returns \"true\" if it's a TV.",
1022
+ "description": "Checks the user's device and returns \"true\" if it's a TV.",
1023
+ "docSource": "upstream",
734
1024
  "parameters": [],
735
1025
  "returnvalues": [
736
1026
  {
@@ -745,8 +1035,9 @@
745
1035
  {
746
1036
  "type": "FUNCTION",
747
1037
  "name": "environment",
748
- "brief": "",
749
- "description": "",
1038
+ "brief": "Returns a table with game environment variables.",
1039
+ "description": "Returns a table with game environment variables.",
1040
+ "docSource": "upstream",
750
1041
  "parameters": [],
751
1042
  "returnvalues": [
752
1043
  {
@@ -761,8 +1052,9 @@
761
1052
  {
762
1053
  "type": "FUNCTION",
763
1054
  "name": "screen_fullscreen_status",
764
- "brief": "",
765
- "description": "",
1055
+ "brief": "Gets the current fullscreen state: \"on\" or \"off\".",
1056
+ "description": "Gets the current fullscreen state: \"on\" or \"off\".",
1057
+ "docSource": "upstream",
766
1058
  "parameters": [],
767
1059
  "returnvalues": [
768
1060
  {
@@ -777,8 +1069,9 @@
777
1069
  {
778
1070
  "type": "FUNCTION",
779
1071
  "name": "screen_fullscreen_request",
780
- "brief": "",
781
- "description": "",
1072
+ "brief": "Requests entering fullscreen mode.",
1073
+ "description": "Requests entering fullscreen mode.",
1074
+ "docSource": "upstream",
782
1075
  "parameters": [
783
1076
  {
784
1077
  "name": "callback",
@@ -794,8 +1087,9 @@
794
1087
  {
795
1088
  "type": "FUNCTION",
796
1089
  "name": "screen_fullscreen_exit",
797
- "brief": "",
798
- "description": "",
1090
+ "brief": "Request exit from fullscreen mode.",
1091
+ "description": "Request exit from fullscreen mode.",
1092
+ "docSource": "upstream",
799
1093
  "parameters": [
800
1094
  {
801
1095
  "name": "callback",
@@ -808,11 +1102,56 @@
808
1102
  ],
809
1103
  "returnvalues": []
810
1104
  },
1105
+ {
1106
+ "type": "TYPEDEF",
1107
+ "name": "ShortcutCanShowCallback"
1108
+ },
1109
+ {
1110
+ "type": "FUNCTION",
1111
+ "name": "shortcut_can_show_prompt",
1112
+ "brief": "Check if a shortcut can be added.",
1113
+ "description": "Check if a shortcut can be added.",
1114
+ "docSource": "upstream",
1115
+ "parameters": [
1116
+ {
1117
+ "name": "callback",
1118
+ "doc": "",
1119
+ "types": [
1120
+ "ShortcutCanShowCallback"
1121
+ ],
1122
+ "is_optional": "False"
1123
+ }
1124
+ ],
1125
+ "returnvalues": []
1126
+ },
1127
+ {
1128
+ "type": "TYPEDEF",
1129
+ "name": "ShortcutShowPromptCallback"
1130
+ },
1131
+ {
1132
+ "type": "FUNCTION",
1133
+ "name": "shortcut_show_prompt",
1134
+ "brief": "Show a prompt to the user to add a shortcut to the game.",
1135
+ "description": "Show a prompt to the user to add a shortcut to the game.",
1136
+ "docSource": "upstream",
1137
+ "parameters": [
1138
+ {
1139
+ "name": "callback",
1140
+ "doc": "",
1141
+ "types": [
1142
+ "ShortcutShowPromptCallback"
1143
+ ],
1144
+ "is_optional": "True"
1145
+ }
1146
+ ],
1147
+ "returnvalues": []
1148
+ },
811
1149
  {
812
1150
  "type": "FUNCTION",
813
1151
  "name": "storage_init",
814
- "brief": "",
815
- "description": "",
1152
+ "brief": "Initialize the Safe Storage",
1153
+ "description": "Initialize the Safe Storage",
1154
+ "docSource": "upstream",
816
1155
  "parameters": [
817
1156
  {
818
1157
  "name": "callback",
@@ -828,8 +1167,9 @@
828
1167
  {
829
1168
  "type": "FUNCTION",
830
1169
  "name": "storage_get_item",
831
- "brief": "",
832
- "description": "",
1170
+ "brief": "Returns that key's value or nil.",
1171
+ "description": "Returns that key's value or nil.",
1172
+ "docSource": "upstream",
833
1173
  "parameters": [
834
1174
  {
835
1175
  "name": "key",
@@ -853,8 +1193,9 @@
853
1193
  {
854
1194
  "type": "FUNCTION",
855
1195
  "name": "storage_set_item",
856
- "brief": "",
857
- "description": "",
1196
+ "brief": "Adds that key to the storage, or update that key's value if it already exists.",
1197
+ "description": "Adds that key to the storage, or update that key's value if it already exists.",
1198
+ "docSource": "upstream",
858
1199
  "parameters": [
859
1200
  {
860
1201
  "name": "key",
@@ -878,8 +1219,9 @@
878
1219
  {
879
1220
  "type": "FUNCTION",
880
1221
  "name": "storage_remove_item",
881
- "brief": "",
882
- "description": "",
1222
+ "brief": "Removes that key from the storage.",
1223
+ "description": "Removes that key from the storage.",
1224
+ "docSource": "upstream",
883
1225
  "parameters": [
884
1226
  {
885
1227
  "name": "key",
@@ -895,16 +1237,18 @@
895
1237
  {
896
1238
  "type": "FUNCTION",
897
1239
  "name": "storage_clear",
898
- "brief": "",
899
- "description": "",
1240
+ "brief": "Empties all keys out of the storage.",
1241
+ "description": "Empties all keys out of the storage.",
1242
+ "docSource": "upstream",
900
1243
  "parameters": [],
901
1244
  "returnvalues": []
902
1245
  },
903
1246
  {
904
1247
  "type": "FUNCTION",
905
1248
  "name": "storage_key",
906
- "brief": "",
907
- "description": "",
1249
+ "brief": "Returns the name of the nth key in the storage.",
1250
+ "description": "Returns the name of the nth key in the storage.",
1251
+ "docSource": "upstream",
908
1252
  "parameters": [
909
1253
  {
910
1254
  "name": "n",
@@ -928,8 +1272,9 @@
928
1272
  {
929
1273
  "type": "FUNCTION",
930
1274
  "name": "storage_length",
931
- "brief": "",
932
- "description": "",
1275
+ "brief": "Returns the number of data items stored in the storage.",
1276
+ "description": "Returns the number of data items stored in the storage.",
1277
+ "docSource": "upstream",
933
1278
  "parameters": [],
934
1279
  "returnvalues": [
935
1280
  {
@@ -941,46 +1286,22 @@
941
1286
  }
942
1287
  ]
943
1288
  },
944
- {
945
- "type": "FUNCTION",
946
- "name": "banner_init",
947
- "brief": "",
948
- "description": "",
949
- "parameters": [
950
- {
951
- "name": "callback",
952
- "doc": "",
953
- "types": [
954
- "ApiCallback"
955
- ],
956
- "is_optional": "False"
957
- }
958
- ],
959
- "returnvalues": []
960
- },
961
1289
  {
962
1290
  "type": "TYPEDEF",
963
- "name": "BannerCreateCallback"
1291
+ "name": "FlagsCallback"
964
1292
  },
965
1293
  {
966
1294
  "type": "FUNCTION",
967
- "name": "banner_create",
968
- "brief": "",
969
- "description": "",
1295
+ "name": "flags_get",
1296
+ "brief": "Asynchronously get remote config data",
1297
+ "description": "Asynchronously get remote config data",
1298
+ "docSource": "upstream",
970
1299
  "parameters": [
971
- {
972
- "name": "rtb_id",
973
- "doc": "",
974
- "types": [
975
- "string"
976
- ],
977
- "is_optional": "False"
978
- },
979
1300
  {
980
1301
  "name": "options",
981
1302
  "doc": "",
982
1303
  "types": [
983
- "BannerCreateOptions"
1304
+ "FlagsOptions | undefined"
984
1305
  ],
985
1306
  "is_optional": "False"
986
1307
  },
@@ -988,38 +1309,48 @@
988
1309
  "name": "callback",
989
1310
  "doc": "",
990
1311
  "types": [
991
- "BannerCreateCallback"
1312
+ "FlagsCallback"
992
1313
  ],
993
- "is_optional": "True"
1314
+ "is_optional": "False"
994
1315
  }
995
1316
  ],
996
1317
  "returnvalues": []
997
1318
  },
998
1319
  {
999
1320
  "type": "FUNCTION",
1000
- "name": "banner_delete",
1001
- "brief": "",
1002
- "description": "",
1321
+ "name": "event_on",
1322
+ "brief": "Add an event listener.",
1323
+ "description": "Add an event listener.",
1324
+ "docSource": "upstream",
1003
1325
  "parameters": [
1004
1326
  {
1005
- "name": "rtb_id",
1327
+ "name": "event_name",
1006
1328
  "doc": "",
1007
1329
  "types": [
1008
1330
  "string"
1009
1331
  ],
1010
1332
  "is_optional": "False"
1333
+ },
1334
+ {
1335
+ "name": "listener",
1336
+ "doc": "",
1337
+ "types": [
1338
+ "ApiCallback"
1339
+ ],
1340
+ "is_optional": "False"
1011
1341
  }
1012
1342
  ],
1013
1343
  "returnvalues": []
1014
1344
  },
1015
1345
  {
1016
1346
  "type": "FUNCTION",
1017
- "name": "banner_refresh",
1018
- "brief": "",
1019
- "description": "",
1347
+ "name": "event_off",
1348
+ "brief": "Remove an event listener.",
1349
+ "description": "Remove an event listener.",
1350
+ "docSource": "upstream",
1020
1351
  "parameters": [
1021
1352
  {
1022
- "name": "rtb_id",
1353
+ "name": "event_name",
1023
1354
  "doc": "",
1024
1355
  "types": [
1025
1356
  "string"
@@ -1027,43 +1358,58 @@
1027
1358
  "is_optional": "False"
1028
1359
  },
1029
1360
  {
1030
- "name": "callback",
1361
+ "name": "listener",
1031
1362
  "doc": "",
1032
1363
  "types": [
1033
- "BannerCreateCallback"
1364
+ "ApiCallback"
1034
1365
  ],
1035
- "is_optional": "True"
1366
+ "is_optional": "False"
1036
1367
  }
1037
1368
  ],
1038
1369
  "returnvalues": []
1039
1370
  },
1040
1371
  {
1041
1372
  "type": "FUNCTION",
1042
- "name": "banner_set",
1043
- "brief": "",
1044
- "description": "",
1373
+ "name": "event_dispatch",
1374
+ "brief": "Dispatch an event.",
1375
+ "description": "Dispatch an event.",
1376
+ "docSource": "upstream",
1045
1377
  "parameters": [
1046
1378
  {
1047
- "name": "rtb_id",
1379
+ "name": "event_name",
1048
1380
  "doc": "",
1049
1381
  "types": [
1050
1382
  "string"
1051
1383
  ],
1052
1384
  "is_optional": "False"
1053
- },
1054
- {
1055
- "name": "property",
1056
- "doc": "",
1385
+ }
1386
+ ],
1387
+ "returnvalues": []
1388
+ },
1389
+ {
1390
+ "type": "TYPEDEF",
1391
+ "name": "MultiplayerSessionsInitCallback"
1392
+ },
1393
+ {
1394
+ "type": "FUNCTION",
1395
+ "name": "multiplayer_sessions_init",
1396
+ "brief": "Initialize the multiplayer sessions. If `isEventBased` is true, you must subscribe to the events `multiplayer-sessions-transaction` and `multiplayer-sessions-finish` through `yagames.event_on(event_name, listener)`, and the SDK itself will load the session and events at the specified timestamps.",
1397
+ "description": "Initialize the multiplayer sessions. If `isEventBased` is true, you must subscribe to the events `multiplayer-sessions-transaction` and `multiplayer-sessions-finish` through `yagames.event_on(event_name, listener)`, and the SDK itself will load the session and events at the specified timestamps.\nNote: To load sessions, you must set at least one of the 3 `meta`-parameters, and the `count` parameter must be greater than zero. Otherwise, the multiplayer will be initialized only for **writing** data.",
1398
+ "docSource": "upstream",
1399
+ "parameters": [
1400
+ {
1401
+ "name": "options",
1402
+ "doc": "",
1057
1403
  "types": [
1058
- "\"stat_id\" | \"css_styles\" | \"css_class\" | \"display\""
1404
+ "MultiplayerSessionsInitOptions"
1059
1405
  ],
1060
1406
  "is_optional": "False"
1061
1407
  },
1062
1408
  {
1063
- "name": "value",
1409
+ "name": "callback",
1064
1410
  "doc": "",
1065
1411
  "types": [
1066
- "string"
1412
+ "MultiplayerSessionsInitCallback"
1067
1413
  ],
1068
1414
  "is_optional": "False"
1069
1415
  }
@@ -1072,15 +1418,16 @@
1072
1418
  },
1073
1419
  {
1074
1420
  "type": "FUNCTION",
1075
- "name": "add_domain",
1076
- "brief": "",
1077
- "description": "",
1421
+ "name": "multiplayer_sessions_commit",
1422
+ "brief": "Commit the multiplayer session",
1423
+ "description": "Commit the multiplayer session",
1424
+ "docSource": "upstream",
1078
1425
  "parameters": [
1079
1426
  {
1080
- "name": "domain",
1427
+ "name": "data",
1081
1428
  "doc": "",
1082
1429
  "types": [
1083
- "string"
1430
+ "Record<string, unknown>"
1084
1431
  ],
1085
1432
  "is_optional": "False"
1086
1433
  }
@@ -1089,48 +1436,65 @@
1089
1436
  },
1090
1437
  {
1091
1438
  "type": "FUNCTION",
1092
- "name": "verify_domain",
1093
- "brief": "",
1094
- "description": "",
1095
- "parameters": [],
1096
- "returnvalues": [
1439
+ "name": "multiplayer_sessions_push",
1440
+ "brief": "Push the multiplayer session",
1441
+ "description": "Push the multiplayer session",
1442
+ "docSource": "upstream",
1443
+ "parameters": [
1097
1444
  {
1098
- "name": "",
1445
+ "name": "data",
1099
1446
  "doc": "",
1100
1447
  "types": [
1101
- "boolean"
1102
- ]
1448
+ "MultiplayerSessionsPushMeta"
1449
+ ],
1450
+ "is_optional": "False"
1103
1451
  }
1104
- ]
1452
+ ],
1453
+ "returnvalues": []
1454
+ },
1455
+ {
1456
+ "type": "TYPEDEF",
1457
+ "name": "AvailableMethodCallback"
1105
1458
  },
1106
1459
  {
1107
1460
  "type": "FUNCTION",
1108
- "name": "get_current_domain",
1109
- "brief": "",
1110
- "description": "",
1111
- "parameters": [],
1112
- "returnvalues": [
1461
+ "name": "is_available_method",
1462
+ "brief": "Checks if the method is available to call",
1463
+ "description": "Checks if the method is available to call",
1464
+ "docSource": "upstream",
1465
+ "parameters": [
1113
1466
  {
1114
- "name": "",
1467
+ "name": "name",
1115
1468
  "doc": "",
1116
1469
  "types": [
1117
1470
  "string"
1118
- ]
1471
+ ],
1472
+ "is_optional": "False"
1473
+ },
1474
+ {
1475
+ "name": "callback",
1476
+ "doc": "",
1477
+ "types": [
1478
+ "AvailableMethodCallback"
1479
+ ],
1480
+ "is_optional": "False"
1119
1481
  }
1120
- ]
1482
+ ],
1483
+ "returnvalues": []
1121
1484
  },
1122
1485
  {
1123
1486
  "type": "FUNCTION",
1124
- "name": "is_release_build",
1125
- "brief": "",
1126
- "description": "",
1487
+ "name": "server_time",
1488
+ "brief": "Get server time in UNIX format.",
1489
+ "description": "Get server time in UNIX format.",
1490
+ "docSource": "upstream",
1127
1491
  "parameters": [],
1128
1492
  "returnvalues": [
1129
1493
  {
1130
1494
  "name": "",
1131
1495
  "doc": "",
1132
1496
  "types": [
1133
- "boolean"
1497
+ "number"
1134
1498
  ]
1135
1499
  }
1136
1500
  ]
@@ -1211,6 +1575,29 @@
1211
1575
  }
1212
1576
  ]
1213
1577
  },
1578
+ {
1579
+ "type": "TYPEDEF",
1580
+ "name": "StickyBannerStatus",
1581
+ "properties": [
1582
+ {
1583
+ "name": "stickyAdvIsShowing",
1584
+ "brief": "",
1585
+ "description": "",
1586
+ "types": [
1587
+ "boolean"
1588
+ ]
1589
+ },
1590
+ {
1591
+ "name": "reason",
1592
+ "brief": "",
1593
+ "description": "",
1594
+ "types": [
1595
+ "\"ADV_IS_NOT_CONNECTED\" | \"UNKNOWN\""
1596
+ ],
1597
+ "is_optional": "True"
1598
+ }
1599
+ ]
1600
+ },
1214
1601
  {
1215
1602
  "type": "TYPEDEF",
1216
1603
  "name": "PlayerInitOptions",
@@ -1221,7 +1608,8 @@
1221
1608
  "description": "",
1222
1609
  "types": [
1223
1610
  "boolean"
1224
- ]
1611
+ ],
1612
+ "is_optional": "True"
1225
1613
  },
1226
1614
  {
1227
1615
  "name": "scopes",
@@ -1229,7 +1617,8 @@
1229
1617
  "description": "",
1230
1618
  "types": [
1231
1619
  "boolean"
1232
- ]
1620
+ ],
1621
+ "is_optional": "True"
1233
1622
  }
1234
1623
  ]
1235
1624
  },
@@ -1251,7 +1640,23 @@
1251
1640
  "description": "",
1252
1641
  "types": [
1253
1642
  "string"
1254
- ]
1643
+ ],
1644
+ "is_optional": "True"
1645
+ }
1646
+ ]
1647
+ },
1648
+ {
1649
+ "type": "TYPEDEF",
1650
+ "name": "PaymentsCatalogOptions",
1651
+ "properties": [
1652
+ {
1653
+ "name": "getPriceCurrencyImage",
1654
+ "brief": "",
1655
+ "description": "",
1656
+ "types": [
1657
+ "'medium' | 'small' | 'svg'"
1658
+ ],
1659
+ "is_optional": "True"
1255
1660
  }
1256
1661
  ]
1257
1662
  },
@@ -1265,7 +1670,8 @@
1265
1670
  "description": "",
1266
1671
  "types": [
1267
1672
  "boolean"
1268
- ]
1673
+ ],
1674
+ "is_optional": "True"
1269
1675
  },
1270
1676
  {
1271
1677
  "name": "quantityAround",
@@ -1273,7 +1679,8 @@
1273
1679
  "description": "",
1274
1680
  "types": [
1275
1681
  "number"
1276
- ]
1682
+ ],
1683
+ "is_optional": "True"
1277
1684
  },
1278
1685
  {
1279
1686
  "name": "quantityTop",
@@ -1281,7 +1688,8 @@
1281
1688
  "description": "",
1282
1689
  "types": [
1283
1690
  "number"
1284
- ]
1691
+ ],
1692
+ "is_optional": "True"
1285
1693
  },
1286
1694
  {
1287
1695
  "name": "getAvatarSrc",
@@ -1289,7 +1697,8 @@
1289
1697
  "description": "",
1290
1698
  "types": [
1291
1699
  "\"small\" | \"medium\" | \"large\""
1292
- ]
1700
+ ],
1701
+ "is_optional": "True"
1293
1702
  },
1294
1703
  {
1295
1704
  "name": "getAvatarSrcSet",
@@ -1297,7 +1706,8 @@
1297
1706
  "description": "",
1298
1707
  "types": [
1299
1708
  "\"small\" | \"medium\" | \"large\""
1300
- ]
1709
+ ],
1710
+ "is_optional": "True"
1301
1711
  }
1302
1712
  ]
1303
1713
  },
@@ -1311,7 +1721,8 @@
1311
1721
  "description": "",
1312
1722
  "types": [
1313
1723
  "boolean"
1314
- ]
1724
+ ],
1725
+ "is_optional": "True"
1315
1726
  },
1316
1727
  {
1317
1728
  "name": "quantityAround",
@@ -1319,7 +1730,8 @@
1319
1730
  "description": "",
1320
1731
  "types": [
1321
1732
  "number"
1322
- ]
1733
+ ],
1734
+ "is_optional": "True"
1323
1735
  },
1324
1736
  {
1325
1737
  "name": "quantityTop",
@@ -1327,7 +1739,8 @@
1327
1739
  "description": "",
1328
1740
  "types": [
1329
1741
  "number"
1330
- ]
1742
+ ],
1743
+ "is_optional": "True"
1331
1744
  },
1332
1745
  {
1333
1746
  "name": "getAvatarSrc",
@@ -1335,7 +1748,8 @@
1335
1748
  "description": "",
1336
1749
  "types": [
1337
1750
  "\"small\" | \"medium\" | \"large\""
1338
- ]
1751
+ ],
1752
+ "is_optional": "True"
1339
1753
  },
1340
1754
  {
1341
1755
  "name": "getAvatarSrcSet",
@@ -1343,6 +1757,53 @@
1343
1757
  "description": "",
1344
1758
  "types": [
1345
1759
  "\"small\" | \"medium\" | \"large\""
1760
+ ],
1761
+ "is_optional": "True"
1762
+ }
1763
+ ]
1764
+ },
1765
+ {
1766
+ "type": "TYPEDEF",
1767
+ "name": "GamesApiGame",
1768
+ "properties": [
1769
+ {
1770
+ "name": "appID",
1771
+ "brief": "",
1772
+ "description": "",
1773
+ "types": [
1774
+ "string"
1775
+ ]
1776
+ },
1777
+ {
1778
+ "name": "title",
1779
+ "brief": "",
1780
+ "description": "",
1781
+ "types": [
1782
+ "string"
1783
+ ]
1784
+ },
1785
+ {
1786
+ "name": "url",
1787
+ "brief": "",
1788
+ "description": "",
1789
+ "types": [
1790
+ "string"
1791
+ ]
1792
+ },
1793
+ {
1794
+ "name": "coverURL",
1795
+ "brief": "",
1796
+ "description": "",
1797
+ "types": [
1798
+ "string"
1799
+ ]
1800
+ },
1801
+ {
1802
+ "name": "iconURL",
1803
+ "brief": "",
1804
+ "description": "",
1805
+ "types": [
1806
+ "string"
1346
1807
  ]
1347
1808
  }
1348
1809
  ]
@@ -1419,16 +1880,41 @@
1419
1880
  "description": "",
1420
1881
  "types": [
1421
1882
  "string"
1422
- ]
1883
+ ],
1884
+ "is_optional": "True"
1885
+ }
1886
+ ]
1887
+ },
1888
+ {
1889
+ "type": "TYPEDEF",
1890
+ "name": "FlagsOptions",
1891
+ "properties": [
1892
+ {
1893
+ "name": "defaultFlags",
1894
+ "brief": "",
1895
+ "description": "",
1896
+ "types": [
1897
+ "Record<string, string>"
1898
+ ],
1899
+ "is_optional": "True"
1900
+ },
1901
+ {
1902
+ "name": "clientFeatures",
1903
+ "brief": "",
1904
+ "description": "",
1905
+ "types": [
1906
+ "Array<FlagsClientFeature>"
1907
+ ],
1908
+ "is_optional": "True"
1423
1909
  }
1424
1910
  ]
1425
1911
  },
1426
1912
  {
1427
1913
  "type": "TYPEDEF",
1428
- "name": "BannerCreateOptions",
1914
+ "name": "MultiplayerSessionsInitOptions",
1429
1915
  "properties": [
1430
1916
  {
1431
- "name": "stat_id",
1917
+ "name": "count",
1432
1918
  "brief": "",
1433
1919
  "description": "",
1434
1920
  "types": [
@@ -1436,15 +1922,38 @@
1436
1922
  ]
1437
1923
  },
1438
1924
  {
1439
- "name": "css_styles",
1925
+ "name": "isEventBased",
1440
1926
  "brief": "",
1441
1927
  "description": "",
1442
1928
  "types": [
1443
- "string"
1929
+ "boolean"
1444
1930
  ]
1445
1931
  },
1446
1932
  {
1447
- "name": "css_class",
1933
+ "name": "maxOpponentTurnTime",
1934
+ "brief": "",
1935
+ "description": "",
1936
+ "types": [
1937
+ "number"
1938
+ ],
1939
+ "is_optional": "True"
1940
+ },
1941
+ {
1942
+ "name": "meta",
1943
+ "brief": "",
1944
+ "description": "",
1945
+ "types": [
1946
+ "MultiplayerSessionsMeta"
1947
+ ]
1948
+ }
1949
+ ]
1950
+ },
1951
+ {
1952
+ "type": "TYPEDEF",
1953
+ "name": "MultiplayerSession",
1954
+ "properties": [
1955
+ {
1956
+ "name": "id",
1448
1957
  "brief": "",
1449
1958
  "description": "",
1450
1959
  "types": [
@@ -1452,14 +1961,100 @@
1452
1961
  ]
1453
1962
  },
1454
1963
  {
1455
- "name": "display",
1964
+ "name": "meta1",
1965
+ "brief": "",
1966
+ "description": "",
1967
+ "types": [
1968
+ "number"
1969
+ ],
1970
+ "is_optional": "True"
1971
+ },
1972
+ {
1973
+ "name": "meta2",
1974
+ "brief": "",
1975
+ "description": "",
1976
+ "types": [
1977
+ "number"
1978
+ ],
1979
+ "is_optional": "True"
1980
+ },
1981
+ {
1982
+ "name": "meta3",
1983
+ "brief": "",
1984
+ "description": "",
1985
+ "types": [
1986
+ "number"
1987
+ ],
1988
+ "is_optional": "True"
1989
+ },
1990
+ {
1991
+ "name": "player",
1992
+ "brief": "",
1993
+ "description": "",
1994
+ "types": [
1995
+ "{ avatar: string; name: string; }"
1996
+ ],
1997
+ "fields": [
1998
+ {
1999
+ "name": "avatar",
2000
+ "doc": "",
2001
+ "types": [
2002
+ "string"
2003
+ ],
2004
+ "is_optional": "False"
2005
+ },
2006
+ {
2007
+ "name": "name",
2008
+ "doc": "",
2009
+ "types": [
2010
+ "string"
2011
+ ],
2012
+ "is_optional": "False"
2013
+ }
2014
+ ]
2015
+ },
2016
+ {
2017
+ "name": "timeline",
1456
2018
  "brief": "",
1457
2019
  "description": "",
1458
2020
  "types": [
1459
- "\"none\" | \"block\""
2021
+ "Array<MultiplayerSessionEvent>"
1460
2022
  ]
1461
2023
  }
1462
2024
  ]
2025
+ },
2026
+ {
2027
+ "type": "TYPEDEF",
2028
+ "name": "MultiplayerSessionsPushMeta",
2029
+ "properties": [
2030
+ {
2031
+ "name": "meta1",
2032
+ "brief": "",
2033
+ "description": "",
2034
+ "types": [
2035
+ "number"
2036
+ ],
2037
+ "is_optional": "True"
2038
+ },
2039
+ {
2040
+ "name": "meta2",
2041
+ "brief": "",
2042
+ "description": "",
2043
+ "types": [
2044
+ "number"
2045
+ ],
2046
+ "is_optional": "True"
2047
+ },
2048
+ {
2049
+ "name": "meta3",
2050
+ "brief": "",
2051
+ "description": "",
2052
+ "types": [
2053
+ "number"
2054
+ ],
2055
+ "is_optional": "True"
2056
+ }
2057
+ ]
1463
2058
  }
1464
2059
  ]
1465
2060
  }