| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <title>MetaScripting</title>
- <link href="torquedoc.css" rel="stylesheet" type="text/css"/>
- </head>
- <body>
- <table width="100%" class="header">
- <tr>
- </tr>
- <tr><td class="headermenu">
- <center>
- <a class="qindex" href="index.html">Main</a>
- <a class="qindex" target="_blank" href="https://github.com/GarageGames/Torque2D">GitHub</a>
- </center>
- </td></tr>
- </table>
- <br>
- <!-- END HEADER -->
- <!-- Generated by Doxygen 1.8.3.1 -->
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#func-members">Functions</a> </div>
- <div class="headertitle">
- <div class="title">MetaScripting</div> </div>
- </div><!--header-->
- <div class="contents">
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
- Functions</h2></td></tr>
- <tr class="memitem:ga5ae5ade473467797760e9d7b293c9df7"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScripting.html#ga5ae5ade473467797760e9d7b293c9df7">call</a> (funcName[, args...])</td></tr>
- <tr class="separator:ga5ae5ade473467797760e9d7b293c9df7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga1d153db73093a827fe97ed7b6fad3de7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScripting.html#ga1d153db73093a827fe97ed7b6fad3de7">compile</a> (<a class="el" href="group__FileSystem.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>)</td></tr>
- <tr class="separator:ga1d153db73093a827fe97ed7b6fad3de7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gafb10ba98c92f9c3ad3fbf0b3e518ca64"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScripting.html#gafb10ba98c92f9c3ad3fbf0b3e518ca64">compilePath</a> (path)</td></tr>
- <tr class="separator:gafb10ba98c92f9c3ad3fbf0b3e518ca64"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga0d0105433f9c65c14928027b3f0966b7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScripting.html#ga0d0105433f9c65c14928027b3f0966b7">debug</a> ()</td></tr>
- <tr class="separator:ga0d0105433f9c65c14928027b3f0966b7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga646e6c0e8dda1a1671c7f8288d93b244"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScripting.html#ga646e6c0e8dda1a1671c7f8288d93b244">deleteVariables</a> (wildCard)</td></tr>
- <tr class="separator:ga646e6c0e8dda1a1671c7f8288d93b244"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga6c88e0b36f23f3a7e4d9e1350e47300c"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScripting.html#ga6c88e0b36f23f3a7e4d9e1350e47300c">eval</a> (script)</td></tr>
- <tr class="separator:ga6c88e0b36f23f3a7e4d9e1350e47300c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga3288f063f851ab676ad5d8605db8d12c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScripting.html#ga3288f063f851ab676ad5d8605db8d12c">exec</a> (<a class="el" href="group__FileSystem.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>[, nocalls[, journalScript]])</td></tr>
- <tr class="separator:ga3288f063f851ab676ad5d8605db8d12c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga4d3588701d858a690d9c8dc28990ba93"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScripting.html#ga4d3588701d858a690d9c8dc28990ba93">execPrefs</a> (<a class="el" href="group__FileSystem.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>[, nocalls[, journalScript]])</td></tr>
- <tr class="separator:ga4d3588701d858a690d9c8dc28990ba93"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gae4bcdf697b4c1f6013ab10ecb9221467"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScripting.html#gae4bcdf697b4c1f6013ab10ecb9221467">export</a> (wildCard[, <a class="el" href="group__FileSystem.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>[, append]])</td></tr>
- <tr class="separator:gae4bcdf697b4c1f6013ab10ecb9221467"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gab380731d6fce2b2a2bcf3ab9365a0a66"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScripting.html#gab380731d6fce2b2a2bcf3ab9365a0a66">getDSOPath</a> (scriptFileName)</td></tr>
- <tr class="separator:gab380731d6fce2b2a2bcf3ab9365a0a66"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga5bfe3cd6141de45d4ba94cdd1fcc3277"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScripting.html#ga5bfe3cd6141de45d4ba94cdd1fcc3277">getModNameFromPath</a> (string path)</td></tr>
- <tr class="separator:ga5bfe3cd6141de45d4ba94cdd1fcc3277"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gacb58901f6b8e05c2a1a3cf483f2cea6d"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScripting.html#gacb58901f6b8e05c2a1a3cf483f2cea6d">getPrefsPath</a> ([<a class="el" href="group__FileSystem.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>])</td></tr>
- <tr class="separator:gacb58901f6b8e05c2a1a3cf483f2cea6d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga917a60496d6a11d9cf6ad526a6bc132b"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScripting.html#ga917a60496d6a11d9cf6ad526a6bc132b">getVariable</a> (string varName)</td></tr>
- <tr class="separator:ga917a60496d6a11d9cf6ad526a6bc132b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga909913d09ade9f6cb76f094856a1846a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScripting.html#ga909913d09ade9f6cb76f094856a1846a">isFunction</a> (string funcName)</td></tr>
- <tr class="separator:ga909913d09ade9f6cb76f094856a1846a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga1084c274a5b2666b356d63ed54e5acb9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScripting.html#ga1084c274a5b2666b356d63ed54e5acb9">isMethod</a> (string namespace, string method)</td></tr>
- <tr class="separator:ga1084c274a5b2666b356d63ed54e5acb9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gae39262a34f5e7fc4a214c2c1aa6e96b0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScripting.html#gae39262a34f5e7fc4a214c2c1aa6e96b0">setScriptExecEcho</a> (<a class="el" href="group__Output.html#ga3f0384585236a6e8d91454d2f6e90a60">echo</a>?)</td></tr>
- <tr class="separator:gae39262a34f5e7fc4a214c2c1aa6e96b0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga33da75a5c4c611bd1d78535974f5362d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScripting.html#ga33da75a5c4c611bd1d78535974f5362d">trace</a> (enable)</td></tr>
- <tr class="separator:ga33da75a5c4c611bd1d78535974f5362d"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <p>Functions that let you manipulate the scripting engine programmatically. </p>
- <h2 class="groupheader">Function Documentation</h2>
- <a class="anchor" id="ga5ae5ade473467797760e9d7b293c9df7"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string call </td>
- <td>(</td>
- <td class="paramtype">funcName </td>
- <td class="paramname">[, args...]</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__MetaScripting.html#ga6c88e0b36f23f3a7e4d9e1350e47300c">eval</a> </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ga1d153db73093a827fe97ed7b6fad3de7"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool compile </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__FileSystem.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a> </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__MetaScripting.html#ga3288f063f851ab676ad5d8605db8d12c">exec</a> </dd></dl>
- </div>
- </div>
- <a class="anchor" id="gafb10ba98c92f9c3ad3fbf0b3e518ca64"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string compilePath </td>
- <td>(</td>
- <td class="paramtype">path </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a class="anchor" id="ga0d0105433f9c65c14928027b3f0966b7"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void 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 class="anchor" id="ga646e6c0e8dda1a1671c7f8288d93b244"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void deleteVariables </td>
- <td>(</td>
- <td class="paramtype">wildCard </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 class="anchor" id="ga6c88e0b36f23f3a7e4d9e1350e47300c"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string eval </td>
- <td>(</td>
- <td class="paramtype">script </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__MetaScripting.html#ga5ae5ade473467797760e9d7b293c9df7">call</a> </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ga3288f063f851ab676ad5d8605db8d12c"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool exec </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__FileSystem.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>] </td>
- <td class="paramname">[, nocalls[, journalScript]</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__MetaScripting.html#ga1d153db73093a827fe97ed7b6fad3de7">compile</a> </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ga4d3588701d858a690d9c8dc28990ba93"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool execPrefs </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__FileSystem.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>] </td>
- <td class="paramname">[, nocalls[, journalScript]</td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a class="anchor" id="gae4bcdf697b4c1f6013ab10ecb9221467"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void export </td>
- <td>(</td>
- <td class="paramtype">wildCard] </td>
- <td class="paramname">[,fileName[, append]</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>
- <a class="anchor" id="gab380731d6fce2b2a2bcf3ab9365a0a66"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string getDSOPath </td>
- <td>(</td>
- <td class="paramtype">scriptFileName </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 class="anchor" id="ga5bfe3cd6141de45d4ba94cdd1fcc3277"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string getModNameFromPath </td>
- <td>(</td>
- <td class="paramtype">string </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 class="anchor" id="gacb58901f6b8e05c2a1a3cf483f2cea6d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string getPrefsPath </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a class="anchor" id="ga917a60496d6a11d9cf6ad526a6bc132b"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string getVariable </td>
- <td>(</td>
- <td class="paramtype">string </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 class="anchor" id="ga909913d09ade9f6cb76f094856a1846a"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool isFunction </td>
- <td>(</td>
- <td class="paramtype">string </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 class="anchor" id="ga1084c274a5b2666b356d63ed54e5acb9"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool isMethod </td>
- <td>(</td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>namespace</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>method</em> </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 class="anchor" id="gae39262a34f5e7fc4a214c2c1aa6e96b0"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void setScriptExecEcho </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__Output.html#ga3f0384585236a6e8d91454d2f6e90a60">echo</a>? </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <ul>
- <li>Whether to echo script file execution or not. </li>
- </ul>
- </div>
- </div>
- <a class="anchor" id="ga33da75a5c4c611bd1d78535974f5362d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void trace </td>
- <td>(</td>
- <td class="paramtype">enable </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>
- </div><!-- contents -->
- <!-- START FOOTER -->
- <br>
- <br>
- <center>
- <div style="color: #777777;">
- Copyright © 2013 <a style="color: #777777;" target="_blank" href="http://www.garagegames.com">GarageGames, LLC</a>. All Rights Reserved.
- </div>
- </center>
- </body>
- </html>
|