Files
dl/document/html/classdl_1_1_lua_script.html
2026-09-16 14:07:40 +08:00

378 lines
18 KiB
HTML
Vendored

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="zh">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>dl: dl::LuaScript类 参考</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">dl
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- 制作者 Doxygen 1.13.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',false,false,'search.php','搜索',false);
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacedl.html">dl</a></li><li class="navelem"><a class="el" href="classdl_1_1_lua_script.html">LuaScript</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes"></a> &#124;
<a href="#pub-methods">Public 成员函数</a> &#124;
<a href="classdl_1_1_lua_script-members.html">所有成员列表</a> </div>
<div class="headertitle"><div class="title">dl::LuaScript类 参考</div></div>
</div><!--header-->
<div class="contents">
<p>lua脚本语言
<a href="#details">更多...</a></p>
<p><code>#include &lt;<a class="el" href="dl__lua_8h_source.html">dl_lua.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdl_1_1_lua_script_1_1_env.html">Env</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public 成员函数</h2></td></tr>
<tr class="memitem:a133776020bceda7e91fc534d97e4fd8f" id="r_a133776020bceda7e91fc534d97e4fd8f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a133776020bceda7e91fc534d97e4fd8f">LuaScript</a> ()</td></tr>
<tr class="separator:a133776020bceda7e91fc534d97e4fd8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab71d927465c5199e2a6ded227b5e9f78" id="r_ab71d927465c5199e2a6ded227b5e9f78"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab71d927465c5199e2a6ded227b5e9f78">~LuaScript</a> ()</td></tr>
<tr class="separator:ab71d927465c5199e2a6ded227b5e9f78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8dd2fe36ca0a43bd8410a65b9581dac8" id="r_a8dd2fe36ca0a43bd8410a65b9581dac8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8dd2fe36ca0a43bd8410a65b9581dac8">SetPathRoot</a> (std::string_view str)</td></tr>
<tr class="memdesc:a8dd2fe36ca0a43bd8410a65b9581dac8"><td class="mdescLeft">&#160;</td><td class="mdescRight">设置加载根路径 <br /></td></tr>
<tr class="separator:a8dd2fe36ca0a43bd8410a65b9581dac8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1e8205f2b1db3869030f9bd1e33c9ea" id="r_aa1e8205f2b1db3869030f9bd1e33c9ea"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa1e8205f2b1db3869030f9bd1e33c9ea">DoString</a> (std::string_view str)</td></tr>
<tr class="memdesc:aa1e8205f2b1db3869030f9bd1e33c9ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">执行lua字符串 <br /></td></tr>
<tr class="separator:aa1e8205f2b1db3869030f9bd1e33c9ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7881802db333f1485efc5ebb515eba67" id="r_a7881802db333f1485efc5ebb515eba67"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7881802db333f1485efc5ebb515eba67">DoFile</a> (std::string_view path_name)</td></tr>
<tr class="memdesc:a7881802db333f1485efc5ebb515eba67"><td class="mdescLeft">&#160;</td><td class="mdescRight">执行lua文件 <br /></td></tr>
<tr class="separator:a7881802db333f1485efc5ebb515eba67"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac35cea91078e8d74f379bd2e3c62d60b" id="r_ac35cea91078e8d74f379bd2e3c62d60b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac35cea91078e8d74f379bd2e3c62d60b">DoFileEx</a> (std::string_view path_name, LuaRef &amp;ret)</td></tr>
<tr class="memdesc:ac35cea91078e8d74f379bd2e3c62d60b"><td class="mdescLeft">&#160;</td><td class="mdescRight">执行lua文件,并获取返回值 <br /></td></tr>
<tr class="separator:ac35cea91078e8d74f379bd2e3c62d60b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7bec7465b8c31df79080a995e0a9c84" id="r_ae7bec7465b8c31df79080a995e0a9c84"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae7bec7465b8c31df79080a995e0a9c84">CallFunction</a> (LuaRef func)</td></tr>
<tr class="memdesc:ae7bec7465b8c31df79080a995e0a9c84"><td class="mdescLeft">&#160;</td><td class="mdescRight">调用函数 <br /></td></tr>
<tr class="separator:ae7bec7465b8c31df79080a995e0a9c84"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3068f83a7381cb384837835a94b12a2" id="r_af3068f83a7381cb384837835a94b12a2"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af3068f83a7381cb384837835a94b12a2">GetRefString</a> (LuaRef ref)</td></tr>
<tr class="memdesc:af3068f83a7381cb384837835a94b12a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">返回lua对象字符串 <br /></td></tr>
<tr class="separator:af3068f83a7381cb384837835a94b12a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3cb0dae2a05612b9954513573e1ba35c" id="r_a3cb0dae2a05612b9954513573e1ba35c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structdl_1_1_lua_script_1_1_env.html">Env</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3cb0dae2a05612b9954513573e1ba35c">GetEnv</a> ()</td></tr>
<tr class="separator:a3cb0dae2a05612b9954513573e1ba35c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5b70382a1cc8559da7b7338d8c5349f" id="r_ae5b70382a1cc8559da7b7338d8c5349f"><td class="memItemLeft" align="right" valign="top">lua_State *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae5b70382a1cc8559da7b7338d8c5349f">GetL</a> ()</td></tr>
<tr class="separator:ae5b70382a1cc8559da7b7338d8c5349f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9af3f74c8b20ea7ab23d39d18b804440" id="r_a9af3f74c8b20ea7ab23d39d18b804440"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9af3f74c8b20ea7ab23d39d18b804440">RegisterAll</a> ()</td></tr>
<tr class="separator:a9af3f74c8b20ea7ab23d39d18b804440"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">详细描述</h2>
<div class="textblock"><p>lua脚本语言 </p>
<p class="definition">在文件 <a class="el" href="dl__lua_8h_source.html">dl_lua.h</a><a class="el" href="dl__lua_8h_source.html#l00038">38</a> 行定义.</p>
</div><h2 class="groupheader">构造及析构函数说明</h2>
<a id="a133776020bceda7e91fc534d97e4fd8f" name="a133776020bceda7e91fc534d97e4fd8f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a133776020bceda7e91fc534d97e4fd8f">&#9670;&#160;</a></span>LuaScript()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dl::LuaScript::LuaScript </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ab71d927465c5199e2a6ded227b5e9f78" name="ab71d927465c5199e2a6ded227b5e9f78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab71d927465c5199e2a6ded227b5e9f78">&#9670;&#160;</a></span>~LuaScript()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dl::LuaScript::~LuaScript </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">成员函数说明</h2>
<a id="ae7bec7465b8c31df79080a995e0a9c84" name="ae7bec7465b8c31df79080a995e0a9c84"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7bec7465b8c31df79080a995e0a9c84">&#9670;&#160;</a></span>CallFunction()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool dl::LuaScript::CallFunction </td>
<td>(</td>
<td class="paramtype">LuaRef</td> <td class="paramname"><span class="paramname"><em>func</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>调用函数 </p>
<dl class="params"><dt>参数</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>lua对象(函数) </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>注解</dt><dd>失败会打印日志 </dd></dl>
</div>
</div>
<a id="a7881802db333f1485efc5ebb515eba67" name="a7881802db333f1485efc5ebb515eba67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7881802db333f1485efc5ebb515eba67">&#9670;&#160;</a></span>DoFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool dl::LuaScript::DoFile </td>
<td>(</td>
<td class="paramtype">std::string_view</td> <td class="paramname"><span class="paramname"><em>path_name</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>执行lua文件 </p>
</div>
</div>
<a id="ac35cea91078e8d74f379bd2e3c62d60b" name="ac35cea91078e8d74f379bd2e3c62d60b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac35cea91078e8d74f379bd2e3c62d60b">&#9670;&#160;</a></span>DoFileEx()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool dl::LuaScript::DoFileEx </td>
<td>(</td>
<td class="paramtype">std::string_view</td> <td class="paramname"><span class="paramname"><em>path_name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">LuaRef &amp;</td> <td class="paramname"><span class="paramname"><em>ret</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>执行lua文件,并获取返回值 </p>
</div>
</div>
<a id="aa1e8205f2b1db3869030f9bd1e33c9ea" name="aa1e8205f2b1db3869030f9bd1e33c9ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa1e8205f2b1db3869030f9bd1e33c9ea">&#9670;&#160;</a></span>DoString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool dl::LuaScript::DoString </td>
<td>(</td>
<td class="paramtype">std::string_view</td> <td class="paramname"><span class="paramname"><em>str</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>执行lua字符串 </p>
</div>
</div>
<a id="a3cb0dae2a05612b9954513573e1ba35c" name="a3cb0dae2a05612b9954513573e1ba35c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3cb0dae2a05612b9954513573e1ba35c">&#9670;&#160;</a></span>GetEnv()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structdl_1_1_lua_script_1_1_env.html">Env</a> &amp; dl::LuaScript::GetEnv </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">在文件 <a class="el" href="dl__lua_8h_source.html">dl_lua.h</a><a class="el" href="dl__lua_8h_source.html#l00106">106</a> 行定义.</p>
</div>
</div>
<a id="ae5b70382a1cc8559da7b7338d8c5349f" name="ae5b70382a1cc8559da7b7338d8c5349f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5b70382a1cc8559da7b7338d8c5349f">&#9670;&#160;</a></span>GetL()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">lua_State * dl::LuaScript::GetL </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">在文件 <a class="el" href="dl__lua_8h_source.html">dl_lua.h</a><a class="el" href="dl__lua_8h_source.html#l00107">107</a> 行定义.</p>
</div>
</div>
<a id="af3068f83a7381cb384837835a94b12a2" name="af3068f83a7381cb384837835a94b12a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af3068f83a7381cb384837835a94b12a2">&#9670;&#160;</a></span>GetRefString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string dl::LuaScript::GetRefString </td>
<td>(</td>
<td class="paramtype">LuaRef</td> <td class="paramname"><span class="paramname"><em>ref</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>返回lua对象字符串 </p>
<dl class="params"><dt>参数</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>lua对象(函数、字符串) </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>返回值</dt><dd>
<table class="retval">
<tr><td class="paramname">失败返回空(不会打印)</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9af3f74c8b20ea7ab23d39d18b804440" name="a9af3f74c8b20ea7ab23d39d18b804440"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9af3f74c8b20ea7ab23d39d18b804440">&#9670;&#160;</a></span>RegisterAll()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void dl::LuaScript::RegisterAll </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a8dd2fe36ca0a43bd8410a65b9581dac8" name="a8dd2fe36ca0a43bd8410a65b9581dac8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8dd2fe36ca0a43bd8410a65b9581dac8">&#9670;&#160;</a></span>SetPathRoot()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void dl::LuaScript::SetPathRoot </td>
<td>(</td>
<td class="paramtype">std::string_view</td> <td class="paramname"><span class="paramname"><em>str</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>设置加载根路径 </p>
<p class="definition">在文件 <a class="el" href="dl__lua_8h_source.html">dl_lua.h</a><a class="el" href="dl__lua_8h_source.html#l00051">51</a> 行定义.</p>
</div>
</div>
<hr/>该类的文档由以下文件生成:<ul>
<li>D:/dl/dl/script/<a class="el" href="dl__lua_8h_source.html">dl_lua.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
制作者&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.1
</small></address>
</div><!-- doc-content -->
</body>
</html>