group__MetaScripting.html 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <title>MetaScripting</title>
  6. <link href="torquedoc.css" rel="stylesheet" type="text/css"/>
  7. </head>
  8. <body>
  9. <table width="100%" class="header">
  10. <tr>
  11. </tr>
  12. <tr><td class="headermenu">
  13. <center>
  14. <a class="qindex" href="index.html">Main</a> &nbsp;
  15. <a class="qindex" target="_blank" href="https://github.com/GarageGames/Torque2D">GitHub</a>
  16. </center>
  17. </td></tr>
  18. </table>
  19. <br>
  20. <!-- END HEADER -->
  21. <!-- Generated by Doxygen 1.8.3.1 -->
  22. </div><!-- top -->
  23. <div class="header">
  24. <div class="summary">
  25. <a href="#func-members">Functions</a> </div>
  26. <div class="headertitle">
  27. <div class="title">MetaScripting</div> </div>
  28. </div><!--header-->
  29. <div class="contents">
  30. <table class="memberdecls">
  31. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  32. Functions</h2></td></tr>
  33. <tr class="memitem:ga5ae5ade473467797760e9d7b293c9df7"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScripting.html#ga5ae5ade473467797760e9d7b293c9df7">call</a> (funcName[, args...])</td></tr>
  34. <tr class="separator:ga5ae5ade473467797760e9d7b293c9df7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  35. <tr class="memitem:ga1d153db73093a827fe97ed7b6fad3de7"><td class="memItemLeft" align="right" valign="top">bool&#160;</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>
  36. <tr class="separator:ga1d153db73093a827fe97ed7b6fad3de7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  37. <tr class="memitem:gafb10ba98c92f9c3ad3fbf0b3e518ca64"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScripting.html#gafb10ba98c92f9c3ad3fbf0b3e518ca64">compilePath</a> (path)</td></tr>
  38. <tr class="separator:gafb10ba98c92f9c3ad3fbf0b3e518ca64"><td class="memSeparator" colspan="2">&#160;</td></tr>
  39. <tr class="memitem:ga0d0105433f9c65c14928027b3f0966b7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScripting.html#ga0d0105433f9c65c14928027b3f0966b7">debug</a> ()</td></tr>
  40. <tr class="separator:ga0d0105433f9c65c14928027b3f0966b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  41. <tr class="memitem:ga646e6c0e8dda1a1671c7f8288d93b244"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScripting.html#ga646e6c0e8dda1a1671c7f8288d93b244">deleteVariables</a> (wildCard)</td></tr>
  42. <tr class="separator:ga646e6c0e8dda1a1671c7f8288d93b244"><td class="memSeparator" colspan="2">&#160;</td></tr>
  43. <tr class="memitem:ga6c88e0b36f23f3a7e4d9e1350e47300c"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScripting.html#ga6c88e0b36f23f3a7e4d9e1350e47300c">eval</a> (script)</td></tr>
  44. <tr class="separator:ga6c88e0b36f23f3a7e4d9e1350e47300c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  45. <tr class="memitem:ga3288f063f851ab676ad5d8605db8d12c"><td class="memItemLeft" align="right" valign="top">bool&#160;</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>
  46. <tr class="separator:ga3288f063f851ab676ad5d8605db8d12c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  47. <tr class="memitem:ga4d3588701d858a690d9c8dc28990ba93"><td class="memItemLeft" align="right" valign="top">bool&#160;</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>
  48. <tr class="separator:ga4d3588701d858a690d9c8dc28990ba93"><td class="memSeparator" colspan="2">&#160;</td></tr>
  49. <tr class="memitem:gae4bcdf697b4c1f6013ab10ecb9221467"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  50. <tr class="separator:gae4bcdf697b4c1f6013ab10ecb9221467"><td class="memSeparator" colspan="2">&#160;</td></tr>
  51. <tr class="memitem:gab380731d6fce2b2a2bcf3ab9365a0a66"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScripting.html#gab380731d6fce2b2a2bcf3ab9365a0a66">getDSOPath</a> (scriptFileName)</td></tr>
  52. <tr class="separator:gab380731d6fce2b2a2bcf3ab9365a0a66"><td class="memSeparator" colspan="2">&#160;</td></tr>
  53. <tr class="memitem:ga5bfe3cd6141de45d4ba94cdd1fcc3277"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScripting.html#ga5bfe3cd6141de45d4ba94cdd1fcc3277">getModNameFromPath</a> (string path)</td></tr>
  54. <tr class="separator:ga5bfe3cd6141de45d4ba94cdd1fcc3277"><td class="memSeparator" colspan="2">&#160;</td></tr>
  55. <tr class="memitem:gacb58901f6b8e05c2a1a3cf483f2cea6d"><td class="memItemLeft" align="right" valign="top">string&#160;</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>
  56. <tr class="separator:gacb58901f6b8e05c2a1a3cf483f2cea6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57. <tr class="memitem:ga917a60496d6a11d9cf6ad526a6bc132b"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScripting.html#ga917a60496d6a11d9cf6ad526a6bc132b">getVariable</a> (string varName)</td></tr>
  58. <tr class="separator:ga917a60496d6a11d9cf6ad526a6bc132b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59. <tr class="memitem:ga909913d09ade9f6cb76f094856a1846a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScripting.html#ga909913d09ade9f6cb76f094856a1846a">isFunction</a> (string funcName)</td></tr>
  60. <tr class="separator:ga909913d09ade9f6cb76f094856a1846a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61. <tr class="memitem:ga1084c274a5b2666b356d63ed54e5acb9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScripting.html#ga1084c274a5b2666b356d63ed54e5acb9">isMethod</a> (string namespace, string method)</td></tr>
  62. <tr class="separator:ga1084c274a5b2666b356d63ed54e5acb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:gae39262a34f5e7fc4a214c2c1aa6e96b0"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  64. <tr class="separator:gae39262a34f5e7fc4a214c2c1aa6e96b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:ga33da75a5c4c611bd1d78535974f5362d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MetaScripting.html#ga33da75a5c4c611bd1d78535974f5362d">trace</a> (enable)</td></tr>
  66. <tr class="separator:ga33da75a5c4c611bd1d78535974f5362d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. </table>
  68. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  69. <p>Functions that let you manipulate the scripting engine programmatically. </p>
  70. <h2 class="groupheader">Function Documentation</h2>
  71. <a class="anchor" id="ga5ae5ade473467797760e9d7b293c9df7"></a>
  72. <div class="memitem">
  73. <div class="memproto">
  74. <table class="memname">
  75. <tr>
  76. <td class="memname">string call </td>
  77. <td>(</td>
  78. <td class="paramtype">funcName&#160;</td>
  79. <td class="paramname">[, args...]</td><td>)</td>
  80. <td></td>
  81. </tr>
  82. </table>
  83. </div><div class="memdoc">
  84. <p>Use the call function to dynamically build and call a function. </p>
  85. <dl class="params"><dt>Parameters</dt><dd>
  86. <table class="params">
  87. <tr><td class="paramname">funcName</td><td>A string containing the unadorned name of a function to be executed. </td></tr>
  88. <tr><td class="paramname">args</td><td>.. - Any arguments that should be passed to the function. </td></tr>
  89. </table>
  90. </dd>
  91. </dl>
  92. <dl class="section return"><dt>Returns</dt><dd>Returns a string containing the results from the function that is built and called. </dd></dl>
  93. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MetaScripting.html#ga6c88e0b36f23f3a7e4d9e1350e47300c">eval</a> </dd></dl>
  94. </div>
  95. </div>
  96. <a class="anchor" id="ga1d153db73093a827fe97ed7b6fad3de7"></a>
  97. <div class="memitem">
  98. <div class="memproto">
  99. <table class="memname">
  100. <tr>
  101. <td class="memname">bool compile </td>
  102. <td>(</td>
  103. <td class="paramtype"><a class="el" href="group__FileSystem.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>&#160;</td>
  104. <td class="paramname"></td><td>)</td>
  105. <td></td>
  106. </tr>
  107. </table>
  108. </div><div class="memdoc">
  109. <p>Use the compile function to pre-compile a script file without executing the contents. </p>
  110. <dl class="params"><dt>Parameters</dt><dd>
  111. <table class="params">
  112. <tr><td class="paramname">fileName</td><td>A path to the script to compile. </td></tr>
  113. </table>
  114. </dd>
  115. </dl>
  116. <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>
  117. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MetaScripting.html#ga3288f063f851ab676ad5d8605db8d12c">exec</a> </dd></dl>
  118. </div>
  119. </div>
  120. <a class="anchor" id="gafb10ba98c92f9c3ad3fbf0b3e518ca64"></a>
  121. <div class="memitem">
  122. <div class="memproto">
  123. <table class="memname">
  124. <tr>
  125. <td class="memname">string compilePath </td>
  126. <td>(</td>
  127. <td class="paramtype">path&#160;</td>
  128. <td class="paramname"></td><td>)</td>
  129. <td></td>
  130. </tr>
  131. </table>
  132. </div><div class="memdoc">
  133. </div>
  134. </div>
  135. <a class="anchor" id="ga0d0105433f9c65c14928027b3f0966b7"></a>
  136. <div class="memitem">
  137. <div class="memproto">
  138. <table class="memname">
  139. <tr>
  140. <td class="memname">void debug </td>
  141. <td>(</td>
  142. <td class="paramname"></td><td>)</td>
  143. <td></td>
  144. </tr>
  145. </table>
  146. </div><div class="memdoc">
  147. <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>
  148. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  149. </div>
  150. </div>
  151. <a class="anchor" id="ga646e6c0e8dda1a1671c7f8288d93b244"></a>
  152. <div class="memitem">
  153. <div class="memproto">
  154. <table class="memname">
  155. <tr>
  156. <td class="memname">void deleteVariables </td>
  157. <td>(</td>
  158. <td class="paramtype">wildCard&#160;</td>
  159. <td class="paramname"></td><td>)</td>
  160. <td></td>
  161. </tr>
  162. </table>
  163. </div><div class="memdoc">
  164. <p>Use the deleteVariables function to delete any global variable matching the wildCard statement. </p>
  165. <dl class="params"><dt>Parameters</dt><dd>
  166. <table class="params">
  167. <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>
  168. </table>
  169. </dd>
  170. </dl>
  171. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  172. </div>
  173. </div>
  174. <a class="anchor" id="ga6c88e0b36f23f3a7e4d9e1350e47300c"></a>
  175. <div class="memitem">
  176. <div class="memproto">
  177. <table class="memname">
  178. <tr>
  179. <td class="memname">string eval </td>
  180. <td>(</td>
  181. <td class="paramtype">script&#160;</td>
  182. <td class="paramname"></td><td>)</td>
  183. <td></td>
  184. </tr>
  185. </table>
  186. </div><div class="memdoc">
  187. <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>
  188. <dl class="params"><dt>Parameters</dt><dd>
  189. <table class="params">
  190. <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>
  191. </table>
  192. </dd>
  193. </dl>
  194. <dl class="section return"><dt>Returns</dt><dd>Returns the result of executing the script statement. </dd></dl>
  195. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MetaScripting.html#ga5ae5ade473467797760e9d7b293c9df7">call</a> </dd></dl>
  196. </div>
  197. </div>
  198. <a class="anchor" id="ga3288f063f851ab676ad5d8605db8d12c"></a>
  199. <div class="memitem">
  200. <div class="memproto">
  201. <table class="memname">
  202. <tr>
  203. <td class="memname">bool exec </td>
  204. <td>(</td>
  205. <td class="paramtype"><a class="el" href="group__FileSystem.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>]&#160;</td>
  206. <td class="paramname">[, nocalls[, journalScript]</td><td>)</td>
  207. <td></td>
  208. </tr>
  209. </table>
  210. </div><div class="memdoc">
  211. <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>
  212. <dl class="params"><dt>Parameters</dt><dd>
  213. <table class="params">
  214. <tr><td class="paramname">fileName</td><td>A string containing a path to the script to be compiled and executed. </td></tr>
  215. <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>
  216. <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>
  217. </table>
  218. </dd>
  219. </dl>
  220. <dl class="section return"><dt>Returns</dt><dd>Returns true if the file compiled and executed w/o errors, false otherwise. </dd></dl>
  221. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__MetaScripting.html#ga1d153db73093a827fe97ed7b6fad3de7">compile</a> </dd></dl>
  222. </div>
  223. </div>
  224. <a class="anchor" id="ga4d3588701d858a690d9c8dc28990ba93"></a>
  225. <div class="memitem">
  226. <div class="memproto">
  227. <table class="memname">
  228. <tr>
  229. <td class="memname">bool execPrefs </td>
  230. <td>(</td>
  231. <td class="paramtype"><a class="el" href="group__FileSystem.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>]&#160;</td>
  232. <td class="paramname">[, nocalls[, journalScript]</td><td>)</td>
  233. <td></td>
  234. </tr>
  235. </table>
  236. </div><div class="memdoc">
  237. </div>
  238. </div>
  239. <a class="anchor" id="gae4bcdf697b4c1f6013ab10ecb9221467"></a>
  240. <div class="memitem">
  241. <div class="memproto">
  242. <table class="memname">
  243. <tr>
  244. <td class="memname">void export </td>
  245. <td>(</td>
  246. <td class="paramtype">wildCard]&#160;</td>
  247. <td class="paramname">[,fileName[, append]</td><td>)</td>
  248. <td></td>
  249. </tr>
  250. </table>
  251. </div><div class="memdoc">
  252. <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>
  253. <dl class="params"><dt>Parameters</dt><dd>
  254. <table class="params">
  255. <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>
  256. <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>
  257. <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>
  258. </table>
  259. </dd>
  260. </dl>
  261. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  262. </div>
  263. </div>
  264. <a class="anchor" id="gab380731d6fce2b2a2bcf3ab9365a0a66"></a>
  265. <div class="memitem">
  266. <div class="memproto">
  267. <table class="memname">
  268. <tr>
  269. <td class="memname">string getDSOPath </td>
  270. <td>(</td>
  271. <td class="paramtype">scriptFileName&#160;</td>
  272. <td class="paramname"></td><td>)</td>
  273. <td></td>
  274. </tr>
  275. </table>
  276. </div><div class="memdoc">
  277. <p>Returns the DSO path of the given filename </p>
  278. <dl class="params"><dt>Parameters</dt><dd>
  279. <table class="params">
  280. <tr><td class="paramname">scriptFileName</td><td>A string contains the file to search for </td></tr>
  281. </table>
  282. </dd>
  283. </dl>
  284. <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>
  285. </div>
  286. </div>
  287. <a class="anchor" id="ga5bfe3cd6141de45d4ba94cdd1fcc3277"></a>
  288. <div class="memitem">
  289. <div class="memproto">
  290. <table class="memname">
  291. <tr>
  292. <td class="memname">string getModNameFromPath </td>
  293. <td>(</td>
  294. <td class="paramtype">string&#160;</td>
  295. <td class="paramname"><em>path</em></td><td>)</td>
  296. <td></td>
  297. </tr>
  298. </table>
  299. </div><div class="memdoc">
  300. <p>Attempts to extract a mod directory from path. Returns empty string on failure. </p>
  301. </div>
  302. </div>
  303. <a class="anchor" id="gacb58901f6b8e05c2a1a3cf483f2cea6d"></a>
  304. <div class="memitem">
  305. <div class="memproto">
  306. <table class="memname">
  307. <tr>
  308. <td class="memname">string getPrefsPath </td>
  309. <td>(</td>
  310. <td class="paramname"></td><td>)</td>
  311. <td></td>
  312. </tr>
  313. </table>
  314. </div><div class="memdoc">
  315. </div>
  316. </div>
  317. <a class="anchor" id="ga917a60496d6a11d9cf6ad526a6bc132b"></a>
  318. <div class="memitem">
  319. <div class="memproto">
  320. <table class="memname">
  321. <tr>
  322. <td class="memname">string getVariable </td>
  323. <td>(</td>
  324. <td class="paramtype">string&#160;</td>
  325. <td class="paramname"><em>varName</em></td><td>)</td>
  326. <td></td>
  327. </tr>
  328. </table>
  329. </div><div class="memdoc">
  330. <p>Grabs the relevant data for the variable represented by the given string </p>
  331. <dl class="params"><dt>Parameters</dt><dd>
  332. <table class="params">
  333. <tr><td class="paramname">varName</td><td>A String representing the variable to check </td></tr>
  334. </table>
  335. </dd>
  336. </dl>
  337. <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>
  338. </div>
  339. </div>
  340. <a class="anchor" id="ga909913d09ade9f6cb76f094856a1846a"></a>
  341. <div class="memitem">
  342. <div class="memproto">
  343. <table class="memname">
  344. <tr>
  345. <td class="memname">bool isFunction </td>
  346. <td>(</td>
  347. <td class="paramtype">string&#160;</td>
  348. <td class="paramname"><em>funcName</em></td><td>)</td>
  349. <td></td>
  350. </tr>
  351. </table>
  352. </div><div class="memdoc">
  353. <p>Checks whether given name represents a current valid function. </p>
  354. <dl class="params"><dt>Parameters</dt><dd>
  355. <table class="params">
  356. <tr><td class="paramname">funcName</td><td>The name of the function to check. </td></tr>
  357. </table>
  358. </dd>
  359. </dl>
  360. <dl class="section return"><dt>Returns</dt><dd>Returns either true if the string represents a valid function or false if not. </dd></dl>
  361. </div>
  362. </div>
  363. <a class="anchor" id="ga1084c274a5b2666b356d63ed54e5acb9"></a>
  364. <div class="memitem">
  365. <div class="memproto">
  366. <table class="memname">
  367. <tr>
  368. <td class="memname">bool isMethod </td>
  369. <td>(</td>
  370. <td class="paramtype">string&#160;</td>
  371. <td class="paramname"><em>namespace</em>, </td>
  372. </tr>
  373. <tr>
  374. <td class="paramkey"></td>
  375. <td></td>
  376. <td class="paramtype">string&#160;</td>
  377. <td class="paramname"><em>method</em>&#160;</td>
  378. </tr>
  379. <tr>
  380. <td></td>
  381. <td>)</td>
  382. <td></td><td></td>
  383. </tr>
  384. </table>
  385. </div><div class="memdoc">
  386. <p>Checks whether the given method name represents a valid method within the given namespace. </p>
  387. <dl class="params"><dt>Parameters</dt><dd>
  388. <table class="params">
  389. <tr><td class="paramname">namespace</td><td>A string representing the namespace in which the method should reside. </td></tr>
  390. <tr><td class="paramname">method</td><td>The name of the method in question. </td></tr>
  391. </table>
  392. </dd>
  393. </dl>
  394. <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>
  395. </div>
  396. </div>
  397. <a class="anchor" id="gae39262a34f5e7fc4a214c2c1aa6e96b0"></a>
  398. <div class="memitem">
  399. <div class="memproto">
  400. <table class="memname">
  401. <tr>
  402. <td class="memname">void setScriptExecEcho </td>
  403. <td>(</td>
  404. <td class="paramtype"><a class="el" href="group__Output.html#ga3f0384585236a6e8d91454d2f6e90a60">echo</a>?&#160;</td>
  405. <td class="paramname"></td><td>)</td>
  406. <td></td>
  407. </tr>
  408. </table>
  409. </div><div class="memdoc">
  410. <ul>
  411. <li>Whether to echo script file execution or not. </li>
  412. </ul>
  413. </div>
  414. </div>
  415. <a class="anchor" id="ga33da75a5c4c611bd1d78535974f5362d"></a>
  416. <div class="memitem">
  417. <div class="memproto">
  418. <table class="memname">
  419. <tr>
  420. <td class="memname">void trace </td>
  421. <td>(</td>
  422. <td class="paramtype">enable&#160;</td>
  423. <td class="paramname"></td><td>)</td>
  424. <td></td>
  425. </tr>
  426. </table>
  427. </div><div class="memdoc">
  428. <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>
  429. <dl class="params"><dt>Parameters</dt><dd>
  430. <table class="params">
  431. <tr><td class="paramname">enable</td><td>A boolean value. If set to true, tracing is enabled, otherwise it is disabled. </td></tr>
  432. </table>
  433. </dd>
  434. </dl>
  435. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  436. </div>
  437. </div>
  438. </div><!-- contents -->
  439. <!-- START FOOTER -->
  440. <br>
  441. <br>
  442. <center>
  443. <div style="color: #777777;">
  444. Copyright &copy; 2013 <a style="color: #777777;" target="_blank" href="http://www.garagegames.com">GarageGames, LLC</a>. All Rights Reserved.
  445. </div>
  446. </center>
  447. </body>
  448. </html>