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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258
							<!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>Output</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> &nbsp; 
	<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">Output</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:ga40c2eca34c2e9469632247b484b0621f"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Output.html#ga40c2eca34c2e9469632247b484b0621f">collapseEscape</a> (text)</td></tr>
<tr class="separator:ga40c2eca34c2e9469632247b484b0621f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3f0384585236a6e8d91454d2f6e90a60"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Output.html#ga3f0384585236a6e8d91454d2f6e90a60">echo</a> (text[,...])</td></tr>
<tr class="separator:ga3f0384585236a6e8d91454d2f6e90a60"><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__Output.html#ga922dee81019ae0f03f66e5beb9cf8540">echoSeparator</a> ()</td></tr>
<tr class="separator:ga922dee81019ae0f03f66e5beb9cf8540"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga46fe3eae1734386686ea10f71458535e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Output.html#ga46fe3eae1734386686ea10f71458535e">error</a> (text[,...])</td></tr>
<tr class="separator:ga46fe3eae1734386686ea10f71458535e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga586d0aba0e7316dc9d2394ac251ee36a"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Output.html#ga586d0aba0e7316dc9d2394ac251ee36a">expandEscape</a> (text)</td></tr>
<tr class="separator:ga586d0aba0e7316dc9d2394ac251ee36a"><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__Output.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__Output.html#gae9a0e1d31d7032ece309a31b3baca894">setLogMode</a> (mode)</td></tr>
<tr class="separator:gae9a0e1d31d7032ece309a31b3baca894"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga62d44352b32a5e99c7852e9c1c8e979a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Output.html#ga62d44352b32a5e99c7852e9c1c8e979a">warn</a> (text[,...])</td></tr>
<tr class="separator:ga62d44352b32a5e99c7852e9c1c8e979a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Functions to output to the console. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga40c2eca34c2e9469632247b484b0621f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string 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__Output.html#ga586d0aba0e7316dc9d2394ac251ee36a">expandEscape</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ga3f0384585236a6e8d91454d2f6e90a60"></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><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__Output.html#ga46fe3eae1734386686ea10f71458535e">error</a>, <a class="el" href="group__Output.html#ga62d44352b32a5e99c7852e9c1c8e979a">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">
<ul>
<li>Prints a separator to the console. </li>
</ul>

</div>
</div>
<a class="anchor" id="ga46fe3eae1734386686ea10f71458535e"></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><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__Output.html#ga3f0384585236a6e8d91454d2f6e90a60">echo</a>, <a class="el" href="group__Output.html#ga62d44352b32a5e99c7852e9c1c8e979a">warn</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ga586d0aba0e7316dc9d2394ac251ee36a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string 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__Output.html#ga40c2eca34c2e9469632247b484b0621f">collapseEscape</a> </dd></dl>

</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="ga62d44352b32a5e99c7852e9c1c8e979a"></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><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__Output.html#ga62d44352b32a5e99c7852e9c1c8e979a">warn</a>, <a class="el" href="group__Output.html#ga46fe3eae1734386686ea10f71458535e">error</a> </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- START FOOTER -->
<br>
<br>
<center>
	<div style="color: #777777;">
	Copyright &copy; 2013 <a style="color: #777777;" target="_blank" href="http://www.garagegames.com">GarageGames, LLC</a>. All Rights Reserved.
	</div>
</center>
</body>
</html>