xref: /freebsd/contrib/lutok/api-docs/html/a00038.html (revision 132f818ddbf457ee67d502cd89b5a18e0a34713d)
1*132f818dSEnji Cooper<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2*132f818dSEnji Cooper<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
3*132f818dSEnji Cooper<head>
4*132f818dSEnji Cooper<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5*132f818dSEnji Cooper<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6*132f818dSEnji Cooper<meta name="generator" content="Doxygen 1.9.6"/>
7*132f818dSEnji Cooper<meta name="viewport" content="width=device-width, initial-scale=1"/>
8*132f818dSEnji Cooper<title>Lutok: operations.hpp File Reference</title>
9*132f818dSEnji Cooper<link href="tabs.css" rel="stylesheet" type="text/css"/>
10*132f818dSEnji Cooper<script type="text/javascript" src="jquery.js"></script>
11*132f818dSEnji Cooper<script type="text/javascript" src="dynsections.js"></script>
12*132f818dSEnji Cooper<link href="search/search.css" rel="stylesheet" type="text/css"/>
13*132f818dSEnji Cooper<script type="text/javascript" src="search/searchdata.js"></script>
14*132f818dSEnji Cooper<script type="text/javascript" src="search/search.js"></script>
15*132f818dSEnji Cooper<link href="doxygen.css" rel="stylesheet" type="text/css" />
16*132f818dSEnji Cooper</head>
17*132f818dSEnji Cooper<body>
18*132f818dSEnji Cooper<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19*132f818dSEnji Cooper<div id="titlearea">
20*132f818dSEnji Cooper<table cellspacing="0" cellpadding="0">
21*132f818dSEnji Cooper <tbody>
22*132f818dSEnji Cooper <tr id="projectrow">
23*132f818dSEnji Cooper  <td id="projectalign">
24*132f818dSEnji Cooper   <div id="projectname">Lutok<span id="projectnumber">&#160;0.6.2</span>
25*132f818dSEnji Cooper   </div>
26*132f818dSEnji Cooper  </td>
27*132f818dSEnji Cooper </tr>
28*132f818dSEnji Cooper </tbody>
29*132f818dSEnji Cooper</table>
30*132f818dSEnji Cooper</div>
31*132f818dSEnji Cooper<!-- end header part -->
32*132f818dSEnji Cooper<!-- Generated by Doxygen 1.9.6 -->
33*132f818dSEnji Cooper<script type="text/javascript">
34*132f818dSEnji Cooper/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
35*132f818dSEnji Coopervar searchBox = new SearchBox("searchBox", "search/",'.html');
36*132f818dSEnji Cooper/* @license-end */
37*132f818dSEnji Cooper</script>
38*132f818dSEnji Cooper<script type="text/javascript" src="menudata.js"></script>
39*132f818dSEnji Cooper<script type="text/javascript" src="menu.js"></script>
40*132f818dSEnji Cooper<script type="text/javascript">
41*132f818dSEnji Cooper/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
42*132f818dSEnji Cooper$(function() {
43*132f818dSEnji Cooper  initMenu('',true,false,'search.php','Search');
44*132f818dSEnji Cooper  $(document).ready(function() { init_search(); });
45*132f818dSEnji Cooper});
46*132f818dSEnji Cooper/* @license-end */
47*132f818dSEnji Cooper</script>
48*132f818dSEnji Cooper<div id="main-nav"></div>
49*132f818dSEnji Cooper<!-- window showing the filter options -->
50*132f818dSEnji Cooper<div id="MSearchSelectWindow"
51*132f818dSEnji Cooper     onmouseover="return searchBox.OnSearchSelectShow()"
52*132f818dSEnji Cooper     onmouseout="return searchBox.OnSearchSelectHide()"
53*132f818dSEnji Cooper     onkeydown="return searchBox.OnSearchSelectKey(event)">
54*132f818dSEnji Cooper</div>
55*132f818dSEnji Cooper
56*132f818dSEnji Cooper<!-- iframe showing the search results (closed by default) -->
57*132f818dSEnji Cooper<div id="MSearchResultsWindow">
58*132f818dSEnji Cooper<div id="MSearchResults">
59*132f818dSEnji Cooper<div class="SRPage">
60*132f818dSEnji Cooper<div id="SRIndex">
61*132f818dSEnji Cooper<div id="SRResults"></div>
62*132f818dSEnji Cooper<div class="SRStatus" id="Loading">Loading...</div>
63*132f818dSEnji Cooper<div class="SRStatus" id="Searching">Searching...</div>
64*132f818dSEnji Cooper<div class="SRStatus" id="NoMatches">No Matches</div>
65*132f818dSEnji Cooper</div>
66*132f818dSEnji Cooper</div>
67*132f818dSEnji Cooper</div>
68*132f818dSEnji Cooper</div>
69*132f818dSEnji Cooper
70*132f818dSEnji Cooper</div><!-- top -->
71*132f818dSEnji Cooper<div class="header">
72*132f818dSEnji Cooper  <div class="summary">
73*132f818dSEnji Cooper<a href="#func-members">Functions</a>  </div>
74*132f818dSEnji Cooper  <div class="headertitle"><div class="title">operations.hpp File Reference</div></div>
75*132f818dSEnji Cooper</div><!--header-->
76*132f818dSEnji Cooper<div class="contents">
77*132f818dSEnji Cooper
78*132f818dSEnji Cooper<p>Extra generic functions to interact with Lua.
79*132f818dSEnji Cooper<a href="#details">More...</a></p>
80*132f818dSEnji Cooper<div class="textblock"><code>#include &lt;map&gt;</code><br />
81*132f818dSEnji Cooper<code>#include &lt;string&gt;</code><br />
82*132f818dSEnji Cooper<code>#include &lt;vector&gt;</code><br />
83*132f818dSEnji Cooper<code>#include &lt;lutok/state.hpp&gt;</code><br />
84*132f818dSEnji Cooper</div>
85*132f818dSEnji Cooper<p><a href="a00038_source.html">Go to the source code of this file.</a></p>
86*132f818dSEnji Cooper<table class="memberdecls">
87*132f818dSEnji Cooper<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
88*132f818dSEnji CooperFunctions</h2></td></tr>
89*132f818dSEnji Cooper<tr class="memitem:afc4214923cf72dbb861cd8bae8cc2d96"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#afc4214923cf72dbb861cd8bae8cc2d96">lutok::create_module</a> (state &amp;, const std::string &amp;, const std::map&lt; std::string, cxx_function &gt; &amp;)</td></tr>
90*132f818dSEnji Cooper<tr class="memdesc:afc4214923cf72dbb861cd8bae8cc2d96"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a module: i.e.  <br /></td></tr>
91*132f818dSEnji Cooper<tr class="separator:afc4214923cf72dbb861cd8bae8cc2d96"><td class="memSeparator" colspan="2">&#160;</td></tr>
92*132f818dSEnji Cooper<tr class="memitem:a587dc527bb2dd12e9aab11beae605051"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a587dc527bb2dd12e9aab11beae605051">lutok::do_file</a> (state &amp;, const std::string &amp;, const int, const int, const int)</td></tr>
93*132f818dSEnji Cooper<tr class="memdesc:a587dc527bb2dd12e9aab11beae605051"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads and processes a Lua file.  <br /></td></tr>
94*132f818dSEnji Cooper<tr class="separator:a587dc527bb2dd12e9aab11beae605051"><td class="memSeparator" colspan="2">&#160;</td></tr>
95*132f818dSEnji Cooper<tr class="memitem:acfcec30028e0795a0a722aa18ee7909d"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#acfcec30028e0795a0a722aa18ee7909d">lutok::do_string</a> (state &amp;, const std::string &amp;, const int, const int, const int)</td></tr>
96*132f818dSEnji Cooper<tr class="memdesc:acfcec30028e0795a0a722aa18ee7909d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Processes a Lua script.  <br /></td></tr>
97*132f818dSEnji Cooper<tr class="separator:acfcec30028e0795a0a722aa18ee7909d"><td class="memSeparator" colspan="2">&#160;</td></tr>
98*132f818dSEnji Cooper<tr class="memitem:a9d58b8708faaae18051c4ef4b707c84b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a9d58b8708faaae18051c4ef4b707c84b">lutok::eval</a> (state &amp;, const std::string &amp;, const int)</td></tr>
99*132f818dSEnji Cooper<tr class="memdesc:a9d58b8708faaae18051c4ef4b707c84b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convenience function to evaluate a Lua expression.  <br /></td></tr>
100*132f818dSEnji Cooper<tr class="separator:a9d58b8708faaae18051c4ef4b707c84b"><td class="memSeparator" colspan="2">&#160;</td></tr>
101*132f818dSEnji Cooper</table>
102*132f818dSEnji Cooper<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
103*132f818dSEnji Cooper<div class="textblock"><p>Extra generic functions to interact with Lua. </p>
104*132f818dSEnji Cooper</div><h2 class="groupheader">Function Documentation</h2>
105*132f818dSEnji Cooper<a id="afc4214923cf72dbb861cd8bae8cc2d96" name="afc4214923cf72dbb861cd8bae8cc2d96"></a>
106*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#afc4214923cf72dbb861cd8bae8cc2d96">&#9670;&#160;</a></span>create_module()</h2>
107*132f818dSEnji Cooper
108*132f818dSEnji Cooper<div class="memitem">
109*132f818dSEnji Cooper<div class="memproto">
110*132f818dSEnji Cooper      <table class="memname">
111*132f818dSEnji Cooper        <tr>
112*132f818dSEnji Cooper          <td class="memname">void lutok::create_module </td>
113*132f818dSEnji Cooper          <td>(</td>
114*132f818dSEnji Cooper          <td class="paramtype"><a class="el" href="a00919.html">state</a> &amp;&#160;</td>
115*132f818dSEnji Cooper          <td class="paramname"><em>s</em>, </td>
116*132f818dSEnji Cooper        </tr>
117*132f818dSEnji Cooper        <tr>
118*132f818dSEnji Cooper          <td class="paramkey"></td>
119*132f818dSEnji Cooper          <td></td>
120*132f818dSEnji Cooper          <td class="paramtype">const std::string &amp;&#160;</td>
121*132f818dSEnji Cooper          <td class="paramname"><em>name</em>, </td>
122*132f818dSEnji Cooper        </tr>
123*132f818dSEnji Cooper        <tr>
124*132f818dSEnji Cooper          <td class="paramkey"></td>
125*132f818dSEnji Cooper          <td></td>
126*132f818dSEnji Cooper          <td class="paramtype">const std::map&lt; std::string, <a class="el" href="a00029.html#a8c623ca426c30c5fab4df2cb21635f17">cxx_function</a> &gt; &amp;&#160;</td>
127*132f818dSEnji Cooper          <td class="paramname"><em>members</em>&#160;</td>
128*132f818dSEnji Cooper        </tr>
129*132f818dSEnji Cooper        <tr>
130*132f818dSEnji Cooper          <td></td>
131*132f818dSEnji Cooper          <td>)</td>
132*132f818dSEnji Cooper          <td></td><td></td>
133*132f818dSEnji Cooper        </tr>
134*132f818dSEnji Cooper      </table>
135*132f818dSEnji Cooper</div><div class="memdoc">
136*132f818dSEnji Cooper
137*132f818dSEnji Cooper<p>Creates a module: i.e. </p>
138*132f818dSEnji Cooper<p>a table with a set of methods in it.</p>
139*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
140*132f818dSEnji Cooper  <table class="params">
141*132f818dSEnji Cooper    <tr><td class="paramname">s</td><td>The Lua state. </td></tr>
142*132f818dSEnji Cooper    <tr><td class="paramname">name</td><td>The name of the module to create. </td></tr>
143*132f818dSEnji Cooper    <tr><td class="paramname">members</td><td>The list of member functions to add to the module. </td></tr>
144*132f818dSEnji Cooper  </table>
145*132f818dSEnji Cooper  </dd>
146*132f818dSEnji Cooper</dl>
147*132f818dSEnji Cooper
148*132f818dSEnji Cooper</div>
149*132f818dSEnji Cooper</div>
150*132f818dSEnji Cooper<a id="a587dc527bb2dd12e9aab11beae605051" name="a587dc527bb2dd12e9aab11beae605051"></a>
151*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a587dc527bb2dd12e9aab11beae605051">&#9670;&#160;</a></span>do_file()</h2>
152*132f818dSEnji Cooper
153*132f818dSEnji Cooper<div class="memitem">
154*132f818dSEnji Cooper<div class="memproto">
155*132f818dSEnji Cooper      <table class="memname">
156*132f818dSEnji Cooper        <tr>
157*132f818dSEnji Cooper          <td class="memname">unsigned int lutok::do_file </td>
158*132f818dSEnji Cooper          <td>(</td>
159*132f818dSEnji Cooper          <td class="paramtype"><a class="el" href="a00919.html">state</a> &amp;&#160;</td>
160*132f818dSEnji Cooper          <td class="paramname"><em>s</em>, </td>
161*132f818dSEnji Cooper        </tr>
162*132f818dSEnji Cooper        <tr>
163*132f818dSEnji Cooper          <td class="paramkey"></td>
164*132f818dSEnji Cooper          <td></td>
165*132f818dSEnji Cooper          <td class="paramtype">const std::string &amp;&#160;</td>
166*132f818dSEnji Cooper          <td class="paramname"><em>file</em>, </td>
167*132f818dSEnji Cooper        </tr>
168*132f818dSEnji Cooper        <tr>
169*132f818dSEnji Cooper          <td class="paramkey"></td>
170*132f818dSEnji Cooper          <td></td>
171*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
172*132f818dSEnji Cooper          <td class="paramname"><em>nargs</em>, </td>
173*132f818dSEnji Cooper        </tr>
174*132f818dSEnji Cooper        <tr>
175*132f818dSEnji Cooper          <td class="paramkey"></td>
176*132f818dSEnji Cooper          <td></td>
177*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
178*132f818dSEnji Cooper          <td class="paramname"><em>nresults</em>, </td>
179*132f818dSEnji Cooper        </tr>
180*132f818dSEnji Cooper        <tr>
181*132f818dSEnji Cooper          <td class="paramkey"></td>
182*132f818dSEnji Cooper          <td></td>
183*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
184*132f818dSEnji Cooper          <td class="paramname"><em>errfunc</em>&#160;</td>
185*132f818dSEnji Cooper        </tr>
186*132f818dSEnji Cooper        <tr>
187*132f818dSEnji Cooper          <td></td>
188*132f818dSEnji Cooper          <td>)</td>
189*132f818dSEnji Cooper          <td></td><td></td>
190*132f818dSEnji Cooper        </tr>
191*132f818dSEnji Cooper      </table>
192*132f818dSEnji Cooper</div><div class="memdoc">
193*132f818dSEnji Cooper
194*132f818dSEnji Cooper<p>Loads and processes a Lua file. </p>
195*132f818dSEnji Cooper<p>This is a replacement for luaL_dofile but with proper error reporting and stack control.</p>
196*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
197*132f818dSEnji Cooper  <table class="params">
198*132f818dSEnji Cooper    <tr><td class="paramname">s</td><td>The Lua state. </td></tr>
199*132f818dSEnji Cooper    <tr><td class="paramname">file</td><td>The file to load. </td></tr>
200*132f818dSEnji Cooper    <tr><td class="paramname">nargs</td><td>The number of arguments on the stack to pass to the file. </td></tr>
201*132f818dSEnji Cooper    <tr><td class="paramname">nresults</td><td>The number of results to expect; -1 for any. </td></tr>
202*132f818dSEnji Cooper    <tr><td class="paramname">errfunc</td><td>If not 0, index of a function in the stack to act as an error handler.</td></tr>
203*132f818dSEnji Cooper  </table>
204*132f818dSEnji Cooper  </dd>
205*132f818dSEnji Cooper</dl>
206*132f818dSEnji Cooper<dl class="section return"><dt>Returns</dt><dd>The number of results left on the stack.</dd></dl>
207*132f818dSEnji Cooper<dl class="exception"><dt>Exceptions</dt><dd>
208*132f818dSEnji Cooper  <table class="exception">
209*132f818dSEnji Cooper    <tr><td class="paramname">error</td><td>If there is a problem processing the file. </td></tr>
210*132f818dSEnji Cooper  </table>
211*132f818dSEnji Cooper  </dd>
212*132f818dSEnji Cooper</dl>
213*132f818dSEnji Cooper
214*132f818dSEnji Cooper</div>
215*132f818dSEnji Cooper</div>
216*132f818dSEnji Cooper<a id="acfcec30028e0795a0a722aa18ee7909d" name="acfcec30028e0795a0a722aa18ee7909d"></a>
217*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#acfcec30028e0795a0a722aa18ee7909d">&#9670;&#160;</a></span>do_string()</h2>
218*132f818dSEnji Cooper
219*132f818dSEnji Cooper<div class="memitem">
220*132f818dSEnji Cooper<div class="memproto">
221*132f818dSEnji Cooper      <table class="memname">
222*132f818dSEnji Cooper        <tr>
223*132f818dSEnji Cooper          <td class="memname">unsigned int lutok::do_string </td>
224*132f818dSEnji Cooper          <td>(</td>
225*132f818dSEnji Cooper          <td class="paramtype"><a class="el" href="a00919.html">state</a> &amp;&#160;</td>
226*132f818dSEnji Cooper          <td class="paramname"><em>s</em>, </td>
227*132f818dSEnji Cooper        </tr>
228*132f818dSEnji Cooper        <tr>
229*132f818dSEnji Cooper          <td class="paramkey"></td>
230*132f818dSEnji Cooper          <td></td>
231*132f818dSEnji Cooper          <td class="paramtype">const std::string &amp;&#160;</td>
232*132f818dSEnji Cooper          <td class="paramname"><em>str</em>, </td>
233*132f818dSEnji Cooper        </tr>
234*132f818dSEnji Cooper        <tr>
235*132f818dSEnji Cooper          <td class="paramkey"></td>
236*132f818dSEnji Cooper          <td></td>
237*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
238*132f818dSEnji Cooper          <td class="paramname"><em>nargs</em>, </td>
239*132f818dSEnji Cooper        </tr>
240*132f818dSEnji Cooper        <tr>
241*132f818dSEnji Cooper          <td class="paramkey"></td>
242*132f818dSEnji Cooper          <td></td>
243*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
244*132f818dSEnji Cooper          <td class="paramname"><em>nresults</em>, </td>
245*132f818dSEnji Cooper        </tr>
246*132f818dSEnji Cooper        <tr>
247*132f818dSEnji Cooper          <td class="paramkey"></td>
248*132f818dSEnji Cooper          <td></td>
249*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
250*132f818dSEnji Cooper          <td class="paramname"><em>errfunc</em>&#160;</td>
251*132f818dSEnji Cooper        </tr>
252*132f818dSEnji Cooper        <tr>
253*132f818dSEnji Cooper          <td></td>
254*132f818dSEnji Cooper          <td>)</td>
255*132f818dSEnji Cooper          <td></td><td></td>
256*132f818dSEnji Cooper        </tr>
257*132f818dSEnji Cooper      </table>
258*132f818dSEnji Cooper</div><div class="memdoc">
259*132f818dSEnji Cooper
260*132f818dSEnji Cooper<p>Processes a Lua script. </p>
261*132f818dSEnji Cooper<p>This is a replacement for luaL_dostring but with proper error reporting and stack control.</p>
262*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
263*132f818dSEnji Cooper  <table class="params">
264*132f818dSEnji Cooper    <tr><td class="paramname">s</td><td>The Lua state. </td></tr>
265*132f818dSEnji Cooper    <tr><td class="paramname">str</td><td>The string to process. </td></tr>
266*132f818dSEnji Cooper    <tr><td class="paramname">nargs</td><td>The number of arguments on the stack to pass to the chunk. </td></tr>
267*132f818dSEnji Cooper    <tr><td class="paramname">nresults</td><td>The number of results to expect; -1 for any. </td></tr>
268*132f818dSEnji Cooper    <tr><td class="paramname">errfunc</td><td>If not 0, index of a function in the stack to act as an error handler.</td></tr>
269*132f818dSEnji Cooper  </table>
270*132f818dSEnji Cooper  </dd>
271*132f818dSEnji Cooper</dl>
272*132f818dSEnji Cooper<dl class="section return"><dt>Returns</dt><dd>The number of results left on the stack.</dd></dl>
273*132f818dSEnji Cooper<dl class="exception"><dt>Exceptions</dt><dd>
274*132f818dSEnji Cooper  <table class="exception">
275*132f818dSEnji Cooper    <tr><td class="paramname">error</td><td>If there is a problem processing the string. </td></tr>
276*132f818dSEnji Cooper  </table>
277*132f818dSEnji Cooper  </dd>
278*132f818dSEnji Cooper</dl>
279*132f818dSEnji Cooper
280*132f818dSEnji Cooper</div>
281*132f818dSEnji Cooper</div>
282*132f818dSEnji Cooper<a id="a9d58b8708faaae18051c4ef4b707c84b" name="a9d58b8708faaae18051c4ef4b707c84b"></a>
283*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a9d58b8708faaae18051c4ef4b707c84b">&#9670;&#160;</a></span>eval()</h2>
284*132f818dSEnji Cooper
285*132f818dSEnji Cooper<div class="memitem">
286*132f818dSEnji Cooper<div class="memproto">
287*132f818dSEnji Cooper      <table class="memname">
288*132f818dSEnji Cooper        <tr>
289*132f818dSEnji Cooper          <td class="memname">void lutok::eval </td>
290*132f818dSEnji Cooper          <td>(</td>
291*132f818dSEnji Cooper          <td class="paramtype"><a class="el" href="a00919.html">state</a> &amp;&#160;</td>
292*132f818dSEnji Cooper          <td class="paramname"><em>s</em>, </td>
293*132f818dSEnji Cooper        </tr>
294*132f818dSEnji Cooper        <tr>
295*132f818dSEnji Cooper          <td class="paramkey"></td>
296*132f818dSEnji Cooper          <td></td>
297*132f818dSEnji Cooper          <td class="paramtype">const std::string &amp;&#160;</td>
298*132f818dSEnji Cooper          <td class="paramname"><em>expression</em>, </td>
299*132f818dSEnji Cooper        </tr>
300*132f818dSEnji Cooper        <tr>
301*132f818dSEnji Cooper          <td class="paramkey"></td>
302*132f818dSEnji Cooper          <td></td>
303*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
304*132f818dSEnji Cooper          <td class="paramname"><em>nresults</em>&#160;</td>
305*132f818dSEnji Cooper        </tr>
306*132f818dSEnji Cooper        <tr>
307*132f818dSEnji Cooper          <td></td>
308*132f818dSEnji Cooper          <td>)</td>
309*132f818dSEnji Cooper          <td></td><td></td>
310*132f818dSEnji Cooper        </tr>
311*132f818dSEnji Cooper      </table>
312*132f818dSEnji Cooper</div><div class="memdoc">
313*132f818dSEnji Cooper
314*132f818dSEnji Cooper<p>Convenience function to evaluate a Lua expression. </p>
315*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
316*132f818dSEnji Cooper  <table class="params">
317*132f818dSEnji Cooper    <tr><td class="paramname">s</td><td>The Lua state. </td></tr>
318*132f818dSEnji Cooper    <tr><td class="paramname">expression</td><td>The textual expression to evaluate. </td></tr>
319*132f818dSEnji Cooper    <tr><td class="paramname">nresults</td><td>The number of results to leave on the stack. Must be positive.</td></tr>
320*132f818dSEnji Cooper  </table>
321*132f818dSEnji Cooper  </dd>
322*132f818dSEnji Cooper</dl>
323*132f818dSEnji Cooper<dl class="exception"><dt>Exceptions</dt><dd>
324*132f818dSEnji Cooper  <table class="exception">
325*132f818dSEnji Cooper    <tr><td class="paramname">api_error</td><td>If there is a problem evaluating the expression. </td></tr>
326*132f818dSEnji Cooper  </table>
327*132f818dSEnji Cooper  </dd>
328*132f818dSEnji Cooper</dl>
329*132f818dSEnji Cooper
330*132f818dSEnji Cooper</div>
331*132f818dSEnji Cooper</div>
332*132f818dSEnji Cooper</div><!-- contents -->
333*132f818dSEnji Cooper<!-- start footer part -->
334*132f818dSEnji Cooper<hr class="footer"/><address class="footer"><small>
335*132f818dSEnji CooperGenerated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
336*132f818dSEnji Cooper</small></address>
337*132f818dSEnji Cooper</body>
338*132f818dSEnji Cooper</html>
339