class_console_constructor.html 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820
  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>Torque2D Reference: ConsoleConstructor Class Reference</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="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/search.js"></script>
  13. <script type="text/javascript">
  14. $(document).ready(function() { searchBox.OnSelectItem(0); });
  15. </script>
  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  17. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td style="padding-left: 0.5em;">
  26. <div id="projectname">Torque2D Reference
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.3.1 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  42. <li><a href="modules.html"><span>Modules</span></a></li>
  43. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  44. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  45. <li>
  46. <div id="MSearchBox" class="MSearchBoxInactive">
  47. <span class="left">
  48. <img id="MSearchSelect" src="search/mag_sel.png"
  49. onmouseover="return searchBox.OnSearchSelectShow()"
  50. onmouseout="return searchBox.OnSearchSelectHide()"
  51. alt=""/>
  52. <input type="text" id="MSearchField" value="Search" accesskey="S"
  53. onfocus="searchBox.OnSearchFieldFocus(true)"
  54. onblur="searchBox.OnSearchFieldFocus(false)"
  55. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  56. </span><span class="right">
  57. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  58. </span>
  59. </div>
  60. </li>
  61. </ul>
  62. </div>
  63. <div id="navrow2" class="tabs2">
  64. <ul class="tablist">
  65. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  66. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  67. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  68. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  69. </ul>
  70. </div>
  71. <!-- window showing the filter options -->
  72. <div id="MSearchSelectWindow"
  73. onmouseover="return searchBox.OnSearchSelectShow()"
  74. onmouseout="return searchBox.OnSearchSelectHide()"
  75. onkeydown="return searchBox.OnSearchSelectKey(event)">
  76. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  77. <!-- iframe showing the search results (closed by default) -->
  78. <div id="MSearchResultsWindow">
  79. <iframe src="javascript:void(0)" frameborder="0"
  80. name="MSearchResults" id="MSearchResults">
  81. </iframe>
  82. </div>
  83. </div><!-- top -->
  84. <div class="header">
  85. <div class="summary">
  86. <a href="#pub-attribs">Public Attributes</a> &#124;
  87. <a href="class_console_constructor-members.html">List of all members</a> </div>
  88. <div class="headertitle">
  89. <div class="title">ConsoleConstructor Class Reference</div> </div>
  90. </div><!--header-->
  91. <div class="contents">
  92. <p><code>#include &lt;console.h&gt;</code></p>
  93. <table class="memberdecls">
  94. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  95. Public Attributes</h2></td></tr>
  96. <tr class="memitem:aaa42f32a432314ff3370d6650897bd7f"><td class="memItemLeft" align="right" valign="top">S32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_constructor.html#aaa42f32a432314ff3370d6650897bd7f">mina</a></td></tr>
  97. <tr class="memdesc:aaa42f32a432314ff3370d6650897bd7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum/maximum number of arguments for the function. <a href="#aaa42f32a432314ff3370d6650897bd7f">More...</a><br/></td></tr>
  98. <tr class="separator:aaa42f32a432314ff3370d6650897bd7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:a27185490efa9c459ee7e32e7f9eadf66"><td class="memItemLeft" align="right" valign="top">S32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_constructor.html#a27185490efa9c459ee7e32e7f9eadf66">maxa</a></td></tr>
  100. <tr class="separator:a27185490efa9c459ee7e32e7f9eadf66"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:aef1bd6ad890a110b466cb0e8088507a2"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_constructor.html#aef1bd6ad890a110b466cb0e8088507a2">usage</a></td></tr>
  102. <tr class="memdesc:aef1bd6ad890a110b466cb0e8088507a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Usage string. <a href="#aef1bd6ad890a110b466cb0e8088507a2">More...</a><br/></td></tr>
  103. <tr class="separator:aef1bd6ad890a110b466cb0e8088507a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:afc7a5b78fd2c95e8a152ce9cc0c358d5"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_constructor.html#afc7a5b78fd2c95e8a152ce9cc0c358d5">funcName</a></td></tr>
  105. <tr class="memdesc:afc7a5b78fd2c95e8a152ce9cc0c358d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function name. <a href="#afc7a5b78fd2c95e8a152ce9cc0c358d5">More...</a><br/></td></tr>
  106. <tr class="separator:afc7a5b78fd2c95e8a152ce9cc0c358d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a43ff489793a22a8e71664f7b5cadf1a3"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_constructor.html#a43ff489793a22a8e71664f7b5cadf1a3">className</a></td></tr>
  108. <tr class="memdesc:a43ff489793a22a8e71664f7b5cadf1a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class name. <a href="#a43ff489793a22a8e71664f7b5cadf1a3">More...</a><br/></td></tr>
  109. <tr class="separator:a43ff489793a22a8e71664f7b5cadf1a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. </table><table class="memberdecls">
  111. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
  112. Entry Type Fields</h2></td></tr>
  113. <tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrpd75c00ca0925a277db5f41d79bd1a4c1"></a>One of these is set based on the type of entry we want inserted in the console.</p>
  114. <p><a class="el" href="console_autodoc.html">Console Auto-Documentation</a> </p>
  115. </td></tr>
  116. <tr class="memitem:a58d259b59730d65a5b3585c629c61a59"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__console__callbacks.html#gaeada7638a4975df2e581e6de5dbb51d9">StringCallback</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_constructor.html#a58d259b59730d65a5b3585c629c61a59">sc</a></td></tr>
  117. <tr class="memdesc:a58d259b59730d65a5b3585c629c61a59"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function/method that returns a string. <a href="#a58d259b59730d65a5b3585c629c61a59">More...</a><br/></td></tr>
  118. <tr class="separator:a58d259b59730d65a5b3585c629c61a59"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:afe91de024e2cd723c581dda81f6bb6b8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__console__callbacks.html#gaa2ec30e48268f28c2037491f145eeacc">IntCallback</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_constructor.html#afe91de024e2cd723c581dda81f6bb6b8">ic</a></td></tr>
  120. <tr class="memdesc:afe91de024e2cd723c581dda81f6bb6b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function/method that returns an int. <a href="#afe91de024e2cd723c581dda81f6bb6b8">More...</a><br/></td></tr>
  121. <tr class="separator:afe91de024e2cd723c581dda81f6bb6b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a4742081c4d3981999ca9b617a2830a1e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__console__callbacks.html#ga85b90d1b2d70a23128e78d1897a37575">FloatCallback</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_constructor.html#a4742081c4d3981999ca9b617a2830a1e">fc</a></td></tr>
  123. <tr class="memdesc:a4742081c4d3981999ca9b617a2830a1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function/method that returns a float. <a href="#a4742081c4d3981999ca9b617a2830a1e">More...</a><br/></td></tr>
  124. <tr class="separator:a4742081c4d3981999ca9b617a2830a1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:a0b02902681a0e7813fbc4d43db8a5623"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__console__callbacks.html#gacacd79319494a58b292a7847f429c40f">VoidCallback</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_constructor.html#a0b02902681a0e7813fbc4d43db8a5623">vc</a></td></tr>
  126. <tr class="memdesc:a0b02902681a0e7813fbc4d43db8a5623"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function/method that returns nothing. <a href="#a0b02902681a0e7813fbc4d43db8a5623">More...</a><br/></td></tr>
  127. <tr class="separator:a0b02902681a0e7813fbc4d43db8a5623"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a49fad7586aea40b5fc229ffb3cf16b18"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__console__callbacks.html#ga7a450c76b2088ea26a24b454428faacd">BoolCallback</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_constructor.html#a49fad7586aea40b5fc229ffb3cf16b18">bc</a></td></tr>
  129. <tr class="memdesc:a49fad7586aea40b5fc229ffb3cf16b18"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function/method that returns a bool. <a href="#a49fad7586aea40b5fc229ffb3cf16b18">More...</a><br/></td></tr>
  130. <tr class="separator:a49fad7586aea40b5fc229ffb3cf16b18"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a091a48dd148417d771d2d2c33b86ebef"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_constructor.html#a091a48dd148417d771d2d2c33b86ebef">group</a></td></tr>
  132. <tr class="memdesc:a091a48dd148417d771d2d2c33b86ebef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates that this is a group marker. <a href="#a091a48dd148417d771d2d2c33b86ebef">More...</a><br/></td></tr>
  133. <tr class="separator:a091a48dd148417d771d2d2c33b86ebef"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a158ba7ae019433ca441d179d95ac4b81"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_constructor.html#a158ba7ae019433ca441d179d95ac4b81">overload</a></td></tr>
  135. <tr class="memdesc:a158ba7ae019433ca441d179d95ac4b81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates that this is an overload marker. <a href="#a158ba7ae019433ca441d179d95ac4b81">More...</a><br/></td></tr>
  136. <tr class="separator:a158ba7ae019433ca441d179d95ac4b81"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:aa3ca0c504f321d3657985faf35740bbe"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_constructor.html#aa3ca0c504f321d3657985faf35740bbe">ns</a></td></tr>
  138. <tr class="separator:aa3ca0c504f321d3657985faf35740bbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. </table><table class="memberdecls">
  140. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
  141. ConsoleConstructer Innards</h2></td></tr>
  142. <tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrpea4aca40ddfe8b5900210ee59e3985af"></a>The <a class="el" href="class_console_constructor.html">ConsoleConstructor</a> class is used as the backend for the ConsoleFunction() and ConsoleMethod() macros. The way it works takes advantage of several properties of C++.</p>
  143. <p>The ConsoleFunction()/ConsoleMethod() macros wrap the declaration of a <a class="el" href="class_console_constructor.html">ConsoleConstructor</a>.</p>
  144. <div class="fragment"><div class="line"><span class="comment">// The definition of a ConsoleFunction using the macro</span></div>
  145. <div class="line">ConsoleFunction(ExpandPath, <span class="keyword">const</span> <span class="keywordtype">char</span>*, 2, 2, <span class="stringliteral">&quot;(string filePath)&quot;</span>)</div>
  146. <div class="line">{</div>
  147. <div class="line"> argc;</div>
  148. <div class="line"> <span class="keywordtype">char</span>* ret = <a class="code" href="namespace_con.html#ab0583ba59217e586cf79446c95bbed3a">Con::getReturnBuffer</a>( 1024 );</div>
  149. <div class="line"> <a class="code" href="namespace_con.html#ade40cc27b73661f1d997107a00baae6b">Con::expandPath</a>(ret, 1024, argv[1]);</div>
  150. <div class="line"> <span class="keywordflow">return</span> ret;</div>
  151. <div class="line">}</div>
  152. <div class="line"></div>
  153. <div class="line"><span class="comment">// Resulting code</span></div>
  154. <div class="line"><span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* cExpandPath(<a class="code" href="class_sim_object.html">SimObject</a> *, S32, <span class="keyword">const</span> <span class="keywordtype">char</span> **argv);</div>
  155. <div class="line"><span class="keyword">static</span> <a class="code" href="class_console_constructor.html">ConsoleConstructor</a></div>
  156. <div class="line"> gExpandPathobj(NULL,<span class="stringliteral">&quot;ExpandPath&quot;</span>, cExpandPath,</div>
  157. <div class="line"> <span class="stringliteral">&quot;(string filePath)&quot;</span>, 2, 2);</div>
  158. <div class="line"><span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* cExpandPath(<a class="code" href="class_sim_object.html">SimObject</a> *, S32 argc, <span class="keyword">const</span> <span class="keywordtype">char</span> **argv)</div>
  159. <div class="line">{</div>
  160. <div class="line"> argc;</div>
  161. <div class="line"> <span class="keywordtype">char</span>* ret = <a class="code" href="namespace_con.html#ab0583ba59217e586cf79446c95bbed3a">Con::getReturnBuffer</a>( 1024 );</div>
  162. <div class="line"> <a class="code" href="namespace_con.html#ade40cc27b73661f1d997107a00baae6b">Con::expandPath</a>(ret, 1024, argv[1]);</div>
  163. <div class="line"> <span class="keywordflow">return</span> ret;</div>
  164. <div class="line">}</div>
  165. <div class="line"></div>
  166. <div class="line"><span class="comment">// A similar thing happens when you do a ConsoleMethod.</span></div>
  167. </div><!-- fragment --><p>As you can see, several global items are defined when you use the ConsoleFunction method. The macro constructs the name of these items from the parameters you passed it. Your implementation of the console function is is placed in a function with a name based on the actual name of the console funnction. In addition, a <a class="el" href="class_console_constructor.html">ConsoleConstructor</a> is declared.</p>
  168. <p>Because it is defined as a global, the constructor for the <a class="el" href="class_console_constructor.html">ConsoleConstructor</a> is called before execution of main() is started. The constructor is called once for each global <a class="el" href="class_console_constructor.html">ConsoleConstructor</a> variable, in the order in which they were defined (this property only holds true within file scope).</p>
  169. <p>We have <a class="el" href="class_console_constructor.html">ConsoleConstructor</a> create a linked list at constructor time, by storing a static pointer to the head of the list, and keeping a pointer to the next item in each instance of <a class="el" href="class_console_constructor.html">ConsoleConstructor</a>. <a class="el" href="class_console_constructor.html#a6d32eb990efa9713db15d405b359de57">init()</a> is a helper function in this process, automatically filling in commonly used fields and updating first and next as needed. In this way, a list of items to add to the console is assemble in memory, ready for use, before we start execution of the program proper.</p>
  170. <p>In <a class="el" href="namespace_con.html#a02fd73d861ef2e4aabb38c0c9ff82947">Con::init()</a>, <a class="el" href="class_console_constructor.html#a4fc01d736fe50cf5b977f755b675f11d">ConsoleConstructor::setup()</a> is called to process this prepared list. Each item in the list is iterated over, and the appropriate <a class="el" href="namespace_con.html">Con</a> namespace functions (usually <a class="el" href="namespace_con.html#afeb915f0af44d6f2a6bf5aab00898eef">Con::addCommand</a>) are invoked to register the ConsoleFunctions and ConsoleMethods in the appropriate namespaces.</p>
  171. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_namespace.html">Namespace</a> </dd>
  172. <dd>
  173. <a class="el" href="namespace_con.html">Con</a> </dd></dl>
  174. </td></tr>
  175. <tr class="memitem:a6e27a0725e68140724c31e583f6b8ef0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_console_constructor.html">ConsoleConstructor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_constructor.html#a6e27a0725e68140724c31e583f6b8ef0">next</a></td></tr>
  176. <tr class="separator:a6e27a0725e68140724c31e583f6b8ef0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  177. <tr class="memitem:a1a493db0fd3895a4cf41f81a267f8075"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_console_constructor.html">ConsoleConstructor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_constructor.html#a1a493db0fd3895a4cf41f81a267f8075">first</a> = NULL</td></tr>
  178. <tr class="separator:a1a493db0fd3895a4cf41f81a267f8075"><td class="memSeparator" colspan="2">&#160;</td></tr>
  179. <tr class="memitem:a6d32eb990efa9713db15d405b359de57"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_constructor.html#a6d32eb990efa9713db15d405b359de57">init</a> (const char *cName, const char *fName, const char *usg, S32 minArgs, S32 maxArgs)</td></tr>
  180. <tr class="separator:a6d32eb990efa9713db15d405b359de57"><td class="memSeparator" colspan="2">&#160;</td></tr>
  181. <tr class="memitem:a4fc01d736fe50cf5b977f755b675f11d"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_constructor.html#a4fc01d736fe50cf5b977f755b675f11d">setup</a> ()</td></tr>
  182. <tr class="separator:a4fc01d736fe50cf5b977f755b675f11d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  183. </table><table class="memberdecls">
  184. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
  185. Basic Console Constructors</h2></td></tr>
  186. <tr class="memitem:ab3778a593cc8675cb0dbb12eecf6b76e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_constructor.html#ab3778a593cc8675cb0dbb12eecf6b76e">ConsoleConstructor</a> (const char *<a class="el" href="class_console_constructor.html#a43ff489793a22a8e71664f7b5cadf1a3">className</a>, const char *<a class="el" href="class_console_constructor.html#afc7a5b78fd2c95e8a152ce9cc0c358d5">funcName</a>, <a class="el" href="group__console__callbacks.html#gaeada7638a4975df2e581e6de5dbb51d9">StringCallback</a> sfunc, const char *<a class="el" href="class_console_constructor.html#aef1bd6ad890a110b466cb0e8088507a2">usage</a>, S32 minArgs, S32 maxArgs)</td></tr>
  187. <tr class="separator:ab3778a593cc8675cb0dbb12eecf6b76e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  188. <tr class="memitem:a35134ff5e7e7e10d202c6ebaead76088"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_constructor.html#a35134ff5e7e7e10d202c6ebaead76088">ConsoleConstructor</a> (const char *<a class="el" href="class_console_constructor.html#a43ff489793a22a8e71664f7b5cadf1a3">className</a>, const char *<a class="el" href="class_console_constructor.html#afc7a5b78fd2c95e8a152ce9cc0c358d5">funcName</a>, <a class="el" href="group__console__callbacks.html#gaa2ec30e48268f28c2037491f145eeacc">IntCallback</a> ifunc, const char *<a class="el" href="class_console_constructor.html#aef1bd6ad890a110b466cb0e8088507a2">usage</a>, S32 minArgs, S32 maxArgs)</td></tr>
  189. <tr class="separator:a35134ff5e7e7e10d202c6ebaead76088"><td class="memSeparator" colspan="2">&#160;</td></tr>
  190. <tr class="memitem:a5f99edde2a028ce6d68c243100b82c51"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_constructor.html#a5f99edde2a028ce6d68c243100b82c51">ConsoleConstructor</a> (const char *<a class="el" href="class_console_constructor.html#a43ff489793a22a8e71664f7b5cadf1a3">className</a>, const char *<a class="el" href="class_console_constructor.html#afc7a5b78fd2c95e8a152ce9cc0c358d5">funcName</a>, <a class="el" href="group__console__callbacks.html#ga85b90d1b2d70a23128e78d1897a37575">FloatCallback</a> ffunc, const char *<a class="el" href="class_console_constructor.html#aef1bd6ad890a110b466cb0e8088507a2">usage</a>, S32 minArgs, S32 maxArgs)</td></tr>
  191. <tr class="separator:a5f99edde2a028ce6d68c243100b82c51"><td class="memSeparator" colspan="2">&#160;</td></tr>
  192. <tr class="memitem:a2d41dcbab99ada28306137531a49a7d5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_constructor.html#a2d41dcbab99ada28306137531a49a7d5">ConsoleConstructor</a> (const char *<a class="el" href="class_console_constructor.html#a43ff489793a22a8e71664f7b5cadf1a3">className</a>, const char *<a class="el" href="class_console_constructor.html#afc7a5b78fd2c95e8a152ce9cc0c358d5">funcName</a>, <a class="el" href="group__console__callbacks.html#gacacd79319494a58b292a7847f429c40f">VoidCallback</a> vfunc, const char *<a class="el" href="class_console_constructor.html#aef1bd6ad890a110b466cb0e8088507a2">usage</a>, S32 minArgs, S32 maxArgs)</td></tr>
  193. <tr class="separator:a2d41dcbab99ada28306137531a49a7d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  194. <tr class="memitem:a69f71688df918beb00b7cf10eb61d353"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_constructor.html#a69f71688df918beb00b7cf10eb61d353">ConsoleConstructor</a> (const char *<a class="el" href="class_console_constructor.html#a43ff489793a22a8e71664f7b5cadf1a3">className</a>, const char *<a class="el" href="class_console_constructor.html#afc7a5b78fd2c95e8a152ce9cc0c358d5">funcName</a>, <a class="el" href="group__console__callbacks.html#ga7a450c76b2088ea26a24b454428faacd">BoolCallback</a> bfunc, const char *<a class="el" href="class_console_constructor.html#aef1bd6ad890a110b466cb0e8088507a2">usage</a>, S32 minArgs, S32 maxArgs)</td></tr>
  195. <tr class="separator:a69f71688df918beb00b7cf10eb61d353"><td class="memSeparator" colspan="2">&#160;</td></tr>
  196. </table><table class="memberdecls">
  197. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
  198. Magic Console Constructors</h2></td></tr>
  199. <tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrp474b8cced04d74d04c4346d57c4dbd78"></a>These perform various pieces of "magic" related to consoleDoc functionality. <a class="el" href="console_autodoc.html">Console Auto-Documentation</a> </p>
  200. </td></tr>
  201. <tr class="memitem:a9e317fd91acb9f5f14db2b4e9ded95ad"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_constructor.html#a9e317fd91acb9f5f14db2b4e9ded95ad">ConsoleConstructor</a> (const char *<a class="el" href="class_console_constructor.html#a43ff489793a22a8e71664f7b5cadf1a3">className</a>, const char *groupName, const char *<a class="el" href="class_console_constructor.html#aef1bd6ad890a110b466cb0e8088507a2">usage</a>)</td></tr>
  202. <tr class="separator:a9e317fd91acb9f5f14db2b4e9ded95ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
  203. <tr class="memitem:ad54b77ce4573de899bc231ca8c51b3b2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_constructor.html#ad54b77ce4573de899bc231ca8c51b3b2">ConsoleConstructor</a> (const char *<a class="el" href="class_console_constructor.html#a43ff489793a22a8e71664f7b5cadf1a3">className</a>, const char *<a class="el" href="class_console_constructor.html#aef1bd6ad890a110b466cb0e8088507a2">usage</a>)</td></tr>
  204. <tr class="memdesc:ad54b77ce4573de899bc231ca8c51b3b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates a namespace usage string. <a href="#ad54b77ce4573de899bc231ca8c51b3b2">More...</a><br/></td></tr>
  205. <tr class="separator:ad54b77ce4573de899bc231ca8c51b3b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  206. </table>
  207. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  208. <div class="textblock"><p>This is the backend for the ConsoleMethod()/ConsoleFunction() macros.</p>
  209. <p>See the group <a class="el" href="class_console_constructor.html">ConsoleConstructor</a> Innards for specifics on how this works.</p>
  210. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="console_autodoc.html">Console Auto-Documentation</a> </dd></dl>
  211. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  212. <a class="anchor" id="ab3778a593cc8675cb0dbb12eecf6b76e"></a>
  213. <div class="memitem">
  214. <div class="memproto">
  215. <table class="memname">
  216. <tr>
  217. <td class="memname"><a class="el" href="class_console_constructor.html">ConsoleConstructor</a> </td>
  218. <td>(</td>
  219. <td class="paramtype">const char *&#160;</td>
  220. <td class="paramname"><em>className</em>, </td>
  221. </tr>
  222. <tr>
  223. <td class="paramkey"></td>
  224. <td></td>
  225. <td class="paramtype">const char *&#160;</td>
  226. <td class="paramname"><em>funcName</em>, </td>
  227. </tr>
  228. <tr>
  229. <td class="paramkey"></td>
  230. <td></td>
  231. <td class="paramtype"><a class="el" href="group__console__callbacks.html#gaeada7638a4975df2e581e6de5dbb51d9">StringCallback</a>&#160;</td>
  232. <td class="paramname"><em>sfunc</em>, </td>
  233. </tr>
  234. <tr>
  235. <td class="paramkey"></td>
  236. <td></td>
  237. <td class="paramtype">const char *&#160;</td>
  238. <td class="paramname"><em>usage</em>, </td>
  239. </tr>
  240. <tr>
  241. <td class="paramkey"></td>
  242. <td></td>
  243. <td class="paramtype">S32&#160;</td>
  244. <td class="paramname"><em>minArgs</em>, </td>
  245. </tr>
  246. <tr>
  247. <td class="paramkey"></td>
  248. <td></td>
  249. <td class="paramtype">S32&#160;</td>
  250. <td class="paramname"><em>maxArgs</em>&#160;</td>
  251. </tr>
  252. <tr>
  253. <td></td>
  254. <td>)</td>
  255. <td></td><td></td>
  256. </tr>
  257. </table>
  258. </div><div class="memdoc">
  259. </div>
  260. </div>
  261. <a class="anchor" id="a35134ff5e7e7e10d202c6ebaead76088"></a>
  262. <div class="memitem">
  263. <div class="memproto">
  264. <table class="memname">
  265. <tr>
  266. <td class="memname"><a class="el" href="class_console_constructor.html">ConsoleConstructor</a> </td>
  267. <td>(</td>
  268. <td class="paramtype">const char *&#160;</td>
  269. <td class="paramname"><em>className</em>, </td>
  270. </tr>
  271. <tr>
  272. <td class="paramkey"></td>
  273. <td></td>
  274. <td class="paramtype">const char *&#160;</td>
  275. <td class="paramname"><em>funcName</em>, </td>
  276. </tr>
  277. <tr>
  278. <td class="paramkey"></td>
  279. <td></td>
  280. <td class="paramtype"><a class="el" href="group__console__callbacks.html#gaa2ec30e48268f28c2037491f145eeacc">IntCallback</a>&#160;</td>
  281. <td class="paramname"><em>ifunc</em>, </td>
  282. </tr>
  283. <tr>
  284. <td class="paramkey"></td>
  285. <td></td>
  286. <td class="paramtype">const char *&#160;</td>
  287. <td class="paramname"><em>usage</em>, </td>
  288. </tr>
  289. <tr>
  290. <td class="paramkey"></td>
  291. <td></td>
  292. <td class="paramtype">S32&#160;</td>
  293. <td class="paramname"><em>minArgs</em>, </td>
  294. </tr>
  295. <tr>
  296. <td class="paramkey"></td>
  297. <td></td>
  298. <td class="paramtype">S32&#160;</td>
  299. <td class="paramname"><em>maxArgs</em>&#160;</td>
  300. </tr>
  301. <tr>
  302. <td></td>
  303. <td>)</td>
  304. <td></td><td></td>
  305. </tr>
  306. </table>
  307. </div><div class="memdoc">
  308. </div>
  309. </div>
  310. <a class="anchor" id="a5f99edde2a028ce6d68c243100b82c51"></a>
  311. <div class="memitem">
  312. <div class="memproto">
  313. <table class="memname">
  314. <tr>
  315. <td class="memname"><a class="el" href="class_console_constructor.html">ConsoleConstructor</a> </td>
  316. <td>(</td>
  317. <td class="paramtype">const char *&#160;</td>
  318. <td class="paramname"><em>className</em>, </td>
  319. </tr>
  320. <tr>
  321. <td class="paramkey"></td>
  322. <td></td>
  323. <td class="paramtype">const char *&#160;</td>
  324. <td class="paramname"><em>funcName</em>, </td>
  325. </tr>
  326. <tr>
  327. <td class="paramkey"></td>
  328. <td></td>
  329. <td class="paramtype"><a class="el" href="group__console__callbacks.html#ga85b90d1b2d70a23128e78d1897a37575">FloatCallback</a>&#160;</td>
  330. <td class="paramname"><em>ffunc</em>, </td>
  331. </tr>
  332. <tr>
  333. <td class="paramkey"></td>
  334. <td></td>
  335. <td class="paramtype">const char *&#160;</td>
  336. <td class="paramname"><em>usage</em>, </td>
  337. </tr>
  338. <tr>
  339. <td class="paramkey"></td>
  340. <td></td>
  341. <td class="paramtype">S32&#160;</td>
  342. <td class="paramname"><em>minArgs</em>, </td>
  343. </tr>
  344. <tr>
  345. <td class="paramkey"></td>
  346. <td></td>
  347. <td class="paramtype">S32&#160;</td>
  348. <td class="paramname"><em>maxArgs</em>&#160;</td>
  349. </tr>
  350. <tr>
  351. <td></td>
  352. <td>)</td>
  353. <td></td><td></td>
  354. </tr>
  355. </table>
  356. </div><div class="memdoc">
  357. </div>
  358. </div>
  359. <a class="anchor" id="a2d41dcbab99ada28306137531a49a7d5"></a>
  360. <div class="memitem">
  361. <div class="memproto">
  362. <table class="memname">
  363. <tr>
  364. <td class="memname"><a class="el" href="class_console_constructor.html">ConsoleConstructor</a> </td>
  365. <td>(</td>
  366. <td class="paramtype">const char *&#160;</td>
  367. <td class="paramname"><em>className</em>, </td>
  368. </tr>
  369. <tr>
  370. <td class="paramkey"></td>
  371. <td></td>
  372. <td class="paramtype">const char *&#160;</td>
  373. <td class="paramname"><em>funcName</em>, </td>
  374. </tr>
  375. <tr>
  376. <td class="paramkey"></td>
  377. <td></td>
  378. <td class="paramtype"><a class="el" href="group__console__callbacks.html#gacacd79319494a58b292a7847f429c40f">VoidCallback</a>&#160;</td>
  379. <td class="paramname"><em>vfunc</em>, </td>
  380. </tr>
  381. <tr>
  382. <td class="paramkey"></td>
  383. <td></td>
  384. <td class="paramtype">const char *&#160;</td>
  385. <td class="paramname"><em>usage</em>, </td>
  386. </tr>
  387. <tr>
  388. <td class="paramkey"></td>
  389. <td></td>
  390. <td class="paramtype">S32&#160;</td>
  391. <td class="paramname"><em>minArgs</em>, </td>
  392. </tr>
  393. <tr>
  394. <td class="paramkey"></td>
  395. <td></td>
  396. <td class="paramtype">S32&#160;</td>
  397. <td class="paramname"><em>maxArgs</em>&#160;</td>
  398. </tr>
  399. <tr>
  400. <td></td>
  401. <td>)</td>
  402. <td></td><td></td>
  403. </tr>
  404. </table>
  405. </div><div class="memdoc">
  406. </div>
  407. </div>
  408. <a class="anchor" id="a69f71688df918beb00b7cf10eb61d353"></a>
  409. <div class="memitem">
  410. <div class="memproto">
  411. <table class="memname">
  412. <tr>
  413. <td class="memname"><a class="el" href="class_console_constructor.html">ConsoleConstructor</a> </td>
  414. <td>(</td>
  415. <td class="paramtype">const char *&#160;</td>
  416. <td class="paramname"><em>className</em>, </td>
  417. </tr>
  418. <tr>
  419. <td class="paramkey"></td>
  420. <td></td>
  421. <td class="paramtype">const char *&#160;</td>
  422. <td class="paramname"><em>funcName</em>, </td>
  423. </tr>
  424. <tr>
  425. <td class="paramkey"></td>
  426. <td></td>
  427. <td class="paramtype"><a class="el" href="group__console__callbacks.html#ga7a450c76b2088ea26a24b454428faacd">BoolCallback</a>&#160;</td>
  428. <td class="paramname"><em>bfunc</em>, </td>
  429. </tr>
  430. <tr>
  431. <td class="paramkey"></td>
  432. <td></td>
  433. <td class="paramtype">const char *&#160;</td>
  434. <td class="paramname"><em>usage</em>, </td>
  435. </tr>
  436. <tr>
  437. <td class="paramkey"></td>
  438. <td></td>
  439. <td class="paramtype">S32&#160;</td>
  440. <td class="paramname"><em>minArgs</em>, </td>
  441. </tr>
  442. <tr>
  443. <td class="paramkey"></td>
  444. <td></td>
  445. <td class="paramtype">S32&#160;</td>
  446. <td class="paramname"><em>maxArgs</em>&#160;</td>
  447. </tr>
  448. <tr>
  449. <td></td>
  450. <td>)</td>
  451. <td></td><td></td>
  452. </tr>
  453. </table>
  454. </div><div class="memdoc">
  455. </div>
  456. </div>
  457. <a class="anchor" id="a9e317fd91acb9f5f14db2b4e9ded95ad"></a>
  458. <div class="memitem">
  459. <div class="memproto">
  460. <table class="memname">
  461. <tr>
  462. <td class="memname"><a class="el" href="class_console_constructor.html">ConsoleConstructor</a> </td>
  463. <td>(</td>
  464. <td class="paramtype">const char *&#160;</td>
  465. <td class="paramname"><em>className</em>, </td>
  466. </tr>
  467. <tr>
  468. <td class="paramkey"></td>
  469. <td></td>
  470. <td class="paramtype">const char *&#160;</td>
  471. <td class="paramname"><em>groupName</em>, </td>
  472. </tr>
  473. <tr>
  474. <td class="paramkey"></td>
  475. <td></td>
  476. <td class="paramtype">const char *&#160;</td>
  477. <td class="paramname"><em>usage</em>&#160;</td>
  478. </tr>
  479. <tr>
  480. <td></td>
  481. <td>)</td>
  482. <td></td><td></td>
  483. </tr>
  484. </table>
  485. </div><div class="memdoc">
  486. <p>Indicates a group marker. (A doxygen illusion)</p>
  487. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="namespace_con.html#a067658a5bf63fb6531cc3042ace16b3e">Con::markCommandGroup</a> <a class="el" href="console_autodoc.html">Console Auto-Documentation</a> </dd></dl>
  488. </div>
  489. </div>
  490. <a class="anchor" id="ad54b77ce4573de899bc231ca8c51b3b2"></a>
  491. <div class="memitem">
  492. <div class="memproto">
  493. <table class="memname">
  494. <tr>
  495. <td class="memname"><a class="el" href="class_console_constructor.html">ConsoleConstructor</a> </td>
  496. <td>(</td>
  497. <td class="paramtype">const char *&#160;</td>
  498. <td class="paramname"><em>className</em>, </td>
  499. </tr>
  500. <tr>
  501. <td class="paramkey"></td>
  502. <td></td>
  503. <td class="paramtype">const char *&#160;</td>
  504. <td class="paramname"><em>usage</em>&#160;</td>
  505. </tr>
  506. <tr>
  507. <td></td>
  508. <td>)</td>
  509. <td></td><td></td>
  510. </tr>
  511. </table>
  512. </div><div class="memdoc">
  513. <p>Indicates a namespace usage string. </p>
  514. </div>
  515. </div>
  516. <h2 class="groupheader">Member Function Documentation</h2>
  517. <a class="anchor" id="a6d32eb990efa9713db15d405b359de57"></a>
  518. <div class="memitem">
  519. <div class="memproto">
  520. <table class="memname">
  521. <tr>
  522. <td class="memname">void init </td>
  523. <td>(</td>
  524. <td class="paramtype">const char *&#160;</td>
  525. <td class="paramname"><em>cName</em>, </td>
  526. </tr>
  527. <tr>
  528. <td class="paramkey"></td>
  529. <td></td>
  530. <td class="paramtype">const char *&#160;</td>
  531. <td class="paramname"><em>fName</em>, </td>
  532. </tr>
  533. <tr>
  534. <td class="paramkey"></td>
  535. <td></td>
  536. <td class="paramtype">const char *&#160;</td>
  537. <td class="paramname"><em>usg</em>, </td>
  538. </tr>
  539. <tr>
  540. <td class="paramkey"></td>
  541. <td></td>
  542. <td class="paramtype">S32&#160;</td>
  543. <td class="paramname"><em>minArgs</em>, </td>
  544. </tr>
  545. <tr>
  546. <td class="paramkey"></td>
  547. <td></td>
  548. <td class="paramtype">S32&#160;</td>
  549. <td class="paramname"><em>maxArgs</em>&#160;</td>
  550. </tr>
  551. <tr>
  552. <td></td>
  553. <td>)</td>
  554. <td></td><td></td>
  555. </tr>
  556. </table>
  557. </div><div class="memdoc">
  558. </div>
  559. </div>
  560. <a class="anchor" id="a4fc01d736fe50cf5b977f755b675f11d"></a>
  561. <div class="memitem">
  562. <div class="memproto">
  563. <table class="mlabels">
  564. <tr>
  565. <td class="mlabels-left">
  566. <table class="memname">
  567. <tr>
  568. <td class="memname">void setup </td>
  569. <td>(</td>
  570. <td class="paramname"></td><td>)</td>
  571. <td></td>
  572. </tr>
  573. </table>
  574. </td>
  575. <td class="mlabels-right">
  576. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  577. </tr>
  578. </table>
  579. </div><div class="memdoc">
  580. </div>
  581. </div>
  582. <h2 class="groupheader">Member Data Documentation</h2>
  583. <a class="anchor" id="a49fad7586aea40b5fc229ffb3cf16b18"></a>
  584. <div class="memitem">
  585. <div class="memproto">
  586. <table class="memname">
  587. <tr>
  588. <td class="memname"><a class="el" href="group__console__callbacks.html#ga7a450c76b2088ea26a24b454428faacd">BoolCallback</a> bc</td>
  589. </tr>
  590. </table>
  591. </div><div class="memdoc">
  592. <p>A function/method that returns a bool. </p>
  593. </div>
  594. </div>
  595. <a class="anchor" id="a43ff489793a22a8e71664f7b5cadf1a3"></a>
  596. <div class="memitem">
  597. <div class="memproto">
  598. <table class="memname">
  599. <tr>
  600. <td class="memname">const char* className</td>
  601. </tr>
  602. </table>
  603. </div><div class="memdoc">
  604. <p>Class name. </p>
  605. </div>
  606. </div>
  607. <a class="anchor" id="a4742081c4d3981999ca9b617a2830a1e"></a>
  608. <div class="memitem">
  609. <div class="memproto">
  610. <table class="memname">
  611. <tr>
  612. <td class="memname"><a class="el" href="group__console__callbacks.html#ga85b90d1b2d70a23128e78d1897a37575">FloatCallback</a> fc</td>
  613. </tr>
  614. </table>
  615. </div><div class="memdoc">
  616. <p>A function/method that returns a float. </p>
  617. </div>
  618. </div>
  619. <a class="anchor" id="a1a493db0fd3895a4cf41f81a267f8075"></a>
  620. <div class="memitem">
  621. <div class="memproto">
  622. <table class="mlabels">
  623. <tr>
  624. <td class="mlabels-left">
  625. <table class="memname">
  626. <tr>
  627. <td class="memname"><a class="el" href="class_console_constructor.html">ConsoleConstructor</a> * first = NULL</td>
  628. </tr>
  629. </table>
  630. </td>
  631. <td class="mlabels-right">
  632. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  633. </tr>
  634. </table>
  635. </div><div class="memdoc">
  636. </div>
  637. </div>
  638. <a class="anchor" id="afc7a5b78fd2c95e8a152ce9cc0c358d5"></a>
  639. <div class="memitem">
  640. <div class="memproto">
  641. <table class="memname">
  642. <tr>
  643. <td class="memname">const char* funcName</td>
  644. </tr>
  645. </table>
  646. </div><div class="memdoc">
  647. <p>Function name. </p>
  648. </div>
  649. </div>
  650. <a class="anchor" id="a091a48dd148417d771d2d2c33b86ebef"></a>
  651. <div class="memitem">
  652. <div class="memproto">
  653. <table class="memname">
  654. <tr>
  655. <td class="memname">bool group</td>
  656. </tr>
  657. </table>
  658. </div><div class="memdoc">
  659. <p>Indicates that this is a group marker. </p>
  660. </div>
  661. </div>
  662. <a class="anchor" id="afe91de024e2cd723c581dda81f6bb6b8"></a>
  663. <div class="memitem">
  664. <div class="memproto">
  665. <table class="memname">
  666. <tr>
  667. <td class="memname"><a class="el" href="group__console__callbacks.html#gaa2ec30e48268f28c2037491f145eeacc">IntCallback</a> ic</td>
  668. </tr>
  669. </table>
  670. </div><div class="memdoc">
  671. <p>A function/method that returns an int. </p>
  672. </div>
  673. </div>
  674. <a class="anchor" id="a27185490efa9c459ee7e32e7f9eadf66"></a>
  675. <div class="memitem">
  676. <div class="memproto">
  677. <table class="memname">
  678. <tr>
  679. <td class="memname">S32 maxa</td>
  680. </tr>
  681. </table>
  682. </div><div class="memdoc">
  683. </div>
  684. </div>
  685. <a class="anchor" id="aaa42f32a432314ff3370d6650897bd7f"></a>
  686. <div class="memitem">
  687. <div class="memproto">
  688. <table class="memname">
  689. <tr>
  690. <td class="memname">S32 mina</td>
  691. </tr>
  692. </table>
  693. </div><div class="memdoc">
  694. <p>Minimum/maximum number of arguments for the function. </p>
  695. </div>
  696. </div>
  697. <a class="anchor" id="a6e27a0725e68140724c31e583f6b8ef0"></a>
  698. <div class="memitem">
  699. <div class="memproto">
  700. <table class="memname">
  701. <tr>
  702. <td class="memname"><a class="el" href="class_console_constructor.html">ConsoleConstructor</a>* next</td>
  703. </tr>
  704. </table>
  705. </div><div class="memdoc">
  706. </div>
  707. </div>
  708. <a class="anchor" id="aa3ca0c504f321d3657985faf35740bbe"></a>
  709. <div class="memitem">
  710. <div class="memproto">
  711. <table class="memname">
  712. <tr>
  713. <td class="memname">bool ns</td>
  714. </tr>
  715. </table>
  716. </div><div class="memdoc">
  717. <pre class="fragment"> Indicates that this is a namespace marker.
  718. </pre> <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000003">Deprecated:</a></b></dt><dd>Unused. </dd></dl>
  719. </div>
  720. </div>
  721. <a class="anchor" id="a158ba7ae019433ca441d179d95ac4b81"></a>
  722. <div class="memitem">
  723. <div class="memproto">
  724. <table class="memname">
  725. <tr>
  726. <td class="memname">bool overload</td>
  727. </tr>
  728. </table>
  729. </div><div class="memdoc">
  730. <p>Indicates that this is an overload marker. </p>
  731. </div>
  732. </div>
  733. <a class="anchor" id="a58d259b59730d65a5b3585c629c61a59"></a>
  734. <div class="memitem">
  735. <div class="memproto">
  736. <table class="memname">
  737. <tr>
  738. <td class="memname"><a class="el" href="group__console__callbacks.html#gaeada7638a4975df2e581e6de5dbb51d9">StringCallback</a> sc</td>
  739. </tr>
  740. </table>
  741. </div><div class="memdoc">
  742. <p>A function/method that returns a string. </p>
  743. </div>
  744. </div>
  745. <a class="anchor" id="aef1bd6ad890a110b466cb0e8088507a2"></a>
  746. <div class="memitem">
  747. <div class="memproto">
  748. <table class="memname">
  749. <tr>
  750. <td class="memname">const char* usage</td>
  751. </tr>
  752. </table>
  753. </div><div class="memdoc">
  754. <p>Usage string. </p>
  755. </div>
  756. </div>
  757. <a class="anchor" id="a0b02902681a0e7813fbc4d43db8a5623"></a>
  758. <div class="memitem">
  759. <div class="memproto">
  760. <table class="memname">
  761. <tr>
  762. <td class="memname"><a class="el" href="group__console__callbacks.html#gacacd79319494a58b292a7847f429c40f">VoidCallback</a> vc</td>
  763. </tr>
  764. </table>
  765. </div><div class="memdoc">
  766. <p>A function/method that returns nothing. </p>
  767. </div>
  768. </div>
  769. <hr/>The documentation for this class was generated from the following files:<ul>
  770. <li>console/console.h</li>
  771. <li>console/console.cc</li>
  772. </ul>
  773. </div><!-- contents -->
  774. <!-- start footer part -->
  775. <hr class="footer"/><address class="footer"><small>
  776. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  777. <img class="footer" src="doxygen.png" alt="doxygen"/>
  778. </a> 1.8.3.1
  779. </small></address>
  780. </body>
  781. </html>