@defold-typescript/library-types 0.20.7 → 0.21.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/decore.json +1883 -0
- package/api-doc/druid.json +11818 -0
- package/generated/decore.d.ts +228 -0
- package/generated/druid.d.ts +2067 -0
- package/luals-targets.json +28 -0
- package/package.json +8 -3
- package/scripts/__snapshots__/emit-library-dts.test.ts.snap +22 -0
- package/scripts/__snapshots__/parse-luals.test.ts.snap +15780 -0
- package/scripts/emit-library-dts.ts +252 -0
- package/scripts/lower-api-doc.ts +115 -0
- package/scripts/luals-fidelity.ts +123 -0
- package/scripts/map-luals-types.ts +323 -0
- package/scripts/parse-luals.ts +432 -0
- package/scripts/sync-luals-types.ts +303 -0
|
@@ -0,0 +1,1883 @@
|
|
|
1
|
+
{
|
|
2
|
+
"info": {
|
|
3
|
+
"namespace": "decore",
|
|
4
|
+
"brief": "",
|
|
5
|
+
"description": ""
|
|
6
|
+
},
|
|
7
|
+
"elements": [
|
|
8
|
+
{
|
|
9
|
+
"type": "FUNCTION",
|
|
10
|
+
"name": "new_world",
|
|
11
|
+
"brief": "Create a new world instance",
|
|
12
|
+
"description": "Create a new world instance",
|
|
13
|
+
"parameters": [
|
|
14
|
+
{
|
|
15
|
+
"name": "...args",
|
|
16
|
+
"doc": "",
|
|
17
|
+
"types": [
|
|
18
|
+
"system[] | undefined"
|
|
19
|
+
],
|
|
20
|
+
"is_optional": "False",
|
|
21
|
+
"is_vararg": "True"
|
|
22
|
+
}
|
|
23
|
+
],
|
|
24
|
+
"returnvalues": [
|
|
25
|
+
{
|
|
26
|
+
"name": "",
|
|
27
|
+
"doc": "",
|
|
28
|
+
"types": [
|
|
29
|
+
"world"
|
|
30
|
+
]
|
|
31
|
+
}
|
|
32
|
+
]
|
|
33
|
+
},
|
|
34
|
+
{
|
|
35
|
+
"type": "FUNCTION",
|
|
36
|
+
"name": "on_message",
|
|
37
|
+
"brief": "Add window event to the world event bus",
|
|
38
|
+
"description": "Add window event to the world event bus",
|
|
39
|
+
"parameters": [
|
|
40
|
+
{
|
|
41
|
+
"name": "world",
|
|
42
|
+
"doc": "",
|
|
43
|
+
"types": [
|
|
44
|
+
"world"
|
|
45
|
+
],
|
|
46
|
+
"is_optional": "False",
|
|
47
|
+
"is_vararg": "False"
|
|
48
|
+
},
|
|
49
|
+
{
|
|
50
|
+
"name": "message_id",
|
|
51
|
+
"doc": "",
|
|
52
|
+
"types": [
|
|
53
|
+
"Hash"
|
|
54
|
+
],
|
|
55
|
+
"is_optional": "False",
|
|
56
|
+
"is_vararg": "False"
|
|
57
|
+
},
|
|
58
|
+
{
|
|
59
|
+
"name": "message",
|
|
60
|
+
"doc": "",
|
|
61
|
+
"types": [
|
|
62
|
+
"LuaTable | undefined"
|
|
63
|
+
],
|
|
64
|
+
"is_optional": "False",
|
|
65
|
+
"is_vararg": "False"
|
|
66
|
+
},
|
|
67
|
+
{
|
|
68
|
+
"name": "sender",
|
|
69
|
+
"doc": "",
|
|
70
|
+
"types": [
|
|
71
|
+
"Url | undefined"
|
|
72
|
+
],
|
|
73
|
+
"is_optional": "False",
|
|
74
|
+
"is_vararg": "False"
|
|
75
|
+
}
|
|
76
|
+
],
|
|
77
|
+
"returnvalues": []
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
"type": "FUNCTION",
|
|
81
|
+
"name": "system",
|
|
82
|
+
"brief": "",
|
|
83
|
+
"description": "",
|
|
84
|
+
"generics": "<T>",
|
|
85
|
+
"parameters": [
|
|
86
|
+
{
|
|
87
|
+
"name": "system_module",
|
|
88
|
+
"doc": "The module with system functions",
|
|
89
|
+
"types": [
|
|
90
|
+
"T"
|
|
91
|
+
],
|
|
92
|
+
"is_optional": "False",
|
|
93
|
+
"is_vararg": "False"
|
|
94
|
+
},
|
|
95
|
+
{
|
|
96
|
+
"name": "system_id",
|
|
97
|
+
"doc": "The system id",
|
|
98
|
+
"types": [
|
|
99
|
+
"string"
|
|
100
|
+
],
|
|
101
|
+
"is_optional": "False",
|
|
102
|
+
"is_vararg": "False"
|
|
103
|
+
},
|
|
104
|
+
{
|
|
105
|
+
"name": "require_all_filters",
|
|
106
|
+
"doc": "The required components. Example: {\"transform\", \"game_object\"} or \"transform\". If nil - system will contain no entities",
|
|
107
|
+
"types": [
|
|
108
|
+
"string | string[] | undefined"
|
|
109
|
+
],
|
|
110
|
+
"is_optional": "False",
|
|
111
|
+
"is_vararg": "False"
|
|
112
|
+
}
|
|
113
|
+
],
|
|
114
|
+
"returnvalues": [
|
|
115
|
+
{
|
|
116
|
+
"name": "",
|
|
117
|
+
"doc": "",
|
|
118
|
+
"types": [
|
|
119
|
+
"T"
|
|
120
|
+
]
|
|
121
|
+
}
|
|
122
|
+
]
|
|
123
|
+
},
|
|
124
|
+
{
|
|
125
|
+
"type": "FUNCTION",
|
|
126
|
+
"name": "processing_system",
|
|
127
|
+
"brief": "",
|
|
128
|
+
"description": "",
|
|
129
|
+
"generics": "<T>",
|
|
130
|
+
"parameters": [
|
|
131
|
+
{
|
|
132
|
+
"name": "system_module",
|
|
133
|
+
"doc": "The module with system functions",
|
|
134
|
+
"types": [
|
|
135
|
+
"T"
|
|
136
|
+
],
|
|
137
|
+
"is_optional": "False",
|
|
138
|
+
"is_vararg": "False"
|
|
139
|
+
},
|
|
140
|
+
{
|
|
141
|
+
"name": "system_id",
|
|
142
|
+
"doc": "The system id",
|
|
143
|
+
"types": [
|
|
144
|
+
"string"
|
|
145
|
+
],
|
|
146
|
+
"is_optional": "False",
|
|
147
|
+
"is_vararg": "False"
|
|
148
|
+
},
|
|
149
|
+
{
|
|
150
|
+
"name": "require_all_filters",
|
|
151
|
+
"doc": "The required components. Example: {\"transform\", \"game_object\"} or \"transform\"",
|
|
152
|
+
"types": [
|
|
153
|
+
"string | string[] | undefined"
|
|
154
|
+
],
|
|
155
|
+
"is_optional": "False",
|
|
156
|
+
"is_vararg": "False"
|
|
157
|
+
}
|
|
158
|
+
],
|
|
159
|
+
"returnvalues": [
|
|
160
|
+
{
|
|
161
|
+
"name": "",
|
|
162
|
+
"doc": "",
|
|
163
|
+
"types": [
|
|
164
|
+
"T"
|
|
165
|
+
]
|
|
166
|
+
}
|
|
167
|
+
]
|
|
168
|
+
},
|
|
169
|
+
{
|
|
170
|
+
"type": "FUNCTION",
|
|
171
|
+
"name": "sorted_system",
|
|
172
|
+
"brief": "",
|
|
173
|
+
"description": "",
|
|
174
|
+
"generics": "<T>",
|
|
175
|
+
"parameters": [
|
|
176
|
+
{
|
|
177
|
+
"name": "system_module",
|
|
178
|
+
"doc": "The module with system functions",
|
|
179
|
+
"types": [
|
|
180
|
+
"T"
|
|
181
|
+
],
|
|
182
|
+
"is_optional": "False",
|
|
183
|
+
"is_vararg": "False"
|
|
184
|
+
},
|
|
185
|
+
{
|
|
186
|
+
"name": "system_id",
|
|
187
|
+
"doc": "The system id",
|
|
188
|
+
"types": [
|
|
189
|
+
"string"
|
|
190
|
+
],
|
|
191
|
+
"is_optional": "False",
|
|
192
|
+
"is_vararg": "False"
|
|
193
|
+
},
|
|
194
|
+
{
|
|
195
|
+
"name": "require_all_filters",
|
|
196
|
+
"doc": "The required components. Example: {\"transform\", \"game_object\"} or \"transform\"",
|
|
197
|
+
"types": [
|
|
198
|
+
"string | string[] | undefined"
|
|
199
|
+
],
|
|
200
|
+
"is_optional": "False",
|
|
201
|
+
"is_vararg": "False"
|
|
202
|
+
}
|
|
203
|
+
],
|
|
204
|
+
"returnvalues": [
|
|
205
|
+
{
|
|
206
|
+
"name": "",
|
|
207
|
+
"doc": "",
|
|
208
|
+
"types": [
|
|
209
|
+
"T"
|
|
210
|
+
]
|
|
211
|
+
}
|
|
212
|
+
]
|
|
213
|
+
},
|
|
214
|
+
{
|
|
215
|
+
"type": "FUNCTION",
|
|
216
|
+
"name": "sorted_processing_system",
|
|
217
|
+
"brief": "",
|
|
218
|
+
"description": "",
|
|
219
|
+
"generics": "<T>",
|
|
220
|
+
"parameters": [
|
|
221
|
+
{
|
|
222
|
+
"name": "system_module",
|
|
223
|
+
"doc": "The module with system functions",
|
|
224
|
+
"types": [
|
|
225
|
+
"T"
|
|
226
|
+
],
|
|
227
|
+
"is_optional": "False",
|
|
228
|
+
"is_vararg": "False"
|
|
229
|
+
},
|
|
230
|
+
{
|
|
231
|
+
"name": "system_id",
|
|
232
|
+
"doc": "The system id",
|
|
233
|
+
"types": [
|
|
234
|
+
"string"
|
|
235
|
+
],
|
|
236
|
+
"is_optional": "False",
|
|
237
|
+
"is_vararg": "False"
|
|
238
|
+
},
|
|
239
|
+
{
|
|
240
|
+
"name": "require_all_filters",
|
|
241
|
+
"doc": "The required components. Example: {\"transform\", \"game_object\"} or \"transform\"",
|
|
242
|
+
"types": [
|
|
243
|
+
"string | string[] | undefined"
|
|
244
|
+
],
|
|
245
|
+
"is_optional": "False",
|
|
246
|
+
"is_vararg": "False"
|
|
247
|
+
}
|
|
248
|
+
],
|
|
249
|
+
"returnvalues": [
|
|
250
|
+
{
|
|
251
|
+
"name": "",
|
|
252
|
+
"doc": "",
|
|
253
|
+
"types": [
|
|
254
|
+
"T"
|
|
255
|
+
]
|
|
256
|
+
}
|
|
257
|
+
]
|
|
258
|
+
},
|
|
259
|
+
{
|
|
260
|
+
"type": "FUNCTION",
|
|
261
|
+
"name": "register_entity",
|
|
262
|
+
"brief": "Register entity to create it with `create_prefab` function",
|
|
263
|
+
"description": "Register entity to create it with `create_prefab` function",
|
|
264
|
+
"parameters": [
|
|
265
|
+
{
|
|
266
|
+
"name": "entity_id",
|
|
267
|
+
"doc": "",
|
|
268
|
+
"types": [
|
|
269
|
+
"string"
|
|
270
|
+
],
|
|
271
|
+
"is_optional": "False",
|
|
272
|
+
"is_vararg": "False"
|
|
273
|
+
},
|
|
274
|
+
{
|
|
275
|
+
"name": "entity_data",
|
|
276
|
+
"doc": "",
|
|
277
|
+
"types": [
|
|
278
|
+
"LuaTable"
|
|
279
|
+
],
|
|
280
|
+
"is_optional": "False",
|
|
281
|
+
"is_vararg": "False"
|
|
282
|
+
},
|
|
283
|
+
{
|
|
284
|
+
"name": "pack_id",
|
|
285
|
+
"doc": "default \"decore\"",
|
|
286
|
+
"types": [
|
|
287
|
+
"string | undefined"
|
|
288
|
+
],
|
|
289
|
+
"is_optional": "False",
|
|
290
|
+
"is_vararg": "False"
|
|
291
|
+
}
|
|
292
|
+
],
|
|
293
|
+
"returnvalues": []
|
|
294
|
+
},
|
|
295
|
+
{
|
|
296
|
+
"type": "FUNCTION",
|
|
297
|
+
"name": "register_entities",
|
|
298
|
+
"brief": "Add entities pack to decore entities\nIf entities pack with same id already loaded, do nothing.\nIf the same id is used in different packs, the last one will be used in `create_prefab` function",
|
|
299
|
+
"description": "Add entities pack to decore entities\nIf entities pack with same id already loaded, do nothing.\nIf the same id is used in different packs, the last one will be used in `create_prefab` function",
|
|
300
|
+
"parameters": [
|
|
301
|
+
{
|
|
302
|
+
"name": "pack_id",
|
|
303
|
+
"doc": "",
|
|
304
|
+
"types": [
|
|
305
|
+
"string"
|
|
306
|
+
],
|
|
307
|
+
"is_optional": "False",
|
|
308
|
+
"is_vararg": "False"
|
|
309
|
+
},
|
|
310
|
+
{
|
|
311
|
+
"name": "entities",
|
|
312
|
+
"doc": "",
|
|
313
|
+
"types": [
|
|
314
|
+
"LuaTable<string, LuaTable>"
|
|
315
|
+
],
|
|
316
|
+
"is_optional": "False",
|
|
317
|
+
"is_vararg": "False"
|
|
318
|
+
}
|
|
319
|
+
],
|
|
320
|
+
"returnvalues": []
|
|
321
|
+
},
|
|
322
|
+
{
|
|
323
|
+
"type": "FUNCTION",
|
|
324
|
+
"name": "unregister_entities",
|
|
325
|
+
"brief": "Unload entities pack from decore entities",
|
|
326
|
+
"description": "Unload entities pack from decore entities",
|
|
327
|
+
"parameters": [
|
|
328
|
+
{
|
|
329
|
+
"name": "pack_id",
|
|
330
|
+
"doc": "",
|
|
331
|
+
"types": [
|
|
332
|
+
"string"
|
|
333
|
+
],
|
|
334
|
+
"is_optional": "False",
|
|
335
|
+
"is_vararg": "False"
|
|
336
|
+
}
|
|
337
|
+
],
|
|
338
|
+
"returnvalues": []
|
|
339
|
+
},
|
|
340
|
+
{
|
|
341
|
+
"type": "FUNCTION",
|
|
342
|
+
"name": "create",
|
|
343
|
+
"brief": "Create new entity instance",
|
|
344
|
+
"description": "Create new entity instance",
|
|
345
|
+
"parameters": [
|
|
346
|
+
{
|
|
347
|
+
"name": "components",
|
|
348
|
+
"doc": "",
|
|
349
|
+
"types": [
|
|
350
|
+
"LuaTable<string, unknown>"
|
|
351
|
+
],
|
|
352
|
+
"is_optional": "False",
|
|
353
|
+
"is_vararg": "False"
|
|
354
|
+
}
|
|
355
|
+
],
|
|
356
|
+
"returnvalues": [
|
|
357
|
+
{
|
|
358
|
+
"name": "",
|
|
359
|
+
"doc": "",
|
|
360
|
+
"types": [
|
|
361
|
+
"entity"
|
|
362
|
+
]
|
|
363
|
+
}
|
|
364
|
+
]
|
|
365
|
+
},
|
|
366
|
+
{
|
|
367
|
+
"type": "FUNCTION",
|
|
368
|
+
"name": "create_prefab",
|
|
369
|
+
"brief": "Create new entity instance from prefab",
|
|
370
|
+
"description": "Create new entity instance from prefab",
|
|
371
|
+
"parameters": [
|
|
372
|
+
{
|
|
373
|
+
"name": "prefab_id",
|
|
374
|
+
"doc": "",
|
|
375
|
+
"types": [
|
|
376
|
+
"string | Hash | undefined"
|
|
377
|
+
],
|
|
378
|
+
"is_optional": "False",
|
|
379
|
+
"is_vararg": "False"
|
|
380
|
+
},
|
|
381
|
+
{
|
|
382
|
+
"name": "pack_id",
|
|
383
|
+
"doc": "",
|
|
384
|
+
"types": [
|
|
385
|
+
"string | undefined"
|
|
386
|
+
],
|
|
387
|
+
"is_optional": "False",
|
|
388
|
+
"is_vararg": "False"
|
|
389
|
+
},
|
|
390
|
+
{
|
|
391
|
+
"name": "components",
|
|
392
|
+
"doc": "additional components to merge with prefab",
|
|
393
|
+
"types": [
|
|
394
|
+
"LuaTable<string, unknown> | undefined"
|
|
395
|
+
],
|
|
396
|
+
"is_optional": "False",
|
|
397
|
+
"is_vararg": "False"
|
|
398
|
+
}
|
|
399
|
+
],
|
|
400
|
+
"returnvalues": [
|
|
401
|
+
{
|
|
402
|
+
"name": "",
|
|
403
|
+
"doc": "",
|
|
404
|
+
"types": [
|
|
405
|
+
"entity"
|
|
406
|
+
]
|
|
407
|
+
}
|
|
408
|
+
]
|
|
409
|
+
},
|
|
410
|
+
{
|
|
411
|
+
"type": "FUNCTION",
|
|
412
|
+
"name": "register_component",
|
|
413
|
+
"brief": "Register component to decore components",
|
|
414
|
+
"description": "Register component to decore components",
|
|
415
|
+
"parameters": [
|
|
416
|
+
{
|
|
417
|
+
"name": "component_id",
|
|
418
|
+
"doc": "",
|
|
419
|
+
"types": [
|
|
420
|
+
"string"
|
|
421
|
+
],
|
|
422
|
+
"is_optional": "False",
|
|
423
|
+
"is_vararg": "False"
|
|
424
|
+
},
|
|
425
|
+
{
|
|
426
|
+
"name": "component_data",
|
|
427
|
+
"doc": "",
|
|
428
|
+
"types": [
|
|
429
|
+
"LuaTable | string | number | boolean"
|
|
430
|
+
],
|
|
431
|
+
"is_optional": "False",
|
|
432
|
+
"is_vararg": "False"
|
|
433
|
+
},
|
|
434
|
+
{
|
|
435
|
+
"name": "pack_id",
|
|
436
|
+
"doc": "default \"decore\"",
|
|
437
|
+
"types": [
|
|
438
|
+
"string | undefined"
|
|
439
|
+
],
|
|
440
|
+
"is_optional": "False",
|
|
441
|
+
"is_vararg": "False"
|
|
442
|
+
}
|
|
443
|
+
],
|
|
444
|
+
"returnvalues": []
|
|
445
|
+
},
|
|
446
|
+
{
|
|
447
|
+
"type": "FUNCTION",
|
|
448
|
+
"name": "register_components",
|
|
449
|
+
"brief": "Register components pack to decore components",
|
|
450
|
+
"description": "Register components pack to decore components",
|
|
451
|
+
"parameters": [
|
|
452
|
+
{
|
|
453
|
+
"name": "components_data",
|
|
454
|
+
"doc": "",
|
|
455
|
+
"types": [
|
|
456
|
+
"decore_components_data"
|
|
457
|
+
],
|
|
458
|
+
"is_optional": "False",
|
|
459
|
+
"is_vararg": "False"
|
|
460
|
+
}
|
|
461
|
+
],
|
|
462
|
+
"returnvalues": [
|
|
463
|
+
{
|
|
464
|
+
"name": "",
|
|
465
|
+
"doc": "",
|
|
466
|
+
"types": [
|
|
467
|
+
"boolean"
|
|
468
|
+
]
|
|
469
|
+
}
|
|
470
|
+
]
|
|
471
|
+
},
|
|
472
|
+
{
|
|
473
|
+
"type": "FUNCTION",
|
|
474
|
+
"name": "unregister_components",
|
|
475
|
+
"brief": "Unload components pack from decore components",
|
|
476
|
+
"description": "Unload components pack from decore components",
|
|
477
|
+
"parameters": [
|
|
478
|
+
{
|
|
479
|
+
"name": "pack_id",
|
|
480
|
+
"doc": "",
|
|
481
|
+
"types": [
|
|
482
|
+
"string"
|
|
483
|
+
],
|
|
484
|
+
"is_optional": "False",
|
|
485
|
+
"is_vararg": "False"
|
|
486
|
+
}
|
|
487
|
+
],
|
|
488
|
+
"returnvalues": []
|
|
489
|
+
},
|
|
490
|
+
{
|
|
491
|
+
"type": "FUNCTION",
|
|
492
|
+
"name": "create_component",
|
|
493
|
+
"brief": "Return new component instance from prefab",
|
|
494
|
+
"description": "Return new component instance from prefab",
|
|
495
|
+
"parameters": [
|
|
496
|
+
{
|
|
497
|
+
"name": "component_id",
|
|
498
|
+
"doc": "",
|
|
499
|
+
"types": [
|
|
500
|
+
"string"
|
|
501
|
+
],
|
|
502
|
+
"is_optional": "False",
|
|
503
|
+
"is_vararg": "False"
|
|
504
|
+
},
|
|
505
|
+
{
|
|
506
|
+
"name": "component_pack_id",
|
|
507
|
+
"doc": "if nil, use first found from latest loaded pack",
|
|
508
|
+
"types": [
|
|
509
|
+
"string | undefined"
|
|
510
|
+
],
|
|
511
|
+
"is_optional": "False",
|
|
512
|
+
"is_vararg": "False"
|
|
513
|
+
}
|
|
514
|
+
],
|
|
515
|
+
"returnvalues": [
|
|
516
|
+
{
|
|
517
|
+
"name": "",
|
|
518
|
+
"doc": "nil if component not found. False can be returned as a component value (check on nil instead of not)",
|
|
519
|
+
"types": [
|
|
520
|
+
"unknown | undefined"
|
|
521
|
+
]
|
|
522
|
+
}
|
|
523
|
+
]
|
|
524
|
+
},
|
|
525
|
+
{
|
|
526
|
+
"type": "FUNCTION",
|
|
527
|
+
"name": "apply_component",
|
|
528
|
+
"brief": "Add component to entity.\nIf component not exists, it will be created with default values\nIf component already exists, it will be merged with the new data\nTo refresh system filters, call world:addEntity(entity) after this function",
|
|
529
|
+
"description": "Add component to entity.\nIf component not exists, it will be created with default values\nIf component already exists, it will be merged with the new data\nTo refresh system filters, call world:addEntity(entity) after this function",
|
|
530
|
+
"parameters": [
|
|
531
|
+
{
|
|
532
|
+
"name": "entity",
|
|
533
|
+
"doc": "",
|
|
534
|
+
"types": [
|
|
535
|
+
"entity"
|
|
536
|
+
],
|
|
537
|
+
"is_optional": "False",
|
|
538
|
+
"is_vararg": "False"
|
|
539
|
+
},
|
|
540
|
+
{
|
|
541
|
+
"name": "component_id",
|
|
542
|
+
"doc": "",
|
|
543
|
+
"types": [
|
|
544
|
+
"string"
|
|
545
|
+
],
|
|
546
|
+
"is_optional": "False",
|
|
547
|
+
"is_vararg": "False"
|
|
548
|
+
},
|
|
549
|
+
{
|
|
550
|
+
"name": "component_data",
|
|
551
|
+
"doc": "if nil, create component with default values",
|
|
552
|
+
"types": [
|
|
553
|
+
"unknown | undefined"
|
|
554
|
+
],
|
|
555
|
+
"is_optional": "False",
|
|
556
|
+
"is_vararg": "False"
|
|
557
|
+
}
|
|
558
|
+
],
|
|
559
|
+
"returnvalues": [
|
|
560
|
+
{
|
|
561
|
+
"name": "",
|
|
562
|
+
"doc": "",
|
|
563
|
+
"types": [
|
|
564
|
+
"entity"
|
|
565
|
+
]
|
|
566
|
+
}
|
|
567
|
+
]
|
|
568
|
+
},
|
|
569
|
+
{
|
|
570
|
+
"type": "FUNCTION",
|
|
571
|
+
"name": "apply_components",
|
|
572
|
+
"brief": "Add components to entity\nTo refresh system filters, call world:addEntity(entity) after this function",
|
|
573
|
+
"description": "Add components to entity\nTo refresh system filters, call world:addEntity(entity) after this function",
|
|
574
|
+
"parameters": [
|
|
575
|
+
{
|
|
576
|
+
"name": "entity",
|
|
577
|
+
"doc": "",
|
|
578
|
+
"types": [
|
|
579
|
+
"entity"
|
|
580
|
+
],
|
|
581
|
+
"is_optional": "False",
|
|
582
|
+
"is_vararg": "False"
|
|
583
|
+
},
|
|
584
|
+
{
|
|
585
|
+
"name": "components",
|
|
586
|
+
"doc": "",
|
|
587
|
+
"types": [
|
|
588
|
+
"LuaTable<string, unknown> | undefined"
|
|
589
|
+
],
|
|
590
|
+
"is_optional": "False",
|
|
591
|
+
"is_vararg": "False"
|
|
592
|
+
}
|
|
593
|
+
],
|
|
594
|
+
"returnvalues": [
|
|
595
|
+
{
|
|
596
|
+
"name": "",
|
|
597
|
+
"doc": "",
|
|
598
|
+
"types": [
|
|
599
|
+
"entity"
|
|
600
|
+
]
|
|
601
|
+
}
|
|
602
|
+
]
|
|
603
|
+
},
|
|
604
|
+
{
|
|
605
|
+
"type": "FUNCTION",
|
|
606
|
+
"name": "get_entity_by_id",
|
|
607
|
+
"brief": "",
|
|
608
|
+
"description": "",
|
|
609
|
+
"parameters": [
|
|
610
|
+
{
|
|
611
|
+
"name": "world",
|
|
612
|
+
"doc": "",
|
|
613
|
+
"types": [
|
|
614
|
+
"world"
|
|
615
|
+
],
|
|
616
|
+
"is_optional": "False",
|
|
617
|
+
"is_vararg": "False"
|
|
618
|
+
},
|
|
619
|
+
{
|
|
620
|
+
"name": "id",
|
|
621
|
+
"doc": "",
|
|
622
|
+
"types": [
|
|
623
|
+
"number"
|
|
624
|
+
],
|
|
625
|
+
"is_optional": "False",
|
|
626
|
+
"is_vararg": "False"
|
|
627
|
+
}
|
|
628
|
+
],
|
|
629
|
+
"returnvalues": [
|
|
630
|
+
{
|
|
631
|
+
"name": "",
|
|
632
|
+
"doc": "",
|
|
633
|
+
"types": [
|
|
634
|
+
"entity | undefined"
|
|
635
|
+
]
|
|
636
|
+
}
|
|
637
|
+
]
|
|
638
|
+
},
|
|
639
|
+
{
|
|
640
|
+
"type": "FUNCTION",
|
|
641
|
+
"name": "find_entities",
|
|
642
|
+
"brief": "Return all entities with component_id equal to component_value or all entities with component_id if component_value is nil.\nIt looks for component_id in entity and entityToChange tables",
|
|
643
|
+
"description": "Return all entities with component_id equal to component_value or all entities with component_id if component_value is nil.\nIt looks for component_id in entity and entityToChange tables",
|
|
644
|
+
"parameters": [
|
|
645
|
+
{
|
|
646
|
+
"name": "world",
|
|
647
|
+
"doc": "",
|
|
648
|
+
"types": [
|
|
649
|
+
"world"
|
|
650
|
+
],
|
|
651
|
+
"is_optional": "False",
|
|
652
|
+
"is_vararg": "False"
|
|
653
|
+
},
|
|
654
|
+
{
|
|
655
|
+
"name": "component_id",
|
|
656
|
+
"doc": "",
|
|
657
|
+
"types": [
|
|
658
|
+
"string"
|
|
659
|
+
],
|
|
660
|
+
"is_optional": "False",
|
|
661
|
+
"is_vararg": "False"
|
|
662
|
+
},
|
|
663
|
+
{
|
|
664
|
+
"name": "component_value",
|
|
665
|
+
"doc": "if nil, return all entities with component_id",
|
|
666
|
+
"types": [
|
|
667
|
+
"unknown | undefined"
|
|
668
|
+
],
|
|
669
|
+
"is_optional": "False",
|
|
670
|
+
"is_vararg": "False"
|
|
671
|
+
}
|
|
672
|
+
],
|
|
673
|
+
"returnvalues": [
|
|
674
|
+
{
|
|
675
|
+
"name": "",
|
|
676
|
+
"doc": "",
|
|
677
|
+
"types": [
|
|
678
|
+
"entity[]"
|
|
679
|
+
]
|
|
680
|
+
}
|
|
681
|
+
]
|
|
682
|
+
},
|
|
683
|
+
{
|
|
684
|
+
"type": "FUNCTION",
|
|
685
|
+
"name": "print_loaded_packs_debug_info",
|
|
686
|
+
"brief": "Log all loaded packs for entities, components and worlds",
|
|
687
|
+
"description": "Log all loaded packs for entities, components and worlds",
|
|
688
|
+
"parameters": [],
|
|
689
|
+
"returnvalues": []
|
|
690
|
+
},
|
|
691
|
+
{
|
|
692
|
+
"type": "FUNCTION",
|
|
693
|
+
"name": "print_loaded_systems_debug_info",
|
|
694
|
+
"brief": "Log all loaded systems",
|
|
695
|
+
"description": "Log all loaded systems",
|
|
696
|
+
"parameters": [
|
|
697
|
+
{
|
|
698
|
+
"name": "world",
|
|
699
|
+
"doc": "",
|
|
700
|
+
"types": [
|
|
701
|
+
"world"
|
|
702
|
+
],
|
|
703
|
+
"is_optional": "False",
|
|
704
|
+
"is_vararg": "False"
|
|
705
|
+
}
|
|
706
|
+
],
|
|
707
|
+
"returnvalues": []
|
|
708
|
+
},
|
|
709
|
+
{
|
|
710
|
+
"type": "FUNCTION",
|
|
711
|
+
"name": "set_logger",
|
|
712
|
+
"brief": "",
|
|
713
|
+
"description": "",
|
|
714
|
+
"parameters": [
|
|
715
|
+
{
|
|
716
|
+
"name": "logger_instance",
|
|
717
|
+
"doc": "",
|
|
718
|
+
"types": [
|
|
719
|
+
"decore_logger | LuaTable | undefined"
|
|
720
|
+
],
|
|
721
|
+
"is_optional": "False",
|
|
722
|
+
"is_vararg": "False"
|
|
723
|
+
}
|
|
724
|
+
],
|
|
725
|
+
"returnvalues": []
|
|
726
|
+
},
|
|
727
|
+
{
|
|
728
|
+
"type": "FUNCTION",
|
|
729
|
+
"name": "get_logger",
|
|
730
|
+
"brief": "",
|
|
731
|
+
"description": "",
|
|
732
|
+
"parameters": [
|
|
733
|
+
{
|
|
734
|
+
"name": "name",
|
|
735
|
+
"doc": "",
|
|
736
|
+
"types": [
|
|
737
|
+
"string | undefined"
|
|
738
|
+
],
|
|
739
|
+
"is_optional": "False",
|
|
740
|
+
"is_vararg": "False"
|
|
741
|
+
},
|
|
742
|
+
{
|
|
743
|
+
"name": "level",
|
|
744
|
+
"doc": "",
|
|
745
|
+
"types": [
|
|
746
|
+
"string | undefined"
|
|
747
|
+
],
|
|
748
|
+
"is_optional": "False",
|
|
749
|
+
"is_vararg": "False"
|
|
750
|
+
}
|
|
751
|
+
],
|
|
752
|
+
"returnvalues": [
|
|
753
|
+
{
|
|
754
|
+
"name": "",
|
|
755
|
+
"doc": "",
|
|
756
|
+
"types": [
|
|
757
|
+
"decore_logger"
|
|
758
|
+
]
|
|
759
|
+
}
|
|
760
|
+
]
|
|
761
|
+
},
|
|
762
|
+
{
|
|
763
|
+
"type": "TYPEDEF",
|
|
764
|
+
"name": "world",
|
|
765
|
+
"properties": [
|
|
766
|
+
{
|
|
767
|
+
"name": "event_bus",
|
|
768
|
+
"brief": "",
|
|
769
|
+
"description": "",
|
|
770
|
+
"types": [
|
|
771
|
+
"decore_event_bus"
|
|
772
|
+
]
|
|
773
|
+
},
|
|
774
|
+
{
|
|
775
|
+
"name": "entities",
|
|
776
|
+
"brief": "",
|
|
777
|
+
"description": "",
|
|
778
|
+
"types": [
|
|
779
|
+
"entity[]"
|
|
780
|
+
]
|
|
781
|
+
},
|
|
782
|
+
{
|
|
783
|
+
"name": "systems",
|
|
784
|
+
"brief": "",
|
|
785
|
+
"description": "",
|
|
786
|
+
"types": [
|
|
787
|
+
"system[]"
|
|
788
|
+
]
|
|
789
|
+
},
|
|
790
|
+
{
|
|
791
|
+
"name": "speed",
|
|
792
|
+
"brief": "Koef for delta time",
|
|
793
|
+
"description": "Koef for delta time",
|
|
794
|
+
"types": [
|
|
795
|
+
"number | undefined"
|
|
796
|
+
]
|
|
797
|
+
},
|
|
798
|
+
{
|
|
799
|
+
"name": "add",
|
|
800
|
+
"brief": "",
|
|
801
|
+
"description": "",
|
|
802
|
+
"types": [
|
|
803
|
+
"(self: world, ...args: unknown[]) => unknown"
|
|
804
|
+
]
|
|
805
|
+
},
|
|
806
|
+
{
|
|
807
|
+
"name": "addEntity",
|
|
808
|
+
"brief": "",
|
|
809
|
+
"description": "",
|
|
810
|
+
"types": [
|
|
811
|
+
"(self: world, entity: entity) => entity"
|
|
812
|
+
]
|
|
813
|
+
},
|
|
814
|
+
{
|
|
815
|
+
"name": "addSystem",
|
|
816
|
+
"brief": "",
|
|
817
|
+
"description": "",
|
|
818
|
+
"types": [
|
|
819
|
+
"(self: world, system: system) => system"
|
|
820
|
+
]
|
|
821
|
+
},
|
|
822
|
+
{
|
|
823
|
+
"name": "remove",
|
|
824
|
+
"brief": "",
|
|
825
|
+
"description": "",
|
|
826
|
+
"types": [
|
|
827
|
+
"(self: world, ...args: unknown[]) => void"
|
|
828
|
+
]
|
|
829
|
+
},
|
|
830
|
+
{
|
|
831
|
+
"name": "removeEntity",
|
|
832
|
+
"brief": "",
|
|
833
|
+
"description": "",
|
|
834
|
+
"types": [
|
|
835
|
+
"(self: world, entity: entity) => entity"
|
|
836
|
+
]
|
|
837
|
+
},
|
|
838
|
+
{
|
|
839
|
+
"name": "removeSystem",
|
|
840
|
+
"brief": "",
|
|
841
|
+
"description": "",
|
|
842
|
+
"types": [
|
|
843
|
+
"(self: world, system: system) => system"
|
|
844
|
+
]
|
|
845
|
+
},
|
|
846
|
+
{
|
|
847
|
+
"name": "refresh",
|
|
848
|
+
"brief": "",
|
|
849
|
+
"description": "",
|
|
850
|
+
"types": [
|
|
851
|
+
"(self: world) => void"
|
|
852
|
+
]
|
|
853
|
+
},
|
|
854
|
+
{
|
|
855
|
+
"name": "update",
|
|
856
|
+
"brief": "",
|
|
857
|
+
"description": "",
|
|
858
|
+
"types": [
|
|
859
|
+
"(self: world, dt: number, filter: (() => void) | undefined) => void"
|
|
860
|
+
]
|
|
861
|
+
},
|
|
862
|
+
{
|
|
863
|
+
"name": "fixed_update",
|
|
864
|
+
"brief": "",
|
|
865
|
+
"description": "",
|
|
866
|
+
"types": [
|
|
867
|
+
"(self: world, dt: number, filter: (() => void) | undefined) => void"
|
|
868
|
+
]
|
|
869
|
+
},
|
|
870
|
+
{
|
|
871
|
+
"name": "late_update",
|
|
872
|
+
"brief": "",
|
|
873
|
+
"description": "",
|
|
874
|
+
"types": [
|
|
875
|
+
"(self: world, dt: number, filter: (() => void) | undefined) => void"
|
|
876
|
+
]
|
|
877
|
+
},
|
|
878
|
+
{
|
|
879
|
+
"name": "clearEntities",
|
|
880
|
+
"brief": "",
|
|
881
|
+
"description": "",
|
|
882
|
+
"types": [
|
|
883
|
+
"(self: world) => void"
|
|
884
|
+
]
|
|
885
|
+
},
|
|
886
|
+
{
|
|
887
|
+
"name": "clearSystems",
|
|
888
|
+
"brief": "",
|
|
889
|
+
"description": "",
|
|
890
|
+
"types": [
|
|
891
|
+
"(self: world) => void"
|
|
892
|
+
]
|
|
893
|
+
},
|
|
894
|
+
{
|
|
895
|
+
"name": "getEntityCount",
|
|
896
|
+
"brief": "",
|
|
897
|
+
"description": "",
|
|
898
|
+
"types": [
|
|
899
|
+
"(self: world) => void"
|
|
900
|
+
]
|
|
901
|
+
},
|
|
902
|
+
{
|
|
903
|
+
"name": "getSystemCount",
|
|
904
|
+
"brief": "",
|
|
905
|
+
"description": "",
|
|
906
|
+
"types": [
|
|
907
|
+
"(self: world) => void"
|
|
908
|
+
]
|
|
909
|
+
},
|
|
910
|
+
{
|
|
911
|
+
"name": "setSystemIndex",
|
|
912
|
+
"brief": "",
|
|
913
|
+
"description": "",
|
|
914
|
+
"types": [
|
|
915
|
+
"(self: world) => void"
|
|
916
|
+
]
|
|
917
|
+
},
|
|
918
|
+
{
|
|
919
|
+
"name": "entitiesToChange",
|
|
920
|
+
"brief": "",
|
|
921
|
+
"description": "",
|
|
922
|
+
"types": [
|
|
923
|
+
"entity[]"
|
|
924
|
+
]
|
|
925
|
+
},
|
|
926
|
+
{
|
|
927
|
+
"name": "entitiesToRemove",
|
|
928
|
+
"brief": "",
|
|
929
|
+
"description": "",
|
|
930
|
+
"types": [
|
|
931
|
+
"entity[]"
|
|
932
|
+
]
|
|
933
|
+
},
|
|
934
|
+
{
|
|
935
|
+
"name": "systemsToChange",
|
|
936
|
+
"brief": "",
|
|
937
|
+
"description": "",
|
|
938
|
+
"types": [
|
|
939
|
+
"system[]"
|
|
940
|
+
]
|
|
941
|
+
},
|
|
942
|
+
{
|
|
943
|
+
"name": "systemsToAdd",
|
|
944
|
+
"brief": "",
|
|
945
|
+
"description": "",
|
|
946
|
+
"types": [
|
|
947
|
+
"system[]"
|
|
948
|
+
]
|
|
949
|
+
},
|
|
950
|
+
{
|
|
951
|
+
"name": "systemsToRemove",
|
|
952
|
+
"brief": "",
|
|
953
|
+
"description": "",
|
|
954
|
+
"types": [
|
|
955
|
+
"system[]"
|
|
956
|
+
]
|
|
957
|
+
},
|
|
958
|
+
{
|
|
959
|
+
"name": "findEntities",
|
|
960
|
+
"brief": "",
|
|
961
|
+
"description": "",
|
|
962
|
+
"types": [
|
|
963
|
+
"(world: world, component_id: string, component_value: unknown | undefined) => entity[]"
|
|
964
|
+
]
|
|
965
|
+
},
|
|
966
|
+
{
|
|
967
|
+
"name": "findEntity",
|
|
968
|
+
"brief": "",
|
|
969
|
+
"description": "",
|
|
970
|
+
"types": [
|
|
971
|
+
"(world: world, component_id: string, component_value: unknown | undefined) => entity | undefined"
|
|
972
|
+
]
|
|
973
|
+
}
|
|
974
|
+
]
|
|
975
|
+
},
|
|
976
|
+
{
|
|
977
|
+
"type": "TYPEDEF",
|
|
978
|
+
"name": "decore"
|
|
979
|
+
},
|
|
980
|
+
{
|
|
981
|
+
"type": "TYPEDEF",
|
|
982
|
+
"name": "decore_logger",
|
|
983
|
+
"properties": [
|
|
984
|
+
{
|
|
985
|
+
"name": "trace",
|
|
986
|
+
"brief": "",
|
|
987
|
+
"description": "",
|
|
988
|
+
"types": [
|
|
989
|
+
"(_: unknown, msg: string, data: unknown) => void"
|
|
990
|
+
]
|
|
991
|
+
},
|
|
992
|
+
{
|
|
993
|
+
"name": "debug",
|
|
994
|
+
"brief": "",
|
|
995
|
+
"description": "",
|
|
996
|
+
"types": [
|
|
997
|
+
"(_: unknown, msg: string, data: unknown) => void"
|
|
998
|
+
]
|
|
999
|
+
},
|
|
1000
|
+
{
|
|
1001
|
+
"name": "info",
|
|
1002
|
+
"brief": "",
|
|
1003
|
+
"description": "",
|
|
1004
|
+
"types": [
|
|
1005
|
+
"(_: unknown, msg: string, data: unknown) => void"
|
|
1006
|
+
]
|
|
1007
|
+
},
|
|
1008
|
+
{
|
|
1009
|
+
"name": "warn",
|
|
1010
|
+
"brief": "",
|
|
1011
|
+
"description": "",
|
|
1012
|
+
"types": [
|
|
1013
|
+
"(_: unknown, msg: string, data: unknown) => void"
|
|
1014
|
+
]
|
|
1015
|
+
},
|
|
1016
|
+
{
|
|
1017
|
+
"name": "error",
|
|
1018
|
+
"brief": "",
|
|
1019
|
+
"description": "",
|
|
1020
|
+
"types": [
|
|
1021
|
+
"(_: unknown, msg: string, data: unknown) => void"
|
|
1022
|
+
]
|
|
1023
|
+
}
|
|
1024
|
+
]
|
|
1025
|
+
},
|
|
1026
|
+
{
|
|
1027
|
+
"type": "TYPEDEF",
|
|
1028
|
+
"name": "decore_components_data",
|
|
1029
|
+
"properties": [
|
|
1030
|
+
{
|
|
1031
|
+
"name": "pack_id",
|
|
1032
|
+
"brief": "",
|
|
1033
|
+
"description": "",
|
|
1034
|
+
"types": [
|
|
1035
|
+
"string"
|
|
1036
|
+
]
|
|
1037
|
+
},
|
|
1038
|
+
{
|
|
1039
|
+
"name": "components",
|
|
1040
|
+
"brief": "",
|
|
1041
|
+
"description": "",
|
|
1042
|
+
"types": [
|
|
1043
|
+
"LuaTable<string, unknown>"
|
|
1044
|
+
]
|
|
1045
|
+
}
|
|
1046
|
+
]
|
|
1047
|
+
},
|
|
1048
|
+
{
|
|
1049
|
+
"type": "TYPEDEF",
|
|
1050
|
+
"name": "entity",
|
|
1051
|
+
"properties": [
|
|
1052
|
+
{
|
|
1053
|
+
"name": "id",
|
|
1054
|
+
"brief": "Unique entity id, autofilled by decore.create_entity",
|
|
1055
|
+
"description": "Unique entity id, autofilled by decore.create_entity",
|
|
1056
|
+
"types": [
|
|
1057
|
+
"number | undefined"
|
|
1058
|
+
]
|
|
1059
|
+
},
|
|
1060
|
+
{
|
|
1061
|
+
"name": "prefab_id",
|
|
1062
|
+
"brief": "The entity id from decore collections, autofilled by decore.create_entity",
|
|
1063
|
+
"description": "The entity id from decore collections, autofilled by decore.create_entity",
|
|
1064
|
+
"types": [
|
|
1065
|
+
"string | undefined"
|
|
1066
|
+
]
|
|
1067
|
+
},
|
|
1068
|
+
{
|
|
1069
|
+
"name": "pack_id",
|
|
1070
|
+
"brief": "The entity id from decore collections, autofilled by decore.create_entity",
|
|
1071
|
+
"description": "The entity id from decore collections, autofilled by decore.create_entity",
|
|
1072
|
+
"types": [
|
|
1073
|
+
"string | undefined"
|
|
1074
|
+
]
|
|
1075
|
+
},
|
|
1076
|
+
{
|
|
1077
|
+
"name": "parent_prefab_id",
|
|
1078
|
+
"brief": "The parent prefab_id, used for prefab inheritance",
|
|
1079
|
+
"description": "The parent prefab_id, used for prefab inheritance",
|
|
1080
|
+
"types": [
|
|
1081
|
+
"string | undefined"
|
|
1082
|
+
]
|
|
1083
|
+
},
|
|
1084
|
+
{
|
|
1085
|
+
"name": "child_instancies",
|
|
1086
|
+
"brief": "The child instances to spawn on entity creation",
|
|
1087
|
+
"description": "The child instances to spawn on entity creation",
|
|
1088
|
+
"types": [
|
|
1089
|
+
"entity | undefined"
|
|
1090
|
+
]
|
|
1091
|
+
},
|
|
1092
|
+
{
|
|
1093
|
+
"name": "parent_id",
|
|
1094
|
+
"brief": "The parent id",
|
|
1095
|
+
"description": "The parent id",
|
|
1096
|
+
"types": [
|
|
1097
|
+
"number | undefined"
|
|
1098
|
+
]
|
|
1099
|
+
},
|
|
1100
|
+
{
|
|
1101
|
+
"name": "children_ids",
|
|
1102
|
+
"brief": "The children ids",
|
|
1103
|
+
"description": "The children ids",
|
|
1104
|
+
"types": [
|
|
1105
|
+
"number[] | undefined"
|
|
1106
|
+
]
|
|
1107
|
+
}
|
|
1108
|
+
]
|
|
1109
|
+
},
|
|
1110
|
+
{
|
|
1111
|
+
"type": "TYPEDEF",
|
|
1112
|
+
"name": "system_decore",
|
|
1113
|
+
"functions": [
|
|
1114
|
+
{
|
|
1115
|
+
"type": "FUNCTION",
|
|
1116
|
+
"name": "onAddToWorld",
|
|
1117
|
+
"brief": "",
|
|
1118
|
+
"description": "",
|
|
1119
|
+
"parameters": [
|
|
1120
|
+
{
|
|
1121
|
+
"name": "world",
|
|
1122
|
+
"doc": "",
|
|
1123
|
+
"types": [
|
|
1124
|
+
"world"
|
|
1125
|
+
],
|
|
1126
|
+
"is_optional": "False",
|
|
1127
|
+
"is_vararg": "False"
|
|
1128
|
+
}
|
|
1129
|
+
],
|
|
1130
|
+
"returnvalues": []
|
|
1131
|
+
},
|
|
1132
|
+
{
|
|
1133
|
+
"type": "FUNCTION",
|
|
1134
|
+
"name": "onRemoveFromWorld",
|
|
1135
|
+
"brief": "",
|
|
1136
|
+
"description": "",
|
|
1137
|
+
"parameters": [
|
|
1138
|
+
{
|
|
1139
|
+
"name": "world",
|
|
1140
|
+
"doc": "",
|
|
1141
|
+
"types": [
|
|
1142
|
+
"world"
|
|
1143
|
+
],
|
|
1144
|
+
"is_optional": "False",
|
|
1145
|
+
"is_vararg": "False"
|
|
1146
|
+
}
|
|
1147
|
+
],
|
|
1148
|
+
"returnvalues": []
|
|
1149
|
+
},
|
|
1150
|
+
{
|
|
1151
|
+
"type": "FUNCTION",
|
|
1152
|
+
"name": "onAdd",
|
|
1153
|
+
"brief": "",
|
|
1154
|
+
"description": "",
|
|
1155
|
+
"parameters": [
|
|
1156
|
+
{
|
|
1157
|
+
"name": "entity",
|
|
1158
|
+
"doc": "",
|
|
1159
|
+
"types": [
|
|
1160
|
+
"entity"
|
|
1161
|
+
],
|
|
1162
|
+
"is_optional": "False",
|
|
1163
|
+
"is_vararg": "False"
|
|
1164
|
+
}
|
|
1165
|
+
],
|
|
1166
|
+
"returnvalues": []
|
|
1167
|
+
},
|
|
1168
|
+
{
|
|
1169
|
+
"type": "FUNCTION",
|
|
1170
|
+
"name": "onRemove",
|
|
1171
|
+
"brief": "",
|
|
1172
|
+
"description": "",
|
|
1173
|
+
"parameters": [
|
|
1174
|
+
{
|
|
1175
|
+
"name": "entity",
|
|
1176
|
+
"doc": "",
|
|
1177
|
+
"types": [
|
|
1178
|
+
"entity"
|
|
1179
|
+
],
|
|
1180
|
+
"is_optional": "False",
|
|
1181
|
+
"is_vararg": "False"
|
|
1182
|
+
}
|
|
1183
|
+
],
|
|
1184
|
+
"returnvalues": []
|
|
1185
|
+
},
|
|
1186
|
+
{
|
|
1187
|
+
"type": "FUNCTION",
|
|
1188
|
+
"name": "spawn_children",
|
|
1189
|
+
"brief": "",
|
|
1190
|
+
"description": "",
|
|
1191
|
+
"parameters": [
|
|
1192
|
+
{
|
|
1193
|
+
"name": "entity",
|
|
1194
|
+
"doc": "",
|
|
1195
|
+
"types": [
|
|
1196
|
+
"entity"
|
|
1197
|
+
],
|
|
1198
|
+
"is_optional": "False",
|
|
1199
|
+
"is_vararg": "False"
|
|
1200
|
+
}
|
|
1201
|
+
],
|
|
1202
|
+
"returnvalues": []
|
|
1203
|
+
},
|
|
1204
|
+
{
|
|
1205
|
+
"type": "FUNCTION",
|
|
1206
|
+
"name": "remove_children",
|
|
1207
|
+
"brief": "",
|
|
1208
|
+
"description": "",
|
|
1209
|
+
"parameters": [
|
|
1210
|
+
{
|
|
1211
|
+
"name": "entity",
|
|
1212
|
+
"doc": "",
|
|
1213
|
+
"types": [
|
|
1214
|
+
"entity"
|
|
1215
|
+
],
|
|
1216
|
+
"is_optional": "False",
|
|
1217
|
+
"is_vararg": "False"
|
|
1218
|
+
}
|
|
1219
|
+
],
|
|
1220
|
+
"returnvalues": []
|
|
1221
|
+
},
|
|
1222
|
+
{
|
|
1223
|
+
"type": "FUNCTION",
|
|
1224
|
+
"name": "remove_from_parent",
|
|
1225
|
+
"brief": "",
|
|
1226
|
+
"description": "",
|
|
1227
|
+
"parameters": [
|
|
1228
|
+
{
|
|
1229
|
+
"name": "entity",
|
|
1230
|
+
"doc": "",
|
|
1231
|
+
"types": [
|
|
1232
|
+
"entity"
|
|
1233
|
+
],
|
|
1234
|
+
"is_optional": "False",
|
|
1235
|
+
"is_vararg": "False"
|
|
1236
|
+
}
|
|
1237
|
+
],
|
|
1238
|
+
"returnvalues": []
|
|
1239
|
+
}
|
|
1240
|
+
],
|
|
1241
|
+
"properties": [
|
|
1242
|
+
{
|
|
1243
|
+
"name": "decore",
|
|
1244
|
+
"brief": "",
|
|
1245
|
+
"description": "",
|
|
1246
|
+
"types": [
|
|
1247
|
+
"decore"
|
|
1248
|
+
]
|
|
1249
|
+
},
|
|
1250
|
+
{
|
|
1251
|
+
"name": "id_to_entity",
|
|
1252
|
+
"brief": "The entity id to entity map",
|
|
1253
|
+
"description": "The entity id to entity map",
|
|
1254
|
+
"types": [
|
|
1255
|
+
"LuaTable<number, entity>"
|
|
1256
|
+
]
|
|
1257
|
+
}
|
|
1258
|
+
]
|
|
1259
|
+
},
|
|
1260
|
+
{
|
|
1261
|
+
"type": "TYPEDEF",
|
|
1262
|
+
"name": "system",
|
|
1263
|
+
"properties": [
|
|
1264
|
+
{
|
|
1265
|
+
"name": "indices",
|
|
1266
|
+
"brief": "Entity index in entities table",
|
|
1267
|
+
"description": "Entity index in entities table",
|
|
1268
|
+
"types": [
|
|
1269
|
+
"LuaTable<entity, number>"
|
|
1270
|
+
]
|
|
1271
|
+
},
|
|
1272
|
+
{
|
|
1273
|
+
"name": "id",
|
|
1274
|
+
"brief": "",
|
|
1275
|
+
"description": "",
|
|
1276
|
+
"types": [
|
|
1277
|
+
"string"
|
|
1278
|
+
]
|
|
1279
|
+
},
|
|
1280
|
+
{
|
|
1281
|
+
"name": "filter",
|
|
1282
|
+
"brief": "",
|
|
1283
|
+
"description": "",
|
|
1284
|
+
"types": [
|
|
1285
|
+
"((self: system, entity: entity) => void) | undefined"
|
|
1286
|
+
]
|
|
1287
|
+
},
|
|
1288
|
+
{
|
|
1289
|
+
"name": "active",
|
|
1290
|
+
"brief": "",
|
|
1291
|
+
"description": "",
|
|
1292
|
+
"types": [
|
|
1293
|
+
"boolean"
|
|
1294
|
+
]
|
|
1295
|
+
},
|
|
1296
|
+
{
|
|
1297
|
+
"name": "world",
|
|
1298
|
+
"brief": "",
|
|
1299
|
+
"description": "",
|
|
1300
|
+
"types": [
|
|
1301
|
+
"world"
|
|
1302
|
+
]
|
|
1303
|
+
},
|
|
1304
|
+
{
|
|
1305
|
+
"name": "entities",
|
|
1306
|
+
"brief": "",
|
|
1307
|
+
"description": "",
|
|
1308
|
+
"types": [
|
|
1309
|
+
"entity[]"
|
|
1310
|
+
]
|
|
1311
|
+
},
|
|
1312
|
+
{
|
|
1313
|
+
"name": "nocache",
|
|
1314
|
+
"brief": "",
|
|
1315
|
+
"description": "",
|
|
1316
|
+
"types": [
|
|
1317
|
+
"boolean"
|
|
1318
|
+
]
|
|
1319
|
+
},
|
|
1320
|
+
{
|
|
1321
|
+
"name": "index",
|
|
1322
|
+
"brief": "",
|
|
1323
|
+
"description": "",
|
|
1324
|
+
"types": [
|
|
1325
|
+
"number"
|
|
1326
|
+
]
|
|
1327
|
+
},
|
|
1328
|
+
{
|
|
1329
|
+
"name": "modified",
|
|
1330
|
+
"brief": "",
|
|
1331
|
+
"description": "",
|
|
1332
|
+
"types": [
|
|
1333
|
+
"boolean"
|
|
1334
|
+
]
|
|
1335
|
+
},
|
|
1336
|
+
{
|
|
1337
|
+
"name": "interval",
|
|
1338
|
+
"brief": "",
|
|
1339
|
+
"description": "",
|
|
1340
|
+
"types": [
|
|
1341
|
+
"number | undefined"
|
|
1342
|
+
]
|
|
1343
|
+
},
|
|
1344
|
+
{
|
|
1345
|
+
"name": "bufferedTime",
|
|
1346
|
+
"brief": "",
|
|
1347
|
+
"description": "",
|
|
1348
|
+
"types": [
|
|
1349
|
+
"number | undefined"
|
|
1350
|
+
]
|
|
1351
|
+
},
|
|
1352
|
+
{
|
|
1353
|
+
"name": "onAdd",
|
|
1354
|
+
"brief": "",
|
|
1355
|
+
"description": "",
|
|
1356
|
+
"types": [
|
|
1357
|
+
"((self: system, entity: entity) => void) | undefined"
|
|
1358
|
+
]
|
|
1359
|
+
},
|
|
1360
|
+
{
|
|
1361
|
+
"name": "onRemove",
|
|
1362
|
+
"brief": "",
|
|
1363
|
+
"description": "",
|
|
1364
|
+
"types": [
|
|
1365
|
+
"((self: system, entity: entity) => void) | undefined"
|
|
1366
|
+
]
|
|
1367
|
+
},
|
|
1368
|
+
{
|
|
1369
|
+
"name": "onModify",
|
|
1370
|
+
"brief": "",
|
|
1371
|
+
"description": "",
|
|
1372
|
+
"types": [
|
|
1373
|
+
"((self: system, dt: number) => void) | undefined"
|
|
1374
|
+
]
|
|
1375
|
+
},
|
|
1376
|
+
{
|
|
1377
|
+
"name": "onAddToWorld",
|
|
1378
|
+
"brief": "",
|
|
1379
|
+
"description": "",
|
|
1380
|
+
"types": [
|
|
1381
|
+
"((self: system, world: world) => void) | undefined"
|
|
1382
|
+
]
|
|
1383
|
+
},
|
|
1384
|
+
{
|
|
1385
|
+
"name": "onRemoveFromWorld",
|
|
1386
|
+
"brief": "",
|
|
1387
|
+
"description": "",
|
|
1388
|
+
"types": [
|
|
1389
|
+
"((self: system, world: world) => void) | undefined"
|
|
1390
|
+
]
|
|
1391
|
+
},
|
|
1392
|
+
{
|
|
1393
|
+
"name": "preWrap",
|
|
1394
|
+
"brief": "",
|
|
1395
|
+
"description": "",
|
|
1396
|
+
"types": [
|
|
1397
|
+
"((system: system, dt: number) => void) | undefined"
|
|
1398
|
+
]
|
|
1399
|
+
},
|
|
1400
|
+
{
|
|
1401
|
+
"name": "postWrap",
|
|
1402
|
+
"brief": "",
|
|
1403
|
+
"description": "",
|
|
1404
|
+
"types": [
|
|
1405
|
+
"((system: system, dt: number) => void) | undefined"
|
|
1406
|
+
]
|
|
1407
|
+
},
|
|
1408
|
+
{
|
|
1409
|
+
"name": "update",
|
|
1410
|
+
"brief": "",
|
|
1411
|
+
"description": "",
|
|
1412
|
+
"types": [
|
|
1413
|
+
"((system: system, dt: number) => void) | undefined"
|
|
1414
|
+
]
|
|
1415
|
+
},
|
|
1416
|
+
{
|
|
1417
|
+
"name": "fixed_update",
|
|
1418
|
+
"brief": "",
|
|
1419
|
+
"description": "",
|
|
1420
|
+
"types": [
|
|
1421
|
+
"((system: system, dt: number) => void) | undefined"
|
|
1422
|
+
]
|
|
1423
|
+
},
|
|
1424
|
+
{
|
|
1425
|
+
"name": "late_update",
|
|
1426
|
+
"brief": "",
|
|
1427
|
+
"description": "",
|
|
1428
|
+
"types": [
|
|
1429
|
+
"((system: system, dt: number) => void) | undefined"
|
|
1430
|
+
]
|
|
1431
|
+
},
|
|
1432
|
+
{
|
|
1433
|
+
"name": "preProcess",
|
|
1434
|
+
"brief": "",
|
|
1435
|
+
"description": "",
|
|
1436
|
+
"types": [
|
|
1437
|
+
"((system: system, dt: number) => void) | undefined"
|
|
1438
|
+
]
|
|
1439
|
+
},
|
|
1440
|
+
{
|
|
1441
|
+
"name": "process",
|
|
1442
|
+
"brief": "",
|
|
1443
|
+
"description": "",
|
|
1444
|
+
"types": [
|
|
1445
|
+
"((system: system, entity: entity, dt: number) => void) | undefined"
|
|
1446
|
+
]
|
|
1447
|
+
},
|
|
1448
|
+
{
|
|
1449
|
+
"name": "postProcess",
|
|
1450
|
+
"brief": "",
|
|
1451
|
+
"description": "",
|
|
1452
|
+
"types": [
|
|
1453
|
+
"((system: system, dt: number) => void) | undefined"
|
|
1454
|
+
]
|
|
1455
|
+
},
|
|
1456
|
+
{
|
|
1457
|
+
"name": "compare",
|
|
1458
|
+
"brief": "",
|
|
1459
|
+
"description": "",
|
|
1460
|
+
"types": [
|
|
1461
|
+
"((e1: entity, e2: entity) => void) | undefined"
|
|
1462
|
+
]
|
|
1463
|
+
}
|
|
1464
|
+
]
|
|
1465
|
+
},
|
|
1466
|
+
{
|
|
1467
|
+
"type": "TYPEDEF",
|
|
1468
|
+
"name": "tiny_ecs_Tiny_ECS_module",
|
|
1469
|
+
"properties": [
|
|
1470
|
+
{
|
|
1471
|
+
"name": "requireAll",
|
|
1472
|
+
"brief": "Returns a filter function that requires all of the specified components",
|
|
1473
|
+
"description": "Returns a filter function that requires all of the specified components",
|
|
1474
|
+
"types": [
|
|
1475
|
+
"(...args: unknown[]) => unknown"
|
|
1476
|
+
]
|
|
1477
|
+
},
|
|
1478
|
+
{
|
|
1479
|
+
"name": "requireAny",
|
|
1480
|
+
"brief": "Returns a filter function that requires any of the specified components",
|
|
1481
|
+
"description": "Returns a filter function that requires any of the specified components",
|
|
1482
|
+
"types": [
|
|
1483
|
+
"(...args: unknown[]) => unknown"
|
|
1484
|
+
]
|
|
1485
|
+
},
|
|
1486
|
+
{
|
|
1487
|
+
"name": "rejectAll",
|
|
1488
|
+
"brief": "Returns a filter function that rejects all of the specified components",
|
|
1489
|
+
"description": "Returns a filter function that rejects all of the specified components",
|
|
1490
|
+
"types": [
|
|
1491
|
+
"(...args: unknown[]) => unknown"
|
|
1492
|
+
]
|
|
1493
|
+
},
|
|
1494
|
+
{
|
|
1495
|
+
"name": "rejectAny",
|
|
1496
|
+
"brief": "Returns a filter function that rejects any of the specified components",
|
|
1497
|
+
"description": "Returns a filter function that rejects any of the specified components",
|
|
1498
|
+
"types": [
|
|
1499
|
+
"(...args: unknown[]) => unknown"
|
|
1500
|
+
]
|
|
1501
|
+
},
|
|
1502
|
+
{
|
|
1503
|
+
"name": "filter",
|
|
1504
|
+
"brief": "Returns a filter function that matches the specified pattern",
|
|
1505
|
+
"description": "Returns a filter function that matches the specified pattern",
|
|
1506
|
+
"types": [
|
|
1507
|
+
"(pattern: string) => LuaMultiReturn<[unknown, unknown]>"
|
|
1508
|
+
]
|
|
1509
|
+
},
|
|
1510
|
+
{
|
|
1511
|
+
"name": "system",
|
|
1512
|
+
"brief": "Creates a new system",
|
|
1513
|
+
"description": "Creates a new system",
|
|
1514
|
+
"types": [
|
|
1515
|
+
"(table: system | undefined) => system"
|
|
1516
|
+
]
|
|
1517
|
+
},
|
|
1518
|
+
{
|
|
1519
|
+
"name": "processingSystem",
|
|
1520
|
+
"brief": "Creates a new processing system",
|
|
1521
|
+
"description": "Creates a new processing system",
|
|
1522
|
+
"types": [
|
|
1523
|
+
"(table: system | undefined) => system"
|
|
1524
|
+
]
|
|
1525
|
+
},
|
|
1526
|
+
{
|
|
1527
|
+
"name": "sortedSystem",
|
|
1528
|
+
"brief": "Creates a new sorted system",
|
|
1529
|
+
"description": "Creates a new sorted system",
|
|
1530
|
+
"types": [
|
|
1531
|
+
"(table: system | undefined) => system"
|
|
1532
|
+
]
|
|
1533
|
+
},
|
|
1534
|
+
{
|
|
1535
|
+
"name": "sortedProcessingSystem",
|
|
1536
|
+
"brief": "Creates a new sorted processing system",
|
|
1537
|
+
"description": "Creates a new sorted processing system",
|
|
1538
|
+
"types": [
|
|
1539
|
+
"(table: system | undefined) => system"
|
|
1540
|
+
]
|
|
1541
|
+
},
|
|
1542
|
+
{
|
|
1543
|
+
"name": "world",
|
|
1544
|
+
"brief": "Creates a new world",
|
|
1545
|
+
"description": "Creates a new world",
|
|
1546
|
+
"types": [
|
|
1547
|
+
"(...args: unknown[]) => LuaMultiReturn<[world, unknown]>"
|
|
1548
|
+
]
|
|
1549
|
+
},
|
|
1550
|
+
{
|
|
1551
|
+
"name": "addEntity",
|
|
1552
|
+
"brief": "Adds an entity to the world",
|
|
1553
|
+
"description": "Adds an entity to the world",
|
|
1554
|
+
"types": [
|
|
1555
|
+
"(world: world, entity: entity) => entity"
|
|
1556
|
+
]
|
|
1557
|
+
},
|
|
1558
|
+
{
|
|
1559
|
+
"name": "addSystem",
|
|
1560
|
+
"brief": "Adds a system to the world",
|
|
1561
|
+
"description": "Adds a system to the world",
|
|
1562
|
+
"types": [
|
|
1563
|
+
"(world: world, system: system) => system"
|
|
1564
|
+
]
|
|
1565
|
+
},
|
|
1566
|
+
{
|
|
1567
|
+
"name": "add",
|
|
1568
|
+
"brief": "Adds entities to the world",
|
|
1569
|
+
"description": "Adds entities to the world",
|
|
1570
|
+
"types": [
|
|
1571
|
+
"(world: world, ...args: unknown[]) => unknown"
|
|
1572
|
+
]
|
|
1573
|
+
},
|
|
1574
|
+
{
|
|
1575
|
+
"name": "removeEntity",
|
|
1576
|
+
"brief": "Removes an entity from the world",
|
|
1577
|
+
"description": "Removes an entity from the world",
|
|
1578
|
+
"types": [
|
|
1579
|
+
"(world: world, entity: entity) => entity"
|
|
1580
|
+
]
|
|
1581
|
+
},
|
|
1582
|
+
{
|
|
1583
|
+
"name": "removeSystem",
|
|
1584
|
+
"brief": "Removes a system from the world",
|
|
1585
|
+
"description": "Removes a system from the world",
|
|
1586
|
+
"types": [
|
|
1587
|
+
"(world: world, system: system) => system"
|
|
1588
|
+
]
|
|
1589
|
+
},
|
|
1590
|
+
{
|
|
1591
|
+
"name": "remove",
|
|
1592
|
+
"brief": "Removes entities from the world",
|
|
1593
|
+
"description": "Removes entities from the world",
|
|
1594
|
+
"types": [
|
|
1595
|
+
"(world: world, ...args: unknown[]) => unknown"
|
|
1596
|
+
]
|
|
1597
|
+
},
|
|
1598
|
+
{
|
|
1599
|
+
"name": "refresh",
|
|
1600
|
+
"brief": "Refreshes the world",
|
|
1601
|
+
"description": "Refreshes the world",
|
|
1602
|
+
"types": [
|
|
1603
|
+
"(world: world) => void"
|
|
1604
|
+
]
|
|
1605
|
+
},
|
|
1606
|
+
{
|
|
1607
|
+
"name": "update",
|
|
1608
|
+
"brief": "Updates the world",
|
|
1609
|
+
"description": "Updates the world",
|
|
1610
|
+
"types": [
|
|
1611
|
+
"(world: world, dt: number, filter: ((...args: unknown[]) => void) | undefined) => unknown"
|
|
1612
|
+
]
|
|
1613
|
+
},
|
|
1614
|
+
{
|
|
1615
|
+
"name": "clearEntities",
|
|
1616
|
+
"brief": "Clears all entities from the world",
|
|
1617
|
+
"description": "Clears all entities from the world",
|
|
1618
|
+
"types": [
|
|
1619
|
+
"(world: world) => void"
|
|
1620
|
+
]
|
|
1621
|
+
},
|
|
1622
|
+
{
|
|
1623
|
+
"name": "clearSystems",
|
|
1624
|
+
"brief": "Clears all systems from the world",
|
|
1625
|
+
"description": "Clears all systems from the world",
|
|
1626
|
+
"types": [
|
|
1627
|
+
"(world: world) => void"
|
|
1628
|
+
]
|
|
1629
|
+
},
|
|
1630
|
+
{
|
|
1631
|
+
"name": "getEntityCount",
|
|
1632
|
+
"brief": "Returns the number of entities in the world",
|
|
1633
|
+
"description": "Returns the number of entities in the world",
|
|
1634
|
+
"types": [
|
|
1635
|
+
"(world: world) => number"
|
|
1636
|
+
]
|
|
1637
|
+
},
|
|
1638
|
+
{
|
|
1639
|
+
"name": "getSystemCount",
|
|
1640
|
+
"brief": "Returns the number of systems in the world",
|
|
1641
|
+
"description": "Returns the number of systems in the world",
|
|
1642
|
+
"types": [
|
|
1643
|
+
"(world: world) => number"
|
|
1644
|
+
]
|
|
1645
|
+
},
|
|
1646
|
+
{
|
|
1647
|
+
"name": "setSystemIndex",
|
|
1648
|
+
"brief": "Sets the index of a system in the world",
|
|
1649
|
+
"description": "Sets the index of a system in the world",
|
|
1650
|
+
"types": [
|
|
1651
|
+
"(world: world, system: system, index: number) => number"
|
|
1652
|
+
]
|
|
1653
|
+
}
|
|
1654
|
+
]
|
|
1655
|
+
},
|
|
1656
|
+
{
|
|
1657
|
+
"type": "TYPEDEF",
|
|
1658
|
+
"name": "decore_event_bus",
|
|
1659
|
+
"functions": [
|
|
1660
|
+
{
|
|
1661
|
+
"type": "FUNCTION",
|
|
1662
|
+
"name": "trigger",
|
|
1663
|
+
"brief": "Pushes an event onto the queue, triggering it and processing the queue of callbacks.",
|
|
1664
|
+
"description": "Pushes an event onto the queue, triggering it and processing the queue of callbacks.",
|
|
1665
|
+
"parameters": [
|
|
1666
|
+
{
|
|
1667
|
+
"name": "event_name",
|
|
1668
|
+
"doc": "The name of the event to push onto the queue.",
|
|
1669
|
+
"types": [
|
|
1670
|
+
"string | Hash"
|
|
1671
|
+
],
|
|
1672
|
+
"is_optional": "False",
|
|
1673
|
+
"is_vararg": "False"
|
|
1674
|
+
},
|
|
1675
|
+
{
|
|
1676
|
+
"name": "data",
|
|
1677
|
+
"doc": "The data to pass to the event and its associated callbacks.",
|
|
1678
|
+
"types": [
|
|
1679
|
+
"unknown"
|
|
1680
|
+
],
|
|
1681
|
+
"is_optional": "False",
|
|
1682
|
+
"is_vararg": "False"
|
|
1683
|
+
}
|
|
1684
|
+
],
|
|
1685
|
+
"returnvalues": []
|
|
1686
|
+
},
|
|
1687
|
+
{
|
|
1688
|
+
"type": "FUNCTION",
|
|
1689
|
+
"name": "process",
|
|
1690
|
+
"brief": "Processes a specified event, returning the list of events and optionally calling callback with the full list.",
|
|
1691
|
+
"description": "Processes a specified event, returning the list of events and optionally calling callback with the full list.",
|
|
1692
|
+
"parameters": [
|
|
1693
|
+
{
|
|
1694
|
+
"name": "event_name",
|
|
1695
|
+
"doc": "The name of the event to process.",
|
|
1696
|
+
"types": [
|
|
1697
|
+
"Hash | string"
|
|
1698
|
+
],
|
|
1699
|
+
"is_optional": "False",
|
|
1700
|
+
"is_vararg": "False"
|
|
1701
|
+
},
|
|
1702
|
+
{
|
|
1703
|
+
"name": "callback",
|
|
1704
|
+
"doc": "Optional callback function to execute with the full list of events.",
|
|
1705
|
+
"types": [
|
|
1706
|
+
"((events: unknown[]) => void) | ((context: unknown, events: unknown[]) => void) | undefined"
|
|
1707
|
+
],
|
|
1708
|
+
"is_optional": "False",
|
|
1709
|
+
"is_vararg": "False"
|
|
1710
|
+
},
|
|
1711
|
+
{
|
|
1712
|
+
"name": "context",
|
|
1713
|
+
"doc": "Optional context to pass as first argument to callback.",
|
|
1714
|
+
"types": [
|
|
1715
|
+
"unknown | undefined"
|
|
1716
|
+
],
|
|
1717
|
+
"is_optional": "False",
|
|
1718
|
+
"is_vararg": "False"
|
|
1719
|
+
}
|
|
1720
|
+
],
|
|
1721
|
+
"returnvalues": [
|
|
1722
|
+
{
|
|
1723
|
+
"name": "",
|
|
1724
|
+
"doc": "The list of events, or nil if no events found.",
|
|
1725
|
+
"types": [
|
|
1726
|
+
"unknown[] | undefined"
|
|
1727
|
+
]
|
|
1728
|
+
}
|
|
1729
|
+
]
|
|
1730
|
+
},
|
|
1731
|
+
{
|
|
1732
|
+
"type": "FUNCTION",
|
|
1733
|
+
"name": "process_all",
|
|
1734
|
+
"brief": "",
|
|
1735
|
+
"description": "",
|
|
1736
|
+
"parameters": [],
|
|
1737
|
+
"returnvalues": []
|
|
1738
|
+
},
|
|
1739
|
+
{
|
|
1740
|
+
"type": "FUNCTION",
|
|
1741
|
+
"name": "set_merge_policy",
|
|
1742
|
+
"brief": "You can set the merge policy for an event. This is useful when you want to merge events of the same type.",
|
|
1743
|
+
"description": "You can set the merge policy for an event. This is useful when you want to merge events of the same type.",
|
|
1744
|
+
"parameters": [
|
|
1745
|
+
{
|
|
1746
|
+
"name": "event_name",
|
|
1747
|
+
"doc": "The name of the event to set the merge policy for.",
|
|
1748
|
+
"types": [
|
|
1749
|
+
"string"
|
|
1750
|
+
],
|
|
1751
|
+
"is_optional": "False",
|
|
1752
|
+
"is_vararg": "False"
|
|
1753
|
+
},
|
|
1754
|
+
{
|
|
1755
|
+
"name": "merge_callback",
|
|
1756
|
+
"doc": "The callback function to merge the events. Return true if the events were merged, false otherwise.",
|
|
1757
|
+
"types": [
|
|
1758
|
+
"((new_event: unknown, events: unknown[], entity_map: LuaTable<entity, unknown[]>) => boolean) | undefined"
|
|
1759
|
+
],
|
|
1760
|
+
"is_optional": "False",
|
|
1761
|
+
"is_vararg": "False"
|
|
1762
|
+
}
|
|
1763
|
+
],
|
|
1764
|
+
"returnvalues": []
|
|
1765
|
+
},
|
|
1766
|
+
{
|
|
1767
|
+
"type": "FUNCTION",
|
|
1768
|
+
"name": "clear_events",
|
|
1769
|
+
"brief": "",
|
|
1770
|
+
"description": "",
|
|
1771
|
+
"parameters": [],
|
|
1772
|
+
"returnvalues": []
|
|
1773
|
+
},
|
|
1774
|
+
{
|
|
1775
|
+
"type": "FUNCTION",
|
|
1776
|
+
"name": "stash_to_events",
|
|
1777
|
+
"brief": "",
|
|
1778
|
+
"description": "",
|
|
1779
|
+
"parameters": [],
|
|
1780
|
+
"returnvalues": []
|
|
1781
|
+
},
|
|
1782
|
+
{
|
|
1783
|
+
"type": "FUNCTION",
|
|
1784
|
+
"name": "get_events",
|
|
1785
|
+
"brief": "",
|
|
1786
|
+
"description": "",
|
|
1787
|
+
"parameters": [],
|
|
1788
|
+
"returnvalues": []
|
|
1789
|
+
},
|
|
1790
|
+
{
|
|
1791
|
+
"type": "FUNCTION",
|
|
1792
|
+
"name": "get_stash",
|
|
1793
|
+
"brief": "",
|
|
1794
|
+
"description": "",
|
|
1795
|
+
"parameters": [
|
|
1796
|
+
{
|
|
1797
|
+
"name": "event_name",
|
|
1798
|
+
"doc": "",
|
|
1799
|
+
"types": [
|
|
1800
|
+
"Hash | string"
|
|
1801
|
+
],
|
|
1802
|
+
"is_optional": "False",
|
|
1803
|
+
"is_vararg": "False"
|
|
1804
|
+
}
|
|
1805
|
+
],
|
|
1806
|
+
"returnvalues": [
|
|
1807
|
+
{
|
|
1808
|
+
"name": "",
|
|
1809
|
+
"doc": "",
|
|
1810
|
+
"types": [
|
|
1811
|
+
"LuaTable[] | undefined"
|
|
1812
|
+
]
|
|
1813
|
+
}
|
|
1814
|
+
]
|
|
1815
|
+
}
|
|
1816
|
+
],
|
|
1817
|
+
"properties": [
|
|
1818
|
+
{
|
|
1819
|
+
"name": "events",
|
|
1820
|
+
"brief": "The list of events group by event name. Array part of entities map is the order of entities event's triggers",
|
|
1821
|
+
"description": "The list of events group by event name. Array part of entities map is the order of entities event's triggers",
|
|
1822
|
+
"types": [
|
|
1823
|
+
"LuaTable<string, unknown[]>"
|
|
1824
|
+
]
|
|
1825
|
+
},
|
|
1826
|
+
{
|
|
1827
|
+
"name": "events_by_entity",
|
|
1828
|
+
"brief": "Maps event_name -> entity -> array of events for fast lookup",
|
|
1829
|
+
"description": "Maps event_name -> entity -> array of events for fast lookup",
|
|
1830
|
+
"types": [
|
|
1831
|
+
"LuaTable<string, LuaTable<entity, unknown[]>>"
|
|
1832
|
+
]
|
|
1833
|
+
},
|
|
1834
|
+
{
|
|
1835
|
+
"name": "stash",
|
|
1836
|
+
"brief": "Events to be processed in PostWrap",
|
|
1837
|
+
"description": "Events to be processed in PostWrap",
|
|
1838
|
+
"types": [
|
|
1839
|
+
"LuaTable<string, unknown[]>"
|
|
1840
|
+
]
|
|
1841
|
+
},
|
|
1842
|
+
{
|
|
1843
|
+
"name": "stash_by_entity",
|
|
1844
|
+
"brief": "Maps event_name -> entity -> array of events for stash (fast lookup)",
|
|
1845
|
+
"description": "Maps event_name -> entity -> array of events for stash (fast lookup)",
|
|
1846
|
+
"types": [
|
|
1847
|
+
"LuaTable<string, LuaTable<entity, unknown[]>>"
|
|
1848
|
+
]
|
|
1849
|
+
},
|
|
1850
|
+
{
|
|
1851
|
+
"name": "merge_callbacks",
|
|
1852
|
+
"brief": "The merge policy for events. If the merge policy returns true, the events are merged and not will be added as new event",
|
|
1853
|
+
"description": "The merge policy for events. If the merge policy returns true, the events are merged and not will be added as new event",
|
|
1854
|
+
"types": [
|
|
1855
|
+
"LuaTable<string, (new_event: unknown, events: unknown[], entity_map: LuaTable<entity, unknown[]>) => boolean>"
|
|
1856
|
+
]
|
|
1857
|
+
}
|
|
1858
|
+
]
|
|
1859
|
+
},
|
|
1860
|
+
{
|
|
1861
|
+
"type": "TYPEDEF",
|
|
1862
|
+
"name": "system_bus_event",
|
|
1863
|
+
"functions": [
|
|
1864
|
+
{
|
|
1865
|
+
"type": "FUNCTION",
|
|
1866
|
+
"name": "onAddToWorld",
|
|
1867
|
+
"brief": "",
|
|
1868
|
+
"description": "",
|
|
1869
|
+
"parameters": [],
|
|
1870
|
+
"returnvalues": []
|
|
1871
|
+
},
|
|
1872
|
+
{
|
|
1873
|
+
"type": "FUNCTION",
|
|
1874
|
+
"name": "postWrap",
|
|
1875
|
+
"brief": "",
|
|
1876
|
+
"description": "",
|
|
1877
|
+
"parameters": [],
|
|
1878
|
+
"returnvalues": []
|
|
1879
|
+
}
|
|
1880
|
+
]
|
|
1881
|
+
}
|
|
1882
|
+
]
|
|
1883
|
+
}
|