group__ConsoleDocFunctions.html 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133
  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. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.3.1"/>
  7. <title>TorqueScript Reference: Console Docs (Dump)</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  13. </head>
  14. <body>
  15. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16. <div id="titlearea">
  17. <table cellspacing="0" cellpadding="0">
  18. <tbody>
  19. <tr style="height: 56px;">
  20. <td style="padding-left: 0.5em;">
  21. <div id="projectname">TorqueScript Reference
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.3.1 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  34. <li><a href="modules.html"><span>Modules</span></a></li>
  35. <li><a href="annotated.html"><span>Classes</span></a></li>
  36. </ul>
  37. </div>
  38. </div><!-- top -->
  39. <div class="header">
  40. <div class="summary">
  41. <a href="#func-members">Functions</a> </div>
  42. <div class="headertitle">
  43. <div class="title">Console Docs (Dump)<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div> </div>
  44. </div><!--header-->
  45. <div class="contents">
  46. <table class="memberdecls">
  47. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  48. Functions</h2></td></tr>
  49. <tr class="memitem:gaf1728a0dbd8d31b0099ab6deb6eee0c7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleDocFunctions.html#gaf1728a0dbd8d31b0099ab6deb6eee0c7">dumpConsoleClasses</a> (bool dumpScript=true, bool dumpEngine=true)</td></tr>
  50. <tr class="separator:gaf1728a0dbd8d31b0099ab6deb6eee0c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  51. <tr class="memitem:ga073aa7e25d9774f58ae9704084b732ad"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ConsoleDocFunctions.html#ga073aa7e25d9774f58ae9704084b732ad">dumpConsoleFunctions</a> (bool dumpScript=true, bool dumpEngine=true)</td></tr>
  52. <tr class="separator:ga073aa7e25d9774f58ae9704084b732ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
  53. </table>
  54. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  55. <h2 class="groupheader">Function Documentation</h2>
  56. <a class="anchor" id="gaf1728a0dbd8d31b0099ab6deb6eee0c7"></a>
  57. <div class="memitem">
  58. <div class="memproto">
  59. <table class="memname">
  60. <tr>
  61. <td class="memname">void dumpConsoleClasses </td>
  62. <td>(</td>
  63. <td class="paramtype">bool&#160;</td>
  64. <td class="paramname"><em>dumpScript</em> = <code>true</code>, </td>
  65. </tr>
  66. <tr>
  67. <td class="paramkey"></td>
  68. <td></td>
  69. <td class="paramtype">bool&#160;</td>
  70. <td class="paramname"><em>dumpEngine</em> = <code>true</code>&#160;</td>
  71. </tr>
  72. <tr>
  73. <td></td>
  74. <td>)</td>
  75. <td></td><td></td>
  76. </tr>
  77. </table>
  78. </div><div class="memdoc">
  79. <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>
  80. <dl class="params"><dt>Parameters</dt><dd>
  81. <table class="params">
  82. <tr><td class="paramname">dumpScript</td><td>Specifies whether or not classes defined in script should be dumped. </td></tr>
  83. <tr><td class="paramname">dumpEngine</td><td>Specifies whether or not classes defined in the engine should be dumped. </td></tr>
  84. </table>
  85. </dd>
  86. </dl>
  87. </div>
  88. </div>
  89. <a class="anchor" id="ga073aa7e25d9774f58ae9704084b732ad"></a>
  90. <div class="memitem">
  91. <div class="memproto">
  92. <table class="memname">
  93. <tr>
  94. <td class="memname">void dumpConsoleFunctions </td>
  95. <td>(</td>
  96. <td class="paramtype">bool&#160;</td>
  97. <td class="paramname"><em>dumpScript</em> = <code>true</code>, </td>
  98. </tr>
  99. <tr>
  100. <td class="paramkey"></td>
  101. <td></td>
  102. <td class="paramtype">bool&#160;</td>
  103. <td class="paramname"><em>dumpEngine</em> = <code>true</code>&#160;</td>
  104. </tr>
  105. <tr>
  106. <td></td>
  107. <td>)</td>
  108. <td></td><td></td>
  109. </tr>
  110. </table>
  111. </div><div class="memdoc">
  112. <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>
  113. <dl class="params"><dt>Parameters</dt><dd>
  114. <table class="params">
  115. <tr><td class="paramname">dumpScript</td><td>Specifies whether or not functions defined in script should be dumped. </td></tr>
  116. <tr><td class="paramname">dumpEngine</td><td>Specifies whether or not functions defined in the engine should be dumped. </td></tr>
  117. </table>
  118. </dd>
  119. </dl>
  120. <dl class="section see"><dt>See Also</dt><dd>dumpConsoleMethods </dd></dl>
  121. </div>
  122. </div>
  123. </div><!-- contents -->
  124. <!-- start footer part -->
  125. <hr class="footer"/><address class="footer"><small>
  126. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  127. <img class="footer" src="doxygen.png" alt="doxygen"/>
  128. </a> 1.8.3.1
  129. </small></address>
  130. </body>
  131. </html>