This repository has been archived by the owner on Nov 16, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathEngine_Merged_Pretty.json
3317 lines (3317 loc) · 114 KB
/
Engine_Merged_Pretty.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"Peripherals": {
"Audio": {
"availableSince": [ 0, 7, 0 ],
"lastUpdatedIn": [ 0, 8, 0 ],
"methods": {
"generate": {
"arguments": [ {
"description": "The waveform id, it should be at least 0, but no more then 5.",
"name": "wave",
"type": "number"
}, {
"description": "The frequency of the tune.",
"name": "freq",
"type": "number"
}, {
"description": "The amplitude of the tune.",
"name": "amp",
"type": "number"
} ],
"availableSince": [ [ 1, 0, 0 ], [ 0, 7, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 8, 0 ] ],
"shortDescription": "Generates a tune from wave, frequency, and amplitude"
},
"play": {
"arguments": [ {
"description": "The sound effect data.",
"name": "sfx",
"type": "table"
}, {
"default": "0",
"description": "A channel from 0 to 3.",
"name": "chn",
"type": "number"
} ],
"availableSince": [ [ 1, 0, 0 ], [ 0, 7, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 8, 0 ] ],
"shortDescription": "Plays a sound effect over a channel."
},
"stop": {
"availableSince": [ [ 1, 0, 0 ], [ 0, 7, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 8, 0 ] ],
"shortDescription": "Stops the playing music."
}
},
"name": "Audio",
"shortDescription": "Allows the generation of chiptune audio.",
"version": [ 1, 0, 0 ]
},
"BIOS": {
"availableSince": [ 0, 6, 0 ],
"fullDescription": "Provides APIs to get information about the peripherals, and their methods, are the direct or indirect.\n\nAlso gives info about LIKO-12's version, and previous version when updated from an old one (only the first boot with the new version).\nStarting with LIKO-12 0.9.0, It also gives the .love of LIKO-12.",
"lastUpdatedIn": [ 1, 0, 0 ],
"methods": {
"HandledAPIS": {
"availableSince": [ [ 1, 15, 2 ], [ 0, 7, 0 ] ],
"extra": "The peripherals handled APIS is a table where the keys and values are:\n- **Keys**: The mount name.\n- **Values**: The peripheral methods (functions).",
"lastUpdatedIn": [ [ 1, 15, 2 ], [ 0, 7, 0 ] ],
"notes": [ "The HandledAPIS table is passed to the operating system's `boot.lua` as an argument:\n```lua\n--In C:/boot.lua\nlocal HandledAPIS = ...\n```" ],
"returns": [ {
"description": "The peripherals handled APIS.",
"name": "HandledAPIS",
"type": "table"
} ],
"shortDescription": "Returns the handled peripherals APIS, that can be used directly."
},
"PeripheralFunctions": {
"arguments": [ {
"description": "The peripheral mount name.",
"name": "mountName",
"type": "string"
} ],
"availableSince": [ [ 1, 15, 2 ], [ 0, 7, 0 ] ],
"extra": "The peripheral functions list is a table where the keys and values are:\n- **Keys**: The function/method name.\n- **Values**: The function/method type (`\"Direct\"` or `\"Yield\"`).",
"lastUpdatedIn": [ [ 1, 15, 2 ], [ 0, 7, 0 ] ],
"notes": [ "It's good to know if a method/function is a yield or direct one:\n- **Direct Methods** are called directly, _fast_.\n- **Yielding Methods** requires a coroutine yield, _slow_." ],
"returns": [ {
"description": "The peripheral functions list.",
"name": "functions",
"type": "table"
} ],
"shortDescription": "Returns the list of available peripheral functions, and their type (Direct,Yield)."
},
"Peripherals": {
"availableSince": [ [ 1, 15, 2 ], [ 0, 7, 0 ] ],
"extra": "The peripherals list is a table where the keys and values are:\n- **Keys**: The mount name.\n- **Values**: The peripheral type.",
"lastUpdatedIn": [ [ 1, 15, 2 ], [ 0, 7, 0 ] ],
"returns": [ {
"description": "The peripherals list.",
"name": "peripherals",
"type": "table"
} ],
"shortDescription": "Returns a list of mounted peripherals and their types."
},
"getSRC": {
"availableSince": [ [ 1, 18, 2 ], [ 1, 0, 0 ] ],
"lastUpdatedIn": [ [ 1, 18, 2 ], [ 1, 0, 0 ] ],
"notes": [ "`LIKO-12_Source.love` is created at the first boot whenever a different LIKO-12 version is used, with the message `Generating internal file...` shown." ],
"returns": [ {
"description": "The file data of LIKO-12's source code .love file.",
"name": "LIKO_SRC",
"type": [ "string", "boolean" ]
}, {
"description": "The failure reason if `LIKO_SRC` was `false`.",
"name": "err",
"type": [ "string", "nil" ]
} ],
"shortDescription": "Returns `LIKO-12_Source.love` data."
},
"getVersion": {
"availableSince": [ [ 1, 15, 2 ], [ 0, 7, 0 ] ],
"lastUpdatedIn": [ [ 1, 15, 2 ], [ 0, 7, 0 ] ],
"notes": [ "The `LIKO_Old` value is only provided when LIKO-12 boots for the __first time__ with the new version." ],
"returns": [ {
"description": "Current LIKO-12's version string (ex: `1.0.0_DEV`).",
"name": "LIKO_Version",
"type": "string"
}, {
"description": "The previous installed LIKO-12's version string (ex: `0.8.0_PRE`).",
"name": "LIKO_Old",
"type": [ "string", "nil" ]
} ],
"shortDescription": "Returns LIKO-12's Version."
},
"isFirstBoot": {
"availableSince": [ [ 1, 18, 3 ], [ 1, 0, 0 ] ],
"lastUpdatedIn": [ [ 1, 18, 3 ], [ 1, 0, 0 ] ],
"returns": [ {
"description": "True when this is the first boot of LIKO-12 ever.",
"name": "FirstBoot",
"type": "boolean"
} ],
"shortDescription": "Tells if this is the first boot of LIKO-12 ever."
}
},
"name": "Basic Integrated Operating System",
"shortDescription": "Gives access to miscellaneous functions.",
"version": [ 1, 18, 3 ]
},
"CPU": {
"availableSince": [ 0, 6, 0 ],
"events": {
"update": {
"arguments": [ {
"description": "The time passed since the previous `update` triggered, measured in seconds.",
"name": "dt",
"type": "number"
} ],
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"notes": [ "`update` is triggered 60 times a second for most of the devices, but that depends on the screen refresh rate, so it can be more or less!", "`update` can be triggered for over than 2000 times a second if the vsync of the GPU was disabled due to user's configuration!" ],
"shortDescription": "Triggered almost every frame, with the delta-time between each called passed in."
}
},
"lastUpdatedIn": [ 0, 8, 0 ],
"methods": {
"clearClipboard": {
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"shortDescription": "Clears the clipboard content."
},
"clearEStack": {
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"shortDescription": "Clears the events stack."
},
"clipboard": {
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"shortDescription": "Read or write to/from the clipboard.",
"usages": [ {
"name": "Read the clipboard content:",
"returns": [ {
"description": "The clipboard content.",
"name": "content",
"type": "string"
} ]
}, {
"arguments": [ {
"description": "The new clipboard content.",
"name": "content",
"type": [ "string", "number" ]
} ],
"name": "Set the clipboard content:"
} ]
},
"cprint": {
"arguments": [ {
"description": "The text to print.",
"name": "text",
"type": "any"
}, {
"default": "nil",
"description": "Will be automatically concated with the first argument, works the same way of the standard Lua print.",
"name": "...",
"type": "any"
} ],
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"shortDescription": "Print into the developer terminal, that can be shown by running LIKO-12 from terminal."
},
"getFPS": {
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"returns": [ {
"description": "The FPS.",
"name": "fps",
"type": "number"
} ],
"shortDescription": "Returns the current frame per second count."
},
"getHostOS": {
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"returns": [ {
"description": "The current operating system. \"OS X\", \"Windows\", \"Linux\", \"Android\" or \"iOS\".",
"name": "os",
"type": "string"
} ],
"shortDescription": "Returns the operating system that's LIKO-12 is running on."
},
"getSaveDirectory": {
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"returns": [ {
"description": "LIKO-12 save directory (the appdata directory) in the HOST filesystem.",
"name": "dir",
"type": "string"
} ],
"shortDescription": "Returns LIKO-12 save directory (the appdata directory) in the HOST filesystem."
},
"isMobile": {
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"returns": [ {
"description": "Is LIKO-12 running on a mobile device ?",
"name": "mobile",
"type": "boolean"
} ],
"shortDescription": "Returns true if LIKO-12 is running on a mobile device (Android or iOS)."
},
"openAppdata": {
"arguments": [ {
"description": "The directory to open in the HOST file explorer.",
"name": "dir",
"type": "string"
} ],
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"longDescription": "Opens a specific directory inside the LIKO-12 appdata folder using the HOST file explorer.\n\nIn order to show a folder inside the virtual drives open `/drives/[driveName]/...`.",
"shortDescription": "Opens a specific directory inside the LIKO-12 appdata folder using the HOST file explorer."
},
"pullEvent": {
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"longDescription": "This function is used internally by DiskOS to run the default event loop, which calls the callback functions that start by `_` like `_update` and `_mousepressed`, etc..\n\nEvents in LIKO-12 may be pulled directly, or pulled from a stack if there are already, the stack may fill up when CPU `sleep()` or GPU `flip()` are called.",
"returns": [ {
"description": "The event name, can be any of the callbacks names without the \"_\" at the start.",
"name": "event",
"type": "string"
}, {
"description": "First argument.",
"name": "a",
"type": "any"
}, {
"description": "Second argument.",
"name": "b",
"type": "any"
}, {
"description": "Third argument.",
"name": "c",
"type": "any"
}, {
"description": "Forth argument.",
"name": "d",
"type": "any"
}, {
"description": "Fifth argument.",
"name": "e",
"type": "any"
}, {
"description": "Sixth argument.",
"name": "f",
"type": "any"
} ],
"shortDescription": "Pulls an event from the events stack."
},
"rawPullEvent": {
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"returns": [ {
"description": "The event name, can be any of the callbacks names without the \"_\" at the start.",
"name": "event",
"type": "string"
}, {
"description": "First argument.",
"name": "a",
"type": "any"
}, {
"description": "Second argument.",
"name": "b",
"type": "any"
}, {
"description": "Third argument.",
"name": "c",
"type": "any"
}, {
"description": "Forth argument.",
"name": "d",
"type": "any"
}, {
"description": "Fifth argument.",
"name": "e",
"type": "any"
}, {
"description": "Sixth argument.",
"name": "f",
"type": "any"
} ],
"shortDescription": "Pulls a new event directly, returns it and stores it in the events stack, used by DiskOS to handle the `escape` key."
},
"reboot": {
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"shortDescription": "Reboot LIKO-12.",
"usages": [ {
"name": "Soft Reboot:",
"shortDescription": "Soft reboots LIKO-12 by doing an internal trick to reload the BIOS and bootup again, will leave some garbage that will be cleaned automatically by the Lua garbage collector."
}, {
"arguments": [ {
"default": "true",
"type": "boolean"
} ],
"name": "Hard Reboot:",
"shortDescription": "Hard reboots LIKO-12 by reinitializing the LÖVE engine, will clear the whole Lua state, and re-create the window."
} ]
},
"shutdown": {
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"shortDescription": "Shutdown/exit LIKO-12."
},
"sleep": {
"arguments": [ {
"description": "The amount of seconds to sleep.",
"name": "time",
"type": "number"
} ],
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"shortDescription": "Sleeps (pauses) the current execution for specific amount of seconds."
},
"triggerEvent": {
"arguments": [ {
"description": "The event name.",
"name": "event",
"type": "string"
}, {
"default": "nil",
"description": "First argument.",
"name": "a",
"type": "any"
}, {
"default": "nil",
"description": "Second argument.",
"name": "b",
"type": "any"
}, {
"default": "nil",
"description": "Third argument.",
"name": "c",
"type": "any"
}, {
"default": "nil",
"description": "Forth argument.",
"name": "d",
"type": "any"
}, {
"default": "nil",
"description": "Fifth argument.",
"name": "e",
"type": "any"
}, {
"default": "nil",
"description": "Sixth argument.",
"name": "f",
"type": "any"
} ],
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"shortDescription": "Add a new event to the events stack."
}
},
"name": "Central Processing Unit",
"shortDescription": "This peripheral contains most of miscellaneous functions that LIKO-12 would use.",
"version": [ 1, 0, 0 ]
},
"FDD": {
"availableSince": [ 0, 6, 0 ],
"lastUpdatedIn": [ 0, 8, 0 ],
"methods": {
"exportDisk": {
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"returns": [ {
"description": "The current floppy disk.",
"name": "fimg",
"type": "string"
} ],
"shortDescription": "Exports current floppy disk"
},
"importDisk": {
"arguments": [ {
"description": "Disk to import.",
"name": "data",
"type": "string"
} ],
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"shortDescription": "Imports and mounts a floppy disk"
},
"newDisk": {
"arguments": [ {
"default": "\"Blue\"",
"description": "Template name, without the .png extension.",
"name": "tname",
"type": "string"
} ],
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"shortDescription": "Creates a new floppy disk and mounts it"
}
},
"name": "Floppy Disk Drive",
"shortDescription": "This peripheral is responsible for loading and reading data inside of PNGs, invisibly to the user.",
"version": [ 1, 0, 0 ]
},
"GPU": {
"availableSince": [ 0, 6, 0 ],
"events": {
"filedropped": {
"arguments": [ {
"description": "The filename of the dropped file.",
"name": "filename",
"type": "string"
}, {
"description": "The content of the dropped file.",
"name": "data",
"type": "string"
} ],
"availableSince": [ [ 1, 0, 0 ], [ 0, 7, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 7, 0 ] ],
"shortDescription": "Triggered when a file is dropped into LIKO-12's window."
},
"mousemoved": {
"arguments": [ {
"description": "Mouse x position, in pixels.",
"name": "x",
"type": "number"
}, {
"description": "Mouse y position, in pixels.",
"name": "y",
"type": "number"
}, {
"description": "The amount moved along the x-axis since the last time mousemoved was triggered.",
"name": "dx",
"type": "number"
}, {
"description": "The amount moved along the y-axis since the last time mousemoved was triggered.",
"name": "dy",
"type": "number"
}, {
"description": "True if the mouse move originated from a touchscreen touch-move.",
"name": "istouch",
"type": "boolean"
} ],
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"shortDescription": "Triggered when the mouse is moved, or if a screen touch was moved."
},
"mousepressed": {
"arguments": [ {
"description": "Mouse x position, in pixels.",
"name": "x",
"type": "number"
}, {
"description": "Mouse y position, in pixels.",
"name": "y",
"type": "number"
}, {
"description": "The button index that was pressed. 1 is the primary mouse button, 2 is the secondary mouse button and 3 is the middle button. Further buttons are mouse dependent.",
"name": "button",
"type": "number"
}, {
"description": "True if the mouse button press originated from a touchscreen touch-press.",
"name": "istouch",
"type": "boolean"
} ],
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"shortDescription": "Triggered when a mouse button is pressed, or if the screen was touched."
},
"mousereleased": {
"arguments": [ {
"description": "Mouse x position, in pixels.",
"name": "x",
"type": "number"
}, {
"description": "Mouse y position, in pixels.",
"name": "y",
"type": "number"
}, {
"description": "The button index that was released. 1 is the primary mouse button, 2 is the secondary mouse button and 3 is the middle button. Further buttons are mouse dependent.",
"name": "button",
"type": "number"
}, {
"description": "True if the mouse button release originated from a touchscreen touch-release.",
"name": "istouch",
"type": "boolean"
} ],
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"shortDescription": "Triggered when a mouse button is released, or if the screen was no longer touched."
},
"touchmoved": {
"arguments": [ {
"description": "The identifier for the touch press.",
"name": "id",
"type": "userdata"
}, {
"description": "The x-axis position of the touch press inside the window, in pixels.",
"name": "x",
"type": "number"
}, {
"description": "The y-axis position of the touch press inside the window, in pixels.",
"name": "y",
"type": "number"
}, {
"description": "The x-axis movement of the touch press inside the window, in pixels.",
"name": "dx",
"type": "number"
}, {
"description": "The y-axis movement of the touch press inside the window, in pixels.",
"name": "dy",
"type": "number"
}, {
"description": "The amount of pressure being applied. Most touch screens aren't pressure sensitive, in which case the pressure will be 1.",
"name": "pressure",
"type": "number"
} ],
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"notes": [ "The identifier is only guaranteed to be unique for the specific touch press until touchreleased is triggered with that identifier, at which point it may be reused for new touch presses." ],
"shortDescription": "Triggered when a touch press moves inside the touchscreen."
},
"touchpressed": {
"arguments": [ {
"description": "The identifier for the touch press.",
"name": "id",
"type": "userdata"
}, {
"description": "The x-axis position of the touch press inside the window, in pixels.",
"name": "x",
"type": "number"
}, {
"description": "The y-axis position of the touch press inside the window, in pixels.",
"name": "y",
"type": "number"
}, {
"description": "The x-axis movement of the touch press inside the window, in pixels. This should always be zero.",
"name": "dx",
"type": "number"
}, {
"description": "The y-axis movement of the touch press inside the window, in pixels. This should always be zero.",
"name": "dy",
"type": "number"
}, {
"description": "The amount of pressure being applied. Most touch screens aren't pressure sensitive, in which case the pressure will be 1.",
"name": "pressure",
"type": "number"
} ],
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"notes": [ "The identifier is only guaranteed to be unique for the specific touch press until touchreleased is triggered with that identifier, at which point it may be reused for new touch presses." ],
"shortDescription": "Triggered when the touchscreen is touched."
},
"touchreleased": {
"arguments": [ {
"description": "The identifier for the touch press.",
"name": "id",
"type": "userdata"
}, {
"description": "The x-axis position of the touch press inside the window, in pixels.",
"name": "x",
"type": "number"
}, {
"description": "The y-axis position of the touch press inside the window, in pixels.",
"name": "y",
"type": "number"
}, {
"description": "The x-axis movement of the touch press inside the window, in pixels.",
"name": "dx",
"type": "number"
}, {
"description": "The y-axis movement of the touch press inside the window, in pixels.",
"name": "dy",
"type": "number"
}, {
"description": "The amount of pressure being applied. Most touch screens aren't pressure sensitive, in which case the pressure will be 1.",
"name": "pressure",
"type": "number"
} ],
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"notes": [ "The identifier is only guaranteed to be unique for the specific touch press until touchreleased is triggered with that identifier, at which point it may be reused for new touch presses." ],
"shortDescription": "Triggered when the touchscreen stops being touched."
},
"wheelmoved": {
"arguments": [ {
"description": "Amount of horizontal mouse wheel movement. Positive values indicate movement to the right.",
"name": "x",
"type": "number"
}, {
"description": "Amount of vertical mouse wheel movement. Positive values indicate upward movement.",
"name": "y",
"type": "number"
} ],
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"shortDescription": "Triggered when the mouse wheel is moved."
}
},
"lastUpdatedIn": [ 0, 8, 0 ],
"methods": {
"_systemMessage": {
"arguments": [ {
"description": "The message to show.",
"name": "msg",
"type": "string"
}, {
"default": "1",
"description": "How long the message to be shown, (in seconds).",
"name": "time",
"type": "number"
}, {
"default": "4",
"description": "The color of the text (0-15).",
"name": "tColor",
"type": "number"
}, {
"default": "9",
"description": "The color of the background (0-15).",
"name": "bgColor",
"type": "number"
} ],
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"shortDescription": "Shows a system message: A single line message at the bottom of the screen."
},
"cam": {
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"notes": [ "The transforming operations sums up, to reset check the fifth usage of this function." ],
"shortDescription": "Transforms the drawing operations.",
"usages": [ {
"arguments": [ {
"default": "\"translate\"",
"type": "string"
}, {
"description": "The translation relative to the x-axis.",
"name": "x",
"type": "number"
}, {
"description": "The translation relative to the y-axis.",
"name": "y",
"type": "number"
} ],
"name": "Translate drawing positions:",
"shortDescription": "Shifts all drawing operations."
}, {
"arguments": [ {
"default": "\"scale\"",
"type": "string"
}, {
"description": "The scaling in the direction of the x-axis.",
"name": "sx",
"type": "number"
}, {
"description": "The scaling in the direction of the y-axis.",
"name": "sy",
"type": "number"
} ],
"name": "Scale drawing operations:",
"shortDescription": "Scales all the drawing operations."
}, {
"arguments": [ {
"default": "\"rotate\"",
"type": "string"
}, {
"description": "The amount to rotate the coordinate system in radians.",
"name": "a",
"type": "number"
} ],
"name": "Rotate drawing operations:"
}, {
"arguments": [ {
"default": "\"shear\"",
"type": "string"
}, {
"description": "The shear factor on the x-axis.",
"name": "x",
"type": "number"
}, {
"description": "The shear factor on the y-axis.",
"name": "y",
"type": "number"
} ],
"name": "Shear drawing operations:"
}, {
"name": "Reset all the tranformations:",
"shortDescription": "Resets all the tranformations done back to their original state."
} ]
},
"circle": {
"arguments": [ {
"description": "The x coord of circle center.",
"name": "x",
"type": "number"
}, {
"description": "The y coord of circle center.",
"name": "y",
"type": "number"
}, {
"description": "The radius of circle.",
"name": "r",
"type": "number"
}, {
"description": "(false/nil) The circle will be filled, (true) The circle will have only lines (outline).",
"name": "l",
"type": "boolean"
}, {
"description": "The color of the circle (0-15), defaults to the active color.",
"name": "c",
"type": "number"
}, {
"description": "The number of the segments used when drawing the circle.",
"name": "seg",
"type": "number"
} ],
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"notes": [ "The arguments can be passed in a table." ],
"shortDescription": "Draws a circle on the screen."
},
"clear": {
"arguments": [ {
"default": "0",
"description": "The ID of the color to fill the screen with, can be 0-15.",
"name": "id",
"type": "number"
} ],
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"shortDescription": "Clears the screen and fills it with a specific color, useful when clearing the screen for a new frame."
},
"clearMatrixStack": {
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"shortDescription": "Clears the matrix stack (By calling `popMatrix()`)."
},
"clip": {
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"shortDescription": "Sets the region that the GPU can draw on.",
"usages": [ {
"arguments": [ {
"description": "The top-left X coord of the clipping area.",
"name": "x",
"type": "number"
}, {
"description": "The top-left Y coord of the clipping area.",
"name": "y",
"type": "number"
}, {
"description": "The width of the clipping area.",
"name": "w",
"type": "number"
}, {
"description": "The height of the clipping area.",
"name": "h",
"type": "number"
} ],
"name": "Enable clipping:",
"note": "The arguments can be passed in a table."
}, {
"name": "Disable clipping:"
} ]
},
"color": {
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"longDescription": "Set's the current active color.\n\n---\n\n![Palette](_media/Palette.png)",
"shortDescription": "Set's the current active color.",
"usages": [ {
"arguments": [ {
"description": "The new active color id (0-15).",
"name": "id",
"type": "number"
} ],
"name": "Set the current active color:"
}, {
"name": "Get the current active color:",
"returns": [ {
"description": "The current active color id (0-15).",
"name": "id",
"type": "number"
} ]
} ]
},
"colorPalette": {
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"shortDescription": "Allows you to read and modify the real RGBA values of a color in the palette.",
"usages": [ {
"arguments": [ {
"description": "The color id.",
"name": "id",
"type": "number"
} ],
"name": "Read the RGB values of a color:",
"returns": [ {
"description": "The channel red value [0-225]",
"name": "r",
"type": "number"
}, {
"description": "The channel green value [0-225]",
"name": "g",
"type": "number"
}, {
"description": "The channel blue value [0-225]",
"name": "b",
"type": "number"
} ]
}, {
"arguments": [ {
"description": "The color id.",
"name": "id",
"type": "number"
}, {
"description": "The channel red value [0-225]",
"name": "r",
"type": "number"
}, {
"description": "The channel green value [0-225]",
"name": "g",
"type": "number"
}, {
"description": "The channel blue value [0-225]",
"name": "b",
"type": "number"
} ],
"name": "Set the RGB values of a color:"
}, {
"name": "Reset the palette colors to their defaults (PICO-8 Palette):"
} ]
},
"cursor": {
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"shortDescription": "Sets the current active mouse cursor, or creates a new one.",
"usages": [ {
"arguments": [ {
"description": "The name of the cursor.",
"name": "name",
"type": "string"
}, {
"default": "false",
"description": "True -> Grap the cursor to the pixelated screen.",
"name": "grap",
"type": "boolean"
} ],
"name": "Set the current mouse cursor:"
}, {
"name": "Get the current mouse cursor:",
"returns": [ {
"description": "The current active cursor name.",
"name": "current",
"type": "string"
} ]
}, {
"arguments": [ {
"description": "The imagedata of the cursor.",
"name": "imgdata",
"type": [ [ "Peripherals", "GPU", "objects", "imageData" ] ]
}, {
"default": "\"default\"",
"description": "The name of the cursor.",
"name": "name",
"type": "string"
}, {
"default": "0",
"description": "The X coord of the cursor hot position.",
"name": "hx",
"type": "number"
}, {
"default": "0",
"description": "The Y coord of the cursor hot position.",
"name": "hy",
"type": "number"
} ],
"name": "Create a new cursor:"
} ]
},
"ellipse": {
"arguments": [ {
"description": "The x coord of ellipse center.",
"name": "x",
"type": "number"
}, {
"description": "The y coord of ellipse center.",
"name": "y",
"type": "number"
}, {
"description": "The radius of the ellipse along the x-axis (half the ellipse's width).",
"name": "rx",
"type": "number"
}, {
"description": "The radius of the ellipse along the y-axis (half the ellipse's height).",
"name": "ry",
"type": "number"
}, {
"default": "false",
"description": "(false/nil) The ellipse will be filled, (true) The ellipse will have only lines (outline).",
"name": "l",
"type": "boolean"
}, {
"description": "The color of the ellipse (0-15), defaults to the active color.",
"name": "r",
"type": "number"
}, {
"description": "The number of the segments used when drawing the ellipse.",
"name": "seg",
"type": "number"
} ],
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"notes": [ "The arguments can be passed in a table" ],
"shortDescription": "Draws an ellipse on the screen."
},
"endGifRecording": {
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"shortDescription": "End LIKO-12 screen Gif recording by code."
},
"flip": {
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"shortDescription": "Waits till the screen is applied and shown to the user, helpful when doing some loading operations."
},
"fontHeight": {
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"returns": [ {
"description": "The height of the font character.",
"name": "height",
"type": "number"
} ],
"shortDescription": "Returns height of the font character in pixels."
},
"fontSize": {
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"returns": [ {
"description": "The height of the font character.",
"name": "height",
"type": "number"
}, {
"description": "The width of the font character.",
"name": "width",
"type": "number"
} ],
"shortDescription": "Returns size of the font character in pixels."
},
"fontWidth": {
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"returns": [ {
"description": "The width of the font character.",
"name": "width",
"type": "number"
} ],
"shortDescription": "Returns width of the font character in pixels."
},
"getLabelImage": {
"availableSince": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"lastUpdatedIn": [ [ 1, 0, 0 ], [ 0, 6, 0 ] ],
"returns": [ {
"description": "The imagedata object of the label.",
"name": "limg",
"type": [ [ "Peripherals", "GPU", "objects", "imageData" ] ]