TorqueEngine
/
Torque2D
mirror de https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385
							<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>TorqueScript Reference: Console Output</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 style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">TorqueScript Reference
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Console Output<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 name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga4826277cc150ddc0f4de4bd464a34909"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleOutputFunctions.html#ga4826277cc150ddc0f4de4bd464a34909">cls</a> ()</td></tr>
<tr class="separator:ga4826277cc150ddc0f4de4bd464a34909"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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__ConsoleOutputFunctions.html#ga7e7ce045bbd8262a84cb6854815f4824">collapseEscape</a> (text)</td></tr>
<tr class="separator:ga7e7ce045bbd8262a84cb6854815f4824"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga530570e5951963de5e7ae349e996691c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleOutputFunctions.html#ga530570e5951963de5e7ae349e996691c">echo</a> (text,[...]*)</td></tr>
<tr class="separator:ga530570e5951963de5e7ae349e996691c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga922dee81019ae0f03f66e5beb9cf8540"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleOutputFunctions.html#ga922dee81019ae0f03f66e5beb9cf8540">echoSeparator</a> ()</td></tr>
<tr class="separator:ga922dee81019ae0f03f66e5beb9cf8540"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7b8d3c113beee1c3d8dd0f669752af05"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleOutputFunctions.html#ga7b8d3c113beee1c3d8dd0f669752af05">error</a> (text,[...]*)</td></tr>
<tr class="separator:ga7b8d3c113beee1c3d8dd0f669752af05"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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__ConsoleOutputFunctions.html#ga57b547e6efe9a4024be764c571e3317b">expandEscape</a> (text)</td></tr>
<tr class="separator:ga57b547e6efe9a4024be764c571e3317b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga002009531b81cd692f9f21ca5c10a742"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleOutputFunctions.html#ga002009531b81cd692f9f21ca5c10a742">gotoWebPage</a> (address)</td></tr>
<tr class="separator:ga002009531b81cd692f9f21ca5c10a742"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2463a3acef2df4c951ce942a3229e44e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleOutputFunctions.html#ga2463a3acef2df4c951ce942a3229e44e">quit</a> ()</td></tr>
<tr class="separator:ga2463a3acef2df4c951ce942a3229e44e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1fa549e02e03c3baf8cd1af4a507ef4b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleOutputFunctions.html#ga1fa549e02e03c3baf8cd1af4a507ef4b">quitWithErrorMessage</a> (msg string)</td></tr>
<tr class="separator:ga1fa549e02e03c3baf8cd1af4a507ef4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5935fd13ef727501211a83b8604ca4f3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleOutputFunctions.html#ga5935fd13ef727501211a83b8604ca4f3">setEchoFileLoads</a> (enable)</td></tr>
<tr class="separator:ga5935fd13ef727501211a83b8604ca4f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae9a0e1d31d7032ece309a31b3baca894"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleOutputFunctions.html#gae9a0e1d31d7032ece309a31b3baca894">setLogMode</a> (mode)</td></tr>
<tr class="separator:gae9a0e1d31d7032ece309a31b3baca894"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadb1ff6baa57eb9487e393a8b38663729"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleOutputFunctions.html#gadb1ff6baa57eb9487e393a8b38663729">warn</a> (text,[...]*)</td></tr>
<tr class="separator:gadb1ff6baa57eb9487e393a8b38663729"><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 class="anchor" id="ga4826277cc150ddc0f4de4bd464a34909"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void cls </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the cls function to clear the console output. </p>
<dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>

