Эхлэл Бүгдийг харах Тусламж
Нэвтрэх
TorqueEngine
/
Torque2D
-ын хуулбар https://github.com/TorqueGameEngines/Torque2D.git
2
0
Салаа 0
Файлууд Асуудлууд 0 Мэдлэгийн сан
Мод: 6bcbc35cd1
Салаанууд Тагууд
Torque2D
/
TorqueScriptDocs
/
html
/
group__ConsoleOutput.html

group__ConsoleOutput.html 24 KB
Түүх Анхны өгөгдөл

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <meta name="generator" content="Doxygen 1.8.10"/>
    7. 

  7. <title>TorqueScript Reference: Console Output</title>
    8. 

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    9. 

  9. <script type="text/javascript" src="jquery.js"></script>
    10. 

  10. <script type="text/javascript" src="dynsections.js"></script>
    11. 

  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    12. 

  12. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
    13. 

  13. </head>
    14. 

  14. <body>
    15. 

  15. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    16. 

  16. <div id="titlearea">
    17. 

  17. <table cellspacing="0" cellpadding="0">
    18. 

  18.  <tbody>
    19. 

  19.  <tr style="height: 56px;">
    20. 

  20.   <td id="projectalign" style="padding-left: 0.5em;">
    21. 

  21.    <div id="projectname">TorqueScript Reference
    22. 

  22.    </div>
    23. 

  23.   </td>
    24. 

  24.  </tr>
    25. 

  25.  </tbody>
    26. 

  26. </table>
    27. 

  27. </div>
    28. 

  28. <!-- end header part -->
    29. 

  29. <!-- Generated by Doxygen 1.8.10 -->
    30. 

  30.   <div id="navrow1" class="tabs">
    31. 

  31.     <ul class="tablist">
    32. 

  32.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    33. 

  33.       <li><a href="modules.html"><span>Modules</span></a></li>
    34. 

  34.       <li><a href="annotated.html"><span>Classes</span></a></li>
    35. 

  35.     </ul>
    36. 

  36.   </div>
    37. 

  37. </div><!-- top -->
    38. 

  38. <div class="header">
    39. 

  39.   <div class="summary">
    40. 

  40. <a href="#func-members">Functions</a>  </div>
    41. 

  41.   <div class="headertitle">
    42. 

  42. <div class="title">Console Output<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div>  </div>
    43. 

  43. </div><!--header-->
    44. 

  44. <div class="contents">
    45. 

  45. <table class="memberdecls">
    46. 

  46. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
    47. 

  47. Functions</h2></td></tr>
    48. 

  48. <tr class="memitem:ga357bbe9fcdf01f0ca7595069fa339da7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleOutput.html#ga357bbe9fcdf01f0ca7595069fa339da7">Assert</a> (condition, message)</td></tr>
    49. 

  49. <tr class="separator:ga357bbe9fcdf01f0ca7595069fa339da7"><td class="memSeparator" colspan="2">&#160;</td></tr>
    50. 

  50. <tr class="memitem:ga4826277cc150ddc0f4de4bd464a34909"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleOutput.html#ga4826277cc150ddc0f4de4bd464a34909">cls</a> ()</td></tr>
    51. 

  51. <tr class="separator:ga4826277cc150ddc0f4de4bd464a34909"><td class="memSeparator" colspan="2">&#160;</td></tr>
    52. 

  52. <tr class="memitem:ga7e7ce045bbd8262a84cb6854815f4824"><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__ConsoleOutput.html#ga7e7ce045bbd8262a84cb6854815f4824">collapseEscape</a> (text)</td></tr>
    53. 

  53. <tr class="separator:ga7e7ce045bbd8262a84cb6854815f4824"><td class="memSeparator" colspan="2">&#160;</td></tr>
    54. 

  54. <tr class="memitem:gaf1728a0dbd8d31b0099ab6deb6eee0c7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleOutput.html#gaf1728a0dbd8d31b0099ab6deb6eee0c7">dumpConsoleClasses</a> (bool dumpScript=true, bool dumpEngine=true)</td></tr>
    55. 

  55. <tr class="separator:gaf1728a0dbd8d31b0099ab6deb6eee0c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
    56. 

  56. <tr class="memitem:ga073aa7e25d9774f58ae9704084b732ad"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleOutput.html#ga073aa7e25d9774f58ae9704084b732ad">dumpConsoleFunctions</a> (bool dumpScript=true, bool dumpEngine=true)</td></tr>
    57. 

  57. <tr class="separator:ga073aa7e25d9774f58ae9704084b732ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
    58. 

  58. <tr class="memitem:gae550d3083e05a0bf167ffbe9f3322213"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleOutput.html#gae550d3083e05a0bf167ffbe9f3322213">echo</a> (text, [...]*)</td></tr>
    59. 

  59. <tr class="separator:gae550d3083e05a0bf167ffbe9f3322213"><td class="memSeparator" colspan="2">&#160;</td></tr>
    60. 

  60. <tr class="memitem:ga922dee81019ae0f03f66e5beb9cf8540"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleOutput.html#ga922dee81019ae0f03f66e5beb9cf8540">echoSeparator</a> ()</td></tr>
    61. 

  61. <tr class="separator:ga922dee81019ae0f03f66e5beb9cf8540"><td class="memSeparator" colspan="2">&#160;</td></tr>
    62. 

  62. <tr class="memitem:ga921681d1d919d27a80cc983e9578c12c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleOutput.html#ga921681d1d919d27a80cc983e9578c12c">error</a> (text, [...]*)</td></tr>
    63. 

  63. <tr class="separator:ga921681d1d919d27a80cc983e9578c12c"><td class="memSeparator" colspan="2">&#160;</td></tr>
    64. 

  64. <tr class="memitem:ga57b547e6efe9a4024be764c571e3317b"><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__ConsoleOutput.html#ga57b547e6efe9a4024be764c571e3317b">expandEscape</a> (text)</td></tr>
    65. 

  65. <tr class="separator:ga57b547e6efe9a4024be764c571e3317b"><td class="memSeparator" colspan="2">&#160;</td></tr>
    66. 

  66. <tr class="memitem:ga002009531b81cd692f9f21ca5c10a742"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleOutput.html#ga002009531b81cd692f9f21ca5c10a742">gotoWebPage</a> (address)</td></tr>
    67. 

  67. <tr class="separator:ga002009531b81cd692f9f21ca5c10a742"><td class="memSeparator" colspan="2">&#160;</td></tr>
    68. 

  68. <tr class="memitem:ga2463a3acef2df4c951ce942a3229e44e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleOutput.html#ga2463a3acef2df4c951ce942a3229e44e">quit</a> ()</td></tr>
    69. 

  69. <tr class="separator:ga2463a3acef2df4c951ce942a3229e44e"><td class="memSeparator" colspan="2">&#160;</td></tr>
    70. 

  70. <tr class="memitem:ga1fa549e02e03c3baf8cd1af4a507ef4b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleOutput.html#ga1fa549e02e03c3baf8cd1af4a507ef4b">quitWithErrorMessage</a> (msg string)</td></tr>
    71. 

  71. <tr class="separator:ga1fa549e02e03c3baf8cd1af4a507ef4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
    72. 

  72. <tr class="memitem:ga0db0f1ee99f226f37d30e44666daa9e8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleOutput.html#ga0db0f1ee99f226f37d30e44666daa9e8">sbmDumpStats</a> ()</td></tr>
    73. 

  73. <tr class="separator:ga0db0f1ee99f226f37d30e44666daa9e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
    74. 

  74. <tr class="memitem:ga535c7e38df40cb42f5ca1ccb4bea7125"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleOutput.html#ga535c7e38df40cb42f5ca1ccb4bea7125">sbmDumpStrings</a> ()</td></tr>
    75. 

  75. <tr class="separator:ga535c7e38df40cb42f5ca1ccb4bea7125"><td class="memSeparator" colspan="2">&#160;</td></tr>
    76. 

  76. <tr class="memitem:ga5935fd13ef727501211a83b8604ca4f3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleOutput.html#ga5935fd13ef727501211a83b8604ca4f3">setEchoFileLoads</a> (enable)</td></tr>
    77. 

  77. <tr class="separator:ga5935fd13ef727501211a83b8604ca4f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
    78. 

  78. <tr class="memitem:gae9a0e1d31d7032ece309a31b3baca894"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleOutput.html#gae9a0e1d31d7032ece309a31b3baca894">setLogMode</a> (mode)</td></tr>
    79. 

  79. <tr class="separator:gae9a0e1d31d7032ece309a31b3baca894"><td class="memSeparator" colspan="2">&#160;</td></tr>
    80. 

  80. <tr class="memitem:ga84b5d3c6d59a2377b48e380dfc726740"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleOutput.html#ga84b5d3c6d59a2377b48e380dfc726740">warn</a> (text, [...]*)</td></tr>
    81. 

  81. <tr class="separator:ga84b5d3c6d59a2377b48e380dfc726740"><td class="memSeparator" colspan="2">&#160;</td></tr>
    82. 

  82. </table>
    83. 

  83. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    84. 

  84. <h2 class="groupheader">Function Documentation</h2>
    85. 

  85. <a class="anchor" id="ga357bbe9fcdf01f0ca7595069fa339da7"></a>
    86. 

  86. <div class="memitem">
    87. 

  87. <div class="memproto">
    88. 

  88.       <table class="memname">
    89. 

  89.         <tr>
    90. 

  90.           <td class="memname">void Assert </td>
    91. 

  91.           <td>(</td>
    92. 

  92.           <td class="paramtype">condition&#160;</td>
    93. 

  93.           <td class="paramname">, </td>
    94. 

  94.         </tr>
    95. 

  95.         <tr>
    96. 

  96.           <td class="paramkey"></td>
    97. 

  97.           <td></td>
    98. 

  98.           <td class="paramtype">message&#160;</td>
    99. 

  99.           <td class="paramname">&#160;</td>
    100. 

  100.         </tr>
    101. 

  101.         <tr>
    102. 

  102.           <td></td>
    103. 

  103.           <td>)</td>
    104. 

  104.           <td></td><td></td>
    105. 

  105.         </tr>
    106. 

  106.       </table>
    107. 

  107. </div><div class="memdoc">
    108. 

  108. <p>Fatal Script Assertion </p><dl class="params"><dt>Parameters</dt><dd>
    109. 

  109.   <table class="params">
    110. 

  110.     <tr><td class="paramname">condition</td><td>if false, exit the program </td></tr>
    111. 

  111.     <tr><td class="paramname">message</td><td>message to print on assertion </td></tr>
    112. 

  112.   </table>
    113. 

  113.   </dd>
    114. 

  114. </dl>
    115. 

  115. 

  116. </div>
    117. 

  117. </div>
    118. 

  118. <a class="anchor" id="ga4826277cc150ddc0f4de4bd464a34909"></a>
    119. 

  119. <div class="memitem">
    120. 

  120. <div class="memproto">
    121. 

  121.       <table class="memname">
    122. 

  122.         <tr>
    123. 

  123.           <td class="memname">void cls </td>
    124. 

  124.           <td>(</td>
    125. 

  125.           <td class="paramname"></td><td>)</td>
    126. 

  126.           <td></td>
    127. 

  127.         </tr>
    128. 

  128.       </table>
    129. 

  129. </div><div class="memdoc">
    130. 

  130. <p>Use the cls function to clear the console output. </p><dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
    131. 

  131. 

  132. </div>
    133. 

  133. </div>
    134. 

  134. <a class="anchor" id="ga7e7ce045bbd8262a84cb6854815f4824"></a>
    135. 

  135. <div class="memitem">
    136. 

  136. <div class="memproto">
    137. 

  137.       <table class="memname">
    138. 

  138.         <tr>
    139. 

  139.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> collapseEscape </td>
    140. 

  140.           <td>(</td>
    141. 

  141.           <td class="paramtype">text&#160;</td>
    142. 

  142.           <td class="paramname"></td><td>)</td>
    143. 

  143.           <td></td>
    144. 

  144.         </tr>
    145. 

  145.       </table>
    146. 

  146. </div><div class="memdoc">
    147. 

  147. <p>Use the collapseEscape function to replace all escape sequences ('xx') with a collapsed version ('xx'). </p><dl class="params"><dt>Parameters</dt><dd>
    148. 

  148.   <table class="params">
    149. 

  149.     <tr><td class="paramname">text</td><td>A string, possibly containing escape sequences. </td></tr>
    150. 

  150.   </table>
    151. 

  151.   </dd>
    152. 

  152. </dl>
    153. 

  153. <dl class="section return"><dt>Returns</dt><dd>Returns a copy of text with all escape sequences converted to an encoding. </dd></dl>
    154. 

  154. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ConsoleOutput.html#ga57b547e6efe9a4024be764c571e3317b">expandEscape</a> </dd></dl>
    155. 

  155. 

  156. </div>
    157. 

  157. </div>
    158. 

  158. <a class="anchor" id="gaf1728a0dbd8d31b0099ab6deb6eee0c7"></a>
    159. 

  159. <div class="memitem">
    160. 

  160. <div class="memproto">
    161. 

  161.       <table class="memname">
    162. 

  162.         <tr>
    163. 

  163.           <td class="memname">void dumpConsoleClasses </td>
    164. 

  164.           <td>(</td>
    165. 

  165.           <td class="paramtype">bool&#160;</td>
    166. 

  166.           <td class="paramname"><em>dumpScript</em> = <code>true</code>, </td>
    167. 

  167.         </tr>
    168. 

  168.         <tr>
    169. 

  169.           <td class="paramkey"></td>
    170. 

  170.           <td></td>
    171. 

  171.           <td class="paramtype">bool&#160;</td>
    172. 

  172.           <td class="paramname"><em>dumpEngine</em> = <code>true</code>&#160;</td>
    173. 

  173.         </tr>
    174. 

  174.         <tr>
    175. 

  175.           <td></td>
    176. 

  176.           <td>)</td>
    177. 

  177.           <td></td><td></td>
    178. 

  178.         </tr>
    179. 

  179.       </table>
    180. 

  180. </div><div class="memdoc">
    181. 

  181. <p>dumps all declared console classes to the console. This will dump all classes and methods that were registered from within the engine, AND from the console via scripts. </p><dl class="params"><dt>Parameters</dt><dd>
    182. 

  182.   <table class="params">
    183. 

  183.     <tr><td class="paramname">dumpScript</td><td>Specifies whether or not classes defined in script should be dumped. </td></tr>
    184. 

  184.     <tr><td class="paramname">dumpEngine</td><td>Specifies whether or not classes defined in the engine should be dumped. </td></tr>
    185. 

  185.   </table>
    186. 

  186.   </dd>
    187. 

  187. </dl>
    188. 

  188. 

  189. </div>
    190. 

  190. </div>
    191. 

  191. <a class="anchor" id="ga073aa7e25d9774f58ae9704084b732ad"></a>
    192. 

  192. <div class="memitem">
    193. 

  193. <div class="memproto">
    194. 

  194.       <table class="memname">
    195. 

  195.         <tr>
    196. 

  196.           <td class="memname">void dumpConsoleFunctions </td>
    197. 

  197.           <td>(</td>
    198. 

  198.           <td class="paramtype">bool&#160;</td>
    199. 

  199.           <td class="paramname"><em>dumpScript</em> = <code>true</code>, </td>
    200. 

  200.         </tr>
    201. 

  201.         <tr>
    202. 

  202.           <td class="paramkey"></td>
    203. 

  203.           <td></td>
    204. 

  204.           <td class="paramtype">bool&#160;</td>
    205. 

  205.           <td class="paramname"><em>dumpEngine</em> = <code>true</code>&#160;</td>
    206. 

  206.         </tr>
    207. 

  207.         <tr>
    208. 

  208.           <td></td>
    209. 

  209.           <td>)</td>
    210. 

  210.           <td></td><td></td>
    211. 

  211.         </tr>
    212. 

  212.       </table>
    213. 

  213. </div><div class="memdoc">
    214. 

  214. <p>Dumps all declared console functions to the console. This will dump all funtions that were registered from within the engine, AND from the console via scripts. </p><dl class="params"><dt>Parameters</dt><dd>
    215. 

  215.   <table class="params">
    216. 

  216.     <tr><td class="paramname">dumpScript</td><td>Specifies whether or not functions defined in script should be dumped. </td></tr>
    217. 

  217.     <tr><td class="paramname">dumpEngine</td><td>Specifies whether or not functions defined in the engine should be dumped. </td></tr>
    218. 

  218.   </table>
    219. 

  219.   </dd>
    220. 

  220. </dl>
    221. 

  221. <dl class="section see"><dt>See also</dt><dd>dumpConsoleMethods </dd></dl>
    222. 

  222. 

  223. </div>
    224. 

  224. </div>
    225. 

  225. <a class="anchor" id="gae550d3083e05a0bf167ffbe9f3322213"></a>
    226. 

  226. <div class="memitem">
    227. 

  227. <div class="memproto">
    228. 

  228.       <table class="memname">
    229. 

  229.         <tr>
    230. 

  230.           <td class="memname">void echo </td>
    231. 

  231.           <td>(</td>
    232. 

  232.           <td class="paramtype">text&#160;</td>
    233. 

  233.           <td class="paramname">, </td>
    234. 

  234.         </tr>
    235. 

  235.         <tr>
    236. 

  236.           <td class="paramkey"></td>
    237. 

  237.           <td></td>
    238. 

  238.           <td class="paramtype">[...] *&#160;</td>
    239. 

  239.           <td class="paramname">&#160;</td>
    240. 

  240.         </tr>
    241. 

  241.         <tr>
    242. 

  242.           <td></td>
    243. 

  243.           <td>)</td>
    244. 

  244.           <td></td><td></td>
    245. 

  245.         </tr>
    246. 

  246.       </table>
    247. 

  247. </div><div class="memdoc">
    248. 

  248. <p>Use the echo function to print messages to the console. </p><dl class="params"><dt>Parameters</dt><dd>
    249. 

  249.   <table class="params">
    250. 

  250.     <tr><td class="paramname">text</td><td>Any valid text string. </td></tr>
    251. 

  251.     <tr><td class="paramname">...</td><td>Any additional valid text string(s). </td></tr>
    252. 

  252.   </table>
    253. 

  253.   </dd>
    254. 

  254. </dl>
    255. 

  255. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    256. 

  256. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ConsoleOutput.html#ga921681d1d919d27a80cc983e9578c12c">error</a>, <a class="el" href="group__ConsoleOutput.html#ga84b5d3c6d59a2377b48e380dfc726740">warn</a> </dd></dl>
    257. 

  257. 

  258. </div>
    259. 

  259. </div>
    260. 

  260. <a class="anchor" id="ga922dee81019ae0f03f66e5beb9cf8540"></a>
    261. 

  261. <div class="memitem">
    262. 

  262. <div class="memproto">
    263. 

  263.       <table class="memname">
    264. 

  264.         <tr>
    265. 

  265.           <td class="memname">void echoSeparator </td>
    266. 

  266.           <td>(</td>
    267. 

  267.           <td class="paramname"></td><td>)</td>
    268. 

  268.           <td></td>
    269. 

  269.         </tr>
    270. 

  270.       </table>
    271. 

  271. </div><div class="memdoc">
    272. 

  272. <p>Prints a separator to the console. </p>
    273. 

  273. 

  274. </div>
    275. 

  275. </div>
    276. 

  276. <a class="anchor" id="ga921681d1d919d27a80cc983e9578c12c"></a>
    277. 

  277. <div class="memitem">
    278. 

  278. <div class="memproto">
    279. 

  279.       <table class="memname">
    280. 

  280.         <tr>
    281. 

  281.           <td class="memname">void error </td>
    282. 

  282.           <td>(</td>
    283. 

  283.           <td class="paramtype">text&#160;</td>
    284. 

  284.           <td class="paramname">, </td>
    285. 

  285.         </tr>
    286. 

  286.         <tr>
    287. 

  287.           <td class="paramkey"></td>
    288. 

  288.           <td></td>
    289. 

  289.           <td class="paramtype">[...] *&#160;</td>
    290. 

  290.           <td class="paramname">&#160;</td>
    291. 

  291.         </tr>
    292. 

  292.         <tr>
    293. 

  293.           <td></td>
    294. 

  294.           <td>)</td>
    295. 

  295.           <td></td><td></td>
    296. 

  296.         </tr>
    297. 

  297.       </table>
    298. 

  298. </div><div class="memdoc">
    299. 

  299. <p>Use the error function to print error messages to the console. These messages usually print in red. </p><dl class="params"><dt>Parameters</dt><dd>
    300. 

  300.   <table class="params">
    301. 

  301.     <tr><td class="paramname">text</td><td>Any valid text string. </td></tr>
    302. 

  302.     <tr><td class="paramname">...</td><td>Any additional valid text string(s). </td></tr>
    303. 

  303.   </table>
    304. 

  304.   </dd>
    305. 

  305. </dl>
    306. 

  306. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    307. 

  307. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ConsoleOutput.html#gae550d3083e05a0bf167ffbe9f3322213">echo</a>, <a class="el" href="group__ConsoleOutput.html#ga84b5d3c6d59a2377b48e380dfc726740">warn</a> </dd></dl>
    308. 

  308. 

  309. </div>
    310. 

  310. </div>
    311. 

  311. <a class="anchor" id="ga57b547e6efe9a4024be764c571e3317b"></a>
    312. 

  312. <div class="memitem">
    313. 

  313. <div class="memproto">
    314. 

  314.       <table class="memname">
    315. 

  315.         <tr>
    316. 

  316.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> expandEscape </td>
    317. 

  317.           <td>(</td>
    318. 

  318.           <td class="paramtype">text&#160;</td>
    319. 

  319.           <td class="paramname"></td><td>)</td>
    320. 

  320.           <td></td>
    321. 

  321.         </tr>
    322. 

  322.       </table>
    323. 

  323. </div><div class="memdoc">
    324. 

  324. <p>Use the collapseEscape function to replace all escape sequences ('xx') with an expanded version ('xx'). </p><dl class="params"><dt>Parameters</dt><dd>
    325. 

  325.   <table class="params">
    326. 

  326.     <tr><td class="paramname">text</td><td>A string, possibly containing escape sequences. </td></tr>
    327. 

  327.   </table>
    328. 

  328.   </dd>
    329. 

  329. </dl>
    330. 

  330. <dl class="section return"><dt>Returns</dt><dd>Returns a copy of text with all escape sequences expanded. </dd></dl>
    331. 

  331. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ConsoleOutput.html#ga7e7ce045bbd8262a84cb6854815f4824">collapseEscape</a> </dd></dl>
    332. 

  332. 

  333. </div>
    334. 

  334. </div>
    335. 

  335. <a class="anchor" id="ga002009531b81cd692f9f21ca5c10a742"></a>
    336. 

  336. <div class="memitem">
    337. 

  337. <div class="memproto">
    338. 

  338.       <table class="memname">
    339. 

  339.         <tr>
    340. 

  340.           <td class="memname">void gotoWebPage </td>
    341. 

  341.           <td>(</td>
    342. 

  342.           <td class="paramtype">address&#160;</td>
    343. 

  343.           <td class="paramname"></td><td>)</td>
    344. 

  344.           <td></td>
    345. 

  345.         </tr>
    346. 

  346.       </table>
    347. 

  347. </div><div class="memdoc">
    348. 

  348. <p>Open a URL in the user's favorite web browser. </p>
    349. 

  349. 

  350. </div>
    351. 

  351. </div>
    352. 

  352. <a class="anchor" id="ga2463a3acef2df4c951ce942a3229e44e"></a>
    353. 

  353. <div class="memitem">
    354. 

  354. <div class="memproto">
    355. 

  355.       <table class="memname">
    356. 

  356.         <tr>
    357. 

  357.           <td class="memname">void quit </td>
    358. 

  358.           <td>(</td>
    359. 

  359.           <td class="paramname"></td><td>)</td>
    360. 

  360.           <td></td>
    361. 

  361.         </tr>
    362. 

  362.       </table>
    363. 

  363. </div><div class="memdoc">
    364. 

  364. <p>Use the quit function to stop the engine and quit to the command line. </p><dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
    365. 

  365. 

  366. </div>
    367. 

  367. </div>
    368. 

  368. <a class="anchor" id="ga1fa549e02e03c3baf8cd1af4a507ef4b"></a>
    369. 

  369. <div class="memitem">
    370. 

  370. <div class="memproto">
    371. 

  371.       <table class="memname">
    372. 

  372.         <tr>
    373. 

  373.           <td class="memname">void quitWithErrorMessage </td>
    374. 

  374.           <td>(</td>
    375. 

  375.           <td class="paramtype">msg&#160;</td>
    376. 

  376.           <td class="paramname"><em>string</em></td><td>)</td>
    377. 

  377.           <td></td>
    378. 

  378.         </tr>
    379. 

  379.       </table>
    380. 

  380. </div><div class="memdoc">
    381. 

  381. <p><a class="el" href="group__ConsoleOutput.html#ga1fa549e02e03c3baf8cd1af4a507ef4b">quitWithErrorMessage(msg)</a></p><ul>
    382. 

  382. <li>Quit, showing the provided error message. This is equivalent to an AssertISV. <dl class="params"><dt>Parameters</dt><dd>
    383. 

  383.   <table class="params">
    384. 

  384.     <tr><td class="paramname">Error</td><td><a class="el" href="classMessage.html">Message</a> </td></tr>
    385. 

  385.   </table>
    386. 

  386.   </dd>
    387. 

  387. </dl>
    388. 

  388. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
    389. 

  389. </li>
    390. 

  390. </ul>
    391. 

  391. 

  392. </div>
    393. 

  393. </div>
    394. 

  394. <a class="anchor" id="ga0db0f1ee99f226f37d30e44666daa9e8"></a>
    395. 

  395. <div class="memitem">
    396. 

  396. <div class="memproto">
    397. 

  397.       <table class="memname">
    398. 

  398.         <tr>
    399. 

  399.           <td class="memname">void sbmDumpStats </td>
    400. 

  400.           <td>(</td>
    401. 

  401.           <td class="paramname"></td><td>)</td>
    402. 

  402.           <td></td>
    403. 

  403.         </tr>
    404. 

  404.       </table>
    405. 

  405. </div><div class="memdoc">
    406. 

  406. 

  407. </div>
    408. 

  408. </div>
    409. 

  409. <a class="anchor" id="ga535c7e38df40cb42f5ca1ccb4bea7125"></a>
    410. 

  410. <div class="memitem">
    411. 

  411. <div class="memproto">
    412. 

  412.       <table class="memname">
    413. 

  413.         <tr>
    414. 

  414.           <td class="memname">void sbmDumpStrings </td>
    415. 

  415.           <td>(</td>
    416. 

  416.           <td class="paramname"></td><td>)</td>
    417. 

  417.           <td></td>
    418. 

  418.         </tr>
    419. 

  419.       </table>
    420. 

  420. </div><div class="memdoc">
    421. 

  421. 

  422. </div>
    423. 

  423. </div>
    424. 

  424. <a class="anchor" id="ga5935fd13ef727501211a83b8604ca4f3"></a>
    425. 

  425. <div class="memitem">
    426. 

  426. <div class="memproto">
    427. 

  427.       <table class="memname">
    428. 

  428.         <tr>
    429. 

  429.           <td class="memname">void setEchoFileLoads </td>
    430. 

  430.           <td>(</td>
    431. 

  431.           <td class="paramtype">enable&#160;</td>
    432. 

  432.           <td class="paramname"></td><td>)</td>
    433. 

  433.           <td></td>
    434. 

  434.         </tr>
    435. 

  435.       </table>
    436. 

  436. </div><div class="memdoc">
    437. 

  437. <p>Use the setEchoFileLoads function to enable/disable echoing of file loads (to console). This does not completely disable message, but rather adds additional methods when echoing is set to true. File loads will always echo a compile statement if compiling is required, and an exec statement at all times </p><dl class="params"><dt>Parameters</dt><dd>
    438. 

  438.   <table class="params">
    439. 

  439.     <tr><td class="paramname">enable</td><td>A boolean value. If this value is true, extra information will be dumped to the console when files are loaded. </td></tr>
    440. 

  440.   </table>
    441. 

  441.   </dd>
    442. 

  442. </dl>
    443. 

  443. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    444. 

  444. 

  445. </div>
    446. 

  446. </div>
    447. 

  447. <a class="anchor" id="gae9a0e1d31d7032ece309a31b3baca894"></a>
    448. 

  448. <div class="memitem">
    449. 

  449. <div class="memproto">
    450. 

  450.       <table class="memname">
    451. 

  451.         <tr>
    452. 

  452.           <td class="memname">void setLogMode </td>
    453. 

  453.           <td>(</td>
    454. 

  454.           <td class="paramtype">mode&#160;</td>
    455. 

  455.           <td class="paramname"></td><td>)</td>
    456. 

  456.           <td></td>
    457. 

  457.         </tr>
    458. 

  458.       </table>
    459. 

  459. </div><div class="memdoc">
    460. 

  460. <p>Use the setLogMode function to set the logging level based on bits that are set in the mode argument. This is a general debug method and should be used in all but release cases and perhaps even then. </p><dl class="params"><dt>Parameters</dt><dd>
    461. 

  461.   <table class="params">
    462. 

  462.     <tr><td class="paramname">mode</td><td>A bitmask enabling various types of logging. See 'Logging Modes' table below. </td></tr>
    463. 

  463.   </table>
    464. 

  464.   </dd>
    465. 

  465. </dl>
    466. 

  466. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    467. 

  467. <dl class="section see"><dt>See also</dt><dd>intputLog </dd></dl>
    468. 

  468. 

  469. </div>
    470. 

  470. </div>
    471. 

  471. <a class="anchor" id="ga84b5d3c6d59a2377b48e380dfc726740"></a>
    472. 

  472. <div class="memitem">
    473. 

  473. <div class="memproto">
    474. 

  474.       <table class="memname">
    475. 

  475.         <tr>
    476. 

  476.           <td class="memname">void warn </td>
    477. 

  477.           <td>(</td>
    478. 

  478.           <td class="paramtype">text&#160;</td>
    479. 

  479.           <td class="paramname">, </td>
    480. 

  480.         </tr>
    481. 

  481.         <tr>
    482. 

  482.           <td class="paramkey"></td>
    483. 

  483.           <td></td>
    484. 

  484.           <td class="paramtype">[...] *&#160;</td>
    485. 

  485.           <td class="paramname">&#160;</td>
    486. 

  486.         </tr>
    487. 

  487.         <tr>
    488. 

  488.           <td></td>
    489. 

  489.           <td>)</td>
    490. 

  490.           <td></td><td></td>
    491. 

  491.         </tr>
    492. 

  492.       </table>
    493. 

  493. </div><div class="memdoc">
    494. 

  494. <p>Use the warn function to print warning messages to the console. These messages usually yellow or orange. </p><dl class="params"><dt>Parameters</dt><dd>
    495. 

  495.   <table class="params">
    496. 

  496.     <tr><td class="paramname">text</td><td>Any valid text string. </td></tr>
    497. 

  497.     <tr><td class="paramname">...</td><td>Any additional valid text string(s). </td></tr>
    498. 

  498.   </table>
    499. 

  499.   </dd>
    500. 

  500. </dl>
    501. 

  501. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    502. 

  502. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ConsoleOutput.html#ga84b5d3c6d59a2377b48e380dfc726740">warn</a>, <a class="el" href="group__ConsoleOutput.html#ga921681d1d919d27a80cc983e9578c12c">error</a> </dd></dl>
    503. 

  503. 

  504. </div>
    505. 

  505. </div>
    506. 

  506. </div><!-- contents -->
    507. 

  507. <!-- start footer part -->
    508. 

  508. <hr class="footer"/><address class="footer"><small>
    509. 

  509. Generated by &#160;<a href="http://www.doxygen.org/index.html">
    510. 

  510. <img class="footer" src="doxygen.png" alt="doxygen"/>
    511. 

  511. </a> 1.8.10
    512. 

  512. </small></address>
    513. 

  513. </body>
    514. 

  514. </html>
    515.