@defold-typescript/library-types 0.18.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (101) hide show
  1. package/NOTICE +52 -0
  2. package/README.md +78 -0
  3. package/api-doc/boom.boom.json +26 -0
  4. package/api-doc/bridge.bridge.json +1653 -0
  5. package/api-doc/bzAnim.bzLibrary.json +156 -0
  6. package/api-doc/defcon.console.json +109 -0
  7. package/api-doc/defmath.defmath.json +1381 -0
  8. package/api-doc/defsave.defsave.json +175 -0
  9. package/api-doc/deftest.deftest.json +71 -0
  10. package/api-doc/dicebag.dicebag.json +323 -0
  11. package/api-doc/event.event.json +238 -0
  12. package/api-doc/gooey.gooey.json +963 -0
  13. package/api-doc/immutable.immutable.json +63 -0
  14. package/api-doc/in.accelerometer.json +281 -0
  15. package/api-doc/in.button.json +148 -0
  16. package/api-doc/in.cursor.json +203 -0
  17. package/api-doc/in.gesture.json +206 -0
  18. package/api-doc/in.keyboard.json +45 -0
  19. package/api-doc/in.mapper.json +141 -0
  20. package/api-doc/in.onscreen.json +265 -0
  21. package/api-doc/in.state.json +195 -0
  22. package/api-doc/in.textbox.json +213 -0
  23. package/api-doc/in.triggers.json +1260 -0
  24. package/api-doc/lang.lang.json +411 -0
  25. package/api-doc/log.log.json +50 -0
  26. package/api-doc/metrics.fps.json +88 -0
  27. package/api-doc/metrics.mem.json +80 -0
  28. package/api-doc/monarch.monarch.json +1065 -0
  29. package/api-doc/monarch.transitions.easings.json +206 -0
  30. package/api-doc/monarch.transitions.gui.json +445 -0
  31. package/api-doc/nakama.engine.defold.json +165 -0
  32. package/api-doc/nakama.nakama.json +6574 -0
  33. package/api-doc/nakama.util.log.json +25 -0
  34. package/api-doc/narrator.narrator.json +150 -0
  35. package/api-doc/orthographic.camera.json +1019 -0
  36. package/api-doc/persist.persist.json +142 -0
  37. package/api-doc/platypus.platypus.json +631 -0
  38. package/api-doc/proto.proto.json +355 -0
  39. package/api-doc/rendy.rendy.json +408 -0
  40. package/api-doc/richtext.color.json +219 -0
  41. package/api-doc/richtext.richtext.json +382 -0
  42. package/api-doc/richtext.tags.json +67 -0
  43. package/api-doc/saver.saver.json +553 -0
  44. package/api-doc/saver.storage.json +174 -0
  45. package/api-doc/squid.squid.json +660 -0
  46. package/api-doc/starly.starly.json +488 -0
  47. package/api-doc/tweener.tweener.json +419 -0
  48. package/api-doc/yagames.yagames.json +1465 -0
  49. package/api-doc/zzfx.api.json +85 -0
  50. package/generated/boom.boom.d.ts +1585 -0
  51. package/generated/bridge.bridge.d.ts +533 -0
  52. package/generated/bzAnim.bzLibrary.d.ts +93 -0
  53. package/generated/defcon.console.d.ts +24 -0
  54. package/generated/defmath.defmath.d.ts +194 -0
  55. package/generated/defsave.defsave.d.ts +31 -0
  56. package/generated/deftest.deftest.d.ts +47 -0
  57. package/generated/dicebag.dicebag.d.ts +90 -0
  58. package/generated/event.event.d.ts +54 -0
  59. package/generated/gooey.gooey.d.ts +261 -0
  60. package/generated/immutable.immutable.d.ts +13 -0
  61. package/generated/in.accelerometer.d.ts +37 -0
  62. package/generated/in.button.d.ts +20 -0
  63. package/generated/in.cursor.d.ts +33 -0
  64. package/generated/in.gesture.d.ts +64 -0
  65. package/generated/in.keyboard.d.ts +18 -0
  66. package/generated/in.mapper.d.ts +23 -0
  67. package/generated/in.onscreen.d.ts +58 -0
  68. package/generated/in.state.d.ts +34 -0
  69. package/generated/in.textbox.d.ts +26 -0
  70. package/generated/in.triggers.d.ts +180 -0
  71. package/generated/lang.lang.d.ts +33 -0
  72. package/generated/log.log.d.ts +40 -0
  73. package/generated/metrics.fps.d.ts +16 -0
  74. package/generated/metrics.mem.d.ts +16 -0
  75. package/generated/monarch.monarch.d.ts +412 -0
  76. package/generated/monarch.transitions.easings.d.ts +65 -0
  77. package/generated/monarch.transitions.gui.d.ts +197 -0
  78. package/generated/nakama.engine.defold.d.ts +24 -0
  79. package/generated/nakama.nakama.d.ts +594 -0
  80. package/generated/nakama.util.log.d.ts +10 -0
  81. package/generated/narrator.narrator.d.ts +66 -0
  82. package/generated/orthographic.camera.d.ts +308 -0
  83. package/generated/persist.persist.d.ts +34 -0
  84. package/generated/platypus.platypus.d.ts +76 -0
  85. package/generated/proto.proto.d.ts +36 -0
  86. package/generated/rendy.rendy.d.ts +184 -0
  87. package/generated/richtext.color.d.ts +33 -0
  88. package/generated/richtext.richtext.d.ts +126 -0
  89. package/generated/richtext.tags.d.ts +12 -0
  90. package/generated/saver.saver.d.ts +44 -0
  91. package/generated/saver.storage.d.ts +16 -0
  92. package/generated/squid.squid.d.ts +106 -0
  93. package/generated/starly.starly.d.ts +148 -0
  94. package/generated/tweener.tweener.d.ts +151 -0
  95. package/generated/yagames.yagames.d.ts +279 -0
  96. package/generated/zzfx.api.d.ts +20 -0
  97. package/library-classification.json +726 -0
  98. package/library-targets.json +291 -0
  99. package/package.json +180 -0
  100. package/scripts/extract-api-doc.ts +418 -0
  101. package/scripts/sync-library-types.ts +542 -0
