xref: /freebsd/contrib/lutok/api-docs/html/a00919.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: lutok::state Class 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 id="nav-path" class="navpath">
71*132f818dSEnji Cooper  <ul>
72*132f818dSEnji Cooper<li class="navelem"><b>lutok</b></li><li class="navelem"><a class="el" href="a00919.html">state</a></li>  </ul>
73*132f818dSEnji Cooper</div>
74*132f818dSEnji Cooper</div><!-- top -->
75*132f818dSEnji Cooper<div class="header">
76*132f818dSEnji Cooper  <div class="summary">
77*132f818dSEnji Cooper<a href="#nested-classes">Classes</a> &#124;
78*132f818dSEnji Cooper<a href="#pub-methods">Public Member Functions</a> &#124;
79*132f818dSEnji Cooper<a href="#pri-methods">Private Member Functions</a> &#124;
80*132f818dSEnji Cooper<a href="#pri-attribs">Private Attributes</a> &#124;
81*132f818dSEnji Cooper<a href="#friends">Friends</a> &#124;
82*132f818dSEnji Cooper<a href="a00916.html">List of all members</a>  </div>
83*132f818dSEnji Cooper  <div class="headertitle"><div class="title">lutok::state Class Reference</div></div>
84*132f818dSEnji Cooper</div><!--header-->
85*132f818dSEnji Cooper<div class="contents">
86*132f818dSEnji Cooper
87*132f818dSEnji Cooper<p>A RAII model for the Lua state.
88*132f818dSEnji Cooper <a href="a00919.html#details">More...</a></p>
89*132f818dSEnji Cooper
90*132f818dSEnji Cooper<p><code>#include &lt;<a class="el" href="a00029_source.html">state.hpp</a>&gt;</code></p>
91*132f818dSEnji Cooper<table class="memberdecls">
92*132f818dSEnji Cooper<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
93*132f818dSEnji CooperClasses</h2></td></tr>
94*132f818dSEnji Cooper<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00915.html">impl</a></td></tr>
95*132f818dSEnji Cooper<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal implementation for <a class="el" href="a00919.html" title="A RAII model for the Lua state.">lutok::state</a>.  <a href="a00915.html#details">More...</a><br /></td></tr>
96*132f818dSEnji Cooper<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
97*132f818dSEnji Cooper</table><table class="memberdecls">
98*132f818dSEnji Cooper<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
99*132f818dSEnji CooperPublic Member Functions</h2></td></tr>
100*132f818dSEnji Cooper<tr class="memitem:ae952d08c75d4d07eef07fc00a608c4b4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#ae952d08c75d4d07eef07fc00a608c4b4">state</a> (void)</td></tr>
101*132f818dSEnji Cooper<tr class="memdesc:ae952d08c75d4d07eef07fc00a608c4b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the Lua state.  <br /></td></tr>
102*132f818dSEnji Cooper<tr class="separator:ae952d08c75d4d07eef07fc00a608c4b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
103*132f818dSEnji Cooper<tr class="memitem:a2b163a6db54c80d3ad1d8d324e7e7fe1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#a2b163a6db54c80d3ad1d8d324e7e7fe1">~state</a> (void)</td></tr>
104*132f818dSEnji Cooper<tr class="memdesc:a2b163a6db54c80d3ad1d8d324e7e7fe1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor for the Lua state.  <br /></td></tr>
105*132f818dSEnji Cooper<tr class="separator:a2b163a6db54c80d3ad1d8d324e7e7fe1"><td class="memSeparator" colspan="2">&#160;</td></tr>
106*132f818dSEnji Cooper<tr class="memitem:a16c2f95e91f64c5ac89258ee5dcd34e2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#a16c2f95e91f64c5ac89258ee5dcd34e2">close</a> (void)</td></tr>
107*132f818dSEnji Cooper<tr class="memdesc:a16c2f95e91f64c5ac89258ee5dcd34e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Terminates this Lua session.  <br /></td></tr>
108*132f818dSEnji Cooper<tr class="separator:a16c2f95e91f64c5ac89258ee5dcd34e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
109*132f818dSEnji Cooper<tr class="memitem:a0291a3b34c5bed860d8d53e54eaee349"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#a0291a3b34c5bed860d8d53e54eaee349">get_global</a> (const std::string &amp;)</td></tr>
110*132f818dSEnji Cooper<tr class="memdesc:a0291a3b34c5bed860d8d53e54eaee349"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_getglobal.  <br /></td></tr>
111*132f818dSEnji Cooper<tr class="separator:a0291a3b34c5bed860d8d53e54eaee349"><td class="memSeparator" colspan="2">&#160;</td></tr>
112*132f818dSEnji Cooper<tr class="memitem:a2287f1dd03e6a72837ab020512927ee6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#a2287f1dd03e6a72837ab020512927ee6">get_global_table</a> (void)</td></tr>
113*132f818dSEnji Cooper<tr class="memdesc:a2287f1dd03e6a72837ab020512927ee6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pushes a reference to the global table onto the stack.  <br /></td></tr>
114*132f818dSEnji Cooper<tr class="separator:a2287f1dd03e6a72837ab020512927ee6"><td class="memSeparator" colspan="2">&#160;</td></tr>
115*132f818dSEnji Cooper<tr class="memitem:a0d4f5204547cac3e4855e375f6bc64cb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#a0d4f5204547cac3e4855e375f6bc64cb">get_metafield</a> (const int, const std::string &amp;)</td></tr>
116*132f818dSEnji Cooper<tr class="memdesc:a0d4f5204547cac3e4855e375f6bc64cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around luaL_getmetafield.  <br /></td></tr>
117*132f818dSEnji Cooper<tr class="separator:a0d4f5204547cac3e4855e375f6bc64cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
118*132f818dSEnji Cooper<tr class="memitem:abbbafa23bb49ccc04e0f32f47b629ae5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#abbbafa23bb49ccc04e0f32f47b629ae5">get_metatable</a> (const int)</td></tr>
119*132f818dSEnji Cooper<tr class="memdesc:abbbafa23bb49ccc04e0f32f47b629ae5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_getmetatable.  <br /></td></tr>
120*132f818dSEnji Cooper<tr class="separator:abbbafa23bb49ccc04e0f32f47b629ae5"><td class="memSeparator" colspan="2">&#160;</td></tr>
121*132f818dSEnji Cooper<tr class="memitem:a8865c4d7ee8a5d9f9ffeff22b8819648"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#a8865c4d7ee8a5d9f9ffeff22b8819648">get_table</a> (const int)</td></tr>
122*132f818dSEnji Cooper<tr class="memdesc:a8865c4d7ee8a5d9f9ffeff22b8819648"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_gettable.  <br /></td></tr>
123*132f818dSEnji Cooper<tr class="separator:a8865c4d7ee8a5d9f9ffeff22b8819648"><td class="memSeparator" colspan="2">&#160;</td></tr>
124*132f818dSEnji Cooper<tr class="memitem:af8591bfdccb2e8732c147a8a6623b2e5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#af8591bfdccb2e8732c147a8a6623b2e5">get_top</a> (void)</td></tr>
125*132f818dSEnji Cooper<tr class="memdesc:af8591bfdccb2e8732c147a8a6623b2e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_gettop.  <br /></td></tr>
126*132f818dSEnji Cooper<tr class="separator:af8591bfdccb2e8732c147a8a6623b2e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
127*132f818dSEnji Cooper<tr class="memitem:a69d7e97f6140c24382fbfd05aa16ad72"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#a69d7e97f6140c24382fbfd05aa16ad72">insert</a> (const int)</td></tr>
128*132f818dSEnji Cooper<tr class="memdesc:a69d7e97f6140c24382fbfd05aa16ad72"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_insert.  <br /></td></tr>
129*132f818dSEnji Cooper<tr class="separator:a69d7e97f6140c24382fbfd05aa16ad72"><td class="memSeparator" colspan="2">&#160;</td></tr>
130*132f818dSEnji Cooper<tr class="memitem:a4efb903445d053766fe54800d36d4deb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#a4efb903445d053766fe54800d36d4deb">is_boolean</a> (const int)</td></tr>
131*132f818dSEnji Cooper<tr class="memdesc:a4efb903445d053766fe54800d36d4deb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_isboolean.  <br /></td></tr>
132*132f818dSEnji Cooper<tr class="separator:a4efb903445d053766fe54800d36d4deb"><td class="memSeparator" colspan="2">&#160;</td></tr>
133*132f818dSEnji Cooper<tr class="memitem:ab454ca52fec8413fde1d46df003c19c0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#ab454ca52fec8413fde1d46df003c19c0">is_function</a> (const int)</td></tr>
134*132f818dSEnji Cooper<tr class="memdesc:ab454ca52fec8413fde1d46df003c19c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_isfunction.  <br /></td></tr>
135*132f818dSEnji Cooper<tr class="separator:ab454ca52fec8413fde1d46df003c19c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
136*132f818dSEnji Cooper<tr class="memitem:a21c5f4f63cf89db0f16dd032f0612a78"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#a21c5f4f63cf89db0f16dd032f0612a78">is_nil</a> (const int)</td></tr>
137*132f818dSEnji Cooper<tr class="memdesc:a21c5f4f63cf89db0f16dd032f0612a78"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_isnil.  <br /></td></tr>
138*132f818dSEnji Cooper<tr class="separator:a21c5f4f63cf89db0f16dd032f0612a78"><td class="memSeparator" colspan="2">&#160;</td></tr>
139*132f818dSEnji Cooper<tr class="memitem:acd31e0953ee71c94903e5444bf451eb1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#acd31e0953ee71c94903e5444bf451eb1">is_number</a> (const int)</td></tr>
140*132f818dSEnji Cooper<tr class="memdesc:acd31e0953ee71c94903e5444bf451eb1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_isnumber.  <br /></td></tr>
141*132f818dSEnji Cooper<tr class="separator:acd31e0953ee71c94903e5444bf451eb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
142*132f818dSEnji Cooper<tr class="memitem:af82c354bbcedaa5f7b2f8b8e6f6c69b5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#af82c354bbcedaa5f7b2f8b8e6f6c69b5">is_string</a> (const int)</td></tr>
143*132f818dSEnji Cooper<tr class="memdesc:af82c354bbcedaa5f7b2f8b8e6f6c69b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_isstring.  <br /></td></tr>
144*132f818dSEnji Cooper<tr class="separator:af82c354bbcedaa5f7b2f8b8e6f6c69b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
145*132f818dSEnji Cooper<tr class="memitem:a468113870c8129430cbd773f5abb85fa"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#a468113870c8129430cbd773f5abb85fa">is_table</a> (const int)</td></tr>
146*132f818dSEnji Cooper<tr class="memdesc:a468113870c8129430cbd773f5abb85fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_istable.  <br /></td></tr>
147*132f818dSEnji Cooper<tr class="separator:a468113870c8129430cbd773f5abb85fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
148*132f818dSEnji Cooper<tr class="memitem:adea141de47b0e6895e8ee9afe5c82a0e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#adea141de47b0e6895e8ee9afe5c82a0e">is_userdata</a> (const int)</td></tr>
149*132f818dSEnji Cooper<tr class="memdesc:adea141de47b0e6895e8ee9afe5c82a0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_isuserdata.  <br /></td></tr>
150*132f818dSEnji Cooper<tr class="separator:adea141de47b0e6895e8ee9afe5c82a0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
151*132f818dSEnji Cooper<tr class="memitem:a493b3192ade9e2f32940b96fa9ef461b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#a493b3192ade9e2f32940b96fa9ef461b">load_file</a> (const std::string &amp;)</td></tr>
152*132f818dSEnji Cooper<tr class="memdesc:a493b3192ade9e2f32940b96fa9ef461b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around luaL_loadfile.  <br /></td></tr>
153*132f818dSEnji Cooper<tr class="separator:a493b3192ade9e2f32940b96fa9ef461b"><td class="memSeparator" colspan="2">&#160;</td></tr>
154*132f818dSEnji Cooper<tr class="memitem:a5ff9ef96d82c9cc497a8dfc1404a1c82"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#a5ff9ef96d82c9cc497a8dfc1404a1c82">load_string</a> (const std::string &amp;)</td></tr>
155*132f818dSEnji Cooper<tr class="memdesc:a5ff9ef96d82c9cc497a8dfc1404a1c82"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around luaL_loadstring.  <br /></td></tr>
156*132f818dSEnji Cooper<tr class="separator:a5ff9ef96d82c9cc497a8dfc1404a1c82"><td class="memSeparator" colspan="2">&#160;</td></tr>
157*132f818dSEnji Cooper<tr class="memitem:a50d389a2c6d23214eda1e46e15ed20b5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#a50d389a2c6d23214eda1e46e15ed20b5">new_table</a> (void)</td></tr>
158*132f818dSEnji Cooper<tr class="memdesc:a50d389a2c6d23214eda1e46e15ed20b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_newtable.  <br /></td></tr>
159*132f818dSEnji Cooper<tr class="separator:a50d389a2c6d23214eda1e46e15ed20b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
160*132f818dSEnji Cooper<tr class="memitem:aaec7e57d4434f087cef8d38a221ae474"><td class="memTemplParams" colspan="2">template&lt;typename Type &gt; </td></tr>
161*132f818dSEnji Cooper<tr class="memitem:aaec7e57d4434f087cef8d38a221ae474"><td class="memTemplItemLeft" align="right" valign="top">Type *&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00919.html#aaec7e57d4434f087cef8d38a221ae474">new_userdata</a> (void)</td></tr>
162*132f818dSEnji Cooper<tr class="memdesc:aaec7e57d4434f087cef8d38a221ae474"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_newuserdata.  <br /></td></tr>
163*132f818dSEnji Cooper<tr class="separator:aaec7e57d4434f087cef8d38a221ae474"><td class="memSeparator" colspan="2">&#160;</td></tr>
164*132f818dSEnji Cooper<tr class="memitem:abbbcf3c19d7d29594ea2e61ece52b815"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#abbbcf3c19d7d29594ea2e61ece52b815">next</a> (const int)</td></tr>
165*132f818dSEnji Cooper<tr class="memdesc:abbbcf3c19d7d29594ea2e61ece52b815"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_next.  <br /></td></tr>
166*132f818dSEnji Cooper<tr class="separator:abbbcf3c19d7d29594ea2e61ece52b815"><td class="memSeparator" colspan="2">&#160;</td></tr>
167*132f818dSEnji Cooper<tr class="memitem:a940ebd0fb37259360a63b7a669d8ca99"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#a940ebd0fb37259360a63b7a669d8ca99">open_all</a> (void)</td></tr>
168*132f818dSEnji Cooper<tr class="memdesc:a940ebd0fb37259360a63b7a669d8ca99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around luaL_openlibs.  <br /></td></tr>
169*132f818dSEnji Cooper<tr class="separator:a940ebd0fb37259360a63b7a669d8ca99"><td class="memSeparator" colspan="2">&#160;</td></tr>
170*132f818dSEnji Cooper<tr class="memitem:abf68c04d96308868fec71a628741c712"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#abf68c04d96308868fec71a628741c712">open_base</a> (void)</td></tr>
171*132f818dSEnji Cooper<tr class="memdesc:abf68c04d96308868fec71a628741c712"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around luaopen_base.  <br /></td></tr>
172*132f818dSEnji Cooper<tr class="separator:abf68c04d96308868fec71a628741c712"><td class="memSeparator" colspan="2">&#160;</td></tr>
173*132f818dSEnji Cooper<tr class="memitem:a85db3b50e195e6ab7e81f9f51205d8c0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#a85db3b50e195e6ab7e81f9f51205d8c0">open_string</a> (void)</td></tr>
174*132f818dSEnji Cooper<tr class="memdesc:a85db3b50e195e6ab7e81f9f51205d8c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around luaopen_string.  <br /></td></tr>
175*132f818dSEnji Cooper<tr class="separator:a85db3b50e195e6ab7e81f9f51205d8c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
176*132f818dSEnji Cooper<tr class="memitem:a8898b62799b3b8a70a2b6a049e531515"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#a8898b62799b3b8a70a2b6a049e531515">open_table</a> (void)</td></tr>
177*132f818dSEnji Cooper<tr class="memdesc:a8898b62799b3b8a70a2b6a049e531515"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around luaopen_table.  <br /></td></tr>
178*132f818dSEnji Cooper<tr class="separator:a8898b62799b3b8a70a2b6a049e531515"><td class="memSeparator" colspan="2">&#160;</td></tr>
179*132f818dSEnji Cooper<tr class="memitem:a307897e3501a5b5b08eb66f35f4d18df"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#a307897e3501a5b5b08eb66f35f4d18df">pcall</a> (const int, const int, const int)</td></tr>
180*132f818dSEnji Cooper<tr class="memdesc:a307897e3501a5b5b08eb66f35f4d18df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_pcall.  <br /></td></tr>
181*132f818dSEnji Cooper<tr class="separator:a307897e3501a5b5b08eb66f35f4d18df"><td class="memSeparator" colspan="2">&#160;</td></tr>
182*132f818dSEnji Cooper<tr class="memitem:ac07258b143ef607dd9f6a9e24e495c20"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#ac07258b143ef607dd9f6a9e24e495c20">pop</a> (const int)</td></tr>
183*132f818dSEnji Cooper<tr class="memdesc:ac07258b143ef607dd9f6a9e24e495c20"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_pop.  <br /></td></tr>
184*132f818dSEnji Cooper<tr class="separator:ac07258b143ef607dd9f6a9e24e495c20"><td class="memSeparator" colspan="2">&#160;</td></tr>
185*132f818dSEnji Cooper<tr class="memitem:a11e9a3235154ebf867298935f1f58ca5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#a11e9a3235154ebf867298935f1f58ca5">push_boolean</a> (const bool)</td></tr>
186*132f818dSEnji Cooper<tr class="memdesc:a11e9a3235154ebf867298935f1f58ca5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_pushboolean.  <br /></td></tr>
187*132f818dSEnji Cooper<tr class="separator:a11e9a3235154ebf867298935f1f58ca5"><td class="memSeparator" colspan="2">&#160;</td></tr>
188*132f818dSEnji Cooper<tr class="memitem:a0e5b1b04d7bdf606a7b013b83de433d1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#a0e5b1b04d7bdf606a7b013b83de433d1">push_cxx_closure</a> (<a class="el" href="a00029.html#a8c623ca426c30c5fab4df2cb21635f17">cxx_function</a>, const int)</td></tr>
189*132f818dSEnji Cooper<tr class="memdesc:a0e5b1b04d7bdf606a7b013b83de433d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_pushcclosure.  <br /></td></tr>
190*132f818dSEnji Cooper<tr class="separator:a0e5b1b04d7bdf606a7b013b83de433d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
191*132f818dSEnji Cooper<tr class="memitem:ae894e01dd1ff748aaf3f1a657363fe02"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#ae894e01dd1ff748aaf3f1a657363fe02">push_cxx_function</a> (<a class="el" href="a00029.html#a8c623ca426c30c5fab4df2cb21635f17">cxx_function</a>)</td></tr>
192*132f818dSEnji Cooper<tr class="memdesc:ae894e01dd1ff748aaf3f1a657363fe02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_pushcfunction.  <br /></td></tr>
193*132f818dSEnji Cooper<tr class="separator:ae894e01dd1ff748aaf3f1a657363fe02"><td class="memSeparator" colspan="2">&#160;</td></tr>
194*132f818dSEnji Cooper<tr class="memitem:a5c5b08f88a143cb48a600c044e2e3a56"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#a5c5b08f88a143cb48a600c044e2e3a56">push_integer</a> (const int)</td></tr>
195*132f818dSEnji Cooper<tr class="memdesc:a5c5b08f88a143cb48a600c044e2e3a56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_pushinteger.  <br /></td></tr>
196*132f818dSEnji Cooper<tr class="separator:a5c5b08f88a143cb48a600c044e2e3a56"><td class="memSeparator" colspan="2">&#160;</td></tr>
197*132f818dSEnji Cooper<tr class="memitem:a7e1219378038bf40f72533dd14946f63"><td class="memItemLeft" align="right" valign="top"><a id="a7e1219378038bf40f72533dd14946f63" name="a7e1219378038bf40f72533dd14946f63"></a>
198*132f818dSEnji Coopervoid&#160;</td><td class="memItemRight" valign="bottom"><b>push_nil</b> (void)</td></tr>
199*132f818dSEnji Cooper<tr class="memdesc:a7e1219378038bf40f72533dd14946f63"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_pushnil. <br /></td></tr>
200*132f818dSEnji Cooper<tr class="separator:a7e1219378038bf40f72533dd14946f63"><td class="memSeparator" colspan="2">&#160;</td></tr>
201*132f818dSEnji Cooper<tr class="memitem:a90859ee0fb17b13c3ebf4dfbfbee8c15"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#a90859ee0fb17b13c3ebf4dfbfbee8c15">push_string</a> (const std::string &amp;)</td></tr>
202*132f818dSEnji Cooper<tr class="memdesc:a90859ee0fb17b13c3ebf4dfbfbee8c15"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_pushstring.  <br /></td></tr>
203*132f818dSEnji Cooper<tr class="separator:a90859ee0fb17b13c3ebf4dfbfbee8c15"><td class="memSeparator" colspan="2">&#160;</td></tr>
204*132f818dSEnji Cooper<tr class="memitem:a48d4552a0e81c350b6ea1077018fc3fe"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#a48d4552a0e81c350b6ea1077018fc3fe">push_value</a> (const int)</td></tr>
205*132f818dSEnji Cooper<tr class="memdesc:a48d4552a0e81c350b6ea1077018fc3fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_pushvalue.  <br /></td></tr>
206*132f818dSEnji Cooper<tr class="separator:a48d4552a0e81c350b6ea1077018fc3fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
207*132f818dSEnji Cooper<tr class="memitem:ad67d44dd8d7273cfce233731ad8f10d7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#ad67d44dd8d7273cfce233731ad8f10d7">raw_get</a> (const int)</td></tr>
208*132f818dSEnji Cooper<tr class="memdesc:ad67d44dd8d7273cfce233731ad8f10d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_rawget.  <br /></td></tr>
209*132f818dSEnji Cooper<tr class="separator:ad67d44dd8d7273cfce233731ad8f10d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
210*132f818dSEnji Cooper<tr class="memitem:aa81b48420e6749c8f957af9039df0b37"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#aa81b48420e6749c8f957af9039df0b37">raw_set</a> (const int)</td></tr>
211*132f818dSEnji Cooper<tr class="memdesc:aa81b48420e6749c8f957af9039df0b37"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_rawset.  <br /></td></tr>
212*132f818dSEnji Cooper<tr class="separator:aa81b48420e6749c8f957af9039df0b37"><td class="memSeparator" colspan="2">&#160;</td></tr>
213*132f818dSEnji Cooper<tr class="memitem:ae8b4f75bb99611707739772417c36e5a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#ae8b4f75bb99611707739772417c36e5a">set_global</a> (const std::string &amp;)</td></tr>
214*132f818dSEnji Cooper<tr class="memdesc:ae8b4f75bb99611707739772417c36e5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_setglobal.  <br /></td></tr>
215*132f818dSEnji Cooper<tr class="separator:ae8b4f75bb99611707739772417c36e5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
216*132f818dSEnji Cooper<tr class="memitem:a9873b4860342a745a832f514ab803909"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#a9873b4860342a745a832f514ab803909">set_metatable</a> (const int)</td></tr>
217*132f818dSEnji Cooper<tr class="memdesc:a9873b4860342a745a832f514ab803909"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_setmetatable.  <br /></td></tr>
218*132f818dSEnji Cooper<tr class="separator:a9873b4860342a745a832f514ab803909"><td class="memSeparator" colspan="2">&#160;</td></tr>
219*132f818dSEnji Cooper<tr class="memitem:ac2467d43a04babb717b4d6d384cf074c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#ac2467d43a04babb717b4d6d384cf074c">set_table</a> (const int)</td></tr>
220*132f818dSEnji Cooper<tr class="memdesc:ac2467d43a04babb717b4d6d384cf074c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_settable.  <br /></td></tr>
221*132f818dSEnji Cooper<tr class="separator:ac2467d43a04babb717b4d6d384cf074c"><td class="memSeparator" colspan="2">&#160;</td></tr>
222*132f818dSEnji Cooper<tr class="memitem:a32129410bd9c2cd170d60919d203a639"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#a32129410bd9c2cd170d60919d203a639">to_boolean</a> (const int)</td></tr>
223*132f818dSEnji Cooper<tr class="memdesc:a32129410bd9c2cd170d60919d203a639"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_toboolean.  <br /></td></tr>
224*132f818dSEnji Cooper<tr class="separator:a32129410bd9c2cd170d60919d203a639"><td class="memSeparator" colspan="2">&#160;</td></tr>
225*132f818dSEnji Cooper<tr class="memitem:ad947a5fb78835427838e4e10b16cc34a"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#ad947a5fb78835427838e4e10b16cc34a">to_integer</a> (const int)</td></tr>
226*132f818dSEnji Cooper<tr class="memdesc:ad947a5fb78835427838e4e10b16cc34a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_tointeger.  <br /></td></tr>
227*132f818dSEnji Cooper<tr class="separator:ad947a5fb78835427838e4e10b16cc34a"><td class="memSeparator" colspan="2">&#160;</td></tr>
228*132f818dSEnji Cooper<tr class="memitem:a0d7c94591101c42e93726ef7999eb11d"><td class="memTemplParams" colspan="2">template&lt;typename Type &gt; </td></tr>
229*132f818dSEnji Cooper<tr class="memitem:a0d7c94591101c42e93726ef7999eb11d"><td class="memTemplItemLeft" align="right" valign="top">Type *&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00919.html#a0d7c94591101c42e93726ef7999eb11d">to_userdata</a> (const int)</td></tr>
230*132f818dSEnji Cooper<tr class="memdesc:a0d7c94591101c42e93726ef7999eb11d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_touserdata.  <br /></td></tr>
231*132f818dSEnji Cooper<tr class="separator:a0d7c94591101c42e93726ef7999eb11d"><td class="memSeparator" colspan="2">&#160;</td></tr>
232*132f818dSEnji Cooper<tr class="memitem:aa40dd851d1e2323c55356506922e7b60"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#aa40dd851d1e2323c55356506922e7b60">to_string</a> (const int)</td></tr>
233*132f818dSEnji Cooper<tr class="memdesc:aa40dd851d1e2323c55356506922e7b60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_tostring.  <br /></td></tr>
234*132f818dSEnji Cooper<tr class="separator:aa40dd851d1e2323c55356506922e7b60"><td class="memSeparator" colspan="2">&#160;</td></tr>
235*132f818dSEnji Cooper<tr class="memitem:a1210a0875bde2a0452dd4813573b8865"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#a1210a0875bde2a0452dd4813573b8865">upvalue_index</a> (const int)</td></tr>
236*132f818dSEnji Cooper<tr class="memdesc:a1210a0875bde2a0452dd4813573b8865"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_upvalueindex.  <br /></td></tr>
237*132f818dSEnji Cooper<tr class="separator:a1210a0875bde2a0452dd4813573b8865"><td class="memSeparator" colspan="2">&#160;</td></tr>
238*132f818dSEnji Cooper</table><table class="memberdecls">
239*132f818dSEnji Cooper<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
240*132f818dSEnji CooperPrivate Member Functions</h2></td></tr>
241*132f818dSEnji Cooper<tr class="memitem:a5f2fa48408831695914e4a57acf85a7c"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#a5f2fa48408831695914e4a57acf85a7c">new_userdata_voidp</a> (const size_t)</td></tr>
242*132f818dSEnji Cooper<tr class="memdesc:a5f2fa48408831695914e4a57acf85a7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_newuserdata.  <br /></td></tr>
243*132f818dSEnji Cooper<tr class="separator:a5f2fa48408831695914e4a57acf85a7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
244*132f818dSEnji Cooper<tr class="memitem:a4054e2df5af0cc5db61c7560637406ea"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#a4054e2df5af0cc5db61c7560637406ea">to_userdata_voidp</a> (const int)</td></tr>
245*132f818dSEnji Cooper<tr class="memdesc:a4054e2df5af0cc5db61c7560637406ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_touserdata.  <br /></td></tr>
246*132f818dSEnji Cooper<tr class="separator:a4054e2df5af0cc5db61c7560637406ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
247*132f818dSEnji Cooper<tr class="memitem:a526b2171768d4d214b6f8f4d0ed2cf1e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#a526b2171768d4d214b6f8f4d0ed2cf1e">state</a> (void *)</td></tr>
248*132f818dSEnji Cooper<tr class="memdesc:a526b2171768d4d214b6f8f4d0ed2cf1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the Lua state from an existing raw state.  <br /></td></tr>
249*132f818dSEnji Cooper<tr class="separator:a526b2171768d4d214b6f8f4d0ed2cf1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
250*132f818dSEnji Cooper<tr class="memitem:a2b577a4a090b67aa5b9b7a3f0762ca18"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html#a2b577a4a090b67aa5b9b7a3f0762ca18">raw_state</a> (void)</td></tr>
251*132f818dSEnji Cooper<tr class="memdesc:a2b577a4a090b67aa5b9b7a3f0762ca18"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the internal lua_State object.  <br /></td></tr>
252*132f818dSEnji Cooper<tr class="separator:a2b577a4a090b67aa5b9b7a3f0762ca18"><td class="memSeparator" colspan="2">&#160;</td></tr>
253*132f818dSEnji Cooper</table><table class="memberdecls">
254*132f818dSEnji Cooper<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
255*132f818dSEnji CooperPrivate Attributes</h2></td></tr>
256*132f818dSEnji Cooper<tr class="memitem:a46953d97b73c00aa13fb98d4f0bb28c5"><td class="memItemLeft" align="right" valign="top"><a id="a46953d97b73c00aa13fb98d4f0bb28c5" name="a46953d97b73c00aa13fb98d4f0bb28c5"></a>
257*132f818dSEnji Cooperstd::shared_ptr&lt; <a class="el" href="a00915.html">impl</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>_pimpl</b></td></tr>
258*132f818dSEnji Cooper<tr class="memdesc:a46953d97b73c00aa13fb98d4f0bb28c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to the shared internal implementation. <br /></td></tr>
259*132f818dSEnji Cooper<tr class="separator:a46953d97b73c00aa13fb98d4f0bb28c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
260*132f818dSEnji Cooper</table><table class="memberdecls">
261*132f818dSEnji Cooper<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
262*132f818dSEnji CooperFriends</h2></td></tr>
263*132f818dSEnji Cooper<tr class="memitem:a1664309d3bb0137c1facd2595acf39e2"><td class="memItemLeft" align="right" valign="top"><a id="a1664309d3bb0137c1facd2595acf39e2" name="a1664309d3bb0137c1facd2595acf39e2"></a>
264*132f818dSEnji Cooperclass&#160;</td><td class="memItemRight" valign="bottom"><b>state_c_gate</b></td></tr>
265*132f818dSEnji Cooper<tr class="separator:a1664309d3bb0137c1facd2595acf39e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
266*132f818dSEnji Cooper</table>
267*132f818dSEnji Cooper<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
268*132f818dSEnji Cooper<div class="textblock"><p>A RAII model for the Lua state. </p>
269*132f818dSEnji Cooper<p>This class holds the state of the Lua interpreter during its existence and provides wrappers around several Lua library functions that operate on such state.</p>
270*132f818dSEnji Cooper<p>These wrapper functions differ from the C versions in that they use the implicit state hold by the class, they use C++ types where appropriate and they use exceptions to report errors.</p>
271*132f818dSEnji Cooper<p>The wrappers intend to be as lightweight as possible but, in some situations, they are pretty complex because they need to do extra work to capture the errors reported by the Lua C API. We prefer having fine-grained error control rather than efficiency, so this is OK. </p>
272*132f818dSEnji Cooper</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
273*132f818dSEnji Cooper<a id="a526b2171768d4d214b6f8f4d0ed2cf1e" name="a526b2171768d4d214b6f8f4d0ed2cf1e"></a>
274*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a526b2171768d4d214b6f8f4d0ed2cf1e">&#9670;&#160;</a></span>state() <span class="overload">[1/2]</span></h2>
275*132f818dSEnji Cooper
276*132f818dSEnji Cooper<div class="memitem">
277*132f818dSEnji Cooper<div class="memproto">
278*132f818dSEnji Cooper<table class="mlabels">
279*132f818dSEnji Cooper  <tr>
280*132f818dSEnji Cooper  <td class="mlabels-left">
281*132f818dSEnji Cooper      <table class="memname">
282*132f818dSEnji Cooper        <tr>
283*132f818dSEnji Cooper          <td class="memname">lutok::state::state </td>
284*132f818dSEnji Cooper          <td>(</td>
285*132f818dSEnji Cooper          <td class="paramtype">void *&#160;</td>
286*132f818dSEnji Cooper          <td class="paramname"><em>raw_state_</em></td><td>)</td>
287*132f818dSEnji Cooper          <td></td>
288*132f818dSEnji Cooper        </tr>
289*132f818dSEnji Cooper      </table>
290*132f818dSEnji Cooper  </td>
291*132f818dSEnji Cooper  <td class="mlabels-right">
292*132f818dSEnji Cooper<span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">private</span></span>  </td>
293*132f818dSEnji Cooper  </tr>
294*132f818dSEnji Cooper</table>
295*132f818dSEnji Cooper</div><div class="memdoc">
296*132f818dSEnji Cooper
297*132f818dSEnji Cooper<p>Initializes the Lua state from an existing raw state. </p>
298*132f818dSEnji Cooper<p>Instances constructed using this method do NOT own the raw state. This means that, on exit, the state will not be destroyed.</p>
299*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
300*132f818dSEnji Cooper  <table class="params">
301*132f818dSEnji Cooper    <tr><td class="paramname">raw_state_</td><td>The raw Lua state to wrap. </td></tr>
302*132f818dSEnji Cooper  </table>
303*132f818dSEnji Cooper  </dd>
304*132f818dSEnji Cooper</dl>
305*132f818dSEnji Cooper
306*132f818dSEnji Cooper</div>
307*132f818dSEnji Cooper</div>
308*132f818dSEnji Cooper<a id="ae952d08c75d4d07eef07fc00a608c4b4" name="ae952d08c75d4d07eef07fc00a608c4b4"></a>
309*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#ae952d08c75d4d07eef07fc00a608c4b4">&#9670;&#160;</a></span>state() <span class="overload">[2/2]</span></h2>
310*132f818dSEnji Cooper
311*132f818dSEnji Cooper<div class="memitem">
312*132f818dSEnji Cooper<div class="memproto">
313*132f818dSEnji Cooper      <table class="memname">
314*132f818dSEnji Cooper        <tr>
315*132f818dSEnji Cooper          <td class="memname">lutok::state::state </td>
316*132f818dSEnji Cooper          <td>(</td>
317*132f818dSEnji Cooper          <td class="paramtype">void&#160;</td>
318*132f818dSEnji Cooper          <td class="paramname"></td><td>)</td>
319*132f818dSEnji Cooper          <td></td>
320*132f818dSEnji Cooper        </tr>
321*132f818dSEnji Cooper      </table>
322*132f818dSEnji Cooper</div><div class="memdoc">
323*132f818dSEnji Cooper
324*132f818dSEnji Cooper<p>Initializes the Lua state. </p>
325*132f818dSEnji Cooper<p>You must share the same state object alongside the lifetime of your Lua session. As soon as the object is destroyed, the session is terminated. </p>
326*132f818dSEnji Cooper
327*132f818dSEnji Cooper</div>
328*132f818dSEnji Cooper</div>
329*132f818dSEnji Cooper<a id="a2b163a6db54c80d3ad1d8d324e7e7fe1" name="a2b163a6db54c80d3ad1d8d324e7e7fe1"></a>
330*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a2b163a6db54c80d3ad1d8d324e7e7fe1">&#9670;&#160;</a></span>~state()</h2>
331*132f818dSEnji Cooper
332*132f818dSEnji Cooper<div class="memitem">
333*132f818dSEnji Cooper<div class="memproto">
334*132f818dSEnji Cooper      <table class="memname">
335*132f818dSEnji Cooper        <tr>
336*132f818dSEnji Cooper          <td class="memname">lutok::state::~state </td>
337*132f818dSEnji Cooper          <td>(</td>
338*132f818dSEnji Cooper          <td class="paramtype">void&#160;</td>
339*132f818dSEnji Cooper          <td class="paramname"></td><td>)</td>
340*132f818dSEnji Cooper          <td></td>
341*132f818dSEnji Cooper        </tr>
342*132f818dSEnji Cooper      </table>
343*132f818dSEnji Cooper</div><div class="memdoc">
344*132f818dSEnji Cooper
345*132f818dSEnji Cooper<p>Destructor for the Lua state. </p>
346*132f818dSEnji Cooper<p>Closes the session unless it has already been closed by calling the <a class="el" href="a00919.html#a16c2f95e91f64c5ac89258ee5dcd34e2" title="Terminates this Lua session.">close()</a> method. It is recommended to explicitly close the session in the code. </p>
347*132f818dSEnji Cooper
348*132f818dSEnji Cooper</div>
349*132f818dSEnji Cooper</div>
350*132f818dSEnji Cooper<h2 class="groupheader">Member Function Documentation</h2>
351*132f818dSEnji Cooper<a id="a16c2f95e91f64c5ac89258ee5dcd34e2" name="a16c2f95e91f64c5ac89258ee5dcd34e2"></a>
352*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a16c2f95e91f64c5ac89258ee5dcd34e2">&#9670;&#160;</a></span>close()</h2>
353*132f818dSEnji Cooper
354*132f818dSEnji Cooper<div class="memitem">
355*132f818dSEnji Cooper<div class="memproto">
356*132f818dSEnji Cooper      <table class="memname">
357*132f818dSEnji Cooper        <tr>
358*132f818dSEnji Cooper          <td class="memname">void lutok::state::close </td>
359*132f818dSEnji Cooper          <td>(</td>
360*132f818dSEnji Cooper          <td class="paramtype">void&#160;</td>
361*132f818dSEnji Cooper          <td class="paramname"></td><td>)</td>
362*132f818dSEnji Cooper          <td></td>
363*132f818dSEnji Cooper        </tr>
364*132f818dSEnji Cooper      </table>
365*132f818dSEnji Cooper</div><div class="memdoc">
366*132f818dSEnji Cooper
367*132f818dSEnji Cooper<p>Terminates this Lua session. </p>
368*132f818dSEnji Cooper<p>It is recommended to call this instead of relying on the destructor to do the cleanup, but it is not a requirement to use <a class="el" href="a00919.html#a16c2f95e91f64c5ac89258ee5dcd34e2" title="Terminates this Lua session.">close()</a>.</p>
369*132f818dSEnji Cooper<dl class="section pre"><dt>Precondition</dt><dd><a class="el" href="a00919.html#a16c2f95e91f64c5ac89258ee5dcd34e2" title="Terminates this Lua session.">close()</a> has not yet been called. </dd>
370*132f818dSEnji Cooper<dd>
371*132f818dSEnji CooperThe Lua stack is empty. This is not truly necessary but ensures that our code is consistent and clears the stack explicitly. </dd></dl>
372*132f818dSEnji Cooper
373*132f818dSEnji Cooper</div>
374*132f818dSEnji Cooper</div>
375*132f818dSEnji Cooper<a id="a0291a3b34c5bed860d8d53e54eaee349" name="a0291a3b34c5bed860d8d53e54eaee349"></a>
376*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a0291a3b34c5bed860d8d53e54eaee349">&#9670;&#160;</a></span>get_global()</h2>
377*132f818dSEnji Cooper
378*132f818dSEnji Cooper<div class="memitem">
379*132f818dSEnji Cooper<div class="memproto">
380*132f818dSEnji Cooper      <table class="memname">
381*132f818dSEnji Cooper        <tr>
382*132f818dSEnji Cooper          <td class="memname">void lutok::state::get_global </td>
383*132f818dSEnji Cooper          <td>(</td>
384*132f818dSEnji Cooper          <td class="paramtype">const std::string &amp;&#160;</td>
385*132f818dSEnji Cooper          <td class="paramname"><em>name</em></td><td>)</td>
386*132f818dSEnji Cooper          <td></td>
387*132f818dSEnji Cooper        </tr>
388*132f818dSEnji Cooper      </table>
389*132f818dSEnji Cooper</div><div class="memdoc">
390*132f818dSEnji Cooper
391*132f818dSEnji Cooper<p>Wrapper around lua_getglobal. </p>
392*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
393*132f818dSEnji Cooper  <table class="params">
394*132f818dSEnji Cooper    <tr><td class="paramname">name</td><td>The second parameter to lua_getglobal.</td></tr>
395*132f818dSEnji Cooper  </table>
396*132f818dSEnji Cooper  </dd>
397*132f818dSEnji Cooper</dl>
398*132f818dSEnji Cooper<dl class="exception"><dt>Exceptions</dt><dd>
399*132f818dSEnji Cooper  <table class="exception">
400*132f818dSEnji Cooper    <tr><td class="paramname"><a class="el" href="a00899.html" title="Exception for errors raised by the Lua API library.">api_error</a></td><td>If lua_getglobal fails.</td></tr>
401*132f818dSEnji Cooper  </table>
402*132f818dSEnji Cooper  </dd>
403*132f818dSEnji Cooper</dl>
404*132f818dSEnji Cooper<dl class="section warning"><dt>Warning</dt><dd>Terminates execution if there is not enough memory to manipulate the Lua stack. </dd></dl>
405*132f818dSEnji Cooper
406*132f818dSEnji Cooper</div>
407*132f818dSEnji Cooper</div>
408*132f818dSEnji Cooper<a id="a2287f1dd03e6a72837ab020512927ee6" name="a2287f1dd03e6a72837ab020512927ee6"></a>
409*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a2287f1dd03e6a72837ab020512927ee6">&#9670;&#160;</a></span>get_global_table()</h2>
410*132f818dSEnji Cooper
411*132f818dSEnji Cooper<div class="memitem">
412*132f818dSEnji Cooper<div class="memproto">
413*132f818dSEnji Cooper      <table class="memname">
414*132f818dSEnji Cooper        <tr>
415*132f818dSEnji Cooper          <td class="memname">void lutok::state::get_global_table </td>
416*132f818dSEnji Cooper          <td>(</td>
417*132f818dSEnji Cooper          <td class="paramtype">void&#160;</td>
418*132f818dSEnji Cooper          <td class="paramname"></td><td>)</td>
419*132f818dSEnji Cooper          <td></td>
420*132f818dSEnji Cooper        </tr>
421*132f818dSEnji Cooper      </table>
422*132f818dSEnji Cooper</div><div class="memdoc">
423*132f818dSEnji Cooper
424*132f818dSEnji Cooper<p>Pushes a reference to the global table onto the stack. </p>
425*132f818dSEnji Cooper<p>This is a wrapper around the incompatible differences between Lua 5.1 and 5.2 to access to the globals table.</p>
426*132f818dSEnji Cooper<dl class="section post"><dt>Postcondition</dt><dd>state(-1) Contains the reference to the globals table. </dd></dl>
427*132f818dSEnji Cooper
428*132f818dSEnji Cooper</div>
429*132f818dSEnji Cooper</div>
430*132f818dSEnji Cooper<a id="a0d4f5204547cac3e4855e375f6bc64cb" name="a0d4f5204547cac3e4855e375f6bc64cb"></a>
431*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a0d4f5204547cac3e4855e375f6bc64cb">&#9670;&#160;</a></span>get_metafield()</h2>
432*132f818dSEnji Cooper
433*132f818dSEnji Cooper<div class="memitem">
434*132f818dSEnji Cooper<div class="memproto">
435*132f818dSEnji Cooper      <table class="memname">
436*132f818dSEnji Cooper        <tr>
437*132f818dSEnji Cooper          <td class="memname">bool lutok::state::get_metafield </td>
438*132f818dSEnji Cooper          <td>(</td>
439*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
440*132f818dSEnji Cooper          <td class="paramname"><em>index</em>, </td>
441*132f818dSEnji Cooper        </tr>
442*132f818dSEnji Cooper        <tr>
443*132f818dSEnji Cooper          <td class="paramkey"></td>
444*132f818dSEnji Cooper          <td></td>
445*132f818dSEnji Cooper          <td class="paramtype">const std::string &amp;&#160;</td>
446*132f818dSEnji Cooper          <td class="paramname"><em>name</em>&#160;</td>
447*132f818dSEnji Cooper        </tr>
448*132f818dSEnji Cooper        <tr>
449*132f818dSEnji Cooper          <td></td>
450*132f818dSEnji Cooper          <td>)</td>
451*132f818dSEnji Cooper          <td></td><td></td>
452*132f818dSEnji Cooper        </tr>
453*132f818dSEnji Cooper      </table>
454*132f818dSEnji Cooper</div><div class="memdoc">
455*132f818dSEnji Cooper
456*132f818dSEnji Cooper<p>Wrapper around luaL_getmetafield. </p>
457*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
458*132f818dSEnji Cooper  <table class="params">
459*132f818dSEnji Cooper    <tr><td class="paramname">index</td><td>The second parameter to luaL_getmetafield. </td></tr>
460*132f818dSEnji Cooper    <tr><td class="paramname">name</td><td>The third parameter to luaL_getmetafield.</td></tr>
461*132f818dSEnji Cooper  </table>
462*132f818dSEnji Cooper  </dd>
463*132f818dSEnji Cooper</dl>
464*132f818dSEnji Cooper<dl class="section return"><dt>Returns</dt><dd>The return value of luaL_getmetafield.</dd></dl>
465*132f818dSEnji Cooper<dl class="section warning"><dt>Warning</dt><dd>Terminates execution if there is not enough memory to manipulate the Lua stack. </dd></dl>
466*132f818dSEnji Cooper
467*132f818dSEnji Cooper</div>
468*132f818dSEnji Cooper</div>
469*132f818dSEnji Cooper<a id="abbbafa23bb49ccc04e0f32f47b629ae5" name="abbbafa23bb49ccc04e0f32f47b629ae5"></a>
470*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#abbbafa23bb49ccc04e0f32f47b629ae5">&#9670;&#160;</a></span>get_metatable()</h2>
471*132f818dSEnji Cooper
472*132f818dSEnji Cooper<div class="memitem">
473*132f818dSEnji Cooper<div class="memproto">
474*132f818dSEnji Cooper      <table class="memname">
475*132f818dSEnji Cooper        <tr>
476*132f818dSEnji Cooper          <td class="memname">bool lutok::state::get_metatable </td>
477*132f818dSEnji Cooper          <td>(</td>
478*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
479*132f818dSEnji Cooper          <td class="paramname"><em>index</em></td><td>)</td>
480*132f818dSEnji Cooper          <td></td>
481*132f818dSEnji Cooper        </tr>
482*132f818dSEnji Cooper      </table>
483*132f818dSEnji Cooper</div><div class="memdoc">
484*132f818dSEnji Cooper
485*132f818dSEnji Cooper<p>Wrapper around lua_getmetatable. </p>
486*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
487*132f818dSEnji Cooper  <table class="params">
488*132f818dSEnji Cooper    <tr><td class="paramname">index</td><td>The second parameter to lua_getmetatable.</td></tr>
489*132f818dSEnji Cooper  </table>
490*132f818dSEnji Cooper  </dd>
491*132f818dSEnji Cooper</dl>
492*132f818dSEnji Cooper<dl class="section return"><dt>Returns</dt><dd>The return value of lua_getmetatable. </dd></dl>
493*132f818dSEnji Cooper
494*132f818dSEnji Cooper</div>
495*132f818dSEnji Cooper</div>
496*132f818dSEnji Cooper<a id="a8865c4d7ee8a5d9f9ffeff22b8819648" name="a8865c4d7ee8a5d9f9ffeff22b8819648"></a>
497*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a8865c4d7ee8a5d9f9ffeff22b8819648">&#9670;&#160;</a></span>get_table()</h2>
498*132f818dSEnji Cooper
499*132f818dSEnji Cooper<div class="memitem">
500*132f818dSEnji Cooper<div class="memproto">
501*132f818dSEnji Cooper      <table class="memname">
502*132f818dSEnji Cooper        <tr>
503*132f818dSEnji Cooper          <td class="memname">void lutok::state::get_table </td>
504*132f818dSEnji Cooper          <td>(</td>
505*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
506*132f818dSEnji Cooper          <td class="paramname"><em>index</em></td><td>)</td>
507*132f818dSEnji Cooper          <td></td>
508*132f818dSEnji Cooper        </tr>
509*132f818dSEnji Cooper      </table>
510*132f818dSEnji Cooper</div><div class="memdoc">
511*132f818dSEnji Cooper
512*132f818dSEnji Cooper<p>Wrapper around lua_gettable. </p>
513*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
514*132f818dSEnji Cooper  <table class="params">
515*132f818dSEnji Cooper    <tr><td class="paramname">index</td><td>The second parameter to lua_gettable.</td></tr>
516*132f818dSEnji Cooper  </table>
517*132f818dSEnji Cooper  </dd>
518*132f818dSEnji Cooper</dl>
519*132f818dSEnji Cooper<dl class="exception"><dt>Exceptions</dt><dd>
520*132f818dSEnji Cooper  <table class="exception">
521*132f818dSEnji Cooper    <tr><td class="paramname"><a class="el" href="a00899.html" title="Exception for errors raised by the Lua API library.">api_error</a></td><td>If lua_gettable fails.</td></tr>
522*132f818dSEnji Cooper  </table>
523*132f818dSEnji Cooper  </dd>
524*132f818dSEnji Cooper</dl>
525*132f818dSEnji Cooper<dl class="section warning"><dt>Warning</dt><dd>Terminates execution if there is not enough memory to manipulate the Lua stack. </dd></dl>
526*132f818dSEnji Cooper
527*132f818dSEnji Cooper</div>
528*132f818dSEnji Cooper</div>
529*132f818dSEnji Cooper<a id="af8591bfdccb2e8732c147a8a6623b2e5" name="af8591bfdccb2e8732c147a8a6623b2e5"></a>
530*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#af8591bfdccb2e8732c147a8a6623b2e5">&#9670;&#160;</a></span>get_top()</h2>
531*132f818dSEnji Cooper
532*132f818dSEnji Cooper<div class="memitem">
533*132f818dSEnji Cooper<div class="memproto">
534*132f818dSEnji Cooper      <table class="memname">
535*132f818dSEnji Cooper        <tr>
536*132f818dSEnji Cooper          <td class="memname">int lutok::state::get_top </td>
537*132f818dSEnji Cooper          <td>(</td>
538*132f818dSEnji Cooper          <td class="paramtype">void&#160;</td>
539*132f818dSEnji Cooper          <td class="paramname"></td><td>)</td>
540*132f818dSEnji Cooper          <td></td>
541*132f818dSEnji Cooper        </tr>
542*132f818dSEnji Cooper      </table>
543*132f818dSEnji Cooper</div><div class="memdoc">
544*132f818dSEnji Cooper
545*132f818dSEnji Cooper<p>Wrapper around lua_gettop. </p>
546*132f818dSEnji Cooper<dl class="section return"><dt>Returns</dt><dd>The return value of lua_gettop. </dd></dl>
547*132f818dSEnji Cooper
548*132f818dSEnji Cooper</div>
549*132f818dSEnji Cooper</div>
550*132f818dSEnji Cooper<a id="a69d7e97f6140c24382fbfd05aa16ad72" name="a69d7e97f6140c24382fbfd05aa16ad72"></a>
551*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a69d7e97f6140c24382fbfd05aa16ad72">&#9670;&#160;</a></span>insert()</h2>
552*132f818dSEnji Cooper
553*132f818dSEnji Cooper<div class="memitem">
554*132f818dSEnji Cooper<div class="memproto">
555*132f818dSEnji Cooper      <table class="memname">
556*132f818dSEnji Cooper        <tr>
557*132f818dSEnji Cooper          <td class="memname">void lutok::state::insert </td>
558*132f818dSEnji Cooper          <td>(</td>
559*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
560*132f818dSEnji Cooper          <td class="paramname"><em>index</em></td><td>)</td>
561*132f818dSEnji Cooper          <td></td>
562*132f818dSEnji Cooper        </tr>
563*132f818dSEnji Cooper      </table>
564*132f818dSEnji Cooper</div><div class="memdoc">
565*132f818dSEnji Cooper
566*132f818dSEnji Cooper<p>Wrapper around lua_insert. </p>
567*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
568*132f818dSEnji Cooper  <table class="params">
569*132f818dSEnji Cooper    <tr><td class="paramname">index</td><td>The second parameter to lua_insert. </td></tr>
570*132f818dSEnji Cooper  </table>
571*132f818dSEnji Cooper  </dd>
572*132f818dSEnji Cooper</dl>
573*132f818dSEnji Cooper
574*132f818dSEnji Cooper</div>
575*132f818dSEnji Cooper</div>
576*132f818dSEnji Cooper<a id="a4efb903445d053766fe54800d36d4deb" name="a4efb903445d053766fe54800d36d4deb"></a>
577*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a4efb903445d053766fe54800d36d4deb">&#9670;&#160;</a></span>is_boolean()</h2>
578*132f818dSEnji Cooper
579*132f818dSEnji Cooper<div class="memitem">
580*132f818dSEnji Cooper<div class="memproto">
581*132f818dSEnji Cooper      <table class="memname">
582*132f818dSEnji Cooper        <tr>
583*132f818dSEnji Cooper          <td class="memname">bool lutok::state::is_boolean </td>
584*132f818dSEnji Cooper          <td>(</td>
585*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
586*132f818dSEnji Cooper          <td class="paramname"><em>index</em></td><td>)</td>
587*132f818dSEnji Cooper          <td></td>
588*132f818dSEnji Cooper        </tr>
589*132f818dSEnji Cooper      </table>
590*132f818dSEnji Cooper</div><div class="memdoc">
591*132f818dSEnji Cooper
592*132f818dSEnji Cooper<p>Wrapper around lua_isboolean. </p>
593*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
594*132f818dSEnji Cooper  <table class="params">
595*132f818dSEnji Cooper    <tr><td class="paramname">index</td><td>The second parameter to lua_isboolean.</td></tr>
596*132f818dSEnji Cooper  </table>
597*132f818dSEnji Cooper  </dd>
598*132f818dSEnji Cooper</dl>
599*132f818dSEnji Cooper<dl class="section return"><dt>Returns</dt><dd>The return value of lua_isboolean. </dd></dl>
600*132f818dSEnji Cooper
601*132f818dSEnji Cooper</div>
602*132f818dSEnji Cooper</div>
603*132f818dSEnji Cooper<a id="ab454ca52fec8413fde1d46df003c19c0" name="ab454ca52fec8413fde1d46df003c19c0"></a>
604*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#ab454ca52fec8413fde1d46df003c19c0">&#9670;&#160;</a></span>is_function()</h2>
605*132f818dSEnji Cooper
606*132f818dSEnji Cooper<div class="memitem">
607*132f818dSEnji Cooper<div class="memproto">
608*132f818dSEnji Cooper      <table class="memname">
609*132f818dSEnji Cooper        <tr>
610*132f818dSEnji Cooper          <td class="memname">bool lutok::state::is_function </td>
611*132f818dSEnji Cooper          <td>(</td>
612*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
613*132f818dSEnji Cooper          <td class="paramname"><em>index</em></td><td>)</td>
614*132f818dSEnji Cooper          <td></td>
615*132f818dSEnji Cooper        </tr>
616*132f818dSEnji Cooper      </table>
617*132f818dSEnji Cooper</div><div class="memdoc">
618*132f818dSEnji Cooper
619*132f818dSEnji Cooper<p>Wrapper around lua_isfunction. </p>
620*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
621*132f818dSEnji Cooper  <table class="params">
622*132f818dSEnji Cooper    <tr><td class="paramname">index</td><td>The second parameter to lua_isfunction.</td></tr>
623*132f818dSEnji Cooper  </table>
624*132f818dSEnji Cooper  </dd>
625*132f818dSEnji Cooper</dl>
626*132f818dSEnji Cooper<dl class="section return"><dt>Returns</dt><dd>The return value of lua_isfunction. </dd></dl>
627*132f818dSEnji Cooper
628*132f818dSEnji Cooper</div>
629*132f818dSEnji Cooper</div>
630*132f818dSEnji Cooper<a id="a21c5f4f63cf89db0f16dd032f0612a78" name="a21c5f4f63cf89db0f16dd032f0612a78"></a>
631*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a21c5f4f63cf89db0f16dd032f0612a78">&#9670;&#160;</a></span>is_nil()</h2>
632*132f818dSEnji Cooper
633*132f818dSEnji Cooper<div class="memitem">
634*132f818dSEnji Cooper<div class="memproto">
635*132f818dSEnji Cooper      <table class="memname">
636*132f818dSEnji Cooper        <tr>
637*132f818dSEnji Cooper          <td class="memname">bool lutok::state::is_nil </td>
638*132f818dSEnji Cooper          <td>(</td>
639*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
640*132f818dSEnji Cooper          <td class="paramname"><em>index</em></td><td>)</td>
641*132f818dSEnji Cooper          <td></td>
642*132f818dSEnji Cooper        </tr>
643*132f818dSEnji Cooper      </table>
644*132f818dSEnji Cooper</div><div class="memdoc">
645*132f818dSEnji Cooper
646*132f818dSEnji Cooper<p>Wrapper around lua_isnil. </p>
647*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
648*132f818dSEnji Cooper  <table class="params">
649*132f818dSEnji Cooper    <tr><td class="paramname">index</td><td>The second parameter to lua_isnil.</td></tr>
650*132f818dSEnji Cooper  </table>
651*132f818dSEnji Cooper  </dd>
652*132f818dSEnji Cooper</dl>
653*132f818dSEnji Cooper<dl class="section return"><dt>Returns</dt><dd>The return value of lua_isnil. </dd></dl>
654*132f818dSEnji Cooper
655*132f818dSEnji Cooper</div>
656*132f818dSEnji Cooper</div>
657*132f818dSEnji Cooper<a id="acd31e0953ee71c94903e5444bf451eb1" name="acd31e0953ee71c94903e5444bf451eb1"></a>
658*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#acd31e0953ee71c94903e5444bf451eb1">&#9670;&#160;</a></span>is_number()</h2>
659*132f818dSEnji Cooper
660*132f818dSEnji Cooper<div class="memitem">
661*132f818dSEnji Cooper<div class="memproto">
662*132f818dSEnji Cooper      <table class="memname">
663*132f818dSEnji Cooper        <tr>
664*132f818dSEnji Cooper          <td class="memname">bool lutok::state::is_number </td>
665*132f818dSEnji Cooper          <td>(</td>
666*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
667*132f818dSEnji Cooper          <td class="paramname"><em>index</em></td><td>)</td>
668*132f818dSEnji Cooper          <td></td>
669*132f818dSEnji Cooper        </tr>
670*132f818dSEnji Cooper      </table>
671*132f818dSEnji Cooper</div><div class="memdoc">
672*132f818dSEnji Cooper
673*132f818dSEnji Cooper<p>Wrapper around lua_isnumber. </p>
674*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
675*132f818dSEnji Cooper  <table class="params">
676*132f818dSEnji Cooper    <tr><td class="paramname">index</td><td>The second parameter to lua_isnumber.</td></tr>
677*132f818dSEnji Cooper  </table>
678*132f818dSEnji Cooper  </dd>
679*132f818dSEnji Cooper</dl>
680*132f818dSEnji Cooper<dl class="section return"><dt>Returns</dt><dd>The return value of lua_isnumber. </dd></dl>
681*132f818dSEnji Cooper
682*132f818dSEnji Cooper</div>
683*132f818dSEnji Cooper</div>
684*132f818dSEnji Cooper<a id="af82c354bbcedaa5f7b2f8b8e6f6c69b5" name="af82c354bbcedaa5f7b2f8b8e6f6c69b5"></a>
685*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#af82c354bbcedaa5f7b2f8b8e6f6c69b5">&#9670;&#160;</a></span>is_string()</h2>
686*132f818dSEnji Cooper
687*132f818dSEnji Cooper<div class="memitem">
688*132f818dSEnji Cooper<div class="memproto">
689*132f818dSEnji Cooper      <table class="memname">
690*132f818dSEnji Cooper        <tr>
691*132f818dSEnji Cooper          <td class="memname">bool lutok::state::is_string </td>
692*132f818dSEnji Cooper          <td>(</td>
693*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
694*132f818dSEnji Cooper          <td class="paramname"><em>index</em></td><td>)</td>
695*132f818dSEnji Cooper          <td></td>
696*132f818dSEnji Cooper        </tr>
697*132f818dSEnji Cooper      </table>
698*132f818dSEnji Cooper</div><div class="memdoc">
699*132f818dSEnji Cooper
700*132f818dSEnji Cooper<p>Wrapper around lua_isstring. </p>
701*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
702*132f818dSEnji Cooper  <table class="params">
703*132f818dSEnji Cooper    <tr><td class="paramname">index</td><td>The second parameter to lua_isstring.</td></tr>
704*132f818dSEnji Cooper  </table>
705*132f818dSEnji Cooper  </dd>
706*132f818dSEnji Cooper</dl>
707*132f818dSEnji Cooper<dl class="section return"><dt>Returns</dt><dd>The return value of lua_isstring. </dd></dl>
708*132f818dSEnji Cooper
709*132f818dSEnji Cooper</div>
710*132f818dSEnji Cooper</div>
711*132f818dSEnji Cooper<a id="a468113870c8129430cbd773f5abb85fa" name="a468113870c8129430cbd773f5abb85fa"></a>
712*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a468113870c8129430cbd773f5abb85fa">&#9670;&#160;</a></span>is_table()</h2>
713*132f818dSEnji Cooper
714*132f818dSEnji Cooper<div class="memitem">
715*132f818dSEnji Cooper<div class="memproto">
716*132f818dSEnji Cooper      <table class="memname">
717*132f818dSEnji Cooper        <tr>
718*132f818dSEnji Cooper          <td class="memname">bool lutok::state::is_table </td>
719*132f818dSEnji Cooper          <td>(</td>
720*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
721*132f818dSEnji Cooper          <td class="paramname"><em>index</em></td><td>)</td>
722*132f818dSEnji Cooper          <td></td>
723*132f818dSEnji Cooper        </tr>
724*132f818dSEnji Cooper      </table>
725*132f818dSEnji Cooper</div><div class="memdoc">
726*132f818dSEnji Cooper
727*132f818dSEnji Cooper<p>Wrapper around lua_istable. </p>
728*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
729*132f818dSEnji Cooper  <table class="params">
730*132f818dSEnji Cooper    <tr><td class="paramname">index</td><td>The second parameter to lua_istable.</td></tr>
731*132f818dSEnji Cooper  </table>
732*132f818dSEnji Cooper  </dd>
733*132f818dSEnji Cooper</dl>
734*132f818dSEnji Cooper<dl class="section return"><dt>Returns</dt><dd>The return value of lua_istable. </dd></dl>
735*132f818dSEnji Cooper
736*132f818dSEnji Cooper</div>
737*132f818dSEnji Cooper</div>
738*132f818dSEnji Cooper<a id="adea141de47b0e6895e8ee9afe5c82a0e" name="adea141de47b0e6895e8ee9afe5c82a0e"></a>
739*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#adea141de47b0e6895e8ee9afe5c82a0e">&#9670;&#160;</a></span>is_userdata()</h2>
740*132f818dSEnji Cooper
741*132f818dSEnji Cooper<div class="memitem">
742*132f818dSEnji Cooper<div class="memproto">
743*132f818dSEnji Cooper      <table class="memname">
744*132f818dSEnji Cooper        <tr>
745*132f818dSEnji Cooper          <td class="memname">bool lutok::state::is_userdata </td>
746*132f818dSEnji Cooper          <td>(</td>
747*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
748*132f818dSEnji Cooper          <td class="paramname"><em>index</em></td><td>)</td>
749*132f818dSEnji Cooper          <td></td>
750*132f818dSEnji Cooper        </tr>
751*132f818dSEnji Cooper      </table>
752*132f818dSEnji Cooper</div><div class="memdoc">
753*132f818dSEnji Cooper
754*132f818dSEnji Cooper<p>Wrapper around lua_isuserdata. </p>
755*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
756*132f818dSEnji Cooper  <table class="params">
757*132f818dSEnji Cooper    <tr><td class="paramname">index</td><td>The second parameter to lua_isuserdata.</td></tr>
758*132f818dSEnji Cooper  </table>
759*132f818dSEnji Cooper  </dd>
760*132f818dSEnji Cooper</dl>
761*132f818dSEnji Cooper<dl class="section return"><dt>Returns</dt><dd>The return value of lua_isuserdata. </dd></dl>
762*132f818dSEnji Cooper
763*132f818dSEnji Cooper</div>
764*132f818dSEnji Cooper</div>
765*132f818dSEnji Cooper<a id="a493b3192ade9e2f32940b96fa9ef461b" name="a493b3192ade9e2f32940b96fa9ef461b"></a>
766*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a493b3192ade9e2f32940b96fa9ef461b">&#9670;&#160;</a></span>load_file()</h2>
767*132f818dSEnji Cooper
768*132f818dSEnji Cooper<div class="memitem">
769*132f818dSEnji Cooper<div class="memproto">
770*132f818dSEnji Cooper      <table class="memname">
771*132f818dSEnji Cooper        <tr>
772*132f818dSEnji Cooper          <td class="memname">void lutok::state::load_file </td>
773*132f818dSEnji Cooper          <td>(</td>
774*132f818dSEnji Cooper          <td class="paramtype">const std::string &amp;&#160;</td>
775*132f818dSEnji Cooper          <td class="paramname"><em>file</em></td><td>)</td>
776*132f818dSEnji Cooper          <td></td>
777*132f818dSEnji Cooper        </tr>
778*132f818dSEnji Cooper      </table>
779*132f818dSEnji Cooper</div><div class="memdoc">
780*132f818dSEnji Cooper
781*132f818dSEnji Cooper<p>Wrapper around luaL_loadfile. </p>
782*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
783*132f818dSEnji Cooper  <table class="params">
784*132f818dSEnji Cooper    <tr><td class="paramname">file</td><td>The second parameter to luaL_loadfile.</td></tr>
785*132f818dSEnji Cooper  </table>
786*132f818dSEnji Cooper  </dd>
787*132f818dSEnji Cooper</dl>
788*132f818dSEnji Cooper<dl class="exception"><dt>Exceptions</dt><dd>
789*132f818dSEnji Cooper  <table class="exception">
790*132f818dSEnji Cooper    <tr><td class="paramname"><a class="el" href="a00899.html" title="Exception for errors raised by the Lua API library.">api_error</a></td><td>If luaL_loadfile returns an error. </td></tr>
791*132f818dSEnji Cooper    <tr><td class="paramname"><a class="el" href="a00903.html" title="File not found error.">file_not_found_error</a></td><td>If the file cannot be accessed.</td></tr>
792*132f818dSEnji Cooper  </table>
793*132f818dSEnji Cooper  </dd>
794*132f818dSEnji Cooper</dl>
795*132f818dSEnji Cooper<dl class="section warning"><dt>Warning</dt><dd>Terminates execution if there is not enough memory. </dd></dl>
796*132f818dSEnji Cooper
797*132f818dSEnji Cooper</div>
798*132f818dSEnji Cooper</div>
799*132f818dSEnji Cooper<a id="a5ff9ef96d82c9cc497a8dfc1404a1c82" name="a5ff9ef96d82c9cc497a8dfc1404a1c82"></a>
800*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a5ff9ef96d82c9cc497a8dfc1404a1c82">&#9670;&#160;</a></span>load_string()</h2>
801*132f818dSEnji Cooper
802*132f818dSEnji Cooper<div class="memitem">
803*132f818dSEnji Cooper<div class="memproto">
804*132f818dSEnji Cooper      <table class="memname">
805*132f818dSEnji Cooper        <tr>
806*132f818dSEnji Cooper          <td class="memname">void lutok::state::load_string </td>
807*132f818dSEnji Cooper          <td>(</td>
808*132f818dSEnji Cooper          <td class="paramtype">const std::string &amp;&#160;</td>
809*132f818dSEnji Cooper          <td class="paramname"><em>str</em></td><td>)</td>
810*132f818dSEnji Cooper          <td></td>
811*132f818dSEnji Cooper        </tr>
812*132f818dSEnji Cooper      </table>
813*132f818dSEnji Cooper</div><div class="memdoc">
814*132f818dSEnji Cooper
815*132f818dSEnji Cooper<p>Wrapper around luaL_loadstring. </p>
816*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
817*132f818dSEnji Cooper  <table class="params">
818*132f818dSEnji Cooper    <tr><td class="paramname">str</td><td>The second parameter to luaL_loadstring.</td></tr>
819*132f818dSEnji Cooper  </table>
820*132f818dSEnji Cooper  </dd>
821*132f818dSEnji Cooper</dl>
822*132f818dSEnji Cooper<dl class="exception"><dt>Exceptions</dt><dd>
823*132f818dSEnji Cooper  <table class="exception">
824*132f818dSEnji Cooper    <tr><td class="paramname"><a class="el" href="a00899.html" title="Exception for errors raised by the Lua API library.">api_error</a></td><td>If luaL_loadstring returns an error.</td></tr>
825*132f818dSEnji Cooper  </table>
826*132f818dSEnji Cooper  </dd>
827*132f818dSEnji Cooper</dl>
828*132f818dSEnji Cooper<dl class="section warning"><dt>Warning</dt><dd>Terminates execution if there is not enough memory. </dd></dl>
829*132f818dSEnji Cooper
830*132f818dSEnji Cooper</div>
831*132f818dSEnji Cooper</div>
832*132f818dSEnji Cooper<a id="a50d389a2c6d23214eda1e46e15ed20b5" name="a50d389a2c6d23214eda1e46e15ed20b5"></a>
833*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a50d389a2c6d23214eda1e46e15ed20b5">&#9670;&#160;</a></span>new_table()</h2>
834*132f818dSEnji Cooper
835*132f818dSEnji Cooper<div class="memitem">
836*132f818dSEnji Cooper<div class="memproto">
837*132f818dSEnji Cooper      <table class="memname">
838*132f818dSEnji Cooper        <tr>
839*132f818dSEnji Cooper          <td class="memname">void lutok::state::new_table </td>
840*132f818dSEnji Cooper          <td>(</td>
841*132f818dSEnji Cooper          <td class="paramtype">void&#160;</td>
842*132f818dSEnji Cooper          <td class="paramname"></td><td>)</td>
843*132f818dSEnji Cooper          <td></td>
844*132f818dSEnji Cooper        </tr>
845*132f818dSEnji Cooper      </table>
846*132f818dSEnji Cooper</div><div class="memdoc">
847*132f818dSEnji Cooper
848*132f818dSEnji Cooper<p>Wrapper around lua_newtable. </p>
849*132f818dSEnji Cooper<dl class="section warning"><dt>Warning</dt><dd>Terminates execution if there is not enough memory. </dd></dl>
850*132f818dSEnji Cooper
851*132f818dSEnji Cooper</div>
852*132f818dSEnji Cooper</div>
853*132f818dSEnji Cooper<a id="aaec7e57d4434f087cef8d38a221ae474" name="aaec7e57d4434f087cef8d38a221ae474"></a>
854*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#aaec7e57d4434f087cef8d38a221ae474">&#9670;&#160;</a></span>new_userdata()</h2>
855*132f818dSEnji Cooper
856*132f818dSEnji Cooper<div class="memitem">
857*132f818dSEnji Cooper<div class="memproto">
858*132f818dSEnji Cooper<div class="memtemplate">
859*132f818dSEnji Coopertemplate&lt;typename Type &gt; </div>
860*132f818dSEnji Cooper      <table class="memname">
861*132f818dSEnji Cooper        <tr>
862*132f818dSEnji Cooper          <td class="memname">Type * lutok::state::new_userdata </td>
863*132f818dSEnji Cooper          <td>(</td>
864*132f818dSEnji Cooper          <td class="paramtype">void&#160;</td>
865*132f818dSEnji Cooper          <td class="paramname"></td><td>)</td>
866*132f818dSEnji Cooper          <td></td>
867*132f818dSEnji Cooper        </tr>
868*132f818dSEnji Cooper      </table>
869*132f818dSEnji Cooper</div><div class="memdoc">
870*132f818dSEnji Cooper
871*132f818dSEnji Cooper<p>Wrapper around lua_newuserdata. </p>
872*132f818dSEnji Cooper<p>This allocates an object as big as the size of the provided Type.</p>
873*132f818dSEnji Cooper<dl class="section return"><dt>Returns</dt><dd>The pointer to the allocated userdata object.</dd></dl>
874*132f818dSEnji Cooper<dl class="section warning"><dt>Warning</dt><dd>Terminates execution if there is not enough memory. </dd></dl>
875*132f818dSEnji Cooper
876*132f818dSEnji Cooper</div>
877*132f818dSEnji Cooper</div>
878*132f818dSEnji Cooper<a id="a5f2fa48408831695914e4a57acf85a7c" name="a5f2fa48408831695914e4a57acf85a7c"></a>
879*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a5f2fa48408831695914e4a57acf85a7c">&#9670;&#160;</a></span>new_userdata_voidp()</h2>
880*132f818dSEnji Cooper
881*132f818dSEnji Cooper<div class="memitem">
882*132f818dSEnji Cooper<div class="memproto">
883*132f818dSEnji Cooper<table class="mlabels">
884*132f818dSEnji Cooper  <tr>
885*132f818dSEnji Cooper  <td class="mlabels-left">
886*132f818dSEnji Cooper      <table class="memname">
887*132f818dSEnji Cooper        <tr>
888*132f818dSEnji Cooper          <td class="memname">void * lutok::state::new_userdata_voidp </td>
889*132f818dSEnji Cooper          <td>(</td>
890*132f818dSEnji Cooper          <td class="paramtype">const size_t&#160;</td>
891*132f818dSEnji Cooper          <td class="paramname"><em>size</em></td><td>)</td>
892*132f818dSEnji Cooper          <td></td>
893*132f818dSEnji Cooper        </tr>
894*132f818dSEnji Cooper      </table>
895*132f818dSEnji Cooper  </td>
896*132f818dSEnji Cooper  <td class="mlabels-right">
897*132f818dSEnji Cooper<span class="mlabels"><span class="mlabel">private</span></span>  </td>
898*132f818dSEnji Cooper  </tr>
899*132f818dSEnji Cooper</table>
900*132f818dSEnji Cooper</div><div class="memdoc">
901*132f818dSEnji Cooper
902*132f818dSEnji Cooper<p>Wrapper around lua_newuserdata. </p>
903*132f818dSEnji Cooper<p>This is internal. The public type-safe interface of this method should be used instead.</p>
904*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
905*132f818dSEnji Cooper  <table class="params">
906*132f818dSEnji Cooper    <tr><td class="paramname">size</td><td>The second parameter to lua_newuserdata.</td></tr>
907*132f818dSEnji Cooper  </table>
908*132f818dSEnji Cooper  </dd>
909*132f818dSEnji Cooper</dl>
910*132f818dSEnji Cooper<dl class="section return"><dt>Returns</dt><dd>The return value of lua_newuserdata.</dd></dl>
911*132f818dSEnji Cooper<dl class="section warning"><dt>Warning</dt><dd>Terminates execution if there is not enough memory. </dd></dl>
912*132f818dSEnji Cooper
913*132f818dSEnji Cooper</div>
914*132f818dSEnji Cooper</div>
915*132f818dSEnji Cooper<a id="abbbcf3c19d7d29594ea2e61ece52b815" name="abbbcf3c19d7d29594ea2e61ece52b815"></a>
916*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#abbbcf3c19d7d29594ea2e61ece52b815">&#9670;&#160;</a></span>next()</h2>
917*132f818dSEnji Cooper
918*132f818dSEnji Cooper<div class="memitem">
919*132f818dSEnji Cooper<div class="memproto">
920*132f818dSEnji Cooper      <table class="memname">
921*132f818dSEnji Cooper        <tr>
922*132f818dSEnji Cooper          <td class="memname">bool lutok::state::next </td>
923*132f818dSEnji Cooper          <td>(</td>
924*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
925*132f818dSEnji Cooper          <td class="paramname"><em>index</em></td><td>)</td>
926*132f818dSEnji Cooper          <td></td>
927*132f818dSEnji Cooper        </tr>
928*132f818dSEnji Cooper      </table>
929*132f818dSEnji Cooper</div><div class="memdoc">
930*132f818dSEnji Cooper
931*132f818dSEnji Cooper<p>Wrapper around lua_next. </p>
932*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
933*132f818dSEnji Cooper  <table class="params">
934*132f818dSEnji Cooper    <tr><td class="paramname">index</td><td>The second parameter to lua_next.</td></tr>
935*132f818dSEnji Cooper  </table>
936*132f818dSEnji Cooper  </dd>
937*132f818dSEnji Cooper</dl>
938*132f818dSEnji Cooper<dl class="section return"><dt>Returns</dt><dd>True if there are more elements to process; false otherwise.</dd></dl>
939*132f818dSEnji Cooper<dl class="section warning"><dt>Warning</dt><dd>Terminates execution if there is not enough memory. </dd></dl>
940*132f818dSEnji Cooper
941*132f818dSEnji Cooper</div>
942*132f818dSEnji Cooper</div>
943*132f818dSEnji Cooper<a id="a940ebd0fb37259360a63b7a669d8ca99" name="a940ebd0fb37259360a63b7a669d8ca99"></a>
944*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a940ebd0fb37259360a63b7a669d8ca99">&#9670;&#160;</a></span>open_all()</h2>
945*132f818dSEnji Cooper
946*132f818dSEnji Cooper<div class="memitem">
947*132f818dSEnji Cooper<div class="memproto">
948*132f818dSEnji Cooper      <table class="memname">
949*132f818dSEnji Cooper        <tr>
950*132f818dSEnji Cooper          <td class="memname">void lutok::state::open_all </td>
951*132f818dSEnji Cooper          <td>(</td>
952*132f818dSEnji Cooper          <td class="paramtype">void&#160;</td>
953*132f818dSEnji Cooper          <td class="paramname"></td><td>)</td>
954*132f818dSEnji Cooper          <td></td>
955*132f818dSEnji Cooper        </tr>
956*132f818dSEnji Cooper      </table>
957*132f818dSEnji Cooper</div><div class="memdoc">
958*132f818dSEnji Cooper
959*132f818dSEnji Cooper<p>Wrapper around luaL_openlibs. </p>
960*132f818dSEnji Cooper<dl class="exception"><dt>Exceptions</dt><dd>
961*132f818dSEnji Cooper  <table class="exception">
962*132f818dSEnji Cooper    <tr><td class="paramname"><a class="el" href="a00899.html" title="Exception for errors raised by the Lua API library.">api_error</a></td><td>If luaL_openlibs fails.</td></tr>
963*132f818dSEnji Cooper  </table>
964*132f818dSEnji Cooper  </dd>
965*132f818dSEnji Cooper</dl>
966*132f818dSEnji Cooper<dl class="section warning"><dt>Warning</dt><dd>Terminates execution if there is not enough memory. </dd></dl>
967*132f818dSEnji Cooper
968*132f818dSEnji Cooper</div>
969*132f818dSEnji Cooper</div>
970*132f818dSEnji Cooper<a id="abf68c04d96308868fec71a628741c712" name="abf68c04d96308868fec71a628741c712"></a>
971*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#abf68c04d96308868fec71a628741c712">&#9670;&#160;</a></span>open_base()</h2>
972*132f818dSEnji Cooper
973*132f818dSEnji Cooper<div class="memitem">
974*132f818dSEnji Cooper<div class="memproto">
975*132f818dSEnji Cooper      <table class="memname">
976*132f818dSEnji Cooper        <tr>
977*132f818dSEnji Cooper          <td class="memname">void lutok::state::open_base </td>
978*132f818dSEnji Cooper          <td>(</td>
979*132f818dSEnji Cooper          <td class="paramtype">void&#160;</td>
980*132f818dSEnji Cooper          <td class="paramname"></td><td>)</td>
981*132f818dSEnji Cooper          <td></td>
982*132f818dSEnji Cooper        </tr>
983*132f818dSEnji Cooper      </table>
984*132f818dSEnji Cooper</div><div class="memdoc">
985*132f818dSEnji Cooper
986*132f818dSEnji Cooper<p>Wrapper around luaopen_base. </p>
987*132f818dSEnji Cooper<dl class="exception"><dt>Exceptions</dt><dd>
988*132f818dSEnji Cooper  <table class="exception">
989*132f818dSEnji Cooper    <tr><td class="paramname"><a class="el" href="a00899.html" title="Exception for errors raised by the Lua API library.">api_error</a></td><td>If luaopen_base fails.</td></tr>
990*132f818dSEnji Cooper  </table>
991*132f818dSEnji Cooper  </dd>
992*132f818dSEnji Cooper</dl>
993*132f818dSEnji Cooper<dl class="section warning"><dt>Warning</dt><dd>Terminates execution if there is not enough memory. </dd></dl>
994*132f818dSEnji Cooper
995*132f818dSEnji Cooper</div>
996*132f818dSEnji Cooper</div>
997*132f818dSEnji Cooper<a id="a85db3b50e195e6ab7e81f9f51205d8c0" name="a85db3b50e195e6ab7e81f9f51205d8c0"></a>
998*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a85db3b50e195e6ab7e81f9f51205d8c0">&#9670;&#160;</a></span>open_string()</h2>
999*132f818dSEnji Cooper
1000*132f818dSEnji Cooper<div class="memitem">
1001*132f818dSEnji Cooper<div class="memproto">
1002*132f818dSEnji Cooper      <table class="memname">
1003*132f818dSEnji Cooper        <tr>
1004*132f818dSEnji Cooper          <td class="memname">void lutok::state::open_string </td>
1005*132f818dSEnji Cooper          <td>(</td>
1006*132f818dSEnji Cooper          <td class="paramtype">void&#160;</td>
1007*132f818dSEnji Cooper          <td class="paramname"></td><td>)</td>
1008*132f818dSEnji Cooper          <td></td>
1009*132f818dSEnji Cooper        </tr>
1010*132f818dSEnji Cooper      </table>
1011*132f818dSEnji Cooper</div><div class="memdoc">
1012*132f818dSEnji Cooper
1013*132f818dSEnji Cooper<p>Wrapper around luaopen_string. </p>
1014*132f818dSEnji Cooper<dl class="exception"><dt>Exceptions</dt><dd>
1015*132f818dSEnji Cooper  <table class="exception">
1016*132f818dSEnji Cooper    <tr><td class="paramname"><a class="el" href="a00899.html" title="Exception for errors raised by the Lua API library.">api_error</a></td><td>If luaopen_string fails.</td></tr>
1017*132f818dSEnji Cooper  </table>
1018*132f818dSEnji Cooper  </dd>
1019*132f818dSEnji Cooper</dl>
1020*132f818dSEnji Cooper<dl class="section warning"><dt>Warning</dt><dd>Terminates execution if there is not enough memory. </dd></dl>
1021*132f818dSEnji Cooper
1022*132f818dSEnji Cooper</div>
1023*132f818dSEnji Cooper</div>
1024*132f818dSEnji Cooper<a id="a8898b62799b3b8a70a2b6a049e531515" name="a8898b62799b3b8a70a2b6a049e531515"></a>
1025*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a8898b62799b3b8a70a2b6a049e531515">&#9670;&#160;</a></span>open_table()</h2>
1026*132f818dSEnji Cooper
1027*132f818dSEnji Cooper<div class="memitem">
1028*132f818dSEnji Cooper<div class="memproto">
1029*132f818dSEnji Cooper      <table class="memname">
1030*132f818dSEnji Cooper        <tr>
1031*132f818dSEnji Cooper          <td class="memname">void lutok::state::open_table </td>
1032*132f818dSEnji Cooper          <td>(</td>
1033*132f818dSEnji Cooper          <td class="paramtype">void&#160;</td>
1034*132f818dSEnji Cooper          <td class="paramname"></td><td>)</td>
1035*132f818dSEnji Cooper          <td></td>
1036*132f818dSEnji Cooper        </tr>
1037*132f818dSEnji Cooper      </table>
1038*132f818dSEnji Cooper</div><div class="memdoc">
1039*132f818dSEnji Cooper
1040*132f818dSEnji Cooper<p>Wrapper around luaopen_table. </p>
1041*132f818dSEnji Cooper<dl class="exception"><dt>Exceptions</dt><dd>
1042*132f818dSEnji Cooper  <table class="exception">
1043*132f818dSEnji Cooper    <tr><td class="paramname"><a class="el" href="a00899.html" title="Exception for errors raised by the Lua API library.">api_error</a></td><td>If luaopen_table fails.</td></tr>
1044*132f818dSEnji Cooper  </table>
1045*132f818dSEnji Cooper  </dd>
1046*132f818dSEnji Cooper</dl>
1047*132f818dSEnji Cooper<dl class="section warning"><dt>Warning</dt><dd>Terminates execution if there is not enough memory. </dd></dl>
1048*132f818dSEnji Cooper
1049*132f818dSEnji Cooper</div>
1050*132f818dSEnji Cooper</div>
1051*132f818dSEnji Cooper<a id="a307897e3501a5b5b08eb66f35f4d18df" name="a307897e3501a5b5b08eb66f35f4d18df"></a>
1052*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a307897e3501a5b5b08eb66f35f4d18df">&#9670;&#160;</a></span>pcall()</h2>
1053*132f818dSEnji Cooper
1054*132f818dSEnji Cooper<div class="memitem">
1055*132f818dSEnji Cooper<div class="memproto">
1056*132f818dSEnji Cooper      <table class="memname">
1057*132f818dSEnji Cooper        <tr>
1058*132f818dSEnji Cooper          <td class="memname">void lutok::state::pcall </td>
1059*132f818dSEnji Cooper          <td>(</td>
1060*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
1061*132f818dSEnji Cooper          <td class="paramname"><em>nargs</em>, </td>
1062*132f818dSEnji Cooper        </tr>
1063*132f818dSEnji Cooper        <tr>
1064*132f818dSEnji Cooper          <td class="paramkey"></td>
1065*132f818dSEnji Cooper          <td></td>
1066*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
1067*132f818dSEnji Cooper          <td class="paramname"><em>nresults</em>, </td>
1068*132f818dSEnji Cooper        </tr>
1069*132f818dSEnji Cooper        <tr>
1070*132f818dSEnji Cooper          <td class="paramkey"></td>
1071*132f818dSEnji Cooper          <td></td>
1072*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
1073*132f818dSEnji Cooper          <td class="paramname"><em>errfunc</em>&#160;</td>
1074*132f818dSEnji Cooper        </tr>
1075*132f818dSEnji Cooper        <tr>
1076*132f818dSEnji Cooper          <td></td>
1077*132f818dSEnji Cooper          <td>)</td>
1078*132f818dSEnji Cooper          <td></td><td></td>
1079*132f818dSEnji Cooper        </tr>
1080*132f818dSEnji Cooper      </table>
1081*132f818dSEnji Cooper</div><div class="memdoc">
1082*132f818dSEnji Cooper
1083*132f818dSEnji Cooper<p>Wrapper around lua_pcall. </p>
1084*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
1085*132f818dSEnji Cooper  <table class="params">
1086*132f818dSEnji Cooper    <tr><td class="paramname">nargs</td><td>The second parameter to lua_pcall. </td></tr>
1087*132f818dSEnji Cooper    <tr><td class="paramname">nresults</td><td>The third parameter to lua_pcall. </td></tr>
1088*132f818dSEnji Cooper    <tr><td class="paramname">errfunc</td><td>The fourth parameter to lua_pcall.</td></tr>
1089*132f818dSEnji Cooper  </table>
1090*132f818dSEnji Cooper  </dd>
1091*132f818dSEnji Cooper</dl>
1092*132f818dSEnji Cooper<dl class="exception"><dt>Exceptions</dt><dd>
1093*132f818dSEnji Cooper  <table class="exception">
1094*132f818dSEnji Cooper    <tr><td class="paramname"><a class="el" href="a00899.html" title="Exception for errors raised by the Lua API library.">api_error</a></td><td>If lua_pcall returns an error. </td></tr>
1095*132f818dSEnji Cooper  </table>
1096*132f818dSEnji Cooper  </dd>
1097*132f818dSEnji Cooper</dl>
1098*132f818dSEnji Cooper
1099*132f818dSEnji Cooper</div>
1100*132f818dSEnji Cooper</div>
1101*132f818dSEnji Cooper<a id="ac07258b143ef607dd9f6a9e24e495c20" name="ac07258b143ef607dd9f6a9e24e495c20"></a>
1102*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#ac07258b143ef607dd9f6a9e24e495c20">&#9670;&#160;</a></span>pop()</h2>
1103*132f818dSEnji Cooper
1104*132f818dSEnji Cooper<div class="memitem">
1105*132f818dSEnji Cooper<div class="memproto">
1106*132f818dSEnji Cooper      <table class="memname">
1107*132f818dSEnji Cooper        <tr>
1108*132f818dSEnji Cooper          <td class="memname">void lutok::state::pop </td>
1109*132f818dSEnji Cooper          <td>(</td>
1110*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
1111*132f818dSEnji Cooper          <td class="paramname"><em>count</em></td><td>)</td>
1112*132f818dSEnji Cooper          <td></td>
1113*132f818dSEnji Cooper        </tr>
1114*132f818dSEnji Cooper      </table>
1115*132f818dSEnji Cooper</div><div class="memdoc">
1116*132f818dSEnji Cooper
1117*132f818dSEnji Cooper<p>Wrapper around lua_pop. </p>
1118*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
1119*132f818dSEnji Cooper  <table class="params">
1120*132f818dSEnji Cooper    <tr><td class="paramname">count</td><td>The second parameter to lua_pop. </td></tr>
1121*132f818dSEnji Cooper  </table>
1122*132f818dSEnji Cooper  </dd>
1123*132f818dSEnji Cooper</dl>
1124*132f818dSEnji Cooper
1125*132f818dSEnji Cooper</div>
1126*132f818dSEnji Cooper</div>
1127*132f818dSEnji Cooper<a id="a11e9a3235154ebf867298935f1f58ca5" name="a11e9a3235154ebf867298935f1f58ca5"></a>
1128*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a11e9a3235154ebf867298935f1f58ca5">&#9670;&#160;</a></span>push_boolean()</h2>
1129*132f818dSEnji Cooper
1130*132f818dSEnji Cooper<div class="memitem">
1131*132f818dSEnji Cooper<div class="memproto">
1132*132f818dSEnji Cooper      <table class="memname">
1133*132f818dSEnji Cooper        <tr>
1134*132f818dSEnji Cooper          <td class="memname">void lutok::state::push_boolean </td>
1135*132f818dSEnji Cooper          <td>(</td>
1136*132f818dSEnji Cooper          <td class="paramtype">const bool&#160;</td>
1137*132f818dSEnji Cooper          <td class="paramname"><em>value</em></td><td>)</td>
1138*132f818dSEnji Cooper          <td></td>
1139*132f818dSEnji Cooper        </tr>
1140*132f818dSEnji Cooper      </table>
1141*132f818dSEnji Cooper</div><div class="memdoc">
1142*132f818dSEnji Cooper
1143*132f818dSEnji Cooper<p>Wrapper around lua_pushboolean. </p>
1144*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
1145*132f818dSEnji Cooper  <table class="params">
1146*132f818dSEnji Cooper    <tr><td class="paramname">value</td><td>The second parameter to lua_pushboolean. </td></tr>
1147*132f818dSEnji Cooper  </table>
1148*132f818dSEnji Cooper  </dd>
1149*132f818dSEnji Cooper</dl>
1150*132f818dSEnji Cooper
1151*132f818dSEnji Cooper</div>
1152*132f818dSEnji Cooper</div>
1153*132f818dSEnji Cooper<a id="a0e5b1b04d7bdf606a7b013b83de433d1" name="a0e5b1b04d7bdf606a7b013b83de433d1"></a>
1154*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a0e5b1b04d7bdf606a7b013b83de433d1">&#9670;&#160;</a></span>push_cxx_closure()</h2>
1155*132f818dSEnji Cooper
1156*132f818dSEnji Cooper<div class="memitem">
1157*132f818dSEnji Cooper<div class="memproto">
1158*132f818dSEnji Cooper      <table class="memname">
1159*132f818dSEnji Cooper        <tr>
1160*132f818dSEnji Cooper          <td class="memname">void lutok::state::push_cxx_closure </td>
1161*132f818dSEnji Cooper          <td>(</td>
1162*132f818dSEnji Cooper          <td class="paramtype"><a class="el" href="a00029.html#a8c623ca426c30c5fab4df2cb21635f17">cxx_function</a>&#160;</td>
1163*132f818dSEnji Cooper          <td class="paramname"><em>function</em>, </td>
1164*132f818dSEnji Cooper        </tr>
1165*132f818dSEnji Cooper        <tr>
1166*132f818dSEnji Cooper          <td class="paramkey"></td>
1167*132f818dSEnji Cooper          <td></td>
1168*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
1169*132f818dSEnji Cooper          <td class="paramname"><em>nvalues</em>&#160;</td>
1170*132f818dSEnji Cooper        </tr>
1171*132f818dSEnji Cooper        <tr>
1172*132f818dSEnji Cooper          <td></td>
1173*132f818dSEnji Cooper          <td>)</td>
1174*132f818dSEnji Cooper          <td></td><td></td>
1175*132f818dSEnji Cooper        </tr>
1176*132f818dSEnji Cooper      </table>
1177*132f818dSEnji Cooper</div><div class="memdoc">
1178*132f818dSEnji Cooper
1179*132f818dSEnji Cooper<p>Wrapper around lua_pushcclosure. </p>
1180*132f818dSEnji Cooper<p>This is not a pure wrapper around lua_pushcclosure because this has to do extra magic to allow passing C++ functions instead of plain C functions.</p>
1181*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
1182*132f818dSEnji Cooper  <table class="params">
1183*132f818dSEnji Cooper    <tr><td class="paramname">function</td><td>The C++ function to be pushed as a closure. </td></tr>
1184*132f818dSEnji Cooper    <tr><td class="paramname">nvalues</td><td>The number of upvalues that the function receives. </td></tr>
1185*132f818dSEnji Cooper  </table>
1186*132f818dSEnji Cooper  </dd>
1187*132f818dSEnji Cooper</dl>
1188*132f818dSEnji Cooper
1189*132f818dSEnji Cooper</div>
1190*132f818dSEnji Cooper</div>
1191*132f818dSEnji Cooper<a id="ae894e01dd1ff748aaf3f1a657363fe02" name="ae894e01dd1ff748aaf3f1a657363fe02"></a>
1192*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#ae894e01dd1ff748aaf3f1a657363fe02">&#9670;&#160;</a></span>push_cxx_function()</h2>
1193*132f818dSEnji Cooper
1194*132f818dSEnji Cooper<div class="memitem">
1195*132f818dSEnji Cooper<div class="memproto">
1196*132f818dSEnji Cooper      <table class="memname">
1197*132f818dSEnji Cooper        <tr>
1198*132f818dSEnji Cooper          <td class="memname">void lutok::state::push_cxx_function </td>
1199*132f818dSEnji Cooper          <td>(</td>
1200*132f818dSEnji Cooper          <td class="paramtype"><a class="el" href="a00029.html#a8c623ca426c30c5fab4df2cb21635f17">cxx_function</a>&#160;</td>
1201*132f818dSEnji Cooper          <td class="paramname"><em>function</em></td><td>)</td>
1202*132f818dSEnji Cooper          <td></td>
1203*132f818dSEnji Cooper        </tr>
1204*132f818dSEnji Cooper      </table>
1205*132f818dSEnji Cooper</div><div class="memdoc">
1206*132f818dSEnji Cooper
1207*132f818dSEnji Cooper<p>Wrapper around lua_pushcfunction. </p>
1208*132f818dSEnji Cooper<p>This is not a pure wrapper around lua_pushcfunction because this has to do extra magic to allow passing C++ functions instead of plain C functions.</p>
1209*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
1210*132f818dSEnji Cooper  <table class="params">
1211*132f818dSEnji Cooper    <tr><td class="paramname">function</td><td>The C++ function to be pushed. </td></tr>
1212*132f818dSEnji Cooper  </table>
1213*132f818dSEnji Cooper  </dd>
1214*132f818dSEnji Cooper</dl>
1215*132f818dSEnji Cooper
1216*132f818dSEnji Cooper</div>
1217*132f818dSEnji Cooper</div>
1218*132f818dSEnji Cooper<a id="a5c5b08f88a143cb48a600c044e2e3a56" name="a5c5b08f88a143cb48a600c044e2e3a56"></a>
1219*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a5c5b08f88a143cb48a600c044e2e3a56">&#9670;&#160;</a></span>push_integer()</h2>
1220*132f818dSEnji Cooper
1221*132f818dSEnji Cooper<div class="memitem">
1222*132f818dSEnji Cooper<div class="memproto">
1223*132f818dSEnji Cooper      <table class="memname">
1224*132f818dSEnji Cooper        <tr>
1225*132f818dSEnji Cooper          <td class="memname">void lutok::state::push_integer </td>
1226*132f818dSEnji Cooper          <td>(</td>
1227*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
1228*132f818dSEnji Cooper          <td class="paramname"><em>value</em></td><td>)</td>
1229*132f818dSEnji Cooper          <td></td>
1230*132f818dSEnji Cooper        </tr>
1231*132f818dSEnji Cooper      </table>
1232*132f818dSEnji Cooper</div><div class="memdoc">
1233*132f818dSEnji Cooper
1234*132f818dSEnji Cooper<p>Wrapper around lua_pushinteger. </p>
1235*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
1236*132f818dSEnji Cooper  <table class="params">
1237*132f818dSEnji Cooper    <tr><td class="paramname">value</td><td>The second parameter to lua_pushinteger. </td></tr>
1238*132f818dSEnji Cooper  </table>
1239*132f818dSEnji Cooper  </dd>
1240*132f818dSEnji Cooper</dl>
1241*132f818dSEnji Cooper
1242*132f818dSEnji Cooper</div>
1243*132f818dSEnji Cooper</div>
1244*132f818dSEnji Cooper<a id="a90859ee0fb17b13c3ebf4dfbfbee8c15" name="a90859ee0fb17b13c3ebf4dfbfbee8c15"></a>
1245*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a90859ee0fb17b13c3ebf4dfbfbee8c15">&#9670;&#160;</a></span>push_string()</h2>
1246*132f818dSEnji Cooper
1247*132f818dSEnji Cooper<div class="memitem">
1248*132f818dSEnji Cooper<div class="memproto">
1249*132f818dSEnji Cooper      <table class="memname">
1250*132f818dSEnji Cooper        <tr>
1251*132f818dSEnji Cooper          <td class="memname">void lutok::state::push_string </td>
1252*132f818dSEnji Cooper          <td>(</td>
1253*132f818dSEnji Cooper          <td class="paramtype">const std::string &amp;&#160;</td>
1254*132f818dSEnji Cooper          <td class="paramname"><em>str</em></td><td>)</td>
1255*132f818dSEnji Cooper          <td></td>
1256*132f818dSEnji Cooper        </tr>
1257*132f818dSEnji Cooper      </table>
1258*132f818dSEnji Cooper</div><div class="memdoc">
1259*132f818dSEnji Cooper
1260*132f818dSEnji Cooper<p>Wrapper around lua_pushstring. </p>
1261*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
1262*132f818dSEnji Cooper  <table class="params">
1263*132f818dSEnji Cooper    <tr><td class="paramname">str</td><td>The second parameter to lua_pushstring.</td></tr>
1264*132f818dSEnji Cooper  </table>
1265*132f818dSEnji Cooper  </dd>
1266*132f818dSEnji Cooper</dl>
1267*132f818dSEnji Cooper<dl class="section warning"><dt>Warning</dt><dd>Terminates execution if there is not enough memory. </dd></dl>
1268*132f818dSEnji Cooper
1269*132f818dSEnji Cooper</div>
1270*132f818dSEnji Cooper</div>
1271*132f818dSEnji Cooper<a id="a48d4552a0e81c350b6ea1077018fc3fe" name="a48d4552a0e81c350b6ea1077018fc3fe"></a>
1272*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a48d4552a0e81c350b6ea1077018fc3fe">&#9670;&#160;</a></span>push_value()</h2>
1273*132f818dSEnji Cooper
1274*132f818dSEnji Cooper<div class="memitem">
1275*132f818dSEnji Cooper<div class="memproto">
1276*132f818dSEnji Cooper      <table class="memname">
1277*132f818dSEnji Cooper        <tr>
1278*132f818dSEnji Cooper          <td class="memname">void lutok::state::push_value </td>
1279*132f818dSEnji Cooper          <td>(</td>
1280*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
1281*132f818dSEnji Cooper          <td class="paramname"><em>index</em></td><td>)</td>
1282*132f818dSEnji Cooper          <td></td>
1283*132f818dSEnji Cooper        </tr>
1284*132f818dSEnji Cooper      </table>
1285*132f818dSEnji Cooper</div><div class="memdoc">
1286*132f818dSEnji Cooper
1287*132f818dSEnji Cooper<p>Wrapper around lua_pushvalue. </p>
1288*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
1289*132f818dSEnji Cooper  <table class="params">
1290*132f818dSEnji Cooper    <tr><td class="paramname">index</td><td>The second parameter to lua_pushvalue. </td></tr>
1291*132f818dSEnji Cooper  </table>
1292*132f818dSEnji Cooper  </dd>
1293*132f818dSEnji Cooper</dl>
1294*132f818dSEnji Cooper
1295*132f818dSEnji Cooper</div>
1296*132f818dSEnji Cooper</div>
1297*132f818dSEnji Cooper<a id="ad67d44dd8d7273cfce233731ad8f10d7" name="ad67d44dd8d7273cfce233731ad8f10d7"></a>
1298*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#ad67d44dd8d7273cfce233731ad8f10d7">&#9670;&#160;</a></span>raw_get()</h2>
1299*132f818dSEnji Cooper
1300*132f818dSEnji Cooper<div class="memitem">
1301*132f818dSEnji Cooper<div class="memproto">
1302*132f818dSEnji Cooper      <table class="memname">
1303*132f818dSEnji Cooper        <tr>
1304*132f818dSEnji Cooper          <td class="memname">void lutok::state::raw_get </td>
1305*132f818dSEnji Cooper          <td>(</td>
1306*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
1307*132f818dSEnji Cooper          <td class="paramname"><em>index</em></td><td>)</td>
1308*132f818dSEnji Cooper          <td></td>
1309*132f818dSEnji Cooper        </tr>
1310*132f818dSEnji Cooper      </table>
1311*132f818dSEnji Cooper</div><div class="memdoc">
1312*132f818dSEnji Cooper
1313*132f818dSEnji Cooper<p>Wrapper around lua_rawget. </p>
1314*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
1315*132f818dSEnji Cooper  <table class="params">
1316*132f818dSEnji Cooper    <tr><td class="paramname">index</td><td>The second parameter to lua_rawget. </td></tr>
1317*132f818dSEnji Cooper  </table>
1318*132f818dSEnji Cooper  </dd>
1319*132f818dSEnji Cooper</dl>
1320*132f818dSEnji Cooper
1321*132f818dSEnji Cooper</div>
1322*132f818dSEnji Cooper</div>
1323*132f818dSEnji Cooper<a id="aa81b48420e6749c8f957af9039df0b37" name="aa81b48420e6749c8f957af9039df0b37"></a>
1324*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#aa81b48420e6749c8f957af9039df0b37">&#9670;&#160;</a></span>raw_set()</h2>
1325*132f818dSEnji Cooper
1326*132f818dSEnji Cooper<div class="memitem">
1327*132f818dSEnji Cooper<div class="memproto">
1328*132f818dSEnji Cooper      <table class="memname">
1329*132f818dSEnji Cooper        <tr>
1330*132f818dSEnji Cooper          <td class="memname">void lutok::state::raw_set </td>
1331*132f818dSEnji Cooper          <td>(</td>
1332*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
1333*132f818dSEnji Cooper          <td class="paramname"><em>index</em></td><td>)</td>
1334*132f818dSEnji Cooper          <td></td>
1335*132f818dSEnji Cooper        </tr>
1336*132f818dSEnji Cooper      </table>
1337*132f818dSEnji Cooper</div><div class="memdoc">
1338*132f818dSEnji Cooper
1339*132f818dSEnji Cooper<p>Wrapper around lua_rawset. </p>
1340*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
1341*132f818dSEnji Cooper  <table class="params">
1342*132f818dSEnji Cooper    <tr><td class="paramname">index</td><td>The second parameter to lua_rawset.</td></tr>
1343*132f818dSEnji Cooper  </table>
1344*132f818dSEnji Cooper  </dd>
1345*132f818dSEnji Cooper</dl>
1346*132f818dSEnji Cooper<dl class="section warning"><dt>Warning</dt><dd>Terminates execution if there is not enough memory to manipulate the Lua stack. </dd></dl>
1347*132f818dSEnji Cooper
1348*132f818dSEnji Cooper</div>
1349*132f818dSEnji Cooper</div>
1350*132f818dSEnji Cooper<a id="a2b577a4a090b67aa5b9b7a3f0762ca18" name="a2b577a4a090b67aa5b9b7a3f0762ca18"></a>
1351*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a2b577a4a090b67aa5b9b7a3f0762ca18">&#9670;&#160;</a></span>raw_state()</h2>
1352*132f818dSEnji Cooper
1353*132f818dSEnji Cooper<div class="memitem">
1354*132f818dSEnji Cooper<div class="memproto">
1355*132f818dSEnji Cooper<table class="mlabels">
1356*132f818dSEnji Cooper  <tr>
1357*132f818dSEnji Cooper  <td class="mlabels-left">
1358*132f818dSEnji Cooper      <table class="memname">
1359*132f818dSEnji Cooper        <tr>
1360*132f818dSEnji Cooper          <td class="memname">void * lutok::state::raw_state </td>
1361*132f818dSEnji Cooper          <td>(</td>
1362*132f818dSEnji Cooper          <td class="paramtype">void&#160;</td>
1363*132f818dSEnji Cooper          <td class="paramname"></td><td>)</td>
1364*132f818dSEnji Cooper          <td></td>
1365*132f818dSEnji Cooper        </tr>
1366*132f818dSEnji Cooper      </table>
1367*132f818dSEnji Cooper  </td>
1368*132f818dSEnji Cooper  <td class="mlabels-right">
1369*132f818dSEnji Cooper<span class="mlabels"><span class="mlabel">private</span></span>  </td>
1370*132f818dSEnji Cooper  </tr>
1371*132f818dSEnji Cooper</table>
1372*132f818dSEnji Cooper</div><div class="memdoc">
1373*132f818dSEnji Cooper
1374*132f818dSEnji Cooper<p>Gets the internal lua_State object. </p>
1375*132f818dSEnji Cooper<dl class="section return"><dt>Returns</dt><dd>The raw Lua state. This is returned as a void pointer to prevent including the lua.hpp header file from our public interface. The only way to call this method is by using the c_gate module, and c_gate takes care of casting this object to the appropriate type. </dd></dl>
1376*132f818dSEnji Cooper
1377*132f818dSEnji Cooper</div>
1378*132f818dSEnji Cooper</div>
1379*132f818dSEnji Cooper<a id="ae8b4f75bb99611707739772417c36e5a" name="ae8b4f75bb99611707739772417c36e5a"></a>
1380*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#ae8b4f75bb99611707739772417c36e5a">&#9670;&#160;</a></span>set_global()</h2>
1381*132f818dSEnji Cooper
1382*132f818dSEnji Cooper<div class="memitem">
1383*132f818dSEnji Cooper<div class="memproto">
1384*132f818dSEnji Cooper      <table class="memname">
1385*132f818dSEnji Cooper        <tr>
1386*132f818dSEnji Cooper          <td class="memname">void lutok::state::set_global </td>
1387*132f818dSEnji Cooper          <td>(</td>
1388*132f818dSEnji Cooper          <td class="paramtype">const std::string &amp;&#160;</td>
1389*132f818dSEnji Cooper          <td class="paramname"><em>name</em></td><td>)</td>
1390*132f818dSEnji Cooper          <td></td>
1391*132f818dSEnji Cooper        </tr>
1392*132f818dSEnji Cooper      </table>
1393*132f818dSEnji Cooper</div><div class="memdoc">
1394*132f818dSEnji Cooper
1395*132f818dSEnji Cooper<p>Wrapper around lua_setglobal. </p>
1396*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
1397*132f818dSEnji Cooper  <table class="params">
1398*132f818dSEnji Cooper    <tr><td class="paramname">name</td><td>The second parameter to lua_setglobal.</td></tr>
1399*132f818dSEnji Cooper  </table>
1400*132f818dSEnji Cooper  </dd>
1401*132f818dSEnji Cooper</dl>
1402*132f818dSEnji Cooper<dl class="exception"><dt>Exceptions</dt><dd>
1403*132f818dSEnji Cooper  <table class="exception">
1404*132f818dSEnji Cooper    <tr><td class="paramname"><a class="el" href="a00899.html" title="Exception for errors raised by the Lua API library.">api_error</a></td><td>If lua_setglobal fails.</td></tr>
1405*132f818dSEnji Cooper  </table>
1406*132f818dSEnji Cooper  </dd>
1407*132f818dSEnji Cooper</dl>
1408*132f818dSEnji Cooper<dl class="section warning"><dt>Warning</dt><dd>Terminates execution if there is not enough memory to manipulate the Lua stack. </dd></dl>
1409*132f818dSEnji Cooper
1410*132f818dSEnji Cooper</div>
1411*132f818dSEnji Cooper</div>
1412*132f818dSEnji Cooper<a id="a9873b4860342a745a832f514ab803909" name="a9873b4860342a745a832f514ab803909"></a>
1413*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a9873b4860342a745a832f514ab803909">&#9670;&#160;</a></span>set_metatable()</h2>
1414*132f818dSEnji Cooper
1415*132f818dSEnji Cooper<div class="memitem">
1416*132f818dSEnji Cooper<div class="memproto">
1417*132f818dSEnji Cooper      <table class="memname">
1418*132f818dSEnji Cooper        <tr>
1419*132f818dSEnji Cooper          <td class="memname">void lutok::state::set_metatable </td>
1420*132f818dSEnji Cooper          <td>(</td>
1421*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
1422*132f818dSEnji Cooper          <td class="paramname"><em>index</em></td><td>)</td>
1423*132f818dSEnji Cooper          <td></td>
1424*132f818dSEnji Cooper        </tr>
1425*132f818dSEnji Cooper      </table>
1426*132f818dSEnji Cooper</div><div class="memdoc">
1427*132f818dSEnji Cooper
1428*132f818dSEnji Cooper<p>Wrapper around lua_setmetatable. </p>
1429*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
1430*132f818dSEnji Cooper  <table class="params">
1431*132f818dSEnji Cooper    <tr><td class="paramname">index</td><td>The second parameter to lua_setmetatable. </td></tr>
1432*132f818dSEnji Cooper  </table>
1433*132f818dSEnji Cooper  </dd>
1434*132f818dSEnji Cooper</dl>
1435*132f818dSEnji Cooper
1436*132f818dSEnji Cooper</div>
1437*132f818dSEnji Cooper</div>
1438*132f818dSEnji Cooper<a id="ac2467d43a04babb717b4d6d384cf074c" name="ac2467d43a04babb717b4d6d384cf074c"></a>
1439*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#ac2467d43a04babb717b4d6d384cf074c">&#9670;&#160;</a></span>set_table()</h2>
1440*132f818dSEnji Cooper
1441*132f818dSEnji Cooper<div class="memitem">
1442*132f818dSEnji Cooper<div class="memproto">
1443*132f818dSEnji Cooper      <table class="memname">
1444*132f818dSEnji Cooper        <tr>
1445*132f818dSEnji Cooper          <td class="memname">void lutok::state::set_table </td>
1446*132f818dSEnji Cooper          <td>(</td>
1447*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
1448*132f818dSEnji Cooper          <td class="paramname"><em>index</em></td><td>)</td>
1449*132f818dSEnji Cooper          <td></td>
1450*132f818dSEnji Cooper        </tr>
1451*132f818dSEnji Cooper      </table>
1452*132f818dSEnji Cooper</div><div class="memdoc">
1453*132f818dSEnji Cooper
1454*132f818dSEnji Cooper<p>Wrapper around lua_settable. </p>
1455*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
1456*132f818dSEnji Cooper  <table class="params">
1457*132f818dSEnji Cooper    <tr><td class="paramname">index</td><td>The second parameter to lua_settable.</td></tr>
1458*132f818dSEnji Cooper  </table>
1459*132f818dSEnji Cooper  </dd>
1460*132f818dSEnji Cooper</dl>
1461*132f818dSEnji Cooper<dl class="exception"><dt>Exceptions</dt><dd>
1462*132f818dSEnji Cooper  <table class="exception">
1463*132f818dSEnji Cooper    <tr><td class="paramname"><a class="el" href="a00899.html" title="Exception for errors raised by the Lua API library.">api_error</a></td><td>If lua_settable fails.</td></tr>
1464*132f818dSEnji Cooper  </table>
1465*132f818dSEnji Cooper  </dd>
1466*132f818dSEnji Cooper</dl>
1467*132f818dSEnji Cooper<dl class="section warning"><dt>Warning</dt><dd>Terminates execution if there is not enough memory to manipulate the Lua stack. </dd></dl>
1468*132f818dSEnji Cooper
1469*132f818dSEnji Cooper</div>
1470*132f818dSEnji Cooper</div>
1471*132f818dSEnji Cooper<a id="a32129410bd9c2cd170d60919d203a639" name="a32129410bd9c2cd170d60919d203a639"></a>
1472*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a32129410bd9c2cd170d60919d203a639">&#9670;&#160;</a></span>to_boolean()</h2>
1473*132f818dSEnji Cooper
1474*132f818dSEnji Cooper<div class="memitem">
1475*132f818dSEnji Cooper<div class="memproto">
1476*132f818dSEnji Cooper      <table class="memname">
1477*132f818dSEnji Cooper        <tr>
1478*132f818dSEnji Cooper          <td class="memname">bool lutok::state::to_boolean </td>
1479*132f818dSEnji Cooper          <td>(</td>
1480*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
1481*132f818dSEnji Cooper          <td class="paramname"><em>index</em></td><td>)</td>
1482*132f818dSEnji Cooper          <td></td>
1483*132f818dSEnji Cooper        </tr>
1484*132f818dSEnji Cooper      </table>
1485*132f818dSEnji Cooper</div><div class="memdoc">
1486*132f818dSEnji Cooper
1487*132f818dSEnji Cooper<p>Wrapper around lua_toboolean. </p>
1488*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
1489*132f818dSEnji Cooper  <table class="params">
1490*132f818dSEnji Cooper    <tr><td class="paramname">index</td><td>The second parameter to lua_toboolean.</td></tr>
1491*132f818dSEnji Cooper  </table>
1492*132f818dSEnji Cooper  </dd>
1493*132f818dSEnji Cooper</dl>
1494*132f818dSEnji Cooper<dl class="section return"><dt>Returns</dt><dd>The return value of lua_toboolean. </dd></dl>
1495*132f818dSEnji Cooper
1496*132f818dSEnji Cooper</div>
1497*132f818dSEnji Cooper</div>
1498*132f818dSEnji Cooper<a id="ad947a5fb78835427838e4e10b16cc34a" name="ad947a5fb78835427838e4e10b16cc34a"></a>
1499*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#ad947a5fb78835427838e4e10b16cc34a">&#9670;&#160;</a></span>to_integer()</h2>
1500*132f818dSEnji Cooper
1501*132f818dSEnji Cooper<div class="memitem">
1502*132f818dSEnji Cooper<div class="memproto">
1503*132f818dSEnji Cooper      <table class="memname">
1504*132f818dSEnji Cooper        <tr>
1505*132f818dSEnji Cooper          <td class="memname">long lutok::state::to_integer </td>
1506*132f818dSEnji Cooper          <td>(</td>
1507*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
1508*132f818dSEnji Cooper          <td class="paramname"><em>index</em></td><td>)</td>
1509*132f818dSEnji Cooper          <td></td>
1510*132f818dSEnji Cooper        </tr>
1511*132f818dSEnji Cooper      </table>
1512*132f818dSEnji Cooper</div><div class="memdoc">
1513*132f818dSEnji Cooper
1514*132f818dSEnji Cooper<p>Wrapper around lua_tointeger. </p>
1515*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
1516*132f818dSEnji Cooper  <table class="params">
1517*132f818dSEnji Cooper    <tr><td class="paramname">index</td><td>The second parameter to lua_tointeger.</td></tr>
1518*132f818dSEnji Cooper  </table>
1519*132f818dSEnji Cooper  </dd>
1520*132f818dSEnji Cooper</dl>
1521*132f818dSEnji Cooper<dl class="section return"><dt>Returns</dt><dd>The return value of lua_tointeger. </dd></dl>
1522*132f818dSEnji Cooper
1523*132f818dSEnji Cooper</div>
1524*132f818dSEnji Cooper</div>
1525*132f818dSEnji Cooper<a id="aa40dd851d1e2323c55356506922e7b60" name="aa40dd851d1e2323c55356506922e7b60"></a>
1526*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#aa40dd851d1e2323c55356506922e7b60">&#9670;&#160;</a></span>to_string()</h2>
1527*132f818dSEnji Cooper
1528*132f818dSEnji Cooper<div class="memitem">
1529*132f818dSEnji Cooper<div class="memproto">
1530*132f818dSEnji Cooper      <table class="memname">
1531*132f818dSEnji Cooper        <tr>
1532*132f818dSEnji Cooper          <td class="memname">std::string lutok::state::to_string </td>
1533*132f818dSEnji Cooper          <td>(</td>
1534*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
1535*132f818dSEnji Cooper          <td class="paramname"><em>index</em></td><td>)</td>
1536*132f818dSEnji Cooper          <td></td>
1537*132f818dSEnji Cooper        </tr>
1538*132f818dSEnji Cooper      </table>
1539*132f818dSEnji Cooper</div><div class="memdoc">
1540*132f818dSEnji Cooper
1541*132f818dSEnji Cooper<p>Wrapper around lua_tostring. </p>
1542*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
1543*132f818dSEnji Cooper  <table class="params">
1544*132f818dSEnji Cooper    <tr><td class="paramname">index</td><td>The second parameter to lua_tostring.</td></tr>
1545*132f818dSEnji Cooper  </table>
1546*132f818dSEnji Cooper  </dd>
1547*132f818dSEnji Cooper</dl>
1548*132f818dSEnji Cooper<dl class="section return"><dt>Returns</dt><dd>The return value of lua_tostring.</dd></dl>
1549*132f818dSEnji Cooper<dl class="section warning"><dt>Warning</dt><dd>Terminates execution if there is not enough memory. </dd></dl>
1550*132f818dSEnji Cooper
1551*132f818dSEnji Cooper</div>
1552*132f818dSEnji Cooper</div>
1553*132f818dSEnji Cooper<a id="a0d7c94591101c42e93726ef7999eb11d" name="a0d7c94591101c42e93726ef7999eb11d"></a>
1554*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a0d7c94591101c42e93726ef7999eb11d">&#9670;&#160;</a></span>to_userdata()</h2>
1555*132f818dSEnji Cooper
1556*132f818dSEnji Cooper<div class="memitem">
1557*132f818dSEnji Cooper<div class="memproto">
1558*132f818dSEnji Cooper<div class="memtemplate">
1559*132f818dSEnji Coopertemplate&lt;typename Type &gt; </div>
1560*132f818dSEnji Cooper      <table class="memname">
1561*132f818dSEnji Cooper        <tr>
1562*132f818dSEnji Cooper          <td class="memname">Type * lutok::state::to_userdata </td>
1563*132f818dSEnji Cooper          <td>(</td>
1564*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
1565*132f818dSEnji Cooper          <td class="paramname"><em>index</em></td><td>)</td>
1566*132f818dSEnji Cooper          <td></td>
1567*132f818dSEnji Cooper        </tr>
1568*132f818dSEnji Cooper      </table>
1569*132f818dSEnji Cooper</div><div class="memdoc">
1570*132f818dSEnji Cooper
1571*132f818dSEnji Cooper<p>Wrapper around lua_touserdata. </p>
1572*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
1573*132f818dSEnji Cooper  <table class="params">
1574*132f818dSEnji Cooper    <tr><td class="paramname">index</td><td>The second parameter to lua_touserdata.</td></tr>
1575*132f818dSEnji Cooper  </table>
1576*132f818dSEnji Cooper  </dd>
1577*132f818dSEnji Cooper</dl>
1578*132f818dSEnji Cooper<dl class="section return"><dt>Returns</dt><dd>The return value of lua_touserdata. </dd></dl>
1579*132f818dSEnji Cooper
1580*132f818dSEnji Cooper</div>
1581*132f818dSEnji Cooper</div>
1582*132f818dSEnji Cooper<a id="a4054e2df5af0cc5db61c7560637406ea" name="a4054e2df5af0cc5db61c7560637406ea"></a>
1583*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a4054e2df5af0cc5db61c7560637406ea">&#9670;&#160;</a></span>to_userdata_voidp()</h2>
1584*132f818dSEnji Cooper
1585*132f818dSEnji Cooper<div class="memitem">
1586*132f818dSEnji Cooper<div class="memproto">
1587*132f818dSEnji Cooper<table class="mlabels">
1588*132f818dSEnji Cooper  <tr>
1589*132f818dSEnji Cooper  <td class="mlabels-left">
1590*132f818dSEnji Cooper      <table class="memname">
1591*132f818dSEnji Cooper        <tr>
1592*132f818dSEnji Cooper          <td class="memname">void * lutok::state::to_userdata_voidp </td>
1593*132f818dSEnji Cooper          <td>(</td>
1594*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
1595*132f818dSEnji Cooper          <td class="paramname"><em>index</em></td><td>)</td>
1596*132f818dSEnji Cooper          <td></td>
1597*132f818dSEnji Cooper        </tr>
1598*132f818dSEnji Cooper      </table>
1599*132f818dSEnji Cooper  </td>
1600*132f818dSEnji Cooper  <td class="mlabels-right">
1601*132f818dSEnji Cooper<span class="mlabels"><span class="mlabel">private</span></span>  </td>
1602*132f818dSEnji Cooper  </tr>
1603*132f818dSEnji Cooper</table>
1604*132f818dSEnji Cooper</div><div class="memdoc">
1605*132f818dSEnji Cooper
1606*132f818dSEnji Cooper<p>Wrapper around lua_touserdata. </p>
1607*132f818dSEnji Cooper<p>This is internal. The public type-safe interface of this method should be used instead.</p>
1608*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
1609*132f818dSEnji Cooper  <table class="params">
1610*132f818dSEnji Cooper    <tr><td class="paramname">index</td><td>The second parameter to lua_touserdata.</td></tr>
1611*132f818dSEnji Cooper  </table>
1612*132f818dSEnji Cooper  </dd>
1613*132f818dSEnji Cooper</dl>
1614*132f818dSEnji Cooper<dl class="section return"><dt>Returns</dt><dd>The return value of lua_touserdata.</dd></dl>
1615*132f818dSEnji Cooper<dl class="section warning"><dt>Warning</dt><dd>Terminates execution if there is not enough memory. </dd></dl>
1616*132f818dSEnji Cooper
1617*132f818dSEnji Cooper</div>
1618*132f818dSEnji Cooper</div>
1619*132f818dSEnji Cooper<a id="a1210a0875bde2a0452dd4813573b8865" name="a1210a0875bde2a0452dd4813573b8865"></a>
1620*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a1210a0875bde2a0452dd4813573b8865">&#9670;&#160;</a></span>upvalue_index()</h2>
1621*132f818dSEnji Cooper
1622*132f818dSEnji Cooper<div class="memitem">
1623*132f818dSEnji Cooper<div class="memproto">
1624*132f818dSEnji Cooper      <table class="memname">
1625*132f818dSEnji Cooper        <tr>
1626*132f818dSEnji Cooper          <td class="memname">int lutok::state::upvalue_index </td>
1627*132f818dSEnji Cooper          <td>(</td>
1628*132f818dSEnji Cooper          <td class="paramtype">const int&#160;</td>
1629*132f818dSEnji Cooper          <td class="paramname"><em>index</em></td><td>)</td>
1630*132f818dSEnji Cooper          <td></td>
1631*132f818dSEnji Cooper        </tr>
1632*132f818dSEnji Cooper      </table>
1633*132f818dSEnji Cooper</div><div class="memdoc">
1634*132f818dSEnji Cooper
1635*132f818dSEnji Cooper<p>Wrapper around lua_upvalueindex. </p>
1636*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
1637*132f818dSEnji Cooper  <table class="params">
1638*132f818dSEnji Cooper    <tr><td class="paramname">index</td><td>The first parameter to lua_upvalueindex.</td></tr>
1639*132f818dSEnji Cooper  </table>
1640*132f818dSEnji Cooper  </dd>
1641*132f818dSEnji Cooper</dl>
1642*132f818dSEnji Cooper<dl class="section return"><dt>Returns</dt><dd>The return value of lua_upvalueindex. </dd></dl>
1643*132f818dSEnji Cooper
1644*132f818dSEnji Cooper</div>
1645*132f818dSEnji Cooper</div>
1646*132f818dSEnji Cooper<hr/>The documentation for this class was generated from the following files:<ul>
1647*132f818dSEnji Cooper<li><a class="el" href="a00029_source.html">state.hpp</a></li>
1648*132f818dSEnji Cooper<li>state.cpp</li>
1649*132f818dSEnji Cooper<li>state.ipp</li>
1650*132f818dSEnji Cooper</ul>
1651*132f818dSEnji Cooper</div><!-- contents -->
1652*132f818dSEnji Cooper<!-- start footer part -->
1653*132f818dSEnji Cooper<hr class="footer"/><address class="footer"><small>
1654*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
1655*132f818dSEnji Cooper</small></address>
1656*132f818dSEnji Cooper</body>
1657*132f818dSEnji Cooper</html>
1658