@defold-typescript/library-types 0.22.0 → 0.23.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/api-doc/{bridge.bridge.json → bridge.json} +749 -844
- package/api-doc/decore.json +22 -22
- package/api-doc/druid.json +195 -1790
- package/api-doc/event.json +1074 -0
- package/api-doc/immutable.json +65 -0
- package/api-doc/lang.json +528 -0
- package/api-doc/{event.event.json → log.json} +96 -101
- package/api-doc/narrator.json +647 -0
- package/api-doc/proto.json +995 -0
- package/api-doc/saver.saver.json +713 -263
- package/api-doc/saver.storage.json +282 -52
- package/api-doc/squid.json +846 -0
- package/api-doc/tweener.json +277 -0
- package/generated/bridge.d.ts +468 -0
- package/generated/decore.d.ts +36 -36
- package/generated/druid.d.ts +137 -443
- package/generated/event.d.ts +318 -0
- package/generated/immutable.d.ts +13 -0
- package/generated/lang.d.ts +101 -0
- package/generated/log.d.ts +36 -0
- package/generated/narrator.d.ts +121 -0
- package/generated/proto.d.ts +146 -0
- package/generated/saver.saver.d.ts +287 -42
- package/generated/saver.storage.d.ts +77 -14
- package/generated/squid.d.ts +127 -0
- package/generated/tweener.d.ts +42 -0
- package/library-classification.json +0 -71
- package/library-targets.json +0 -66
- package/luals-targets.json +114 -0
- package/package.json +4 -33
- package/script-api-targets.json +15 -0
- package/scripts/__snapshots__/parse-luals.test.ts.snap +340 -75
- package/scripts/apply-luals-overrides.ts +63 -0
- package/scripts/emit-library-dts.ts +84 -3
- package/scripts/lower-api-doc.ts +48 -16
- package/scripts/luals-fidelity.ts +7 -0
- package/scripts/map-luals-types.ts +34 -1
- package/scripts/parse-luals.ts +423 -18
- package/scripts/sync-luals-types.ts +15 -1
- package/scripts/sync-script-api-types.ts +368 -0
- package/api-doc/immutable.immutable.json +0 -63
- package/api-doc/lang.lang.json +0 -411
- package/api-doc/log.log.json +0 -50
- package/api-doc/narrator.narrator.json +0 -150
- package/api-doc/proto.proto.json +0 -355
- package/api-doc/squid.squid.json +0 -660
- package/api-doc/tweener.tweener.json +0 -419
- package/generated/bridge.bridge.d.ts +0 -533
- package/generated/event.event.d.ts +0 -54
- package/generated/immutable.immutable.d.ts +0 -13
- package/generated/lang.lang.d.ts +0 -33
- package/generated/log.log.d.ts +0 -40
- package/generated/narrator.narrator.d.ts +0 -66
- package/generated/proto.proto.d.ts +0 -36
- package/generated/squid.squid.d.ts +0 -106
- package/generated/tweener.tweener.d.ts +0 -151
|
@@ -1,396 +1,413 @@
|
|
|
1
1
|
{
|
|
2
2
|
"info": {
|
|
3
|
-
"namespace": "bridge
|
|
4
|
-
"brief": "",
|
|
5
|
-
"description": ""
|
|
3
|
+
"namespace": "bridge",
|
|
4
|
+
"brief": "Functions and constants for interacting with bridge",
|
|
5
|
+
"description": "Functions and constants for interacting with bridge"
|
|
6
6
|
},
|
|
7
7
|
"elements": [
|
|
8
8
|
{
|
|
9
9
|
"type": "FUNCTION",
|
|
10
|
-
"name": "
|
|
11
|
-
"
|
|
12
|
-
"description": "Returns the achievement list in JSON.",
|
|
10
|
+
"name": "bridge.platform.on",
|
|
11
|
+
"description": "State changed events.",
|
|
13
12
|
"parameters": [
|
|
14
13
|
{
|
|
15
|
-
"name": "
|
|
14
|
+
"name": "event_name",
|
|
16
15
|
"doc": "",
|
|
17
16
|
"types": [
|
|
18
|
-
"
|
|
19
|
-
]
|
|
20
|
-
"is_optional": "False"
|
|
21
|
-
},
|
|
22
|
-
{
|
|
23
|
-
"name": "on_success",
|
|
24
|
-
"doc": "function(_, list)",
|
|
25
|
-
"types": [
|
|
26
|
-
"(this: any, list: unknown) => void"
|
|
27
|
-
],
|
|
28
|
-
"is_optional": "False"
|
|
17
|
+
"string"
|
|
18
|
+
]
|
|
29
19
|
},
|
|
30
20
|
{
|
|
31
|
-
"name": "
|
|
32
|
-
"doc": "function(_,
|
|
21
|
+
"name": "callback",
|
|
22
|
+
"doc": "function(_, state)",
|
|
33
23
|
"types": [
|
|
34
|
-
"
|
|
35
|
-
]
|
|
36
|
-
"is_optional": "False"
|
|
24
|
+
"function"
|
|
25
|
+
]
|
|
37
26
|
}
|
|
38
27
|
],
|
|
39
28
|
"returnvalues": []
|
|
40
29
|
},
|
|
41
30
|
{
|
|
42
31
|
"type": "FUNCTION",
|
|
43
|
-
"name": "
|
|
44
|
-
"
|
|
45
|
-
"description": "Check if getting list of achievements is supported.",
|
|
32
|
+
"name": "bridge.platform.id",
|
|
33
|
+
"description": "Identify the platform on which the game is currently running to customize features and settings accordingly.",
|
|
46
34
|
"parameters": [],
|
|
47
35
|
"returnvalues": [
|
|
48
36
|
{
|
|
49
|
-
"name": "",
|
|
37
|
+
"name": "result",
|
|
50
38
|
"doc": "",
|
|
51
39
|
"types": [
|
|
52
|
-
"
|
|
40
|
+
"string | nil"
|
|
53
41
|
]
|
|
54
42
|
}
|
|
55
43
|
]
|
|
56
44
|
},
|
|
57
45
|
{
|
|
58
46
|
"type": "FUNCTION",
|
|
59
|
-
"name": "
|
|
60
|
-
"
|
|
61
|
-
"description": "Check if built-in popup is supported.",
|
|
47
|
+
"name": "bridge.platform.tld",
|
|
48
|
+
"description": "Retrieve the top-level domain of the platform to handle domain-specific configurations and behavior.",
|
|
62
49
|
"parameters": [],
|
|
63
50
|
"returnvalues": [
|
|
64
51
|
{
|
|
65
|
-
"name": "",
|
|
52
|
+
"name": "result",
|
|
66
53
|
"doc": "",
|
|
67
54
|
"types": [
|
|
68
|
-
"
|
|
55
|
+
"string | nil"
|
|
69
56
|
]
|
|
70
57
|
}
|
|
71
58
|
]
|
|
72
59
|
},
|
|
73
60
|
{
|
|
74
61
|
"type": "FUNCTION",
|
|
75
|
-
"name": "
|
|
76
|
-
"
|
|
77
|
-
"description": "Use this to determine if you can implement achievements for your game on the current platform.",
|
|
62
|
+
"name": "bridge.platform.language",
|
|
63
|
+
"description": "Get the language set by the user on the platform or the browser language if not provided by the platform, to localize game content.",
|
|
78
64
|
"parameters": [],
|
|
79
65
|
"returnvalues": [
|
|
80
66
|
{
|
|
81
|
-
"name": "",
|
|
67
|
+
"name": "result",
|
|
82
68
|
"doc": "",
|
|
83
69
|
"types": [
|
|
84
|
-
"
|
|
70
|
+
"string"
|
|
85
71
|
]
|
|
86
72
|
}
|
|
87
73
|
]
|
|
88
74
|
},
|
|
89
75
|
{
|
|
90
76
|
"type": "FUNCTION",
|
|
91
|
-
"name": "
|
|
92
|
-
"
|
|
93
|
-
"
|
|
77
|
+
"name": "bridge.platform.payload",
|
|
78
|
+
"description": "Embed auxiliary information into the game URL to pass additional data or settings when launching the game.",
|
|
79
|
+
"parameters": [],
|
|
80
|
+
"returnvalues": [
|
|
81
|
+
{
|
|
82
|
+
"name": "result",
|
|
83
|
+
"doc": "",
|
|
84
|
+
"types": [
|
|
85
|
+
"string | nil"
|
|
86
|
+
]
|
|
87
|
+
}
|
|
88
|
+
]
|
|
89
|
+
},
|
|
90
|
+
{
|
|
91
|
+
"type": "FUNCTION",
|
|
92
|
+
"name": "bridge.platform.send_message",
|
|
93
|
+
"description": "Send predefined messages to the platform to trigger specific actions or events, such as signaling that the game is ready.",
|
|
94
94
|
"parameters": [
|
|
95
|
+
{
|
|
96
|
+
"name": "message",
|
|
97
|
+
"doc": "One of message types: `game_ready` `in_game_loading_started`",
|
|
98
|
+
"types": [
|
|
99
|
+
"string"
|
|
100
|
+
]
|
|
101
|
+
},
|
|
95
102
|
{
|
|
96
103
|
"name": "options",
|
|
97
|
-
"doc": "",
|
|
104
|
+
"doc": "Optional message-specific options (may be omitted).",
|
|
98
105
|
"types": [
|
|
99
|
-
"
|
|
100
|
-
]
|
|
101
|
-
"is_optional": "False"
|
|
106
|
+
"table"
|
|
107
|
+
]
|
|
102
108
|
},
|
|
103
109
|
{
|
|
104
110
|
"name": "on_success",
|
|
105
|
-
"doc": "
|
|
111
|
+
"doc": "",
|
|
106
112
|
"types": [
|
|
107
|
-
"
|
|
108
|
-
]
|
|
109
|
-
"is_optional": "False"
|
|
113
|
+
"function"
|
|
114
|
+
]
|
|
110
115
|
},
|
|
111
116
|
{
|
|
112
117
|
"name": "on_failure",
|
|
113
|
-
"doc": "
|
|
118
|
+
"doc": "",
|
|
114
119
|
"types": [
|
|
115
|
-
"
|
|
116
|
-
]
|
|
117
|
-
"is_optional": "False"
|
|
120
|
+
"function"
|
|
121
|
+
]
|
|
118
122
|
}
|
|
119
123
|
],
|
|
120
124
|
"returnvalues": []
|
|
121
125
|
},
|
|
122
126
|
{
|
|
123
127
|
"type": "FUNCTION",
|
|
124
|
-
"name": "
|
|
125
|
-
"
|
|
126
|
-
"description": "Unlocks achievement for a player.",
|
|
128
|
+
"name": "bridge.platform.send_custom_message",
|
|
129
|
+
"description": "Send a custom message with an arbitrary id to the platform.",
|
|
127
130
|
"parameters": [
|
|
131
|
+
{
|
|
132
|
+
"name": "id",
|
|
133
|
+
"doc": "The custom message id.",
|
|
134
|
+
"types": [
|
|
135
|
+
"string"
|
|
136
|
+
]
|
|
137
|
+
},
|
|
128
138
|
{
|
|
129
139
|
"name": "options",
|
|
130
|
-
"doc": "",
|
|
140
|
+
"doc": "Optional message-specific options (may be omitted).",
|
|
131
141
|
"types": [
|
|
132
|
-
"
|
|
133
|
-
]
|
|
134
|
-
"is_optional": "False"
|
|
142
|
+
"table"
|
|
143
|
+
]
|
|
135
144
|
},
|
|
136
145
|
{
|
|
137
146
|
"name": "on_success",
|
|
138
|
-
"doc": "
|
|
147
|
+
"doc": "",
|
|
139
148
|
"types": [
|
|
140
|
-
"
|
|
141
|
-
]
|
|
142
|
-
"is_optional": "False"
|
|
149
|
+
"function"
|
|
150
|
+
]
|
|
143
151
|
},
|
|
144
152
|
{
|
|
145
153
|
"name": "on_failure",
|
|
146
|
-
"doc": "
|
|
154
|
+
"doc": "",
|
|
147
155
|
"types": [
|
|
148
|
-
"
|
|
149
|
-
]
|
|
150
|
-
"is_optional": "False"
|
|
156
|
+
"function"
|
|
157
|
+
]
|
|
151
158
|
}
|
|
152
159
|
],
|
|
153
160
|
"returnvalues": []
|
|
154
161
|
},
|
|
155
162
|
{
|
|
156
163
|
"type": "FUNCTION",
|
|
157
|
-
"name": "
|
|
158
|
-
"
|
|
159
|
-
"description": "Hide the currently displayed banner ad when it is no longer needed.",
|
|
160
|
-
"parameters": [],
|
|
161
|
-
"returnvalues": []
|
|
162
|
-
},
|
|
163
|
-
{
|
|
164
|
-
"type": "FUNCTION",
|
|
165
|
-
"name": "advertisement.check_ad_block",
|
|
166
|
-
"brief": "Check if the ad blocker is enabled.",
|
|
167
|
-
"description": "Check if the ad blocker is enabled.",
|
|
164
|
+
"name": "bridge.platform.get_server_time",
|
|
165
|
+
"description": "Server Time",
|
|
168
166
|
"parameters": [
|
|
169
167
|
{
|
|
170
168
|
"name": "on_success",
|
|
171
|
-
"doc": "function(_,
|
|
169
|
+
"doc": "function(_, time)",
|
|
172
170
|
"types": [
|
|
173
|
-
"
|
|
174
|
-
]
|
|
175
|
-
"is_optional": "False"
|
|
171
|
+
"function"
|
|
172
|
+
]
|
|
176
173
|
},
|
|
177
174
|
{
|
|
178
175
|
"name": "on_failure",
|
|
179
176
|
"doc": "function(_, error)",
|
|
180
177
|
"types": [
|
|
181
|
-
"
|
|
182
|
-
]
|
|
183
|
-
"is_optional": "False"
|
|
178
|
+
"function"
|
|
179
|
+
]
|
|
184
180
|
}
|
|
185
181
|
],
|
|
186
182
|
"returnvalues": []
|
|
187
183
|
},
|
|
188
184
|
{
|
|
189
185
|
"type": "FUNCTION",
|
|
190
|
-
"name": "
|
|
191
|
-
"
|
|
192
|
-
"description": "Hide the currently displayed banner ad when it is no longer needed.",
|
|
193
|
-
"parameters": [],
|
|
194
|
-
"returnvalues": []
|
|
195
|
-
},
|
|
196
|
-
{
|
|
197
|
-
"type": "FUNCTION",
|
|
198
|
-
"name": "advertisement.interstitial_state",
|
|
199
|
-
"brief": "Track the state of the interstitial ad to manage ad display and user experience.",
|
|
200
|
-
"description": "Track the state of the interstitial ad to manage ad display and user experience.",
|
|
201
|
-
"parameters": [],
|
|
202
|
-
"returnvalues": []
|
|
203
|
-
},
|
|
204
|
-
{
|
|
205
|
-
"type": "FUNCTION",
|
|
206
|
-
"name": "advertisement.is_banner_supported",
|
|
207
|
-
"brief": "Check if the platform supports displaying banner ads. Use this to determine if you can include banner advertisements in your game.",
|
|
208
|
-
"description": "Check if the platform supports displaying banner ads. Use this to determine if you can include banner advertisements in your game.",
|
|
209
|
-
"parameters": [],
|
|
210
|
-
"returnvalues": [
|
|
211
|
-
{
|
|
212
|
-
"name": "",
|
|
213
|
-
"doc": "",
|
|
214
|
-
"types": [
|
|
215
|
-
"string"
|
|
216
|
-
]
|
|
217
|
-
}
|
|
218
|
-
]
|
|
219
|
-
},
|
|
220
|
-
{
|
|
221
|
-
"type": "FUNCTION",
|
|
222
|
-
"name": "advertisement.is_interstitial_supported",
|
|
223
|
-
"brief": "Check if the platform supports displaying interstitial ads. Use this to determine if you can include interstitial advertisements in your game.",
|
|
224
|
-
"description": "Check if the platform supports displaying interstitial ads. Use this to determine if you can include interstitial advertisements in your game.",
|
|
186
|
+
"name": "bridge.platform.is_audio_enabled",
|
|
187
|
+
"description": "Check if the audio is enabled on the platform.",
|
|
225
188
|
"parameters": [],
|
|
226
189
|
"returnvalues": [
|
|
227
190
|
{
|
|
228
|
-
"name": "",
|
|
191
|
+
"name": "result",
|
|
229
192
|
"doc": "",
|
|
230
193
|
"types": [
|
|
231
|
-
"
|
|
194
|
+
"boolean"
|
|
232
195
|
]
|
|
233
196
|
}
|
|
234
197
|
]
|
|
235
198
|
},
|
|
236
199
|
{
|
|
237
200
|
"type": "FUNCTION",
|
|
238
|
-
"name": "
|
|
239
|
-
"
|
|
240
|
-
"description": "Check if the platform supports displaying rewarded ads. Use this to determine if you can include rewarded advertisements in your game.",
|
|
201
|
+
"name": "bridge.platform.is_external_calls_supported",
|
|
202
|
+
"description": "Check if external calls are supported on the platform.",
|
|
241
203
|
"parameters": [],
|
|
242
204
|
"returnvalues": [
|
|
243
205
|
{
|
|
244
|
-
"name": "",
|
|
206
|
+
"name": "result",
|
|
245
207
|
"doc": "",
|
|
246
208
|
"types": [
|
|
247
|
-
"
|
|
209
|
+
"boolean"
|
|
248
210
|
]
|
|
249
211
|
}
|
|
250
212
|
]
|
|
251
213
|
},
|
|
252
214
|
{
|
|
253
215
|
"type": "FUNCTION",
|
|
254
|
-
"name": "
|
|
255
|
-
"
|
|
256
|
-
"description": "Minimum time interval between interstitial ad displays to comply with platform requirements and improve user experience.",
|
|
216
|
+
"name": "bridge.platform.is_external_links_allowed",
|
|
217
|
+
"description": "Check if external links are allowed on the platform.",
|
|
257
218
|
"parameters": [],
|
|
258
219
|
"returnvalues": [
|
|
259
220
|
{
|
|
260
|
-
"name": "",
|
|
221
|
+
"name": "result",
|
|
261
222
|
"doc": "",
|
|
262
223
|
"types": [
|
|
263
|
-
"
|
|
224
|
+
"boolean"
|
|
264
225
|
]
|
|
265
226
|
}
|
|
266
227
|
]
|
|
267
228
|
},
|
|
268
229
|
{
|
|
269
230
|
"type": "FUNCTION",
|
|
270
|
-
"name": "
|
|
271
|
-
"
|
|
272
|
-
"description": "State changed events.",
|
|
231
|
+
"name": "bridge.cross_promo.get_games",
|
|
232
|
+
"description": "Get the cross-promo games list. Resolves to an empty array when unsupported. Each game has the shape { id, name, url, icon_url, cover_url, payload }.",
|
|
273
233
|
"parameters": [
|
|
274
234
|
{
|
|
275
|
-
"name": "
|
|
276
|
-
"doc": "",
|
|
235
|
+
"name": "on_success",
|
|
236
|
+
"doc": "function(_, games)",
|
|
277
237
|
"types": [
|
|
278
|
-
"
|
|
279
|
-
]
|
|
280
|
-
"is_optional": "False"
|
|
238
|
+
"function"
|
|
239
|
+
]
|
|
281
240
|
},
|
|
282
241
|
{
|
|
283
|
-
"name": "
|
|
284
|
-
"doc": "function(_,
|
|
242
|
+
"name": "on_failure",
|
|
243
|
+
"doc": "function(_, error)",
|
|
285
244
|
"types": [
|
|
286
|
-
"
|
|
287
|
-
]
|
|
288
|
-
"is_optional": "False"
|
|
245
|
+
"function"
|
|
246
|
+
]
|
|
289
247
|
}
|
|
290
248
|
],
|
|
291
249
|
"returnvalues": []
|
|
292
250
|
},
|
|
293
251
|
{
|
|
294
252
|
"type": "FUNCTION",
|
|
295
|
-
"name": "
|
|
296
|
-
"
|
|
297
|
-
"description": "Monitor the placement of the rewarded ad to manage the reward process.",
|
|
253
|
+
"name": "bridge.cross_promo.show",
|
|
254
|
+
"description": "Show the built-in cross-promo HTML overlay.",
|
|
298
255
|
"parameters": [],
|
|
299
256
|
"returnvalues": []
|
|
300
257
|
},
|
|
301
258
|
{
|
|
302
259
|
"type": "FUNCTION",
|
|
303
|
-
"name": "
|
|
304
|
-
"
|
|
305
|
-
"description": "Monitor the state of the rewarded ad (loading, opened, closed, rewarded, failed) to manage the reward process.",
|
|
260
|
+
"name": "bridge.cross_promo.hide",
|
|
261
|
+
"description": "Hide the built-in cross-promo HTML overlay.",
|
|
306
262
|
"parameters": [],
|
|
307
263
|
"returnvalues": []
|
|
308
264
|
},
|
|
309
265
|
{
|
|
310
266
|
"type": "FUNCTION",
|
|
311
|
-
"name": "
|
|
312
|
-
"
|
|
313
|
-
"
|
|
267
|
+
"name": "bridge.cross_promo.is_visible",
|
|
268
|
+
"description": "Check whether the cross-promo overlay is currently shown.",
|
|
269
|
+
"parameters": [],
|
|
270
|
+
"returnvalues": [
|
|
271
|
+
{
|
|
272
|
+
"name": "result",
|
|
273
|
+
"doc": "",
|
|
274
|
+
"types": [
|
|
275
|
+
"boolean"
|
|
276
|
+
]
|
|
277
|
+
}
|
|
278
|
+
]
|
|
279
|
+
},
|
|
280
|
+
{
|
|
281
|
+
"type": "FUNCTION",
|
|
282
|
+
"name": "bridge.storage.get",
|
|
283
|
+
"description": "Retrieve stored data based on a key or multiple keys to restore player progress or settings.",
|
|
314
284
|
"parameters": [
|
|
315
285
|
{
|
|
316
|
-
"name": "
|
|
317
|
-
"doc": "
|
|
286
|
+
"name": "table_keys",
|
|
287
|
+
"doc": "",
|
|
318
288
|
"types": [
|
|
319
|
-
"
|
|
320
|
-
]
|
|
321
|
-
|
|
289
|
+
"table"
|
|
290
|
+
]
|
|
291
|
+
},
|
|
292
|
+
{
|
|
293
|
+
"name": "on_success",
|
|
294
|
+
"doc": "function(_, data)",
|
|
295
|
+
"types": [
|
|
296
|
+
"function"
|
|
297
|
+
]
|
|
298
|
+
},
|
|
299
|
+
{
|
|
300
|
+
"name": "on_failure",
|
|
301
|
+
"doc": "function(_, error)",
|
|
302
|
+
"types": [
|
|
303
|
+
"function"
|
|
304
|
+
]
|
|
322
305
|
}
|
|
323
306
|
],
|
|
324
307
|
"returnvalues": []
|
|
325
308
|
},
|
|
326
309
|
{
|
|
327
310
|
"type": "FUNCTION",
|
|
328
|
-
"name": "
|
|
329
|
-
"
|
|
330
|
-
"description": "Display a banner ad within your game to generate revenue through advertising.",
|
|
311
|
+
"name": "bridge.storage.set",
|
|
312
|
+
"description": "Save data to the storage with a key to retain player progress or settings.",
|
|
331
313
|
"parameters": [
|
|
332
314
|
{
|
|
333
|
-
"name": "
|
|
315
|
+
"name": "table_data",
|
|
334
316
|
"doc": "",
|
|
335
317
|
"types": [
|
|
336
|
-
"
|
|
337
|
-
]
|
|
338
|
-
"is_optional": "False"
|
|
318
|
+
"table"
|
|
319
|
+
]
|
|
339
320
|
},
|
|
340
321
|
{
|
|
341
|
-
"name": "
|
|
342
|
-
"doc": "",
|
|
322
|
+
"name": "on_success",
|
|
323
|
+
"doc": "function(_)",
|
|
343
324
|
"types": [
|
|
344
|
-
"
|
|
345
|
-
]
|
|
346
|
-
|
|
325
|
+
"function"
|
|
326
|
+
]
|
|
327
|
+
},
|
|
328
|
+
{
|
|
329
|
+
"name": "on_failure",
|
|
330
|
+
"doc": "function(_, error)",
|
|
331
|
+
"types": [
|
|
332
|
+
"function"
|
|
333
|
+
]
|
|
347
334
|
}
|
|
348
335
|
],
|
|
349
336
|
"returnvalues": []
|
|
350
337
|
},
|
|
351
338
|
{
|
|
352
339
|
"type": "FUNCTION",
|
|
353
|
-
"name": "
|
|
354
|
-
"
|
|
355
|
-
"description": "Display an interstitial ad at appropriate moments, such as during level transitions or game over screens.",
|
|
340
|
+
"name": "bridge.storage.delete",
|
|
341
|
+
"description": "Remove data from the storage by key to manage player data and settings effectively.",
|
|
356
342
|
"parameters": [
|
|
357
343
|
{
|
|
358
|
-
"name": "
|
|
344
|
+
"name": "table_keys",
|
|
359
345
|
"doc": "",
|
|
360
346
|
"types": [
|
|
361
|
-
"
|
|
362
|
-
]
|
|
363
|
-
|
|
347
|
+
"table"
|
|
348
|
+
]
|
|
349
|
+
},
|
|
350
|
+
{
|
|
351
|
+
"name": "on_success",
|
|
352
|
+
"doc": "function(_)",
|
|
353
|
+
"types": [
|
|
354
|
+
"function"
|
|
355
|
+
]
|
|
356
|
+
},
|
|
357
|
+
{
|
|
358
|
+
"name": "on_failure",
|
|
359
|
+
"doc": "function(_, error)",
|
|
360
|
+
"types": [
|
|
361
|
+
"function"
|
|
362
|
+
]
|
|
364
363
|
}
|
|
365
364
|
],
|
|
366
365
|
"returnvalues": []
|
|
367
366
|
},
|
|
368
367
|
{
|
|
369
368
|
"type": "FUNCTION",
|
|
370
|
-
"name": "advertisement.
|
|
371
|
-
"
|
|
372
|
-
"description": "Display a rewarded ad and provide incentives to players for watching the entire ad.",
|
|
369
|
+
"name": "bridge.advertisement.show_banner",
|
|
370
|
+
"description": "Display a banner ad within your game to generate revenue through advertising.",
|
|
373
371
|
"parameters": [
|
|
372
|
+
{
|
|
373
|
+
"name": "position",
|
|
374
|
+
"doc": "",
|
|
375
|
+
"types": [
|
|
376
|
+
"string"
|
|
377
|
+
]
|
|
378
|
+
},
|
|
374
379
|
{
|
|
375
380
|
"name": "placement",
|
|
376
381
|
"doc": "",
|
|
377
382
|
"types": [
|
|
378
383
|
"string"
|
|
379
|
-
]
|
|
380
|
-
"is_optional": "False"
|
|
384
|
+
]
|
|
381
385
|
}
|
|
382
386
|
],
|
|
383
387
|
"returnvalues": []
|
|
384
388
|
},
|
|
385
389
|
{
|
|
386
390
|
"type": "FUNCTION",
|
|
387
|
-
"name": "
|
|
388
|
-
"
|
|
389
|
-
"
|
|
391
|
+
"name": "bridge.advertisement.hide_banner",
|
|
392
|
+
"description": "Hide the currently displayed banner ad when it is no longer needed.",
|
|
393
|
+
"parameters": [],
|
|
394
|
+
"returnvalues": []
|
|
395
|
+
},
|
|
396
|
+
{
|
|
397
|
+
"type": "FUNCTION",
|
|
398
|
+
"name": "bridge.advertisement.banner_state",
|
|
399
|
+
"description": "Hide the currently displayed banner ad when it is no longer needed.",
|
|
400
|
+
"parameters": [],
|
|
401
|
+
"returnvalues": []
|
|
402
|
+
},
|
|
403
|
+
{
|
|
404
|
+
"type": "FUNCTION",
|
|
405
|
+
"name": "bridge.advertisement.is_banner_supported",
|
|
406
|
+
"description": "Check if the platform supports displaying banner ads. Use this to determine if you can include banner advertisements in your game.",
|
|
390
407
|
"parameters": [],
|
|
391
408
|
"returnvalues": [
|
|
392
409
|
{
|
|
393
|
-
"name": "",
|
|
410
|
+
"name": "result",
|
|
394
411
|
"doc": "",
|
|
395
412
|
"types": [
|
|
396
413
|
"string"
|
|
@@ -400,38 +417,27 @@
|
|
|
400
417
|
},
|
|
401
418
|
{
|
|
402
419
|
"type": "FUNCTION",
|
|
403
|
-
"name": "
|
|
404
|
-
"
|
|
405
|
-
"
|
|
406
|
-
"
|
|
420
|
+
"name": "bridge.advertisement.is_interstitial_supported",
|
|
421
|
+
"description": "Check if the platform supports displaying interstitial ads. Use this to determine if you can include interstitial advertisements in your game.",
|
|
422
|
+
"parameters": [],
|
|
423
|
+
"returnvalues": [
|
|
407
424
|
{
|
|
408
|
-
"name": "
|
|
425
|
+
"name": "result",
|
|
409
426
|
"doc": "",
|
|
410
427
|
"types": [
|
|
411
428
|
"string"
|
|
412
|
-
]
|
|
413
|
-
"is_optional": "False"
|
|
414
|
-
},
|
|
415
|
-
{
|
|
416
|
-
"name": "callback",
|
|
417
|
-
"doc": "function(_, state)",
|
|
418
|
-
"types": [
|
|
419
|
-
"(this: any, state: unknown) => void"
|
|
420
|
-
],
|
|
421
|
-
"is_optional": "False"
|
|
429
|
+
]
|
|
422
430
|
}
|
|
423
|
-
]
|
|
424
|
-
"returnvalues": []
|
|
431
|
+
]
|
|
425
432
|
},
|
|
426
433
|
{
|
|
427
434
|
"type": "FUNCTION",
|
|
428
|
-
"name": "
|
|
429
|
-
"
|
|
430
|
-
"description": "Returns the current visibility state of the game (the tab with the game).",
|
|
435
|
+
"name": "bridge.advertisement.is_rewarded_supported",
|
|
436
|
+
"description": "Check if the platform supports displaying rewarded ads. Use this to determine if you can include rewarded advertisements in your game.",
|
|
431
437
|
"parameters": [],
|
|
432
438
|
"returnvalues": [
|
|
433
439
|
{
|
|
434
|
-
"name": "",
|
|
440
|
+
"name": "result",
|
|
435
441
|
"doc": "",
|
|
436
442
|
"types": [
|
|
437
443
|
"string"
|
|
@@ -441,367 +447,211 @@
|
|
|
441
447
|
},
|
|
442
448
|
{
|
|
443
449
|
"type": "FUNCTION",
|
|
444
|
-
"name": "
|
|
445
|
-
"
|
|
446
|
-
"description": "Retrieve entries from the leaderboard, including the player's rank and score, to display a comprehensive leaderboard.",
|
|
450
|
+
"name": "bridge.advertisement.on",
|
|
451
|
+
"description": "State changed events.",
|
|
447
452
|
"parameters": [
|
|
448
453
|
{
|
|
449
|
-
"name": "
|
|
454
|
+
"name": "event_name",
|
|
450
455
|
"doc": "",
|
|
451
456
|
"types": [
|
|
452
457
|
"string"
|
|
453
|
-
]
|
|
454
|
-
"is_optional": "False"
|
|
455
|
-
},
|
|
456
|
-
{
|
|
457
|
-
"name": "on_success",
|
|
458
|
-
"doc": "function(_, entries)",
|
|
459
|
-
"types": [
|
|
460
|
-
"(this: any, entries: unknown) => void"
|
|
461
|
-
],
|
|
462
|
-
"is_optional": "False"
|
|
458
|
+
]
|
|
463
459
|
},
|
|
464
460
|
{
|
|
465
|
-
"name": "
|
|
466
|
-
"doc": "function(_,
|
|
461
|
+
"name": "callback",
|
|
462
|
+
"doc": "function(_, state)",
|
|
467
463
|
"types": [
|
|
468
|
-
"
|
|
469
|
-
]
|
|
470
|
-
"is_optional": "False"
|
|
464
|
+
"function"
|
|
465
|
+
]
|
|
471
466
|
}
|
|
472
467
|
],
|
|
473
468
|
"returnvalues": []
|
|
474
469
|
},
|
|
475
470
|
{
|
|
476
471
|
"type": "FUNCTION",
|
|
477
|
-
"name": "
|
|
478
|
-
"
|
|
479
|
-
"description": "Submit the player's score to the leaderboard to update their rank and position.",
|
|
472
|
+
"name": "bridge.advertisement.show_interstitial",
|
|
473
|
+
"description": "Display an interstitial ad at appropriate moments, such as during level transitions or game over screens.",
|
|
480
474
|
"parameters": [
|
|
481
475
|
{
|
|
482
|
-
"name": "
|
|
476
|
+
"name": "placement",
|
|
483
477
|
"doc": "",
|
|
484
478
|
"types": [
|
|
485
479
|
"string"
|
|
486
|
-
]
|
|
487
|
-
"is_optional": "False"
|
|
488
|
-
},
|
|
489
|
-
{
|
|
490
|
-
"name": "score",
|
|
491
|
-
"doc": "",
|
|
492
|
-
"types": [
|
|
493
|
-
"number"
|
|
494
|
-
],
|
|
495
|
-
"is_optional": "False"
|
|
496
|
-
},
|
|
497
|
-
{
|
|
498
|
-
"name": "on_success",
|
|
499
|
-
"doc": "function()",
|
|
500
|
-
"types": [
|
|
501
|
-
"(...args: any[]) => void"
|
|
502
|
-
],
|
|
503
|
-
"is_optional": "False"
|
|
504
|
-
},
|
|
505
|
-
{
|
|
506
|
-
"name": "on_failure",
|
|
507
|
-
"doc": "function(_, error)",
|
|
508
|
-
"types": [
|
|
509
|
-
"(this: any, error: unknown) => void"
|
|
510
|
-
],
|
|
511
|
-
"is_optional": "False"
|
|
480
|
+
]
|
|
512
481
|
}
|
|
513
482
|
],
|
|
514
483
|
"returnvalues": []
|
|
515
484
|
},
|
|
516
485
|
{
|
|
517
486
|
"type": "FUNCTION",
|
|
518
|
-
"name": "
|
|
519
|
-
"
|
|
520
|
-
"
|
|
521
|
-
"parameters": [
|
|
522
|
-
{
|
|
523
|
-
"name": "id",
|
|
524
|
-
"doc": "",
|
|
525
|
-
"types": [
|
|
526
|
-
"string"
|
|
527
|
-
],
|
|
528
|
-
"is_optional": "False"
|
|
529
|
-
},
|
|
530
|
-
{
|
|
531
|
-
"name": "on_success",
|
|
532
|
-
"doc": "function()",
|
|
533
|
-
"types": [
|
|
534
|
-
"(...args: any[]) => void"
|
|
535
|
-
],
|
|
536
|
-
"is_optional": "False"
|
|
537
|
-
},
|
|
538
|
-
{
|
|
539
|
-
"name": "on_failure",
|
|
540
|
-
"doc": "function(_, error)",
|
|
541
|
-
"types": [
|
|
542
|
-
"(this: any, error: unknown) => void"
|
|
543
|
-
],
|
|
544
|
-
"is_optional": "False"
|
|
545
|
-
}
|
|
546
|
-
],
|
|
487
|
+
"name": "bridge.advertisement.interstitial_state",
|
|
488
|
+
"description": "Track the state of the interstitial ad to manage ad display and user experience.",
|
|
489
|
+
"parameters": [],
|
|
547
490
|
"returnvalues": []
|
|
548
491
|
},
|
|
549
492
|
{
|
|
550
493
|
"type": "FUNCTION",
|
|
551
|
-
"name": "
|
|
552
|
-
"
|
|
553
|
-
"description": "Check the leaderboards type on the platform.",
|
|
494
|
+
"name": "bridge.advertisement.minimum_delay_between_interstitial",
|
|
495
|
+
"description": "Minimum time interval between interstitial ad displays to comply with platform requirements and improve user experience.",
|
|
554
496
|
"parameters": [],
|
|
555
497
|
"returnvalues": [
|
|
556
498
|
{
|
|
557
|
-
"name": "",
|
|
499
|
+
"name": "result",
|
|
558
500
|
"doc": "",
|
|
559
501
|
"types": [
|
|
560
|
-
"
|
|
502
|
+
"number"
|
|
561
503
|
]
|
|
562
504
|
}
|
|
563
505
|
]
|
|
564
506
|
},
|
|
565
507
|
{
|
|
566
508
|
"type": "FUNCTION",
|
|
567
|
-
"name": "
|
|
568
|
-
"
|
|
569
|
-
"description": "Consume purchased items, such as in-game currency, once they are used, to manage inventory and player progression.",
|
|
509
|
+
"name": "bridge.advertisement.set_minimum_delay_between_interstitial",
|
|
510
|
+
"description": "Set the minimum time interval between interstitial ad displays to comply with platform requirements and improve user experience.",
|
|
570
511
|
"parameters": [
|
|
571
512
|
{
|
|
572
|
-
"name": "
|
|
573
|
-
"doc": "",
|
|
574
|
-
"types": [
|
|
575
|
-
"string"
|
|
576
|
-
],
|
|
577
|
-
"is_optional": "False"
|
|
578
|
-
},
|
|
579
|
-
{
|
|
580
|
-
"name": "on_success",
|
|
581
|
-
"doc": "function(_, purchase)",
|
|
582
|
-
"types": [
|
|
583
|
-
"(this: any, purchase: unknown) => void"
|
|
584
|
-
],
|
|
585
|
-
"is_optional": "False"
|
|
586
|
-
},
|
|
587
|
-
{
|
|
588
|
-
"name": "on_failure",
|
|
589
|
-
"doc": "function(_, error)",
|
|
513
|
+
"name": "delay",
|
|
514
|
+
"doc": "60 from default",
|
|
590
515
|
"types": [
|
|
591
|
-
"
|
|
592
|
-
]
|
|
593
|
-
"is_optional": "False"
|
|
516
|
+
"number"
|
|
517
|
+
]
|
|
594
518
|
}
|
|
595
519
|
],
|
|
596
520
|
"returnvalues": []
|
|
597
521
|
},
|
|
598
522
|
{
|
|
599
523
|
"type": "FUNCTION",
|
|
600
|
-
"name": "
|
|
601
|
-
"
|
|
602
|
-
"
|
|
603
|
-
"parameters": [
|
|
604
|
-
{
|
|
605
|
-
"name": "on_success",
|
|
606
|
-
"doc": "function(_, catalogItems)",
|
|
607
|
-
"types": [
|
|
608
|
-
"(this: any, catalogItems: unknown) => void"
|
|
609
|
-
],
|
|
610
|
-
"is_optional": "False"
|
|
611
|
-
},
|
|
612
|
-
{
|
|
613
|
-
"name": "on_failure",
|
|
614
|
-
"doc": "function(_, error)",
|
|
615
|
-
"types": [
|
|
616
|
-
"(this: any, error: unknown) => void"
|
|
617
|
-
],
|
|
618
|
-
"is_optional": "False"
|
|
619
|
-
}
|
|
620
|
-
],
|
|
524
|
+
"name": "bridge.advertisement.rewarded_state",
|
|
525
|
+
"description": "Monitor the state of the rewarded ad (loading, opened, closed, rewarded, failed) to manage the reward process.",
|
|
526
|
+
"parameters": [],
|
|
621
527
|
"returnvalues": []
|
|
622
528
|
},
|
|
623
529
|
{
|
|
624
530
|
"type": "FUNCTION",
|
|
625
|
-
"name": "
|
|
626
|
-
"
|
|
627
|
-
"
|
|
531
|
+
"name": "bridge.advertisement.rewarded_placement",
|
|
532
|
+
"description": "Monitor the placement of the rewarded ad to manage the reward process.",
|
|
533
|
+
"parameters": [],
|
|
534
|
+
"returnvalues": []
|
|
535
|
+
},
|
|
536
|
+
{
|
|
537
|
+
"type": "FUNCTION",
|
|
538
|
+
"name": "bridge.advertisement.show_rewarded",
|
|
539
|
+
"description": "Display a rewarded ad and provide incentives to players for watching the entire ad.",
|
|
628
540
|
"parameters": [
|
|
629
541
|
{
|
|
630
|
-
"name": "
|
|
631
|
-
"doc": "
|
|
632
|
-
"types": [
|
|
633
|
-
"(this: any, purchases: unknown) => void"
|
|
634
|
-
],
|
|
635
|
-
"is_optional": "False"
|
|
636
|
-
},
|
|
637
|
-
{
|
|
638
|
-
"name": "on_failure",
|
|
639
|
-
"doc": "function(_, error)",
|
|
542
|
+
"name": "placement",
|
|
543
|
+
"doc": "",
|
|
640
544
|
"types": [
|
|
641
|
-
"
|
|
642
|
-
]
|
|
643
|
-
"is_optional": "False"
|
|
545
|
+
"string"
|
|
546
|
+
]
|
|
644
547
|
}
|
|
645
548
|
],
|
|
646
549
|
"returnvalues": []
|
|
647
550
|
},
|
|
648
551
|
{
|
|
649
552
|
"type": "FUNCTION",
|
|
650
|
-
"name": "
|
|
651
|
-
"
|
|
652
|
-
"description": "Check if in-game purchases are supported to offer items or upgrades within the game.",
|
|
553
|
+
"name": "bridge.advertisement.is_advanced_banners_supported",
|
|
554
|
+
"description": "Check if the platform supports displaying advanced banner ads.",
|
|
653
555
|
"parameters": [],
|
|
654
556
|
"returnvalues": [
|
|
655
557
|
{
|
|
656
|
-
"name": "",
|
|
558
|
+
"name": "result",
|
|
657
559
|
"doc": "",
|
|
658
560
|
"types": [
|
|
659
|
-
"
|
|
561
|
+
"string"
|
|
660
562
|
]
|
|
661
563
|
}
|
|
662
564
|
]
|
|
663
565
|
},
|
|
664
566
|
{
|
|
665
567
|
"type": "FUNCTION",
|
|
666
|
-
"name": "
|
|
667
|
-
"
|
|
668
|
-
"
|
|
568
|
+
"name": "bridge.advertisement.advanced_banners_state",
|
|
569
|
+
"description": "Track the state of the advanced banners to manage ad display and user experience.",
|
|
570
|
+
"parameters": [],
|
|
571
|
+
"returnvalues": []
|
|
572
|
+
},
|
|
573
|
+
{
|
|
574
|
+
"type": "FUNCTION",
|
|
575
|
+
"name": "bridge.advertisement.show_advanced_banners",
|
|
576
|
+
"description": "Display advanced banners at appropriate moments of the game.",
|
|
669
577
|
"parameters": [
|
|
670
578
|
{
|
|
671
|
-
"name": "
|
|
579
|
+
"name": "placement",
|
|
672
580
|
"doc": "",
|
|
673
581
|
"types": [
|
|
674
582
|
"string"
|
|
675
|
-
]
|
|
676
|
-
"is_optional": "False"
|
|
677
|
-
},
|
|
678
|
-
{
|
|
679
|
-
"name": "on_success",
|
|
680
|
-
"doc": "function(_, purchase)",
|
|
681
|
-
"types": [
|
|
682
|
-
"(this: any, purchase: unknown) => void"
|
|
683
|
-
],
|
|
684
|
-
"is_optional": "False"
|
|
685
|
-
},
|
|
686
|
-
{
|
|
687
|
-
"name": "on_failure",
|
|
688
|
-
"doc": "function(_, error)",
|
|
689
|
-
"types": [
|
|
690
|
-
"(this: any, error: unknown) => void"
|
|
691
|
-
],
|
|
692
|
-
"is_optional": "False"
|
|
583
|
+
]
|
|
693
584
|
}
|
|
694
585
|
],
|
|
695
586
|
"returnvalues": []
|
|
696
587
|
},
|
|
697
588
|
{
|
|
698
589
|
"type": "FUNCTION",
|
|
699
|
-
"name": "
|
|
700
|
-
"
|
|
701
|
-
"
|
|
702
|
-
"parameters": [
|
|
703
|
-
{
|
|
704
|
-
"name": "on_success",
|
|
705
|
-
"doc": "function(_, data)",
|
|
706
|
-
"types": [
|
|
707
|
-
"(this: any, data: unknown) => void"
|
|
708
|
-
],
|
|
709
|
-
"is_optional": "False"
|
|
710
|
-
},
|
|
711
|
-
{
|
|
712
|
-
"name": "on_failure",
|
|
713
|
-
"doc": "function(_, error)",
|
|
714
|
-
"types": [
|
|
715
|
-
"(this: any, error: unknown) => void"
|
|
716
|
-
],
|
|
717
|
-
"is_optional": "False"
|
|
718
|
-
}
|
|
719
|
-
],
|
|
590
|
+
"name": "bridge.advertisement.hide_advanced_banners",
|
|
591
|
+
"description": "Hide the currently displayed advanced banners when they are no longer needed.",
|
|
592
|
+
"parameters": [],
|
|
720
593
|
"returnvalues": []
|
|
721
594
|
},
|
|
722
595
|
{
|
|
723
596
|
"type": "FUNCTION",
|
|
724
|
-
"name": "
|
|
725
|
-
"
|
|
726
|
-
"description": "Get game by ID on the platform.",
|
|
597
|
+
"name": "bridge.advertisement.check_ad_block",
|
|
598
|
+
"description": "Check if the ad blocker is enabled.",
|
|
727
599
|
"parameters": [
|
|
728
|
-
{
|
|
729
|
-
"name": "options",
|
|
730
|
-
"doc": "",
|
|
731
|
-
"types": [
|
|
732
|
-
"object"
|
|
733
|
-
],
|
|
734
|
-
"is_optional": "False"
|
|
735
|
-
},
|
|
736
600
|
{
|
|
737
601
|
"name": "on_success",
|
|
738
|
-
"doc": "function(_,
|
|
602
|
+
"doc": "function(_, bool)",
|
|
739
603
|
"types": [
|
|
740
|
-
"
|
|
741
|
-
]
|
|
742
|
-
"is_optional": "False"
|
|
604
|
+
"function"
|
|
605
|
+
]
|
|
743
606
|
},
|
|
744
607
|
{
|
|
745
608
|
"name": "on_failure",
|
|
746
609
|
"doc": "function(_, error)",
|
|
747
610
|
"types": [
|
|
748
|
-
"
|
|
749
|
-
]
|
|
750
|
-
"is_optional": "False"
|
|
611
|
+
"function"
|
|
612
|
+
]
|
|
751
613
|
}
|
|
752
614
|
],
|
|
753
615
|
"returnvalues": []
|
|
754
616
|
},
|
|
755
617
|
{
|
|
756
618
|
"type": "FUNCTION",
|
|
757
|
-
"name": "
|
|
758
|
-
"
|
|
759
|
-
"
|
|
760
|
-
"
|
|
761
|
-
{
|
|
762
|
-
"name": "on_success",
|
|
763
|
-
"doc": "function(_, time)",
|
|
764
|
-
"types": [
|
|
765
|
-
"(this: any, time: unknown) => void"
|
|
766
|
-
],
|
|
767
|
-
"is_optional": "False"
|
|
768
|
-
},
|
|
619
|
+
"name": "bridge.device.type",
|
|
620
|
+
"description": "Determine the type of device (mobile, tablet, desktop, tv) the game is being played on to adjust the game`s interface and performance settings.",
|
|
621
|
+
"parameters": [],
|
|
622
|
+
"returnvalues": [
|
|
769
623
|
{
|
|
770
|
-
"name": "
|
|
771
|
-
"doc": "
|
|
624
|
+
"name": "result",
|
|
625
|
+
"doc": "",
|
|
772
626
|
"types": [
|
|
773
|
-
"
|
|
774
|
-
]
|
|
775
|
-
"is_optional": "False"
|
|
627
|
+
"string"
|
|
628
|
+
]
|
|
776
629
|
}
|
|
777
|
-
]
|
|
778
|
-
"returnvalues": []
|
|
630
|
+
]
|
|
779
631
|
},
|
|
780
632
|
{
|
|
781
633
|
"type": "FUNCTION",
|
|
782
|
-
"name": "
|
|
783
|
-
"
|
|
784
|
-
"description": "Identify the platform on which the game is currently running to customize features and settings accordingly.",
|
|
634
|
+
"name": "bridge.player.is_authorization_supported",
|
|
635
|
+
"description": "Check if the platform supports player authorization to enable features that require user authentication, such as saving game progress or accessing social features.",
|
|
785
636
|
"parameters": [],
|
|
786
637
|
"returnvalues": [
|
|
787
638
|
{
|
|
788
|
-
"name": "",
|
|
639
|
+
"name": "result",
|
|
789
640
|
"doc": "",
|
|
790
641
|
"types": [
|
|
791
|
-
"
|
|
642
|
+
"boolean"
|
|
792
643
|
]
|
|
793
644
|
}
|
|
794
645
|
]
|
|
795
646
|
},
|
|
796
647
|
{
|
|
797
648
|
"type": "FUNCTION",
|
|
798
|
-
"name": "
|
|
799
|
-
"
|
|
800
|
-
"description": "Check if the audio is enabled on the platform.",
|
|
649
|
+
"name": "bridge.player.is_authorized",
|
|
650
|
+
"description": "Verify if the player is currently authorized on the platform. This allows you to enable personalized features, such as saving high scores or providing user-specific content.",
|
|
801
651
|
"parameters": [],
|
|
802
652
|
"returnvalues": [
|
|
803
653
|
{
|
|
804
|
-
"name": "",
|
|
654
|
+
"name": "result",
|
|
805
655
|
"doc": "",
|
|
806
656
|
"types": [
|
|
807
657
|
"boolean"
|
|
@@ -811,13 +661,12 @@
|
|
|
811
661
|
},
|
|
812
662
|
{
|
|
813
663
|
"type": "FUNCTION",
|
|
814
|
-
"name": "
|
|
815
|
-
"
|
|
816
|
-
"description": "Verify if the get_all_games is supported on the platform to ensure compatibility.",
|
|
664
|
+
"name": "bridge.player.is_guest",
|
|
665
|
+
"description": "Check if the player is unauthorized or running as a guest.",
|
|
817
666
|
"parameters": [],
|
|
818
667
|
"returnvalues": [
|
|
819
668
|
{
|
|
820
|
-
"name": "",
|
|
669
|
+
"name": "result",
|
|
821
670
|
"doc": "",
|
|
822
671
|
"types": [
|
|
823
672
|
"boolean"
|
|
@@ -827,297 +676,277 @@
|
|
|
827
676
|
},
|
|
828
677
|
{
|
|
829
678
|
"type": "FUNCTION",
|
|
830
|
-
"name": "
|
|
831
|
-
"
|
|
832
|
-
"description": "Verify if the get_game_by_id is supported on the platform to ensure compatibility.",
|
|
679
|
+
"name": "bridge.player.id",
|
|
680
|
+
"description": "Get the player’s unique ID on the platform to manage user-specific data and settings. Use this ID to track player progress, achievements, and purchases.",
|
|
833
681
|
"parameters": [],
|
|
834
682
|
"returnvalues": [
|
|
835
683
|
{
|
|
836
|
-
"name": "",
|
|
684
|
+
"name": "result",
|
|
837
685
|
"doc": "",
|
|
838
686
|
"types": [
|
|
839
|
-
"
|
|
687
|
+
"string | nil"
|
|
840
688
|
]
|
|
841
689
|
}
|
|
842
690
|
]
|
|
843
691
|
},
|
|
844
692
|
{
|
|
845
693
|
"type": "FUNCTION",
|
|
846
|
-
"name": "
|
|
847
|
-
"
|
|
848
|
-
"description": "Get the language set by the user on the platform or the browser language if not provided by the platform, to localize game content.",
|
|
694
|
+
"name": "bridge.player.name",
|
|
695
|
+
"description": "Retrieve the player's name to personalize the game experience. Display the name in leaderboards, friend lists, or when sending notifications and messages.",
|
|
849
696
|
"parameters": [],
|
|
850
697
|
"returnvalues": [
|
|
851
698
|
{
|
|
852
|
-
"name": "",
|
|
699
|
+
"name": "result",
|
|
853
700
|
"doc": "",
|
|
854
701
|
"types": [
|
|
855
|
-
"string"
|
|
702
|
+
"string | nil"
|
|
856
703
|
]
|
|
857
704
|
}
|
|
858
705
|
]
|
|
859
706
|
},
|
|
860
707
|
{
|
|
861
708
|
"type": "FUNCTION",
|
|
862
|
-
"name": "
|
|
863
|
-
"
|
|
864
|
-
"
|
|
865
|
-
"
|
|
709
|
+
"name": "bridge.player.extra",
|
|
710
|
+
"description": "Get the extra information about player.",
|
|
711
|
+
"parameters": [],
|
|
712
|
+
"returnvalues": [
|
|
866
713
|
{
|
|
867
|
-
"name": "
|
|
714
|
+
"name": "result",
|
|
868
715
|
"doc": "",
|
|
869
716
|
"types": [
|
|
870
|
-
"
|
|
871
|
-
]
|
|
872
|
-
"is_optional": "False"
|
|
873
|
-
},
|
|
874
|
-
{
|
|
875
|
-
"name": "callback",
|
|
876
|
-
"doc": "function(_, state)",
|
|
877
|
-
"types": [
|
|
878
|
-
"(this: any, state: unknown) => void"
|
|
879
|
-
],
|
|
880
|
-
"is_optional": "False"
|
|
717
|
+
"table"
|
|
718
|
+
]
|
|
881
719
|
}
|
|
882
|
-
]
|
|
883
|
-
"returnvalues": []
|
|
720
|
+
]
|
|
884
721
|
},
|
|
885
722
|
{
|
|
886
723
|
"type": "FUNCTION",
|
|
887
|
-
"name": "
|
|
888
|
-
"
|
|
889
|
-
"description": "Embed auxiliary information into the game URL to pass additional data or settings when launching the game.",
|
|
724
|
+
"name": "bridge.player.photos",
|
|
725
|
+
"description": "Get the count of player avatars available. Use this to manage and display user profile images effectively, such as showing the avatar in multiplayer lobbies or profile screens.",
|
|
890
726
|
"parameters": [],
|
|
891
727
|
"returnvalues": [
|
|
892
728
|
{
|
|
893
|
-
"name": "",
|
|
729
|
+
"name": "result",
|
|
894
730
|
"doc": "",
|
|
895
731
|
"types": [
|
|
896
|
-
"
|
|
732
|
+
"table"
|
|
897
733
|
]
|
|
898
734
|
}
|
|
899
735
|
]
|
|
900
736
|
},
|
|
901
737
|
{
|
|
902
738
|
"type": "FUNCTION",
|
|
903
|
-
"name": "
|
|
904
|
-
"
|
|
905
|
-
"description": "Send predefined messages to the platform to trigger specific actions or events, such as signaling that the game is ready.",
|
|
739
|
+
"name": "bridge.player.authorize",
|
|
740
|
+
"description": "Authorize the player on the platform to access protected features and personalize the game experience. For example, prompting the player to log in to save their progress or unlock social sharing features.",
|
|
906
741
|
"parameters": [
|
|
907
742
|
{
|
|
908
|
-
"name": "
|
|
909
|
-
"doc": "
|
|
743
|
+
"name": "options",
|
|
744
|
+
"doc": "",
|
|
910
745
|
"types": [
|
|
911
|
-
"
|
|
912
|
-
]
|
|
913
|
-
"is_optional": "False"
|
|
746
|
+
"table"
|
|
747
|
+
]
|
|
914
748
|
},
|
|
915
749
|
{
|
|
916
750
|
"name": "on_success",
|
|
917
|
-
"doc": "",
|
|
751
|
+
"doc": "function()",
|
|
918
752
|
"types": [
|
|
919
|
-
"
|
|
920
|
-
]
|
|
921
|
-
"is_optional": "False"
|
|
753
|
+
"function"
|
|
754
|
+
]
|
|
922
755
|
},
|
|
923
756
|
{
|
|
924
757
|
"name": "on_failure",
|
|
925
|
-
"doc": "",
|
|
758
|
+
"doc": "function(_, error)",
|
|
926
759
|
"types": [
|
|
927
|
-
"
|
|
928
|
-
]
|
|
929
|
-
"is_optional": "False"
|
|
760
|
+
"function"
|
|
761
|
+
]
|
|
930
762
|
}
|
|
931
763
|
],
|
|
932
764
|
"returnvalues": []
|
|
933
765
|
},
|
|
934
766
|
{
|
|
935
767
|
"type": "FUNCTION",
|
|
936
|
-
"name": "
|
|
937
|
-
"
|
|
938
|
-
"description": "Retrieve the top-level domain of the platform to handle domain-specific configurations and behavior.",
|
|
768
|
+
"name": "bridge.social.is_share_supported",
|
|
769
|
+
"description": "Check if the share functionality is supported on the platform.",
|
|
939
770
|
"parameters": [],
|
|
940
771
|
"returnvalues": [
|
|
941
772
|
{
|
|
942
|
-
"name": "",
|
|
773
|
+
"name": "result",
|
|
943
774
|
"doc": "",
|
|
944
775
|
"types": [
|
|
945
|
-
"
|
|
776
|
+
"boolean"
|
|
946
777
|
]
|
|
947
778
|
}
|
|
948
779
|
]
|
|
949
780
|
},
|
|
950
781
|
{
|
|
951
782
|
"type": "FUNCTION",
|
|
952
|
-
"name": "
|
|
953
|
-
"
|
|
954
|
-
"description": "Authorize the player on the platform to access protected features and personalize the game experience. For example, prompting the player to log in to save their progress or unlock social sharing features.",
|
|
783
|
+
"name": "bridge.social.share",
|
|
784
|
+
"description": "Use this to allow players to share game content or achievements on social media platforms.",
|
|
955
785
|
"parameters": [
|
|
956
786
|
{
|
|
957
787
|
"name": "options",
|
|
958
788
|
"doc": "",
|
|
959
789
|
"types": [
|
|
960
|
-
"
|
|
961
|
-
]
|
|
962
|
-
"is_optional": "False"
|
|
790
|
+
"table"
|
|
791
|
+
]
|
|
963
792
|
},
|
|
964
793
|
{
|
|
965
794
|
"name": "on_success",
|
|
966
|
-
"doc": "function()",
|
|
795
|
+
"doc": "function(_)",
|
|
967
796
|
"types": [
|
|
968
|
-
"
|
|
969
|
-
]
|
|
970
|
-
"is_optional": "False"
|
|
797
|
+
"function"
|
|
798
|
+
]
|
|
971
799
|
},
|
|
972
800
|
{
|
|
973
801
|
"name": "on_failure",
|
|
974
|
-
"doc": "function(_
|
|
802
|
+
"doc": "function(_)",
|
|
975
803
|
"types": [
|
|
976
|
-
"
|
|
977
|
-
]
|
|
978
|
-
"is_optional": "False"
|
|
804
|
+
"function"
|
|
805
|
+
]
|
|
979
806
|
}
|
|
980
807
|
],
|
|
981
808
|
"returnvalues": []
|
|
982
809
|
},
|
|
983
810
|
{
|
|
984
811
|
"type": "FUNCTION",
|
|
985
|
-
"name": "
|
|
986
|
-
"
|
|
987
|
-
"description": "Get the extra information about player.",
|
|
812
|
+
"name": "bridge.social.is_join_community_supported",
|
|
813
|
+
"description": "Check if the join community functionality is supported on the platform.",
|
|
988
814
|
"parameters": [],
|
|
989
815
|
"returnvalues": [
|
|
990
816
|
{
|
|
991
|
-
"name": "",
|
|
817
|
+
"name": "result",
|
|
992
818
|
"doc": "",
|
|
993
819
|
"types": [
|
|
994
|
-
"
|
|
820
|
+
"boolean"
|
|
995
821
|
]
|
|
996
822
|
}
|
|
997
823
|
]
|
|
998
824
|
},
|
|
999
825
|
{
|
|
1000
826
|
"type": "FUNCTION",
|
|
1001
|
-
"name": "
|
|
1002
|
-
"
|
|
1003
|
-
"
|
|
1004
|
-
"parameters": [],
|
|
1005
|
-
"returnvalues": [
|
|
827
|
+
"name": "bridge.social.join_community",
|
|
828
|
+
"description": "Use this to allow players to share game content or achievements on social media platforms.",
|
|
829
|
+
"parameters": [
|
|
1006
830
|
{
|
|
1007
|
-
"name": "",
|
|
831
|
+
"name": "options",
|
|
1008
832
|
"doc": "",
|
|
1009
833
|
"types": [
|
|
1010
|
-
"
|
|
834
|
+
"table"
|
|
1011
835
|
]
|
|
1012
|
-
}
|
|
1013
|
-
]
|
|
1014
|
-
},
|
|
1015
|
-
{
|
|
1016
|
-
"type": "FUNCTION",
|
|
1017
|
-
"name": "player.is_authorization_supported",
|
|
1018
|
-
"brief": "Check if the platform supports player authorization to enable features that require user authentication, such as saving game progress or accessing social features.",
|
|
1019
|
-
"description": "Check if the platform supports player authorization to enable features that require user authentication, such as saving game progress or accessing social features.",
|
|
1020
|
-
"parameters": [],
|
|
1021
|
-
"returnvalues": [
|
|
836
|
+
},
|
|
1022
837
|
{
|
|
1023
|
-
"name": "",
|
|
1024
|
-
"doc": "",
|
|
838
|
+
"name": "on_success",
|
|
839
|
+
"doc": "function(_)",
|
|
1025
840
|
"types": [
|
|
1026
|
-
"
|
|
841
|
+
"function"
|
|
1027
842
|
]
|
|
1028
|
-
}
|
|
1029
|
-
]
|
|
1030
|
-
},
|
|
1031
|
-
{
|
|
1032
|
-
"type": "FUNCTION",
|
|
1033
|
-
"name": "player.is_authorized",
|
|
1034
|
-
"brief": "Verify if the player is currently authorized on the platform. This allows you to enable personalized features, such as saving high scores or providing user-specific content.",
|
|
1035
|
-
"description": "Verify if the player is currently authorized on the platform. This allows you to enable personalized features, such as saving high scores or providing user-specific content.",
|
|
1036
|
-
"parameters": [],
|
|
1037
|
-
"returnvalues": [
|
|
843
|
+
},
|
|
1038
844
|
{
|
|
1039
|
-
"name": "",
|
|
1040
|
-
"doc": "",
|
|
845
|
+
"name": "on_failure",
|
|
846
|
+
"doc": "function(_)",
|
|
1041
847
|
"types": [
|
|
1042
|
-
"
|
|
848
|
+
"function"
|
|
1043
849
|
]
|
|
1044
850
|
}
|
|
1045
|
-
]
|
|
851
|
+
],
|
|
852
|
+
"returnvalues": []
|
|
1046
853
|
},
|
|
1047
854
|
{
|
|
1048
855
|
"type": "FUNCTION",
|
|
1049
|
-
"name": "
|
|
1050
|
-
"
|
|
1051
|
-
"description": "Retrieve the player's name to personalize the game experience. Display the name in leaderboards, friend lists, or when sending notifications and messages.",
|
|
856
|
+
"name": "bridge.social.is_invite_friends_supported",
|
|
857
|
+
"description": "Check if the invite friends functionality is supported on the platform.",
|
|
1052
858
|
"parameters": [],
|
|
1053
859
|
"returnvalues": [
|
|
1054
860
|
{
|
|
1055
|
-
"name": "",
|
|
861
|
+
"name": "result",
|
|
1056
862
|
"doc": "",
|
|
1057
863
|
"types": [
|
|
1058
|
-
"
|
|
864
|
+
"boolean"
|
|
1059
865
|
]
|
|
1060
866
|
}
|
|
1061
867
|
]
|
|
1062
868
|
},
|
|
1063
869
|
{
|
|
1064
870
|
"type": "FUNCTION",
|
|
1065
|
-
"name": "
|
|
1066
|
-
"
|
|
1067
|
-
"
|
|
1068
|
-
"parameters": [],
|
|
1069
|
-
"returnvalues": [
|
|
871
|
+
"name": "bridge.social.invite_friends",
|
|
872
|
+
"description": "Allow players to invite their friends to play the game, helping to grow your player base organically.",
|
|
873
|
+
"parameters": [
|
|
1070
874
|
{
|
|
1071
|
-
"name": "",
|
|
875
|
+
"name": "options",
|
|
1072
876
|
"doc": "",
|
|
1073
877
|
"types": [
|
|
1074
|
-
"
|
|
878
|
+
"table"
|
|
1075
879
|
]
|
|
1076
|
-
}
|
|
880
|
+
},
|
|
881
|
+
{
|
|
882
|
+
"name": "on_success",
|
|
883
|
+
"doc": "function(_)",
|
|
884
|
+
"types": [
|
|
885
|
+
"function"
|
|
886
|
+
]
|
|
887
|
+
},
|
|
888
|
+
{
|
|
889
|
+
"name": "on_failure",
|
|
890
|
+
"doc": "function(_)",
|
|
891
|
+
"types": [
|
|
892
|
+
"function"
|
|
893
|
+
]
|
|
894
|
+
}
|
|
895
|
+
],
|
|
896
|
+
"returnvalues": []
|
|
897
|
+
},
|
|
898
|
+
{
|
|
899
|
+
"type": "FUNCTION",
|
|
900
|
+
"name": "bridge.social.is_create_post_supported",
|
|
901
|
+
"description": "Check if the create post functionality is supported on the platform.",
|
|
902
|
+
"parameters": [],
|
|
903
|
+
"returnvalues": [
|
|
904
|
+
{
|
|
905
|
+
"name": "result",
|
|
906
|
+
"doc": "",
|
|
907
|
+
"types": [
|
|
908
|
+
"boolean"
|
|
909
|
+
]
|
|
910
|
+
}
|
|
1077
911
|
]
|
|
1078
912
|
},
|
|
1079
913
|
{
|
|
1080
914
|
"type": "FUNCTION",
|
|
1081
|
-
"name": "
|
|
1082
|
-
"
|
|
1083
|
-
"description": "Encourage players to rate your game, providing valuable feedback and improving visibility.",
|
|
915
|
+
"name": "bridge.social.create_post",
|
|
916
|
+
"description": "Use this to let players create posts about their achievements or updates directly from the game.",
|
|
1084
917
|
"parameters": [
|
|
1085
918
|
{
|
|
1086
919
|
"name": "options",
|
|
1087
920
|
"doc": "",
|
|
1088
921
|
"types": [
|
|
1089
|
-
"
|
|
1090
|
-
]
|
|
1091
|
-
"is_optional": "False"
|
|
922
|
+
"table"
|
|
923
|
+
]
|
|
1092
924
|
},
|
|
1093
925
|
{
|
|
1094
926
|
"name": "on_success",
|
|
1095
|
-
"doc": "function(_
|
|
927
|
+
"doc": "function(_)",
|
|
1096
928
|
"types": [
|
|
1097
|
-
"
|
|
1098
|
-
]
|
|
1099
|
-
"is_optional": "False"
|
|
929
|
+
"function"
|
|
930
|
+
]
|
|
1100
931
|
},
|
|
1101
932
|
{
|
|
1102
933
|
"name": "on_failure",
|
|
1103
934
|
"doc": "function(_)",
|
|
1104
935
|
"types": [
|
|
1105
|
-
"
|
|
1106
|
-
]
|
|
1107
|
-
"is_optional": "False"
|
|
936
|
+
"function"
|
|
937
|
+
]
|
|
1108
938
|
}
|
|
1109
939
|
],
|
|
1110
940
|
"returnvalues": []
|
|
1111
941
|
},
|
|
1112
942
|
{
|
|
1113
943
|
"type": "FUNCTION",
|
|
1114
|
-
"name": "
|
|
1115
|
-
"
|
|
1116
|
-
"description": "Check if remote configuration is supported to manage game settings without releasing updates.",
|
|
944
|
+
"name": "bridge.social.is_add_to_favorites_supported",
|
|
945
|
+
"description": "Check if the add to favorites functionality is supported on the platform.",
|
|
1117
946
|
"parameters": [],
|
|
1118
947
|
"returnvalues": [
|
|
1119
948
|
{
|
|
1120
|
-
"name": "",
|
|
949
|
+
"name": "result",
|
|
1121
950
|
"doc": "",
|
|
1122
951
|
"types": [
|
|
1123
952
|
"boolean"
|
|
@@ -1127,348 +956,451 @@
|
|
|
1127
956
|
},
|
|
1128
957
|
{
|
|
1129
958
|
"type": "FUNCTION",
|
|
1130
|
-
"name": "social.add_to_favorites",
|
|
1131
|
-
"brief": "Allow players to bookmark your game for easy access in the future.",
|
|
959
|
+
"name": "bridge.social.add_to_favorites",
|
|
1132
960
|
"description": "Allow players to bookmark your game for easy access in the future.",
|
|
1133
961
|
"parameters": [
|
|
1134
962
|
{
|
|
1135
963
|
"name": "on_success",
|
|
1136
964
|
"doc": "function(_)",
|
|
1137
965
|
"types": [
|
|
1138
|
-
"
|
|
1139
|
-
]
|
|
1140
|
-
"is_optional": "False"
|
|
966
|
+
"function"
|
|
967
|
+
]
|
|
1141
968
|
},
|
|
1142
969
|
{
|
|
1143
970
|
"name": "on_failure",
|
|
1144
971
|
"doc": "function(_)",
|
|
1145
972
|
"types": [
|
|
1146
|
-
"
|
|
1147
|
-
]
|
|
1148
|
-
"is_optional": "False"
|
|
973
|
+
"function"
|
|
974
|
+
]
|
|
1149
975
|
}
|
|
1150
976
|
],
|
|
1151
977
|
"returnvalues": []
|
|
1152
978
|
},
|
|
1153
979
|
{
|
|
1154
980
|
"type": "FUNCTION",
|
|
1155
|
-
"name": "social.
|
|
1156
|
-
"
|
|
981
|
+
"name": "bridge.social.is_add_to_home_screen_supported",
|
|
982
|
+
"description": "Check if the add to home screen functionality is supported on the platform.",
|
|
983
|
+
"parameters": [],
|
|
984
|
+
"returnvalues": [
|
|
985
|
+
{
|
|
986
|
+
"name": "result",
|
|
987
|
+
"doc": "",
|
|
988
|
+
"types": [
|
|
989
|
+
"boolean"
|
|
990
|
+
]
|
|
991
|
+
}
|
|
992
|
+
]
|
|
993
|
+
},
|
|
994
|
+
{
|
|
995
|
+
"type": "FUNCTION",
|
|
996
|
+
"name": "bridge.social.add_to_home_screen",
|
|
1157
997
|
"description": "Enable players to add a shortcut to your game on their home screen for quick access.",
|
|
1158
998
|
"parameters": [
|
|
1159
999
|
{
|
|
1160
1000
|
"name": "on_success",
|
|
1161
1001
|
"doc": "function(_)",
|
|
1162
1002
|
"types": [
|
|
1163
|
-
"
|
|
1164
|
-
]
|
|
1165
|
-
"is_optional": "False"
|
|
1003
|
+
"function"
|
|
1004
|
+
]
|
|
1166
1005
|
},
|
|
1167
1006
|
{
|
|
1168
1007
|
"name": "on_failure",
|
|
1169
1008
|
"doc": "function(_)",
|
|
1170
1009
|
"types": [
|
|
1171
|
-
"
|
|
1172
|
-
]
|
|
1173
|
-
"is_optional": "False"
|
|
1010
|
+
"function"
|
|
1011
|
+
]
|
|
1174
1012
|
}
|
|
1175
1013
|
],
|
|
1176
1014
|
"returnvalues": []
|
|
1177
1015
|
},
|
|
1178
1016
|
{
|
|
1179
1017
|
"type": "FUNCTION",
|
|
1180
|
-
"name": "social.
|
|
1181
|
-
"
|
|
1182
|
-
"
|
|
1183
|
-
"
|
|
1018
|
+
"name": "bridge.social.is_rate_supported",
|
|
1019
|
+
"description": "Check if the rate game functionality is supported on the platform.",
|
|
1020
|
+
"parameters": [],
|
|
1021
|
+
"returnvalues": [
|
|
1184
1022
|
{
|
|
1185
|
-
"name": "
|
|
1023
|
+
"name": "result",
|
|
1186
1024
|
"doc": "",
|
|
1187
1025
|
"types": [
|
|
1188
|
-
"
|
|
1189
|
-
]
|
|
1190
|
-
|
|
1191
|
-
|
|
1026
|
+
"boolean"
|
|
1027
|
+
]
|
|
1028
|
+
}
|
|
1029
|
+
]
|
|
1030
|
+
},
|
|
1031
|
+
{
|
|
1032
|
+
"type": "FUNCTION",
|
|
1033
|
+
"name": "bridge.social.rate",
|
|
1034
|
+
"description": "Encourage players to rate your game, providing valuable feedback and improving visibility.",
|
|
1035
|
+
"parameters": [
|
|
1192
1036
|
{
|
|
1193
1037
|
"name": "on_success",
|
|
1194
1038
|
"doc": "function(_)",
|
|
1195
1039
|
"types": [
|
|
1196
|
-
"
|
|
1197
|
-
]
|
|
1198
|
-
"is_optional": "False"
|
|
1040
|
+
"function"
|
|
1041
|
+
]
|
|
1199
1042
|
},
|
|
1200
1043
|
{
|
|
1201
1044
|
"name": "on_failure",
|
|
1202
1045
|
"doc": "function(_)",
|
|
1203
1046
|
"types": [
|
|
1204
|
-
"
|
|
1205
|
-
]
|
|
1206
|
-
"is_optional": "False"
|
|
1047
|
+
"function"
|
|
1048
|
+
]
|
|
1207
1049
|
}
|
|
1208
1050
|
],
|
|
1209
1051
|
"returnvalues": []
|
|
1210
1052
|
},
|
|
1211
1053
|
{
|
|
1212
1054
|
"type": "FUNCTION",
|
|
1213
|
-
"name": "
|
|
1214
|
-
"
|
|
1215
|
-
"
|
|
1055
|
+
"name": "bridge.payments.is_supported",
|
|
1056
|
+
"description": "Check if in-game purchases are supported to offer items or upgrades within the game.",
|
|
1057
|
+
"parameters": [],
|
|
1058
|
+
"returnvalues": [
|
|
1059
|
+
{
|
|
1060
|
+
"name": "result",
|
|
1061
|
+
"doc": "",
|
|
1062
|
+
"types": [
|
|
1063
|
+
"boolean"
|
|
1064
|
+
]
|
|
1065
|
+
}
|
|
1066
|
+
]
|
|
1067
|
+
},
|
|
1068
|
+
{
|
|
1069
|
+
"type": "FUNCTION",
|
|
1070
|
+
"name": "bridge.payments.purchase",
|
|
1071
|
+
"description": "Allow players to buy items or upgrades in your game to enhance their gameplay experience.",
|
|
1216
1072
|
"parameters": [
|
|
1217
1073
|
{
|
|
1218
|
-
"name": "
|
|
1074
|
+
"name": "id",
|
|
1219
1075
|
"doc": "",
|
|
1220
1076
|
"types": [
|
|
1221
|
-
"
|
|
1222
|
-
]
|
|
1223
|
-
"is_optional": "False"
|
|
1077
|
+
"string"
|
|
1078
|
+
]
|
|
1224
1079
|
},
|
|
1225
1080
|
{
|
|
1226
1081
|
"name": "on_success",
|
|
1227
|
-
"doc": "function(_)",
|
|
1082
|
+
"doc": "function(_, purchase)",
|
|
1228
1083
|
"types": [
|
|
1229
|
-
"
|
|
1230
|
-
]
|
|
1231
|
-
"is_optional": "False"
|
|
1084
|
+
"function"
|
|
1085
|
+
]
|
|
1232
1086
|
},
|
|
1233
1087
|
{
|
|
1234
1088
|
"name": "on_failure",
|
|
1235
|
-
"doc": "function(_)",
|
|
1089
|
+
"doc": "function(_, error)",
|
|
1236
1090
|
"types": [
|
|
1237
|
-
"
|
|
1238
|
-
]
|
|
1239
|
-
"is_optional": "False"
|
|
1091
|
+
"function"
|
|
1092
|
+
]
|
|
1240
1093
|
}
|
|
1241
1094
|
],
|
|
1242
1095
|
"returnvalues": []
|
|
1243
1096
|
},
|
|
1244
1097
|
{
|
|
1245
1098
|
"type": "FUNCTION",
|
|
1246
|
-
"name": "
|
|
1247
|
-
"
|
|
1248
|
-
"
|
|
1249
|
-
"parameters": [],
|
|
1250
|
-
"returnvalues": [
|
|
1099
|
+
"name": "bridge.payments.consume_purchase",
|
|
1100
|
+
"description": "Consume purchased items, such as in-game currency, once they are used, to manage inventory and player progression.",
|
|
1101
|
+
"parameters": [
|
|
1251
1102
|
{
|
|
1252
|
-
"name": "",
|
|
1103
|
+
"name": "id",
|
|
1253
1104
|
"doc": "",
|
|
1254
1105
|
"types": [
|
|
1255
|
-
"
|
|
1106
|
+
"string"
|
|
1107
|
+
]
|
|
1108
|
+
},
|
|
1109
|
+
{
|
|
1110
|
+
"name": "on_success",
|
|
1111
|
+
"doc": "function(_, purchase)",
|
|
1112
|
+
"types": [
|
|
1113
|
+
"function"
|
|
1114
|
+
]
|
|
1115
|
+
},
|
|
1116
|
+
{
|
|
1117
|
+
"name": "on_failure",
|
|
1118
|
+
"doc": "function(_, error)",
|
|
1119
|
+
"types": [
|
|
1120
|
+
"function"
|
|
1256
1121
|
]
|
|
1257
1122
|
}
|
|
1258
|
-
]
|
|
1123
|
+
],
|
|
1124
|
+
"returnvalues": []
|
|
1259
1125
|
},
|
|
1260
1126
|
{
|
|
1261
1127
|
"type": "FUNCTION",
|
|
1262
|
-
"name": "
|
|
1263
|
-
"
|
|
1264
|
-
"
|
|
1265
|
-
"parameters": [],
|
|
1266
|
-
"returnvalues": [
|
|
1128
|
+
"name": "bridge.payments.get_catalog",
|
|
1129
|
+
"description": "Retrieve a list of all available in-game items that players can purchase to display in the game store.",
|
|
1130
|
+
"parameters": [
|
|
1267
1131
|
{
|
|
1268
|
-
"name": "",
|
|
1269
|
-
"doc": "",
|
|
1132
|
+
"name": "on_success",
|
|
1133
|
+
"doc": "function(_, catalogItems)",
|
|
1270
1134
|
"types": [
|
|
1271
|
-
"
|
|
1135
|
+
"function"
|
|
1136
|
+
]
|
|
1137
|
+
},
|
|
1138
|
+
{
|
|
1139
|
+
"name": "on_failure",
|
|
1140
|
+
"doc": "function(_, error)",
|
|
1141
|
+
"types": [
|
|
1142
|
+
"function"
|
|
1272
1143
|
]
|
|
1273
1144
|
}
|
|
1274
|
-
]
|
|
1145
|
+
],
|
|
1146
|
+
"returnvalues": []
|
|
1275
1147
|
},
|
|
1276
1148
|
{
|
|
1277
1149
|
"type": "FUNCTION",
|
|
1278
|
-
"name": "
|
|
1279
|
-
"
|
|
1280
|
-
"
|
|
1281
|
-
"parameters": [],
|
|
1282
|
-
"returnvalues": [
|
|
1150
|
+
"name": "bridge.payments.get_purchases",
|
|
1151
|
+
"description": "Retrieve a list of items that the player has purchased to manage their inventory and provide access to purchased content.",
|
|
1152
|
+
"parameters": [
|
|
1283
1153
|
{
|
|
1284
|
-
"name": "",
|
|
1285
|
-
"doc": "",
|
|
1154
|
+
"name": "on_success",
|
|
1155
|
+
"doc": "function(nil, purchases)",
|
|
1286
1156
|
"types": [
|
|
1287
|
-
"
|
|
1157
|
+
"function"
|
|
1158
|
+
]
|
|
1159
|
+
},
|
|
1160
|
+
{
|
|
1161
|
+
"name": "on_failure",
|
|
1162
|
+
"doc": "function(_, error)",
|
|
1163
|
+
"types": [
|
|
1164
|
+
"function"
|
|
1288
1165
|
]
|
|
1289
1166
|
}
|
|
1290
|
-
]
|
|
1167
|
+
],
|
|
1168
|
+
"returnvalues": []
|
|
1291
1169
|
},
|
|
1292
1170
|
{
|
|
1293
1171
|
"type": "FUNCTION",
|
|
1294
|
-
"name": "
|
|
1295
|
-
"
|
|
1296
|
-
"
|
|
1297
|
-
"parameters": [],
|
|
1298
|
-
"returnvalues": [
|
|
1172
|
+
"name": "bridge.achievements.unlock",
|
|
1173
|
+
"description": "Unlocks achievement for a player.",
|
|
1174
|
+
"parameters": [
|
|
1299
1175
|
{
|
|
1300
|
-
"name": "",
|
|
1176
|
+
"name": "id",
|
|
1301
1177
|
"doc": "",
|
|
1302
1178
|
"types": [
|
|
1303
|
-
"
|
|
1179
|
+
"string"
|
|
1180
|
+
]
|
|
1181
|
+
},
|
|
1182
|
+
{
|
|
1183
|
+
"name": "on_success",
|
|
1184
|
+
"doc": "function(_, result)",
|
|
1185
|
+
"types": [
|
|
1186
|
+
"function"
|
|
1187
|
+
]
|
|
1188
|
+
},
|
|
1189
|
+
{
|
|
1190
|
+
"name": "on_failure",
|
|
1191
|
+
"doc": "function(_, error)",
|
|
1192
|
+
"types": [
|
|
1193
|
+
"function"
|
|
1304
1194
|
]
|
|
1305
1195
|
}
|
|
1306
|
-
]
|
|
1196
|
+
],
|
|
1197
|
+
"returnvalues": []
|
|
1307
1198
|
},
|
|
1308
1199
|
{
|
|
1309
1200
|
"type": "FUNCTION",
|
|
1310
|
-
"name": "
|
|
1311
|
-
"
|
|
1312
|
-
"
|
|
1313
|
-
"parameters": [],
|
|
1314
|
-
"returnvalues": [
|
|
1201
|
+
"name": "bridge.achievements.get_achievements",
|
|
1202
|
+
"description": "Returns the achievement list in JSON.",
|
|
1203
|
+
"parameters": [
|
|
1315
1204
|
{
|
|
1316
|
-
"name": "",
|
|
1317
|
-
"doc": "",
|
|
1205
|
+
"name": "on_success",
|
|
1206
|
+
"doc": "function(_, list)",
|
|
1318
1207
|
"types": [
|
|
1319
|
-
"
|
|
1208
|
+
"function"
|
|
1209
|
+
]
|
|
1210
|
+
},
|
|
1211
|
+
{
|
|
1212
|
+
"name": "on_failure",
|
|
1213
|
+
"doc": "function(_, error)",
|
|
1214
|
+
"types": [
|
|
1215
|
+
"function"
|
|
1320
1216
|
]
|
|
1321
1217
|
}
|
|
1322
|
-
]
|
|
1218
|
+
],
|
|
1219
|
+
"returnvalues": []
|
|
1323
1220
|
},
|
|
1324
1221
|
{
|
|
1325
1222
|
"type": "FUNCTION",
|
|
1326
|
-
"name": "
|
|
1327
|
-
"
|
|
1328
|
-
"
|
|
1329
|
-
"parameters": [],
|
|
1330
|
-
"returnvalues": [
|
|
1223
|
+
"name": "bridge.daily_rewards.get_rewards",
|
|
1224
|
+
"description": "Returns the configured ordered list of reward ids as a JSON string.",
|
|
1225
|
+
"parameters": [
|
|
1331
1226
|
{
|
|
1332
|
-
"name": "",
|
|
1333
|
-
"doc": "",
|
|
1227
|
+
"name": "on_success",
|
|
1228
|
+
"doc": "function(_, rewards)",
|
|
1334
1229
|
"types": [
|
|
1335
|
-
"
|
|
1230
|
+
"function"
|
|
1231
|
+
]
|
|
1232
|
+
},
|
|
1233
|
+
{
|
|
1234
|
+
"name": "on_failure",
|
|
1235
|
+
"doc": "function(_, error)",
|
|
1236
|
+
"types": [
|
|
1237
|
+
"function"
|
|
1336
1238
|
]
|
|
1337
1239
|
}
|
|
1338
|
-
]
|
|
1240
|
+
],
|
|
1241
|
+
"returnvalues": []
|
|
1339
1242
|
},
|
|
1340
1243
|
{
|
|
1341
1244
|
"type": "FUNCTION",
|
|
1342
|
-
"name": "
|
|
1343
|
-
"
|
|
1344
|
-
"
|
|
1345
|
-
"parameters": [],
|
|
1346
|
-
"returnvalues": [
|
|
1245
|
+
"name": "bridge.daily_rewards.get_current_day",
|
|
1246
|
+
"description": "Returns the 0-based index of the reward the player is currently on.",
|
|
1247
|
+
"parameters": [
|
|
1347
1248
|
{
|
|
1348
|
-
"name": "",
|
|
1349
|
-
"doc": "",
|
|
1249
|
+
"name": "on_success",
|
|
1250
|
+
"doc": "function(_, day)",
|
|
1350
1251
|
"types": [
|
|
1351
|
-
"
|
|
1252
|
+
"function"
|
|
1253
|
+
]
|
|
1254
|
+
},
|
|
1255
|
+
{
|
|
1256
|
+
"name": "on_failure",
|
|
1257
|
+
"doc": "function(_, error)",
|
|
1258
|
+
"types": [
|
|
1259
|
+
"function"
|
|
1352
1260
|
]
|
|
1353
1261
|
}
|
|
1354
|
-
]
|
|
1262
|
+
],
|
|
1263
|
+
"returnvalues": []
|
|
1355
1264
|
},
|
|
1356
1265
|
{
|
|
1357
1266
|
"type": "FUNCTION",
|
|
1358
|
-
"name": "
|
|
1359
|
-
"
|
|
1360
|
-
"
|
|
1361
|
-
"parameters": [],
|
|
1362
|
-
"returnvalues": [
|
|
1267
|
+
"name": "bridge.daily_rewards.get_current_reward",
|
|
1268
|
+
"description": "Returns the id of the reward claimable today, or nil when nothing can be claimed.",
|
|
1269
|
+
"parameters": [
|
|
1363
1270
|
{
|
|
1364
|
-
"name": "",
|
|
1365
|
-
"doc": "",
|
|
1271
|
+
"name": "on_success",
|
|
1272
|
+
"doc": "function(_, reward)",
|
|
1366
1273
|
"types": [
|
|
1367
|
-
"
|
|
1274
|
+
"function"
|
|
1275
|
+
]
|
|
1276
|
+
},
|
|
1277
|
+
{
|
|
1278
|
+
"name": "on_failure",
|
|
1279
|
+
"doc": "function(_, error)",
|
|
1280
|
+
"types": [
|
|
1281
|
+
"function"
|
|
1368
1282
|
]
|
|
1369
1283
|
}
|
|
1370
|
-
]
|
|
1284
|
+
],
|
|
1285
|
+
"returnvalues": []
|
|
1371
1286
|
},
|
|
1372
1287
|
{
|
|
1373
1288
|
"type": "FUNCTION",
|
|
1374
|
-
"name": "
|
|
1375
|
-
"
|
|
1376
|
-
"description": "Use this to allow players to share game content or achievements on social media platforms.",
|
|
1289
|
+
"name": "bridge.daily_rewards.claim_current_reward",
|
|
1290
|
+
"description": "Claims the reward available today. Calls on_success when claimed, on_failure otherwise.",
|
|
1377
1291
|
"parameters": [
|
|
1378
1292
|
{
|
|
1379
|
-
"name": "
|
|
1380
|
-
"doc": "",
|
|
1293
|
+
"name": "on_success",
|
|
1294
|
+
"doc": "function(_)",
|
|
1381
1295
|
"types": [
|
|
1382
|
-
"
|
|
1383
|
-
]
|
|
1384
|
-
"is_optional": "False"
|
|
1296
|
+
"function"
|
|
1297
|
+
]
|
|
1385
1298
|
},
|
|
1299
|
+
{
|
|
1300
|
+
"name": "on_failure",
|
|
1301
|
+
"doc": "function(_, error)",
|
|
1302
|
+
"types": [
|
|
1303
|
+
"function"
|
|
1304
|
+
]
|
|
1305
|
+
}
|
|
1306
|
+
],
|
|
1307
|
+
"returnvalues": []
|
|
1308
|
+
},
|
|
1309
|
+
{
|
|
1310
|
+
"type": "FUNCTION",
|
|
1311
|
+
"name": "bridge.tasks.get_tasks",
|
|
1312
|
+
"description": "Returns every active task across all groups, with live progress, as a JSON string.",
|
|
1313
|
+
"parameters": [
|
|
1386
1314
|
{
|
|
1387
1315
|
"name": "on_success",
|
|
1388
|
-
"doc": "function(_)",
|
|
1316
|
+
"doc": "function(_, tasks)",
|
|
1389
1317
|
"types": [
|
|
1390
|
-
"
|
|
1391
|
-
]
|
|
1392
|
-
"is_optional": "False"
|
|
1318
|
+
"function"
|
|
1319
|
+
]
|
|
1393
1320
|
},
|
|
1394
1321
|
{
|
|
1395
1322
|
"name": "on_failure",
|
|
1396
|
-
"doc": "function(_)",
|
|
1323
|
+
"doc": "function(_, error)",
|
|
1397
1324
|
"types": [
|
|
1398
|
-
"
|
|
1399
|
-
]
|
|
1400
|
-
"is_optional": "False"
|
|
1325
|
+
"function"
|
|
1326
|
+
]
|
|
1401
1327
|
}
|
|
1402
1328
|
],
|
|
1403
1329
|
"returnvalues": []
|
|
1404
1330
|
},
|
|
1405
1331
|
{
|
|
1406
1332
|
"type": "FUNCTION",
|
|
1407
|
-
"name": "
|
|
1408
|
-
"
|
|
1409
|
-
"description": "Encourage players to rate your game, providing valuable feedback and improving visibility.",
|
|
1333
|
+
"name": "bridge.tasks.add_progress",
|
|
1334
|
+
"description": "Advances every active target whose id equals the given metric, clamped to the target amount.",
|
|
1410
1335
|
"parameters": [
|
|
1336
|
+
{
|
|
1337
|
+
"name": "metric",
|
|
1338
|
+
"doc": "The metric id to advance.",
|
|
1339
|
+
"types": [
|
|
1340
|
+
"string"
|
|
1341
|
+
]
|
|
1342
|
+
},
|
|
1343
|
+
{
|
|
1344
|
+
"name": "amount",
|
|
1345
|
+
"doc": "The amount to add (defaults to 1).",
|
|
1346
|
+
"types": [
|
|
1347
|
+
"number"
|
|
1348
|
+
]
|
|
1349
|
+
},
|
|
1411
1350
|
{
|
|
1412
1351
|
"name": "on_success",
|
|
1413
1352
|
"doc": "function(_)",
|
|
1414
1353
|
"types": [
|
|
1415
|
-
"
|
|
1416
|
-
]
|
|
1417
|
-
"is_optional": "False"
|
|
1354
|
+
"function"
|
|
1355
|
+
]
|
|
1418
1356
|
},
|
|
1419
1357
|
{
|
|
1420
1358
|
"name": "on_failure",
|
|
1421
|
-
"doc": "function(_)",
|
|
1359
|
+
"doc": "function(_, error)",
|
|
1422
1360
|
"types": [
|
|
1423
|
-
"
|
|
1424
|
-
]
|
|
1425
|
-
"is_optional": "False"
|
|
1361
|
+
"function"
|
|
1362
|
+
]
|
|
1426
1363
|
}
|
|
1427
1364
|
],
|
|
1428
1365
|
"returnvalues": []
|
|
1429
1366
|
},
|
|
1430
1367
|
{
|
|
1431
1368
|
"type": "FUNCTION",
|
|
1432
|
-
"name": "
|
|
1433
|
-
"
|
|
1434
|
-
"description": "Use this to allow players to share game content or achievements on social media platforms.",
|
|
1369
|
+
"name": "bridge.tasks.claim_reward",
|
|
1370
|
+
"description": "Claims a completed task's rewards. Calls on_success with true when claimed, false otherwise.",
|
|
1435
1371
|
"parameters": [
|
|
1436
1372
|
{
|
|
1437
|
-
"name": "
|
|
1438
|
-
"doc": "",
|
|
1373
|
+
"name": "task_id",
|
|
1374
|
+
"doc": "The id of the task to claim.",
|
|
1439
1375
|
"types": [
|
|
1440
|
-
"
|
|
1441
|
-
]
|
|
1442
|
-
"is_optional": "False"
|
|
1376
|
+
"string"
|
|
1377
|
+
]
|
|
1443
1378
|
},
|
|
1444
1379
|
{
|
|
1445
1380
|
"name": "on_success",
|
|
1446
|
-
"doc": "function(_)",
|
|
1381
|
+
"doc": "function(_, claimed)",
|
|
1447
1382
|
"types": [
|
|
1448
|
-
"
|
|
1449
|
-
]
|
|
1450
|
-
"is_optional": "False"
|
|
1383
|
+
"function"
|
|
1384
|
+
]
|
|
1451
1385
|
},
|
|
1452
1386
|
{
|
|
1453
1387
|
"name": "on_failure",
|
|
1454
|
-
"doc": "function(_)",
|
|
1388
|
+
"doc": "function(_, error)",
|
|
1455
1389
|
"types": [
|
|
1456
|
-
"
|
|
1457
|
-
]
|
|
1458
|
-
"is_optional": "False"
|
|
1390
|
+
"function"
|
|
1391
|
+
]
|
|
1459
1392
|
}
|
|
1460
1393
|
],
|
|
1461
1394
|
"returnvalues": []
|
|
1462
1395
|
},
|
|
1463
1396
|
{
|
|
1464
1397
|
"type": "FUNCTION",
|
|
1465
|
-
"name": "
|
|
1466
|
-
"
|
|
1467
|
-
"description": "Identify the default storage type to understand where data is being saved (local or server).",
|
|
1398
|
+
"name": "bridge.leaderboards.type",
|
|
1399
|
+
"description": "Check the leaderboards type on the platform.",
|
|
1468
1400
|
"parameters": [],
|
|
1469
1401
|
"returnvalues": [
|
|
1470
1402
|
{
|
|
1471
|
-
"name": "",
|
|
1403
|
+
"name": "result",
|
|
1472
1404
|
"doc": "",
|
|
1473
1405
|
"types": [
|
|
1474
1406
|
"string"
|
|
@@ -1478,104 +1410,106 @@
|
|
|
1478
1410
|
},
|
|
1479
1411
|
{
|
|
1480
1412
|
"type": "FUNCTION",
|
|
1481
|
-
"name": "
|
|
1482
|
-
"
|
|
1483
|
-
"description": "Remove data from the specified storage by key to manage player data and settings effectively.",
|
|
1413
|
+
"name": "bridge.leaderboards.set_score",
|
|
1414
|
+
"description": "Submit the player's score to the leaderboard to update their rank and position.",
|
|
1484
1415
|
"parameters": [
|
|
1485
1416
|
{
|
|
1486
|
-
"name": "
|
|
1417
|
+
"name": "id",
|
|
1487
1418
|
"doc": "",
|
|
1488
1419
|
"types": [
|
|
1489
|
-
"
|
|
1490
|
-
]
|
|
1491
|
-
"is_optional": "False"
|
|
1420
|
+
"string"
|
|
1421
|
+
]
|
|
1492
1422
|
},
|
|
1493
1423
|
{
|
|
1494
|
-
"name": "
|
|
1495
|
-
"doc": "
|
|
1424
|
+
"name": "score",
|
|
1425
|
+
"doc": "",
|
|
1496
1426
|
"types": [
|
|
1497
|
-
"
|
|
1498
|
-
]
|
|
1499
|
-
"is_optional": "False"
|
|
1427
|
+
"number"
|
|
1428
|
+
]
|
|
1500
1429
|
},
|
|
1501
1430
|
{
|
|
1502
|
-
"name": "
|
|
1503
|
-
"doc": "function(
|
|
1431
|
+
"name": "on_success",
|
|
1432
|
+
"doc": "function()",
|
|
1504
1433
|
"types": [
|
|
1505
|
-
"
|
|
1506
|
-
]
|
|
1507
|
-
"is_optional": "False"
|
|
1434
|
+
"function"
|
|
1435
|
+
]
|
|
1508
1436
|
},
|
|
1509
1437
|
{
|
|
1510
|
-
"name": "
|
|
1511
|
-
"doc": "",
|
|
1438
|
+
"name": "on_failure",
|
|
1439
|
+
"doc": "function(_, error)",
|
|
1512
1440
|
"types": [
|
|
1513
|
-
"
|
|
1514
|
-
]
|
|
1515
|
-
"is_optional": "False"
|
|
1441
|
+
"function"
|
|
1442
|
+
]
|
|
1516
1443
|
}
|
|
1517
1444
|
],
|
|
1518
1445
|
"returnvalues": []
|
|
1519
1446
|
},
|
|
1520
1447
|
{
|
|
1521
1448
|
"type": "FUNCTION",
|
|
1522
|
-
"name": "
|
|
1523
|
-
"
|
|
1524
|
-
"description": "Retrieve stored data based on a key or multiple keys to restore player progress or settings.",
|
|
1449
|
+
"name": "bridge.leaderboards.get_entries",
|
|
1450
|
+
"description": "Retrieve entries from the leaderboard, including the player's rank and score, to display a comprehensive leaderboard.",
|
|
1525
1451
|
"parameters": [
|
|
1526
1452
|
{
|
|
1527
|
-
"name": "
|
|
1453
|
+
"name": "id",
|
|
1528
1454
|
"doc": "",
|
|
1529
1455
|
"types": [
|
|
1530
|
-
"
|
|
1531
|
-
]
|
|
1532
|
-
"is_optional": "False"
|
|
1456
|
+
"string"
|
|
1457
|
+
]
|
|
1533
1458
|
},
|
|
1534
1459
|
{
|
|
1535
1460
|
"name": "on_success",
|
|
1536
|
-
"doc": "function(_,
|
|
1461
|
+
"doc": "function(_, entries)",
|
|
1537
1462
|
"types": [
|
|
1538
|
-
"
|
|
1539
|
-
]
|
|
1540
|
-
"is_optional": "False"
|
|
1463
|
+
"function"
|
|
1464
|
+
]
|
|
1541
1465
|
},
|
|
1542
1466
|
{
|
|
1543
1467
|
"name": "on_failure",
|
|
1544
1468
|
"doc": "function(_, error)",
|
|
1545
1469
|
"types": [
|
|
1546
|
-
"
|
|
1547
|
-
]
|
|
1548
|
-
"is_optional": "False"
|
|
1549
|
-
},
|
|
1550
|
-
{
|
|
1551
|
-
"name": "storage_type",
|
|
1552
|
-
"doc": "",
|
|
1553
|
-
"types": [
|
|
1554
|
-
"string"
|
|
1555
|
-
],
|
|
1556
|
-
"is_optional": "False"
|
|
1470
|
+
"function"
|
|
1471
|
+
]
|
|
1557
1472
|
}
|
|
1558
1473
|
],
|
|
1559
1474
|
"returnvalues": []
|
|
1560
1475
|
},
|
|
1561
1476
|
{
|
|
1562
1477
|
"type": "FUNCTION",
|
|
1563
|
-
"name": "
|
|
1564
|
-
"
|
|
1565
|
-
"description": "Check if the specified storage type is currently available for use to manage data storage effectively.",
|
|
1478
|
+
"name": "bridge.leaderboards.show_native_popup",
|
|
1479
|
+
"description": "Show native popup leaderboard.",
|
|
1566
1480
|
"parameters": [
|
|
1567
1481
|
{
|
|
1568
|
-
"name": "
|
|
1482
|
+
"name": "id",
|
|
1569
1483
|
"doc": "",
|
|
1570
1484
|
"types": [
|
|
1571
1485
|
"string"
|
|
1572
|
-
]
|
|
1573
|
-
|
|
1486
|
+
]
|
|
1487
|
+
},
|
|
1488
|
+
{
|
|
1489
|
+
"name": "on_success",
|
|
1490
|
+
"doc": "function()",
|
|
1491
|
+
"types": [
|
|
1492
|
+
"function"
|
|
1493
|
+
]
|
|
1494
|
+
},
|
|
1495
|
+
{
|
|
1496
|
+
"name": "on_failure",
|
|
1497
|
+
"doc": "function(_, error)",
|
|
1498
|
+
"types": [
|
|
1499
|
+
"function"
|
|
1500
|
+
]
|
|
1574
1501
|
}
|
|
1575
1502
|
],
|
|
1503
|
+
"returnvalues": []
|
|
1504
|
+
},
|
|
1505
|
+
{
|
|
1506
|
+
"type": "FUNCTION",
|
|
1507
|
+
"name": "bridge.remote_config.is_supported",
|
|
1508
|
+
"description": "Check if remote configuration is supported to manage game settings without releasing updates.",
|
|
1509
|
+
"parameters": [],
|
|
1576
1510
|
"returnvalues": [
|
|
1577
1511
|
{
|
|
1578
|
-
"name": "",
|
|
1512
|
+
"name": "result",
|
|
1579
1513
|
"doc": "",
|
|
1580
1514
|
"types": [
|
|
1581
1515
|
"boolean"
|
|
@@ -1585,66 +1519,37 @@
|
|
|
1585
1519
|
},
|
|
1586
1520
|
{
|
|
1587
1521
|
"type": "FUNCTION",
|
|
1588
|
-
"name": "
|
|
1589
|
-
"
|
|
1590
|
-
"description": "Verify if the specified storage type is supported on the platform to ensure compatibility.",
|
|
1522
|
+
"name": "bridge.remote_config.set_context",
|
|
1523
|
+
"description": "Set dynamic game/player parameters used for config segmentation. Accumulates across calls; only used by platforms that support it.",
|
|
1591
1524
|
"parameters": [
|
|
1592
1525
|
{
|
|
1593
|
-
"name": "
|
|
1526
|
+
"name": "parameters",
|
|
1594
1527
|
"doc": "",
|
|
1595
1528
|
"types": [
|
|
1596
|
-
"
|
|
1597
|
-
],
|
|
1598
|
-
"is_optional": "False"
|
|
1599
|
-
}
|
|
1600
|
-
],
|
|
1601
|
-
"returnvalues": [
|
|
1602
|
-
{
|
|
1603
|
-
"name": "",
|
|
1604
|
-
"doc": "",
|
|
1605
|
-
"types": [
|
|
1606
|
-
"boolean"
|
|
1529
|
+
"table"
|
|
1607
1530
|
]
|
|
1608
1531
|
}
|
|
1609
|
-
]
|
|
1532
|
+
],
|
|
1533
|
+
"returnvalues": []
|
|
1610
1534
|
},
|
|
1611
1535
|
{
|
|
1612
1536
|
"type": "FUNCTION",
|
|
1613
|
-
"name": "
|
|
1614
|
-
"
|
|
1615
|
-
"description": "Save data to the specified storage with a key to retain player progress or settings.",
|
|
1537
|
+
"name": "bridge.remote_config.get",
|
|
1538
|
+
"description": "Encourage players to rate your game, providing valuable feedback and improving visibility.",
|
|
1616
1539
|
"parameters": [
|
|
1617
|
-
{
|
|
1618
|
-
"name": "table_data",
|
|
1619
|
-
"doc": "",
|
|
1620
|
-
"types": [
|
|
1621
|
-
"object"
|
|
1622
|
-
],
|
|
1623
|
-
"is_optional": "False"
|
|
1624
|
-
},
|
|
1625
1540
|
{
|
|
1626
1541
|
"name": "on_success",
|
|
1627
|
-
"doc": "function(_)",
|
|
1542
|
+
"doc": "function(_, data)",
|
|
1628
1543
|
"types": [
|
|
1629
|
-
"
|
|
1630
|
-
]
|
|
1631
|
-
"is_optional": "False"
|
|
1544
|
+
"function"
|
|
1545
|
+
]
|
|
1632
1546
|
},
|
|
1633
1547
|
{
|
|
1634
1548
|
"name": "on_failure",
|
|
1635
|
-
"doc": "function(_
|
|
1636
|
-
"types": [
|
|
1637
|
-
"(this: any, error: unknown) => void"
|
|
1638
|
-
],
|
|
1639
|
-
"is_optional": "False"
|
|
1640
|
-
},
|
|
1641
|
-
{
|
|
1642
|
-
"name": "storage_type",
|
|
1643
|
-
"doc": "",
|
|
1549
|
+
"doc": "function(_)",
|
|
1644
1550
|
"types": [
|
|
1645
|
-
"
|
|
1646
|
-
]
|
|
1647
|
-
"is_optional": "False"
|
|
1551
|
+
"function"
|
|
1552
|
+
]
|
|
1648
1553
|
}
|
|
1649
1554
|
],
|
|
1650
1555
|
"returnvalues": []
|