package/api-doc/defmath.defmath.json ADDED
@@ -0,0 +1,1381 @@
1
+ {
2
+ "info": {
3
+ "namespace": "defmath.defmath",
4
+ "brief": "",
5
+ "description": ""
6
+ },
7
+ "elements": [
8
+ {
9
+ "type": "FUNCTION",
10
+ "name": "anglediff_rad",
11
+ "brief": "Angle-Diff (gets the smallest angle between two angles, using radians)",
12
+ "description": "Angle-Diff (gets the smallest angle between two angles, using radians)",
13
+ "parameters": [
14
+ {
15
+ "name": "rad1",
16
+ "doc": "",
17
+ "types": [
18
+ "number"
19
+ ],
20
+ "is_optional": "False"
21
+ },
22
+ {
23
+ "name": "rad2",
24
+ "doc": "",
25
+ "types": [
26
+ "number"
27
+ ],
28
+ "is_optional": "False"
29
+ }
30
+ ],
31
+ "returnvalues": [
32
+ {
33
+ "name": "",
34
+ "doc": "",
35
+ "types": [
36
+ "number"
37
+ ]
38
+ }
39
+ ]
40
+ },
41
+ {
42
+ "type": "FUNCTION",
43
+ "name": "anglediff_deg",
44
+ "brief": "Angle-Diff (gets the smallest angle between two angles, using degrees)",
45
+ "description": "Angle-Diff (gets the smallest angle between two angles, using degrees)",
46
+ "parameters": [
47
+ {
48
+ "name": "deg1",
49
+ "doc": "",
50
+ "types": [
51
+ "number"
52
+ ],
53
+ "is_optional": "False"
54
+ },
55
+ {
56
+ "name": "deg2",
57
+ "doc": "",
58
+ "types": [
59
+ "number"
60
+ ],
61
+ "is_optional": "False"
62
+ }
63
+ ],
64
+ "returnvalues": [
65
+ {
66
+ "name": "",
67
+ "doc": "",
68
+ "types": [
69
+ "number"
70
+ ]
71
+ }
72
+ ]
73
+ },
74
+ {
75
+ "type": "FUNCTION",
76
+ "name": "round",
77
+ "brief": "Round",
78
+ "description": "Round",
79
+ "parameters": [
80
+ {
81
+ "name": "x",
82
+ "doc": "",
83
+ "types": [
84
+ "number"
85
+ ],
86
+ "is_optional": "False"
87
+ }
88
+ ],
89
+ "returnvalues": [
90
+ {
91
+ "name": "",
92
+ "doc": "",
93
+ "types": [
94
+ "number"
95
+ ]
96
+ }
97
+ ]
98
+ },
99
+ {
100
+ "type": "FUNCTION",
101
+ "name": "round_decimal",
102
+ "brief": "Round to decimal point",
103
+ "description": "Round to decimal point",
104
+ "parameters": [
105
+ {
106
+ "name": "number",
107
+ "doc": "",
108
+ "types": [
109
+ "number"
110
+ ],
111
+ "is_optional": "False"
112
+ },
113
+ {
114
+ "name": "decimal",
115
+ "doc": "",
116
+ "types": [
117
+ "number"
118
+ ],
119
+ "is_optional": "False"
120
+ }
121
+ ],
122
+ "returnvalues": [
123
+ {
124
+ "name": "",
125
+ "doc": "",
126
+ "types": [
127
+ "number"
128
+ ]
129
+ }
130
+ ]
131
+ },
132
+ {
133
+ "type": "FUNCTION",
134
+ "name": "clamp",
135
+ "brief": "Clamp",
136
+ "description": "Clamp",
137
+ "parameters": [
138
+ {
139
+ "name": "x",
140
+ "doc": "",
141
+ "types": [
142
+ "number"
143
+ ],
144
+ "is_optional": "False"
145
+ },
146
+ {
147
+ "name": "min",
148
+ "doc": "",
149
+ "types": [
150
+ "number"
151
+ ],
152
+ "is_optional": "False"
153
+ },
154
+ {
155
+ "name": "max",
156
+ "doc": "",
157
+ "types": [
158
+ "number"
159
+ ],
160
+ "is_optional": "False"
161
+ }
162
+ ],
163
+ "returnvalues": [
164
+ {
165
+ "name": "",
166
+ "doc": "",
167
+ "types": [
168
+ "number"
169
+ ]
170
+ }
171
+ ]
172
+ },
173
+ {
174
+ "type": "FUNCTION",
175
+ "name": "sign",
176
+ "brief": "Sign",
177
+ "description": "Sign",
178
+ "parameters": [
179
+ {
180
+ "name": "x",
181
+ "doc": "",
182
+ "types": [
183
+ "number"
184
+ ],
185
+ "is_optional": "False"
186
+ }
187
+ ],
188
+ "returnvalues": [
189
+ {
190
+ "name": "",
191
+ "doc": "",
192
+ "types": [
193
+ "number"
194
+ ]
195
+ }
196
+ ]
197
+ },
198
+ {
199
+ "type": "FUNCTION",
200
+ "name": "same_sign",
201
+ "brief": "Checks if two numbers have the same sign",
202
+ "description": "Checks if two numbers have the same sign",
203
+ "parameters": [
204
+ {
205
+ "name": "a",
206
+ "doc": "",
207
+ "types": [
208
+ "number"
209
+ ],
210
+ "is_optional": "False"
211
+ },
212
+ {
213
+ "name": "b",
214
+ "doc": "",
215
+ "types": [
216
+ "number"
217
+ ],
218
+ "is_optional": "False"
219
+ }
220
+ ],
221
+ "returnvalues": [
222
+ {
223
+ "name": "",
224
+ "doc": "",
225
+ "types": [
226
+ "boolean"
227
+ ]
228
+ }
229
+ ]
230
+ },
231
+ {
232
+ "type": "FUNCTION",
233
+ "name": "vect_to_quat",
234
+ "brief": "Vect to Quat",
235
+ "description": "Vect to Quat",
236
+ "parameters": [
237
+ {
238
+ "name": "vect",
239
+ "doc": "",
240
+ "types": [
241
+ "Vector3 | Vector4"
242
+ ],
243
+ "is_optional": "False"
244
+ }
245
+ ],
246
+ "returnvalues": [
247
+ {
248
+ "name": "",
249
+ "doc": "",
250
+ "types": [
251
+ "Quaternion"
252
+ ]
253
+ }
254
+ ]
255
+ },
256
+ {
257
+ "type": "FUNCTION",
258
+ "name": "vect_to_quat90",
259
+ "brief": "Vect to Quat + 90 degrees (perpendicular)",
260
+ "description": "Vect to Quat + 90 degrees (perpendicular)",
261
+ "parameters": [
262
+ {
263
+ "name": "vect",
264
+ "doc": "",
265
+ "types": [
266
+ "Vector3 | Vector4"
267
+ ],
268
+ "is_optional": "False"
269
+ }
270
+ ],
271
+ "returnvalues": [
272
+ {
273
+ "name": "",
274
+ "doc": "",
275
+ "types": [
276
+ "Quaternion"
277
+ ]
278
+ }
279
+ ]
280
+ },
281
+ {
282
+ "type": "FUNCTION",
283
+ "name": "rand11",
284
+ "brief": "Random float from -1 to 1",
285
+ "description": "Random float from -1 to 1",
286
+ "parameters": [],
287
+ "returnvalues": [
288
+ {
289
+ "name": "",
290
+ "doc": "",
291
+ "types": [
292
+ "number"
293
+ ]
294
+ }
295
+ ]
296
+ },
297
+ {
298
+ "type": "FUNCTION",
299
+ "name": "rand_range",
300
+ "brief": "Random float in range",
301
+ "description": "Random float in range",
302
+ "parameters": [
303
+ {
304
+ "name": "min",
305
+ "doc": "",
306
+ "types": [
307
+ "number"
308
+ ],
309
+ "is_optional": "False"
310
+ },
311
+ {
312
+ "name": "max",
313
+ "doc": "",
314
+ "types": [
315
+ "number"
316
+ ],
317
+ "is_optional": "False"
318
+ }
319
+ ],
320
+ "returnvalues": [
321
+ {
322
+ "name": "",
323
+ "doc": "",
324
+ "types": [
325
+ "number"
326
+ ]
327
+ }
328
+ ]
329
+ },
330
+ {
331
+ "type": "FUNCTION",
332
+ "name": "lerp",
333
+ "brief": "Linear interpolation",
334
+ "description": "Linear interpolation",
335
+ "parameters": [
336
+ {
337
+ "name": "start",
338
+ "doc": "",
339
+ "types": [
340
+ "number"
341
+ ],
342
+ "is_optional": "False"
343
+ },
344
+ {
345
+ "name": "stop",
346
+ "doc": "",
347
+ "types": [
348
+ "number"
349
+ ],
350
+ "is_optional": "False"
351
+ },
352
+ {
353
+ "name": "amount",
354
+ "doc": "",
355
+ "types": [
356
+ "number"
357
+ ],
358
+ "is_optional": "False"
359
+ }
360
+ ],
361
+ "returnvalues": [
362
+ {
363
+ "name": "",
364
+ "doc": "",
365
+ "types": [
366
+ "number"
367
+ ]
368
+ }
369
+ ]
370
+ },
371
+ {
372
+ "type": "FUNCTION",
373
+ "name": "dist2d",
374
+ "brief": "Distance between two 2d points",
375
+ "description": "Distance between two 2d points",
376
+ "parameters": [
377
+ {
378
+ "name": "x1",
379
+ "doc": "",
380
+ "types": [
381
+ "number"
382
+ ],
383
+ "is_optional": "False"
384
+ },
385
+ {
386
+ "name": "y1",
387
+ "doc": "",
388
+ "types": [
389
+ "number"
390
+ ],
391
+ "is_optional": "False"
392
+ },
393
+ {
394
+ "name": "x2",
395
+ "doc": "",
396
+ "types": [
397
+ "number"
398
+ ],
399
+ "is_optional": "False"
400
+ },
401
+ {
402
+ "name": "y2",
403
+ "doc": "",
404
+ "types": [
405
+ "number"
406
+ ],
407
+ "is_optional": "False"
408
+ }
409
+ ],
410
+ "returnvalues": [
411
+ {
412
+ "name": "",
413
+ "doc": "",
414
+ "types": [
415
+ "number"
416
+ ]
417
+ }
418
+ ]
419
+ },
420
+ {
421
+ "type": "FUNCTION",
422
+ "name": "dist3d",
423
+ "brief": "Distance between two 3d points",
424
+ "description": "Distance between two 3d points",
425
+ "parameters": [
426
+ {
427
+ "name": "x1",
428
+ "doc": "",
429
+ "types": [
430
+ "number"
431
+ ],
432
+ "is_optional": "False"
433
+ },
434
+ {
435
+ "name": "y1",
436
+ "doc": "",
437
+ "types": [
438
+ "number"
439
+ ],
440
+ "is_optional": "False"
441
+ },
442
+ {
443
+ "name": "z1",
444
+ "doc": "",
445
+ "types": [
446
+ "number"
447
+ ],
448
+ "is_optional": "False"
449
+ },
450
+ {
451
+ "name": "x2",
452
+ "doc": "",
453
+ "types": [
454
+ "number"
455
+ ],
456
+ "is_optional": "False"
457
+ },
458
+ {
459
+ "name": "y2",
460
+ "doc": "",
461
+ "types": [
462
+ "number"
463
+ ],
464
+ "is_optional": "False"
465
+ },
466
+ {
467
+ "name": "z2",
468
+ "doc": "",
469
+ "types": [
470
+ "number"
471
+ ],
472
+ "is_optional": "False"
473
+ }
474
+ ],
475
+ "returnvalues": [
476
+ {
477
+ "name": "",
478
+ "doc": "",
479
+ "types": [
480
+ "number"
481
+ ]
482
+ }
483
+ ]
484
+ },
485
+ {
486
+ "type": "FUNCTION",
487
+ "name": "angle_of_vector_between_two_points",
488
+ "brief": "Angle in radians of vector between two points",
489
+ "description": "Angle in radians of vector between two points",
490
+ "parameters": [
491
+ {
492
+ "name": "x1",
493
+ "doc": "",
494
+ "types": [
495
+ "number"
496
+ ],
497
+ "is_optional": "False"
498
+ },
499
+ {
500
+ "name": "y1",
501
+ "doc": "",
502
+ "types": [
503
+ "number"
504
+ ],
505
+ "is_optional": "False"
506
+ },
507
+ {
508
+ "name": "x2",
509
+ "doc": "",
510
+ "types": [
511
+ "number"
512
+ ],
513
+ "is_optional": "False"
514
+ },
515
+ {
516
+ "name": "y2",
517
+ "doc": "",
518
+ "types": [
519
+ "number"
520
+ ],
521
+ "is_optional": "False"
522
+ }
523
+ ],
524
+ "returnvalues": [
525
+ {
526
+ "name": "",
527
+ "doc": "",
528
+ "types": [
529
+ "number"
530
+ ]
531
+ }
532
+ ]
533
+ },
534
+ {
535
+ "type": "FUNCTION",
536
+ "name": "setup_rng",
537
+ "brief": "Clears bad RNG and sets seed to be based on OS time",
538
+ "description": "Clears bad RNG and sets seed to be based on OS time",
539
+ "parameters": [],
540
+ "returnvalues": []
541
+ },
542
+ {
543
+ "type": "FUNCTION",
544
+ "name": "is_within_range",
545
+ "brief": "Check if number is within range",
546
+ "description": "Check if number is within range",
547
+ "parameters": [
548
+ {
549
+ "name": "number",
550
+ "doc": "",
551
+ "types": [
552
+ "number"
553
+ ],
554
+ "is_optional": "False"
555
+ },
556
+ {
557
+ "name": "min",
558
+ "doc": "",
559
+ "types": [
560
+ "number"
561
+ ],
562
+ "is_optional": "False"
563
+ },
564
+ {
565
+ "name": "max",
566
+ "doc": "",
567
+ "types": [
568
+ "number"
569
+ ],
570
+ "is_optional": "False"
571
+ }
572
+ ],
573
+ "returnvalues": [
574
+ {
575
+ "name": "",
576
+ "doc": "",
577
+ "types": [
578
+ "boolean"
579
+ ]
580
+ }
581
+ ]
582
+ },
583
+ {
584
+ "type": "FUNCTION",
585
+ "name": "radians_to_degrees",
586
+ "brief": "Convert radians to degrees",
587
+ "description": "Convert radians to degrees",
588
+ "parameters": [
589
+ {
590
+ "name": "radian",
591
+ "doc": "",
592
+ "types": [
593
+ "number"
594
+ ],
595
+ "is_optional": "False"
596
+ }
597
+ ],
598
+ "returnvalues": [
599
+ {
600
+ "name": "",
601
+ "doc": "",
602
+ "types": [
603
+ "number"
604
+ ]
605
+ }
606
+ ]
607
+ },
608
+ {
609
+ "type": "FUNCTION",
610
+ "name": "degrees_to_radians",
611
+ "brief": "Convert degrees to radians",
612
+ "description": "Convert degrees to radians",
613
+ "parameters": [
614
+ {
615
+ "name": "degrees",
616
+ "doc": "",
617
+ "types": [
618
+ "number"
619
+ ],
620
+ "is_optional": "False"
621
+ }
622
+ ],
623
+ "returnvalues": [
624
+ {
625
+ "name": "",
626
+ "doc": "",
627
+ "types": [
628
+ "number"
629
+ ]
630
+ }
631
+ ]
632
+ },
633
+ {
634
+ "type": "FUNCTION",
635
+ "name": "wrap",
636
+ "brief": "Wrap a number to betwen 0 and a range bound",
637
+ "description": "Wrap a number to betwen 0 and a range bound",
638
+ "parameters": [
639
+ {
640
+ "name": "number",
641
+ "doc": "",
642
+ "types": [
643
+ "number"
644
+ ],
645
+ "is_optional": "False"
646
+ },
647
+ {
648
+ "name": "bound",
649
+ "doc": "",
650
+ "types": [
651
+ "number"
652
+ ],
653
+ "is_optional": "False"
654
+ }
655
+ ],
656
+ "returnvalues": [
657
+ {
658
+ "name": "",
659
+ "doc": "",
660
+ "types": [
661
+ "number"
662
+ ]
663
+ }
664
+ ]
665
+ },
666
+ {
667
+ "type": "FUNCTION",
668
+ "name": "bound",
669
+ "brief": "Bound a number so that it is no larger than max and no smaller than min",
670
+ "description": "Bound a number so that it is no larger than max and no smaller than min",
671
+ "parameters": [
672
+ {
673
+ "name": "number",
674
+ "doc": "",
675
+ "types": [
676
+ "number"
677
+ ],
678
+ "is_optional": "False"
679
+ },
680
+ {
681
+ "name": "min",
682
+ "doc": "",
683
+ "types": [
684
+ "number"
685
+ ],
686
+ "is_optional": "False"
687
+ },
688
+ {
689
+ "name": "max",
690
+ "doc": "",
691
+ "types": [
692
+ "number"
693
+ ],
694
+ "is_optional": "False"
695
+ }
696
+ ],
697
+ "returnvalues": [
698
+ {
699
+ "name": "",
700
+ "doc": "",
701
+ "types": [
702
+ "number"
703
+ ]
704
+ }
705
+ ]
706
+ },
707
+ {
708
+ "type": "FUNCTION",
709
+ "name": "bound_add",
710
+ "brief": "Adds an amount to a value within the value going over max or below min",
711
+ "description": "Adds an amount to a value within the value going over max or below min",
712
+ "parameters": [
713
+ {
714
+ "name": "number",
715
+ "doc": "",
716
+ "types": [
717
+ "number"
718
+ ],
719
+ "is_optional": "False"
720
+ },
721
+ {
722
+ "name": "amount",
723
+ "doc": "",
724
+ "types": [
725
+ "number"
726
+ ],
727
+ "is_optional": "False"
728
+ },
729
+ {
730
+ "name": "min",
731
+ "doc": "",
732
+ "types": [
733
+ "number"
734
+ ],
735
+ "is_optional": "False"
736
+ },
737
+ {
738
+ "name": "max",
739
+ "doc": "",
740
+ "types": [
741
+ "number"
742
+ ],
743
+ "is_optional": "False"
744
+ }
745
+ ],
746
+ "returnvalues": [
747
+ {
748
+ "name": "",
749
+ "doc": "",
750
+ "types": [
751
+ "number"
752
+ ]
753
+ }
754
+ ]
755
+ },
756
+ {
757
+ "type": "FUNCTION",
758
+ "name": "sum",
759
+ "brief": "Sums a set of values",
760
+ "description": "Sums a set of values",
761
+ "parameters": [
762
+ {
763
+ "name": "vararg",
764
+ "doc": "",
765
+ "types": [
766
+ "number[]"
767
+ ],
768
+ "is_optional": "False"
769
+ }
770
+ ],
771
+ "returnvalues": [
772
+ {
773
+ "name": "",
774
+ "doc": "",
775
+ "types": [
776
+ "number"
777
+ ]
778
+ }
779
+ ]
780
+ },
781
+ {
782
+ "type": "FUNCTION",
783
+ "name": "average",
784
+ "brief": "Average of set of values",
785
+ "description": "Average of set of values",
786
+ "parameters": [
787
+ {
788
+ "name": "vararg",
789
+ "doc": "",
790
+ "types": [
791
+ "number[]"
792
+ ],
793
+ "is_optional": "False"
794
+ }
795
+ ],
796
+ "returnvalues": [
797
+ {
798
+ "name": "",
799
+ "doc": "",
800
+ "types": [
801
+ "number"
802
+ ]
803
+ }
804
+ ]
805
+ },
806
+ {
807
+ "type": "FUNCTION",
808
+ "name": "difference",
809
+ "brief": "Get difference between two values",
810
+ "description": "Get difference between two values",
811
+ "parameters": [
812
+ {
813
+ "name": "a",
814
+ "doc": "",
815
+ "types": [
816
+ "number"
817
+ ],
818
+ "is_optional": "False"
819
+ },
820
+ {
821
+ "name": "b",
822
+ "doc": "",
823
+ "types": [
824
+ "number"
825
+ ],
826
+ "is_optional": "False"
827
+ }
828
+ ],
829
+ "returnvalues": [
830
+ {
831
+ "name": "",
832
+ "doc": "",
833
+ "types": [
834
+ "number"
835
+ ]
836
+ }
837
+ ]
838
+ },
839
+ {
840
+ "type": "FUNCTION",
841
+ "name": "is_even",
842
+ "brief": "if a number is even",
843
+ "description": "if a number is even",
844
+ "parameters": [
845
+ {
846
+ "name": "number",
847
+ "doc": "",
848
+ "types": [
849
+ "number"
850
+ ],
851
+ "is_optional": "False"
852
+ }
853
+ ],
854
+ "returnvalues": [
855
+ {
856
+ "name": "",
857
+ "doc": "",
858
+ "types": [
859
+ "boolean"
860
+ ]
861
+ }
862
+ ]
863
+ },
864
+ {
865
+ "type": "FUNCTION",
866
+ "name": "is_odd",
867
+ "brief": "if a number is odd",
868
+ "description": "if a number is odd",
869
+ "parameters": [
870
+ {
871
+ "name": "number",
872
+ "doc": "",
873
+ "types": [
874
+ "number"
875
+ ],
876
+ "is_optional": "False"
877
+ }
878
+ ],
879
+ "returnvalues": [
880
+ {
881
+ "name": "",
882
+ "doc": "",
883
+ "types": [
884
+ "boolean"
885
+ ]
886
+ }
887
+ ]
888
+ },
889
+ {
890
+ "type": "FUNCTION",
891
+ "name": "wrap_angle",
892
+ "brief": "Wrap an angle between -180 and +180",
893
+ "description": "Wrap an angle between -180 and +180",
894
+ "parameters": [
895
+ {
896
+ "name": "angle",
897
+ "doc": "",
898
+ "types": [
899
+ "number"
900
+ ],
901
+ "is_optional": "False"
902
+ }
903
+ ],
904
+ "returnvalues": [
905
+ {
906
+ "name": "",
907
+ "doc": "",
908
+ "types": [
909
+ "number"
910
+ ]
911
+ }
912
+ ]
913
+ },
914
+ {
915
+ "type": "FUNCTION",
916
+ "name": "angle_between_vectors",
917
+ "brief": "Angle between vmath vectors in radians",
918
+ "description": "Angle between vmath vectors in radians",
919
+ "parameters": [
920
+ {
921
+ "name": "vector1",
922
+ "doc": "",
923
+ "types": [
924
+ "Vector3 | Vector4"
925
+ ],
926
+ "is_optional": "False"
927
+ },
928
+ {
929
+ "name": "vector2",
930
+ "doc": "",
931
+ "types": [
932
+ "Vector3 | Vector4"
933
+ ],
934
+ "is_optional": "False"
935
+ }
936
+ ],
937
+ "returnvalues": [
938
+ {
939
+ "name": "",
940
+ "doc": "",
941
+ "types": [
942
+ "number"
943
+ ]
944
+ }
945
+ ]
946
+ },
947
+ {
948
+ "type": "FUNCTION",
949
+ "name": "average_midpoint_of_vectors",
950
+ "brief": "Average midpoint of a set of vmath vectors",
951
+ "description": "Average midpoint of a set of vmath vectors",
952
+ "parameters": [
953
+ {
954
+ "name": "vararg",
955
+ "doc": "",
956
+ "types": [
957
+ "Array<Vector3 | Vector4>"
958
+ ],
959
+ "is_optional": "False"
960
+ }
961
+ ],
962
+ "returnvalues": [
963
+ {
964
+ "name": "",
965
+ "doc": "",
966
+ "types": [
967
+ "LuaMultiReturn<[ number, number ]>"
968
+ ]
969
+ }
970
+ ]
971
+ },
972
+ {
973
+ "type": "FUNCTION",
974
+ "name": "fraction_of",
975
+ "brief": "Fraction of",
976
+ "description": "Fraction of",
977
+ "parameters": [
978
+ {
979
+ "name": "a",
980
+ "doc": "",
981
+ "types": [
982
+ "number"
983
+ ],
984
+ "is_optional": "False"
985
+ },
986
+ {
987
+ "name": "b",
988
+ "doc": "",
989
+ "types": [
990
+ "number"
991
+ ],
992
+ "is_optional": "False"
993
+ }
994
+ ],
995
+ "returnvalues": [
996
+ {
997
+ "name": "",
998
+ "doc": "",
999
+ "types": [
1000
+ "number"
1001
+ ]
1002
+ }
1003
+ ]
1004
+ },
1005
+ {
1006
+ "type": "FUNCTION",
1007
+ "name": "percent_of",
1008
+ "brief": "Percent of",
1009
+ "description": "Percent of",
1010
+ "parameters": [
1011
+ {
1012
+ "name": "a",
1013
+ "doc": "",
1014
+ "types": [
1015
+ "number"
1016
+ ],
1017
+ "is_optional": "False"
1018
+ },
1019
+ {
1020
+ "name": "b",
1021
+ "doc": "",
1022
+ "types": [
1023
+ "number"
1024
+ ],
1025
+ "is_optional": "False"
1026
+ }
1027
+ ],
1028
+ "returnvalues": [
1029
+ {
1030
+ "name": "",
1031
+ "doc": "",
1032
+ "types": [
1033
+ "number"
1034
+ ]
1035
+ }
1036
+ ]
1037
+ },
1038
+ {
1039
+ "type": "FUNCTION",
1040
+ "name": "min_max",
1041
+ "brief": "Used for MinMax Range",
1042
+ "description": "Used for MinMax Range",
1043
+ "parameters": [
1044
+ {
1045
+ "name": "min",
1046
+ "doc": "",
1047
+ "types": [
1048
+ "number"
1049
+ ],
1050
+ "is_optional": "False"
1051
+ },
1052
+ {
1053
+ "name": "max",
1054
+ "doc": "",
1055
+ "types": [
1056
+ "number"
1057
+ ],
1058
+ "is_optional": "False"
1059
+ },
1060
+ {
1061
+ "name": "value",
1062
+ "doc": "",
1063
+ "types": [
1064
+ "number"
1065
+ ],
1066
+ "is_optional": "False"
1067
+ }
1068
+ ],
1069
+ "returnvalues": [
1070
+ {
1071
+ "name": "",
1072
+ "doc": "",
1073
+ "types": [
1074
+ "number"
1075
+ ]
1076
+ }
1077
+ ]
1078
+ },
1079
+ {
1080
+ "type": "FUNCTION",
1081
+ "name": "min_value",
1082
+ "brief": "",
1083
+ "description": "",
1084
+ "parameters": [
1085
+ {
1086
+ "name": "smallest",
1087
+ "doc": "",
1088
+ "types": [
1089
+ "number"
1090
+ ],
1091
+ "is_optional": "False"
1092
+ },
1093
+ {
1094
+ "name": "value",
1095
+ "doc": "",
1096
+ "types": [
1097
+ "number"
1098
+ ],
1099
+ "is_optional": "False"
1100
+ }
1101
+ ],
1102
+ "returnvalues": [
1103
+ {
1104
+ "name": "",
1105
+ "doc": "",
1106
+ "types": [
1107
+ "number"
1108
+ ]
1109
+ }
1110
+ ]
1111
+ },
1112
+ {
1113
+ "type": "FUNCTION",
1114
+ "name": "max_value",
1115
+ "brief": "",
1116
+ "description": "",
1117
+ "parameters": [
1118
+ {
1119
+ "name": "largest",
1120
+ "doc": "",
1121
+ "types": [
1122
+ "number"
1123
+ ],
1124
+ "is_optional": "False"
1125
+ },
1126
+ {
1127
+ "name": "value",
1128
+ "doc": "",
1129
+ "types": [
1130
+ "number"
1131
+ ],
1132
+ "is_optional": "False"
1133
+ }
1134
+ ],
1135
+ "returnvalues": [
1136
+ {
1137
+ "name": "",
1138
+ "doc": "",
1139
+ "types": [
1140
+ "number"
1141
+ ]
1142
+ }
1143
+ ]
1144
+ },
1145
+ {
1146
+ "type": "FUNCTION",
1147
+ "name": "in_triangle",
1148
+ "brief": "Used to find a point in a triangle",
1149
+ "description": "Used to find a point in a triangle\nx0, y0 are the points that are being checked against the rest to see if it's inside",
1150
+ "parameters": [
1151
+ {
1152
+ "name": "x0",
1153
+ "doc": "",
1154
+ "types": [
1155
+ "number"
1156
+ ],
1157
+ "is_optional": "False"
1158
+ },
1159
+ {
1160
+ "name": "y0",
1161
+ "doc": "",
1162
+ "types": [
1163
+ "number"
1164
+ ],
1165
+ "is_optional": "False"
1166
+ },
1167
+ {
1168
+ "name": "x1",
1169
+ "doc": "",
1170
+ "types": [
1171
+ "number"
1172
+ ],
1173
+ "is_optional": "False"
1174
+ },
1175
+ {
1176
+ "name": "y1",
1177
+ "doc": "",
1178
+ "types": [
1179
+ "number"
1180
+ ],
1181
+ "is_optional": "False"
1182
+ },
1183
+ {
1184
+ "name": "x2",
1185
+ "doc": "",
1186
+ "types": [
1187
+ "number"
1188
+ ],
1189
+ "is_optional": "False"
1190
+ },
1191
+ {
1192
+ "name": "y2",
1193
+ "doc": "",
1194
+ "types": [
1195
+ "number"
1196
+ ],
1197
+ "is_optional": "False"
1198
+ },
1199
+ {
1200
+ "name": "x3",
1201
+ "doc": "",
1202
+ "types": [
1203
+ "number"
1204
+ ],
1205
+ "is_optional": "False"
1206
+ },
1207
+ {
1208
+ "name": "y3",
1209
+ "doc": "",
1210
+ "types": [
1211
+ "number"
1212
+ ],
1213
+ "is_optional": "False"
1214
+ }
1215
+ ],
1216
+ "returnvalues": [
1217
+ {
1218
+ "name": "",
1219
+ "doc": "",
1220
+ "types": [
1221
+ "boolean"
1222
+ ]
1223
+ }
1224
+ ]
1225
+ },
1226
+ {
1227
+ "type": "FUNCTION",
1228
+ "name": "box_intersect",
1229
+ "brief": "arr must be 6 in length: top x/y, bottom right x/y, bottom left x/y",
1230
+ "description": "arr must be 6 in length: top x/y, bottom right x/y, bottom left x/y",
1231
+ "parameters": [
1232
+ {
1233
+ "name": "ax",
1234
+ "doc": "",
1235
+ "types": [
1236
+ "number"
1237
+ ],
1238
+ "is_optional": "False"
1239
+ },
1240
+ {
1241
+ "name": "ay",
1242
+ "doc": "",
1243
+ "types": [
1244
+ "number"
1245
+ ],
1246
+ "is_optional": "False"
1247
+ },
1248
+ {
1249
+ "name": "awidth",
1250
+ "doc": "",
1251
+ "types": [
1252
+ "number"
1253
+ ],
1254
+ "is_optional": "False"
1255
+ },
1256
+ {
1257
+ "name": "aheight",
1258
+ "doc": "",
1259
+ "types": [
1260
+ "number"
1261
+ ],
1262
+ "is_optional": "False"
1263
+ },
1264
+ {
1265
+ "name": "bx",
1266
+ "doc": "",
1267
+ "types": [
1268
+ "number"
1269
+ ],
1270
+ "is_optional": "False"
1271
+ },
1272
+ {
1273
+ "name": "by",
1274
+ "doc": "",
1275
+ "types": [
1276
+ "number"
1277
+ ],
1278
+ "is_optional": "False"
1279
+ },
1280
+ {
1281
+ "name": "bwidth",
1282
+ "doc": "",
1283
+ "types": [
1284
+ "number"
1285
+ ],
1286
+ "is_optional": "False"
1287
+ },
1288
+ {
1289
+ "name": "bheight",
1290
+ "doc": "",
1291
+ "types": [
1292
+ "number"
1293
+ ],
1294
+ "is_optional": "False"
1295
+ }
1296
+ ],
1297
+ "returnvalues": [
1298
+ {
1299
+ "name": "",
1300
+ "doc": "",
1301
+ "types": [
1302
+ "boolean"
1303
+ ]
1304
+ }
1305
+ ]
1306
+ },
1307
+ {
1308
+ "type": "FUNCTION",
1309
+ "name": "check_point_in_rect",
1310
+ "brief": "see if a single point is within a rotated rectangle",
1311
+ "description": "see if a single point is within a rotated rectangle",
1312
+ "parameters": [
1313
+ {
1314
+ "name": "rx",
1315
+ "doc": "",
1316
+ "types": [
1317
+ "number"
1318
+ ],
1319
+ "is_optional": "False"
1320
+ },
1321
+ {
1322
+ "name": "ry",
1323
+ "doc": "",
1324
+ "types": [
1325
+ "number"
1326
+ ],
1327
+ "is_optional": "False"
1328
+ },
1329
+ {
1330
+ "name": "rw",
1331
+ "doc": "",
1332
+ "types": [
1333
+ "number"
1334
+ ],
1335
+ "is_optional": "False"
1336
+ },
1337
+ {
1338
+ "name": "rh",
1339
+ "doc": "",
1340
+ "types": [
1341
+ "number"
1342
+ ],
1343
+ "is_optional": "False"
1344
+ },
1345
+ {
1346
+ "name": "rot",
1347
+ "doc": "",
1348
+ "types": [
1349
+ "number"
1350
+ ],
1351
+ "is_optional": "False"
1352
+ },
1353
+ {
1354
+ "name": "px",
1355
+ "doc": "",
1356
+ "types": [
1357
+ "number"
1358
+ ],
1359
+ "is_optional": "False"
1360
+ },
1361
+ {
1362
+ "name": "py",
1363
+ "doc": "",
1364
+ "types": [
1365
+ "number"
1366
+ ],
1367
+ "is_optional": "False"
1368
+ }
1369
+ ],
1370
+ "returnvalues": [
1371
+ {
1372
+ "name": "",
1373
+ "doc": "",
1374
+ "types": [
1375
+ "boolean"
1376
+ ]
1377
+ }
1378
+ ]
1379
+ }
1380
+ ]
1381
+ }