xref: /freebsd/contrib/lua/doc/contents.html (revision a90b9d0159070121c221b966469c3e36d912bf82) 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<HTML>
3<HEAD>
4<TITLE>Lua 5.4 Reference Manual - contents</TITLE>
5<LINK REL="stylesheet" TYPE="text/css" HREF="lua.css">
6<LINK REL="stylesheet" TYPE="text/css" HREF="index.css">
7<META HTTP-EQUIV="content-type" CONTENT="text/html; charset=iso-8859-1">
8</HEAD>
9
10<BODY>
11
12<H1>
13<A HREF="http://www.lua.org/"><IMG SRC="logo.gif" ALT="Lua"></A>
14Lua 5.4 Reference Manual
15</H1>
16
17<P>
18The reference manual is the official definition of the Lua language.
19<BR>
20For a complete introduction to Lua programming, see the book
21<A HREF="http://www.lua.org/pil/">Programming in Lua</A>.
22
23<DIV CLASS="menubar">
24<A HREF="manual.html">start</A>
25&middot;
26<A HREF="#contents">contents</A>
27&middot;
28<A HREF="#index">index</A>
29&middot;
30<A HREF="http://www.lua.org/manual/">other versions</A>
31</DIV>
32
33<P>
34<SMALL>
35Copyright &copy; 2020&ndash;2023 Lua.org, PUC-Rio.
36Freely available under the terms of the
37<A HREF="http://www.lua.org/license.html">Lua license</A>.
38</SMALL>
39
40<H2><A NAME="contents">Contents</A></H2>
41<UL CLASS="contents menubar">
42<LI><A HREF="manual.html">1 &ndash; Introduction</A>
43<P>
44<LI><A HREF="manual.html#2">2 &ndash; Basic Concepts</A>
45<UL>
46<LI><A HREF="manual.html#2.1">2.1 &ndash; Values and Types</A>
47<LI><A HREF="manual.html#2.2">2.2 &ndash; Environments and the Global Environment</A>
48<LI><A HREF="manual.html#2.3">2.3 &ndash; Error Handling</A>
49<LI><A HREF="manual.html#2.4">2.4 &ndash; Metatables and Metamethods</A>
50<LI><A HREF="manual.html#2.5">2.5 &ndash; Garbage Collection</A>
51<UL>
52<LI><A HREF="manual.html#2.5.1">2.5.1 &ndash; Incremental Garbage Collection</A>
53<LI><A HREF="manual.html#2.5.2">2.5.2 &ndash; Generational Garbage Collection</A>
54<LI><A HREF="manual.html#2.5.3">2.5.3 &ndash; Garbage-Collection Metamethods</A>
55<LI><A HREF="manual.html#2.5.4">2.5.4 &ndash; Weak Tables</A>
56</UL>
57<LI><A HREF="manual.html#2.6">2.6 &ndash; Coroutines</A>
58</UL>
59<P>
60<LI><A HREF="manual.html#3">3 &ndash; The Language</A>
61<UL>
62<LI><A HREF="manual.html#3.1">3.1 &ndash; Lexical Conventions</A>
63<LI><A HREF="manual.html#3.2">3.2 &ndash; Variables</A>
64<LI><A HREF="manual.html#3.3">3.3 &ndash; Statements</A>
65<UL>
66<LI><A HREF="manual.html#3.3.1">3.3.1 &ndash; Blocks</A>
67<LI><A HREF="manual.html#3.3.2">3.3.2 &ndash; Chunks</A>
68<LI><A HREF="manual.html#3.3.3">3.3.3 &ndash; Assignment</A>
69<LI><A HREF="manual.html#3.3.4">3.3.4 &ndash; Control Structures</A>
70<LI><A HREF="manual.html#3.3.5">3.3.5 &ndash; For Statement</A>
71<LI><A HREF="manual.html#3.3.6">3.3.6 &ndash; Function Calls as Statements</A>
72<LI><A HREF="manual.html#3.3.7">3.3.7 &ndash; Local Declarations</A>
73<LI><A HREF="manual.html#3.3.8">3.3.8 &ndash; To-be-closed Variables</A>
74</UL>
75<LI><A HREF="manual.html#3.4">3.4 &ndash; Expressions</A>
76<UL>
77<LI><A HREF="manual.html#3.4.1">3.4.1 &ndash; Arithmetic Operators</A>
78<LI><A HREF="manual.html#3.4.2">3.4.2 &ndash; Bitwise Operators</A>
79<LI><A HREF="manual.html#3.4.3">3.4.3 &ndash; Coercions and Conversions</A>
80<LI><A HREF="manual.html#3.4.4">3.4.4 &ndash; Relational Operators</A>
81<LI><A HREF="manual.html#3.4.5">3.4.5 &ndash; Logical Operators</A>
82<LI><A HREF="manual.html#3.4.6">3.4.6 &ndash; Concatenation</A>
83<LI><A HREF="manual.html#3.4.7">3.4.7 &ndash; The Length Operator</A>
84<LI><A HREF="manual.html#3.4.8">3.4.8 &ndash; Precedence</A>
85<LI><A HREF="manual.html#3.4.9">3.4.9 &ndash; Table Constructors</A>
86<LI><A HREF="manual.html#3.4.10">3.4.10 &ndash; Function Calls</A>
87<LI><A HREF="manual.html#3.4.11">3.4.11 &ndash; Function Definitions</A>
88<LI><A HREF="manual.html#3.4.12">3.4.12 &ndash; Lists of expressions, multiple results, and adjustment<A>
89
90</UL>
91<LI><A HREF="manual.html#3.5">3.5 &ndash; Visibility Rules</A>
92</UL>
93<P>
94<LI><A HREF="manual.html#4">4 &ndash; The Application Program Interface</A>
95<UL>
96<LI><A HREF="manual.html#4.1">4.1 &ndash; The Stack</A>
97<UL>
98<LI><A HREF="manual.html#4.1.1">4.1.1 &ndash; Stack Size</A>
99<LI><A HREF="manual.html#4.1.2">4.1.2 &ndash; Valid and Acceptable Indices</A>
100<LI><A HREF="manual.html#4.1.3">4.1.3 &ndash; Pointers to strings</A>
101</UL>
102<LI><A HREF="manual.html#4.2">4.2 &ndash; C Closures</A>
103<LI><A HREF="manual.html#4.3">4.3 &ndash; Registry</A>
104<LI><A HREF="manual.html#4.4">4.4 &ndash; Error Handling in C</A>
105<UL>
106<LI><A HREF="manual.html#4.4.1">4.4.1 &ndash; Status Codes</A>
107</UL>
108<LI><A HREF="manual.html#4.5">4.5 &ndash; Handling Yields in C</A>
109<LI><A HREF="manual.html#4.6">4.6 &ndash; Functions and Types</A>
110<LI><A HREF="manual.html#4.7">4.7 &ndash; The Debug Interface</A>
111</UL>
112<P>
113<LI><A HREF="manual.html#5">5 &ndash; The Auxiliary Library</A>
114<UL>
115<LI><A HREF="manual.html#5.1">5.1 &ndash; Functions and Types</A>
116</UL>
117<P>
118<LI><A HREF="manual.html#6">6 &ndash; The Standard Libraries</A>
119<UL>
120<LI><A HREF="manual.html#6.1">6.1 &ndash; Basic Functions</A>
121<LI><A HREF="manual.html#6.2">6.2 &ndash; Coroutine Manipulation</A>
122<LI><A HREF="manual.html#6.3">6.3 &ndash; Modules</A>
123<LI><A HREF="manual.html#6.4">6.4 &ndash; String Manipulation</A>
124<UL>
125<LI><A HREF="manual.html#6.4.1">6.4.1 &ndash; Patterns</A>
126<LI><A HREF="manual.html#6.4.2">6.4.2 &ndash; Format Strings for Pack and Unpack</A>
127</UL>
128<LI><A HREF="manual.html#6.5">6.5 &ndash; UTF-8 Support</A>
129<LI><A HREF="manual.html#6.6">6.6 &ndash; Table Manipulation</A>
130<LI><A HREF="manual.html#6.7">6.7 &ndash; Mathematical Functions</A>
131<LI><A HREF="manual.html#6.8">6.8 &ndash; Input and Output Facilities</A>
132<LI><A HREF="manual.html#6.9">6.9 &ndash; Operating System Facilities</A>
133<LI><A HREF="manual.html#6.10">6.10 &ndash; The Debug Library</A>
134</UL>
135<P>
136<LI><A HREF="manual.html#7">7 &ndash; Lua Standalone</A>
137<P>
138<LI><A HREF="manual.html#8">8 &ndash; Incompatibilities with the Previous Version</A>
139<UL>
140<LI><A HREF="manual.html#8.1">8.1 &ndash; Incompatibilities in the Language</A>
141<LI><A HREF="manual.html#8.2">8.2 &ndash; Incompatibilities in the Libraries</A>
142<LI><A HREF="manual.html#8.3">8.3 &ndash; Incompatibilities in the API</A>
143</UL>
144<P>
145<LI><A HREF="manual.html#9">9 &ndash; The Complete Syntax of Lua</A>
146</UL>
147
148<H2><A NAME="index">Index</A></H2>
149<TABLE CLASS="menubar" WIDTH="100%">
150<TR>
151<TD>
152<H3><A NAME="functions">Lua functions</A></H3>
153<P>
154<A HREF="manual.html#6.1">basic</A><BR>
155<A HREF="manual.html#pdf-_G">_G</A><BR>
156<A HREF="manual.html#pdf-_VERSION">_VERSION</A><BR>
157<A HREF="manual.html#pdf-assert">assert</A><BR>
158<A HREF="manual.html#pdf-collectgarbage">collectgarbage</A><BR>
159<A HREF="manual.html#pdf-dofile">dofile</A><BR>
160<A HREF="manual.html#pdf-error">error</A><BR>
161<A HREF="manual.html#pdf-getmetatable">getmetatable</A><BR>
162<A HREF="manual.html#pdf-ipairs">ipairs</A><BR>
163<A HREF="manual.html#pdf-load">load</A><BR>
164<A HREF="manual.html#pdf-loadfile">loadfile</A><BR>
165<A HREF="manual.html#pdf-next">next</A><BR>
166<A HREF="manual.html#pdf-pairs">pairs</A><BR>
167<A HREF="manual.html#pdf-pcall">pcall</A><BR>
168<A HREF="manual.html#pdf-print">print</A><BR>
169<A HREF="manual.html#pdf-rawequal">rawequal</A><BR>
170<A HREF="manual.html#pdf-rawget">rawget</A><BR>
171<A HREF="manual.html#pdf-rawlen">rawlen</A><BR>
172<A HREF="manual.html#pdf-rawset">rawset</A><BR>
173<A HREF="manual.html#pdf-require">require</A><BR>
174<A HREF="manual.html#pdf-select">select</A><BR>
175<A HREF="manual.html#pdf-setmetatable">setmetatable</A><BR>
176<A HREF="manual.html#pdf-tonumber">tonumber</A><BR>
177<A HREF="manual.html#pdf-tostring">tostring</A><BR>
178<A HREF="manual.html#pdf-type">type</A><BR>
179<A HREF="manual.html#pdf-warn">warn</A><BR>
180<A HREF="manual.html#pdf-xpcall">xpcall</A><BR>
181
182<P>
183<A HREF="manual.html#6.2">coroutine</A><BR>
184<A HREF="manual.html#pdf-coroutine.close">coroutine.close</A><BR>
185<A HREF="manual.html#pdf-coroutine.create">coroutine.create</A><BR>
186<A HREF="manual.html#pdf-coroutine.isyieldable">coroutine.isyieldable</A><BR>
187<A HREF="manual.html#pdf-coroutine.resume">coroutine.resume</A><BR>
188<A HREF="manual.html#pdf-coroutine.running">coroutine.running</A><BR>
189<A HREF="manual.html#pdf-coroutine.status">coroutine.status</A><BR>
190<A HREF="manual.html#pdf-coroutine.wrap">coroutine.wrap</A><BR>
191<A HREF="manual.html#pdf-coroutine.yield">coroutine.yield</A><BR>
192
193<P>
194<A HREF="manual.html#6.10">debug</A><BR>
195<A HREF="manual.html#pdf-debug.debug">debug.debug</A><BR>
196<A HREF="manual.html#pdf-debug.gethook">debug.gethook</A><BR>
197<A HREF="manual.html#pdf-debug.getinfo">debug.getinfo</A><BR>
198<A HREF="manual.html#pdf-debug.getlocal">debug.getlocal</A><BR>
199<A HREF="manual.html#pdf-debug.getmetatable">debug.getmetatable</A><BR>
200<A HREF="manual.html#pdf-debug.getregistry">debug.getregistry</A><BR>
201<A HREF="manual.html#pdf-debug.getupvalue">debug.getupvalue</A><BR>
202<A HREF="manual.html#pdf-debug.getuservalue">debug.getuservalue</A><BR>
203<A HREF="manual.html#pdf-debug.sethook">debug.sethook</A><BR>
204<A HREF="manual.html#pdf-debug.setlocal">debug.setlocal</A><BR>
205<A HREF="manual.html#pdf-debug.setmetatable">debug.setmetatable</A><BR>
206<A HREF="manual.html#pdf-debug.setupvalue">debug.setupvalue</A><BR>
207<A HREF="manual.html#pdf-debug.setuservalue">debug.setuservalue</A><BR>
208<A HREF="manual.html#pdf-debug.traceback">debug.traceback</A><BR>
209<A HREF="manual.html#pdf-debug.upvalueid">debug.upvalueid</A><BR>
210<A HREF="manual.html#pdf-debug.upvaluejoin">debug.upvaluejoin</A><BR>
211
212<P>
213<A HREF="manual.html#6.8">io</A><BR>
214<A HREF="manual.html#pdf-io.close">io.close</A><BR>
215<A HREF="manual.html#pdf-io.flush">io.flush</A><BR>
216<A HREF="manual.html#pdf-io.input">io.input</A><BR>
217<A HREF="manual.html#pdf-io.lines">io.lines</A><BR>
218<A HREF="manual.html#pdf-io.open">io.open</A><BR>
219<A HREF="manual.html#pdf-io.output">io.output</A><BR>
220<A HREF="manual.html#pdf-io.popen">io.popen</A><BR>
221<A HREF="manual.html#pdf-io.read">io.read</A><BR>
222<A HREF="manual.html#pdf-io.stderr">io.stderr</A><BR>
223<A HREF="manual.html#pdf-io.stdin">io.stdin</A><BR>
224<A HREF="manual.html#pdf-io.stdout">io.stdout</A><BR>
225<A HREF="manual.html#pdf-io.tmpfile">io.tmpfile</A><BR>
226<A HREF="manual.html#pdf-io.type">io.type</A><BR>
227<A HREF="manual.html#pdf-io.write">io.write</A><BR>
228
229<A HREF="manual.html#pdf-file:close">file:close</A><BR>
230<A HREF="manual.html#pdf-file:flush">file:flush</A><BR>
231<A HREF="manual.html#pdf-file:lines">file:lines</A><BR>
232<A HREF="manual.html#pdf-file:read">file:read</A><BR>
233<A HREF="manual.html#pdf-file:seek">file:seek</A><BR>
234<A HREF="manual.html#pdf-file:setvbuf">file:setvbuf</A><BR>
235<A HREF="manual.html#pdf-file:write">file:write</A><BR>
236
237</TD>
238<TD>
239<H3>&nbsp;</H3>
240<P>
241<A HREF="manual.html#6.7">math</A><BR>
242<A HREF="manual.html#pdf-math.abs">math.abs</A><BR>
243<A HREF="manual.html#pdf-math.acos">math.acos</A><BR>
244<A HREF="manual.html#pdf-math.asin">math.asin</A><BR>
245<A HREF="manual.html#pdf-math.atan">math.atan</A><BR>
246<A HREF="manual.html#pdf-math.ceil">math.ceil</A><BR>
247<A HREF="manual.html#pdf-math.cos">math.cos</A><BR>
248<A HREF="manual.html#pdf-math.deg">math.deg</A><BR>
249<A HREF="manual.html#pdf-math.exp">math.exp</A><BR>
250<A HREF="manual.html#pdf-math.floor">math.floor</A><BR>
251<A HREF="manual.html#pdf-math.fmod">math.fmod</A><BR>
252<A HREF="manual.html#pdf-math.huge">math.huge</A><BR>
253<A HREF="manual.html#pdf-math.log">math.log</A><BR>
254<A HREF="manual.html#pdf-math.max">math.max</A><BR>
255<A HREF="manual.html#pdf-math.maxinteger">math.maxinteger</A><BR>
256<A HREF="manual.html#pdf-math.min">math.min</A><BR>
257<A HREF="manual.html#pdf-math.mininteger">math.mininteger</A><BR>
258<A HREF="manual.html#pdf-math.modf">math.modf</A><BR>
259<A HREF="manual.html#pdf-math.pi">math.pi</A><BR>
260<A HREF="manual.html#pdf-math.rad">math.rad</A><BR>
261<A HREF="manual.html#pdf-math.random">math.random</A><BR>
262<A HREF="manual.html#pdf-math.randomseed">math.randomseed</A><BR>
263<A HREF="manual.html#pdf-math.sin">math.sin</A><BR>
264<A HREF="manual.html#pdf-math.sqrt">math.sqrt</A><BR>
265<A HREF="manual.html#pdf-math.tan">math.tan</A><BR>
266<A HREF="manual.html#pdf-math.tointeger">math.tointeger</A><BR>
267<A HREF="manual.html#pdf-math.type">math.type</A><BR>
268<A HREF="manual.html#pdf-math.ult">math.ult</A><BR>
269
270<P>
271<A HREF="manual.html#6.9">os</A><BR>
272<A HREF="manual.html#pdf-os.clock">os.clock</A><BR>
273<A HREF="manual.html#pdf-os.date">os.date</A><BR>
274<A HREF="manual.html#pdf-os.difftime">os.difftime</A><BR>
275<A HREF="manual.html#pdf-os.execute">os.execute</A><BR>
276<A HREF="manual.html#pdf-os.exit">os.exit</A><BR>
277<A HREF="manual.html#pdf-os.getenv">os.getenv</A><BR>
278<A HREF="manual.html#pdf-os.remove">os.remove</A><BR>
279<A HREF="manual.html#pdf-os.rename">os.rename</A><BR>
280<A HREF="manual.html#pdf-os.setlocale">os.setlocale</A><BR>
281<A HREF="manual.html#pdf-os.time">os.time</A><BR>
282<A HREF="manual.html#pdf-os.tmpname">os.tmpname</A><BR>
283
284<P>
285<A HREF="manual.html#6.3">package</A><BR>
286<A HREF="manual.html#pdf-package.config">package.config</A><BR>
287<A HREF="manual.html#pdf-package.cpath">package.cpath</A><BR>
288<A HREF="manual.html#pdf-package.loaded">package.loaded</A><BR>
289<A HREF="manual.html#pdf-package.loadlib">package.loadlib</A><BR>
290<A HREF="manual.html#pdf-package.path">package.path</A><BR>
291<A HREF="manual.html#pdf-package.preload">package.preload</A><BR>
292<A HREF="manual.html#pdf-package.searchers">package.searchers</A><BR>
293<A HREF="manual.html#pdf-package.searchpath">package.searchpath</A><BR>
294
295<P>
296<A HREF="manual.html#6.4">string</A><BR>
297<A HREF="manual.html#pdf-string.byte">string.byte</A><BR>
298<A HREF="manual.html#pdf-string.char">string.char</A><BR>
299<A HREF="manual.html#pdf-string.dump">string.dump</A><BR>
300<A HREF="manual.html#pdf-string.find">string.find</A><BR>
301<A HREF="manual.html#pdf-string.format">string.format</A><BR>
302<A HREF="manual.html#pdf-string.gmatch">string.gmatch</A><BR>
303<A HREF="manual.html#pdf-string.gsub">string.gsub</A><BR>
304<A HREF="manual.html#pdf-string.len">string.len</A><BR>
305<A HREF="manual.html#pdf-string.lower">string.lower</A><BR>
306<A HREF="manual.html#pdf-string.match">string.match</A><BR>
307<A HREF="manual.html#pdf-string.pack">string.pack</A><BR>
308<A HREF="manual.html#pdf-string.packsize">string.packsize</A><BR>
309<A HREF="manual.html#pdf-string.rep">string.rep</A><BR>
310<A HREF="manual.html#pdf-string.reverse">string.reverse</A><BR>
311<A HREF="manual.html#pdf-string.sub">string.sub</A><BR>
312<A HREF="manual.html#pdf-string.unpack">string.unpack</A><BR>
313<A HREF="manual.html#pdf-string.upper">string.upper</A><BR>
314
315<P>
316<A HREF="manual.html#6.6">table</A><BR>
317<A HREF="manual.html#pdf-table.concat">table.concat</A><BR>
318<A HREF="manual.html#pdf-table.insert">table.insert</A><BR>
319<A HREF="manual.html#pdf-table.move">table.move</A><BR>
320<A HREF="manual.html#pdf-table.pack">table.pack</A><BR>
321<A HREF="manual.html#pdf-table.remove">table.remove</A><BR>
322<A HREF="manual.html#pdf-table.sort">table.sort</A><BR>
323<A HREF="manual.html#pdf-table.unpack">table.unpack</A><BR>
324
325<P>
326<A HREF="manual.html#6.5">utf8</A><BR>
327<A HREF="manual.html#pdf-utf8.char">utf8.char</A><BR>
328<A HREF="manual.html#pdf-utf8.charpattern">utf8.charpattern</A><BR>
329<A HREF="manual.html#pdf-utf8.codepoint">utf8.codepoint</A><BR>
330<A HREF="manual.html#pdf-utf8.codes">utf8.codes</A><BR>
331<A HREF="manual.html#pdf-utf8.len">utf8.len</A><BR>
332<A HREF="manual.html#pdf-utf8.offset">utf8.offset</A><BR>
333
334<H3><A NAME="metamethods">metamethods</A></H3>
335<P>
336<A HREF="manual.html#2.4">__add</A><BR>
337<A HREF="manual.html#2.4">__band</A><BR>
338<A HREF="manual.html#2.4">__bnot</A><BR>
339<A HREF="manual.html#2.4">__bor</A><BR>
340<A HREF="manual.html#2.4">__bxor</A><BR>
341<A HREF="manual.html#2.4">__call</A><BR>
342<A HREF="manual.html#3.3.8">__close</A><BR>
343<A HREF="manual.html#2.4">__concat</A><BR>
344<A HREF="manual.html#2.4">__div</A><BR>
345<A HREF="manual.html#2.4">__eq</A><BR>
346<A HREF="manual.html#2.5.3">__gc</A><BR>
347<A HREF="manual.html#2.4">__idiv</A><BR>
348<A HREF="manual.html#2.4">__index</A><BR>
349<A HREF="manual.html#2.4">__le</A><BR>
350<A HREF="manual.html#2.4">__len</A><BR>
351<A HREF="manual.html#2.4">__lt</A><BR>
352<A HREF="manual.html#pdf-getmetatable">__metatable</A><BR>
353<A HREF="manual.html#2.4">__mod</A><BR>
354<A HREF="manual.html#2.5.4">__mode</A><BR>
355<A HREF="manual.html#2.4">__mul</A><BR>
356<A HREF="manual.html#luaL_newmetatable">__name</A><BR>
357<A HREF="manual.html#2.4">__newindex</A><BR>
358<A HREF="manual.html#pdf-pairs">__pairs</A><BR>
359<A HREF="manual.html#2.4">__pow</A><BR>
360<A HREF="manual.html#2.4">__shl</A><BR>
361<A HREF="manual.html#2.4">__shr</A><BR>
362<A HREF="manual.html#2.4">__sub</A><BR>
363<A HREF="manual.html#pdf-tostring">__tostring</A><BR>
364<A HREF="manual.html#2.4">__unm</A><BR>
365
366<H3><A NAME="env">environment<BR>variables</A></H3>
367<P>
368<A HREF="manual.html#pdf-LUA_CPATH">LUA_CPATH</A><BR>
369<A HREF="manual.html#pdf-LUA_CPATH_5_4">LUA_CPATH_5_4</A><BR>
370<A HREF="manual.html#pdf-LUA_INIT">LUA_INIT</A><BR>
371<A HREF="manual.html#pdf-LUA_INIT_5_4">LUA_INIT_5_4</A><BR>
372<A HREF="manual.html#pdf-LUA_PATH">LUA_PATH</A><BR>
373<A HREF="manual.html#pdf-LUA_PATH_5_4">LUA_PATH_5_4</A><BR>
374
375</TD>
376<TD>
377<H3><A NAME="api">C API</A></H3>
378<P>
379<A HREF="manual.html#lua_Alloc">lua_Alloc</A><BR>
380<A HREF="manual.html#lua_CFunction">lua_CFunction</A><BR>
381<A HREF="manual.html#lua_Debug">lua_Debug</A><BR>
382<A HREF="manual.html#lua_Hook">lua_Hook</A><BR>
383<A HREF="manual.html#lua_Integer">lua_Integer</A><BR>
384<A HREF="manual.html#lua_KContext">lua_KContext</A><BR>
385<A HREF="manual.html#lua_KFunction">lua_KFunction</A><BR>
386<A HREF="manual.html#lua_Number">lua_Number</A><BR>
387<A HREF="manual.html#lua_Reader">lua_Reader</A><BR>
388<A HREF="manual.html#lua_State">lua_State</A><BR>
389<A HREF="manual.html#lua_Unsigned">lua_Unsigned</A><BR>
390<A HREF="manual.html#lua_WarnFunction">lua_WarnFunction</A><BR>
391<A HREF="manual.html#lua_Writer">lua_Writer</A><BR>
392
393<P>
394<A HREF="manual.html#lua_absindex">lua_absindex</A><BR>
395<A HREF="manual.html#lua_arith">lua_arith</A><BR>
396<A HREF="manual.html#lua_atpanic">lua_atpanic</A><BR>
397<A HREF="manual.html#lua_call">lua_call</A><BR>
398<A HREF="manual.html#lua_callk">lua_callk</A><BR>
399<A HREF="manual.html#lua_checkstack">lua_checkstack</A><BR>
400<A HREF="manual.html#lua_close">lua_close</A><BR>
401<A HREF="manual.html#lua_closeslot">lua_closeslot</A><BR>
402<A HREF="manual.html#lua_compare">lua_compare</A><BR>
403<A HREF="manual.html#lua_concat">lua_concat</A><BR>
404<A HREF="manual.html#lua_copy">lua_copy</A><BR>
405<A HREF="manual.html#lua_createtable">lua_createtable</A><BR>
406<A HREF="manual.html#lua_dump">lua_dump</A><BR>
407<A HREF="manual.html#lua_error">lua_error</A><BR>
408<A HREF="manual.html#lua_gc">lua_gc</A><BR>
409<A HREF="manual.html#lua_getallocf">lua_getallocf</A><BR>
410<A HREF="manual.html#lua_getextraspace">lua_getextraspace</A><BR>
411<A HREF="manual.html#lua_getfield">lua_getfield</A><BR>
412<A HREF="manual.html#lua_getglobal">lua_getglobal</A><BR>
413<A HREF="manual.html#lua_gethook">lua_gethook</A><BR>
414<A HREF="manual.html#lua_gethookcount">lua_gethookcount</A><BR>
415<A HREF="manual.html#lua_gethookmask">lua_gethookmask</A><BR>
416<A HREF="manual.html#lua_geti">lua_geti</A><BR>
417<A HREF="manual.html#lua_getinfo">lua_getinfo</A><BR>
418<A HREF="manual.html#lua_getiuservalue">lua_getiuservalue</A><BR>
419<A HREF="manual.html#lua_getlocal">lua_getlocal</A><BR>
420<A HREF="manual.html#lua_getmetatable">lua_getmetatable</A><BR>
421<A HREF="manual.html#lua_getstack">lua_getstack</A><BR>
422<A HREF="manual.html#lua_gettable">lua_gettable</A><BR>
423<A HREF="manual.html#lua_gettop">lua_gettop</A><BR>
424<A HREF="manual.html#lua_getupvalue">lua_getupvalue</A><BR>
425<A HREF="manual.html#lua_insert">lua_insert</A><BR>
426<A HREF="manual.html#lua_isboolean">lua_isboolean</A><BR>
427<A HREF="manual.html#lua_iscfunction">lua_iscfunction</A><BR>
428<A HREF="manual.html#lua_isfunction">lua_isfunction</A><BR>
429<A HREF="manual.html#lua_isinteger">lua_isinteger</A><BR>
430<A HREF="manual.html#lua_islightuserdata">lua_islightuserdata</A><BR>
431<A HREF="manual.html#lua_isnil">lua_isnil</A><BR>
432<A HREF="manual.html#lua_isnone">lua_isnone</A><BR>
433<A HREF="manual.html#lua_isnoneornil">lua_isnoneornil</A><BR>
434<A HREF="manual.html#lua_isnumber">lua_isnumber</A><BR>
435<A HREF="manual.html#lua_isstring">lua_isstring</A><BR>
436<A HREF="manual.html#lua_istable">lua_istable</A><BR>
437<A HREF="manual.html#lua_isthread">lua_isthread</A><BR>
438<A HREF="manual.html#lua_isuserdata">lua_isuserdata</A><BR>
439<A HREF="manual.html#lua_isyieldable">lua_isyieldable</A><BR>
440<A HREF="manual.html#lua_len">lua_len</A><BR>
441<A HREF="manual.html#lua_load">lua_load</A><BR>
442<A HREF="manual.html#lua_newstate">lua_newstate</A><BR>
443<A HREF="manual.html#lua_newtable">lua_newtable</A><BR>
444<A HREF="manual.html#lua_newthread">lua_newthread</A><BR>
445<A HREF="manual.html#lua_newuserdatauv">lua_newuserdatauv</A><BR>
446<A HREF="manual.html#lua_next">lua_next</A><BR>
447<A HREF="manual.html#lua_numbertointeger">lua_numbertointeger</A><BR>
448<A HREF="manual.html#lua_pcall">lua_pcall</A><BR>
449<A HREF="manual.html#lua_pcallk">lua_pcallk</A><BR>
450<A HREF="manual.html#lua_pop">lua_pop</A><BR>
451<A HREF="manual.html#lua_pushboolean">lua_pushboolean</A><BR>
452<A HREF="manual.html#lua_pushcclosure">lua_pushcclosure</A><BR>
453<A HREF="manual.html#lua_pushcfunction">lua_pushcfunction</A><BR>
454<A HREF="manual.html#lua_pushfstring">lua_pushfstring</A><BR>
455<A HREF="manual.html#lua_pushglobaltable">lua_pushglobaltable</A><BR>
456<A HREF="manual.html#lua_pushinteger">lua_pushinteger</A><BR>
457<A HREF="manual.html#lua_pushlightuserdata">lua_pushlightuserdata</A><BR>
458<A HREF="manual.html#lua_pushliteral">lua_pushliteral</A><BR>
459<A HREF="manual.html#lua_pushlstring">lua_pushlstring</A><BR>
460<A HREF="manual.html#lua_pushnil">lua_pushnil</A><BR>
461<A HREF="manual.html#lua_pushnumber">lua_pushnumber</A><BR>
462<A HREF="manual.html#lua_pushstring">lua_pushstring</A><BR>
463<A HREF="manual.html#lua_pushthread">lua_pushthread</A><BR>
464<A HREF="manual.html#lua_pushvalue">lua_pushvalue</A><BR>
465<A HREF="manual.html#lua_pushvfstring">lua_pushvfstring</A><BR>
466<A HREF="manual.html#lua_rawequal">lua_rawequal</A><BR>
467<A HREF="manual.html#lua_rawget">lua_rawget</A><BR>
468<A HREF="manual.html#lua_rawgeti">lua_rawgeti</A><BR>
469<A HREF="manual.html#lua_rawgetp">lua_rawgetp</A><BR>
470<A HREF="manual.html#lua_rawlen">lua_rawlen</A><BR>
471<A HREF="manual.html#lua_rawset">lua_rawset</A><BR>
472<A HREF="manual.html#lua_rawseti">lua_rawseti</A><BR>
473<A HREF="manual.html#lua_rawsetp">lua_rawsetp</A><BR>
474<A HREF="manual.html#lua_register">lua_register</A><BR>
475<A HREF="manual.html#lua_remove">lua_remove</A><BR>
476<A HREF="manual.html#lua_replace">lua_replace</A><BR>
477<A HREF="manual.html#lua_resetthread">lua_resetthread</A><BR>
478<A HREF="manual.html#lua_resume">lua_resume</A><BR>
479<A HREF="manual.html#lua_rotate">lua_rotate</A><BR>
480<A HREF="manual.html#lua_setallocf">lua_setallocf</A><BR>
481<A HREF="manual.html#lua_setfield">lua_setfield</A><BR>
482<A HREF="manual.html#lua_setglobal">lua_setglobal</A><BR>
483<A HREF="manual.html#lua_sethook">lua_sethook</A><BR>
484<A HREF="manual.html#lua_seti">lua_seti</A><BR>
485<A HREF="manual.html#lua_setiuservalue">lua_setiuservalue</A><BR>
486<A HREF="manual.html#lua_setlocal">lua_setlocal</A><BR>
487<A HREF="manual.html#lua_setmetatable">lua_setmetatable</A><BR>
488<A HREF="manual.html#lua_settable">lua_settable</A><BR>
489<A HREF="manual.html#lua_settop">lua_settop</A><BR>
490<A HREF="manual.html#lua_setupvalue">lua_setupvalue</A><BR>
491<A HREF="manual.html#lua_setwarnf">lua_setwarnf</A><BR>
492<A HREF="manual.html#lua_status">lua_status</A><BR>
493<A HREF="manual.html#lua_stringtonumber">lua_stringtonumber</A><BR>
494<A HREF="manual.html#lua_toboolean">lua_toboolean</A><BR>
495<A HREF="manual.html#lua_tocfunction">lua_tocfunction</A><BR>
496<A HREF="manual.html#lua_toclose">lua_toclose</A><BR>
497<A HREF="manual.html#lua_tointeger">lua_tointeger</A><BR>
498<A HREF="manual.html#lua_tointegerx">lua_tointegerx</A><BR>
499<A HREF="manual.html#lua_tolstring">lua_tolstring</A><BR>
500<A HREF="manual.html#lua_tonumber">lua_tonumber</A><BR>
501<A HREF="manual.html#lua_tonumberx">lua_tonumberx</A><BR>
502<A HREF="manual.html#lua_topointer">lua_topointer</A><BR>
503<A HREF="manual.html#lua_tostring">lua_tostring</A><BR>
504<A HREF="manual.html#lua_tothread">lua_tothread</A><BR>
505<A HREF="manual.html#lua_touserdata">lua_touserdata</A><BR>
506<A HREF="manual.html#lua_type">lua_type</A><BR>
507<A HREF="manual.html#lua_typename">lua_typename</A><BR>
508<A HREF="manual.html#lua_upvalueid">lua_upvalueid</A><BR>
509<A HREF="manual.html#lua_upvalueindex">lua_upvalueindex</A><BR>
510<A HREF="manual.html#lua_upvaluejoin">lua_upvaluejoin</A><BR>
511<A HREF="manual.html#lua_version">lua_version</A><BR>
512<A HREF="manual.html#lua_warning">lua_warning</A><BR>
513<A HREF="manual.html#lua_xmove">lua_xmove</A><BR>
514<A HREF="manual.html#lua_yield">lua_yield</A><BR>
515<A HREF="manual.html#lua_yieldk">lua_yieldk</A><BR>
516
517</TD>
518<TD>
519<H3><A NAME="auxlib">auxiliary library</A></H3>
520<P>
521<A HREF="manual.html#luaL_Buffer">luaL_Buffer</A><BR>
522<A HREF="manual.html#luaL_Reg">luaL_Reg</A><BR>
523<A HREF="manual.html#luaL_Stream">luaL_Stream</A><BR>
524
525<P>
526<A HREF="manual.html#luaL_addchar">luaL_addchar</A><BR>
527<A HREF="manual.html#luaL_addgsub">luaL_addgsub</A><BR>
528<A HREF="manual.html#luaL_addlstring">luaL_addlstring</A><BR>
529<A HREF="manual.html#luaL_addsize">luaL_addsize</A><BR>
530<A HREF="manual.html#luaL_addstring">luaL_addstring</A><BR>
531<A HREF="manual.html#luaL_addvalue">luaL_addvalue</A><BR>
532<A HREF="manual.html#luaL_argcheck">luaL_argcheck</A><BR>
533<A HREF="manual.html#luaL_argerror">luaL_argerror</A><BR>
534<A HREF="manual.html#luaL_argexpected">luaL_argexpected</A><BR>
535<A HREF="manual.html#luaL_buffaddr">luaL_buffaddr</A><BR>
536<A HREF="manual.html#luaL_buffinit">luaL_buffinit</A><BR>
537<A HREF="manual.html#luaL_buffinitsize">luaL_buffinitsize</A><BR>
538<A HREF="manual.html#luaL_bufflen">luaL_bufflen</A><BR>
539<A HREF="manual.html#luaL_buffsub">luaL_buffsub</A><BR>
540<A HREF="manual.html#luaL_callmeta">luaL_callmeta</A><BR>
541<A HREF="manual.html#luaL_checkany">luaL_checkany</A><BR>
542<A HREF="manual.html#luaL_checkinteger">luaL_checkinteger</A><BR>
543<A HREF="manual.html#luaL_checklstring">luaL_checklstring</A><BR>
544<A HREF="manual.html#luaL_checknumber">luaL_checknumber</A><BR>
545<A HREF="manual.html#luaL_checkoption">luaL_checkoption</A><BR>
546<A HREF="manual.html#luaL_checkstack">luaL_checkstack</A><BR>
547<A HREF="manual.html#luaL_checkstring">luaL_checkstring</A><BR>
548<A HREF="manual.html#luaL_checktype">luaL_checktype</A><BR>
549<A HREF="manual.html#luaL_checkudata">luaL_checkudata</A><BR>
550<A HREF="manual.html#luaL_checkversion">luaL_checkversion</A><BR>
551<A HREF="manual.html#luaL_dofile">luaL_dofile</A><BR>
552<A HREF="manual.html#luaL_dostring">luaL_dostring</A><BR>
553<A HREF="manual.html#luaL_error">luaL_error</A><BR>
554<A HREF="manual.html#luaL_execresult">luaL_execresult</A><BR>
555<A HREF="manual.html#luaL_fileresult">luaL_fileresult</A><BR>
556<A HREF="manual.html#luaL_getmetafield">luaL_getmetafield</A><BR>
557<A HREF="manual.html#luaL_getmetatable">luaL_getmetatable</A><BR>
558<A HREF="manual.html#luaL_getsubtable">luaL_getsubtable</A><BR>
559<A HREF="manual.html#luaL_gsub">luaL_gsub</A><BR>
560<A HREF="manual.html#luaL_len">luaL_len</A><BR>
561<A HREF="manual.html#luaL_loadbuffer">luaL_loadbuffer</A><BR>
562<A HREF="manual.html#luaL_loadbufferx">luaL_loadbufferx</A><BR>
563<A HREF="manual.html#luaL_loadfile">luaL_loadfile</A><BR>
564<A HREF="manual.html#luaL_loadfilex">luaL_loadfilex</A><BR>
565<A HREF="manual.html#luaL_loadstring">luaL_loadstring</A><BR>
566<A HREF="manual.html#luaL_newlib">luaL_newlib</A><BR>
567<A HREF="manual.html#luaL_newlibtable">luaL_newlibtable</A><BR>
568<A HREF="manual.html#luaL_newmetatable">luaL_newmetatable</A><BR>
569<A HREF="manual.html#luaL_newstate">luaL_newstate</A><BR>
570<A HREF="manual.html#luaL_openlibs">luaL_openlibs</A><BR>
571<A HREF="manual.html#luaL_opt">luaL_opt</A><BR>
572<A HREF="manual.html#luaL_optinteger">luaL_optinteger</A><BR>
573<A HREF="manual.html#luaL_optlstring">luaL_optlstring</A><BR>
574<A HREF="manual.html#luaL_optnumber">luaL_optnumber</A><BR>
575<A HREF="manual.html#luaL_optstring">luaL_optstring</A><BR>
576<A HREF="manual.html#luaL_prepbuffer">luaL_prepbuffer</A><BR>
577<A HREF="manual.html#luaL_prepbuffsize">luaL_prepbuffsize</A><BR>
578<A HREF="manual.html#luaL_pushfail">luaL_pushfail</A><BR>
579<A HREF="manual.html#luaL_pushresult">luaL_pushresult</A><BR>
580<A HREF="manual.html#luaL_pushresultsize">luaL_pushresultsize</A><BR>
581<A HREF="manual.html#luaL_ref">luaL_ref</A><BR>
582<A HREF="manual.html#luaL_requiref">luaL_requiref</A><BR>
583<A HREF="manual.html#luaL_setfuncs">luaL_setfuncs</A><BR>
584<A HREF="manual.html#luaL_setmetatable">luaL_setmetatable</A><BR>
585<A HREF="manual.html#luaL_testudata">luaL_testudata</A><BR>
586<A HREF="manual.html#luaL_tolstring">luaL_tolstring</A><BR>
587<A HREF="manual.html#luaL_traceback">luaL_traceback</A><BR>
588<A HREF="manual.html#luaL_typeerror">luaL_typeerror</A><BR>
589<A HREF="manual.html#luaL_typename">luaL_typename</A><BR>
590<A HREF="manual.html#luaL_unref">luaL_unref</A><BR>
591<A HREF="manual.html#luaL_where">luaL_where</A><BR>
592
593<H3><A NAME="library">standard library</A></H3>
594<P>
595<A HREF="manual.html#pdf-luaopen_base">luaopen_base</A><BR>
596<A HREF="manual.html#pdf-luaopen_coroutine">luaopen_coroutine</A><BR>
597<A HREF="manual.html#pdf-luaopen_debug">luaopen_debug</A><BR>
598<A HREF="manual.html#pdf-luaopen_io">luaopen_io</A><BR>
599<A HREF="manual.html#pdf-luaopen_math">luaopen_math</A><BR>
600<A HREF="manual.html#pdf-luaopen_os">luaopen_os</A><BR>
601<A HREF="manual.html#pdf-luaopen_package">luaopen_package</A><BR>
602<A HREF="manual.html#pdf-luaopen_string">luaopen_string</A><BR>
603<A HREF="manual.html#pdf-luaopen_table">luaopen_table</A><BR>
604<A HREF="manual.html#pdf-luaopen_utf8">luaopen_utf8</A><BR>
605
606<H3><A NAME="constants">constants</A></H3>
607<P>
608<A HREF="manual.html#pdf-LUA_ERRERR">LUA_ERRERR</A><BR>
609<A HREF="manual.html#pdf-LUA_ERRFILE">LUA_ERRFILE</A><BR>
610<A HREF="manual.html#pdf-LUA_ERRMEM">LUA_ERRMEM</A><BR>
611<A HREF="manual.html#pdf-LUA_ERRRUN">LUA_ERRRUN</A><BR>
612<A HREF="manual.html#pdf-LUA_ERRSYNTAX">LUA_ERRSYNTAX</A><BR>
613<A HREF="manual.html#pdf-LUA_HOOKCALL">LUA_HOOKCALL</A><BR>
614<A HREF="manual.html#pdf-LUA_HOOKCOUNT">LUA_HOOKCOUNT</A><BR>
615<A HREF="manual.html#pdf-LUA_HOOKLINE">LUA_HOOKLINE</A><BR>
616<A HREF="manual.html#pdf-LUA_HOOKRET">LUA_HOOKRET</A><BR>
617<A HREF="manual.html#pdf-LUA_HOOKTAILCALL">LUA_HOOKTAILCALL</A><BR>
618<A HREF="manual.html#pdf-LUA_LOADED_TABLE">LUA_LOADED_TABLE</A><BR>
619<A HREF="manual.html#pdf-LUA_MASKCALL">LUA_MASKCALL</A><BR>
620<A HREF="manual.html#pdf-LUA_MASKCOUNT">LUA_MASKCOUNT</A><BR>
621<A HREF="manual.html#pdf-LUA_MASKLINE">LUA_MASKLINE</A><BR>
622<A HREF="manual.html#pdf-LUA_MASKRET">LUA_MASKRET</A><BR>
623<A HREF="manual.html#pdf-LUA_MAXINTEGER">LUA_MAXINTEGER</A><BR>
624<A HREF="manual.html#pdf-LUA_MININTEGER">LUA_MININTEGER</A><BR>
625<A HREF="manual.html#pdf-LUA_MINSTACK">LUA_MINSTACK</A><BR>
626<A HREF="manual.html#pdf-LUA_MULTRET">LUA_MULTRET</A><BR>
627<A HREF="manual.html#pdf-LUA_NOREF">LUA_NOREF</A><BR>
628<A HREF="manual.html#pdf-LUA_OK">LUA_OK</A><BR>
629<A HREF="manual.html#pdf-LUA_OPADD">LUA_OPADD</A><BR>
630<A HREF="manual.html#pdf-LUA_OPBAND">LUA_OPBAND</A><BR>
631<A HREF="manual.html#pdf-LUA_OPBNOT">LUA_OPBNOT</A><BR>
632<A HREF="manual.html#pdf-LUA_OPBOR">LUA_OPBOR</A><BR>
633<A HREF="manual.html#pdf-LUA_OPBXOR">LUA_OPBXOR</A><BR>
634<A HREF="manual.html#pdf-LUA_OPDIV">LUA_OPDIV</A><BR>
635<A HREF="manual.html#pdf-LUA_OPEQ">LUA_OPEQ</A><BR>
636<A HREF="manual.html#pdf-LUA_OPIDIV">LUA_OPIDIV</A><BR>
637<A HREF="manual.html#pdf-LUA_OPLE">LUA_OPLE</A><BR>
638<A HREF="manual.html#pdf-LUA_OPLT">LUA_OPLT</A><BR>
639<A HREF="manual.html#pdf-LUA_OPMOD">LUA_OPMOD</A><BR>
640<A HREF="manual.html#pdf-LUA_OPMUL">LUA_OPMUL</A><BR>
641<A HREF="manual.html#pdf-LUA_OPPOW">LUA_OPPOW</A><BR>
642<A HREF="manual.html#pdf-LUA_OPSHL">LUA_OPSHL</A><BR>
643<A HREF="manual.html#pdf-LUA_OPSHR">LUA_OPSHR</A><BR>
644<A HREF="manual.html#pdf-LUA_OPSUB">LUA_OPSUB</A><BR>
645<A HREF="manual.html#pdf-LUA_OPUNM">LUA_OPUNM</A><BR>
646<A HREF="manual.html#pdf-LUA_PRELOAD_TABLE">LUA_PRELOAD_TABLE</A><BR>
647<A HREF="manual.html#pdf-LUA_REFNIL">LUA_REFNIL</A><BR>
648<A HREF="manual.html#pdf-LUA_REGISTRYINDEX">LUA_REGISTRYINDEX</A><BR>
649<A HREF="manual.html#pdf-LUA_RIDX_GLOBALS">LUA_RIDX_GLOBALS</A><BR>
650<A HREF="manual.html#pdf-LUA_RIDX_MAINTHREAD">LUA_RIDX_MAINTHREAD</A><BR>
651<A HREF="manual.html#pdf-LUA_TBOOLEAN">LUA_TBOOLEAN</A><BR>
652<A HREF="manual.html#pdf-LUA_TFUNCTION">LUA_TFUNCTION</A><BR>
653<A HREF="manual.html#pdf-LUA_TLIGHTUSERDATA">LUA_TLIGHTUSERDATA</A><BR>
654<A HREF="manual.html#pdf-LUA_TNIL">LUA_TNIL</A><BR>
655<A HREF="manual.html#pdf-LUA_TNONE">LUA_TNONE</A><BR>
656<A HREF="manual.html#pdf-LUA_TNUMBER">LUA_TNUMBER</A><BR>
657<A HREF="manual.html#pdf-LUA_TSTRING">LUA_TSTRING</A><BR>
658<A HREF="manual.html#pdf-LUA_TTABLE">LUA_TTABLE</A><BR>
659<A HREF="manual.html#pdf-LUA_TTHREAD">LUA_TTHREAD</A><BR>
660<A HREF="manual.html#pdf-LUA_TUSERDATA">LUA_TUSERDATA</A><BR>
661<A HREF="manual.html#pdf-LUA_USE_APICHECK">LUA_USE_APICHECK</A><BR>
662<A HREF="manual.html#pdf-LUA_YIELD">LUA_YIELD</A><BR>
663<A HREF="manual.html#pdf-LUAL_BUFFERSIZE">LUAL_BUFFERSIZE</A><BR>
664
665</TD>
666</TR>
667</TABLE>
668
669<P CLASS="footer">
670Last update:
671Sat Apr  1 17:57:05 UTC 2023
672</P>
673<!--
674Last change: revised for Lua 5.4.5
675-->
676
677</BODY>
678</HTML>
679