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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta name="generator" content="HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org">
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<title>Lua 5.1 short reference</title>
<style type="text/css">
<!--
body
{margin-left:24px;
margin-bottom:120px;
width:75%}
p.MsoNormal
{margin-top:0cm;
margin-right:0cm;
margin-bottom:0cm;
margin-left:2.85pt;
margin-bottom:.0001pt;
font-size:8.0pt;
font-family:"Times New Roman";}
span.LuaCbold
{font-weight:bold;}
span.LuaCitalic
{font-style:italic;}
p.LuaPHeader2
{margin-top:32px;
margin-right:0cm;
margin-bottom:8px;
margin-left:0cm;
text-indent:2.85pt;
page-break-after:avoid;
font-size:10.0pt;
font-family:Arial;
color:gray;
font-weight:bold;
font-style:italic;}
p.LuaPHeader1
{margin-top:48px;
margin-right:4.25pt;
margin-bottom:8px;
margin-left:0px;
width:100%;
page-break-after:avoid;
background:#F3F3F3;
padding:8px;
font-size:12.0pt;
font-family:Arial;
color:gray;
letter-spacing:1.2pt;
font-weight:bold;}
table.LuaTTables
{width:100%;}
td
{padding:4px;}
a.IndexRef
{white-space:nowrap;
padding-right:8px;
text-decoration:none;
}
-->
</style>
</head>
<body bgcolor="white" style="line-break:strict">
<p class='LuaPHeader1'><span lang='EN-US'>Contents</span></p>
<div style='width:100%;font-size:12.0pt;font-weight:bold;text-align:center;line-height: 200%;'>
<p><a class="IndexRef" href="#The_Lua_language">· The Lua language ·</a> <a class="IndexRef" href="#The_base_library">· The base library ·</a> <a class="IndexRef" href="#Modules_and_the_package_library">· Modules and
the package library ·</a> <a class="IndexRef" href="#The_coroutine_library">· The coroutine library ·</a> <a class="IndexRef" href="#The_table_library">· The table library ·</a> <a class="IndexRef" href=
"#The_mathematical_library">· The mathematical library ·</a> <a class="IndexRef" href="#The_string_library">· The string library ·</a> <a class="IndexRef" href="#The_I_O_library">· The I/O library ·</a>
<a class="IndexRef" href="#The_operating_system_library">· The operating system library ·</a> <a class="IndexRef" href="#The_debug_library">· The debug library ·</a> <a class="IndexRef" href=
"#The_stand_alone_interpreter">· The stand-alone interpreter ·</a> <a class="IndexRef" href="#The_compiler">· The compiler ·</a></p>
</div>
<p class="LuaPHeader1"><a name="The_Lua_language" id="The_Lua_language"><span lang="EN-US">The Lua language (v5.1)</span></a></p>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Reserved identifiers and
comments</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" width="650" summary="?">
<tr>
<td width="59" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">and</span></span></p>
</td>
<td width="59" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">break</span></span></p>
</td>
<td width="59" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">do</span></span></p>
</td>
<td width="59" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">else</span></span></p>
</td>
<td width="59" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">elseif</span></span></p>
</td>
<td width="59" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">end</span></span></p>
</td>
<td width="59" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">false</span></span></p>
</td>
<td width="59" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">for</span></span></p>
</td>
<td width="59" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">function</span></span></p>
</td>
<td width="59" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">if</span></span></p>
</td>
<td width="59" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">in</span></span></p>
</td>
</tr>
<tr>
<td width="59" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">local</span></span></p>
</td>
<td width="59" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">nil</span></span></p>
</td>
<td width="59" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">not</span></span></p>
</td>
<td width="59" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">or</span></span></p>
</td>
<td width="59" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">repeat</span></span></p>
</td>
<td width="59" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">return</span></span></p>
</td>
<td width="59" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">then</span></span></p>
</td>
<td width="59" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">true</span></span></p>
</td>
<td width="59" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">until</span></span></p>
</td>
<td width="59" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">while</span></span></p>
</td>
<td width="59" valign="top">
<p class="MsoNormal"><b><span lang="EN-US"> </span></b></p>
</td>
</tr>
<tr>
<td width="59" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-- ...</span></span></p>
</td>
<td width="236" colspan="4" valign="top">
<p class="MsoNormal"><span lang="EN-US">comment to end of line</span></p>
</td>
<td width="59" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">--[=[</span></span> <span lang="EN-US"> <span class="LuaCbold">]=]</span></span></p>
</td>
<td width="295" colspan="5" valign="top">
<p class="MsoNormal"><span lang="EN-US">multi line comment (zero or multiple '=' are valid)</span></p>
</td>
</tr>
<tr>
<td width="295" colspan="5" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">_X</span></span> <span lang="EN-US">is "reserved" (by convention) for constants (with X being any sequence of uppercase letters)</span></p>
</td>
<td width="59" valign="top">
<p class="MsoNormal"><span lang="EN-US">#!</span></p>
</td>
<td width="295" colspan="5" valign="top">
<p class="MsoNormal"><span lang="EN-US">usual Unix shebang; Lua ignores whole first line if this starts the line.</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Types (the string values are the
possible results of base library function type())</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="81" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">"nil"</span></span></p>
</td>
<td width="81" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">"boolean"</span></span></p>
</td>
<td width="81" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">"number"</span></span></p>
</td>
<td width="81" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">"string"</span></span></p>
</td>
<td width="81" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">"table"</span></span></p>
</td>
<td width="81" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">"function"</span></span></p>
</td>
<td width="81" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">"thread"</span></span></p>
</td>
<td width="81" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">"userdata"</span></span></p>
</td>
</tr>
</table>
<p class="MsoNormal"><span lang="EN-GB">Note: for type boolean,</span> <span class="LuaCbold"><span lang="EN-US">nil</span></span> <span lang="EN-GB">and</span> <span class="LuaCbold"><span lang="EN-US">false</span></span> <span lang="EN-GB">count as
false; everything else is true (including 0 and "").</span></p>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Strings and escape
sequences</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="95" colspan="2" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">'...'</span></span> <span lang="EN-US">and</span> <span class="LuaCbold"><span lang="EN-US">"..."</span></span></p>
</td>
<td width="201" colspan="3" valign="top">
<p class="MsoNormal"><span lang="EN-US">string delimiters; interpret escapes.</span></p>
</td>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">[=[...]=]</span></span></p>
</td>
<td width="284" colspan="4" valign="top">
<p class="MsoNormal"><span lang="EN-US">multi line strings; escape sequences are ignored.</span></p>
</td>
</tr>
<tr>
<td width="93" valign="top">
<p class="MsoNormal"><span lang="EN-US">\a bell</span></p>
</td>
<td width="93" colspan="2" valign="top">
<p class="MsoNormal"><span lang="EN-US">\b backspace</span></p>
</td>
<td width="93" valign="top">
<p class="MsoNormal"><span lang="EN-US">\f form feed</span></p>
</td>
<td width="93" colspan="3" valign="top">
<p class="MsoNormal"><span lang="EN-US">\n newline</span></p>
</td>
<td width="93" valign="top">
<p class="MsoNormal"><span lang="EN-US">\r return</span></p>
</td>
<td width="93" valign="top">
<p class="MsoNormal"><span lang="EN-US">\t horiz. tab</span></p>
</td>
<td width="93" valign="top">
<p class="MsoNormal"><span lang="EN-US">\v vert. tab</span></p>
</td>
</tr>
<tr>
<td width="93" valign="top">
<p class="MsoNormal"><span lang="EN-US">\\ backslash</span></p>
</td>
<td width="93" colspan="2" valign="top">
<p class="MsoNormal"><span lang="EN-US">\" d. quote</span></p>
</td>
<td width="93" valign="top">
<p class="MsoNormal"><span lang="EN-US">\' quote</span></p>
</td>
<td width="93" colspan="3" valign="top">
<p class="MsoNormal"><span lang="EN-US">\[ sq. bracket</span></p>
</td>
<td width="93" valign="top">
<p class="MsoNormal"><span lang="EN-US">\] sq. bracket</span></p>
</td>
<td width="93" valign="top">
<p class="MsoNormal"><span lang="EN-US">\ddd decimal</span></p>
</td>
<td width="93" valign="top">
<p class="MsoNormal"><span lang="EN-US"> </span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Operators, decreasing
precedence</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="650" colspan="6" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">^</span></span> <span lang="EN-US"> (right associative, math library required)</span></p>
</td>
</tr>
<tr>
<td width="217" colspan="2" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">not</span></span></p>
</td>
<td width="217" colspan="2" valign="top">
<p class="MsoNormal"><span lang="EN-US"># (length of strings and tables)</span></p>
</td>
<td width="217" colspan="2" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-</span></span> <span lang="EN-US"> (unary)</span></p>
</td>
</tr>
<tr>
<td width="217" colspan="2" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">*</span></span></p>
</td>
<td width="217" colspan="2" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">/</span></span></p>
</td>
<td width="217" colspan="2" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%</span></span></p>
</td>
</tr>
<tr>
<td width="325" colspan="3" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">+</span></span></p>
</td>
<td width="325" colspan="3" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-</span></span></p>
</td>
</tr>
<tr>
<td width="650" colspan="6" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">..</span></span> <span lang="EN-US"> (string concatenation, right associative)</span></p>
</td>
</tr>
<tr>
<td width="108" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US"><</span></span></p>
</td>
<td width="108" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">></span></span></p>
</td>
<td width="108" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US"><=</span></span></p>
</td>
<td width="108" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">>=</span></span></p>
</td>
<td width="108" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">~=</span></span></p>
</td>
<td width="108" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">==</span></span></p>
</td>
</tr>
<tr>
<td width="650" colspan="6" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">and</span></span> <span lang="EN-US"> (stops on <span class="LuaCbold">false</span> or <span class="LuaCbold">nil</span> , returns last evaluated value)</span></p>
</td>
</tr>
<tr>
<td width="650" colspan="6" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">or</span></span> <span lang="EN-US"> (stops on <span class="LuaCbold">true</span> (not <span class="LuaCbold">false</span> or <span class="LuaCbold">nil</span> ), returns last
evaluated value)</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Assignment and
coercion</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="142" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">a = 5 b= "hi"</span></span></p>
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">local a = a</span></span></p>
</td>
<td width="508" valign="top">
<p class="MsoNormal"><span lang="EN-US">simple assignment; variables are not typed and can hold different types. Local variables are lexically scoped; their scope begins after the full declaration (so that local <span class="LuaCbold">a</span> =
5).</span></p>
</td>
</tr>
<tr>
<td width="142" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">a, b, c = 1, 2, 3</span></span></p>
</td>
<td width="508" valign="top">
<p class="MsoNormal"><span lang="EN-US">multiple assignments are supported</span></p>
</td>
</tr>
<tr>
<td width="142" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">a, b = b, a</span></span></p>
</td>
<td width="508" valign="top">
<p class="MsoNormal"><span lang="EN-US">swap values: right hand side is evaluated before assignment takes place</span></p>
</td>
</tr>
<tr>
<td width="142" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">a, b = 4, 5, "6"</span></span></p>
</td>
<td width="508" valign="top">
<p class="MsoNormal"><span lang="EN-US">excess values on right hand side ("6") are evaluated but discarded</span></p>
</td>
</tr>
<tr>
<td width="142" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">a, b = "there"</span></span></p>
</td>
<td width="508" valign="top">
<p class="MsoNormal"><span lang="EN-US">for missing values</span> <span lang="EN-US">on right hand side <span class="LuaCbold">nil</span> is assumed</span></p>
</td>
</tr>
<tr>
<td width="142" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">a = nil</span></span></p>
</td>
<td width="508" valign="top">
<p class="MsoNormal"><span lang="EN-US">destroys <span class="LuaCbold">a</span> ; its contents are eligible for garbage collection if unreferenced.</span></p>
</td>
</tr>
<tr>
<td width="142" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">a = z</span></span></p>
</td>
<td width="508" valign="top">
<p class="MsoNormal"><span lang="EN-US">if <span class="LuaCbold">z</span> is not defined it is <span class="LuaCbold">nil</span> , so <span class="LuaCbold">nil</span> is assigned to <span class="LuaCbold">a</span> (destroying it)</span></p>
</td>
</tr>
<tr>
<td width="142" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">a = "3" + "2"</span></span></p>
</td>
<td width="508" valign="top">
<p class="MsoNormal"><span lang="EN-US">numbers expected, strings are converted to numbers (a = 5)</span></p>
</td>
</tr>
<tr>
<td width="142" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">a = 3 .. 2</span></span></p>
</td>
<td width="508" valign="top">
<p class="MsoNormal"><span lang="EN-US">strings expected, numbers are converted to strings (a = "32")</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Control structures</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="331" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">do</span></span> <span class="LuaCitalic"><span lang="EN-US">block</span></span> <span class="LuaCbold"><span lang="EN-US">end</span></span></p>
</td>
<td width="319" valign="top">
<p class="MsoNormal"><span lang="EN-US">block; introduces local scope.</span></p>
</td>
</tr>
<tr>
<td width="331" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">if</span></span> <span class="LuaCitalic"><span lang="EN-US">exp</span></span> <span class="LuaCbold"><span lang="EN-US">then</span></span> <span class="LuaCitalic"><span lang=
"EN-US">block</span></span> <span lang="EN-US">{ <span class="LuaCbold">elseif</span> <span class="LuaCitalic">exp</span> <span class="LuaCbold">then</span> <span class="LuaCitalic">block</span> } [ <span class="LuaCbold">else</span> <span class=
"LuaCitalic">block</span> ] <span class="LuaCbold">end</span></span></p>
</td>
<td width="319" valign="top">
<p class="MsoNormal"><span lang="EN-US">conditional execution</span></p>
</td>
</tr>
<tr>
<td width="331" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">while</span></span> <span class="LuaCitalic"><span lang="EN-US">exp</span></span> <span class="LuaCbold"><span lang="EN-US">do</span></span> <span class="LuaCitalic"><span lang=
"EN-US">block</span></span> <span class="LuaCbold"><span lang="EN-US">end</span></span></p>
</td>
<td width="319" valign="top">
<p class="MsoNormal"><span lang="EN-US">loop as long as <span class="LuaCitalic">exp</span> is true</span></p>
</td>
</tr>
<tr>
<td width="331" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">repeat</span></span> <span class="LuaCitalic"><span lang="EN-US">block</span></span> <span class="LuaCbold"><span lang="EN-US">until</span></span> <span class="LuaCitalic"><span lang=
"EN-US">exp</span></span></p>
</td>
<td width="319" valign="top">
<p class="MsoNormal"><span lang="EN-US">exits when <span class="LuaCitalic">exp</span> becomes true; <span class="LuaCitalic">exp</span> is in loop scope.</span></p>
</td>
</tr>
<tr>
<td width="331" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">for</span></span> <span class="LuaCitalic"><span lang="EN-US">var</span></span> <span lang="EN-US">= <span class="LuaCitalic">start</span> <span class="LuaCbold">,</span> <span class=
"LuaCitalic">end</span> [ <span class="LuaCbold">,</span> <span class="LuaCitalic">step</span> ] <span class="LuaCbold">do</span> <span class="LuaCitalic">block</span> <span class="LuaCbold">end</span></span></p>
</td>
<td width="319" valign="top">
<p class="MsoNormal"><span lang="EN-US">numerical for loop; <span class="LuaCitalic">var</span> is local to loop.</span></p>
</td>
</tr>
<tr>
<td width="331" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">for</span></span> <span class="LuaCitalic"><span lang="EN-US">vars</span></span> <span class="LuaCbold"><span lang="EN-US">in</span></span> <span class="LuaCitalic"><span lang=
"EN-US">iterator</span></span> <span class="LuaCbold"><span lang="EN-US">do</span></span> <span class="LuaCitalic"><span lang="EN-US">block</span></span> <span class="LuaCbold"><span lang="EN-US">end</span></span></p>
</td>
<td width="319" valign="top">
<p class="MsoNormal"><span lang="EN-US">iterator based for loop; <span class="LuaCitalic">vars</span> are local to loop.</span></p>
</td>
</tr>
<tr>
<td width="331" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">break</span></span></p>
</td>
<td width="319" valign="top">
<p class="MsoNormal"><span lang="EN-US">exits loop; must be last statement in block.</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Table constructors</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="331" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">t = {}</span></span></p>
</td>
<td width="319" valign="top">
<p class="MsoNormal"><span lang="EN-US">creates an empty table and assigns it to <span class="LuaCbold">t</span></span></p>
</td>
</tr>
<tr>
<td width="331" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">t = {"yes", "no", "?"}</span></span></p>
</td>
<td width="319" valign="top">
<p class="MsoNormal"><span lang="EN-US">simple array; elements are <span class="LuaCbold">t[1]</span> , <span class="LuaCbold">t[2]</span> , <span class="LuaCbold">t[3]</span> .</span></p>
</td>
</tr>
<tr>
<td width="331" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">t = { [1] = "yes", [2] = "no", [3] = "?" }</span></span></p>
</td>
<td width="319" valign="top">
<p class="MsoNormal"><span lang="EN-US">same as above, but with explicit fields</span></p>
</td>
</tr>
<tr>
<td width="331" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">t = {[-900] = 3, [+900] = 4}</span></span></p>
</td>
<td width="319" valign="top">
<p class="MsoNormal"><span lang="EN-US">sparse array with just two elements (no space wasted)</span></p>
</td>
</tr>
<tr>
<td width="331" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">t = {x=5, y=10}</span></span></p>
</td>
<td width="319" valign="top">
<p class="MsoNormal"><span lang="EN-US">hash table, fields are <span class="LuaCbold">t["x"]</span> , <span class="LuaCbold">t["y"]</span> (or <span class="LuaCbold">t.x</span> , <span class="LuaCbold">t.y</span> )</span></p>
</td>
</tr>
<tr>
<td width="331" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">t = {x=5, y=10; "yes", "no"}</span></span></p>
</td>
<td width="319" valign="top">
<p class="MsoNormal"><span lang="EN-US">mixed, fields/elements are <span class="LuaCbold">t.x</span> , <span class="LuaCbold">t.y</span> , <span class="LuaCbold">t[1]</span> , <span class="LuaCbold">t[2]</span></span></p>
</td>
</tr>
<tr>
<td width="331" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">t = {msg = "choice", {"yes", "no", "?"}}</span></span></p>
</td>
<td width="319" valign="top">
<p class="MsoNormal"><span lang="EN-US">tables can contain others tables as fields</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Function definition</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="331" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">function</span></span> <span class="LuaCitalic"><span lang="EN-US">name</span></span> <span class="LuaCbold"><span lang="EN-US">(</span></span> <span class="LuaCitalic"><span lang=
"EN-US">args</span></span> <span class="LuaCbold"><span lang="EN-US">)</span></span> <span class="LuaCitalic"><span lang="EN-US">body</span></span> <span lang="EN-US">[ <span class="LuaCbold">return</span> <span class="LuaCitalic">values</span> ]
<span class="LuaCbold">end</span></span></p>
</td>
<td width="319" valign="top">
<p class="MsoNormal"><span lang="EN-US">defines function and assigns to global variable <span class="LuaCbold">name</span></span></p>
</td>
</tr>
<tr>
<td width="331" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">local function</span></span> <span class="LuaCitalic"><span lang="EN-US">name</span></span> <span class="LuaCbold"><span lang="EN-US">(</span></span> <span class=
"LuaCitalic"><span lang="EN-US">args</span></span> <span class="LuaCbold"><span lang="EN-US">)</span></span> <span class="LuaCitalic"><span lang="EN-US">body</span></span> <span lang="EN-US">[ <span class="LuaCbold">return</span> <span class=
"LuaCitalic">values</span> ] <span class="LuaCbold">end</span></span></p>
</td>
<td width="319" valign="top">
<p class="MsoNormal"><span lang="EN-US">defines function as local to chunk</span></p>
</td>
</tr>
<tr>
<td width="331" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">f = function (</span></span> <span class="LuaCitalic"><span lang="EN-US">args</span></span> <span class="LuaCbold"><span lang="EN-US">)</span></span></p>
</td>
<td width="319" valign="top">
<p class="MsoNormal"><span lang="EN-US">anonymous function assigned to variable <span class="LuaCbold">f</span></span></p>
</td>
</tr>
<tr>
<td width="331" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">function (</span></span> <span lang="EN-US">[ <span class="LuaCitalic">args</span> , ] <span class="LuaCbold">... )</span> <span class="LuaCitalic">body</span> [ <span class=
"LuaCbold">return</span> <span class="LuaCitalic">values</span> ] <span class="LuaCbold">end</span></span></p>
</td>
<td width="319" valign="top">
<p class="MsoNormal"><span lang="EN-US">variable argument list, in <span class="LuaCitalic">body</span> accessed as <span class="LuaCbold">...</span></span></p>
</td>
</tr>
<tr>
<td width="331" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">function</span></span> <span class="LuaCitalic"><span lang="EN-US">t</span></span> <span class="LuaCbold"><span lang="EN-US">.</span></span> <span class="LuaCitalic"><span lang=
"EN-US">name</span></span></p>
</td>
<td width="319" valign="top">
<p class="MsoNormal"><span lang="EN-US">shortcut for <span class="LuaCitalic">t</span> <span class="LuaCbold">.</span> <span class="LuaCitalic">name</span> = <span class="LuaCbold">function</span> <span class="LuaCbold">...</span></span></p>
</td>
</tr>
<tr>
<td width="331" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">function</span></span> <span class="LuaCitalic"><span lang="EN-US">obj</span></span> <span class="LuaCbold"><span lang="EN-US">:</span></span> <span class="LuaCitalic"><span lang=
"EN-US">name</span></span></p>
</td>
<td width="319" valign="top">
<p class="MsoNormal"><span lang="EN-US">object function, gets <span class="LuaCitalic">obj</span> as extra argument <span class="LuaCbold">self</span></span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Function call</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">f (x)</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">simple call, possibly returning one or more values</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">f "hello"</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">shortcut for <span class="LuaCbold">f("hello")</span></span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">f 'goodbye'</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">shortcut for <span class="LuaCbold">f('goodbye')</span></span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">f [[see you soon]]</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">shortcut for <span class="LuaCbold">f([[see you soon]])</span></span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">f {x = 3, y = 4}</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">shortcut for <span class="LuaCbold">f({x = 3, y = 4})</span></span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">t.f (x)</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">calling a function assigned to field <span class="LuaCbold">f</span> of table <span class="LuaCbold">t</span></span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">x:move (2, -3)</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">object call: shortcut for <span class="LuaCbold">x.move(x, 2, -3)</span> , <span class="LuaCbold">x</span> will be assigned to <span class="LuaCbold">self</span></span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Metatable operations (base
library required)</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">setmetatable</span></span> <span lang="EN-US">(t, mt)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">sets <span class="LuaCbold">mt</span> as metatable for <span class="LuaCbold">t</span> , unless <span class="LuaCbold">t</span> 's metatable has a <span class="LuaCbold">__metatable</span> field</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">getmetatable</span></span> <span lang="EN-US">(t)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns <span class="LuaCbold">__metatable</span> field of <span class="LuaCbold">t</span> 's metatable or <span class="LuaCbold">t</span> 's metatable or <span class="LuaCbold">nil</span></span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">rawget</span></span> <span lang="EN-US">(t, i)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">gets <span class="LuaCbold">t[i]</span> of a table without invoking metamethods</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">rawset</span></span> <span lang="EN-US">(t, i, v)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">sets <span class="LuaCbold">t[i] = v</span> on a table without invoking metamethods</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">rawequal</span></span> <span lang="EN-US">(t1, t2)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns boolean <span class="LuaCbold">(t1 == t2)</span> without invoking metamethods</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Metatable fields (for tables and
userdata)</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" width="650" summary="?">
<tr>
<td width="83" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__add, __sub</span></span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US">sets handler <span class="LuaCbold">h(a, b)</span> for ' <span class="LuaCbold">+</span> ' and for binary ' <span class="LuaCbold">-</span> '</span></p>
</td>
<td width="83" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__mul, __div</span></span></p>
</td>
<td width="236" valign="top">
<p class="MsoNormal"><span lang="EN-US">sets handler <span class="LuaCbold">h(a, b)</span> for ' <span class="LuaCbold">*</span> ' and for ' <span class="LuaCbold">/</span> '</span></p>
</td>
</tr>
<tr>
<td width="83" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__mod</span></span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US">set handler <span class="LuaCbold">h(a, b)</span> for '%'</span></p>
</td>
<td width="83" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__pow</span></span></p>
</td>
<td width="236" valign="top">
<p class="MsoNormal"><span lang="EN-US">sets handler <span class="LuaCbold">h(a, b)</span> for ' <span class="LuaCbold">^</span> '</span></p>
</td>
</tr>
<tr>
<td width="83" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__unm</span></span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US">sets handler <span class="LuaCbold">h(a)</span> for unary ' <span class="LuaCbold">-</span> '</span></p>
</td>
<td width="83" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__len</span></span></p>
</td>
<td width="236" valign="top">
<p class="MsoNormal"><span lang="EN-US">sets handler <span class="LuaCbold">h(a)</span> for the # operator</span></p>
</td>
</tr>
<tr>
<td width="83" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__concat</span></span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US">sets handler <span class="LuaCbold">h(a, b)</span> for '..'</span></p>
</td>
<td width="83" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__eq</span></span></p>
</td>
<td width="236" valign="top">
<p class="MsoNormal"><span lang="EN-US">sets handler <span class="LuaCbold">h(a, b)</span> for ' <span class="LuaCbold">==</span> ', ' <span class="LuaCbold">~=</span> '</span></p>
</td>
</tr>
<tr>
<td width="83" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__lt</span></span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US">sets handler <span class="LuaCbold">h(a, b)</span> for ' <span class="LuaCbold"><</span> ', ' <span class="LuaCbold">></span> ' and possibly ' <span class="LuaCbold"><=</span> ', ' <span class=
"LuaCbold">>=</span> ' (if no <span class="LuaCbold">__le</span> )</span></p>
</td>
<td width="83" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__le</span></span></p>
</td>
<td width="236" valign="top">
<p class="MsoNormal"><span lang="EN-US">sets handler <span class="LuaCbold">h(a, b)</span> for ' <span class="LuaCbold"><=</span> ', ' <span class="LuaCbold">>=</span> '</span></p>
</td>
</tr>
<tr>
<td width="83" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__index</span></span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US">sets handler <span class="LuaCbold">h(t, k)</span> for access to non-existing field</span></p>
</td>
<td width="83" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__newindex</span></span></p>
</td>
<td width="236" valign="top">
<p class="MsoNormal"><span lang="EN-US">sets handler <span class="LuaCbold">h(t, k)</span> for assignment to non-existing field</span></p>
</td>
</tr>
<tr>
<td width="83" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__call</span></span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US">sets handler <span class="LuaCbold">h(f, ...)</span> for function call (using the object as a function)</span></p>
</td>
<td width="83" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__tostring</span></span></p>
</td>
<td width="236" valign="top">
<p class="MsoNormal"><span lang="EN-US">sets handler <span class="LuaCbold">h(a)</span> to convert to string, e.g. for <span class="LuaCbold">print()</span></span></p>
</td>
</tr>
<tr>
<td width="83" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__gc</span></span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US">sets finalizer <span class="LuaCbold">h(ud)</span> for userdata (has to be set from C)</span></p>
</td>
<td width="83" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__mode</span></span></p>
</td>
<td width="236" valign="top">
<p class="MsoNormal"><span lang="EN-US">table mode: <span class="LuaCbold">'k'</span> = weak keys; <span class="LuaCbold">'v'</span> = weak values; <span class="LuaCbold">'kv'</span> = both.</span></p>
</td>
</tr>
<tr>
<td width="83" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__metatable</span></span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US">sets value to be returned by <span class="LuaCbold">getmetatable()</span></span></p>
</td>
<td width="83" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US"> </span></span></p>
</td>
<td width="236" valign="top">
<p class="MsoNormal"><span lang="EN-US"> </span></p>
</td>
</tr>
</table>
<p class="LuaPHeader1"><a name="The_base_library" id="The_base_library"><span lang="EN-US">The base library [no prefix]</span></a></p>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Environment and global
variables</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">getfenv</span></span> <span lang="EN-US">([f])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">if <span class="LuaCbold">f</span> is a function, returns its environment; if <span class="LuaCbold">f</span> is a number, returns the environment of function at level <span class="LuaCbold">f</span> (1 =
current [default], 0 = global); if the environment has a field <span class="LuaCbold">__fenv</span> , returns that instead.</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">setfenv</span></span> <span lang="EN-US">(f, t)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">sets environment for function <span class="LuaCbold">f</span> or function at level <span class="LuaCbold">f</span> (0 = current thread);</span></p>
<p class="MsoNormal"><span lang="EN-US">if the original environment has a field <span class="LuaCbold">__fenv</span> , raises an error.</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">_G</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">global variable whose value is the global environment (that is, <span class="LuaCbold">_G._G == _G</span> <span class="LuaCbold"><span style="font-weight:normal">)</span></span></span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">_VERSION</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">global variable containing the interpreter's version (e.g. <span class="LuaCbold">"Lua 5.1"</span> )</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Loading and executing</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">require</span></span> <span lang="EN-US">(pkgname)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">loads a package, raises error if it can't be loaded</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">dofile</span></span> <span lang="EN-US">([filename])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">loads and executes the contents of <span class="LuaCbold">filename</span> [default: standard input]; returns its returned values.</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">load</span></span> <span lang="EN-US">(func [, chunkname])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">loads a chunk (with chunk name set to <span class="LuaCbold">name</span> ) using function <span class="LuaCbold">func</span> to get its pieces; returns compiled chunk as function (or <span class=
"LuaCbold">nil</span> and error message).</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">loadfile</span></span> <span lang="EN-US">(filename)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">loads file <span class="LuaCbold">filename</span> ; return values like <span class="LuaCbold">load()</span> .</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">loadstring</span></span> <span lang="EN-US">(s [, name])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">loads string <span class="LuaCbold">s</span> (with chunk name set to <span class="LuaCbold">name</span> ); return values like <span class="LuaCbold">load()</span> .</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">pcall</span></span> <span lang="EN-US">(f [, <span class="LuaCitalic">args</span> ])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">calls <span class="LuaCbold">f()</span> in protected mode; returns <span class="LuaCbold">true</span> and function results or <span class="LuaCbold">false</span> and error message.</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">xpcall</span></span> <span lang="EN-US">(f, h)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">as <span class="LuaCbold">pcall()</span> but passes error handler <span class="LuaCbold">h</span> instead of extra args; returns as <span class="LuaCbold">pcall()</span> but with the result of <span class=
"LuaCbold">h()</span> as error message, if any.</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Simple output and error
feedback</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">print</span></span> <span lang="EN-US">( <span class="LuaCitalic">args</span> )</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">prints each of the passed <span class="LuaCitalic">args</span> to stdout using <span class="LuaCbold">tostring()</span> (see below)</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">error</span></span> <span lang="EN-US">(msg [, n])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">terminates the program or the last protected call (e.g. <span class="LuaCbold">pcall()</span> ) with error message <span class="LuaCbold">msg</span> quoting level <span class="LuaCbold">n</span> [default: 1,
current function]</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">assert</span></span> <span lang="EN-US">(v [, msg])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">calls <span class="LuaCbold">error(msg)</span> if <span class="LuaCbold">v</span> is <span class="LuaCbold">nil</span> or <span class="LuaCbold">false</span> [default <span class="LuaCbold">msg</span> :
<span class="LuaCbold">"assertion failed!"</span> ]</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US"> Information and
conversion</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">select</span></span> <span lang="EN-US">(index, ...)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns the arguments after argument number <span class="LuaCbold">index</span> or (if index is "#") the total number of arguments it received after <span class="LuaCbold">index</span></span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">type</span></span> <span lang="EN-US">(x)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns the type of <span class="LuaCbold">x</span> as a string (e.g. <span class="LuaCbold">"nil"</span> , <span class="LuaCbold">"string"</span> ); see <span class="LuaCitalic">Types</span>
above.</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">tostring</span></span> <span lang="EN-US">(x)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">converts <span class="LuaCbold">x</span> to a string, using <span class="LuaCbold">t</span> 's metatable's <span class="LuaCbold">__tostring</span> if available</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">tonumber</span></span> <span lang="EN-US">(x [, b])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">converts string <span class="LuaCbold">x</span> representing a number in base <span class="LuaCbold">b</span> [2..36, default: 10] to a number, or <span class="LuaCbold">nil</span> if invalid; for base 10
accepts full format (e.g. "1.5e6").</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">unpack</span></span> <span lang="EN-US">(t)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns <span class="LuaCbold">t[1]</span> .. <span class="LuaCbold">t[n]</span> (n = <span class="LuaCbold">#t</span> ) as separate values</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Iterators</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">ipairs</span></span> <span lang="EN-US">(t)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns an iterator getting <span class="LuaCbold">index, value</span> pairs of array <span class="LuaCbold">t</span> in numerical order</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">pairs</span></span> <span lang="EN-US">(t)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns an iterator getting <span class="LuaCbold">key, value</span> pairs of table <span class="LuaCbold">t</span> in an unspecified order</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">next</span></span> <span lang="EN-US">(t [, inx])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">if <span class="LuaCbold">inx</span> is <span class="LuaCbold">nil</span> [default] returns first <span class="LuaCbold">index, value</span> pair of table <span class="LuaCbold">t</span> ; if <span class=
"LuaCbold">inx</span> is the previous index returns next <span class="LuaCbold">index, value</span> pair or <span class="LuaCbold">nil</span> when finished.</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Garbage collection</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">collectgarbage</span></span> <span lang="EN-US">(opt [, arg])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">generic interface to the garbage collector; <span class="LuaCbold">opt</span> defines function performed.</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader1"><a name="Modules_and_the_package_library" id="Modules_and_the_package_library"><span lang="EN-US">Modules and the package library [package]</span></a></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="166" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">module</span></span> <span lang="EN-US">(name, ...)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">creates module <span class="LuaCbold">name.</span> If there is a table in <span class="LuaCbold">package.loaded[name]</span> , this table is the module. Otherwise, if there is a global table <span class=
"LuaCbold">name</span> , this table is the module. Otherwise creates a new table and sets it as the value of the global <span class="LuaCbold">name</span> and the value of <span class="LuaCbold">package.loaded[name]</span> . Optional arguments are
functions to be applied over the module.</span></p>
</td>
</tr>
<tr>
<td width="166" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">package.loadlib</span></span> <span lang="EN-US">(lib, func)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">loads dynamic library <span class="LuaCbold">lib</span> (e.g. .so or .dll) and returns function <span class="LuaCbold">func (</span> or <span class="LuaCbold">nil</span> and error message)</span></p>
</td>
</tr>
<tr>
<td width="166" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">package.path, package.cpath</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">contains the paths used by <span class="LuaCbold">require()</span> to search for a Lua or C loader, respectively</span></p>
</td>
</tr>
<tr>
<td width="166" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">package.loaded</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">a table used by require to control which modules are already loaded (see module)</span></p>
</td>
</tr>
<tr>
<td width="166" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">package.preload</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">a table to store loaders for specific modules (see require)</span></p>
</td>
</tr>
<tr>
<td width="166" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">package.seeall</span></span> <span lang="EN-US">(module)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">sets a metatable for <span class="LuaCbold">module</span> with its <span class="LuaCbold">__index</span> field referring to the global environment</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader1"><a name="The_coroutine_library" id="The_coroutine_library"><span lang="EN-US">The coroutine library [coroutine]</span></a></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="168" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">coroutine.create</span></span> <span lang="EN-US">(f)</span></p>
</td>
<td width="482" valign="top">
<p class="MsoNormal"><span lang="EN-US">creates a new coroutine with Lua function <span class="LuaCbold">f()</span> as body and returns it</span></p>
</td>
</tr>
<tr>
<td width="168" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">coroutine.resume</span></span> <span lang="EN-US">(co, <span class="LuaCitalic">args</span> )</span></p>
</td>
<td width="482" valign="top">
<p class="MsoNormal"><span lang="EN-US">starts or continues running coroutine <span class="LuaCbold">co</span> , passing <span class="LuaCitalic">args</span> to it; returns <span class="LuaCbold">true</span> (and possibly values) if <span class=
"LuaCbold">co</span> calls <span class="LuaCbold">coroutine.yield()</span> or terminates or <span class="LuaCbold">false</span> and an error message.</span></p>
</td>
</tr>
<tr>
<td width="168" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">coroutine.yield</span></span> <span lang="EN-US">( <span class="LuaCitalic">args</span> )</span></p>
</td>
<td width="482" valign="top">
<p class="MsoNormal"><span lang="EN-US">suspends execution of the calling coroutine (not from within C functions, metamethods or iterators); any <span class="LuaCitalic">args</span> become extra return values of <span class=
"LuaCbold">coroutine.resume()</span> .</span></p>
</td>
</tr>
<tr>
<td width="168" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">coroutine.status</span></span> <span lang="EN-US">(co)</span></p>
</td>
<td width="482" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns the status of coroutine <span class="LuaCbold">co</span> : either <span class="LuaCbold">"running"</span> , <span class="LuaCbold">"suspended"</span> or <span class=
"LuaCbold">"dead"</span></span></p>
</td>
</tr>
<tr>
<td width="168" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">coroutine.running ()</span></span></p>
</td>
<td width="482" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns the running coroutine or nil when called by the main thread</span></p>
</td>
</tr>
<tr>
<td width="168" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">coroutine.wrap</span></span> <span lang="EN-US">(f)</span></p>
</td>
<td width="482" valign="top">
<p class="MsoNormal"><span lang="EN-US">creates a new coroutine with Lua function <span class="LuaCbold">f</span> as body and returns a function; this function will act as <span class="LuaCbold">coroutine.resume()</span> without the first argument
and the first return value, propagating any errors.</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader1"><a name="The_table_library" id="The_table_library"><span lang="EN-US">The table library [table]</span></a></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="168" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">table.insert</span></span> <span lang="EN-US">(t, [i,] v)</span></p>
</td>
<td width="482" valign="top">
<p class="MsoNormal"><span lang="EN-US">inserts <span class="LuaCbold">v</span> at numerical index <span class="LuaCbold">i</span> [default: after the end] in table <span class="LuaCbold">t</span></span></p>
</td>
</tr>
<tr>
<td width="168" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">table.remove</span></span> <span lang="EN-US">(t [, i])</span></p>
</td>
<td width="482" valign="top">
<p class="MsoNormal"><span lang="EN-US">removes element at numerical index <span class="LuaCbold">i</span> [default: last element] from table <span class="LuaCbold">t</span> ; returns the removed element or <span class="LuaCbold">nil</span> on
empty table.</span></p>
</td>
</tr>
<tr>
<td width="168" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">table.maxn</span></span> <span lang="EN-US">(t)</span></p>
</td>
<td width="482" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns the largest positive numerical index of table <span class="LuaCbold">t</span> or zero if <span class="LuaCbold">t</span> has no positive indices</span></p>
</td>
</tr>
<tr>
<td width="168" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">table.sort</span></span> <span lang="EN-US">(t [, cf])</span></p>
</td>
<td width="482" valign="top">
<p class="MsoNormal"><span lang="EN-US">sorts (in place) elements from <span class="LuaCbold">t[1]</span> to # <span class="LuaCbold">t</span> , using compare function <span class="LuaCbold">cf(e1, e2)</span> [default: ' <span class=
"LuaCbold"><</span> ']</span></p>
</td>
</tr>
<tr>
<td width="168" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">table.concat</span></span> <span lang="EN-US">(t [, s [, i [, j]]])</span></p>
</td>
<td width="482" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns a single string made by concatenating table elements <span class="LuaCbold">t[i]</span> to <span class="LuaCbold">t[j]</span> [default: <span class="LuaCbold">i =1</span> , <span class="LuaCbold">j =
#t</span> ] separated by string <span class="LuaCbold">s</span> ; returns empty string if no elements exist or <span class="LuaCbold">i</span> > <span class="LuaCbold">j</span> .</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader1"><a name="The_mathematical_library" id="The_mathematical_library"><span lang="EN-US">The mathematical library [math]</span></a></p>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Basic operations</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.abs</span></span> <span lang="EN-US">(x)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns the absolute value of <span class="LuaCbold">x</span></span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.mod</span></span> <span lang="EN-US">(x, y)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns the remainder of <span class="LuaCbold">x</span> / <span class="LuaCbold">y</span> as a rounded-down integer, for <span class="LuaCbold">y</span> ~= 0</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.floor</span></span> <span lang="EN-US">(x)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns <span class="LuaCbold">x</span> rounded down to the nearest integer</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.ceil</span></span> <span lang="EN-US">(x)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns <span class="LuaCbold">x</span> rounded up to the nearest integer</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.min</span></span> <span lang="EN-US">( <span class="LuaCitalic">args</span> )</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns the minimum value from the <span class="LuaCitalic">args</span> received</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.max</span></span> <span lang="EN-US">( <span class="LuaCitalic">args</span> )</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns the maximum value from the <span class="LuaCitalic">args</span> received</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Exponential and
logarithmic</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.sqrt</span></span> <span lang="EN-US">(x)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns the square root of <span class="LuaCbold">x</span> , for <span class="LuaCbold">x</span> >= 0</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.pow</span></span> <span lang="EN-US">(x, y)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns <span class="LuaCbold">x</span> raised to the power of <span class="LuaCbold">y</span> , i.e. <span class="LuaCbold">x</span> ^ <span class="LuaCbold">y</span> ; if <span class="LuaCbold">x</span>
< 0, <span class="LuaCbold">y</span> must be integer.</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__pow</span></span> <span lang="EN-US">(x, y)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">global function added by the math library to make operator ' <span class="LuaCbold">^</span> ' work</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.exp</span></span> <span lang="EN-US">(x)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns e (base of natural logs) raised to the power of <span class="LuaCbold">x</span> , i.e. e^ <span class="LuaCbold">x</span></span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.log</span></span> <span lang="EN-US">(x)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns the natural logarithm of <span class="LuaCbold">x</span> , for <span class="LuaCbold">x</span> >= 0</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.log10</span></span> <span lang="EN-US">(x)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns the base-10 logarithm of <span class="LuaCbold">x</span> , for <span class="LuaCbold">x</span> >= 0</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Trigonometrical</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.deg</span></span> <span lang="EN-US">(a)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">converts angle <span class="LuaCbold">a</span> from radians to degrees</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.rad</span></span> <span lang="EN-US">(a)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">converts angle <span class="LuaCbold">a</span> from degrees to radians</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.pi</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">constant containing the value of pi</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.sin</span></span> <span lang="EN-US">(a)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns the sine of angle <span class="LuaCbold">a</span> (measured in radians)</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.cos</span></span> <span lang="EN-US">(a)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns the cosine of angle <span class="LuaCbold">a</span> (measured in radians)</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.tan</span></span> <span lang="EN-US">(a)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns the tangent of angle <span class="LuaCbold">a</span> (measured in radians)</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.asin</span></span> <span lang="EN-US">(x)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns the arc sine of <span class="LuaCbold">x</span> in radians, for <span class="LuaCbold">x</span> in [-1, 1]</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.acos</span></span> <span lang="EN-US">(x)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns the arc cosine of <span class="LuaCbold">x</span> in radians, for <span class="LuaCbold">x</span> in [-1, 1]</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.atan</span></span> <span lang="EN-US">(x)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns the arc tangent of <span class="LuaCbold">x</span> in radians</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.atan2</span></span> <span lang="EN-US">(y, x)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">similar to <span class="LuaCbold">math.atan(y / x)</span> but with quadrant and allowing x = 0</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Splitting on powers of
2</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.frexp</span></span> <span lang="EN-US">(x)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">splits <span class="LuaCbold">x</span> into normalized fraction and exponent of 2 and returns both</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.ldexp</span></span> <span lang="EN-US">(x, y)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns <span class="LuaCbold">x</span> * (2 ^ <span class="LuaCbold">y</span> ) with <span class="LuaCbold">x</span> = normalized fraction, <span class="LuaCbold">y</span> = exponent of <span class=
"LuaCbold">2</span></span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Pseudo-random numbers</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.random</span></span> <span lang="EN-US">([n [, m])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns a pseudo-random number in range [0, 1] if no arguments given; in range [1, <span class="LuaCbold">n</span> ] if <span class="LuaCbold">n</span> is given, in range [ <span class="LuaCbold">n</span> ,
<span class="LuaCbold">m</span> ] if both <span class="LuaCbold">n</span> and <span class="LuaCbold">m</span> are passed.</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.randomseed</span></span> <span lang="EN-US">(n)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">sets a seed <span class="LuaCbold">n</span> for random sequence (same seed = same sequence)</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader1"><a name="The_string_library" id="The_string_library"><span lang="EN-US">The string library [string]</span></a></p>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Basic operations</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.len</span></span> <span lang="EN-US">(s)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns the length of string <span class="LuaCbold">s</span> , including embedded zeros (see also # operator)</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.sub</span></span> <span lang="EN-US">(s, i [, j])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns the substring of <span class="LuaCbold">s</span> from position <span class="LuaCbold">i</span> to <span class="LuaCbold">j</span> [default: -1] inclusive</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.rep</span></span> <span lang="EN-US">(s, n)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns a string made of <span class="LuaCbold">n</span> concatenated copies of string <span class="LuaCbold">s</span></span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.upper</span></span> <span lang="EN-US">(s)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns a copy of <span class="LuaCbold">s</span> converted to uppercase according to locale</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.lower</span></span> <span lang="EN-US">(s)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns a copy of <span class="LuaCbold">s</span> converted to lowercase according to locale</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Character codes</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.byte</span></span> <span lang="EN-US">(s [, i])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns the platform-dependent numerical code (e.g. ASCII) of character at position <span class="LuaCbold">i</span> [default: 1] in string <span class="LuaCbold">s</span> , or <span class=
"LuaCbold">nil</span> if <span class="LuaCbold">i</span> is invalid</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.char</span></span> <span lang="EN-US">( <span class="LuaCitalic">args</span> )</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns a string made of the characters whose platform-dependent numerical codes are passed as <span class="LuaCitalic">args</span></span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Function storage</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.dump</span></span> <span lang="EN-US">(f)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns a binary representation of function <span class="LuaCbold">f()</span> , for later use with <span class="LuaCbold">loadstring()</span> ( <span class="LuaCbold">f()</span> must be a Lua function with
no upvalues)</span></p>
</td>
</tr>
</table>
<p class="MsoNormal"><span lang="EN-GB">Note: string indexes extend from 1 to #string, or from end of string if negative (index -1 refers to the last character).</span></p>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Formatting</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.format</span></span> <span lang="EN-US">(s [, <span class="LuaCitalic">args</span> ])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns a copy of <span class="LuaCbold">s</span> where formatting directives beginning with ' <span class="LuaCbold">%</span> ' are replaced by the value of arguments <span class="LuaCitalic">args</span> ,
in the given order (see <span class="LuaCitalic">Formatting directives</span> below)</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Formatting directives for
string.format</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="650" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%</span></span> <span lang="EN-US">[ <span class="LuaCitalic">flags</span> ] [ <span class="LuaCitalic">field_width</span> ] [ <span class="LuaCbold">.</span> <span class=
"LuaCitalic">precision</span> ] <span class="LuaCitalic">type</span></span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Formatting field
types</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%d</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">decimal integer</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%o</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">octal integer</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%x</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">hexadecimal integer, uppercase if <span class="LuaCbold">%X</span></span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%f</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">floating-point in the form [-]nnnn.nnnn</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%e</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">floating-point in exp. Form [-]n.nnnn e [+|-]nnn, uppercase if <span class="LuaCbold">%E</span></span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%g</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">floating-point as <span class="LuaCbold">%e</span> if exp. < -4 or >= precision, else as <span class="LuaCbold">%f</span> ; uppercase if <span class="LuaCbold">%G</span> .</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%c</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">character having the (system-dependent) code passed as integer</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%s</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">string with no embedded zeros</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%q</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">string between double quotes, with all special characters escaped</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%%</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">' <span class="LuaCbold">%</span> ' character</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Formatting flags</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">left-justifies within <span class="LuaCbold">field_width</span> [default: right-justify]</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span lang="EN-US">+</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">prepends sign (only applies to numbers)</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span lang="EN-US">( <span class="LuaCbold">space</span> )</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">prepends sign if negative, else blank space</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">#</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">adds "0x" before <span class="LuaCbold">%x</span> , force decimal point for <span class="LuaCbold">%e</span> , <span class="LuaCbold">%f</span> , leaves trailing zeros for <span class=
"LuaCbold">%g</span></span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Formatting field width and
precision</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">n</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">puts at least <span class="LuaCbold">n</span> characters, pad with blanks</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">0n</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">puts at least <span class="LuaCbold">n</span> characters, left-pad with zeros</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">.n</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">puts at least <span class="LuaCbold">n</span> digits for integers; rounds to <span class="LuaCbold">n</span> decimals for floating-point; puts no more than <span class="LuaCbold">n</span> characters for
strings.</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Formatting examples</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="319" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.format("results: %d, %d", 13, 27)</span></span></p>
</td>
<td width="331" valign="top">
<p class="MsoNormal"><span lang="EN-US">results: 13, 27</span></p>
</td>
</tr>
<tr>
<td width="319" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.format("<%5d>", 13)</span></span></p>
</td>
<td width="331" valign="top">
<p class="MsoNormal"><span lang="EN-US">< 13></span></p>
</td>
</tr>
<tr>
<td width="319" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.format("<%-5d>", 13)</span></span></p>
</td>
<td width="331" valign="top">
<p class="MsoNormal"><span lang="EN-US"><13 ></span></p>
</td>
</tr>
<tr>
<td width="319" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.format("<%05d>", 13)</span></span></p>
</td>
<td width="331" valign="top">
<p class="MsoNormal"><span lang="EN-US"><00013></span></p>
</td>
</tr>
<tr>
<td width="319" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.format("<%06.3d>", 13)</span></span></p>
</td>
<td width="331" valign="top">
<p class="MsoNormal"><span lang="EN-US">< 013></span></p>
</td>
</tr>
<tr>
<td width="319" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.format("<%f>", math.pi)</span></span></p>
</td>
<td width="331" valign="top">
<p class="MsoNormal"><span lang="EN-US"><3.141593></span></p>
</td>
</tr>
<tr>
<td width="319" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.format("<%e>", math.pi)</span></span></p>
</td>
<td width="331" valign="top">
<p class="MsoNormal"><span lang="EN-US"><3.141593e+00></span></p>
</td>
</tr>
<tr>
<td width="319" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.format("<%.4f>", math.pi)</span></span></p>
</td>
<td width="331" valign="top">
<p class="MsoNormal"><span lang="EN-US"><3.1416></span></p>
</td>
</tr>
<tr>
<td width="319" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.format("<%9.4f>", math.pi)</span></span></p>
</td>
<td width="331" valign="top">
<p class="MsoNormal"><span lang="EN-US">< 3.1416></span></p>
</td>
</tr>
<tr>
<td width="319" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.format("<%c>", 64)</span></span></p>
</td>
<td width="331" valign="top">
<p class="MsoNormal"><span lang="EN-US"><@></span></p>
</td>
</tr>
<tr>
<td width="319" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.format("<%.4s>", "goodbye")</span></span></p>
</td>
<td width="331" valign="top">
<p class="MsoNormal"><span lang="EN-US"><good></span></p>
</td>
</tr>
<tr>
<td width="319" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.format("%q", [[she said "hi"]])</span></span></p>
</td>
<td width="331" valign="top">
<p class="MsoNormal"><span lang="EN-US">"she said \"hi\""</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Finding, replacing, iterating
(for the Patterns see below)</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.find</span></span> <span lang="EN-US">(s, p [, i [, d]])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns first and last position of pattern <span class="LuaCbold">p</span> in string <span class="LuaCbold">s</span> , or <span class="LuaCbold">nil</span> if not found, starting search at position
<span class="LuaCbold">i</span> [default: 1]; returns captures as extra results. If <span class="LuaCbold">d</span> is true, treat pattern as plain string.</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.gmatch</span></span> <span lang="EN-US">(s, p)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns an iterator getting next occurrence of pattern <span class="LuaCbold">p</span> (or its captures) in string <span class="LuaCbold">s</span> as substring(s) matching the pattern.</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.gsub</span></span> <span lang="EN-US">(s, p, r [, n])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns a copy of <span class="LuaCbold">s</span> with up to <span class="LuaCbold">n</span> [default: 1] occurrences of pattern <span class="LuaCbold">p</span> (or its captures) replaced by <span class=
"LuaCbold">r</span> if <span class="LuaCbold">r</span> is a string ( <span class="LuaCbold">r</span> can include references to captures in the form <span class="LuaCbold">%</span> <span class="LuaCitalic">n</span> ). If <span class=
"LuaCbold">r</span> is a function <span class="LuaCbold">r()</span> is called for each match and receives captured substrings; it should return the replacement string. If <span class="LuaCbold">r</span> is a table, the captures are used as fields
into the table. The function returns the number of substitutions made as second result.</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.match</span></span> <span lang="EN-US">(s, p [, i])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns captures of pattern <span class="LuaCbold">p</span> in string <span class="LuaCbold">s</span> (or the whole match if <span class="LuaCbold">p</span> specifies no captures) or <span class=
"LuaCbold">nil</span> if <span class="LuaCbold">p</span> does not match <span class="LuaCbold">s</span> ; starts search at position <span class="LuaCbold">i</span> [default: 1].</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Patterns and pattern
items</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="650" colspan="2" valign="top">
<p class="MsoNormal"><span lang="EN-US">General pattern format: <span class="LuaCitalic">pattern_item</span> [ <span class="LuaCitalic">pattern_items</span> ]</span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCitalic"><span lang="EN-US">cc</span></span></p>
</td>
<td width="579" valign="top">
<p class="MsoNormal"><span lang="EN-US">matches a single character in the class <span class="LuaCitalic">cc</span> (see <span class="LuaCitalic">Pattern character classes</span> below)</span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCitalic"><span lang="EN-US">cc</span></span> <span class="LuaCbold"><span lang="EN-US">*</span></span></p>
</td>
<td width="579" valign="top">
<p class="MsoNormal"><span lang="EN-US">matches zero or more characters in the class <span class="LuaCitalic">cc</span> ; matchest longest sequence (greedy).</span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCitalic"><span lang="EN-US">cc</span></span> <span class="LuaCbold"><span lang="EN-US">-</span></span></p>
</td>
<td width="579" valign="top">
<p class="MsoNormal"><span lang="EN-US">matches zero or more characters in the class <span class="LuaCitalic">cc</span> ; matchest shortest sequence (non-greedy).</span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCitalic"><span lang="EN-US">cc</span></span> <span class="LuaCbold"><span lang="EN-US">+</span></span></p>
</td>
<td width="579" valign="top">
<p class="MsoNormal"><span lang="EN-US">matches one or more characters in the class <span class="LuaCitalic">cc</span> ; matchest longest sequence (greedy).</span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCitalic"><span lang="EN-US">cc</span></span> <span class="LuaCbold"><span lang="EN-US">?</span></span></p>
</td>
<td width="579" valign="top">
<p class="MsoNormal"><span lang="EN-US">matches zero or one character in the class <span class="LuaCitalic">cc</span></span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%</span></span> <span class="LuaCitalic"><span lang="EN-US">n</span></span></p>
</td>
<td width="579" valign="top">
<p class="MsoNormal"><span lang="EN-US">matches the <span class="LuaCitalic">n</span> -th captured string ( <span class="LuaCitalic">n</span> = 1..9, see <span class="LuaCitalic">Pattern captures</span> )</span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%b</span></span> <span class="LuaCitalic"><span lang="EN-US">xy</span></span></p>
</td>
<td width="579" valign="top">
<p class="MsoNormal"><span lang="EN-US">matches the balanced string from character <span class="LuaCitalic">x</span> to character <span class="LuaCitalic">y</span> (e.g. <span class="LuaCbold">%b()</span> for nested parentheses)</span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">^</span></span></p>
</td>
<td width="579" valign="top">
<p class="MsoNormal"><span lang="EN-US">anchors pattern to start of string, must be the first item in the pattern</span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">$</span></span></p>
</td>
<td width="579" valign="top">
<p class="MsoNormal"><span lang="EN-US">anchors pattern to end of string, must be the last item in the pattern</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Captures</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span lang="EN-US">( <span class="LuaCitalic">pattern</span> )</span></p>
</td>
<td width="579" valign="top">
<p class="MsoNormal"><span lang="EN-US">stores substring matching <span class="LuaCitalic">pattern</span> as capture <span class="LuaCbold">%1</span> .. <span class="LuaCbold">%9</span> , in order of opening parentheses</span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span lang="EN-US">()</span></p>
</td>
<td width="579" valign="top">
<p class="MsoNormal"><span lang="EN-US">stores current string position as capture</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Pattern character
classes</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" width="650" summary="?">
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">.</span></span></p>
</td>
<td width="260" valign="top">
<p class="MsoNormal"><span lang="EN-US">any character</span></p>
</td>
<td width="71" valign="top">
<p class="MsoNormal"><span lang="EN-US"> </span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US"> </span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%a</span></span></p>
</td>
<td width="260" valign="top">
<p class="MsoNormal"><span lang="EN-US">any letter</span></p>
</td>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%A</span></span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US">any non-letter</span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%c</span></span></p>
</td>
<td width="260" valign="top">
<p class="MsoNormal"><span lang="EN-US">any control character</span></p>
</td>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%C</span></span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US">any non-control character</span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%d</span></span></p>
</td>
<td width="260" valign="top">
<p class="MsoNormal"><span lang="EN-US">any digit</span></p>
</td>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%D</span></span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US">any non-digit</span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%l</span></span></p>
</td>
<td width="260" valign="top">
<p class="MsoNormal"><span lang="EN-US">any lowercase letter</span></p>
</td>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%L</span></span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US">any non-(lowercase letter)</span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%p</span></span></p>
</td>
<td width="260" valign="top">
<p class="MsoNormal"><span lang="EN-US">any punctuation character</span></p>
</td>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%P</span></span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US">any non-punctuation character</span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%s</span></span></p>
</td>
<td width="260" valign="top">
<p class="MsoNormal"><span lang="EN-US">any whitespace character</span></p>
</td>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%S</span></span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US">any non-whitespace character</span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%u</span></span></p>
</td>
<td width="260" valign="top">
<p class="MsoNormal"><span lang="EN-US">any uppercase letter</span></p>
</td>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%U</span></span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US">any non-(uppercase letter)</span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%w</span></span></p>
</td>
<td width="260" valign="top">
<p class="MsoNormal"><span lang="EN-US">any alphanumeric character</span></p>
</td>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%W</span></span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US">any non-alphanumeric character</span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%x</span></span></p>
</td>
<td width="260" valign="top">
<p class="MsoNormal"><span lang="EN-US">any hexadecimal digit</span></p>
</td>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%X</span></span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US">any non-(hexadecimal digit)</span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%z</span></span></p>
</td>
<td width="260" valign="top">
<p class="MsoNormal"><span lang="EN-US">the byte value zero</span></p>
</td>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%Z</span></span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US">any non-zero character</span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%</span></span> <span class="LuaCitalic"><span lang="EN-US">x</span></span></p>
</td>
<td width="260" valign="top">
<p class="MsoNormal"><span lang="EN-US">if <span class="LuaCitalic">x</span> is a symbol the symbol itself</span></p>
</td>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCitalic"><span lang="EN-US">x</span></span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US">if <span class="LuaCitalic">x</span> not in ^$()%.[]*+-? the character itself</span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">[</span></span> <span class="LuaCitalic"><span lang="EN-US">set</span></span> <span class="LuaCbold"><span lang="EN-US">]</span></span></p>
</td>
<td width="260" valign="top">
<p class="MsoNormal"><span lang="EN-US">any character in any of the given classes; can also be a range <span class="LuaCbold">[</span> <span class="LuaCitalic">c1</span> <span class="LuaCbold">-</span> <span class="LuaCitalic">c2</span>
<span class="LuaCbold">]</span> , e.g. [a-z].</span></p>
</td>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">[</span></span> <span class="LuaCbold"><span lang="EN-US">^</span></span> <span class="LuaCitalic"><span lang="EN-US">set</span></span> <span class="LuaCbold"><span lang=
"EN-US">]</span></span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US">any character not in <span class="LuaCitalic">set</span></span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Pattern examples</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="319" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.find("Lua is great!", "is")</span></span></p>
</td>
<td width="189" valign="top">
<p class="MsoNormal"><span lang="EN-US">5</span></p>
</td>
<td width="142" valign="top">
<p class="MsoNormal"><span lang="EN-US">6</span></p>
</td>
</tr>
<tr>
<td width="319" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.find("Lua is great!", "%s")</span></span></p>
</td>
<td width="189" valign="top">
<p class="MsoNormal"><span lang="EN-US">4</span></p>
</td>
<td width="142" valign="top">
<p class="MsoNormal"><span lang="EN-US">4</span></p>
</td>
</tr>
<tr>
<td width="319" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.gsub("Lua is great!", "%s", "-")</span></span></p>
</td>
<td width="189" valign="top">
<p class="MsoNormal"><span lang="EN-US">Lua-is-great!</span></p>
</td>
<td width="142" valign="top">
<p class="MsoNormal"><span lang="EN-US">2</span></p>
</td>
</tr>
<tr>
<td width="319" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.gsub("Lua is great!", "[%s%l]", "*")</span></span></p>
</td>
<td width="189" valign="top">
<p class="MsoNormal"><span lang="EN-US">L***********!</span></p>
</td>
<td width="142" valign="top">
<p class="MsoNormal"><span lang="EN-US">11</span></p>
</td>
</tr>
<tr>
<td width="319" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.gsub("Lua is great!", "%a+", "*")</span></span></p>
</td>
<td width="189" valign="top">
<p class="MsoNormal"><span lang="EN-US">* * *!</span></p>
</td>
<td width="142" valign="top">
<p class="MsoNormal"><span lang="EN-US">3</span></p>
</td>
</tr>
<tr>
<td width="319" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.gsub("Lua is great!", "(.)", "%1%1")</span></span></p>
</td>
<td width="189" valign="top">
<p class="MsoNormal"><span lang="EN-US">LLuuaa iiss ggrreeaatt!!</span></p>
</td>
<td width="142" valign="top">
<p class="MsoNormal"><span lang="EN-US">13</span></p>
</td>
</tr>
<tr>
<td width="319" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.gsub("Lua is great!", "%but", "")</span></span></p>
</td>
<td width="189" valign="top">
<p class="MsoNormal"><span lang="EN-US">L!</span></p>
</td>
<td width="142" valign="top">
<p class="MsoNormal"><span lang="EN-US">1</span></p>
</td>
</tr>
<tr>
<td width="319" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.gsub("Lua is great!", "^.-a", "LUA")</span></span></p>
</td>
<td width="189" valign="top">
<p class="MsoNormal"><span lang="EN-US">LUA is great!</span></p>
</td>
<td width="142" valign="top">
<p class="MsoNormal"><span lang="EN-US">1</span></p>
</td>
</tr>
<tr>
<td width="319" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.gsub("Lua is great!", "^.-a",</span></span></p>
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US"> function(s) return string.upper(s) end)</span></span></p>
</td>
<td width="189" valign="top">
<p class="MsoNormal"><span lang="EN-US">LUA is great!</span></p>
</td>
<td width="142" valign="top">
<p class="MsoNormal"><span lang="EN-US">1</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader1"><a name="The_I_O_library" id="The_I_O_library"><span lang="EN-US">The I/O library [io]</span></a></p>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Complete I/O</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">io.open</span></span> <span lang="EN-US">(fn [, m])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">opens file with name <span class="LuaCbold">fn</span> in mode <span class="LuaCbold">m</span> : "r" = read [default], "w" = write", "a" = append, "r+" = update-preserve, "w+" = update-erase, "a+" =
update-append (add trailing "b" for binary mode on some systems); returns a file object (a userdata with a C handle).</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span lang="EN-US">file <span class="LuaCbold">:close</span> ()</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">closes <span class="LuaCbold">file</span></span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span lang="EN-US">file <span class="LuaCbold">:read</span> ( <span class="LuaCitalic">formats</span> )</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns a value from <span class="LuaCbold">file</span> for each of the passed <span class="LuaCitalic">formats</span> : "*n" = reads a number, "*a" = reads the whole <span class="LuaCbold">file</span> as a
string from current position (returns "" at end of file), "*l" = reads a line ( <span class="LuaCbold">nil</span> at end of file) [default], <span class="LuaCitalic">n</span> = reads a string of up to <span class="LuaCitalic">n</span> characters (
<span class="LuaCbold">nil</span> at end of file)</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span lang="EN-US">file <span class="LuaCbold">:lines</span> ()</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns an iterator function for reading <span class="LuaCbold">file</span> line by line; the iterator does not close the file when finished.</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span lang="EN-US">file <span class="LuaCbold">:write</span> ( <span class="LuaCitalic">values</span> )</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">writes each of the <span class="LuaCitalic">values</span> (strings or numbers) to <span class="LuaCbold">file</span> , with no added separators. Numbers are written as text, strings can contain binary data
(in this case, <span class="LuaCbold">file</span> may need to be opened in binary mode on some systems).</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span lang="EN-US">file <span class="LuaCbold">:seek</span> ([p] [, of])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">sets the current position in <span class="LuaCbold">file</span> relative to <span class="LuaCbold">p</span> ("set" = start of file [default], "cur" = current, "end" = end of file) adding offset <span class=
"LuaCbold">of</span> [default: zero]; returns new current position in <span class="LuaCbold">file</span> .</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span lang="EN-US">file <span class="LuaCbold">:flush</span> ()</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">flushes any data still held in buffers to <span class="LuaCbold">file</span></span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Simple I/O</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">io.input</span></span> <span lang="EN-US">([file])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">sets <span class="LuaCbold">file</span> as default input file; <span class="LuaCbold">file</span> can be either an open file object or a file name; in the latter case the file is opened for reading in text
mode. Returns a file object, the current one if no <span class="LuaCbold">file</span> given; raises error on failure.</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">io.output</span></span> <span lang="EN-US">([file])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">sets <span class="LuaCbold">file</span> as default output file (the current output file is not closed); <span class="LuaCbold">file</span> can be either an open file object or a file name; in the latter case
the file is opened for writing in text mode. Returns a file object, the current one if no <span class="LuaCbold">file</span> given; raises error on failure.</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">io.close</span></span> <span lang="EN-US">([file])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">closes <span class="LuaCbold">file</span> (a file object) [default: closes the default output file]</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">io.read</span></span> <span lang="EN-US">( <span class="LuaCitalic">formats</span> )</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">reads from the default input file, usage as <span class="LuaCbold">file:read()</span></span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">io.lines</span></span> <span lang="EN-US">([fn])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">opens the file with name <span class="LuaCbold">fn</span> for reading and returns an iterator function to read line by line; the iterator closes the file when finished. If no <span class="LuaCbold">fn</span>
is given, returns an iterator reading lines from the default input file.</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">io.write</span></span> <span lang="EN-US">( <span class="LuaCitalic">values</span> )</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">writes to the default output file, usage as <span class="LuaCbold">file:write()</span></span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">io.flush</span></span> <span lang="EN-US">()</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">flushes any data still held in buffers to the default output file</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Standard files and utility
functions</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">io.stdin, io.stdout, io.stderr</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">predefined file objects for stdin, stdout and stderr streams</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">io.popen</span></span> <span lang="EN-US">([prog [, mode]])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">starts program <span class="LuaCbold">prog</span> in a separate process and returns a file handle that you can use to read data from (if <span class="LuaCbold">mode</span> is "r", default) or to write data
to (if <span class="LuaCbold">mode</span> is "w")</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">io.type</span></span> <span lang="EN-US">(x)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns the string "file" if <span class="LuaCbold">x</span> is an open file, "closed file" if <span class="LuaCbold">x</span> is a closed file or <span class="LuaCbold">nil</span> if <span class=
"LuaCbold">x</span> is not a file object</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">io.tmpfile</span></span> <span lang="EN-US">()</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns a file object for a temporary file (deleted when program ends)</span></p>
</td>
</tr>
</table>
<p class="MsoNormal"><span lang="EN-US">Note: unless otherwise stated, the I/O functions return <span class="LuaCbold">nil</span> and an error message on failure; passing a closed file object raises an error instead.</span></p>
<p class="LuaPHeader1"><a name="The_operating_system_library" id="The_operating_system_library"><span lang="EN-US">The operating system library [os]</span></a></p>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">System interaction</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">os.execute</span></span> <span lang="EN-US">(cmd)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">calls a system shell to execute the string <span class="LuaCbold">cmd</span> as a command; returns a system-dependent status code.</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">os.exit</span></span> <span lang="EN-US">([code])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">terminates the program returning <span class="LuaCbold">code</span> [default: success]</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">os.getenv</span></span> <span lang="EN-US">(var)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns a string with the value of the environment variable <span class="LuaCbold">var</span> or <span class="LuaCbold">nil</span> if no such variable exists</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">os.setlocale</span></span> <span lang="EN-US">(s [, c])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">sets the locale described by string <span class="LuaCbold">s</span> for category <span class="LuaCbold">c</span> : "all", "collate", "ctype", "monetary", "numeric" or "time" [default: "all"]; returns the
name of the locale or <span class="LuaCbold">nil</span> if it can't be set.</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">os.remove</span></span> <span lang="EN-US">(fn)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">deletes the file <span class="LuaCbold">fn</span> ; in case of error returns <span class="LuaCbold">nil</span> and error description.</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">os.rename</span></span> <span lang="EN-US">(of, nf)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">renames file <span class="LuaCbold">of</span> to <span class="LuaCbold">nf</span> ; in case of error returns <span class="LuaCbold">nil</span> and error description.</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">os.tmpname</span></span> <span lang="EN-US">()</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns a string usable as name for a temporary file; subject to name conflicts, use <span class="LuaCbold">io.tmpfile()</span> instead.</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Date/time</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">os.clock</span></span> <span lang="EN-US">()</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns an approximation of the amount in seconds of CPU time used by the program</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">os.time</span></span> <span lang="EN-US">([tt])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns a system-dependent number representing date/time described by table <span class="LuaCbold">tt</span> [default: current]. <span class="LuaCbold">tt</span> must have fields <span class=
"LuaCbold">year</span> , <span class="LuaCbold">month</span> , <span class="LuaCbold">day</span> ; can have fields <span class="LuaCbold">hour</span> , <span class="LuaCbold">min</span> , <span class="LuaCbold">sec</span> , <span class=
"LuaCbold">isdst</span> (daylight saving, boolean). On many systems the returned value is the number of seconds since a fixed point in time (the "epoch").</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">os.date</span></span> <span lang="EN-US">([fmt [, t]])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns a table or a string describing date/time <span class="LuaCbold">t</span> (should be a value returned by <span class="LuaCbold">os.time()</span> [default: current date/time]), according to the format
string <span class="LuaCbold">fmt</span> [default: date/time according to locale settings]; if <span class="LuaCbold">fmt</span> is "*t" or "!*t", returns a table with fields <span class="LuaCbold">year</span> (yyyy), <span class=
"LuaCbold">month</span> (1..12), <span class="LuaCbold">day</span> (1..31), <span class="LuaCbold">hour</span> (0..23), <span class="LuaCbold">min</span> (0..59), <span class="LuaCbold">sec</span> (0..61), <span class="LuaCbold">wday</span> (1..7,
Sunday = 1), <span class="LuaCbold">yday</span> (1..366), <span class="LuaCbold">isdst</span> (true = daylight saving), else returns the <span class="LuaCbold">fmt</span> string with formatting directives beginning with ' <span class=
"LuaCbold">%</span> ' replaced according to <span class="LuaCitalic">Time formatting directives</span> (see below). In either case a leading "!" requests UTC (Coordinated Universal Time).</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">os.difftime</span></span> <span lang="EN-US">(t2, t1)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns the difference between two values returned by <span class="LuaCbold">os.time()</span></span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Time formatting directives (most
used, portable features):</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%c</span></span></p>
</td>
<td width="260" valign="top">
<p class="MsoNormal"><span lang="EN-US">date/time (locale)</span></p>
</td>
<td width="71" valign="top">
<p class="MsoNormal"><span lang="EN-US"> </span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US"> </span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%x</span></span></p>
</td>
<td width="260" valign="top">
<p class="MsoNormal"><span lang="EN-US">date only (locale)</span></p>
</td>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%X</span></span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US">time only (locale)</span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%y</span></span></p>
</td>
<td width="260" valign="top">
<p class="MsoNormal"><span lang="EN-US">year (nn)</span></p>
</td>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%Y</span></span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US">year (yyyy)</span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%j</span></span></p>
</td>
<td width="260" valign="top">
<p class="MsoNormal"><span lang="EN-US">day of year (001..366)</span></p>
</td>
<td width="71" valign="top">
<p class="MsoNormal"><span lang="EN-US"> </span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US"> </span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%m</span></span></p>
</td>
<td width="260" valign="top">
<p class="MsoNormal"><span lang="EN-US">month (01..12)</span></p>
</td>
<td width="71" valign="top">
<p class="MsoNormal"><span lang="EN-US"> </span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US"> </span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%b</span></span></p>
</td>
<td width="260" valign="top">
<p class="MsoNormal"><span lang="EN-US">abbreviated month name (locale)</span></p>
</td>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%B</span></span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US">full name of month (locale)</span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%d</span></span></p>
</td>
<td width="260" valign="top">
<p class="MsoNormal"><span lang="EN-US">day of month (01..31)</span></p>
</td>
<td width="71" valign="top">
<p class="MsoNormal"><span lang="EN-US"> </span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US"> </span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%U</span></span></p>
</td>
<td width="260" valign="top">
<p class="MsoNormal"><span lang="EN-US">week number (01..53), Sunday-based</span></p>
</td>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%W</span></span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US">week number (01..53), Monday-based</span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%w</span></span></p>
</td>
<td width="260" valign="top">
<p class="MsoNormal"><span lang="EN-US">weekday (0..6), 0 is Sunday</span></p>
</td>
<td width="71" valign="top">
<p class="MsoNormal"><span lang="EN-US"> </span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US"> </span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%a</span></span></p>
</td>
<td width="260" valign="top">
<p class="MsoNormal"><span lang="EN-US">abbreviated weekday name (locale)</span></p>
</td>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%A</span></span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US">full weekday name (locale)</span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%H</span></span></p>
</td>
<td width="260" valign="top">
<p class="MsoNormal"><span lang="EN-US">hour (00..23)</span></p>
</td>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%I</span></span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US">hour (01..12)</span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%p</span></span></p>
</td>
<td width="260" valign="top">
<p class="MsoNormal"><span lang="EN-US">either AM or PM</span></p>
</td>
<td width="71" valign="top">
<p class="MsoNormal"><span lang="EN-US"> </span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US"> </span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%M</span></span></p>
</td>
<td width="260" valign="top">
<p class="MsoNormal"><span lang="EN-US">minute (00..59)</span></p>
</td>
<td width="71" valign="top">
<p class="MsoNormal"><span lang="EN-US"> </span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US"> </span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%S</span></span></p>
</td>
<td width="260" valign="top">
<p class="MsoNormal"><span lang="EN-US">second (00..61)</span></p>
</td>
<td width="71" valign="top">
<p class="MsoNormal"><span lang="EN-US"> </span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US"> </span></p>
</td>
</tr>
<tr>
<td width="71" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%Z</span></span></p>
</td>
<td width="260" valign="top">
<p class="MsoNormal"><span lang="EN-US">time zone name, if any</span></p>
</td>
<td width="71" valign="top">
<p class="MsoNormal"><span lang="EN-US"> </span></p>
</td>
<td width="248" valign="top">
<p class="MsoNormal"><span lang="EN-US"> </span></p>
</td>
</tr>
</table>
<p class="LuaPHeader1"><a name="The_debug_library" id="The_debug_library"><span lang="EN-US">The debug library [debug]</span></a></p>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Basic functions</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">debug.debug</span></span> <span lang="EN-US">()</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">enters interactive debugging shell (type <span class="LuaCbold">cont</span> to exit); local variables cannot be accessed directly.</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">debug.getinfo</span></span> <span lang="EN-US">(f [, w])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns a table with information for function <span class="LuaCbold">f</span> or for function at level <span class="LuaCbold">f</span> [1 = caller], or <span class="LuaCbold">nil</span> if invalid level (see
<span class="LuaCitalic">Result fields for getinfo</span> below); characters in string <span class="LuaCbold">w</span> select one or more groups of fields [default: all] (see <span class="LuaCitalic">Options for getinfo</span> below).</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">debug.getlocal</span></span> <span lang="EN-US">(n, i)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns name and value of local variable at index <span class="LuaCbold">i</span> (from 1, in order of appearance) of the function at stack level <span class="LuaCbold">n</span> (1= caller); returns
<span class="LuaCbold">nil</span> if <span class="LuaCbold">i</span> is out of range, raises error if <span class="LuaCbold">n</span> is out of range.</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">debug.getupvalue</span></span> <span lang="EN-US">(f, i)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns name and value of upvalue at index <span class="LuaCbold">i</span> (from 1, in order of appearance) of function <span class="LuaCbold">f</span> ; returns <span class="LuaCbold">nil</span> if
<span class="LuaCbold">i</span> is out of range.</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">debug.traceback</span></span> <span lang="EN-US">([msg])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns a string with traceback of call stack, prepended by <span class="LuaCbold">msg</span></span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">debug.setlocal</span></span> <span lang="EN-US">(n, i, v)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">assigns value <span class="LuaCbold">v</span> to the local variable at index <span class="LuaCbold">i</span> (from 1, in order of appearance) of the function at stack level <span class="LuaCbold">n</span>
(1= caller); returns <span class="LuaCbold">nil</span> if <span class="LuaCbold">i</span> is out of range, raises error if <span class="LuaCbold">n</span> is out of range.</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">debug.setupvalue</span></span> <span lang="EN-US">(f, i, v)</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">assigns value <span class="LuaCbold">v</span> to the upvalue at index <span class="LuaCbold">i</span> (from 1, in order of appearance) of function <span class="LuaCbold">f</span> ; returns <span class=
"LuaCbold">nil</span> if <span class="LuaCbold">i</span> is out of range.</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">debug.sethook</span></span> <span lang="EN-US">([h, m [, n]])</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">sets function <span class="LuaCbold">h</span> as hook, called for events given in string (mask) <span class="LuaCbold">m</span> : "c" = function call, "r" = function return, "l" = new code line; also, a
number <span class="LuaCbold">n</span> will call <span class="LuaCbold">h()</span> every <span class="LuaCbold">n</span> instructions; <span class="LuaCbold">h()</span> will receive the event type as first argument: "call", "return", "tail
return", "line" (line number as second argument) or "count"; use <span class="LuaCbold">debug.getinfo(2)</span> inside <span class="LuaCbold">h()</span> for info (not for "tail_return").</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">debug.gethook</span></span> <span lang="EN-US">()</span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns current hook function, mask and count set with <span class="LuaCbold">debug.sethook()</span></span></p>
</td>
</tr>
</table>
<p class="MsoNormal"><span lang="EN-US">Note: the debug library functions are not optimised for efficiency and should not be used in normal operation.</span></p>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Result fields for
debug.getinfo</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">source</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">name of file (prefixed by '@') or string where the function was defined</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">short_src</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">short version of <span class="LuaCbold">source</span> , up to 60 characters</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">linedefined</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">line of source where the function was defined</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">what</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">"Lua" = Lua function, "C" = C function, "main" = part of main chunk</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">name</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">name of function, if available, or a reasonable guess if possible</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">namewhat</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">meaning of <span class="LuaCbold">name</span> : "global", "local", "method", "field" or ""</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">nups</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">number of upvalues of the function</span></p>
</td>
</tr>
<tr>
<td width="165" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">func</span></span></p>
</td>
<td width="484" valign="top">
<p class="MsoNormal"><span lang="EN-US">the function itself</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Options for debug.getinfo
(character codes for argument w)</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="36" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">n</span></span></p>
</td>
<td width="295" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns fields <span class="LuaCbold">name</span> and <span class="LuaCbold">namewhat</span></span></p>
</td>
<td width="36" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">l</span></span></p>
</td>
<td width="284" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns field <span class="LuaCbold">currentline</span></span></p>
</td>
</tr>
<tr>
<td width="36" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">f</span></span></p>
</td>
<td width="295" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns field <span class="LuaCbold">func</span></span></p>
</td>
<td width="36" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">u</span></span></p>
</td>
<td width="284" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns field <span class="LuaCbold">nup</span></span></p>
</td>
</tr>
<tr>
<td width="36" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">S</span></span></p>
</td>
<td width="295" valign="top">
<p class="MsoNormal"><span lang="EN-US">returns fields <span class="LuaCbold">source</span> , <span class="LuaCbold">short_src</span> , <span class="LuaCbold">what</span> and <span class="LuaCbold">linedefined</span></span></p>
</td>
<td width="36" valign="top">
<p class="MsoNormal"><span lang="EN-US"> </span></p>
</td>
<td width="284" valign="top">
<p class="MsoNormal"><span lang="EN-US"> </span></p>
</td>
</tr>
</table>
<p class="LuaPHeader1"><a name="The_stand_alone_interpreter" id="The_stand_alone_interpreter"><span lang="EN-US">The stand-alone interpreter</span></a></p>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Command line syntax</span></p>
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">lua</span></span> <span lang="EN-US">[ <span class="LuaCitalic">options</span> ] [ <span class="LuaCitalic">script</span> [ <span class="LuaCitalic">arguments</span> ]]</span></p>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Options</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="95" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-</span></span></p>
</td>
<td width="555" valign="top">
<p class="MsoNormal"><span lang="EN-US">loads and executes <span class="LuaCbold">script</span> from standard input (no args allowed)</span></p>
</td>
</tr>
<tr>
<td width="95" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-e</span></span></p>
</td>
<td width="555" valign="top">
<p class="MsoNormal"><span lang="EN-US">executes the Lua statements in the literal string <span class="LuaCitalic">stats</span> , can be used multiple times on the same line</span></p>
</td>
</tr>
<tr>
<td width="95" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-l</span></span></p>
</td>
<td width="555" valign="top">
<p class="MsoNormal"><span lang="EN-US">requires <span class="LuaCitalic">filename</span> (loads and executes if not already done)</span></p>
</td>
</tr>
<tr>
<td width="95" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-i</span></span></p>
</td>
<td width="555" valign="top">
<p class="MsoNormal"><span lang="EN-US">enters interactive mode after loading and executing <span class="LuaCitalic">script</span></span></p>
</td>
</tr>
<tr>
<td width="95" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-v</span></span></p>
</td>
<td width="555" valign="top">
<p class="MsoNormal"><span lang="EN-US">prints version information</span></p>
</td>
</tr>
<tr>
<td width="95" valign="top">
<p class="MsoNormal"><span lang="EN-US">--</span></p>
</td>
<td width="555" valign="top">
<p class="MsoNormal"><span lang="EN-US">stops parsing options</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Recognized environment
variables</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="95" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">LUA_INIT</span></span></p>
</td>
<td width="555" valign="top">
<p class="MsoNormal"><span lang="EN-US">if this holds a string in the form <span class="LuaCitalic">@filename</span> loads and executes <span class="LuaCitalic">filename</span> , else executes the string itself</span></p>
</td>
</tr>
<tr>
<td width="95" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">LUA_PATH</span></span></p>
</td>
<td width="555" valign="top">
<p class="MsoNormal"><span lang="EN-US">defines search path for Lua modules, with "?" replaced by the module name</span></p>
</td>
</tr>
<tr>
<td width="95" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">LUA_CPATH</span></span></p>
</td>
<td width="555" valign="top">
<p class="MsoNormal"><span lang="EN-US">defines search path for dynamic libraries (e.g. .so or .dll files), with "?" replaced by the module name</span></p>
</td>
</tr>
<tr>
<td width="95" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">_PROMPT[2]</span></span></p>
</td>
<td width="555" valign="top">
<p class="MsoNormal"><span lang="EN-US">set the prompts for interactive mode</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Special Lua variables</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="95" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">arg</span></span></p>
</td>
<td width="555" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">nil</span></span> <span lang="EN-US">if no arguments on the command line, else a table containing command line <span class="LuaCitalic">arguments</span> starting from <span class=
"LuaCbold">arg[1]</span> while # <span class="LuaCbold">arg</span> is the number of <span class="LuaCitalic">arguments</span> ; <span class="LuaCbold">arg[0]</span> holds the script name as given on the command line; <span class=
"LuaCbold">arg[-1]</span> and lower indexes contain the fields of the command line preceding the script name.</span></p>
</td>
</tr>
<tr>
<td width="95" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">_PROMPT[2]</span></span></p>
</td>
<td width="555" valign="top">
<p class="MsoNormal"><span lang="EN-US">contain the prompt for interactive mode; can be changed by assigning a new value.</span></p>
</td>
</tr>
</table>
<p class="LuaPHeader1"><a name="The_compiler" id="The_compiler"><span lang="EN-US">The compiler</span></a></p>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Command line syntax</span></p>
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">luac</span></span> <span lang="EN-US">[ <span class="LuaCitalic">options</span> ] [ <span class="LuaCitalic">filenames</span> ]</span></p>
<p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">· <span style='font:7.0pt "Times New Roman"'> </span></span> <span lang="EN-US">Options</span></p>
<table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
<tr>
<td width="95" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-</span></span></p>
</td>
<td width="555" valign="top">
<p class="MsoNormal"><span lang="EN-US">compiles from standard input</span></p>
</td>
</tr>
<tr>
<td width="95" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-l</span></span></p>
</td>
<td width="555" valign="top">
<p class="MsoNormal"><span lang="EN-US">produces a listing of the compiled bytecode</span></p>
</td>
</tr>
<tr>
<td width="95" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-o</span></span></p>
</td>
<td width="555" valign="top">
<p class="MsoNormal"><span lang="EN-US">sends output to <span class="LuaCbold">filename</span> [default: <span class="LuaCbold">luac.out</span> ]</span></p>
</td>
</tr>
<tr>
<td width="95" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-p</span></span></p>
</td>
<td width="555" valign="top">
<p class="MsoNormal"><span lang="EN-US">performs syntax and integrity checking only, does not output bytecode</span></p>
</td>
</tr>
<tr>
<td width="95" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-s</span></span></p>
</td>
<td width="555" valign="top">
<p class="MsoNormal"><span lang="EN-US">strips debug information; line numbers and local names are lost.</span></p>
</td>
</tr>
<tr>
<td width="95" valign="top">
<p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-v</span></span></p>
</td>
<td width="555" valign="top">
<p class="MsoNormal"><span lang="EN-US">prints version information</span></p>
</td>
</tr>
<tr>
<td width="95" valign="top">
<p class="MsoNormal"><span lang="EN-US">--</span></p>
</td>
<td width="555" valign="top">
<p class="MsoNormal"><span lang="EN-US">stops parsing options</span></p>
</td>
</tr>
</table>
<p class="MsoNormal"><span lang="EN-US">Note: compiled chunks are portable between machines having the same word size.</span></p>
<p class="MsoNormal"><span lang="EN-US"> </span></p>
<p class="MsoNormal"><i><span lang="EN-US" style="font-size:6.0pt"><br>
<br>
Lua is a language designed and implemented by Roberto Ierusalimschy, Luiz Henrique de Figueiredo and Waldemar Celes; for details see lua.org. Drafts of this reference card (for Lua 5.0) were produced by Enrico Colombini <erix@erix.it> in 2004 and
updated by Thomas Lauer <thomas.lauer@gmail.com> in 2007. Comments, praise or blame please to the lua-l mailing list.</span></i></p>
</body>
</html>
|
