class_sim_field_dictionary.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374
  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: SimFieldDictionary Class 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-types">Public Types</a> &#124;
  74. <a href="#pub-methods">Public Member Functions</a> &#124;
  75. <a href="#pub-attribs">Public Attributes</a> &#124;
  76. <a href="#friends">Friends</a> &#124;
  77. <a href="class_sim_field_dictionary-members.html">List of all members</a> </div>
  78. <div class="headertitle"><div class="title">SimFieldDictionary Class Reference</div></div>
  79. </div><!--header-->
  80. <div class="contents">
  81. <p><a class="el" href="class_dictionary.html">Dictionary</a> to keep track of dynamic fields on <a class="el" href="class_sim_object.html">SimObject</a>.
  82. <a href="class_sim_field_dictionary.html#details">More...</a></p>
  83. <p><code>#include &lt;simFieldDictionary.h&gt;</code></p>
  84. <table class="memberdecls">
  85. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
  86. Classes</h2></td></tr>
  87. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_sim_field_dictionary_1_1_entry.html">Entry</a></td></tr>
  88. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. </table><table class="memberdecls">
  90. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
  91. Public Types</h2></td></tr>
  92. <tr class="memitem:ac205be2172292384dd687b5471a87edd" id="r_ac205be2172292384dd687b5471a87edd"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom">{ <a class="el" href="class_sim_field_dictionary.html#ac205be2172292384dd687b5471a87eddac897f568ed00ab1aa7e0c99d812a7715">HashTableSize</a> = 19
  93. }</td></tr>
  94. <tr class="separator:ac205be2172292384dd687b5471a87edd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. </table><table class="memberdecls">
  96. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  97. Public Member Functions</h2></td></tr>
  98. <tr class="memitem:a5cb255216f01a186c2e276cc983cb795" id="r_a5cb255216f01a186c2e276cc983cb795"><td class="memItemLeft" align="right" valign="top">const U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_field_dictionary.html#a5cb255216f01a186c2e276cc983cb795">getVersion</a> () const</td></tr>
  99. <tr class="separator:a5cb255216f01a186c2e276cc983cb795"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a57b35608ee20bca7add8461768626003" id="r_a57b35608ee20bca7add8461768626003"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_field_dictionary.html#a57b35608ee20bca7add8461768626003">SimFieldDictionary</a> ()</td></tr>
  101. <tr class="separator:a57b35608ee20bca7add8461768626003"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:ace641267b18c995cd9a959d6100d851f" id="r_ace641267b18c995cd9a959d6100d851f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_field_dictionary.html#ace641267b18c995cd9a959d6100d851f">~SimFieldDictionary</a> ()</td></tr>
  103. <tr class="separator:ace641267b18c995cd9a959d6100d851f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a4c56c09cd55db7afd81d675440d28890" id="r_a4c56c09cd55db7afd81d675440d28890"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_field_dictionary.html#a4c56c09cd55db7afd81d675440d28890">setFieldValue</a> (StringTableEntry slotName, const char *value)</td></tr>
  105. <tr class="separator:a4c56c09cd55db7afd81d675440d28890"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a244a44dc0145b41feaa47a7928f33024" id="r_a244a44dc0145b41feaa47a7928f33024"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_field_dictionary.html#a244a44dc0145b41feaa47a7928f33024">getFieldValue</a> (StringTableEntry slotName)</td></tr>
  107. <tr class="separator:a244a44dc0145b41feaa47a7928f33024"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a9c779ec17c2336abeb6023d72dbe3e51" id="r_a9c779ec17c2336abeb6023d72dbe3e51"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_field_dictionary.html#a9c779ec17c2336abeb6023d72dbe3e51">writeFields</a> (<a class="el" href="class_sim_object.html">SimObject</a> *obj, <a class="el" href="class_stream.html">Stream</a> &amp;strem, U32 tabStop)</td></tr>
  109. <tr class="separator:a9c779ec17c2336abeb6023d72dbe3e51"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a49f6b98db92cda8ee277f37d506024b4" id="r_a49f6b98db92cda8ee277f37d506024b4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_field_dictionary.html#a49f6b98db92cda8ee277f37d506024b4">printFields</a> (<a class="el" href="class_sim_object.html">SimObject</a> *obj)</td></tr>
  111. <tr class="separator:a49f6b98db92cda8ee277f37d506024b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a4de5cdcf395d0ccbd0c5b57f545695db" id="r_a4de5cdcf395d0ccbd0c5b57f545695db"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_field_dictionary.html#a4de5cdcf395d0ccbd0c5b57f545695db">assignFrom</a> (<a class="el" href="class_sim_field_dictionary.html">SimFieldDictionary</a> *dict)</td></tr>
  113. <tr class="separator:a4de5cdcf395d0ccbd0c5b57f545695db"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. </table><table class="memberdecls">
  115. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  116. Public Attributes</h2></td></tr>
  117. <tr class="memitem:a0b214672d2ab9c57601faa778d6c58df" id="r_a0b214672d2ab9c57601faa778d6c58df"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_sim_field_dictionary_1_1_entry.html">Entry</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_field_dictionary.html#a0b214672d2ab9c57601faa778d6c58df">mHashTable</a> [<a class="el" href="class_sim_field_dictionary.html#ac205be2172292384dd687b5471a87eddac897f568ed00ab1aa7e0c99d812a7715">HashTableSize</a>]</td></tr>
  118. <tr class="separator:a0b214672d2ab9c57601faa778d6c58df"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. </table><table class="memberdecls">
  120. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
  121. Friends</h2></td></tr>
  122. <tr class="memitem:a6a5289021f7f92848ab43efe29b616fb" id="r_a6a5289021f7f92848ab43efe29b616fb"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_field_dictionary.html#a6a5289021f7f92848ab43efe29b616fb">SimFieldDictionaryIterator</a></td></tr>
  123. <tr class="separator:a6a5289021f7f92848ab43efe29b616fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. </table>
  125. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  126. <div class="textblock"><p><a class="el" href="class_dictionary.html">Dictionary</a> to keep track of dynamic fields on <a class="el" href="class_sim_object.html">SimObject</a>. </p>
  127. </div><h2 class="groupheader">Member Enumeration Documentation</h2>
  128. <a id="ac205be2172292384dd687b5471a87edd" name="ac205be2172292384dd687b5471a87edd"></a>
  129. <h2 class="memtitle"><span class="permalink"><a href="#ac205be2172292384dd687b5471a87edd">&#9670;&#160;</a></span>anonymous enum</h2>
  130. <div class="memitem">
  131. <div class="memproto">
  132. <table class="memname">
  133. <tr>
  134. <td class="memname">anonymous enum</td>
  135. </tr>
  136. </table>
  137. </div><div class="memdoc">
  138. <table class="fieldtable">
  139. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ac205be2172292384dd687b5471a87eddac897f568ed00ab1aa7e0c99d812a7715" name="ac205be2172292384dd687b5471a87eddac897f568ed00ab1aa7e0c99d812a7715"></a>HashTableSize&#160;</td><td class="fielddoc"></td></tr>
  140. </table>
  141. </div>
  142. </div>
  143. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  144. <a id="a57b35608ee20bca7add8461768626003" name="a57b35608ee20bca7add8461768626003"></a>
  145. <h2 class="memtitle"><span class="permalink"><a href="#a57b35608ee20bca7add8461768626003">&#9670;&#160;</a></span>SimFieldDictionary()</h2>
  146. <div class="memitem">
  147. <div class="memproto">
  148. <table class="memname">
  149. <tr>
  150. <td class="memname"><a class="el" href="class_sim_field_dictionary.html">SimFieldDictionary</a> </td>
  151. <td>(</td>
  152. <td class="paramname"></td><td>)</td>
  153. <td></td>
  154. </tr>
  155. </table>
  156. </div><div class="memdoc">
  157. </div>
  158. </div>
  159. <a id="ace641267b18c995cd9a959d6100d851f" name="ace641267b18c995cd9a959d6100d851f"></a>
  160. <h2 class="memtitle"><span class="permalink"><a href="#ace641267b18c995cd9a959d6100d851f">&#9670;&#160;</a></span>~SimFieldDictionary()</h2>
  161. <div class="memitem">
  162. <div class="memproto">
  163. <table class="memname">
  164. <tr>
  165. <td class="memname">~<a class="el" href="class_sim_field_dictionary.html">SimFieldDictionary</a> </td>
  166. <td>(</td>
  167. <td class="paramname"></td><td>)</td>
  168. <td></td>
  169. </tr>
  170. </table>
  171. </div><div class="memdoc">
  172. </div>
  173. </div>
  174. <h2 class="groupheader">Member Function Documentation</h2>
  175. <a id="a4de5cdcf395d0ccbd0c5b57f545695db" name="a4de5cdcf395d0ccbd0c5b57f545695db"></a>
  176. <h2 class="memtitle"><span class="permalink"><a href="#a4de5cdcf395d0ccbd0c5b57f545695db">&#9670;&#160;</a></span>assignFrom()</h2>
  177. <div class="memitem">
  178. <div class="memproto">
  179. <table class="memname">
  180. <tr>
  181. <td class="memname">void assignFrom </td>
  182. <td>(</td>
  183. <td class="paramtype"><a class="el" href="class_sim_field_dictionary.html">SimFieldDictionary</a> *&#160;</td>
  184. <td class="paramname"><em>dict</em></td><td>)</td>
  185. <td></td>
  186. </tr>
  187. </table>
  188. </div><div class="memdoc">
  189. </div>
  190. </div>
  191. <a id="a244a44dc0145b41feaa47a7928f33024" name="a244a44dc0145b41feaa47a7928f33024"></a>
  192. <h2 class="memtitle"><span class="permalink"><a href="#a244a44dc0145b41feaa47a7928f33024">&#9670;&#160;</a></span>getFieldValue()</h2>
  193. <div class="memitem">
  194. <div class="memproto">
  195. <table class="memname">
  196. <tr>
  197. <td class="memname">const char * getFieldValue </td>
  198. <td>(</td>
  199. <td class="paramtype">StringTableEntry&#160;</td>
  200. <td class="paramname"><em>slotName</em></td><td>)</td>
  201. <td></td>
  202. </tr>
  203. </table>
  204. </div><div class="memdoc">
  205. </div>
  206. </div>
  207. <a id="a5cb255216f01a186c2e276cc983cb795" name="a5cb255216f01a186c2e276cc983cb795"></a>
  208. <h2 class="memtitle"><span class="permalink"><a href="#a5cb255216f01a186c2e276cc983cb795">&#9670;&#160;</a></span>getVersion()</h2>
  209. <div class="memitem">
  210. <div class="memproto">
  211. <table class="mlabels">
  212. <tr>
  213. <td class="mlabels-left">
  214. <table class="memname">
  215. <tr>
  216. <td class="memname">const U32 getVersion </td>
  217. <td>(</td>
  218. <td class="paramname"></td><td>)</td>
  219. <td> const</td>
  220. </tr>
  221. </table>
  222. </td>
  223. <td class="mlabels-right">
  224. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  225. </tr>
  226. </table>
  227. </div><div class="memdoc">
  228. </div>
  229. </div>
  230. <a id="a49f6b98db92cda8ee277f37d506024b4" name="a49f6b98db92cda8ee277f37d506024b4"></a>
  231. <h2 class="memtitle"><span class="permalink"><a href="#a49f6b98db92cda8ee277f37d506024b4">&#9670;&#160;</a></span>printFields()</h2>
  232. <div class="memitem">
  233. <div class="memproto">
  234. <table class="memname">
  235. <tr>
  236. <td class="memname">void printFields </td>
  237. <td>(</td>
  238. <td class="paramtype"><a class="el" href="class_sim_object.html">SimObject</a> *&#160;</td>
  239. <td class="paramname"><em>obj</em></td><td>)</td>
  240. <td></td>
  241. </tr>
  242. </table>
  243. </div><div class="memdoc">
  244. </div>
  245. </div>
  246. <a id="a4c56c09cd55db7afd81d675440d28890" name="a4c56c09cd55db7afd81d675440d28890"></a>
  247. <h2 class="memtitle"><span class="permalink"><a href="#a4c56c09cd55db7afd81d675440d28890">&#9670;&#160;</a></span>setFieldValue()</h2>
  248. <div class="memitem">
  249. <div class="memproto">
  250. <table class="memname">
  251. <tr>
  252. <td class="memname">void setFieldValue </td>
  253. <td>(</td>
  254. <td class="paramtype">StringTableEntry&#160;</td>
  255. <td class="paramname"><em>slotName</em>, </td>
  256. </tr>
  257. <tr>
  258. <td class="paramkey"></td>
  259. <td></td>
  260. <td class="paramtype">const char *&#160;</td>
  261. <td class="paramname"><em>value</em>&#160;</td>
  262. </tr>
  263. <tr>
  264. <td></td>
  265. <td>)</td>
  266. <td></td><td></td>
  267. </tr>
  268. </table>
  269. </div><div class="memdoc">
  270. </div>
  271. </div>
  272. <a id="a9c779ec17c2336abeb6023d72dbe3e51" name="a9c779ec17c2336abeb6023d72dbe3e51"></a>
  273. <h2 class="memtitle"><span class="permalink"><a href="#a9c779ec17c2336abeb6023d72dbe3e51">&#9670;&#160;</a></span>writeFields()</h2>
  274. <div class="memitem">
  275. <div class="memproto">
  276. <table class="memname">
  277. <tr>
  278. <td class="memname">void writeFields </td>
  279. <td>(</td>
  280. <td class="paramtype"><a class="el" href="class_sim_object.html">SimObject</a> *&#160;</td>
  281. <td class="paramname"><em>obj</em>, </td>
  282. </tr>
  283. <tr>
  284. <td class="paramkey"></td>
  285. <td></td>
  286. <td class="paramtype"><a class="el" href="class_stream.html">Stream</a> &amp;&#160;</td>
  287. <td class="paramname"><em>strem</em>, </td>
  288. </tr>
  289. <tr>
  290. <td class="paramkey"></td>
  291. <td></td>
  292. <td class="paramtype">U32&#160;</td>
  293. <td class="paramname"><em>tabStop</em>&#160;</td>
  294. </tr>
  295. <tr>
  296. <td></td>
  297. <td>)</td>
  298. <td></td><td></td>
  299. </tr>
  300. </table>
  301. </div><div class="memdoc">
  302. </div>
  303. </div>
  304. <h2 class="groupheader">Friends And Related Symbol Documentation</h2>
  305. <a id="a6a5289021f7f92848ab43efe29b616fb" name="a6a5289021f7f92848ab43efe29b616fb"></a>
  306. <h2 class="memtitle"><span class="permalink"><a href="#a6a5289021f7f92848ab43efe29b616fb">&#9670;&#160;</a></span>SimFieldDictionaryIterator</h2>
  307. <div class="memitem">
  308. <div class="memproto">
  309. <table class="mlabels">
  310. <tr>
  311. <td class="mlabels-left">
  312. <table class="memname">
  313. <tr>
  314. <td class="memname">friend class <a class="el" href="class_sim_field_dictionary_iterator.html">SimFieldDictionaryIterator</a></td>
  315. </tr>
  316. </table>
  317. </td>
  318. <td class="mlabels-right">
  319. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  320. </tr>
  321. </table>
  322. </div><div class="memdoc">
  323. </div>
  324. </div>
  325. <h2 class="groupheader">Member Data Documentation</h2>
  326. <a id="a0b214672d2ab9c57601faa778d6c58df" name="a0b214672d2ab9c57601faa778d6c58df"></a>
  327. <h2 class="memtitle"><span class="permalink"><a href="#a0b214672d2ab9c57601faa778d6c58df">&#9670;&#160;</a></span>mHashTable</h2>
  328. <div class="memitem">
  329. <div class="memproto">
  330. <table class="memname">
  331. <tr>
  332. <td class="memname"><a class="el" href="struct_sim_field_dictionary_1_1_entry.html">Entry</a>* mHashTable[<a class="el" href="class_sim_field_dictionary.html#ac205be2172292384dd687b5471a87eddac897f568ed00ab1aa7e0c99d812a7715">HashTableSize</a>]</td>
  333. </tr>
  334. </table>
  335. </div><div class="memdoc">
  336. </div>
  337. </div>
  338. <hr/>The documentation for this class was generated from the following files:<ul>
  339. <li>sim/<b>simFieldDictionary.h</b></li>
  340. <li>sim/<b>simFieldDictionary.cc</b></li>
  341. </ul>
  342. </div><!-- contents -->
  343. <!-- start footer part -->
  344. <hr class="footer"/><address class="footer"><small>
  345. 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
  346. </small></address>
  347. </body>
  348. </html>