group__ConsoleDoc.html 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120
  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>ConsoleDoc</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">ConsoleDoc</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:gaf1728a0dbd8d31b0099ab6deb6eee0c7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleDoc.html#gaf1728a0dbd8d31b0099ab6deb6eee0c7">dumpConsoleClasses</a> (bool dumpScript=true, bool dumpEngine=true)</td></tr>
  34. <tr class="separator:gaf1728a0dbd8d31b0099ab6deb6eee0c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  35. <tr class="memitem:ga073aa7e25d9774f58ae9704084b732ad"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleDoc.html#ga073aa7e25d9774f58ae9704084b732ad">dumpConsoleFunctions</a> (bool dumpScript=true, bool dumpEngine=true)</td></tr>
  36. <tr class="separator:ga073aa7e25d9774f58ae9704084b732ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
  37. </table>
  38. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  39. <p>Console self-documentation functions. These output psuedo C++ suitable for feeeding through Doxygen or another auto documentation tool. </p>
  40. <h2 class="groupheader">Function Documentation</h2>
  41. <a class="anchor" id="gaf1728a0dbd8d31b0099ab6deb6eee0c7"></a>
  42. <div class="memitem">
  43. <div class="memproto">
  44. <table class="memname">
  45. <tr>
  46. <td class="memname">void dumpConsoleClasses </td>
  47. <td>(</td>
  48. <td class="paramtype">bool&#160;</td>
  49. <td class="paramname"><em>dumpScript</em> = <code>true</code>, </td>
  50. </tr>
  51. <tr>
  52. <td class="paramkey"></td>
  53. <td></td>
  54. <td class="paramtype">bool&#160;</td>
  55. <td class="paramname"><em>dumpEngine</em> = <code>true</code>&#160;</td>
  56. </tr>
  57. <tr>
  58. <td></td>
  59. <td>)</td>
  60. <td></td><td></td>
  61. </tr>
  62. </table>
  63. </div><div class="memdoc">
  64. <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>
  65. <dl class="params"><dt>Parameters</dt><dd>
  66. <table class="params">
  67. <tr><td class="paramname">dumpScript</td><td>Specifies whether or not classes defined in script should be dumped. </td></tr>
  68. <tr><td class="paramname">dumpEngine</td><td>Specifies whether or not classes defined in the engine should be dumped. </td></tr>
  69. </table>
  70. </dd>
  71. </dl>
  72. </div>
  73. </div>
  74. <a class="anchor" id="ga073aa7e25d9774f58ae9704084b732ad"></a>
  75. <div class="memitem">
  76. <div class="memproto">
  77. <table class="memname">
  78. <tr>
  79. <td class="memname">void dumpConsoleFunctions </td>
  80. <td>(</td>
  81. <td class="paramtype">bool&#160;</td>
  82. <td class="paramname"><em>dumpScript</em> = <code>true</code>, </td>
  83. </tr>
  84. <tr>
  85. <td class="paramkey"></td>
  86. <td></td>
  87. <td class="paramtype">bool&#160;</td>
  88. <td class="paramname"><em>dumpEngine</em> = <code>true</code>&#160;</td>
  89. </tr>
  90. <tr>
  91. <td></td>
  92. <td>)</td>
  93. <td></td><td></td>
  94. </tr>
  95. </table>
  96. </div><div class="memdoc">
  97. <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>
  98. <dl class="params"><dt>Parameters</dt><dd>
  99. <table class="params">
  100. <tr><td class="paramname">dumpScript</td><td>Specifies whether or not functions defined in script should be dumped. </td></tr>
  101. <tr><td class="paramname">dumpEngine</td><td>Specifies whether or not functions defined in the engine should be dumped.</td></tr>
  102. </table>
  103. </dd>
  104. </dl>
  105. <dl class="section see"><dt>See Also</dt><dd>dumpConsoleMethods </dd></dl>
  106. </div>
  107. </div>
  108. </div><!-- contents -->
  109. <!-- START FOOTER -->
  110. <br>
  111. <br>
  112. <center>
  113. <div style="color: #777777;">
  114. Copyright &copy; 2013 <a style="color: #777777;" target="_blank" href="http://www.garagegames.com">GarageGames, LLC</a>. All Rights Reserved.
  115. </div>
  116. </center>
  117. </body>
  118. </html>