</div>
</div>
<a class="anchor" id="ga7e7ce045bbd8262a84cb6854815f4824"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> collapseEscape </td>
          <td>(</td>
          <td class="paramtype">text&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the collapseEscape function to replace all escape sequences ('xx') with a collapsed version ('xx'). </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">text</td><td>A string, possibly containing escape sequences. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a copy of text with all escape sequences converted to an encoding. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__ConsoleOutputFunctions.html#ga57b547e6efe9a4024be764c571e3317b">expandEscape</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ga530570e5951963de5e7ae349e996691c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void echo </td>
          <td>(</td>
          <td class="paramtype">text&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">[...] *&#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 echo function to print messages to the console. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">text</td><td>Any valid text string. </td></tr>
    <tr><td class="paramname">...</td><td>Any additional valid text string(s). </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__ConsoleOutputFunctions.html#ga7b8d3c113beee1c3d8dd0f669752af05">error</a>, <a class="el" href="group__ConsoleOutputFunctions.html#gadb1ff6baa57eb9487e393a8b38663729">warn</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ga922dee81019ae0f03f66e5beb9cf8540"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void echoSeparator </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Prints a separator to the console. </p>

</div>
</div>
<a class="anchor" id="ga7b8d3c113beee1c3d8dd0f669752af05"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void error </td>
          <td>(</td>
          <td class="paramtype">text&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">[...] *&#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 error function to print error messages to the console. These messages usually print in red. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">text</td><td>Any valid text string. </td></tr>
    <tr><td class="paramname">...</td><td>Any additional valid text string(s). </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__ConsoleOutputFunctions.html#ga530570e5951963de5e7ae349e996691c">echo</a>, <a class="el" href="group__ConsoleOutputFunctions.html#gadb1ff6baa57eb9487e393a8b38663729">warn</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ga57b547e6efe9a4024be764c571e3317b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> expandEscape </td>
          <td>(</td>
          <td class="paramtype">text&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the collapseEscape function to replace all escape sequences ('xx') with an expanded version ('xx'). </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">text</td><td>A string, possibly containing escape sequences. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a copy of text with all escape sequences expanded. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__ConsoleOutputFunctions.html#ga7e7ce045bbd8262a84cb6854815f4824">collapseEscape</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ga002009531b81cd692f9f21ca5c10a742"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void gotoWebPage </td>
          <td>(</td>
          <td class="paramtype">address&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Open a URL in the user's favorite web browser. </p>

</div>
</div>
<a class="anchor" id="ga2463a3acef2df4c951ce942a3229e44e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void quit </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<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>

</div>
</div>
<a class="anchor" id="ga1fa549e02e03c3baf8cd1af4a507ef4b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void quitWithErrorMessage </td>
          <td>(</td>
          <td class="paramtype">msg&#160;</td>
          <td class="paramname"><em>string</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p><a class="el" href="group__ConsoleOutputFunctions.html#ga1fa549e02e03c3baf8cd1af4a507ef4b">quitWithErrorMessage(msg)</a></p>
<ul>
<li>Quit, showing the provided error message. This is equivalent to an AssertISV. <dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">Error</td><td><a class="el" href="classMessage.html">Message</a> </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
</li>
</ul>

</div>
</div>
<a class="anchor" id="ga5935fd13ef727501211a83b8604ca4f3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void setEchoFileLoads </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 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>
  <table class="params">
    <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>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>

</div>
</div>
<a class="anchor" id="gae9a0e1d31d7032ece309a31b3baca894"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void setLogMode </td>
          <td>(</td>
          <td class="paramtype">mode&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<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>
  <table class="params">
    <tr><td class="paramname">mode</td><td>A bitmask enabling various types of logging. See 'Logging Modes' table below. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd>intputLog </dd></dl>

</div>
</div>
<a class="anchor" id="gadb1ff6baa57eb9487e393a8b38663729"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void warn </td>
          <td>(</td>
          <td class="paramtype">text&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">[...] *&#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 warn function to print warning messages to the console. These messages usually yellow or orange. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">text</td><td>Any valid text string. </td></tr>
    <tr><td class="paramname">...</td><td>Any additional valid text string(s). </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__ConsoleOutputFunctions.html#gadb1ff6baa57eb9487e393a8b38663729">warn</a>, <a class="el" href="group__ConsoleOutputFunctions.html#ga7b8d3c113beee1c3d8dd0f669752af05">error</a> </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>