struct_enum_table.html 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Torque2D Reference: EnumTable Struct Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr id="projectrow">
  24. <td id="projectalign">
  25. <div id="projectname">Torque2D Reference
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.9.8 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  36. var searchBox = new SearchBox("searchBox", "search/",'.html');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */
  48. </script>
  49. <div id="main-nav"></div>
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <div id="MSearchResults">
  59. <div class="SRPage">
  60. <div id="SRIndex">
  61. <div id="SRResults"></div>
  62. <div class="SRStatus" id="Loading">Loading...</div>
  63. <div class="SRStatus" id="Searching">Searching...</div>
  64. <div class="SRStatus" id="NoMatches">No Matches</div>
  65. </div>
  66. </div>
  67. </div>
  68. </div>
  69. </div><!-- top -->
  70. <div class="header">
  71. <div class="summary">
  72. <a href="#nested-classes">Classes</a> &#124;
  73. <a href="#pub-methods">Public Member Functions</a> &#124;
  74. <a href="#pub-attribs">Public Attributes</a> &#124;
  75. <a href="struct_enum_table-members.html">List of all members</a> </div>
  76. <div class="headertitle"><div class="title">EnumTable Struct Reference</div></div>
  77. </div><!--header-->
  78. <div class="contents">
  79. <p><code>#include &lt;console.h&gt;</code></p>
  80. <table class="memberdecls">
  81. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
  82. Classes</h2></td></tr>
  83. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_enum_table_1_1_enums.html">Enums</a></td></tr>
  84. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This represents a specific item in the enumeration. <a href="struct_enum_table_1_1_enums.html#details">More...</a><br /></td></tr>
  85. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. </table><table class="memberdecls">
  87. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  88. Public Member Functions</h2></td></tr>
  89. <tr class="memitem:a7212ee37518cbd06c7b6d87021906555" id="r_a7212ee37518cbd06c7b6d87021906555"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_enum_table.html#a7212ee37518cbd06c7b6d87021906555">EnumTable</a> (S32 sSize, <a class="el" href="struct_enum_table_1_1_enums.html">Enums</a> *sTable)</td></tr>
  90. <tr class="separator:a7212ee37518cbd06c7b6d87021906555"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. </table><table class="memberdecls">
  92. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  93. Public Attributes</h2></td></tr>
  94. <tr class="memitem:a1d835f722a85dc94fbdee4f0a3179038" id="r_a1d835f722a85dc94fbdee4f0a3179038"><td class="memItemLeft" align="right" valign="top">S32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_enum_table.html#a1d835f722a85dc94fbdee4f0a3179038">size</a></td></tr>
  95. <tr class="memdesc:a1d835f722a85dc94fbdee4f0a3179038"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of enumerated items in the table. <br /></td></tr>
  96. <tr class="separator:a1d835f722a85dc94fbdee4f0a3179038"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:afe8cd1c47c4c77479a81285900908f89" id="r_afe8cd1c47c4c77479a81285900908f89"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_enum_table_1_1_enums.html">Enums</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_enum_table.html#afe8cd1c47c4c77479a81285900908f89">table</a></td></tr>
  98. <tr class="separator:afe8cd1c47c4c77479a81285900908f89"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. </table>
  100. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  101. <div class="textblock"><p>Scripting engine representation of an enum.</p>
  102. <p>This data structure is used by the scripting engine to expose enumerations to the scripting language. It acts to relate named constants to integer values, just like an enum in C++. </p>
  103. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  104. <a id="a7212ee37518cbd06c7b6d87021906555" name="a7212ee37518cbd06c7b6d87021906555"></a>
  105. <h2 class="memtitle"><span class="permalink"><a href="#a7212ee37518cbd06c7b6d87021906555">&#9670;&#160;</a></span>EnumTable()</h2>
  106. <div class="memitem">
  107. <div class="memproto">
  108. <table class="mlabels">
  109. <tr>
  110. <td class="mlabels-left">
  111. <table class="memname">
  112. <tr>
  113. <td class="memname"><a class="el" href="struct_enum_table.html">EnumTable</a> </td>
  114. <td>(</td>
  115. <td class="paramtype">S32&#160;</td>
  116. <td class="paramname"><em>sSize</em>, </td>
  117. </tr>
  118. <tr>
  119. <td class="paramkey"></td>
  120. <td></td>
  121. <td class="paramtype"><a class="el" href="struct_enum_table_1_1_enums.html">Enums</a> *&#160;</td>
  122. <td class="paramname"><em>sTable</em>&#160;</td>
  123. </tr>
  124. <tr>
  125. <td></td>
  126. <td>)</td>
  127. <td></td><td></td>
  128. </tr>
  129. </table>
  130. </td>
  131. <td class="mlabels-right">
  132. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  133. </tr>
  134. </table>
  135. </div><div class="memdoc">
  136. <p>Constructor.</p>
  137. <p>This sets up the <a class="el" href="struct_enum_table.html">EnumTable</a> with predefined data.</p>
  138. <dl class="params"><dt>Parameters</dt><dd>
  139. <table class="params">
  140. <tr><td class="paramname">sSize</td><td>Size of the table. </td></tr>
  141. <tr><td class="paramname">sTable</td><td>Pointer to table of <a class="el" href="struct_enum_table_1_1_enums.html" title="This represents a specific item in the enumeration.">Enums</a>.</td></tr>
  142. </table>
  143. </dd>
  144. </dl>
  145. <dl class="section see"><dt>See also</dt><dd>gLiquidTypeTable </dd>
  146. <dd>
  147. gAlignTable </dd></dl>
  148. </div>
  149. </div>
  150. <h2 class="groupheader">Member Data Documentation</h2>
  151. <a id="a1d835f722a85dc94fbdee4f0a3179038" name="a1d835f722a85dc94fbdee4f0a3179038"></a>
  152. <h2 class="memtitle"><span class="permalink"><a href="#a1d835f722a85dc94fbdee4f0a3179038">&#9670;&#160;</a></span>size</h2>
  153. <div class="memitem">
  154. <div class="memproto">
  155. <table class="memname">
  156. <tr>
  157. <td class="memname">S32 size</td>
  158. </tr>
  159. </table>
  160. </div><div class="memdoc">
  161. <p>Number of enumerated items in the table. </p>
  162. </div>
  163. </div>
  164. <a id="afe8cd1c47c4c77479a81285900908f89" name="afe8cd1c47c4c77479a81285900908f89"></a>
  165. <h2 class="memtitle"><span class="permalink"><a href="#afe8cd1c47c4c77479a81285900908f89">&#9670;&#160;</a></span>table</h2>
  166. <div class="memitem">
  167. <div class="memproto">
  168. <table class="memname">
  169. <tr>
  170. <td class="memname"><a class="el" href="struct_enum_table_1_1_enums.html">Enums</a>* table</td>
  171. </tr>
  172. </table>
  173. </div><div class="memdoc">
  174. </div>
  175. </div>
  176. <hr/>The documentation for this struct was generated from the following file:<ul>
  177. <li>console/<b>console.h</b></li>
  178. </ul>
  179. </div><!-- contents -->
  180. <!-- start footer part -->
  181. <hr class="footer"/><address class="footer"><small>
  182. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
  183. </small></address>
  184. </body>
  185. </html>