Debian Codegraph @

geanylua/docs/luarefv51.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
3 <html>
4 <head>
5 <meta name="generator" content="HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org">
6 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
7
8 <title>Lua 5.1 short reference</title>
9 <style type="text/css">
10 <!--
11 body
12 {margin-left:24px;
13 margin-bottom:120px;
14 width:75%}
15 p.MsoNormal
16 {margin-top:0cm;
17 margin-right:0cm;
18 margin-bottom:0cm;
19 margin-left:2.85pt;
20 margin-bottom:.0001pt;
21 font-size:8.0pt;
22 font-family:"Times New Roman";}
23 span.LuaCbold
24 {font-weight:bold;}
25 span.LuaCitalic
26 {font-style:italic;}
27 p.LuaPHeader2
28 {margin-top:32px;
29 margin-right:0cm;
30 margin-bottom:8px;
31 margin-left:0cm;
32 text-indent:2.85pt;
33 page-break-after:avoid;
34 font-size:10.0pt;
35 font-family:Arial;
36 color:gray;
37 font-weight:bold;
38 font-style:italic;}
39 p.LuaPHeader1
40 {margin-top:48px;
41 margin-right:4.25pt;
42 margin-bottom:8px;
43 margin-left:0px;
44 width:100%;
45 page-break-after:avoid;
46 background:#F3F3F3;
47 padding:8px;
48 font-size:12.0pt;
49 font-family:Arial;
50 color:gray;
51 letter-spacing:1.2pt;
52 font-weight:bold;}
53 table.LuaTTables
54 {width:100%;}
55 td
56 {padding:4px;}
57 a.IndexRef
58 {white-space:nowrap;
59 padding-right:8px;
60 text-decoration:none;
61 }
62 -->
63 </style>
64 </head>
65
66 <body bgcolor="white" style="line-break:strict">
67 <p class='LuaPHeader1'><span lang='EN-US'>Contents</span></p>
68
69 <div style='width:100%;font-size:12.0pt;font-weight:bold;text-align:center;line-height: 200%;'>
70 <p><a class="IndexRef" href="#The_Lua_language">&middot; The Lua language &middot;</a> <a class="IndexRef" href="#The_base_library">&middot; The base library &middot;</a> <a class="IndexRef" href="#Modules_and_the_package_library">&middot; Modules and
71 the package library &middot;</a> <a class="IndexRef" href="#The_coroutine_library">&middot; The coroutine library &middot;</a> <a class="IndexRef" href="#The_table_library">&middot; The table library &middot;</a> <a class="IndexRef" href=
72 "#The_mathematical_library">&middot; The mathematical library &middot;</a> <a class="IndexRef" href="#The_string_library">&middot; The string library &middot;</a> <a class="IndexRef" href="#The_I_O_library">&middot; The I/O library &middot;</a>
73 <a class="IndexRef" href="#The_operating_system_library">&middot; The operating system library &middot;</a> <a class="IndexRef" href="#The_debug_library">&middot; The debug library &middot;</a> <a class="IndexRef" href=
74 "#The_stand_alone_interpreter">&middot; The stand-alone interpreter &middot;</a> <a class="IndexRef" href="#The_compiler">&middot; The compiler &middot;</a></p>
75 </div>
76
77 <p class="LuaPHeader1"><a name="The_Lua_language" id="The_Lua_language"><span lang="EN-US">The Lua language (v5.1)</span></a></p>
78
79 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Reserved identifiers and
80 comments</span></p>
81
82 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" width="650" summary="?">
83 <tr>
84 <td width="59" valign="top">
85 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">and</span></span></p>
86 </td>
87
88 <td width="59" valign="top">
89 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">break</span></span></p>
90 </td>
91
92 <td width="59" valign="top">
93 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">do</span></span></p>
94 </td>
95
96 <td width="59" valign="top">
97 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">else</span></span></p>
98 </td>
99
100 <td width="59" valign="top">
101 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">elseif</span></span></p>
102 </td>
103
104 <td width="59" valign="top">
105 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">end</span></span></p>
106 </td>
107
108 <td width="59" valign="top">
109 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">false</span></span></p>
110 </td>
111
112 <td width="59" valign="top">
113 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">for</span></span></p>
114 </td>
115
116 <td width="59" valign="top">
117 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">function</span></span></p>
118 </td>
119
120 <td width="59" valign="top">
121 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">if</span></span></p>
122 </td>
123
124 <td width="59" valign="top">
125 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">in</span></span></p>
126 </td>
127 </tr>
128
129 <tr>
130 <td width="59" valign="top">
131 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">local</span></span></p>
132 </td>
133
134 <td width="59" valign="top">
135 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">nil</span></span></p>
136 </td>
137
138 <td width="59" valign="top">
139 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">not</span></span></p>
140 </td>
141
142 <td width="59" valign="top">
143 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">or</span></span></p>
144 </td>
145
146 <td width="59" valign="top">
147 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">repeat</span></span></p>
148 </td>
149
150 <td width="59" valign="top">
151 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">return</span></span></p>
152 </td>
153
154 <td width="59" valign="top">
155 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">then</span></span></p>
156 </td>
157
158 <td width="59" valign="top">
159 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">true</span></span></p>
160 </td>
161
162 <td width="59" valign="top">
163 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">until</span></span></p>
164 </td>
165
166 <td width="59" valign="top">
167 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">while</span></span></p>
168 </td>
169
170 <td width="59" valign="top">
171 <p class="MsoNormal"><b><span lang="EN-US">&nbsp;</span></b></p>
172 </td>
173 </tr>
174
175 <tr>
176 <td width="59" valign="top">
177 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-- ...</span></span></p>
178 </td>
179
180 <td width="236" colspan="4" valign="top">
181 <p class="MsoNormal"><span lang="EN-US">comment to end of line</span></p>
182 </td>
183
184 <td width="59" valign="top">
185 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">--[=[</span></span> <span lang="EN-US">&nbsp; <span class="LuaCbold">]=]</span></span></p>
186 </td>
187
188 <td width="295" colspan="5" valign="top">
189 <p class="MsoNormal"><span lang="EN-US">multi line comment (zero or multiple '=' are valid)</span></p>
190 </td>
191 </tr>
192
193 <tr>
194 <td width="295" colspan="5" valign="top">
195 <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>
196 </td>
197
198 <td width="59" valign="top">
199 <p class="MsoNormal"><span lang="EN-US">#!</span></p>
200 </td>
201
202 <td width="295" colspan="5" valign="top">
203 <p class="MsoNormal"><span lang="EN-US">usual Unix shebang; Lua ignores whole first line if this starts the line.</span></p>
204 </td>
205 </tr>
206 </table>
207
208 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Types (the string values are the
209 possible results of base library function type())</span></p>
210
211 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
212 <tr>
213 <td width="81" valign="top">
214 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">"nil"</span></span></p>
215 </td>
216
217 <td width="81" valign="top">
218 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">"boolean"</span></span></p>
219 </td>
220
221 <td width="81" valign="top">
222 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">"number"</span></span></p>
223 </td>
224
225 <td width="81" valign="top">
226 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">"string"</span></span></p>
227 </td>
228
229 <td width="81" valign="top">
230 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">"table"</span></span></p>
231 </td>
232
233 <td width="81" valign="top">
234 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">"function"</span></span></p>
235 </td>
236
237 <td width="81" valign="top">
238 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">"thread"</span></span></p>
239 </td>
240
241 <td width="81" valign="top">
242 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">"userdata"</span></span></p>
243 </td>
244 </tr>
245 </table>
246
247 <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
248 false; everything else is true (including 0 and "").</span></p>
249
250 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Strings and escape
251 sequences</span></p>
252
253 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
254 <tr>
255 <td width="95" colspan="2" valign="top">
256 <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>
257 </td>
258
259 <td width="201" colspan="3" valign="top">
260 <p class="MsoNormal"><span lang="EN-US">string delimiters; interpret escapes.</span></p>
261 </td>
262
263 <td width="71" valign="top">
264 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">[=[...]=]</span></span></p>
265 </td>
266
267 <td width="284" colspan="4" valign="top">
268 <p class="MsoNormal"><span lang="EN-US">multi line strings; escape sequences are ignored.</span></p>
269 </td>
270 </tr>
271
272 <tr>
273 <td width="93" valign="top">
274 <p class="MsoNormal"><span lang="EN-US">\a&nbsp; bell</span></p>
275 </td>
276
277 <td width="93" colspan="2" valign="top">
278 <p class="MsoNormal"><span lang="EN-US">\b&nbsp; backspace</span></p>
279 </td>
280
281 <td width="93" valign="top">
282 <p class="MsoNormal"><span lang="EN-US">\f&nbsp; form feed</span></p>
283 </td>
284
285 <td width="93" colspan="3" valign="top">
286 <p class="MsoNormal"><span lang="EN-US">\n&nbsp; newline</span></p>
287 </td>
288
289 <td width="93" valign="top">
290 <p class="MsoNormal"><span lang="EN-US">\r&nbsp; return</span></p>
291 </td>
292
293 <td width="93" valign="top">
294 <p class="MsoNormal"><span lang="EN-US">\t&nbsp; horiz. tab</span></p>
295 </td>
296
297 <td width="93" valign="top">
298 <p class="MsoNormal"><span lang="EN-US">\v&nbsp; vert. tab</span></p>
299 </td>
300 </tr>
301
302 <tr>
303 <td width="93" valign="top">
304 <p class="MsoNormal"><span lang="EN-US">\\&nbsp; backslash</span></p>
305 </td>
306
307 <td width="93" colspan="2" valign="top">
308 <p class="MsoNormal"><span lang="EN-US">\"&nbsp; d. quote</span></p>
309 </td>
310
311 <td width="93" valign="top">
312 <p class="MsoNormal"><span lang="EN-US">\'&nbsp; quote</span></p>
313 </td>
314
315 <td width="93" colspan="3" valign="top">
316 <p class="MsoNormal"><span lang="EN-US">\[&nbsp; sq. bracket</span></p>
317 </td>
318
319 <td width="93" valign="top">
320 <p class="MsoNormal"><span lang="EN-US">\]&nbsp; sq. bracket</span></p>
321 </td>
322
323 <td width="93" valign="top">
324 <p class="MsoNormal"><span lang="EN-US">\ddd decimal</span></p>
325 </td>
326
327 <td width="93" valign="top">
328 <p class="MsoNormal"><span lang="EN-US">&nbsp;</span></p>
329 </td>
330 </tr>
331 </table>
332
333 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Operators, decreasing
334 precedence</span></p>
335
336 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
337 <tr>
338 <td width="650" colspan="6" valign="top">
339 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">^</span></span> <span lang="EN-US">&nbsp; (right associative, math library required)</span></p>
340 </td>
341 </tr>
342
343 <tr>
344 <td width="217" colspan="2" valign="top">
345 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">not</span></span></p>
346 </td>
347
348 <td width="217" colspan="2" valign="top">
349 <p class="MsoNormal"><span lang="EN-US">#&nbsp; (length of strings and tables)</span></p>
350 </td>
351
352 <td width="217" colspan="2" valign="top">
353 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-</span></span> <span lang="EN-US">&nbsp; (unary)</span></p>
354 </td>
355 </tr>
356
357 <tr>
358 <td width="217" colspan="2" valign="top">
359 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">*</span></span></p>
360 </td>
361
362 <td width="217" colspan="2" valign="top">
363 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">/</span></span></p>
364 </td>
365
366 <td width="217" colspan="2" valign="top">
367 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%</span></span></p>
368 </td>
369 </tr>
370
371 <tr>
372 <td width="325" colspan="3" valign="top">
373 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">+</span></span></p>
374 </td>
375
376 <td width="325" colspan="3" valign="top">
377 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-</span></span></p>
378 </td>
379 </tr>
380
381 <tr>
382 <td width="650" colspan="6" valign="top">
383 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">..</span></span> <span lang="EN-US">&nbsp; (string concatenation, right associative)</span></p>
384 </td>
385 </tr>
386
387 <tr>
388 <td width="108" valign="top">
389 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">&lt;</span></span></p>
390 </td>
391
392 <td width="108" valign="top">
393 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">&gt;</span></span></p>
394 </td>
395
396 <td width="108" valign="top">
397 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">&lt;=</span></span></p>
398 </td>
399
400 <td width="108" valign="top">
401 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">&gt;=</span></span></p>
402 </td>
403
404 <td width="108" valign="top">
405 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">~=</span></span></p>
406 </td>
407
408 <td width="108" valign="top">
409 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">==</span></span></p>
410 </td>
411 </tr>
412
413 <tr>
414 <td width="650" colspan="6" valign="top">
415 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">and</span></span> <span lang="EN-US">&nbsp; (stops on <span class="LuaCbold">false</span> or <span class="LuaCbold">nil</span> , returns last evaluated value)</span></p>
416 </td>
417 </tr>
418
419 <tr>
420 <td width="650" colspan="6" valign="top">
421 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">or</span></span> <span lang="EN-US">&nbsp;(stops on <span class="LuaCbold">true</span> (not <span class="LuaCbold">false</span> or <span class="LuaCbold">nil</span> ), returns last
422 evaluated value)</span></p>
423 </td>
424 </tr>
425 </table>
426
427 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Assignment and
428 coercion</span></p>
429
430 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
431 <tr>
432 <td width="142" valign="top">
433 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">a = 5&nbsp; b= "hi"</span></span></p>
434
435 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">local a = a</span></span></p>
436 </td>
437
438 <td width="508" valign="top">
439 <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> =
440 5).</span></p>
441 </td>
442 </tr>
443
444 <tr>
445 <td width="142" valign="top">
446 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">a, b, c = 1, 2, 3</span></span></p>
447 </td>
448
449 <td width="508" valign="top">
450 <p class="MsoNormal"><span lang="EN-US">multiple assignments are supported</span></p>
451 </td>
452 </tr>
453
454 <tr>
455 <td width="142" valign="top">
456 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">a, b = b, a</span></span></p>
457 </td>
458
459 <td width="508" valign="top">
460 <p class="MsoNormal"><span lang="EN-US">swap values: right hand side is evaluated before assignment takes place</span></p>
461 </td>
462 </tr>
463
464 <tr>
465 <td width="142" valign="top">
466 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">a, b = 4, 5, "6"</span></span></p>
467 </td>
468
469 <td width="508" valign="top">
470 <p class="MsoNormal"><span lang="EN-US">excess values on right hand side ("6") are evaluated but discarded</span></p>
471 </td>
472 </tr>
473
474 <tr>
475 <td width="142" valign="top">
476 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">a, b = "there"</span></span></p>
477 </td>
478
479 <td width="508" valign="top">
480 <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>
481 </td>
482 </tr>
483
484 <tr>
485 <td width="142" valign="top">
486 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">a = nil</span></span></p>
487 </td>
488
489 <td width="508" valign="top">
490 <p class="MsoNormal"><span lang="EN-US">destroys <span class="LuaCbold">a</span> ; its contents are eligible for garbage collection if unreferenced.</span></p>
491 </td>
492 </tr>
493
494 <tr>
495 <td width="142" valign="top">
496 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">a = z</span></span></p>
497 </td>
498
499 <td width="508" valign="top">
500 <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>
501 </td>
502 </tr>
503
504 <tr>
505 <td width="142" valign="top">
506 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">a = "3" + "2"</span></span></p>
507 </td>
508
509 <td width="508" valign="top">
510 <p class="MsoNormal"><span lang="EN-US">numbers expected, strings are converted to numbers (a = 5)</span></p>
511 </td>
512 </tr>
513
514 <tr>
515 <td width="142" valign="top">
516 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">a = 3 .. 2</span></span></p>
517 </td>
518
519 <td width="508" valign="top">
520 <p class="MsoNormal"><span lang="EN-US">strings expected, numbers are converted to strings (a = "32")</span></p>
521 </td>
522 </tr>
523 </table>
524
525 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Control structures</span></p>
526
527 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
528 <tr>
529 <td width="331" valign="top">
530 <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>
531 </td>
532
533 <td width="319" valign="top">
534 <p class="MsoNormal"><span lang="EN-US">block; introduces local scope.</span></p>
535 </td>
536 </tr>
537
538 <tr>
539 <td width="331" valign="top">
540 <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=
541 "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=
542 "LuaCitalic">block</span> ] <span class="LuaCbold">end</span></span></p>
543 </td>
544
545 <td width="319" valign="top">
546 <p class="MsoNormal"><span lang="EN-US">conditional execution</span></p>
547 </td>
548 </tr>
549
550 <tr>
551 <td width="331" valign="top">
552 <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=
553 "EN-US">block</span></span> <span class="LuaCbold"><span lang="EN-US">end</span></span></p>
554 </td>
555
556 <td width="319" valign="top">
557 <p class="MsoNormal"><span lang="EN-US">loop as long as <span class="LuaCitalic">exp</span> is true</span></p>
558 </td>
559 </tr>
560
561 <tr>
562 <td width="331" valign="top">
563 <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=
564 "EN-US">exp</span></span></p>
565 </td>
566
567 <td width="319" valign="top">
568 <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>
569 </td>
570 </tr>
571
572 <tr>
573 <td width="331" valign="top">
574 <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=
575 "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>
576 </td>
577
578 <td width="319" valign="top">
579 <p class="MsoNormal"><span lang="EN-US">numerical for loop; <span class="LuaCitalic">var</span> is local to loop.</span></p>
580 </td>
581 </tr>
582
583 <tr>
584 <td width="331" valign="top">
585 <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=
586 "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>
587 </td>
588
589 <td width="319" valign="top">
590 <p class="MsoNormal"><span lang="EN-US">iterator based for loop; <span class="LuaCitalic">vars</span> are local to loop.</span></p>
591 </td>
592 </tr>
593
594 <tr>
595 <td width="331" valign="top">
596 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">break</span></span></p>
597 </td>
598
599 <td width="319" valign="top">
600 <p class="MsoNormal"><span lang="EN-US">exits loop; must be last statement in block.</span></p>
601 </td>
602 </tr>
603 </table>
604
605 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Table constructors</span></p>
606
607 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
608 <tr>
609 <td width="331" valign="top">
610 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">t = {}</span></span></p>
611 </td>
612
613 <td width="319" valign="top">
614 <p class="MsoNormal"><span lang="EN-US">creates an empty table and assigns it to <span class="LuaCbold">t</span></span></p>
615 </td>
616 </tr>
617
618 <tr>
619 <td width="331" valign="top">
620 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">t = {"yes", "no", "?"}</span></span></p>
621 </td>
622
623 <td width="319" valign="top">
624 <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>
625 </td>
626 </tr>
627
628 <tr>
629 <td width="331" valign="top">
630 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">t = { [1] = "yes", [2] = "no", [3] = "?" }</span></span></p>
631 </td>
632
633 <td width="319" valign="top">
634 <p class="MsoNormal"><span lang="EN-US">same as above, but with explicit fields</span></p>
635 </td>
636 </tr>
637
638 <tr>
639 <td width="331" valign="top">
640 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">t = {[-900] = 3, [+900] = 4}</span></span></p>
641 </td>
642
643 <td width="319" valign="top">
644 <p class="MsoNormal"><span lang="EN-US">sparse array with just two elements (no space wasted)</span></p>
645 </td>
646 </tr>
647
648 <tr>
649 <td width="331" valign="top">
650 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">t = {x=5, y=10}</span></span></p>
651 </td>
652
653 <td width="319" valign="top">
654 <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>
655 </td>
656 </tr>
657
658 <tr>
659 <td width="331" valign="top">
660 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">t = {x=5, y=10; "yes", "no"}</span></span></p>
661 </td>
662
663 <td width="319" valign="top">
664 <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>
665 </td>
666 </tr>
667
668 <tr>
669 <td width="331" valign="top">
670 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">t = {msg = "choice", {"yes", "no", "?"}}</span></span></p>
671 </td>
672
673 <td width="319" valign="top">
674 <p class="MsoNormal"><span lang="EN-US">tables can contain others tables as fields</span></p>
675 </td>
676 </tr>
677 </table>
678
679 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Function definition</span></p>
680
681 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
682 <tr>
683 <td width="331" valign="top">
684 <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=
685 "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> ]
686 <span class="LuaCbold">end</span></span></p>
687 </td>
688
689 <td width="319" valign="top">
690 <p class="MsoNormal"><span lang="EN-US">defines function and assigns to global variable <span class="LuaCbold">name</span></span></p>
691 </td>
692 </tr>
693
694 <tr>
695 <td width="331" valign="top">
696 <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=
697 "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=
698 "LuaCitalic">values</span> ] <span class="LuaCbold">end</span></span></p>
699 </td>
700
701 <td width="319" valign="top">
702 <p class="MsoNormal"><span lang="EN-US">defines function as local to chunk</span></p>
703 </td>
704 </tr>
705
706 <tr>
707 <td width="331" valign="top">
708 <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>
709 </td>
710
711 <td width="319" valign="top">
712 <p class="MsoNormal"><span lang="EN-US">anonymous function assigned to variable <span class="LuaCbold">f</span></span></p>
713 </td>
714 </tr>
715
716 <tr>
717 <td width="331" valign="top">
718 <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=
719 "LuaCbold">return</span> <span class="LuaCitalic">values</span> ] <span class="LuaCbold">end</span></span></p>
720 </td>
721
722 <td width="319" valign="top">
723 <p class="MsoNormal"><span lang="EN-US">variable argument list, in <span class="LuaCitalic">body</span> accessed as <span class="LuaCbold">...</span></span></p>
724 </td>
725 </tr>
726
727 <tr>
728 <td width="331" valign="top">
729 <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=
730 "EN-US">name</span></span></p>
731 </td>
732
733 <td width="319" valign="top">
734 <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>
735 </td>
736 </tr>
737
738 <tr>
739 <td width="331" valign="top">
740 <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=
741 "EN-US">name</span></span></p>
742 </td>
743
744 <td width="319" valign="top">
745 <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>
746 </td>
747 </tr>
748 </table>
749
750 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Function call</span></p>
751
752 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
753 <tr>
754 <td width="165" valign="top">
755 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">f (x)</span></span></p>
756 </td>
757
758 <td width="484" valign="top">
759 <p class="MsoNormal"><span lang="EN-US">simple call, possibly returning one or more values</span></p>
760 </td>
761 </tr>
762
763 <tr>
764 <td width="165" valign="top">
765 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">f "hello"</span></span></p>
766 </td>
767
768 <td width="484" valign="top">
769 <p class="MsoNormal"><span lang="EN-US">shortcut for <span class="LuaCbold">f("hello")</span></span></p>
770 </td>
771 </tr>
772
773 <tr>
774 <td width="165" valign="top">
775 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">f 'goodbye'</span></span></p>
776 </td>
777
778 <td width="484" valign="top">
779 <p class="MsoNormal"><span lang="EN-US">shortcut for <span class="LuaCbold">f('goodbye')</span></span></p>
780 </td>
781 </tr>
782
783 <tr>
784 <td width="165" valign="top">
785 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">f [[see you soon]]</span></span></p>
786 </td>
787
788 <td width="484" valign="top">
789 <p class="MsoNormal"><span lang="EN-US">shortcut for <span class="LuaCbold">f([[see you soon]])</span></span></p>
790 </td>
791 </tr>
792
793 <tr>
794 <td width="165" valign="top">
795 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">f {x = 3, y = 4}</span></span></p>
796 </td>
797
798 <td width="484" valign="top">
799 <p class="MsoNormal"><span lang="EN-US">shortcut for <span class="LuaCbold">f({x = 3, y = 4})</span></span></p>
800 </td>
801 </tr>
802
803 <tr>
804 <td width="165" valign="top">
805 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">t.f (x)</span></span></p>
806 </td>
807
808 <td width="484" valign="top">
809 <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>
810 </td>
811 </tr>
812
813 <tr>
814 <td width="165" valign="top">
815 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">x:move (2, -3)</span></span></p>
816 </td>
817
818 <td width="484" valign="top">
819 <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>
820 </td>
821 </tr>
822 </table>
823
824 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Metatable operations (base
825 library required)</span></p>
826
827 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
828 <tr>
829 <td width="165" valign="top">
830 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">setmetatable</span></span> <span lang="EN-US">(t, mt)</span></p>
831 </td>
832
833 <td width="484" valign="top">
834 <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>
835 </td>
836 </tr>
837
838 <tr>
839 <td width="165" valign="top">
840 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">getmetatable</span></span> <span lang="EN-US">(t)</span></p>
841 </td>
842
843 <td width="484" valign="top">
844 <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>
845 </td>
846 </tr>
847
848 <tr>
849 <td width="165" valign="top">
850 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">rawget</span></span> <span lang="EN-US">(t, i)</span></p>
851 </td>
852
853 <td width="484" valign="top">
854 <p class="MsoNormal"><span lang="EN-US">gets <span class="LuaCbold">t[i]</span> of a table without invoking metamethods</span></p>
855 </td>
856 </tr>
857
858 <tr>
859 <td width="165" valign="top">
860 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">rawset</span></span> <span lang="EN-US">(t, i, v)</span></p>
861 </td>
862
863 <td width="484" valign="top">
864 <p class="MsoNormal"><span lang="EN-US">sets <span class="LuaCbold">t[i] = v</span> on a table without invoking metamethods</span></p>
865 </td>
866 </tr>
867
868 <tr>
869 <td width="165" valign="top">
870 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">rawequal</span></span> <span lang="EN-US">(t1, t2)</span></p>
871 </td>
872
873 <td width="484" valign="top">
874 <p class="MsoNormal"><span lang="EN-US">returns boolean <span class="LuaCbold">(t1 == t2)</span> without invoking metamethods</span></p>
875 </td>
876 </tr>
877 </table>
878
879 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Metatable fields (for tables and
880 userdata)</span></p>
881
882 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" width="650" summary="?">
883 <tr>
884 <td width="83" valign="top">
885 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__add, __sub</span></span></p>
886 </td>
887
888 <td width="248" valign="top">
889 <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>
890 </td>
891
892 <td width="83" valign="top">
893 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__mul, __div</span></span></p>
894 </td>
895
896 <td width="236" valign="top">
897 <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>
898 </td>
899 </tr>
900
901 <tr>
902 <td width="83" valign="top">
903 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__mod</span></span></p>
904 </td>
905
906 <td width="248" valign="top">
907 <p class="MsoNormal"><span lang="EN-US">set handler <span class="LuaCbold">h(a, b)</span> for '%'</span></p>
908 </td>
909
910 <td width="83" valign="top">
911 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__pow</span></span></p>
912 </td>
913
914 <td width="236" valign="top">
915 <p class="MsoNormal"><span lang="EN-US">sets handler <span class="LuaCbold">h(a, b)</span> for ' <span class="LuaCbold">^</span> '</span></p>
916 </td>
917 </tr>
918
919 <tr>
920 <td width="83" valign="top">
921 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__unm</span></span></p>
922 </td>
923
924 <td width="248" valign="top">
925 <p class="MsoNormal"><span lang="EN-US">sets handler <span class="LuaCbold">h(a)</span> for unary ' <span class="LuaCbold">-</span> '</span></p>
926 </td>
927
928 <td width="83" valign="top">
929 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__len</span></span></p>
930 </td>
931
932 <td width="236" valign="top">
933 <p class="MsoNormal"><span lang="EN-US">sets handler <span class="LuaCbold">h(a)</span> for the # operator</span></p>
934 </td>
935 </tr>
936
937 <tr>
938 <td width="83" valign="top">
939 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__concat</span></span></p>
940 </td>
941
942 <td width="248" valign="top">
943 <p class="MsoNormal"><span lang="EN-US">sets handler <span class="LuaCbold">h(a, b)</span> for '..'</span></p>
944 </td>
945
946 <td width="83" valign="top">
947 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__eq</span></span></p>
948 </td>
949
950 <td width="236" valign="top">
951 <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>
952 </td>
953 </tr>
954
955 <tr>
956 <td width="83" valign="top">
957 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__lt</span></span></p>
958 </td>
959
960 <td width="248" valign="top">
961 <p class="MsoNormal"><span lang="EN-US">sets handler <span class="LuaCbold">h(a, b)</span> for ' <span class="LuaCbold">&lt;</span> ', ' <span class="LuaCbold">&gt;</span> ' and possibly ' <span class="LuaCbold">&lt;=</span> ', ' <span class=
962 "LuaCbold">&gt;=</span> ' (if no <span class="LuaCbold">__le</span> )</span></p>
963 </td>
964
965 <td width="83" valign="top">
966 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__le</span></span></p>
967 </td>
968
969 <td width="236" valign="top">
970 <p class="MsoNormal"><span lang="EN-US">sets handler <span class="LuaCbold">h(a, b)</span> for ' <span class="LuaCbold">&lt;=</span> ', ' <span class="LuaCbold">&gt;=</span> '</span></p>
971 </td>
972 </tr>
973
974 <tr>
975 <td width="83" valign="top">
976 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__index</span></span></p>
977 </td>
978
979 <td width="248" valign="top">
980 <p class="MsoNormal"><span lang="EN-US">sets handler <span class="LuaCbold">h(t, k)</span> for access to non-existing field</span></p>
981 </td>
982
983 <td width="83" valign="top">
984 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__newindex</span></span></p>
985 </td>
986
987 <td width="236" valign="top">
988 <p class="MsoNormal"><span lang="EN-US">sets handler <span class="LuaCbold">h(t, k)</span> for assignment to non-existing field</span></p>
989 </td>
990 </tr>
991
992 <tr>
993 <td width="83" valign="top">
994 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__call</span></span></p>
995 </td>
996
997 <td width="248" valign="top">
998 <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>
999 </td>
1000
1001 <td width="83" valign="top">
1002 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__tostring</span></span></p>
1003 </td>
1004
1005 <td width="236" valign="top">
1006 <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>
1007 </td>
1008 </tr>
1009
1010 <tr>
1011 <td width="83" valign="top">
1012 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__gc</span></span></p>
1013 </td>
1014
1015 <td width="248" valign="top">
1016 <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>
1017 </td>
1018
1019 <td width="83" valign="top">
1020 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__mode</span></span></p>
1021 </td>
1022
1023 <td width="236" valign="top">
1024 <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>
1025 </td>
1026 </tr>
1027
1028 <tr>
1029 <td width="83" valign="top">
1030 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__metatable</span></span></p>
1031 </td>
1032
1033 <td width="248" valign="top">
1034 <p class="MsoNormal"><span lang="EN-US">sets value to be returned by <span class="LuaCbold">getmetatable()</span></span></p>
1035 </td>
1036
1037 <td width="83" valign="top">
1038 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">&nbsp;</span></span></p>
1039 </td>
1040
1041 <td width="236" valign="top">
1042 <p class="MsoNormal"><span lang="EN-US">&nbsp;</span></p>
1043 </td>
1044 </tr>
1045 </table>
1046
1047 <p class="LuaPHeader1"><a name="The_base_library" id="The_base_library"><span lang="EN-US">The base library [no prefix]</span></a></p>
1048
1049 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Environment and global
1050 variables</span></p>
1051
1052 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
1053 <tr>
1054 <td width="165" valign="top">
1055 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">getfenv</span></span> <span lang="EN-US">([f])</span></p>
1056 </td>
1057
1058 <td width="484" valign="top">
1059 <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 =
1060 current [default], 0 = global); if the environment has a field <span class="LuaCbold">__fenv</span> , returns that instead.</span></p>
1061 </td>
1062 </tr>
1063
1064 <tr>
1065 <td width="165" valign="top">
1066 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">setfenv</span></span> <span lang="EN-US">(f, t)</span></p>
1067 </td>
1068
1069 <td width="484" valign="top">
1070 <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>
1071
1072 <p class="MsoNormal"><span lang="EN-US">if the original environment has a field <span class="LuaCbold">__fenv</span> , raises an error.</span></p>
1073 </td>
1074 </tr>
1075
1076 <tr>
1077 <td width="165" valign="top">
1078 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">_G</span></span></p>
1079 </td>
1080
1081 <td width="484" valign="top">
1082 <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>
1083 </td>
1084 </tr>
1085
1086 <tr>
1087 <td width="165" valign="top">
1088 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">_VERSION</span></span></p>
1089 </td>
1090
1091 <td width="484" valign="top">
1092 <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>
1093 </td>
1094 </tr>
1095 </table>
1096
1097 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Loading and executing</span></p>
1098
1099 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
1100 <tr>
1101 <td width="165" valign="top">
1102 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">require</span></span> <span lang="EN-US">(pkgname)</span></p>
1103 </td>
1104
1105 <td width="484" valign="top">
1106 <p class="MsoNormal"><span lang="EN-US">loads a package, raises error if it can't be loaded</span></p>
1107 </td>
1108 </tr>
1109
1110 <tr>
1111 <td width="165" valign="top">
1112 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">dofile</span></span> <span lang="EN-US">([filename])</span></p>
1113 </td>
1114
1115 <td width="484" valign="top">
1116 <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>
1117 </td>
1118 </tr>
1119
1120 <tr>
1121 <td width="165" valign="top">
1122 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">load</span></span> <span lang="EN-US">(func [, chunkname])</span></p>
1123 </td>
1124
1125 <td width="484" valign="top">
1126 <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=
1127 "LuaCbold">nil</span> and error message).</span></p>
1128 </td>
1129 </tr>
1130
1131 <tr>
1132 <td width="165" valign="top">
1133 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">loadfile</span></span> <span lang="EN-US">(filename)</span></p>
1134 </td>
1135
1136 <td width="484" valign="top">
1137 <p class="MsoNormal"><span lang="EN-US">loads file <span class="LuaCbold">filename</span> ; return values like <span class="LuaCbold">load()</span> .</span></p>
1138 </td>
1139 </tr>
1140
1141 <tr>
1142 <td width="165" valign="top">
1143 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">loadstring</span></span> <span lang="EN-US">(s [, name])</span></p>
1144 </td>
1145
1146 <td width="484" valign="top">
1147 <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>
1148 </td>
1149 </tr>
1150
1151 <tr>
1152 <td width="165" valign="top">
1153 <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>
1154 </td>
1155
1156 <td width="484" valign="top">
1157 <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>
1158 </td>
1159 </tr>
1160
1161 <tr>
1162 <td width="165" valign="top">
1163 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">xpcall</span></span> <span lang="EN-US">(f, h)</span></p>
1164 </td>
1165
1166 <td width="484" valign="top">
1167 <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=
1168 "LuaCbold">h()</span> as error message, if any.</span></p>
1169 </td>
1170 </tr>
1171 </table>
1172
1173 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Simple output and error
1174 feedback</span></p>
1175
1176 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
1177 <tr>
1178 <td width="165" valign="top">
1179 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">print</span></span> <span lang="EN-US">( <span class="LuaCitalic">args</span> )</span></p>
1180 </td>
1181
1182 <td width="484" valign="top">
1183 <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>
1184 </td>
1185 </tr>
1186
1187 <tr>
1188 <td width="165" valign="top">
1189 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">error</span></span> <span lang="EN-US">(msg [, n])</span></p>
1190 </td>
1191
1192 <td width="484" valign="top">
1193 <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,
1194 current function]</span></p>
1195 </td>
1196 </tr>
1197
1198 <tr>
1199 <td width="165" valign="top">
1200 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">assert</span></span> <span lang="EN-US">(v [, msg])</span></p>
1201 </td>
1202
1203 <td width="484" valign="top">
1204 <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> :
1205 <span class="LuaCbold">"assertion failed!"</span> ]</span></p>
1206 </td>
1207 </tr>
1208 </table>
1209
1210 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">&nbsp;Information and
1211 conversion</span></p>
1212
1213 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
1214 <tr>
1215 <td width="165" valign="top">
1216 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">select</span></span> <span lang="EN-US">(index, ...)</span></p>
1217 </td>
1218
1219 <td width="484" valign="top">
1220 <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>
1221 </td>
1222 </tr>
1223
1224 <tr>
1225 <td width="165" valign="top">
1226 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">type</span></span> <span lang="EN-US">(x)</span></p>
1227 </td>
1228
1229 <td width="484" valign="top">
1230 <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>
1231 above.</span></p>
1232 </td>
1233 </tr>
1234
1235 <tr>
1236 <td width="165" valign="top">
1237 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">tostring</span></span> <span lang="EN-US">(x)</span></p>
1238 </td>
1239
1240 <td width="484" valign="top">
1241 <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>
1242 </td>
1243 </tr>
1244
1245 <tr>
1246 <td width="165" valign="top">
1247 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">tonumber</span></span> <span lang="EN-US">(x [, b])</span></p>
1248 </td>
1249
1250 <td width="484" valign="top">
1251 <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
1252 accepts full format (e.g. "1.5e6").</span></p>
1253 </td>
1254 </tr>
1255
1256 <tr>
1257 <td width="165" valign="top">
1258 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">unpack</span></span> <span lang="EN-US">(t)</span></p>
1259 </td>
1260
1261 <td width="484" valign="top">
1262 <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>
1263 </td>
1264 </tr>
1265 </table>
1266
1267 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Iterators</span></p>
1268
1269 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
1270 <tr>
1271 <td width="165" valign="top">
1272 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">ipairs</span></span> <span lang="EN-US">(t)</span></p>
1273 </td>
1274
1275 <td width="484" valign="top">
1276 <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>
1277 </td>
1278 </tr>
1279
1280 <tr>
1281 <td width="165" valign="top">
1282 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">pairs</span></span> <span lang="EN-US">(t)</span></p>
1283 </td>
1284
1285 <td width="484" valign="top">
1286 <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>
1287 </td>
1288 </tr>
1289
1290 <tr>
1291 <td width="165" valign="top">
1292 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">next</span></span> <span lang="EN-US">(t [, inx])</span></p>
1293 </td>
1294
1295 <td width="484" valign="top">
1296 <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=
1297 "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>
1298 </td>
1299 </tr>
1300 </table>
1301
1302 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Garbage collection</span></p>
1303
1304 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
1305 <tr>
1306 <td width="165" valign="top">
1307 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">collectgarbage</span></span> <span lang="EN-US">(opt [, arg])</span></p>
1308 </td>
1309
1310 <td width="484" valign="top">
1311 <p class="MsoNormal"><span lang="EN-US">generic interface to the garbage collector; <span class="LuaCbold">opt</span> defines function performed.</span></p>
1312 </td>
1313 </tr>
1314 </table>
1315
1316 <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>
1317
1318 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
1319 <tr>
1320 <td width="166" valign="top">
1321 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">module</span></span> <span lang="EN-US">(name, ...)</span></p>
1322 </td>
1323
1324 <td width="484" valign="top">
1325 <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=
1326 "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
1327 functions to be applied over the module.</span></p>
1328 </td>
1329 </tr>
1330
1331 <tr>
1332 <td width="166" valign="top">
1333 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">package.loadlib</span></span> <span lang="EN-US">(lib, func)</span></p>
1334 </td>
1335
1336 <td width="484" valign="top">
1337 <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>
1338 </td>
1339 </tr>
1340
1341 <tr>
1342 <td width="166" valign="top">
1343 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">package.path, package.cpath</span></span></p>
1344 </td>
1345
1346 <td width="484" valign="top">
1347 <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>
1348 </td>
1349 </tr>
1350
1351 <tr>
1352 <td width="166" valign="top">
1353 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">package.loaded</span></span></p>
1354 </td>
1355
1356 <td width="484" valign="top">
1357 <p class="MsoNormal"><span lang="EN-US">a table used by require to control which modules are already loaded (see module)</span></p>
1358 </td>
1359 </tr>
1360
1361 <tr>
1362 <td width="166" valign="top">
1363 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">package.preload</span></span></p>
1364 </td>
1365
1366 <td width="484" valign="top">
1367 <p class="MsoNormal"><span lang="EN-US">a table to store loaders for specific modules (see require)</span></p>
1368 </td>
1369 </tr>
1370
1371 <tr>
1372 <td width="166" valign="top">
1373 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">package.seeall</span></span> <span lang="EN-US">(module)</span></p>
1374 </td>
1375
1376 <td width="484" valign="top">
1377 <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>
1378 </td>
1379 </tr>
1380 </table>
1381
1382 <p class="LuaPHeader1"><a name="The_coroutine_library" id="The_coroutine_library"><span lang="EN-US">The coroutine library [coroutine]</span></a></p>
1383
1384 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
1385 <tr>
1386 <td width="168" valign="top">
1387 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">coroutine.create</span></span> <span lang="EN-US">(f)</span></p>
1388 </td>
1389
1390 <td width="482" valign="top">
1391 <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>
1392 </td>
1393 </tr>
1394
1395 <tr>
1396 <td width="168" valign="top">
1397 <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>
1398 </td>
1399
1400 <td width="482" valign="top">
1401 <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=
1402 "LuaCbold">co</span> calls <span class="LuaCbold">coroutine.yield()</span> or terminates or <span class="LuaCbold">false</span> and an error message.</span></p>
1403 </td>
1404 </tr>
1405
1406 <tr>
1407 <td width="168" valign="top">
1408 <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>
1409 </td>
1410
1411 <td width="482" valign="top">
1412 <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=
1413 "LuaCbold">coroutine.resume()</span> .</span></p>
1414 </td>
1415 </tr>
1416
1417 <tr>
1418 <td width="168" valign="top">
1419 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">coroutine.status</span></span> <span lang="EN-US">(co)</span></p>
1420 </td>
1421
1422 <td width="482" valign="top">
1423 <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=
1424 "LuaCbold">"dead"</span></span></p>
1425 </td>
1426 </tr>
1427
1428 <tr>
1429 <td width="168" valign="top">
1430 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">coroutine.running ()</span></span></p>
1431 </td>
1432
1433 <td width="482" valign="top">
1434 <p class="MsoNormal"><span lang="EN-US">returns the running coroutine or nil when called by the main thread</span></p>
1435 </td>
1436 </tr>
1437
1438 <tr>
1439 <td width="168" valign="top">
1440 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">coroutine.wrap</span></span> <span lang="EN-US">(f)</span></p>
1441 </td>
1442
1443 <td width="482" valign="top">
1444 <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
1445 and the first return value, propagating any errors.</span></p>
1446 </td>
1447 </tr>
1448 </table>
1449
1450 <p class="LuaPHeader1"><a name="The_table_library" id="The_table_library"><span lang="EN-US">The table library [table]</span></a></p>
1451
1452 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
1453 <tr>
1454 <td width="168" valign="top">
1455 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">table.insert</span></span> <span lang="EN-US">(t, [i,] v)</span></p>
1456 </td>
1457
1458 <td width="482" valign="top">
1459 <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>
1460 </td>
1461 </tr>
1462
1463 <tr>
1464 <td width="168" valign="top">
1465 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">table.remove</span></span> <span lang="EN-US">(t [, i])</span></p>
1466 </td>
1467
1468 <td width="482" valign="top">
1469 <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
1470 empty table.</span></p>
1471 </td>
1472 </tr>
1473
1474 <tr>
1475 <td width="168" valign="top">
1476 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">table.maxn</span></span> <span lang="EN-US">(t)</span></p>
1477 </td>
1478
1479 <td width="482" valign="top">
1480 <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>
1481 </td>
1482 </tr>
1483
1484 <tr>
1485 <td width="168" valign="top">
1486 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">table.sort</span></span> <span lang="EN-US">(t [, cf])</span></p>
1487 </td>
1488
1489 <td width="482" valign="top">
1490 <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=
1491 "LuaCbold">&lt;</span> ']</span></p>
1492 </td>
1493 </tr>
1494
1495 <tr>
1496 <td width="168" valign="top">
1497 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">table.concat</span></span> <span lang="EN-US">(t [, s [, i [, j]]])</span></p>
1498 </td>
1499
1500 <td width="482" valign="top">
1501 <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 =
1502 #t</span> ] separated by string <span class="LuaCbold">s</span> ; returns empty string if no elements exist or <span class="LuaCbold">i</span> &gt; <span class="LuaCbold">j</span> .</span></p>
1503 </td>
1504 </tr>
1505 </table>
1506
1507 <p class="LuaPHeader1"><a name="The_mathematical_library" id="The_mathematical_library"><span lang="EN-US">The mathematical library [math]</span></a></p>
1508
1509 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Basic operations</span></p>
1510
1511 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
1512 <tr>
1513 <td width="165" valign="top">
1514 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.abs</span></span> <span lang="EN-US">(x)</span></p>
1515 </td>
1516
1517 <td width="484" valign="top">
1518 <p class="MsoNormal"><span lang="EN-US">returns the absolute value of <span class="LuaCbold">x</span></span></p>
1519 </td>
1520 </tr>
1521
1522 <tr>
1523 <td width="165" valign="top">
1524 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.mod</span></span> <span lang="EN-US">(x, y)</span></p>
1525 </td>
1526
1527 <td width="484" valign="top">
1528 <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>
1529 </td>
1530 </tr>
1531
1532 <tr>
1533 <td width="165" valign="top">
1534 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.floor</span></span> <span lang="EN-US">(x)</span></p>
1535 </td>
1536
1537 <td width="484" valign="top">
1538 <p class="MsoNormal"><span lang="EN-US">returns <span class="LuaCbold">x</span> rounded down to the nearest integer</span></p>
1539 </td>
1540 </tr>
1541
1542 <tr>
1543 <td width="165" valign="top">
1544 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.ceil</span></span> <span lang="EN-US">(x)</span></p>
1545 </td>
1546
1547 <td width="484" valign="top">
1548 <p class="MsoNormal"><span lang="EN-US">returns <span class="LuaCbold">x</span> rounded up to the nearest integer</span></p>
1549 </td>
1550 </tr>
1551
1552 <tr>
1553 <td width="165" valign="top">
1554 <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>
1555 </td>
1556
1557 <td width="484" valign="top">
1558 <p class="MsoNormal"><span lang="EN-US">returns the minimum value from the <span class="LuaCitalic">args</span> received</span></p>
1559 </td>
1560 </tr>
1561
1562 <tr>
1563 <td width="165" valign="top">
1564 <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>
1565 </td>
1566
1567 <td width="484" valign="top">
1568 <p class="MsoNormal"><span lang="EN-US">returns the maximum value from the <span class="LuaCitalic">args</span> received</span></p>
1569 </td>
1570 </tr>
1571 </table>
1572
1573 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Exponential and
1574 logarithmic</span></p>
1575
1576 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
1577 <tr>
1578 <td width="165" valign="top">
1579 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.sqrt</span></span> <span lang="EN-US">(x)</span></p>
1580 </td>
1581
1582 <td width="484" valign="top">
1583 <p class="MsoNormal"><span lang="EN-US">returns the square root of <span class="LuaCbold">x</span> , for <span class="LuaCbold">x</span> &gt;= 0</span></p>
1584 </td>
1585 </tr>
1586
1587 <tr>
1588 <td width="165" valign="top">
1589 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.pow</span></span> <span lang="EN-US">(x, y)</span></p>
1590 </td>
1591
1592 <td width="484" valign="top">
1593 <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>
1594 &lt; 0, <span class="LuaCbold">y</span> must be integer.</span></p>
1595 </td>
1596 </tr>
1597
1598 <tr>
1599 <td width="165" valign="top">
1600 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">__pow</span></span> <span lang="EN-US">(x, y)</span></p>
1601 </td>
1602
1603 <td width="484" valign="top">
1604 <p class="MsoNormal"><span lang="EN-US">global function added by the math library to make operator ' <span class="LuaCbold">^</span> ' work</span></p>
1605 </td>
1606 </tr>
1607
1608 <tr>
1609 <td width="165" valign="top">
1610 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.exp</span></span> <span lang="EN-US">(x)</span></p>
1611 </td>
1612
1613 <td width="484" valign="top">
1614 <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>
1615 </td>
1616 </tr>
1617
1618 <tr>
1619 <td width="165" valign="top">
1620 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.log</span></span> <span lang="EN-US">(x)</span></p>
1621 </td>
1622
1623 <td width="484" valign="top">
1624 <p class="MsoNormal"><span lang="EN-US">returns the natural logarithm of <span class="LuaCbold">x</span> , for <span class="LuaCbold">x</span> &gt;= 0</span></p>
1625 </td>
1626 </tr>
1627
1628 <tr>
1629 <td width="165" valign="top">
1630 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.log10</span></span> <span lang="EN-US">(x)</span></p>
1631 </td>
1632
1633 <td width="484" valign="top">
1634 <p class="MsoNormal"><span lang="EN-US">returns the base-10 logarithm of <span class="LuaCbold">x</span> , for <span class="LuaCbold">x</span> &gt;= 0</span></p>
1635 </td>
1636 </tr>
1637 </table>
1638
1639 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Trigonometrical</span></p>
1640
1641 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
1642 <tr>
1643 <td width="165" valign="top">
1644 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.deg</span></span> <span lang="EN-US">(a)</span></p>
1645 </td>
1646
1647 <td width="484" valign="top">
1648 <p class="MsoNormal"><span lang="EN-US">converts angle <span class="LuaCbold">a</span> from radians to degrees</span></p>
1649 </td>
1650 </tr>
1651
1652 <tr>
1653 <td width="165" valign="top">
1654 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.rad</span></span> <span lang="EN-US">(a)</span></p>
1655 </td>
1656
1657 <td width="484" valign="top">
1658 <p class="MsoNormal"><span lang="EN-US">converts angle <span class="LuaCbold">a</span> from degrees to radians</span></p>
1659 </td>
1660 </tr>
1661
1662 <tr>
1663 <td width="165" valign="top">
1664 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.pi</span></span></p>
1665 </td>
1666
1667 <td width="484" valign="top">
1668 <p class="MsoNormal"><span lang="EN-US">constant containing the value of pi</span></p>
1669 </td>
1670 </tr>
1671
1672 <tr>
1673 <td width="165" valign="top">
1674 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.sin</span></span> <span lang="EN-US">(a)</span></p>
1675 </td>
1676
1677 <td width="484" valign="top">
1678 <p class="MsoNormal"><span lang="EN-US">returns the sine of angle <span class="LuaCbold">a</span> (measured in radians)</span></p>
1679 </td>
1680 </tr>
1681
1682 <tr>
1683 <td width="165" valign="top">
1684 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.cos</span></span> <span lang="EN-US">(a)</span></p>
1685 </td>
1686
1687 <td width="484" valign="top">
1688 <p class="MsoNormal"><span lang="EN-US">returns the cosine of angle <span class="LuaCbold">a</span> (measured in radians)</span></p>
1689 </td>
1690 </tr>
1691
1692 <tr>
1693 <td width="165" valign="top">
1694 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.tan</span></span> <span lang="EN-US">(a)</span></p>
1695 </td>
1696
1697 <td width="484" valign="top">
1698 <p class="MsoNormal"><span lang="EN-US">returns the tangent of angle <span class="LuaCbold">a</span> (measured in radians)</span></p>
1699 </td>
1700 </tr>
1701
1702 <tr>
1703 <td width="165" valign="top">
1704 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.asin</span></span> <span lang="EN-US">(x)</span></p>
1705 </td>
1706
1707 <td width="484" valign="top">
1708 <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>
1709 </td>
1710 </tr>
1711
1712 <tr>
1713 <td width="165" valign="top">
1714 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.acos</span></span> <span lang="EN-US">(x)</span></p>
1715 </td>
1716
1717 <td width="484" valign="top">
1718 <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>
1719 </td>
1720 </tr>
1721
1722 <tr>
1723 <td width="165" valign="top">
1724 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.atan</span></span> <span lang="EN-US">(x)</span></p>
1725 </td>
1726
1727 <td width="484" valign="top">
1728 <p class="MsoNormal"><span lang="EN-US">returns the arc tangent of <span class="LuaCbold">x</span> in radians</span></p>
1729 </td>
1730 </tr>
1731
1732 <tr>
1733 <td width="165" valign="top">
1734 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.atan2</span></span> <span lang="EN-US">(y, x)</span></p>
1735 </td>
1736
1737 <td width="484" valign="top">
1738 <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>
1739 </td>
1740 </tr>
1741 </table>
1742
1743 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Splitting on powers of
1744 2</span></p>
1745
1746 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
1747 <tr>
1748 <td width="165" valign="top">
1749 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.frexp</span></span> <span lang="EN-US">(x)</span></p>
1750 </td>
1751
1752 <td width="484" valign="top">
1753 <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>
1754 </td>
1755 </tr>
1756
1757 <tr>
1758 <td width="165" valign="top">
1759 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.ldexp</span></span> <span lang="EN-US">(x, y)</span></p>
1760 </td>
1761
1762 <td width="484" valign="top">
1763 <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=
1764 "LuaCbold">2</span></span></p>
1765 </td>
1766 </tr>
1767 </table>
1768
1769 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Pseudo-random numbers</span></p>
1770
1771 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
1772 <tr>
1773 <td width="165" valign="top">
1774 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.random</span></span> <span lang="EN-US">([n [, m])</span></p>
1775 </td>
1776
1777 <td width="484" valign="top">
1778 <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> ,
1779 <span class="LuaCbold">m</span> ] if both <span class="LuaCbold">n</span> and <span class="LuaCbold">m</span> are passed.</span></p>
1780 </td>
1781 </tr>
1782
1783 <tr>
1784 <td width="165" valign="top">
1785 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">math.randomseed</span></span> <span lang="EN-US">(n)</span></p>
1786 </td>
1787
1788 <td width="484" valign="top">
1789 <p class="MsoNormal"><span lang="EN-US">sets a seed <span class="LuaCbold">n</span> for random sequence (same seed = same sequence)</span></p>
1790 </td>
1791 </tr>
1792 </table>
1793
1794 <p class="LuaPHeader1"><a name="The_string_library" id="The_string_library"><span lang="EN-US">The string library [string]</span></a></p>
1795
1796 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Basic operations</span></p>
1797
1798 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
1799 <tr>
1800 <td width="165" valign="top">
1801 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.len</span></span> <span lang="EN-US">(s)</span></p>
1802 </td>
1803
1804 <td width="484" valign="top">
1805 <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>
1806 </td>
1807 </tr>
1808
1809 <tr>
1810 <td width="165" valign="top">
1811 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.sub</span></span> <span lang="EN-US">(s, i [, j])</span></p>
1812 </td>
1813
1814 <td width="484" valign="top">
1815 <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>
1816 </td>
1817 </tr>
1818
1819 <tr>
1820 <td width="165" valign="top">
1821 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.rep</span></span> <span lang="EN-US">(s, n)</span></p>
1822 </td>
1823
1824 <td width="484" valign="top">
1825 <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>
1826 </td>
1827 </tr>
1828
1829 <tr>
1830 <td width="165" valign="top">
1831 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.upper</span></span> <span lang="EN-US">(s)</span></p>
1832 </td>
1833
1834 <td width="484" valign="top">
1835 <p class="MsoNormal"><span lang="EN-US">returns a copy of <span class="LuaCbold">s</span> converted to uppercase according to locale</span></p>
1836 </td>
1837 </tr>
1838
1839 <tr>
1840 <td width="165" valign="top">
1841 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.lower</span></span> <span lang="EN-US">(s)</span></p>
1842 </td>
1843
1844 <td width="484" valign="top">
1845 <p class="MsoNormal"><span lang="EN-US">returns a copy of <span class="LuaCbold">s</span> converted to lowercase according to locale</span></p>
1846 </td>
1847 </tr>
1848 </table>
1849
1850 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Character codes</span></p>
1851
1852 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
1853 <tr>
1854 <td width="165" valign="top">
1855 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.byte</span></span> <span lang="EN-US">(s [, i])</span></p>
1856 </td>
1857
1858 <td width="484" valign="top">
1859 <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=
1860 "LuaCbold">nil</span> if <span class="LuaCbold">i</span> is invalid</span></p>
1861 </td>
1862 </tr>
1863
1864 <tr>
1865 <td width="165" valign="top">
1866 <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>
1867 </td>
1868
1869 <td width="484" valign="top">
1870 <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>
1871 </td>
1872 </tr>
1873 </table>
1874
1875 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Function storage</span></p>
1876
1877 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
1878 <tr>
1879 <td width="165" valign="top">
1880 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.dump</span></span> <span lang="EN-US">(f)</span></p>
1881 </td>
1882
1883 <td width="484" valign="top">
1884 <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
1885 no upvalues)</span></p>
1886 </td>
1887 </tr>
1888 </table>
1889
1890 <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>
1891
1892 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Formatting</span></p>
1893
1894 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
1895 <tr>
1896 <td width="165" valign="top">
1897 <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>
1898 </td>
1899
1900 <td width="484" valign="top">
1901 <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> ,
1902 in the given order (see <span class="LuaCitalic">Formatting directives</span> below)</span></p>
1903 </td>
1904 </tr>
1905 </table>
1906
1907 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Formatting directives for
1908 string.format</span></p>
1909
1910 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
1911 <tr>
1912 <td width="650" valign="top">
1913 <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=
1914 "LuaCitalic">precision</span> ] <span class="LuaCitalic">type</span></span></p>
1915 </td>
1916 </tr>
1917 </table>
1918
1919 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Formatting field
1920 types</span></p>
1921
1922 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
1923 <tr>
1924 <td width="165" valign="top">
1925 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%d</span></span></p>
1926 </td>
1927
1928 <td width="484" valign="top">
1929 <p class="MsoNormal"><span lang="EN-US">decimal integer</span></p>
1930 </td>
1931 </tr>
1932
1933 <tr>
1934 <td width="165" valign="top">
1935 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%o</span></span></p>
1936 </td>
1937
1938 <td width="484" valign="top">
1939 <p class="MsoNormal"><span lang="EN-US">octal integer</span></p>
1940 </td>
1941 </tr>
1942
1943 <tr>
1944 <td width="165" valign="top">
1945 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%x</span></span></p>
1946 </td>
1947
1948 <td width="484" valign="top">
1949 <p class="MsoNormal"><span lang="EN-US">hexadecimal integer, uppercase if <span class="LuaCbold">%X</span></span></p>
1950 </td>
1951 </tr>
1952
1953 <tr>
1954 <td width="165" valign="top">
1955 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%f</span></span></p>
1956 </td>
1957
1958 <td width="484" valign="top">
1959 <p class="MsoNormal"><span lang="EN-US">floating-point in the form [-]nnnn.nnnn</span></p>
1960 </td>
1961 </tr>
1962
1963 <tr>
1964 <td width="165" valign="top">
1965 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%e</span></span></p>
1966 </td>
1967
1968 <td width="484" valign="top">
1969 <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>
1970 </td>
1971 </tr>
1972
1973 <tr>
1974 <td width="165" valign="top">
1975 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%g</span></span></p>
1976 </td>
1977
1978 <td width="484" valign="top">
1979 <p class="MsoNormal"><span lang="EN-US">floating-point as <span class="LuaCbold">%e</span> if exp. &lt; -4 or &gt;= precision, else as <span class="LuaCbold">%f</span> ; uppercase if <span class="LuaCbold">%G</span> .</span></p>
1980 </td>
1981 </tr>
1982
1983 <tr>
1984 <td width="165" valign="top">
1985 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%c</span></span></p>
1986 </td>
1987
1988 <td width="484" valign="top">
1989 <p class="MsoNormal"><span lang="EN-US">character having the (system-dependent) code passed as integer</span></p>
1990 </td>
1991 </tr>
1992
1993 <tr>
1994 <td width="165" valign="top">
1995 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%s</span></span></p>
1996 </td>
1997
1998 <td width="484" valign="top">
1999 <p class="MsoNormal"><span lang="EN-US">string with no embedded zeros</span></p>
2000 </td>
2001 </tr>
2002
2003 <tr>
2004 <td width="165" valign="top">
2005 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%q</span></span></p>
2006 </td>
2007
2008 <td width="484" valign="top">
2009 <p class="MsoNormal"><span lang="EN-US">string between double quotes, with all special characters escaped</span></p>
2010 </td>
2011 </tr>
2012
2013 <tr>
2014 <td width="165" valign="top">
2015 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%%</span></span></p>
2016 </td>
2017
2018 <td width="484" valign="top">
2019 <p class="MsoNormal"><span lang="EN-US">' <span class="LuaCbold">%</span> ' character</span></p>
2020 </td>
2021 </tr>
2022 </table>
2023
2024 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Formatting flags</span></p>
2025
2026 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
2027 <tr>
2028 <td width="165" valign="top">
2029 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-</span></span></p>
2030 </td>
2031
2032 <td width="484" valign="top">
2033 <p class="MsoNormal"><span lang="EN-US">left-justifies within <span class="LuaCbold">field_width</span> [default: right-justify]</span></p>
2034 </td>
2035 </tr>
2036
2037 <tr>
2038 <td width="165" valign="top">
2039 <p class="MsoNormal"><span lang="EN-US">+</span></p>
2040 </td>
2041
2042 <td width="484" valign="top">
2043 <p class="MsoNormal"><span lang="EN-US">prepends sign (only applies to numbers)</span></p>
2044 </td>
2045 </tr>
2046
2047 <tr>
2048 <td width="165" valign="top">
2049 <p class="MsoNormal"><span lang="EN-US">( <span class="LuaCbold">space</span> )</span></p>
2050 </td>
2051
2052 <td width="484" valign="top">
2053 <p class="MsoNormal"><span lang="EN-US">prepends sign if negative, else blank space</span></p>
2054 </td>
2055 </tr>
2056
2057 <tr>
2058 <td width="165" valign="top">
2059 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">#</span></span></p>
2060 </td>
2061
2062 <td width="484" valign="top">
2063 <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=
2064 "LuaCbold">%g</span></span></p>
2065 </td>
2066 </tr>
2067 </table>
2068
2069 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Formatting field width and
2070 precision</span></p>
2071
2072 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
2073 <tr>
2074 <td width="165" valign="top">
2075 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">n</span></span></p>
2076 </td>
2077
2078 <td width="484" valign="top">
2079 <p class="MsoNormal"><span lang="EN-US">puts at least <span class="LuaCbold">n</span> characters, pad with blanks</span></p>
2080 </td>
2081 </tr>
2082
2083 <tr>
2084 <td width="165" valign="top">
2085 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">0n</span></span></p>
2086 </td>
2087
2088 <td width="484" valign="top">
2089 <p class="MsoNormal"><span lang="EN-US">puts at least <span class="LuaCbold">n</span> characters, left-pad with zeros</span></p>
2090 </td>
2091 </tr>
2092
2093 <tr>
2094 <td width="165" valign="top">
2095 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">.n</span></span></p>
2096 </td>
2097
2098 <td width="484" valign="top">
2099 <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
2100 strings.</span></p>
2101 </td>
2102 </tr>
2103 </table>
2104
2105 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Formatting examples</span></p>
2106
2107 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
2108 <tr>
2109 <td width="319" valign="top">
2110 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.format("results: %d, %d", 13, 27)</span></span></p>
2111 </td>
2112
2113 <td width="331" valign="top">
2114 <p class="MsoNormal"><span lang="EN-US">results: 13, 27</span></p>
2115 </td>
2116 </tr>
2117
2118 <tr>
2119 <td width="319" valign="top">
2120 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.format("&lt;%5d&gt;", 13)</span></span></p>
2121 </td>
2122
2123 <td width="331" valign="top">
2124 <p class="MsoNormal"><span lang="EN-US">&lt;&nbsp;&nbsp; 13&gt;</span></p>
2125 </td>
2126 </tr>
2127
2128 <tr>
2129 <td width="319" valign="top">
2130 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.format("&lt;%-5d&gt;", 13)</span></span></p>
2131 </td>
2132
2133 <td width="331" valign="top">
2134 <p class="MsoNormal"><span lang="EN-US">&lt;13&nbsp;&nbsp; &gt;</span></p>
2135 </td>
2136 </tr>
2137
2138 <tr>
2139 <td width="319" valign="top">
2140 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.format("&lt;%05d&gt;", 13)</span></span></p>
2141 </td>
2142
2143 <td width="331" valign="top">
2144 <p class="MsoNormal"><span lang="EN-US">&lt;00013&gt;</span></p>
2145 </td>
2146 </tr>
2147
2148 <tr>
2149 <td width="319" valign="top">
2150 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.format("&lt;%06.3d&gt;", 13)</span></span></p>
2151 </td>
2152
2153 <td width="331" valign="top">
2154 <p class="MsoNormal"><span lang="EN-US">&lt;&nbsp;&nbsp; 013&gt;</span></p>
2155 </td>
2156 </tr>
2157
2158 <tr>
2159 <td width="319" valign="top">
2160 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.format("&lt;%f&gt;", math.pi)</span></span></p>
2161 </td>
2162
2163 <td width="331" valign="top">
2164 <p class="MsoNormal"><span lang="EN-US">&lt;3.141593&gt;</span></p>
2165 </td>
2166 </tr>
2167
2168 <tr>
2169 <td width="319" valign="top">
2170 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.format("&lt;%e&gt;", math.pi)</span></span></p>
2171 </td>
2172
2173 <td width="331" valign="top">
2174 <p class="MsoNormal"><span lang="EN-US">&lt;3.141593e+00&gt;</span></p>
2175 </td>
2176 </tr>
2177
2178 <tr>
2179 <td width="319" valign="top">
2180 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.format("&lt;%.4f&gt;", math.pi)</span></span></p>
2181 </td>
2182
2183 <td width="331" valign="top">
2184 <p class="MsoNormal"><span lang="EN-US">&lt;3.1416&gt;</span></p>
2185 </td>
2186 </tr>
2187
2188 <tr>
2189 <td width="319" valign="top">
2190 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.format("&lt;%9.4f&gt;", math.pi)</span></span></p>
2191 </td>
2192
2193 <td width="331" valign="top">
2194 <p class="MsoNormal"><span lang="EN-US">&lt;&nbsp;&nbsp; 3.1416&gt;</span></p>
2195 </td>
2196 </tr>
2197
2198 <tr>
2199 <td width="319" valign="top">
2200 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.format("&lt;%c&gt;", 64)</span></span></p>
2201 </td>
2202
2203 <td width="331" valign="top">
2204 <p class="MsoNormal"><span lang="EN-US">&lt;@&gt;</span></p>
2205 </td>
2206 </tr>
2207
2208 <tr>
2209 <td width="319" valign="top">
2210 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.format("&lt;%.4s&gt;", "goodbye")</span></span></p>
2211 </td>
2212
2213 <td width="331" valign="top">
2214 <p class="MsoNormal"><span lang="EN-US">&lt;good&gt;</span></p>
2215 </td>
2216 </tr>
2217
2218 <tr>
2219 <td width="319" valign="top">
2220 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.format("%q", [[she said "hi"]])</span></span></p>
2221 </td>
2222
2223 <td width="331" valign="top">
2224 <p class="MsoNormal"><span lang="EN-US">"she said \"hi\""</span></p>
2225 </td>
2226 </tr>
2227 </table>
2228
2229 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Finding, replacing, iterating
2230 (for the Patterns see below)</span></p>
2231
2232 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
2233 <tr>
2234 <td width="165" valign="top">
2235 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.find</span></span> <span lang="EN-US">(s, p [, i [, d]])</span></p>
2236 </td>
2237
2238 <td width="484" valign="top">
2239 <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
2240 <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>
2241 </td>
2242 </tr>
2243
2244 <tr>
2245 <td width="165" valign="top">
2246 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.gmatch</span></span> <span lang="EN-US">(s, p)</span></p>
2247 </td>
2248
2249 <td width="484" valign="top">
2250 <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>
2251 </td>
2252 </tr>
2253
2254 <tr>
2255 <td width="165" valign="top">
2256 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.gsub</span></span> <span lang="EN-US">(s, p, r [, n])</span></p>
2257 </td>
2258
2259 <td width="484" valign="top">
2260 <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=
2261 "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=
2262 "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
2263 into the table. The function returns the number of substitutions made as second result.</span></p>
2264 </td>
2265 </tr>
2266
2267 <tr>
2268 <td width="165" valign="top">
2269 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.match</span></span> <span lang="EN-US">(s, p [, i])</span></p>
2270 </td>
2271
2272 <td width="484" valign="top">
2273 <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=
2274 "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>
2275 </td>
2276 </tr>
2277 </table>
2278
2279 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Patterns and pattern
2280 items</span></p>
2281
2282 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
2283 <tr>
2284 <td width="650" colspan="2" valign="top">
2285 <p class="MsoNormal"><span lang="EN-US">General pattern format: <span class="LuaCitalic">pattern_item</span> [ <span class="LuaCitalic">pattern_items</span> ]</span></p>
2286 </td>
2287 </tr>
2288
2289 <tr>
2290 <td width="71" valign="top">
2291 <p class="MsoNormal"><span class="LuaCitalic"><span lang="EN-US">cc</span></span></p>
2292 </td>
2293
2294 <td width="579" valign="top">
2295 <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>
2296 </td>
2297 </tr>
2298
2299 <tr>
2300 <td width="71" valign="top">
2301 <p class="MsoNormal"><span class="LuaCitalic"><span lang="EN-US">cc</span></span> <span class="LuaCbold"><span lang="EN-US">*</span></span></p>
2302 </td>
2303
2304 <td width="579" valign="top">
2305 <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>
2306 </td>
2307 </tr>
2308
2309 <tr>
2310 <td width="71" valign="top">
2311 <p class="MsoNormal"><span class="LuaCitalic"><span lang="EN-US">cc</span></span> <span class="LuaCbold"><span lang="EN-US">-</span></span></p>
2312 </td>
2313
2314 <td width="579" valign="top">
2315 <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>
2316 </td>
2317 </tr>
2318
2319 <tr>
2320 <td width="71" valign="top">
2321 <p class="MsoNormal"><span class="LuaCitalic"><span lang="EN-US">cc</span></span> <span class="LuaCbold"><span lang="EN-US">+</span></span></p>
2322 </td>
2323
2324 <td width="579" valign="top">
2325 <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>
2326 </td>
2327 </tr>
2328
2329 <tr>
2330 <td width="71" valign="top">
2331 <p class="MsoNormal"><span class="LuaCitalic"><span lang="EN-US">cc</span></span> <span class="LuaCbold"><span lang="EN-US">?</span></span></p>
2332 </td>
2333
2334 <td width="579" valign="top">
2335 <p class="MsoNormal"><span lang="EN-US">matches zero or one character in the class <span class="LuaCitalic">cc</span></span></p>
2336 </td>
2337 </tr>
2338
2339 <tr>
2340 <td width="71" valign="top">
2341 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%</span></span> <span class="LuaCitalic"><span lang="EN-US">n</span></span></p>
2342 </td>
2343
2344 <td width="579" valign="top">
2345 <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>
2346 </td>
2347 </tr>
2348
2349 <tr>
2350 <td width="71" valign="top">
2351 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%b</span></span> <span class="LuaCitalic"><span lang="EN-US">xy</span></span></p>
2352 </td>
2353
2354 <td width="579" valign="top">
2355 <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>
2356 </td>
2357 </tr>
2358
2359 <tr>
2360 <td width="71" valign="top">
2361 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">^</span></span></p>
2362 </td>
2363
2364 <td width="579" valign="top">
2365 <p class="MsoNormal"><span lang="EN-US">anchors pattern to start of string, must be the first item in the pattern</span></p>
2366 </td>
2367 </tr>
2368
2369 <tr>
2370 <td width="71" valign="top">
2371 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">$</span></span></p>
2372 </td>
2373
2374 <td width="579" valign="top">
2375 <p class="MsoNormal"><span lang="EN-US">anchors pattern to end of string, must be the last item in the pattern</span></p>
2376 </td>
2377 </tr>
2378 </table>
2379
2380 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Captures</span></p>
2381
2382 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
2383 <tr>
2384 <td width="71" valign="top">
2385 <p class="MsoNormal"><span lang="EN-US">( <span class="LuaCitalic">pattern</span> )</span></p>
2386 </td>
2387
2388 <td width="579" valign="top">
2389 <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>
2390 </td>
2391 </tr>
2392
2393 <tr>
2394 <td width="71" valign="top">
2395 <p class="MsoNormal"><span lang="EN-US">()</span></p>
2396 </td>
2397
2398 <td width="579" valign="top">
2399 <p class="MsoNormal"><span lang="EN-US">stores current string position as capture</span></p>
2400 </td>
2401 </tr>
2402 </table>
2403
2404 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Pattern character
2405 classes</span></p>
2406
2407 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" width="650" summary="?">
2408 <tr>
2409 <td width="71" valign="top">
2410 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">.</span></span></p>
2411 </td>
2412
2413 <td width="260" valign="top">
2414 <p class="MsoNormal"><span lang="EN-US">any character</span></p>
2415 </td>
2416
2417 <td width="71" valign="top">
2418 <p class="MsoNormal"><span lang="EN-US">&nbsp;</span></p>
2419 </td>
2420
2421 <td width="248" valign="top">
2422 <p class="MsoNormal"><span lang="EN-US">&nbsp;</span></p>
2423 </td>
2424 </tr>
2425
2426 <tr>
2427 <td width="71" valign="top">
2428 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%a</span></span></p>
2429 </td>
2430
2431 <td width="260" valign="top">
2432 <p class="MsoNormal"><span lang="EN-US">any letter</span></p>
2433 </td>
2434
2435 <td width="71" valign="top">
2436 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%A</span></span></p>
2437 </td>
2438
2439 <td width="248" valign="top">
2440 <p class="MsoNormal"><span lang="EN-US">any non-letter</span></p>
2441 </td>
2442 </tr>
2443
2444 <tr>
2445 <td width="71" valign="top">
2446 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%c</span></span></p>
2447 </td>
2448
2449 <td width="260" valign="top">
2450 <p class="MsoNormal"><span lang="EN-US">any control character</span></p>
2451 </td>
2452
2453 <td width="71" valign="top">
2454 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%C</span></span></p>
2455 </td>
2456
2457 <td width="248" valign="top">
2458 <p class="MsoNormal"><span lang="EN-US">any non-control character</span></p>
2459 </td>
2460 </tr>
2461
2462 <tr>
2463 <td width="71" valign="top">
2464 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%d</span></span></p>
2465 </td>
2466
2467 <td width="260" valign="top">
2468 <p class="MsoNormal"><span lang="EN-US">any digit</span></p>
2469 </td>
2470
2471 <td width="71" valign="top">
2472 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%D</span></span></p>
2473 </td>
2474
2475 <td width="248" valign="top">
2476 <p class="MsoNormal"><span lang="EN-US">any non-digit</span></p>
2477 </td>
2478 </tr>
2479
2480 <tr>
2481 <td width="71" valign="top">
2482 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%l</span></span></p>
2483 </td>
2484
2485 <td width="260" valign="top">
2486 <p class="MsoNormal"><span lang="EN-US">any lowercase letter</span></p>
2487 </td>
2488
2489 <td width="71" valign="top">
2490 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%L</span></span></p>
2491 </td>
2492
2493 <td width="248" valign="top">
2494 <p class="MsoNormal"><span lang="EN-US">any non-(lowercase letter)</span></p>
2495 </td>
2496 </tr>
2497
2498 <tr>
2499 <td width="71" valign="top">
2500 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%p</span></span></p>
2501 </td>
2502
2503 <td width="260" valign="top">
2504 <p class="MsoNormal"><span lang="EN-US">any punctuation character</span></p>
2505 </td>
2506
2507 <td width="71" valign="top">
2508 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%P</span></span></p>
2509 </td>
2510
2511 <td width="248" valign="top">
2512 <p class="MsoNormal"><span lang="EN-US">any non-punctuation character</span></p>
2513 </td>
2514 </tr>
2515
2516 <tr>
2517 <td width="71" valign="top">
2518 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%s</span></span></p>
2519 </td>
2520
2521 <td width="260" valign="top">
2522 <p class="MsoNormal"><span lang="EN-US">any whitespace character</span></p>
2523 </td>
2524
2525 <td width="71" valign="top">
2526 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%S</span></span></p>
2527 </td>
2528
2529 <td width="248" valign="top">
2530 <p class="MsoNormal"><span lang="EN-US">any non-whitespace character</span></p>
2531 </td>
2532 </tr>
2533
2534 <tr>
2535 <td width="71" valign="top">
2536 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%u</span></span></p>
2537 </td>
2538
2539 <td width="260" valign="top">
2540 <p class="MsoNormal"><span lang="EN-US">any uppercase letter</span></p>
2541 </td>
2542
2543 <td width="71" valign="top">
2544 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%U</span></span></p>
2545 </td>
2546
2547 <td width="248" valign="top">
2548 <p class="MsoNormal"><span lang="EN-US">any non-(uppercase letter)</span></p>
2549 </td>
2550 </tr>
2551
2552 <tr>
2553 <td width="71" valign="top">
2554 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%w</span></span></p>
2555 </td>
2556
2557 <td width="260" valign="top">
2558 <p class="MsoNormal"><span lang="EN-US">any alphanumeric character</span></p>
2559 </td>
2560
2561 <td width="71" valign="top">
2562 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%W</span></span></p>
2563 </td>
2564
2565 <td width="248" valign="top">
2566 <p class="MsoNormal"><span lang="EN-US">any non-alphanumeric character</span></p>
2567 </td>
2568 </tr>
2569
2570 <tr>
2571 <td width="71" valign="top">
2572 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%x</span></span></p>
2573 </td>
2574
2575 <td width="260" valign="top">
2576 <p class="MsoNormal"><span lang="EN-US">any hexadecimal digit</span></p>
2577 </td>
2578
2579 <td width="71" valign="top">
2580 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%X</span></span></p>
2581 </td>
2582
2583 <td width="248" valign="top">
2584 <p class="MsoNormal"><span lang="EN-US">any non-(hexadecimal digit)</span></p>
2585 </td>
2586 </tr>
2587
2588 <tr>
2589 <td width="71" valign="top">
2590 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%z</span></span></p>
2591 </td>
2592
2593 <td width="260" valign="top">
2594 <p class="MsoNormal"><span lang="EN-US">the byte value zero</span></p>
2595 </td>
2596
2597 <td width="71" valign="top">
2598 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%Z</span></span></p>
2599 </td>
2600
2601 <td width="248" valign="top">
2602 <p class="MsoNormal"><span lang="EN-US">any non-zero character</span></p>
2603 </td>
2604 </tr>
2605
2606 <tr>
2607 <td width="71" valign="top">
2608 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%</span></span> <span class="LuaCitalic"><span lang="EN-US">x</span></span></p>
2609 </td>
2610
2611 <td width="260" valign="top">
2612 <p class="MsoNormal"><span lang="EN-US">if <span class="LuaCitalic">x</span> is a symbol the symbol itself</span></p>
2613 </td>
2614
2615 <td width="71" valign="top">
2616 <p class="MsoNormal"><span class="LuaCitalic"><span lang="EN-US">x</span></span></p>
2617 </td>
2618
2619 <td width="248" valign="top">
2620 <p class="MsoNormal"><span lang="EN-US">if <span class="LuaCitalic">x</span> not in ^$()%.[]*+-? the character itself</span></p>
2621 </td>
2622 </tr>
2623
2624 <tr>
2625 <td width="71" valign="top">
2626 <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>
2627 </td>
2628
2629 <td width="260" valign="top">
2630 <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>
2631 <span class="LuaCbold">]</span> , e.g. [a-z].</span></p>
2632 </td>
2633
2634 <td width="71" valign="top">
2635 <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=
2636 "EN-US">]</span></span></p>
2637 </td>
2638
2639 <td width="248" valign="top">
2640 <p class="MsoNormal"><span lang="EN-US">any character not in <span class="LuaCitalic">set</span></span></p>
2641 </td>
2642 </tr>
2643 </table>
2644
2645 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Pattern examples</span></p>
2646
2647 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
2648 <tr>
2649 <td width="319" valign="top">
2650 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.find("Lua is great!", "is")</span></span></p>
2651 </td>
2652
2653 <td width="189" valign="top">
2654 <p class="MsoNormal"><span lang="EN-US">5</span></p>
2655 </td>
2656
2657 <td width="142" valign="top">
2658 <p class="MsoNormal"><span lang="EN-US">6</span></p>
2659 </td>
2660 </tr>
2661
2662 <tr>
2663 <td width="319" valign="top">
2664 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.find("Lua is great!", "%s")</span></span></p>
2665 </td>
2666
2667 <td width="189" valign="top">
2668 <p class="MsoNormal"><span lang="EN-US">4</span></p>
2669 </td>
2670
2671 <td width="142" valign="top">
2672 <p class="MsoNormal"><span lang="EN-US">4</span></p>
2673 </td>
2674 </tr>
2675
2676 <tr>
2677 <td width="319" valign="top">
2678 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.gsub("Lua is great!", "%s", "-")</span></span></p>
2679 </td>
2680
2681 <td width="189" valign="top">
2682 <p class="MsoNormal"><span lang="EN-US">Lua-is-great!</span></p>
2683 </td>
2684
2685 <td width="142" valign="top">
2686 <p class="MsoNormal"><span lang="EN-US">2</span></p>
2687 </td>
2688 </tr>
2689
2690 <tr>
2691 <td width="319" valign="top">
2692 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.gsub("Lua is great!", "[%s%l]", "*")</span></span></p>
2693 </td>
2694
2695 <td width="189" valign="top">
2696 <p class="MsoNormal"><span lang="EN-US">L***********!</span></p>
2697 </td>
2698
2699 <td width="142" valign="top">
2700 <p class="MsoNormal"><span lang="EN-US">11</span></p>
2701 </td>
2702 </tr>
2703
2704 <tr>
2705 <td width="319" valign="top">
2706 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.gsub("Lua is great!", "%a+", "*")</span></span></p>
2707 </td>
2708
2709 <td width="189" valign="top">
2710 <p class="MsoNormal"><span lang="EN-US">* * *!</span></p>
2711 </td>
2712
2713 <td width="142" valign="top">
2714 <p class="MsoNormal"><span lang="EN-US">3</span></p>
2715 </td>
2716 </tr>
2717
2718 <tr>
2719 <td width="319" valign="top">
2720 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.gsub("Lua is great!", "(.)", "%1%1")</span></span></p>
2721 </td>
2722
2723 <td width="189" valign="top">
2724 <p class="MsoNormal"><span lang="EN-US">LLuuaa&nbsp; iiss&nbsp; ggrreeaatt!!</span></p>
2725 </td>
2726
2727 <td width="142" valign="top">
2728 <p class="MsoNormal"><span lang="EN-US">13</span></p>
2729 </td>
2730 </tr>
2731
2732 <tr>
2733 <td width="319" valign="top">
2734 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.gsub("Lua is great!", "%but", "")</span></span></p>
2735 </td>
2736
2737 <td width="189" valign="top">
2738 <p class="MsoNormal"><span lang="EN-US">L!</span></p>
2739 </td>
2740
2741 <td width="142" valign="top">
2742 <p class="MsoNormal"><span lang="EN-US">1</span></p>
2743 </td>
2744 </tr>
2745
2746 <tr>
2747 <td width="319" valign="top">
2748 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.gsub("Lua is great!", "^.-a", "LUA")</span></span></p>
2749 </td>
2750
2751 <td width="189" valign="top">
2752 <p class="MsoNormal"><span lang="EN-US">LUA is great!</span></p>
2753 </td>
2754
2755 <td width="142" valign="top">
2756 <p class="MsoNormal"><span lang="EN-US">1</span></p>
2757 </td>
2758 </tr>
2759
2760 <tr>
2761 <td width="319" valign="top">
2762 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">string.gsub("Lua is great!", "^.-a",</span></span></p>
2763
2764 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">&nbsp;&nbsp; function(s) return string.upper(s) end)</span></span></p>
2765 </td>
2766
2767 <td width="189" valign="top">
2768 <p class="MsoNormal"><span lang="EN-US">LUA is great!</span></p>
2769 </td>
2770
2771 <td width="142" valign="top">
2772 <p class="MsoNormal"><span lang="EN-US">1</span></p>
2773 </td>
2774 </tr>
2775 </table>
2776
2777 <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>
2778
2779 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Complete I/O</span></p>
2780
2781 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
2782 <tr>
2783 <td width="165" valign="top">
2784 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">io.open</span></span> <span lang="EN-US">(fn [, m])</span></p>
2785 </td>
2786
2787 <td width="484" valign="top">
2788 <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+" =
2789 update-append (add trailing "b" for binary mode on some systems); returns a file object (a userdata with a C handle).</span></p>
2790 </td>
2791 </tr>
2792
2793 <tr>
2794 <td width="165" valign="top">
2795 <p class="MsoNormal"><span lang="EN-US">file <span class="LuaCbold">:close</span> ()</span></p>
2796 </td>
2797
2798 <td width="484" valign="top">
2799 <p class="MsoNormal"><span lang="EN-US">closes <span class="LuaCbold">file</span></span></p>
2800 </td>
2801 </tr>
2802
2803 <tr>
2804 <td width="165" valign="top">
2805 <p class="MsoNormal"><span lang="EN-US">file <span class="LuaCbold">:read</span> ( <span class="LuaCitalic">formats</span> )</span></p>
2806 </td>
2807
2808 <td width="484" valign="top">
2809 <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
2810 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 (
2811 <span class="LuaCbold">nil</span> at end of file)</span></p>
2812 </td>
2813 </tr>
2814
2815 <tr>
2816 <td width="165" valign="top">
2817 <p class="MsoNormal"><span lang="EN-US">file <span class="LuaCbold">:lines</span> ()</span></p>
2818 </td>
2819
2820 <td width="484" valign="top">
2821 <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>
2822 </td>
2823 </tr>
2824
2825 <tr>
2826 <td width="165" valign="top">
2827 <p class="MsoNormal"><span lang="EN-US">file <span class="LuaCbold">:write</span> ( <span class="LuaCitalic">values</span> )</span></p>
2828 </td>
2829
2830 <td width="484" valign="top">
2831 <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
2832 (in this case, <span class="LuaCbold">file</span> may need to be opened in binary mode on some systems).</span></p>
2833 </td>
2834 </tr>
2835
2836 <tr>
2837 <td width="165" valign="top">
2838 <p class="MsoNormal"><span lang="EN-US">file <span class="LuaCbold">:seek</span> ([p] [, of])</span></p>
2839 </td>
2840
2841 <td width="484" valign="top">
2842 <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=
2843 "LuaCbold">of</span> [default: zero]; returns new current position in <span class="LuaCbold">file</span> .</span></p>
2844 </td>
2845 </tr>
2846
2847 <tr>
2848 <td width="165" valign="top">
2849 <p class="MsoNormal"><span lang="EN-US">file <span class="LuaCbold">:flush</span> ()</span></p>
2850 </td>
2851
2852 <td width="484" valign="top">
2853 <p class="MsoNormal"><span lang="EN-US">flushes any data still held in buffers to <span class="LuaCbold">file</span></span></p>
2854 </td>
2855 </tr>
2856 </table>
2857
2858 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Simple I/O</span></p>
2859
2860 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
2861 <tr>
2862 <td width="165" valign="top">
2863 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">io.input</span></span> <span lang="EN-US">([file])</span></p>
2864 </td>
2865
2866 <td width="484" valign="top">
2867 <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
2868 mode. Returns a file object, the current one if no <span class="LuaCbold">file</span> given; raises error on failure.</span></p>
2869 </td>
2870 </tr>
2871
2872 <tr>
2873 <td width="165" valign="top">
2874 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">io.output</span></span> <span lang="EN-US">([file])</span></p>
2875 </td>
2876
2877 <td width="484" valign="top">
2878 <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
2879 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>
2880 </td>
2881 </tr>
2882
2883 <tr>
2884 <td width="165" valign="top">
2885 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">io.close</span></span> <span lang="EN-US">([file])</span></p>
2886 </td>
2887
2888 <td width="484" valign="top">
2889 <p class="MsoNormal"><span lang="EN-US">closes <span class="LuaCbold">file</span> (a file object) [default: closes the default output file]</span></p>
2890 </td>
2891 </tr>
2892
2893 <tr>
2894 <td width="165" valign="top">
2895 <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>
2896 </td>
2897
2898 <td width="484" valign="top">
2899 <p class="MsoNormal"><span lang="EN-US">reads from the default input file, usage as <span class="LuaCbold">file:read()</span></span></p>
2900 </td>
2901 </tr>
2902
2903 <tr>
2904 <td width="165" valign="top">
2905 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">io.lines</span></span> <span lang="EN-US">([fn])</span></p>
2906 </td>
2907
2908 <td width="484" valign="top">
2909 <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>
2910 is given, returns an iterator reading lines from the default input file.</span></p>
2911 </td>
2912 </tr>
2913
2914 <tr>
2915 <td width="165" valign="top">
2916 <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>
2917 </td>
2918
2919 <td width="484" valign="top">
2920 <p class="MsoNormal"><span lang="EN-US">writes to the default output file, usage as <span class="LuaCbold">file:write()</span></span></p>
2921 </td>
2922 </tr>
2923
2924 <tr>
2925 <td width="165" valign="top">
2926 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">io.flush</span></span> <span lang="EN-US">()</span></p>
2927 </td>
2928
2929 <td width="484" valign="top">
2930 <p class="MsoNormal"><span lang="EN-US">flushes any data still held in buffers to the default output file</span></p>
2931 </td>
2932 </tr>
2933 </table>
2934
2935 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Standard files and utility
2936 functions</span></p>
2937
2938 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
2939 <tr>
2940 <td width="165" valign="top">
2941 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">io.stdin, io.stdout, io.stderr</span></span></p>
2942 </td>
2943
2944 <td width="484" valign="top">
2945 <p class="MsoNormal"><span lang="EN-US">predefined file objects for stdin, stdout and stderr streams</span></p>
2946 </td>
2947 </tr>
2948
2949 <tr>
2950 <td width="165" valign="top">
2951 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">io.popen</span></span> <span lang="EN-US">([prog [, mode]])</span></p>
2952 </td>
2953
2954 <td width="484" valign="top">
2955 <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
2956 to (if <span class="LuaCbold">mode</span> is "w")</span></p>
2957 </td>
2958 </tr>
2959
2960 <tr>
2961 <td width="165" valign="top">
2962 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">io.type</span></span> <span lang="EN-US">(x)</span></p>
2963 </td>
2964
2965 <td width="484" valign="top">
2966 <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=
2967 "LuaCbold">x</span> is not a file object</span></p>
2968 </td>
2969 </tr>
2970
2971 <tr>
2972 <td width="165" valign="top">
2973 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">io.tmpfile</span></span> <span lang="EN-US">()</span></p>
2974 </td>
2975
2976 <td width="484" valign="top">
2977 <p class="MsoNormal"><span lang="EN-US">returns a file object for a temporary file (deleted when program ends)</span></p>
2978 </td>
2979 </tr>
2980 </table>
2981
2982 <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>
2983
2984 <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>
2985
2986 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">System interaction</span></p>
2987
2988 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
2989 <tr>
2990 <td width="165" valign="top">
2991 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">os.execute</span></span> <span lang="EN-US">(cmd)</span></p>
2992 </td>
2993
2994 <td width="484" valign="top">
2995 <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>
2996 </td>
2997 </tr>
2998
2999 <tr>
3000 <td width="165" valign="top">
3001 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">os.exit</span></span> <span lang="EN-US">([code])</span></p>
3002 </td>
3003
3004 <td width="484" valign="top">
3005 <p class="MsoNormal"><span lang="EN-US">terminates the program returning <span class="LuaCbold">code</span> [default: success]</span></p>
3006 </td>
3007 </tr>
3008
3009 <tr>
3010 <td width="165" valign="top">
3011 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">os.getenv</span></span> <span lang="EN-US">(var)</span></p>
3012 </td>
3013
3014 <td width="484" valign="top">
3015 <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>
3016 </td>
3017 </tr>
3018
3019 <tr>
3020 <td width="165" valign="top">
3021 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">os.setlocale</span></span> <span lang="EN-US">(s [, c])</span></p>
3022 </td>
3023
3024 <td width="484" valign="top">
3025 <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
3026 name of the locale or <span class="LuaCbold">nil</span> if it can't be set.</span></p>
3027 </td>
3028 </tr>
3029
3030 <tr>
3031 <td width="165" valign="top">
3032 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">os.remove</span></span> <span lang="EN-US">(fn)</span></p>
3033 </td>
3034
3035 <td width="484" valign="top">
3036 <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>
3037 </td>
3038 </tr>
3039
3040 <tr>
3041 <td width="165" valign="top">
3042 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">os.rename</span></span> <span lang="EN-US">(of, nf)</span></p>
3043 </td>
3044
3045 <td width="484" valign="top">
3046 <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>
3047 </td>
3048 </tr>
3049
3050 <tr>
3051 <td width="165" valign="top">
3052 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">os.tmpname</span></span> <span lang="EN-US">()</span></p>
3053 </td>
3054
3055 <td width="484" valign="top">
3056 <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>
3057 </td>
3058 </tr>
3059 </table>
3060
3061 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Date/time</span></p>
3062
3063 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
3064 <tr>
3065 <td width="165" valign="top">
3066 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">os.clock</span></span> <span lang="EN-US">()</span></p>
3067 </td>
3068
3069 <td width="484" valign="top">
3070 <p class="MsoNormal"><span lang="EN-US">returns an approximation of the amount in seconds of CPU time used by the program</span></p>
3071 </td>
3072 </tr>
3073
3074 <tr>
3075 <td width="165" valign="top">
3076 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">os.time</span></span> <span lang="EN-US">([tt])</span></p>
3077 </td>
3078
3079 <td width="484" valign="top">
3080 <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=
3081 "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=
3082 "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>
3083 </td>
3084 </tr>
3085
3086 <tr>
3087 <td width="165" valign="top">
3088 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">os.date</span></span> <span lang="EN-US">([fmt [, t]])</span></p>
3089 </td>
3090
3091 <td width="484" valign="top">
3092 <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
3093 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=
3094 "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,
3095 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=
3096 "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>
3097 </td>
3098 </tr>
3099
3100 <tr>
3101 <td width="165" valign="top">
3102 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">os.difftime</span></span> <span lang="EN-US">(t2, t1)</span></p>
3103 </td>
3104
3105 <td width="484" valign="top">
3106 <p class="MsoNormal"><span lang="EN-US">returns the difference between two values returned by <span class="LuaCbold">os.time()</span></span></p>
3107 </td>
3108 </tr>
3109 </table>
3110
3111 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Time formatting directives (most
3112 used, portable features):</span></p>
3113
3114 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
3115 <tr>
3116 <td width="71" valign="top">
3117 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%c</span></span></p>
3118 </td>
3119
3120 <td width="260" valign="top">
3121 <p class="MsoNormal"><span lang="EN-US">date/time (locale)</span></p>
3122 </td>
3123
3124 <td width="71" valign="top">
3125 <p class="MsoNormal"><span lang="EN-US">&nbsp;</span></p>
3126 </td>
3127
3128 <td width="248" valign="top">
3129 <p class="MsoNormal"><span lang="EN-US">&nbsp;</span></p>
3130 </td>
3131 </tr>
3132
3133 <tr>
3134 <td width="71" valign="top">
3135 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%x</span></span></p>
3136 </td>
3137
3138 <td width="260" valign="top">
3139 <p class="MsoNormal"><span lang="EN-US">date only (locale)</span></p>
3140 </td>
3141
3142 <td width="71" valign="top">
3143 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%X</span></span></p>
3144 </td>
3145
3146 <td width="248" valign="top">
3147 <p class="MsoNormal"><span lang="EN-US">time only (locale)</span></p>
3148 </td>
3149 </tr>
3150
3151 <tr>
3152 <td width="71" valign="top">
3153 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%y</span></span></p>
3154 </td>
3155
3156 <td width="260" valign="top">
3157 <p class="MsoNormal"><span lang="EN-US">year (nn)</span></p>
3158 </td>
3159
3160 <td width="71" valign="top">
3161 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%Y</span></span></p>
3162 </td>
3163
3164 <td width="248" valign="top">
3165 <p class="MsoNormal"><span lang="EN-US">year (yyyy)</span></p>
3166 </td>
3167 </tr>
3168
3169 <tr>
3170 <td width="71" valign="top">
3171 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%j</span></span></p>
3172 </td>
3173
3174 <td width="260" valign="top">
3175 <p class="MsoNormal"><span lang="EN-US">day of year (001..366)</span></p>
3176 </td>
3177
3178 <td width="71" valign="top">
3179 <p class="MsoNormal"><span lang="EN-US">&nbsp;</span></p>
3180 </td>
3181
3182 <td width="248" valign="top">
3183 <p class="MsoNormal"><span lang="EN-US">&nbsp;</span></p>
3184 </td>
3185 </tr>
3186
3187 <tr>
3188 <td width="71" valign="top">
3189 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%m</span></span></p>
3190 </td>
3191
3192 <td width="260" valign="top">
3193 <p class="MsoNormal"><span lang="EN-US">month (01..12)</span></p>
3194 </td>
3195
3196 <td width="71" valign="top">
3197 <p class="MsoNormal"><span lang="EN-US">&nbsp;</span></p>
3198 </td>
3199
3200 <td width="248" valign="top">
3201 <p class="MsoNormal"><span lang="EN-US">&nbsp;</span></p>
3202 </td>
3203 </tr>
3204
3205 <tr>
3206 <td width="71" valign="top">
3207 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%b</span></span></p>
3208 </td>
3209
3210 <td width="260" valign="top">
3211 <p class="MsoNormal"><span lang="EN-US">abbreviated month name (locale)</span></p>
3212 </td>
3213
3214 <td width="71" valign="top">
3215 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%B</span></span></p>
3216 </td>
3217
3218 <td width="248" valign="top">
3219 <p class="MsoNormal"><span lang="EN-US">full name of month (locale)</span></p>
3220 </td>
3221 </tr>
3222
3223 <tr>
3224 <td width="71" valign="top">
3225 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%d</span></span></p>
3226 </td>
3227
3228 <td width="260" valign="top">
3229 <p class="MsoNormal"><span lang="EN-US">day of month (01..31)</span></p>
3230 </td>
3231
3232 <td width="71" valign="top">
3233 <p class="MsoNormal"><span lang="EN-US">&nbsp;</span></p>
3234 </td>
3235
3236 <td width="248" valign="top">
3237 <p class="MsoNormal"><span lang="EN-US">&nbsp;</span></p>
3238 </td>
3239 </tr>
3240
3241 <tr>
3242 <td width="71" valign="top">
3243 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%U</span></span></p>
3244 </td>
3245
3246 <td width="260" valign="top">
3247 <p class="MsoNormal"><span lang="EN-US">week number (01..53), Sunday-based</span></p>
3248 </td>
3249
3250 <td width="71" valign="top">
3251 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%W</span></span></p>
3252 </td>
3253
3254 <td width="248" valign="top">
3255 <p class="MsoNormal"><span lang="EN-US">week number (01..53), Monday-based</span></p>
3256 </td>
3257 </tr>
3258
3259 <tr>
3260 <td width="71" valign="top">
3261 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%w</span></span></p>
3262 </td>
3263
3264 <td width="260" valign="top">
3265 <p class="MsoNormal"><span lang="EN-US">weekday (0..6), 0 is Sunday</span></p>
3266 </td>
3267
3268 <td width="71" valign="top">
3269 <p class="MsoNormal"><span lang="EN-US">&nbsp;</span></p>
3270 </td>
3271
3272 <td width="248" valign="top">
3273 <p class="MsoNormal"><span lang="EN-US">&nbsp;</span></p>
3274 </td>
3275 </tr>
3276
3277 <tr>
3278 <td width="71" valign="top">
3279 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%a</span></span></p>
3280 </td>
3281
3282 <td width="260" valign="top">
3283 <p class="MsoNormal"><span lang="EN-US">abbreviated weekday name (locale)</span></p>
3284 </td>
3285
3286 <td width="71" valign="top">
3287 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%A</span></span></p>
3288 </td>
3289
3290 <td width="248" valign="top">
3291 <p class="MsoNormal"><span lang="EN-US">full weekday name (locale)</span></p>
3292 </td>
3293 </tr>
3294
3295 <tr>
3296 <td width="71" valign="top">
3297 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%H</span></span></p>
3298 </td>
3299
3300 <td width="260" valign="top">
3301 <p class="MsoNormal"><span lang="EN-US">hour (00..23)</span></p>
3302 </td>
3303
3304 <td width="71" valign="top">
3305 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%I</span></span></p>
3306 </td>
3307
3308 <td width="248" valign="top">
3309 <p class="MsoNormal"><span lang="EN-US">hour (01..12)</span></p>
3310 </td>
3311 </tr>
3312
3313 <tr>
3314 <td width="71" valign="top">
3315 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%p</span></span></p>
3316 </td>
3317
3318 <td width="260" valign="top">
3319 <p class="MsoNormal"><span lang="EN-US">either AM or PM</span></p>
3320 </td>
3321
3322 <td width="71" valign="top">
3323 <p class="MsoNormal"><span lang="EN-US">&nbsp;</span></p>
3324 </td>
3325
3326 <td width="248" valign="top">
3327 <p class="MsoNormal"><span lang="EN-US">&nbsp;</span></p>
3328 </td>
3329 </tr>
3330
3331 <tr>
3332 <td width="71" valign="top">
3333 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%M</span></span></p>
3334 </td>
3335
3336 <td width="260" valign="top">
3337 <p class="MsoNormal"><span lang="EN-US">minute (00..59)</span></p>
3338 </td>
3339
3340 <td width="71" valign="top">
3341 <p class="MsoNormal"><span lang="EN-US">&nbsp;</span></p>
3342 </td>
3343
3344 <td width="248" valign="top">
3345 <p class="MsoNormal"><span lang="EN-US">&nbsp;</span></p>
3346 </td>
3347 </tr>
3348
3349 <tr>
3350 <td width="71" valign="top">
3351 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%S</span></span></p>
3352 </td>
3353
3354 <td width="260" valign="top">
3355 <p class="MsoNormal"><span lang="EN-US">second (00..61)</span></p>
3356 </td>
3357
3358 <td width="71" valign="top">
3359 <p class="MsoNormal"><span lang="EN-US">&nbsp;</span></p>
3360 </td>
3361
3362 <td width="248" valign="top">
3363 <p class="MsoNormal"><span lang="EN-US">&nbsp;</span></p>
3364 </td>
3365 </tr>
3366
3367 <tr>
3368 <td width="71" valign="top">
3369 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">%Z</span></span></p>
3370 </td>
3371
3372 <td width="260" valign="top">
3373 <p class="MsoNormal"><span lang="EN-US">time zone name, if any</span></p>
3374 </td>
3375
3376 <td width="71" valign="top">
3377 <p class="MsoNormal"><span lang="EN-US">&nbsp;</span></p>
3378 </td>
3379
3380 <td width="248" valign="top">
3381 <p class="MsoNormal"><span lang="EN-US">&nbsp;</span></p>
3382 </td>
3383 </tr>
3384 </table>
3385
3386 <p class="LuaPHeader1"><a name="The_debug_library" id="The_debug_library"><span lang="EN-US">The debug library [debug]</span></a></p>
3387
3388 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Basic functions</span></p>
3389
3390 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
3391 <tr>
3392 <td width="165" valign="top">
3393 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">debug.debug</span></span> <span lang="EN-US">()</span></p>
3394 </td>
3395
3396 <td width="484" valign="top">
3397 <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>
3398 </td>
3399 </tr>
3400
3401 <tr>
3402 <td width="165" valign="top">
3403 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">debug.getinfo</span></span> <span lang="EN-US">(f [, w])</span></p>
3404 </td>
3405
3406 <td width="484" valign="top">
3407 <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
3408 <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>
3409 </td>
3410 </tr>
3411
3412 <tr>
3413 <td width="165" valign="top">
3414 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">debug.getlocal</span></span> <span lang="EN-US">(n, i)</span></p>
3415 </td>
3416
3417 <td width="484" valign="top">
3418 <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
3419 <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>
3420 </td>
3421 </tr>
3422
3423 <tr>
3424 <td width="165" valign="top">
3425 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">debug.getupvalue</span></span> <span lang="EN-US">(f, i)</span></p>
3426 </td>
3427
3428 <td width="484" valign="top">
3429 <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
3430 <span class="LuaCbold">i</span> is out of range.</span></p>
3431 </td>
3432 </tr>
3433
3434 <tr>
3435 <td width="165" valign="top">
3436 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">debug.traceback</span></span> <span lang="EN-US">([msg])</span></p>
3437 </td>
3438
3439 <td width="484" valign="top">
3440 <p class="MsoNormal"><span lang="EN-US">returns a string with traceback of call stack, prepended by <span class="LuaCbold">msg</span></span></p>
3441 </td>
3442 </tr>
3443
3444 <tr>
3445 <td width="165" valign="top">
3446 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">debug.setlocal</span></span> <span lang="EN-US">(n,&nbsp; i, v)</span></p>
3447 </td>
3448
3449 <td width="484" valign="top">
3450 <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>
3451 (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>
3452 </td>
3453 </tr>
3454
3455 <tr>
3456 <td width="165" valign="top">
3457 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">debug.setupvalue</span></span> <span lang="EN-US">(f, i, v)</span></p>
3458 </td>
3459
3460 <td width="484" valign="top">
3461 <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=
3462 "LuaCbold">nil</span> if <span class="LuaCbold">i</span> is out of range.</span></p>
3463 </td>
3464 </tr>
3465
3466 <tr>
3467 <td width="165" valign="top">
3468 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">debug.sethook</span></span> <span lang="EN-US">([h, m [, n]])</span></p>
3469 </td>
3470
3471 <td width="484" valign="top">
3472 <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
3473 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
3474 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>
3475 </td>
3476 </tr>
3477
3478 <tr>
3479 <td width="165" valign="top">
3480 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">debug.gethook</span></span> <span lang="EN-US">()</span></p>
3481 </td>
3482
3483 <td width="484" valign="top">
3484 <p class="MsoNormal"><span lang="EN-US">returns current hook function, mask and count set with <span class="LuaCbold">debug.sethook()</span></span></p>
3485 </td>
3486 </tr>
3487 </table>
3488
3489 <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>
3490
3491 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Result fields for
3492 debug.getinfo</span></p>
3493
3494 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
3495 <tr>
3496 <td width="165" valign="top">
3497 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">source</span></span></p>
3498 </td>
3499
3500 <td width="484" valign="top">
3501 <p class="MsoNormal"><span lang="EN-US">name of file (prefixed by '@') or string where the function was defined</span></p>
3502 </td>
3503 </tr>
3504
3505 <tr>
3506 <td width="165" valign="top">
3507 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">short_src</span></span></p>
3508 </td>
3509
3510 <td width="484" valign="top">
3511 <p class="MsoNormal"><span lang="EN-US">short version of <span class="LuaCbold">source</span> , up to 60 characters</span></p>
3512 </td>
3513 </tr>
3514
3515 <tr>
3516 <td width="165" valign="top">
3517 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">linedefined</span></span></p>
3518 </td>
3519
3520 <td width="484" valign="top">
3521 <p class="MsoNormal"><span lang="EN-US">line of source where the function was defined</span></p>
3522 </td>
3523 </tr>
3524
3525 <tr>
3526 <td width="165" valign="top">
3527 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">what</span></span></p>
3528 </td>
3529
3530 <td width="484" valign="top">
3531 <p class="MsoNormal"><span lang="EN-US">"Lua" = Lua function, "C" = C function, "main" = part of main chunk</span></p>
3532 </td>
3533 </tr>
3534
3535 <tr>
3536 <td width="165" valign="top">
3537 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">name</span></span></p>
3538 </td>
3539
3540 <td width="484" valign="top">
3541 <p class="MsoNormal"><span lang="EN-US">name of function, if available, or a reasonable guess if possible</span></p>
3542 </td>
3543 </tr>
3544
3545 <tr>
3546 <td width="165" valign="top">
3547 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">namewhat</span></span></p>
3548 </td>
3549
3550 <td width="484" valign="top">
3551 <p class="MsoNormal"><span lang="EN-US">meaning of <span class="LuaCbold">name</span> : "global", "local", "method", "field" or ""</span></p>
3552 </td>
3553 </tr>
3554
3555 <tr>
3556 <td width="165" valign="top">
3557 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">nups</span></span></p>
3558 </td>
3559
3560 <td width="484" valign="top">
3561 <p class="MsoNormal"><span lang="EN-US">number of upvalues of the function</span></p>
3562 </td>
3563 </tr>
3564
3565 <tr>
3566 <td width="165" valign="top">
3567 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">func</span></span></p>
3568 </td>
3569
3570 <td width="484" valign="top">
3571 <p class="MsoNormal"><span lang="EN-US">the function itself</span></p>
3572 </td>
3573 </tr>
3574 </table>
3575
3576 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Options for debug.getinfo
3577 (character codes for argument w)</span></p>
3578
3579 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
3580 <tr>
3581 <td width="36" valign="top">
3582 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">n</span></span></p>
3583 </td>
3584
3585 <td width="295" valign="top">
3586 <p class="MsoNormal"><span lang="EN-US">returns fields <span class="LuaCbold">name</span> and <span class="LuaCbold">namewhat</span></span></p>
3587 </td>
3588
3589 <td width="36" valign="top">
3590 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">l</span></span></p>
3591 </td>
3592
3593 <td width="284" valign="top">
3594 <p class="MsoNormal"><span lang="EN-US">returns field <span class="LuaCbold">currentline</span></span></p>
3595 </td>
3596 </tr>
3597
3598 <tr>
3599 <td width="36" valign="top">
3600 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">f</span></span></p>
3601 </td>
3602
3603 <td width="295" valign="top">
3604 <p class="MsoNormal"><span lang="EN-US">returns field <span class="LuaCbold">func</span></span></p>
3605 </td>
3606
3607 <td width="36" valign="top">
3608 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">u</span></span></p>
3609 </td>
3610
3611 <td width="284" valign="top">
3612 <p class="MsoNormal"><span lang="EN-US">returns field <span class="LuaCbold">nup</span></span></p>
3613 </td>
3614 </tr>
3615
3616 <tr>
3617 <td width="36" valign="top">
3618 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">S</span></span></p>
3619 </td>
3620
3621 <td width="295" valign="top">
3622 <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>
3623 </td>
3624
3625 <td width="36" valign="top">
3626 <p class="MsoNormal"><span lang="EN-US">&nbsp;</span></p>
3627 </td>
3628
3629 <td width="284" valign="top">
3630 <p class="MsoNormal"><span lang="EN-US">&nbsp;</span></p>
3631 </td>
3632 </tr>
3633 </table>
3634
3635 <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>
3636
3637 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Command line syntax</span></p>
3638
3639 <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>
3640
3641 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Options</span></p>
3642
3643 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
3644 <tr>
3645 <td width="95" valign="top">
3646 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-</span></span></p>
3647 </td>
3648
3649 <td width="555" valign="top">
3650 <p class="MsoNormal"><span lang="EN-US">loads and executes <span class="LuaCbold">script</span> from standard input (no args allowed)</span></p>
3651 </td>
3652 </tr>
3653
3654 <tr>
3655 <td width="95" valign="top">
3656 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-e</span></span></p>
3657 </td>
3658
3659 <td width="555" valign="top">
3660 <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>
3661 </td>
3662 </tr>
3663
3664 <tr>
3665 <td width="95" valign="top">
3666 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-l</span></span></p>
3667 </td>
3668
3669 <td width="555" valign="top">
3670 <p class="MsoNormal"><span lang="EN-US">requires <span class="LuaCitalic">filename</span> (loads and executes if not already done)</span></p>
3671 </td>
3672 </tr>
3673
3674 <tr>
3675 <td width="95" valign="top">
3676 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-i</span></span></p>
3677 </td>
3678
3679 <td width="555" valign="top">
3680 <p class="MsoNormal"><span lang="EN-US">enters interactive mode after loading and executing <span class="LuaCitalic">script</span></span></p>
3681 </td>
3682 </tr>
3683
3684 <tr>
3685 <td width="95" valign="top">
3686 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-v</span></span></p>
3687 </td>
3688
3689 <td width="555" valign="top">
3690 <p class="MsoNormal"><span lang="EN-US">prints version information</span></p>
3691 </td>
3692 </tr>
3693
3694 <tr>
3695 <td width="95" valign="top">
3696 <p class="MsoNormal"><span lang="EN-US">--</span></p>
3697 </td>
3698
3699 <td width="555" valign="top">
3700 <p class="MsoNormal"><span lang="EN-US">stops parsing options</span></p>
3701 </td>
3702 </tr>
3703 </table>
3704
3705 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Recognized environment
3706 variables</span></p>
3707
3708 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
3709 <tr>
3710 <td width="95" valign="top">
3711 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">LUA_INIT</span></span></p>
3712 </td>
3713
3714 <td width="555" valign="top">
3715 <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>
3716 </td>
3717 </tr>
3718
3719 <tr>
3720 <td width="95" valign="top">
3721 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">LUA_PATH</span></span></p>
3722 </td>
3723
3724 <td width="555" valign="top">
3725 <p class="MsoNormal"><span lang="EN-US">defines search path for Lua modules, with "?" replaced by the module name</span></p>
3726 </td>
3727 </tr>
3728
3729 <tr>
3730 <td width="95" valign="top">
3731 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">LUA_CPATH</span></span></p>
3732 </td>
3733
3734 <td width="555" valign="top">
3735 <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>
3736 </td>
3737 </tr>
3738
3739 <tr>
3740 <td width="95" valign="top">
3741 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">_PROMPT[2]</span></span></p>
3742 </td>
3743
3744 <td width="555" valign="top">
3745 <p class="MsoNormal"><span lang="EN-US">set the prompts for interactive mode</span></p>
3746 </td>
3747 </tr>
3748 </table>
3749
3750 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Special Lua variables</span></p>
3751
3752 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
3753 <tr>
3754 <td width="95" valign="top">
3755 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">arg</span></span></p>
3756 </td>
3757
3758 <td width="555" valign="top">
3759 <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=
3760 "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=
3761 "LuaCbold">arg[-1]</span> and lower indexes contain the fields of the command line preceding the script name.</span></p>
3762 </td>
3763 </tr>
3764
3765 <tr>
3766 <td width="95" valign="top">
3767 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">_PROMPT[2]</span></span></p>
3768 </td>
3769
3770 <td width="555" valign="top">
3771 <p class="MsoNormal"><span lang="EN-US">contain the prompt for interactive mode; can be changed by assigning a new value.</span></p>
3772 </td>
3773 </tr>
3774 </table>
3775
3776 <p class="LuaPHeader1"><a name="The_compiler" id="The_compiler"><span lang="EN-US">The compiler</span></a></p>
3777
3778 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Command line syntax</span></p>
3779
3780 <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>
3781
3782 <p class="LuaPHeader2"><span lang="EN-US" style="font-size: 9.0pt;font-family:Symbol;font-weight:normal;font-style:normal">&middot; <span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;</span></span> <span lang="EN-US">Options</span></p>
3783
3784 <table class="LuaTTables" border="1" cellspacing="0" cellpadding="0" summary="?">
3785 <tr>
3786 <td width="95" valign="top">
3787 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-</span></span></p>
3788 </td>
3789
3790 <td width="555" valign="top">
3791 <p class="MsoNormal"><span lang="EN-US">compiles from standard input</span></p>
3792 </td>
3793 </tr>
3794
3795 <tr>
3796 <td width="95" valign="top">
3797 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-l</span></span></p>
3798 </td>
3799
3800 <td width="555" valign="top">
3801 <p class="MsoNormal"><span lang="EN-US">produces a listing of the compiled bytecode</span></p>
3802 </td>
3803 </tr>
3804
3805 <tr>
3806 <td width="95" valign="top">
3807 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-o</span></span></p>
3808 </td>
3809
3810 <td width="555" valign="top">
3811 <p class="MsoNormal"><span lang="EN-US">sends output to <span class="LuaCbold">filename</span> [default: <span class="LuaCbold">luac.out</span> ]</span></p>
3812 </td>
3813 </tr>
3814
3815 <tr>
3816 <td width="95" valign="top">
3817 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-p</span></span></p>
3818 </td>
3819
3820 <td width="555" valign="top">
3821 <p class="MsoNormal"><span lang="EN-US">performs syntax and integrity checking only, does not output bytecode</span></p>
3822 </td>
3823 </tr>
3824
3825 <tr>
3826 <td width="95" valign="top">
3827 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-s</span></span></p>
3828 </td>
3829
3830 <td width="555" valign="top">
3831 <p class="MsoNormal"><span lang="EN-US">strips debug information; line numbers and local names are lost.</span></p>
3832 </td>
3833 </tr>
3834
3835 <tr>
3836 <td width="95" valign="top">
3837 <p class="MsoNormal"><span class="LuaCbold"><span lang="EN-US">-v</span></span></p>
3838 </td>
3839
3840 <td width="555" valign="top">
3841 <p class="MsoNormal"><span lang="EN-US">prints version information</span></p>
3842 </td>
3843 </tr>
3844
3845 <tr>
3846 <td width="95" valign="top">
3847 <p class="MsoNormal"><span lang="EN-US">--</span></p>
3848 </td>
3849
3850 <td width="555" valign="top">
3851 <p class="MsoNormal"><span lang="EN-US">stops parsing options</span></p>
3852 </td>
3853 </tr>
3854 </table>
3855
3856 <p class="MsoNormal"><span lang="EN-US">Note: compiled chunks are portable between machines having the same word size.</span></p>
3857
3858 <p class="MsoNormal"><span lang="EN-US">&nbsp;</span></p>
3859
3860 <p class="MsoNormal"><i><span lang="EN-US" style="font-size:6.0pt"><br>
3861 <br>
3862 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 &lt;[email protected]&gt; in 2004 and
3863 updated by Thomas Lauer &lt;[email protected]&gt; in 2007. Comments, praise or blame please to the lua-l mailing list.</span></i></p>
3864 </body>
3865 </html>