TorqueEngine
/
Torque2D
зеркало из https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597
							<!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="en-US">
<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.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>TorqueScript Reference: Meta-Scripting</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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="t2d-stylesheet-extra.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">TorqueScript Reference
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<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','Search');
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">Meta-Scripting<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga36f70153a5bb67504cdb173c16bb0567" id="r_ga36f70153a5bb67504cdb173c16bb0567"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScriptingFunctions.html#ga36f70153a5bb67504cdb173c16bb0567">call</a> (funcName, [args ...]?)</td></tr>
<tr class="separator:ga36f70153a5bb67504cdb173c16bb0567"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad5fb0a981781c3cbdc2ca5f4fb2d1fbd" id="r_gad5fb0a981781c3cbdc2ca5f4fb2d1fbd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScriptingFunctions.html#gad5fb0a981781c3cbdc2ca5f4fb2d1fbd">compile</a> (<a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>)</td></tr>
<tr class="separator:gad5fb0a981781c3cbdc2ca5f4fb2d1fbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3a28aee5a37e140b89af5c0dd005368a" id="r_ga3a28aee5a37e140b89af5c0dd005368a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScriptingFunctions.html#ga3a28aee5a37e140b89af5c0dd005368a">compilePath</a> (path)</td></tr>
<tr class="separator:ga3a28aee5a37e140b89af5c0dd005368a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0d0105433f9c65c14928027b3f0966b7" id="r_ga0d0105433f9c65c14928027b3f0966b7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScriptingFunctions.html#ga0d0105433f9c65c14928027b3f0966b7">debug</a> ()</td></tr>
<tr class="separator:ga0d0105433f9c65c14928027b3f0966b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga646e6c0e8dda1a1671c7f8288d93b244" id="r_ga646e6c0e8dda1a1671c7f8288d93b244"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScriptingFunctions.html#ga646e6c0e8dda1a1671c7f8288d93b244">deleteVariables</a> (wildCard)</td></tr>
<tr class="separator:ga646e6c0e8dda1a1671c7f8288d93b244"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4266cffd9543cdac25860c98a4528975" id="r_ga4266cffd9543cdac25860c98a4528975"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScriptingFunctions.html#ga4266cffd9543cdac25860c98a4528975">enumerateConsoleClasses</a> ([baseClass]?)</td></tr>
<tr class="separator:ga4266cffd9543cdac25860c98a4528975"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga539fb85d3a4d4a1a4e8ec8bc09f3c2bd" id="r_ga539fb85d3a4d4a1a4e8ec8bc09f3c2bd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScriptingFunctions.html#ga539fb85d3a4d4a1a4e8ec8bc09f3c2bd">eval</a> (script)</td></tr>
<tr class="separator:ga539fb85d3a4d4a1a4e8ec8bc09f3c2bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2f508cd989ace9296eda8e699108cfb4" id="r_ga2f508cd989ace9296eda8e699108cfb4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScriptingFunctions.html#ga2f508cd989ace9296eda8e699108cfb4">exec</a> (<a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>, [nocalls]?, [journalScript]?)</td></tr>
<tr class="separator:ga2f508cd989ace9296eda8e699108cfb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga199cc8f61c86c26446d43ddf40eb8490" id="r_ga199cc8f61c86c26446d43ddf40eb8490"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScriptingFunctions.html#ga199cc8f61c86c26446d43ddf40eb8490">execPrefs</a> (<a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>, [nocalls]?, [journalScript]?)</td></tr>
<tr class="separator:ga199cc8f61c86c26446d43ddf40eb8490"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga11fd62ba8811b2dd8f7cdc85dab0a305" id="r_ga11fd62ba8811b2dd8f7cdc85dab0a305"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScriptingFunctions.html#ga11fd62ba8811b2dd8f7cdc85dab0a305">getAppleDeviceIPAddress</a> ()</td></tr>
<tr class="separator:ga11fd62ba8811b2dd8f7cdc85dab0a305"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga890681cbb705378a184d8bcff93d7d72" id="r_ga890681cbb705378a184d8bcff93d7d72"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScriptingFunctions.html#ga890681cbb705378a184d8bcff93d7d72">getDSOPath</a> (scriptFileName)</td></tr>
<tr class="separator:ga890681cbb705378a184d8bcff93d7d72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0ebd75528902993c748fdf52b00e2081" id="r_ga0ebd75528902993c748fdf52b00e2081"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScriptingFunctions.html#ga0ebd75528902993c748fdf52b00e2081">getModNameFromPath</a> (string path)</td></tr>
<tr class="separator:ga0ebd75528902993c748fdf52b00e2081"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga333a8d2d5e17a3fe233825cb050e60f1" id="r_ga333a8d2d5e17a3fe233825cb050e60f1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScriptingFunctions.html#ga333a8d2d5e17a3fe233825cb050e60f1">getPrefsPath</a> ([<a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>]?)</td></tr>
<tr class="separator:ga333a8d2d5e17a3fe233825cb050e60f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga732bd5c5c6c0bf6a193ad275cfdc208d" id="r_ga732bd5c5c6c0bf6a193ad275cfdc208d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScriptingFunctions.html#ga732bd5c5c6c0bf6a193ad275cfdc208d">getVariable</a> (string varName)</td></tr>
<tr class="separator:ga732bd5c5c6c0bf6a193ad275cfdc208d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab14840a4465d4dab20117f341895dfb4" id="r_gab14840a4465d4dab20117f341895dfb4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScriptingFunctions.html#gab14840a4465d4dab20117f341895dfb4">isFunction</a> (string funcName)</td></tr>
<tr class="separator:gab14840a4465d4dab20117f341895dfb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3fc8f69d5837dd27ffa1331ce371018c" id="r_ga3fc8f69d5837dd27ffa1331ce371018c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScriptingFunctions.html#ga3fc8f69d5837dd27ffa1331ce371018c">isMethod</a> (string namespace, string method)</td></tr>
<tr class="separator:ga3fc8f69d5837dd27ffa1331ce371018c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae39262a34f5e7fc4a214c2c1aa6e96b0" id="r_gae39262a34f5e7fc4a214c2c1aa6e96b0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScriptingFunctions.html#gae39262a34f5e7fc4a214c2c1aa6e96b0">setScriptExecEcho</a> (<a class="el" href="group__ConsoleOutput.html#gadc918a80dc292eeae84dcca04998faba">echo</a>?)</td></tr>
<tr class="separator:gae39262a34f5e7fc4a214c2c1aa6e96b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga33da75a5c4c611bd1d78535974f5362d" id="r_ga33da75a5c4c611bd1d78535974f5362d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScriptingFunctions.html#ga33da75a5c4c611bd1d78535974f5362d">trace</a> (enable)</td></tr>
<tr class="separator:ga33da75a5c4c611bd1d78535974f5362d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3428b441d74b14a5aed2f08490b4b9f3" id="r_ga3428b441d74b14a5aed2f08490b4b9f3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> (wildCard, [<a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>]?, [append]?)</td></tr>
<tr class="separator:ga3428b441d74b14a5aed2f08490b4b9f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga36f70153a5bb67504cdb173c16bb0567" name="ga36f70153a5bb67504cdb173c16bb0567"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga36f70153a5bb67504cdb173c16bb0567">&#9670;&#160;</a></span>call()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> call </td>
          <td>(</td>
          <td class="paramtype">funcName&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">[args ... ] ?&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the call function to dynamically build and call a function. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">funcName</td><td>A string containing the unadorned name of a function to be executed. </td></tr>
    <tr><td class="paramname">args</td><td>.. - Any arguments that should be passed to the function. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a string containing the results from the function that is built and called. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__MetaScriptingFunctions.html#ga539fb85d3a4d4a1a4e8ec8bc09f3c2bd">eval</a> </dd></dl>

</div>
</div>
<a id="gad5fb0a981781c3cbdc2ca5f4fb2d1fbd" name="gad5fb0a981781c3cbdc2ca5f4fb2d1fbd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad5fb0a981781c3cbdc2ca5f4fb2d1fbd">&#9670;&#160;</a></span>compile()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> compile </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the compile function to pre-compile a script file without executing the contents. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">fileName</td><td>A path to the script to compile. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns 1 if the script compiled without errors and 0 if the file did not compile correctly or if the path is wrong. Also, ff the path is invalid, an error will print to the console. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__MetaScriptingFunctions.html#ga2f508cd989ace9296eda8e699108cfb4">exec</a> </dd></dl>

</div>
</div>
<a id="ga3a28aee5a37e140b89af5c0dd005368a" name="ga3a28aee5a37e140b89af5c0dd005368a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3a28aee5a37e140b89af5c0dd005368a">&#9670;&#160;</a></span>compilePath()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> compilePath </td>
          <td>(</td>
          <td class="paramtype">path&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="ga0d0105433f9c65c14928027b3f0966b7" name="ga0d0105433f9c65c14928027b3f0966b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0d0105433f9c65c14928027b3f0966b7">&#9670;&#160;</a></span>debug()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> debug </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the debug function to cause the engine to issue a debug break and to break into an active debugger. For this to work, the engine must have been compiled with either TORQUE_DEBUG, or INTERNAL_RELEASE defined </p><dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>

</div>
</div>
<a id="ga646e6c0e8dda1a1671c7f8288d93b244" name="ga646e6c0e8dda1a1671c7f8288d93b244"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga646e6c0e8dda1a1671c7f8288d93b244">&#9670;&#160;</a></span>deleteVariables()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> deleteVariables </td>
          <td>(</td>
          <td class="paramtype">wildCard&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the deleteVariables function to delete any global variable matching the wildCard statement. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">wildCard</td><td>A string identifying what variable(s) to delete. All characters used to create a global are allowed and the special symbol *\, meaning 0 or more instances of any character. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>

</div>
</div>
<a id="ga4266cffd9543cdac25860c98a4528975" name="ga4266cffd9543cdac25860c98a4528975"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4266cffd9543cdac25860c98a4528975">&#9670;&#160;</a></span>enumerateConsoleClasses()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> enumerateConsoleClasses </td>
          <td>(</td>
          <td class="paramtype">[baseClass] ?&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="ga539fb85d3a4d4a1a4e8ec8bc09f3c2bd" name="ga539fb85d3a4d4a1a4e8ec8bc09f3c2bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga539fb85d3a4d4a1a4e8ec8bc09f3c2bd">&#9670;&#160;</a></span>eval()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> eval </td>
          <td>(</td>
          <td class="paramtype">script&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the eval function to execute any valid script statement. If you choose to eval a multi-line statement, be sure that there are no comments or comment blocks embedded in the script string. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">script</td><td>A string containing a valid script statement. This may be a single line statement or multiple lines concatenated together with new-line characters. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the result of executing the script statement. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__MetaScriptingFunctions.html#ga36f70153a5bb67504cdb173c16bb0567">call</a> </dd></dl>

</div>
</div>
<a id="ga2f508cd989ace9296eda8e699108cfb4" name="ga2f508cd989ace9296eda8e699108cfb4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2f508cd989ace9296eda8e699108cfb4">&#9670;&#160;</a></span>exec()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> exec </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">[nocalls] ?&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">[journalScript ] ?&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the exec function to compile and execute a normal script, or a special journal script. If $Pref::ignoreDSOs is set to true, the system will use .cs before a .dso file if both are found. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">fileName</td><td>A string containing a path to the script to be compiled and executed. </td></tr>
    <tr><td class="paramname">nocalls</td><td>A boolean value. If this value is set to true, then all function calls encountered while executing the script file will be skipped and not called. This allows us to re-define function definitions found in a script file, without re-executing other worker scripts in the same file. </td></tr>
    <tr><td class="paramname">journalScript</td><td>A boolean value. If this value is set tot true, and if a journal is being played, the engine will attempt to read this script from the journal stream. If no journal is playing, this field is ignored. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true if the file compiled and executed w/o errors, false otherwise. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__MetaScriptingFunctions.html#gad5fb0a981781c3cbdc2ca5f4fb2d1fbd">compile</a> </dd></dl>

</div>
</div>
<a id="ga199cc8f61c86c26446d43ddf40eb8490" name="ga199cc8f61c86c26446d43ddf40eb8490"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga199cc8f61c86c26446d43ddf40eb8490">&#9670;&#160;</a></span>execPrefs()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> execPrefs </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">[nocalls] ?&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">[journalScript] ?&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="ga11fd62ba8811b2dd8f7cdc85dab0a305" name="ga11fd62ba8811b2dd8f7cdc85dab0a305"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga11fd62ba8811b2dd8f7cdc85dab0a305">&#9670;&#160;</a></span>getAppleDeviceIPAddress()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getAppleDeviceIPAddress </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Gets the Apple hardware local IP on wifi. Should work on OS X and iOS </p>

</div>
</div>
<a id="ga890681cbb705378a184d8bcff93d7d72" name="ga890681cbb705378a184d8bcff93d7d72"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga890681cbb705378a184d8bcff93d7d72">&#9670;&#160;</a></span>getDSOPath()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getDSOPath </td>
          <td>(</td>
          <td class="paramtype">scriptFileName&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Returns the DSO path of the given filename </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">scriptFileName</td><td>A string contains the file to search for </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns either the requested pathname as a string, or an empty string if not found. </dd></dl>

</div>
</div>
<a id="ga0ebd75528902993c748fdf52b00e2081" name="ga0ebd75528902993c748fdf52b00e2081"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0ebd75528902993c748fdf52b00e2081">&#9670;&#160;</a></span>getModNameFromPath()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getModNameFromPath </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>path</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Attempts to extract a mod directory from path. Returns empty string on failure. </p>

</div>
</div>
<a id="ga333a8d2d5e17a3fe233825cb050e60f1" name="ga333a8d2d5e17a3fe233825cb050e60f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga333a8d2d5e17a3fe233825cb050e60f1">&#9670;&#160;</a></span>getPrefsPath()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getPrefsPath </td>
          <td>(</td>
          <td class="paramtype">[fileName] ?&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="ga732bd5c5c6c0bf6a193ad275cfdc208d" name="ga732bd5c5c6c0bf6a193ad275cfdc208d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga732bd5c5c6c0bf6a193ad275cfdc208d">&#9670;&#160;</a></span>getVariable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getVariable </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>varName</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Grabs the relevant data for the variable represented by the given string </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">varName</td><td>A String representing the variable to check </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a string containing component data for the requested variable or an empty string if not found. </dd></dl>

</div>
</div>
<a id="gab14840a4465d4dab20117f341895dfb4" name="gab14840a4465d4dab20117f341895dfb4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab14840a4465d4dab20117f341895dfb4">&#9670;&#160;</a></span>isFunction()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isFunction </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>funcName</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Checks whether given name represents a current valid function. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">funcName</td><td>The name of the function to check. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns either true if the string represents a valid function or false if not. </dd></dl>

</div>
</div>
<a id="ga3fc8f69d5837dd27ffa1331ce371018c" name="ga3fc8f69d5837dd27ffa1331ce371018c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3fc8f69d5837dd27ffa1331ce371018c">&#9670;&#160;</a></span>isMethod()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isMethod </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>namespace</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>method</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Checks whether the given method name represents a valid method within the given namespace. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">namespace</td><td>A string representing the namespace in which the method should reside. </td></tr>
    <tr><td class="paramname">method</td><td>The name of the method in question. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a boolean value which is true if the given mathod name represents a valid method in the namespace and false otherwise. </dd></dl>

</div>
</div>
<a id="gae39262a34f5e7fc4a214c2c1aa6e96b0" name="gae39262a34f5e7fc4a214c2c1aa6e96b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae39262a34f5e7fc4a214c2c1aa6e96b0">&#9670;&#160;</a></span>setScriptExecEcho()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setScriptExecEcho </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__ConsoleOutput.html#gadc918a80dc292eeae84dcca04998faba">echo</a>?&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Whether to echo script file execution or not. </p>

</div>
</div>
<a id="ga33da75a5c4c611bd1d78535974f5362d" name="ga33da75a5c4c611bd1d78535974f5362d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga33da75a5c4c611bd1d78535974f5362d">&#9670;&#160;</a></span>trace()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> trace </td>
          <td>(</td>
          <td class="paramtype">enable&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the trace function to enable (or disable) function call tracing. If enabled, tracing will print a message every time a function is entered, showing what arguments it received, and it will print a message every time a function is exited, showing the return value (or last value of last statement) for that function. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">enable</td><td>A boolean value. If set to true, tracing is enabled, otherwise it is disabled. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>

</div>
</div>
<a id="ga3428b441d74b14a5aed2f08490b4b9f3" name="ga3428b441d74b14a5aed2f08490b4b9f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3428b441d74b14a5aed2f08490b4b9f3">&#9670;&#160;</a></span>void()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void </td>
          <td>(</td>
          <td class="paramtype">wildCard&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">[fileName] ?&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">[append] ?&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the export function to save all global variables matching the specified name pattern in wildCard to a file, either appending to that file or over-writing it. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">wildCard</td><td>A string identifying what variable(s) to export. All characters used to create a global are allowed and the special symbol *\, meaning 0 or more instances of any character. </td></tr>
    <tr><td class="paramname">fileName</td><td>A string containing a path to a file in which to save the globals and their definitions. </td></tr>
    <tr><td class="paramname">append</td><td>A boolean value. If this value is true, the file will be appended to if it exists, otherwise it will be created/over-written. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated 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.8
</small></address>
</body>
</html>