| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120 |
- <!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>ConsoleDoc</title>
- <link href="torquedoc.css" rel="stylesheet" type="text/css"/>
- </head>
- <body>
- <table width="100%" class="header">
- <tr>
- </tr>
- <tr><td class="headermenu">
- <center>
- <a class="qindex" href="index.html">Main</a>
- <a class="qindex" target="_blank" href="https://github.com/GarageGames/Torque2D">GitHub</a>
- </center>
- </td></tr>
- </table>
- <br>
- <!-- END HEADER -->
- <!-- Generated by Doxygen 1.8.3.1 -->
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#func-members">Functions</a> </div>
- <div class="headertitle">
- <div class="title">ConsoleDoc</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:gaf1728a0dbd8d31b0099ab6deb6eee0c7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleDoc.html#gaf1728a0dbd8d31b0099ab6deb6eee0c7">dumpConsoleClasses</a> (bool dumpScript=true, bool dumpEngine=true)</td></tr>
- <tr class="separator:gaf1728a0dbd8d31b0099ab6deb6eee0c7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga073aa7e25d9774f58ae9704084b732ad"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleDoc.html#ga073aa7e25d9774f58ae9704084b732ad">dumpConsoleFunctions</a> (bool dumpScript=true, bool dumpEngine=true)</td></tr>
- <tr class="separator:ga073aa7e25d9774f58ae9704084b732ad"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <p>Console self-documentation functions. These output psuedo C++ suitable for feeeding through Doxygen or another auto documentation tool. </p>
- <h2 class="groupheader">Function Documentation</h2>
- <a class="anchor" id="gaf1728a0dbd8d31b0099ab6deb6eee0c7"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void dumpConsoleClasses </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>dumpScript</em> = <code>true</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>dumpEngine</em> = <code>true</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <table class="params">
- <tr><td class="paramname">dumpScript</td><td>Specifies whether or not classes defined in script should be dumped. </td></tr>
- <tr><td class="paramname">dumpEngine</td><td>Specifies whether or not classes defined in the engine should be dumped. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="ga073aa7e25d9774f58ae9704084b732ad"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void dumpConsoleFunctions </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>dumpScript</em> = <code>true</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>dumpEngine</em> = <code>true</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <table class="params">
- <tr><td class="paramname">dumpScript</td><td>Specifies whether or not functions defined in script should be dumped. </td></tr>
- <tr><td class="paramname">dumpEngine</td><td>Specifies whether or not functions defined in the engine should be dumped.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section see"><dt>See Also</dt><dd>dumpConsoleMethods </dd></dl>
- </div>
- </div>
- </div><!-- contents -->
- <!-- START FOOTER -->
- <br>
- <br>
- <center>
- <div style="color: #777777;">
- Copyright © 2013 <a style="color: #777777;" target="_blank" href="http://www.garagegames.com">GarageGames, LLC</a>. All Rights Reserved.
- </div>
- </center>
- </body>
- </html>
|