Inicio Explorar Axuda
Iniciar sesión
TorqueEngine
/
Torque2D
réplica de https://github.com/TorqueGameEngines/Torque2D.git
2
0
Fork 0
Ficheiros Incidencias 0 Wiki
Rama: gh-pages
Ramas Etiquetas
Torque2D
/
Torque2DDocs
/
html
/
class_console_object.html

class_console_object.html 85 KB
Permalink Histórico Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
    6. 

  6. <meta name="generator" content="Doxygen 1.9.8"/>
    7. 

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
    8. 

  8. <title>Torque2D Reference: ConsoleObject Class Reference</title>
    9. 

  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    10. 

  10. <script type="text/javascript" src="jquery.js"></script>
    11. 

  11. <script type="text/javascript" src="dynsections.js"></script>
    12. 

  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
    13. 

  13. <script type="text/javascript" src="search/searchdata.js"></script>
    14. 

  14. <script type="text/javascript" src="search/search.js"></script>
    15. 

  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    16. 

  16. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
    17. 

  17. </head>
    18. 

  18. <body>
    19. 

  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    20. 

  20. <div id="titlearea">
    21. 

  21. <table cellspacing="0" cellpadding="0">
    22. 

  22.  <tbody>
    23. 

  23.  <tr id="projectrow">
    24. 

  24.   <td id="projectalign">
    25. 

  25.    <div id="projectname">Torque2D Reference
    26. 

  26.    </div>
    27. 

  27.   </td>
    28. 

  28.  </tr>
    29. 

  29.  </tbody>
    30. 

  30. </table>
    31. 

  31. </div>
    32. 

  32. <!-- end header part -->
    33. 

  33. <!-- Generated by Doxygen 1.9.8 -->
    34. 

  34. <script type="text/javascript">
    35. 

  35. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
    36. 

  36. var searchBox = new SearchBox("searchBox", "search/",'.html');
    37. 

  37. /* @license-end */
    38. 

  38. </script>
    39. 

  39. <script type="text/javascript" src="menudata.js"></script>
    40. 

  40. <script type="text/javascript" src="menu.js"></script>
    41. 

  41. <script type="text/javascript">
    42. 

  42. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
    43. 

  43. $(function() {
    44. 

  44.   initMenu('',true,false,'search.php','Search');
    45. 

  45.   $(document).ready(function() { init_search(); });
    46. 

  46. });
    47. 

  47. /* @license-end */
    48. 

  48. </script>
    49. 

  49. <div id="main-nav"></div>
    50. 

  50. <!-- window showing the filter options -->
    51. 

  51. <div id="MSearchSelectWindow"
    52. 

  52.      onmouseover="return searchBox.OnSearchSelectShow()"
    53. 

  53.      onmouseout="return searchBox.OnSearchSelectHide()"
    54. 

  54.      onkeydown="return searchBox.OnSearchSelectKey(event)">
    55. 

  55. </div>
    56. 

  56. 

  57. <!-- iframe showing the search results (closed by default) -->
    58. 

  58. <div id="MSearchResultsWindow">
    59. 

  59. <div id="MSearchResults">
    60. 

  60. <div class="SRPage">
    61. 

  61. <div id="SRIndex">
    62. 

  62. <div id="SRResults"></div>
    63. 

  63. <div class="SRStatus" id="Loading">Loading...</div>
    64. 

  64. <div class="SRStatus" id="Searching">Searching...</div>
    65. 

  65. <div class="SRStatus" id="NoMatches">No Matches</div>
    66. 

  66. </div>
    67. 

  67. </div>
    68. 

  68. </div>
    69. 

  69. </div>
    70. 

  70. 

  71. </div><!-- top -->
    72. 

  72. <div class="header">
    73. 

  73.   <div class="summary">
    74. 

  74. <a href="#pub-methods">Public Member Functions</a> &#124;
    75. 

  75. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
    76. 

  76. <a href="#pro-methods">Protected Member Functions</a> &#124;
    77. 

  77. <a href="class_console_object-members.html">List of all members</a>  </div>
    78. 

  78.   <div class="headertitle"><div class="title">ConsoleObject Class Reference</div></div>
    79. 

  79. </div><!--header-->
    80. 

  80. <div class="contents">
    81. 

  81. 

  82. <p><code>#include &lt;consoleObject.h&gt;</code></p>
    83. 

  83. <div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
    84. 

  84.   <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for ConsoleObject:</div>
    85. 

  85. <div id="dynsection-0-summary" class="dynsummary" style="display:block;">
    86. 

  86. </div>
    87. 

  87. <div id="dynsection-0-content" class="dyncontent" style="display:none;">
    88. 

  88.  <div class="center">
    89. 

  89.   <img src="class_console_object.png" usemap="#ConsoleObject_map" alt=""/>
    90. 

  90.   <map id="ConsoleObject_map" name="ConsoleObject_map">
    91. 

  91. <area href="class_net_event.html" alt="NetEvent" shape="rect" coords="0,56,165,80"/>
    92. 

  92. <area href="class_sim_object.html" alt="SimObject" shape="rect" coords="350,56,515,80"/>
    93. 

  93. <area href="class_connection_message_event.html" alt="ConnectionMessageEvent" shape="rect" coords="175,112,340,136"/>
    94. 

  94. <area href="class_file_chunk_event.html" alt="FileChunkEvent" shape="rect" coords="175,168,340,192"/>
    95. 

  95. <area href="class_file_download_request_event.html" alt="FileDownloadRequestEvent" shape="rect" coords="175,224,340,248"/>
    96. 

  96. <area href="class_ghost_always_object_event.html" alt="GhostAlwaysObjectEvent" shape="rect" coords="175,280,340,304"/>
    97. 

  97. <area href="class_net_string_event.html" alt="NetStringEvent" shape="rect" coords="175,336,340,360"/>
    98. 

  98. <area href="class_remote_command_event.html" alt="RemoteCommandEvent" shape="rect" coords="175,392,340,416"/>
    99. 

  99. <area href="class_simple_message_event.html" alt="SimpleMessageEvent" shape="rect" coords="175,448,340,472"/>
    100. 

  100. <area href="class_action_map.html" alt="ActionMap" shape="rect" coords="525,112,690,136"/>
    101. 

  101. <area href="class_android_stream_source.html" alt="AndroidStreamSource" shape="rect" coords="525,168,690,192"/>
    102. 

  102. <area href="class_array.html" title="A data structure holding indexed sequences of key/value pairs for script use." alt="Array" shape="rect" coords="525,224,690,248"/>
    103. 

  103. <area href="class_asset_base.html" alt="AssetBase" shape="rect" coords="525,280,690,304"/>
    104. 

  104. <area href="class_asset_manager.html" alt="AssetManager" shape="rect" coords="525,336,690,360"/>
    105. 

  105. <area href="class_asset_query.html" alt="AssetQuery" shape="rect" coords="525,392,690,416"/>
    106. 

  106. <area href="class_asset_tags_manifest.html" alt="AssetTagsManifest" shape="rect" coords="525,448,690,472"/>
    107. 

  107. <area href="class_behavior_instance.html" alt="BehaviorInstance" shape="rect" coords="525,504,690,528"/>
    108. 

  108. <area href="class_behavior_template.html" alt="BehaviorTemplate" shape="rect" coords="525,560,690,584"/>
    109. 

  109. <area href="class_console_logger.html" alt="ConsoleLogger" shape="rect" coords="525,616,690,640"/>
    110. 

  110. <area href="class_declared_assets.html" alt="DeclaredAssets" shape="rect" coords="525,672,690,696"/>
    111. 

  111. <area href="class_dynamic_texture.html" alt="DynamicTexture" shape="rect" coords="525,728,690,752"/>
    112. 

  112. <area href="class_editor_toy_tool.html" alt="EditorToyTool" shape="rect" coords="525,784,690,808"/>
    113. 

  113. <area href="class_event_manager.html" alt="EventManager" shape="rect" coords="525,840,690,864"/>
    114. 

  114. <area href="class_file_dialog.html" alt="FileDialog" shape="rect" coords="525,896,690,920"/>
    115. 

  115. <area href="class_file_object.html" alt="FileObject" shape="rect" coords="525,952,690,976"/>
    116. 

  116. <area href="class_gui_border_profile.html" alt="GuiBorderProfile" shape="rect" coords="525,1008,690,1032"/>
    117. 

  117. <area href="class_gui_control_profile.html" alt="GuiControlProfile" shape="rect" coords="525,1064,690,1088"/>
    118. 

  118. <area href="class_gui_cursor.html" alt="GuiCursor" shape="rect" coords="525,1120,690,1144"/>
    119. 

  119. <area href="class_input_device.html" alt="InputDevice" shape="rect" coords="525,1176,690,1200"/>
    120. 

  120. <area href="class_lang_table.html" title="Language file table." alt="LangTable" shape="rect" coords="525,1232,690,1256"/>
    121. 

  121. <area href="class_message.html" title="Base class for messages." alt="Message" shape="rect" coords="525,1288,690,1312"/>
    122. 

  122. <area href="class_message_vector.html" alt="MessageVector" shape="rect" coords="525,1344,690,1368"/>
    123. 

  123. <area href="class_module_manager.html" alt="ModuleManager" shape="rect" coords="525,1400,690,1424"/>
    124. 

  124. <area href="class_module_merge_definition.html" alt="ModuleMergeDefinition" shape="rect" coords="525,1456,690,1480"/>
    125. 

  125. <area href="class_net_object.html" alt="NetObject" shape="rect" coords="525,1512,690,1536"/>
    126. 

  126. <area href="class_p_n_g_image.html" alt="PNGImage" shape="rect" coords="525,1568,690,1592"/>
    127. 

  127. <area href="class_particle_asset_emitter.html" alt="ParticleAssetEmitter" shape="rect" coords="525,1624,690,1648"/>
    128. 

  128. <area href="class_picking_scene_controller.html" alt="PickingSceneController" shape="rect" coords="525,1680,690,1704"/>
    129. 

  129. <area href="class_popup_menu.html" alt="PopupMenu" shape="rect" coords="525,1736,690,1760"/>
    130. 

  130. <area href="class_referenced_assets.html" alt="ReferencedAssets" shape="rect" coords="525,1792,690,1816"/>
    131. 

  131. <area href="class_remote_debugger_base.html" alt="RemoteDebuggerBase" shape="rect" coords="525,1848,690,1872"/>
    132. 

  132. <area href="class_render_proxy.html" alt="RenderProxy" shape="rect" coords="525,1904,690,1928"/>
    133. 

  133. <area href="class_scene_object_set.html" alt="SceneObjectSet" shape="rect" coords="525,1960,690,1984"/>
    134. 

  134. <area href="class_script_msg_listener.html" title="Script accessible version of Dispatcher::IMessageListener." alt="ScriptMsgListener" shape="rect" coords="525,2016,690,2040"/>
    135. 

  135. <area href="class_sim_component.html" alt="SimComponent" shape="rect" coords="525,2072,690,2096"/>
    136. 

  136. <area href="class_sim_data_block.html" alt="SimDataBlock" shape="rect" coords="525,2128,690,2152"/>
    137. 

  137. <area href="class_sim_set.html" alt="SimSet" shape="rect" coords="525,2184,690,2208"/>
    138. 

  138. <area href="class_sim_x_m_l_document.html" alt="SimXMLDocument" shape="rect" coords="525,2240,690,2264"/>
    139. 

  139. <area href="class_stream_object.html" title="Script wrapper for the Stream class." alt="StreamObject" shape="rect" coords="525,2296,690,2320"/>
    140. 

  140. <area href="class_t_c_p_object.html" alt="TCPObject" shape="rect" coords="525,2352,690,2376"/>
    141. 

  141. <area href="class_taml.html" alt="Taml" shape="rect" coords="525,2408,690,2432"/>
    142. 

  142. <area href="class_undo_action.html" alt="UndoAction" shape="rect" coords="525,2464,690,2488"/>
    143. 

  143. <area href="class_undo_manager.html" alt="UndoManager" shape="rect" coords="525,2520,690,2544"/>
    144. 

  144. <area href="class_world_query.html" alt="WorldQuery" shape="rect" coords="525,2576,690,2600"/>
    145. 

  145. <area href="class_zip_object.html" title="Script wrapper for Zip::ZipArchive." alt="ZipObject" shape="rect" coords="525,2632,690,2656"/>
    146. 

  146.   </map>
    147. 

  147. </div></div>
    148. 

  148. <table class="memberdecls">
    149. 

  149. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
    150. 

  150. Public Member Functions</h2></td></tr>
    151. 

  151. <tr class="memitem:a1126670f9cef40e89f356669cd373252" id="r_a1126670f9cef40e89f356669cd373252"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="struct_abstract_class_rep_1_1_field.html">AbstractClassRep::Field</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a1126670f9cef40e89f356669cd373252">findField</a> (StringTableEntry fieldName) const</td></tr>
    152. 

  152. <tr class="memdesc:a1126670f9cef40e89f356669cd373252"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a reference to a field by name.  <br /></td></tr>
    153. 

  153. <tr class="separator:a1126670f9cef40e89f356669cd373252"><td class="memSeparator" colspan="2">&#160;</td></tr>
    154. 

  154. <tr class="memitem:aa8453ccfe6d778d5612ae246b05c488b" id="r_aa8453ccfe6d778d5612ae246b05c488b"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_abstract_class_rep.html">AbstractClassRep</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#aa8453ccfe6d778d5612ae246b05c488b">getClassRep</a> () const</td></tr>
    155. 

  155. <tr class="memdesc:aa8453ccfe6d778d5612ae246b05c488b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the ClassRep.  <br /></td></tr>
    156. 

  156. <tr class="separator:aa8453ccfe6d778d5612ae246b05c488b"><td class="memSeparator" colspan="2">&#160;</td></tr>
    157. 

  157. <tr class="memitem:ac980ffce7987a95385fe04d6fd934a6a" id="r_ac980ffce7987a95385fe04d6fd934a6a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#ac980ffce7987a95385fe04d6fd934a6a">setField</a> (const char *fieldName, const char *value)</td></tr>
    158. 

  158. <tr class="memdesc:ac980ffce7987a95385fe04d6fd934a6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the value of a field.  <br /></td></tr>
    159. 

  159. <tr class="separator:ac980ffce7987a95385fe04d6fd934a6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
    160. 

  160. <tr class="memitem:a648a403aff97cfb8f198fad055feea64" id="r_a648a403aff97cfb8f198fad055feea64"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a648a403aff97cfb8f198fad055feea64">~ConsoleObject</a> ()</td></tr>
    161. 

  161. <tr class="separator:a648a403aff97cfb8f198fad055feea64"><td class="memSeparator" colspan="2">&#160;</td></tr>
    162. 

  162. </table><table class="memberdecls">
    163. 

  163. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
    164. 

  164. Static Public Member Functions</h2></td></tr>
    165. 

  165. <tr class="memitem:a336cc354c2d28bd8a502405466282db9" id="r_a336cc354c2d28bd8a502405466282db9"><td class="memItemLeft" align="right" valign="top">static const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a336cc354c2d28bd8a502405466282db9">lookupClassName</a> (const U32 in_classTag)</td></tr>
    166. 

  166. <tr class="memdesc:a336cc354c2d28bd8a502405466282db9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the classname from a class tag.  <br /></td></tr>
    167. 

  167. <tr class="separator:a336cc354c2d28bd8a502405466282db9"><td class="memSeparator" colspan="2">&#160;</td></tr>
    168. 

  168. <tr class="memitem:a67420d3593db1aae6efb2c3abb23c690" id="r_a67420d3593db1aae6efb2c3abb23c690"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a67420d3593db1aae6efb2c3abb23c690">initPersistFields</a> ()</td></tr>
    169. 

  169. <tr class="separator:a67420d3593db1aae6efb2c3abb23c690"><td class="memSeparator" colspan="2">&#160;</td></tr>
    170. 

  170. <tr class="memitem:a95c239afc15d197ae11798bc11e5c28b" id="r_a95c239afc15d197ae11798bc11e5c28b"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a95c239afc15d197ae11798bc11e5c28b">consoleInit</a> ()</td></tr>
    171. 

  171. <tr class="separator:a95c239afc15d197ae11798bc11e5c28b"><td class="memSeparator" colspan="2">&#160;</td></tr>
    172. 

  172. </table><table class="memberdecls">
    173. 

  173. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
    174. 

  174. Protected Member Functions</h2></td></tr>
    175. 

  175. <tr class="memitem:a8b5a944ed3b7fa672a250a5d389c8f15" id="r_a8b5a944ed3b7fa672a250a5d389c8f15"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a8b5a944ed3b7fa672a250a5d389c8f15">ConsoleObject</a> ()</td></tr>
    176. 

  176. <tr class="separator:a8b5a944ed3b7fa672a250a5d389c8f15"><td class="memSeparator" colspan="2">&#160;</td></tr>
    177. 

  177. <tr class="memitem:a601f42ddcee97ab4eee59e6dbc9df75b" id="r_a601f42ddcee97ab4eee59e6dbc9df75b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a601f42ddcee97ab4eee59e6dbc9df75b">ConsoleObject</a> (const <a class="el" href="class_console_object.html">ConsoleObject</a> &amp;)</td></tr>
    178. 

  178. <tr class="separator:a601f42ddcee97ab4eee59e6dbc9df75b"><td class="memSeparator" colspan="2">&#160;</td></tr>
    179. 

  179. </table><table class="memberdecls">
    180. 

  180. <tr class="heading"><td colspan="2"><h2 class="groupheader">Field List</h2></td></tr>
    181. 

  181. <tr class="memitem:a2f9f31b3f4acbf8bdfefa15f78c49729" id="r_a2f9f31b3f4acbf8bdfefa15f78c49729"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="class_abstract_class_rep.html#a470d9814acbdf9bd6a2b054c6ff7f3a6">AbstractClassRep::FieldList</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a2f9f31b3f4acbf8bdfefa15f78c49729">getFieldList</a> () const</td></tr>
    182. 

  182. <tr class="memdesc:a2f9f31b3f4acbf8bdfefa15f78c49729"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a list of all the fields. This information cannot be modified.  <br /></td></tr>
    183. 

  183. <tr class="separator:a2f9f31b3f4acbf8bdfefa15f78c49729"><td class="memSeparator" colspan="2">&#160;</td></tr>
    184. 

  184. <tr class="memitem:ab33e449170ae2f52341c47138da4996c" id="r_ab33e449170ae2f52341c47138da4996c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_abstract_class_rep.html#a470d9814acbdf9bd6a2b054c6ff7f3a6">AbstractClassRep::FieldList</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#ab33e449170ae2f52341c47138da4996c">getModifiableFieldList</a> ()</td></tr>
    185. 

  185. <tr class="separator:ab33e449170ae2f52341c47138da4996c"><td class="memSeparator" colspan="2">&#160;</td></tr>
    186. 

  186. <tr class="memitem:a546fd9261e6104b86b947e417bef1228" id="r_a546fd9261e6104b86b947e417bef1228"><td class="memItemLeft" align="right" valign="top">bool &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a546fd9261e6104b86b947e417bef1228">getDynamicGroupExpand</a> ()</td></tr>
    187. 

  187. <tr class="separator:a546fd9261e6104b86b947e417bef1228"><td class="memSeparator" colspan="2">&#160;</td></tr>
    188. 

  188. </table><table class="memberdecls">
    189. 

  189. <tr class="heading"><td colspan="2"><h2 class="groupheader">ConsoleObject Implementation</h2></td></tr>
    190. 

  190. <tr><td class="ititle" colspan="2"><p>These functions are implemented in every subclass of <a class="el" href="class_console_object.html">ConsoleObject</a> by an IMPLEMENT_CONOBJECT or IMPLEMENT_CO_* macro. </p>
    191. 

  191. </td></tr>
    192. 

  192. <tr class="memitem:ae7913c7a8d1966a725b93f657456b66a" id="r_ae7913c7a8d1966a725b93f657456b66a"><td class="memItemLeft" align="right" valign="top">S32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#ae7913c7a8d1966a725b93f657456b66a">getClassId</a> (U32 netClassGroup) const</td></tr>
    193. 

  193. <tr class="separator:ae7913c7a8d1966a725b93f657456b66a"><td class="memSeparator" colspan="2">&#160;</td></tr>
    194. 

  194. <tr class="memitem:a45b489f436c9d32a63f9c3d62f66c892" id="r_a45b489f436c9d32a63f9c3d62f66c892"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a45b489f436c9d32a63f9c3d62f66c892">getClassName</a> () const</td></tr>
    195. 

  195. <tr class="separator:a45b489f436c9d32a63f9c3d62f66c892"><td class="memSeparator" colspan="2">&#160;</td></tr>
    196. 

  196. <tr class="memitem:af6128f2158606edc40e1cb210ba92bd0" id="r_af6128f2158606edc40e1cb210ba92bd0"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_abstract_class_rep.html">AbstractClassRep</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#af6128f2158606edc40e1cb210ba92bd0">getStaticClassRep</a> ()</td></tr>
    197. 

  197. <tr class="memdesc:af6128f2158606edc40e1cb210ba92bd0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the abstract class information for this class.  <br /></td></tr>
    198. 

  198. <tr class="separator:af6128f2158606edc40e1cb210ba92bd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
    199. 

  199. <tr class="memitem:ac93219672441a5e91bcfc02abeed29cb" id="r_ac93219672441a5e91bcfc02abeed29cb"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_abstract_class_rep.html">AbstractClassRep</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#ac93219672441a5e91bcfc02abeed29cb">getParentStaticClassRep</a> ()</td></tr>
    200. 

  200. <tr class="memdesc:ac93219672441a5e91bcfc02abeed29cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the abstract class information for this class's superclass.  <br /></td></tr>
    201. 

  201. <tr class="separator:ac93219672441a5e91bcfc02abeed29cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
    202. 

  202. </table><table class="memberdecls">
    203. 

  203. <tr class="heading"><td colspan="2"><h2 class="groupheader">Object Creation</h2></td></tr>
    204. 

  204. <tr class="memitem:aa8b4ee59c729a0704b4a2f7b52246f98" id="r_aa8b4ee59c729a0704b4a2f7b52246f98"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_console_object.html">ConsoleObject</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#aa8b4ee59c729a0704b4a2f7b52246f98">create</a> (const char *in_pClassName)</td></tr>
    205. 

  205. <tr class="separator:aa8b4ee59c729a0704b4a2f7b52246f98"><td class="memSeparator" colspan="2">&#160;</td></tr>
    206. 

  206. <tr class="memitem:abeb358d6fc89fc282b4e401de2895965" id="r_abeb358d6fc89fc282b4e401de2895965"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_console_object.html">ConsoleObject</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#abeb358d6fc89fc282b4e401de2895965">create</a> (const U32 groupId, const U32 typeId, const U32 in_classId)</td></tr>
    207. 

  207. <tr class="separator:abeb358d6fc89fc282b4e401de2895965"><td class="memSeparator" colspan="2">&#160;</td></tr>
    208. 

  208. </table><table class="memberdecls">
    209. 

  209. <tr class="heading"><td colspan="2"><h2 class="groupheader">Fields</h2></td></tr>
    210. 

  210. <tr class="memitem:a38f3095c01e8b2055e4c2e58d9a133e8" id="r_a38f3095c01e8b2055e4c2e58d9a133e8"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a38f3095c01e8b2055e4c2e58d9a133e8">addGroup</a> (const char *in_pGroupname, const char *in_pGroupDocs=NULL)</td></tr>
    211. 

  211. <tr class="separator:a38f3095c01e8b2055e4c2e58d9a133e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
    212. 

  212. <tr class="memitem:a1918263ead95ed1906c7027651938e0c" id="r_a1918263ead95ed1906c7027651938e0c"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a1918263ead95ed1906c7027651938e0c">endGroup</a> (const char *in_pGroupname)</td></tr>
    213. 

  213. <tr class="separator:a1918263ead95ed1906c7027651938e0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
    214. 

  214. <tr class="memitem:a1e61452413a8cd497dfc1a2b62f072cd" id="r_a1e61452413a8cd497dfc1a2b62f072cd"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a1e61452413a8cd497dfc1a2b62f072cd">addField</a> (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, const U32 in_elementCount=1, <a class="el" href="struct_enum_table.html">EnumTable</a> *in_table=NULL, const char *in_pFieldDocs=NULL)</td></tr>
    215. 

  215. <tr class="separator:a1e61452413a8cd497dfc1a2b62f072cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
    216. 

  216. <tr class="memitem:ad4ad51d247b2e09ea51783a8fdbb4b95" id="r_ad4ad51d247b2e09ea51783a8fdbb4b95"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#ad4ad51d247b2e09ea51783a8fdbb4b95">addField</a> (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, <a class="el" href="class_abstract_class_rep.html#ab897bbd2116b331da38ac71717dbb3b3">AbstractClassRep::WriteDataNotify</a> in_writeDataFn, const U32 in_elementCount=1, <a class="el" href="struct_enum_table.html">EnumTable</a> *in_table=NULL, const char *in_pFieldDocs=NULL)</td></tr>
    217. 

  217. <tr class="separator:ad4ad51d247b2e09ea51783a8fdbb4b95"><td class="memSeparator" colspan="2">&#160;</td></tr>
    218. 

  218. <tr class="memitem:a7fe0d513b2bea8f6a1710c35189f550c" id="r_a7fe0d513b2bea8f6a1710c35189f550c"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a7fe0d513b2bea8f6a1710c35189f550c">addField</a> (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, const char *in_pFieldDocs)</td></tr>
    219. 

  219. <tr class="separator:a7fe0d513b2bea8f6a1710c35189f550c"><td class="memSeparator" colspan="2">&#160;</td></tr>
    220. 

  220. <tr class="memitem:a83176674ac909724b9ba2dce44a71e9a" id="r_a83176674ac909724b9ba2dce44a71e9a"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a83176674ac909724b9ba2dce44a71e9a">addField</a> (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, <a class="el" href="class_abstract_class_rep.html#ab897bbd2116b331da38ac71717dbb3b3">AbstractClassRep::WriteDataNotify</a> in_writeDataFn, const char *in_pFieldDocs)</td></tr>
    221. 

  221. <tr class="separator:a83176674ac909724b9ba2dce44a71e9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
    222. 

  222. <tr class="memitem:a3356a3140575cbc1e4466883937daf0b" id="r_a3356a3140575cbc1e4466883937daf0b"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a3356a3140575cbc1e4466883937daf0b">addFieldV</a> (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, <a class="el" href="class_console_type_validator.html">ConsoleTypeValidator</a> *v, const char *in_pFieldDocs=NULL)</td></tr>
    223. 

  223. <tr class="separator:a3356a3140575cbc1e4466883937daf0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
    224. 

  224. <tr class="memitem:ae5af434e7146816044ce3be70f61ebb8" id="r_ae5af434e7146816044ce3be70f61ebb8"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#ae5af434e7146816044ce3be70f61ebb8">addProtectedField</a> (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, <a class="el" href="class_abstract_class_rep.html#a23fe751b9b844d180a5e8ee921968aa5">AbstractClassRep::SetDataNotify</a> in_setDataFn, <a class="el" href="class_abstract_class_rep.html#a11f286fc60ce139f916571059ec35e22">AbstractClassRep::GetDataNotify</a> in_getDataFn=&amp;defaultProtectedGetFn, const U32 in_elementCount=1, <a class="el" href="struct_enum_table.html">EnumTable</a> *in_table=NULL, const char *in_pFieldDocs=NULL)</td></tr>
    225. 

  225. <tr class="separator:ae5af434e7146816044ce3be70f61ebb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
    226. 

  226. <tr class="memitem:a5161f628159e510b744cef47fd6598a3" id="r_a5161f628159e510b744cef47fd6598a3"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a5161f628159e510b744cef47fd6598a3">addProtectedField</a> (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, <a class="el" href="class_abstract_class_rep.html#a23fe751b9b844d180a5e8ee921968aa5">AbstractClassRep::SetDataNotify</a> in_setDataFn, <a class="el" href="class_abstract_class_rep.html#a11f286fc60ce139f916571059ec35e22">AbstractClassRep::GetDataNotify</a> in_getDataFn=&amp;defaultProtectedGetFn, <a class="el" href="class_abstract_class_rep.html#ab897bbd2116b331da38ac71717dbb3b3">AbstractClassRep::WriteDataNotify</a> in_writeDataFn=&amp;defaultProtectedWriteFn, const U32 in_elementCount=1, <a class="el" href="struct_enum_table.html">EnumTable</a> *in_table=NULL, const char *in_pFieldDocs=NULL)</td></tr>
    227. 

  227. <tr class="separator:a5161f628159e510b744cef47fd6598a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
    228. 

  228. <tr class="memitem:a2df2d873096113f009661c676c4d0c81" id="r_a2df2d873096113f009661c676c4d0c81"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a2df2d873096113f009661c676c4d0c81">addProtectedField</a> (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, <a class="el" href="class_abstract_class_rep.html#a23fe751b9b844d180a5e8ee921968aa5">AbstractClassRep::SetDataNotify</a> in_setDataFn, <a class="el" href="class_abstract_class_rep.html#a11f286fc60ce139f916571059ec35e22">AbstractClassRep::GetDataNotify</a> in_getDataFn=&amp;defaultProtectedGetFn, const char *in_pFieldDocs=NULL)</td></tr>
    229. 

  229. <tr class="separator:a2df2d873096113f009661c676c4d0c81"><td class="memSeparator" colspan="2">&#160;</td></tr>
    230. 

  230. <tr class="memitem:aed96a36e73e2eee15cf6a3ae1412d9bd" id="r_aed96a36e73e2eee15cf6a3ae1412d9bd"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#aed96a36e73e2eee15cf6a3ae1412d9bd">addProtectedField</a> (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, <a class="el" href="class_abstract_class_rep.html#a23fe751b9b844d180a5e8ee921968aa5">AbstractClassRep::SetDataNotify</a> in_setDataFn, <a class="el" href="class_abstract_class_rep.html#a11f286fc60ce139f916571059ec35e22">AbstractClassRep::GetDataNotify</a> in_getDataFn=&amp;defaultProtectedGetFn, <a class="el" href="class_abstract_class_rep.html#ab897bbd2116b331da38ac71717dbb3b3">AbstractClassRep::WriteDataNotify</a> in_writeDataFn=&amp;defaultProtectedWriteFn, const char *in_pFieldDocs=NULL)</td></tr>
    231. 

  231. <tr class="separator:aed96a36e73e2eee15cf6a3ae1412d9bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
    232. 

  232. <tr class="memitem:aed3d0d1abd7ba4a17e792ca80f3478a7" id="r_aed3d0d1abd7ba4a17e792ca80f3478a7"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#aed3d0d1abd7ba4a17e792ca80f3478a7">addDepricatedField</a> (const char *fieldName)</td></tr>
    233. 

  233. <tr class="separator:aed3d0d1abd7ba4a17e792ca80f3478a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
    234. 

  234. <tr class="memitem:a7a47772574721164fe83b2fd5e3c6fc8" id="r_a7a47772574721164fe83b2fd5e3c6fc8"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a7a47772574721164fe83b2fd5e3c6fc8">removeField</a> (const char *in_pFieldname)</td></tr>
    235. 

  235. <tr class="separator:a7a47772574721164fe83b2fd5e3c6fc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
    236. 

  236. </table>
    237. 

  237. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    238. 

  238. <div class="textblock"><p>Interface class to the console.</p>
    239. 

  239. <h1><a class="anchor" id="ConsoleObject_basics"></a>
    240. 

  240. The Basics</h1>
    241. 

  241. <p>Any object which you want to work with the console system should derive from this, and access functionality through the static interface.</p>
    242. 

  242. <p>This class is always used with the DECLARE_CONOBJECT and IMPLEMENT_* macros.</p>
    243. 

  243. <div class="fragment"><div class="line"><span class="comment">// A very basic example object. It will do nothing!</span></div>
    244. 

  244. <div class="line"><span class="keyword">class </span>TorqueObject : <span class="keyword">public</span> <a class="code hl_class" href="class_console_object.html">ConsoleObject</a> {</div>
    245. 

  245. <div class="line">     <span class="comment">// Must provide a Parent typedef so the console system knows what we inherit from.</span></div>
    246. 

  246. <div class="line">     <span class="keyword">typedef</span> <a class="code hl_class" href="class_console_object.html">ConsoleObject</a> Parent;</div>
    247. 

  247. <div class="line"> </div>
    248. 

  248. <div class="line">     <span class="comment">// This does a lot of menial declaration for you.</span></div>
    249. 

  249. <div class="line">     DECLARE_CONOBJECT(TorqueObject);</div>
    250. 

  250. <div class="line"> </div>
    251. 

  251. <div class="line">     <span class="comment">// This is for us to register our fields in.</span></div>
    252. 

  252. <div class="line">     <span class="keyword">static</span> <span class="keywordtype">void</span> initPersistFields();</div>
    253. 

  253. <div class="line"> </div>
    254. 

  254. <div class="line">     <span class="comment">// A sample field.</span></div>
    255. 

  255. <div class="line">     S8 mSample;</div>
    256. 

  256. <div class="line">}</div>
    257. 

  257. <div class="ttc" id="aclass_console_object_html"><div class="ttname"><a href="class_console_object.html">ConsoleObject</a></div><div class="ttdef"><b>Definition</b> consoleObject.h:481</div></div>
    258. 

  258. </div><!-- fragment --><div class="fragment"><div class="line"><span class="comment">// And the accordant implementation...</span></div>
    259. 

  259. <div class="line">IMPLEMENT_CONOBJECT(TorqueObject);</div>
    260. 

  260. <div class="line"> </div>
    261. 

  261. <div class="line"><span class="keywordtype">void</span> TorqueObject::initPersistFields()</div>
    262. 

  262. <div class="line">{</div>
    263. 

  263. <div class="line">  <span class="comment">// If you want to inherit any fields from the parent (you do), do this:</span></div>
    264. 

  264. <div class="line">  Parent::initPersistFields();</div>
    265. 

  265. <div class="line"> </div>
    266. 

  266. <div class="line">  <span class="comment">// Pass the field, the type, the offset,                  and a usage string.</span></div>
    267. 

  267. <div class="line">  <a class="code hl_function" href="class_console_object.html#a1e61452413a8cd497dfc1a2b62f072cd">addField</a>(<span class="stringliteral">&quot;sample&quot;</span>, TypeS8, Offset(mSample, TorqueObject), <span class="stringliteral">&quot;A test field.&quot;</span>);</div>
    268. 

  268. <div class="line">}</div>
    269. 

  269. <div class="ttc" id="aclass_console_object_html_a1e61452413a8cd497dfc1a2b62f072cd"><div class="ttname"><a href="class_console_object.html#a1e61452413a8cd497dfc1a2b62f072cd">ConsoleObject::addField</a></div><div class="ttdeci">static void addField(const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, const U32 in_elementCount=1, EnumTable *in_table=NULL, const char *in_pFieldDocs=NULL)</div><div class="ttdef"><b>Definition</b> consoleObject.cc:369</div></div>
    270. 

  270. </div><!-- fragment --><p>That's all you need to do to get a class registered with the console system. At this point, you can instantiate it via script, tie methods to it using ConsoleMethod, register fields, and so forth. You can also register any global variables related to the class by creating a <a class="el" href="class_console_object.html#a95c239afc15d197ae11798bc11e5c28b">consoleInit()</a> method.</p>
    271. 

  271. <p>You will need to use different IMPLEMENT_ macros in different cases; for instance, if you are making a <a class="el" href="class_net_object.html">NetObject</a> (for ghosting), a DataBlock, or a <a class="el" href="class_net_event.html">NetEvent</a>.</p>
    272. 

  272. <dl class="section see"><dt>See also</dt><dd><a class="el" href="class_abstract_class_rep.html">AbstractClassRep</a> for gory implementation details. </dd></dl>
    273. 

  273. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
    274. 

  274. <a id="a8b5a944ed3b7fa672a250a5d389c8f15" name="a8b5a944ed3b7fa672a250a5d389c8f15"></a>
    275. 

  275. <h2 class="memtitle"><span class="permalink"><a href="#a8b5a944ed3b7fa672a250a5d389c8f15">&#9670;&#160;</a></span>ConsoleObject() <span class="overload">[1/2]</span></h2>
    276. 

  276. 

  277. <div class="memitem">
    278. 

  278. <div class="memproto">
    279. 

  279. <table class="mlabels">
    280. 

  280.   <tr>
    281. 

  281.   <td class="mlabels-left">
    282. 

  282.       <table class="memname">
    283. 

  283.         <tr>
    284. 

  284.           <td class="memname"><a class="el" href="class_console_object.html">ConsoleObject</a> </td>
    285. 

  285.           <td>(</td>
    286. 

  286.           <td class="paramname"></td><td>)</td>
    287. 

  287.           <td></td>
    288. 

  288.         </tr>
    289. 

  289.       </table>
    290. 

  290.   </td>
    291. 

  291.   <td class="mlabels-right">
    292. 

  292. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span>  </td>
    293. 

  293.   </tr>
    294. 

  294. </table>
    295. 

  295. </div><div class="memdoc">
    296. 

  296. <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000004">Deprecated:</a></b></dt><dd>This is disallowed. </dd></dl>
    297. 

  297. 

  298. </div>
    299. 

  299. </div>
    300. 

  300. <a id="a601f42ddcee97ab4eee59e6dbc9df75b" name="a601f42ddcee97ab4eee59e6dbc9df75b"></a>
    301. 

  301. <h2 class="memtitle"><span class="permalink"><a href="#a601f42ddcee97ab4eee59e6dbc9df75b">&#9670;&#160;</a></span>ConsoleObject() <span class="overload">[2/2]</span></h2>
    302. 

  302. 

  303. <div class="memitem">
    304. 

  304. <div class="memproto">
    305. 

  305. <table class="mlabels">
    306. 

  306.   <tr>
    307. 

  307.   <td class="mlabels-left">
    308. 

  308.       <table class="memname">
    309. 

  309.         <tr>
    310. 

  310.           <td class="memname"><a class="el" href="class_console_object.html">ConsoleObject</a> </td>
    311. 

  311.           <td>(</td>
    312. 

  312.           <td class="paramtype">const <a class="el" href="class_console_object.html">ConsoleObject</a> &amp;&#160;</td>
    313. 

  313.           <td class="paramname"></td><td>)</td>
    314. 

  314.           <td></td>
    315. 

  315.         </tr>
    316. 

  316.       </table>
    317. 

  317.   </td>
    318. 

  318.   <td class="mlabels-right">
    319. 

  319. <span class="mlabels"><span class="mlabel">protected</span></span>  </td>
    320. 

  320.   </tr>
    321. 

  321. </table>
    322. 

  322. </div><div class="memdoc">
    323. 

  323. <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000005">Deprecated:</a></b></dt><dd>This is disallowed. </dd></dl>
    324. 

  324. 

  325. </div>
    326. 

  326. </div>
    327. 

  327. <a id="a648a403aff97cfb8f198fad055feea64" name="a648a403aff97cfb8f198fad055feea64"></a>
    328. 

  328. <h2 class="memtitle"><span class="permalink"><a href="#a648a403aff97cfb8f198fad055feea64">&#9670;&#160;</a></span>~ConsoleObject()</h2>
    329. 

  329. 

  330. <div class="memitem">
    331. 

  331. <div class="memproto">
    332. 

  332. <table class="mlabels">
    333. 

  333.   <tr>
    334. 

  334.   <td class="mlabels-left">
    335. 

  335.       <table class="memname">
    336. 

  336.         <tr>
    337. 

  337.           <td class="memname">~<a class="el" href="class_console_object.html">ConsoleObject</a> </td>
    338. 

  338.           <td>(</td>
    339. 

  339.           <td class="paramname"></td><td>)</td>
    340. 

  340.           <td></td>
    341. 

  341.         </tr>
    342. 

  342.       </table>
    343. 

  343.   </td>
    344. 

  344.   <td class="mlabels-right">
    345. 

  345. <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
    346. 

  346.   </tr>
    347. 

  347. </table>
    348. 

  348. </div><div class="memdoc">
    349. 

  349. 

  350. </div>
    351. 

  351. </div>
    352. 

  352. <h2 class="groupheader">Member Function Documentation</h2>
    353. 

  353. <a id="aed3d0d1abd7ba4a17e792ca80f3478a7" name="aed3d0d1abd7ba4a17e792ca80f3478a7"></a>
    354. 

  354. <h2 class="memtitle"><span class="permalink"><a href="#aed3d0d1abd7ba4a17e792ca80f3478a7">&#9670;&#160;</a></span>addDepricatedField()</h2>
    355. 

  355. 

  356. <div class="memitem">
    357. 

  357. <div class="memproto">
    358. 

  358. <table class="mlabels">
    359. 

  359.   <tr>
    360. 

  360.   <td class="mlabels-left">
    361. 

  361.       <table class="memname">
    362. 

  362.         <tr>
    363. 

  363.           <td class="memname">void addDepricatedField </td>
    364. 

  364.           <td>(</td>
    365. 

  365.           <td class="paramtype">const char *&#160;</td>
    366. 

  366.           <td class="paramname"><em>fieldName</em></td><td>)</td>
    367. 

  367.           <td></td>
    368. 

  368.         </tr>
    369. 

  369.       </table>
    370. 

  370.   </td>
    371. 

  371.   <td class="mlabels-right">
    372. 

  372. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span>  </td>
    373. 

  373.   </tr>
    374. 

  374. </table>
    375. 

  375. </div><div class="memdoc">
    376. 

  376. <p>Add a deprecated field.</p>
    377. 

  377. <p>A deprecated field will always be undefined, even if you assign a value to it. This is useful when you need to make sure that a field is not being used anymore. </p>
    378. 

  378. 

  379. </div>
    380. 

  380. </div>
    381. 

  381. <a id="a83176674ac909724b9ba2dce44a71e9a" name="a83176674ac909724b9ba2dce44a71e9a"></a>
    382. 

  382. <h2 class="memtitle"><span class="permalink"><a href="#a83176674ac909724b9ba2dce44a71e9a">&#9670;&#160;</a></span>addField() <span class="overload">[1/4]</span></h2>
    383. 

  383. 

  384. <div class="memitem">
    385. 

  385. <div class="memproto">
    386. 

  386. <table class="mlabels">
    387. 

  387.   <tr>
    388. 

  388.   <td class="mlabels-left">
    389. 

  389.       <table class="memname">
    390. 

  390.         <tr>
    391. 

  391.           <td class="memname">void addField </td>
    392. 

  392.           <td>(</td>
    393. 

  393.           <td class="paramtype">const char *&#160;</td>
    394. 

  394.           <td class="paramname"><em>in_pFieldname</em>, </td>
    395. 

  395.         </tr>
    396. 

  396.         <tr>
    397. 

  397.           <td class="paramkey"></td>
    398. 

  398.           <td></td>
    399. 

  399.           <td class="paramtype">const U32&#160;</td>
    400. 

  400.           <td class="paramname"><em>in_fieldType</em>, </td>
    401. 

  401.         </tr>
    402. 

  402.         <tr>
    403. 

  403.           <td class="paramkey"></td>
    404. 

  404.           <td></td>
    405. 

  405.           <td class="paramtype">const dsize_t&#160;</td>
    406. 

  406.           <td class="paramname"><em>in_fieldOffset</em>, </td>
    407. 

  407.         </tr>
    408. 

  408.         <tr>
    409. 

  409.           <td class="paramkey"></td>
    410. 

  410.           <td></td>
    411. 

  411.           <td class="paramtype"><a class="el" href="class_abstract_class_rep.html#ab897bbd2116b331da38ac71717dbb3b3">AbstractClassRep::WriteDataNotify</a>&#160;</td>
    412. 

  412.           <td class="paramname"><em>in_writeDataFn</em>, </td>
    413. 

  413.         </tr>
    414. 

  414.         <tr>
    415. 

  415.           <td class="paramkey"></td>
    416. 

  416.           <td></td>
    417. 

  417.           <td class="paramtype">const char *&#160;</td>
    418. 

  418.           <td class="paramname"><em>in_pFieldDocs</em>&#160;</td>
    419. 

  419.         </tr>
    420. 

  420.         <tr>
    421. 

  421.           <td></td>
    422. 

  422.           <td>)</td>
    423. 

  423.           <td></td><td></td>
    424. 

  424.         </tr>
    425. 

  425.       </table>
    426. 

  426.   </td>
    427. 

  427.   <td class="mlabels-right">
    428. 

  428. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span>  </td>
    429. 

  429.   </tr>
    430. 

  430. </table>
    431. 

  431. </div><div class="memdoc">
    432. 

  432. <p>Register a simple field with a write notify.</p>
    433. 

  433. <dl class="params"><dt>Parameters</dt><dd>
    434. 

  434.   <table class="params">
    435. 

  435.     <tr><td class="paramname">in_pFieldname</td><td>Name of the field. </td></tr>
    436. 

  436.     <tr><td class="paramname">in_fieldType</td><td>Type of the field. </td></tr>
    437. 

  437.   </table>
    438. 

  438.   </dd>
    439. 

  439. </dl>
    440. 

  440. <dl class="section see"><dt>See also</dt><dd>ConsoleDynamicTypes </dd></dl>
    441. 

  441. <dl class="params"><dt>Parameters</dt><dd>
    442. 

  442.   <table class="params">
    443. 

  443.     <tr><td class="paramname">in_fieldOffset</td><td>Offset to the field from the start of the class; calculated using the Offset() macro. </td></tr>
    444. 

  444.     <tr><td class="paramname">in_writeDataFn</td><td>This method will return whether the field should be written or not. </td></tr>
    445. 

  445.     <tr><td class="paramname">in_pFieldDocs</td><td>Usage string for this field. </td></tr>
    446. 

  446.   </table>
    447. 

  447.   </dd>
    448. 

  448. </dl>
    449. 

  449. <dl class="section see"><dt>See also</dt><dd>console_autodoc </dd></dl>
    450. 

  450. 

  451. </div>
    452. 

  452. </div>
    453. 

  453. <a id="ad4ad51d247b2e09ea51783a8fdbb4b95" name="ad4ad51d247b2e09ea51783a8fdbb4b95"></a>
    454. 

  454. <h2 class="memtitle"><span class="permalink"><a href="#ad4ad51d247b2e09ea51783a8fdbb4b95">&#9670;&#160;</a></span>addField() <span class="overload">[2/4]</span></h2>
    455. 

  455. 

  456. <div class="memitem">
    457. 

  457. <div class="memproto">
    458. 

  458. <table class="mlabels">
    459. 

  459.   <tr>
    460. 

  460.   <td class="mlabels-left">
    461. 

  461.       <table class="memname">
    462. 

  462.         <tr>
    463. 

  463.           <td class="memname">void addField </td>
    464. 

  464.           <td>(</td>
    465. 

  465.           <td class="paramtype">const char *&#160;</td>
    466. 

  466.           <td class="paramname"><em>in_pFieldname</em>, </td>
    467. 

  467.         </tr>
    468. 

  468.         <tr>
    469. 

  469.           <td class="paramkey"></td>
    470. 

  470.           <td></td>
    471. 

  471.           <td class="paramtype">const U32&#160;</td>
    472. 

  472.           <td class="paramname"><em>in_fieldType</em>, </td>
    473. 

  473.         </tr>
    474. 

  474.         <tr>
    475. 

  475.           <td class="paramkey"></td>
    476. 

  476.           <td></td>
    477. 

  477.           <td class="paramtype">const dsize_t&#160;</td>
    478. 

  478.           <td class="paramname"><em>in_fieldOffset</em>, </td>
    479. 

  479.         </tr>
    480. 

  480.         <tr>
    481. 

  481.           <td class="paramkey"></td>
    482. 

  482.           <td></td>
    483. 

  483.           <td class="paramtype"><a class="el" href="class_abstract_class_rep.html#ab897bbd2116b331da38ac71717dbb3b3">AbstractClassRep::WriteDataNotify</a>&#160;</td>
    484. 

  484.           <td class="paramname"><em>in_writeDataFn</em>, </td>
    485. 

  485.         </tr>
    486. 

  486.         <tr>
    487. 

  487.           <td class="paramkey"></td>
    488. 

  488.           <td></td>
    489. 

  489.           <td class="paramtype">const U32&#160;</td>
    490. 

  490.           <td class="paramname"><em>in_elementCount</em> = <code>1</code>, </td>
    491. 

  491.         </tr>
    492. 

  492.         <tr>
    493. 

  493.           <td class="paramkey"></td>
    494. 

  494.           <td></td>
    495. 

  495.           <td class="paramtype"><a class="el" href="struct_enum_table.html">EnumTable</a> *&#160;</td>
    496. 

  496.           <td class="paramname"><em>in_table</em> = <code>NULL</code>, </td>
    497. 

  497.         </tr>
    498. 

  498.         <tr>
    499. 

  499.           <td class="paramkey"></td>
    500. 

  500.           <td></td>
    501. 

  501.           <td class="paramtype">const char *&#160;</td>
    502. 

  502.           <td class="paramname"><em>in_pFieldDocs</em> = <code>NULL</code>&#160;</td>
    503. 

  503.         </tr>
    504. 

  504.         <tr>
    505. 

  505.           <td></td>
    506. 

  506.           <td>)</td>
    507. 

  507.           <td></td><td></td>
    508. 

  508.         </tr>
    509. 

  509.       </table>
    510. 

  510.   </td>
    511. 

  511.   <td class="mlabels-right">
    512. 

  512. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span>  </td>
    513. 

  513.   </tr>
    514. 

  514. </table>
    515. 

  515. </div><div class="memdoc">
    516. 

  516. <p>Register a complex field with a write notify.</p>
    517. 

  517. <dl class="params"><dt>Parameters</dt><dd>
    518. 

  518.   <table class="params">
    519. 

  519.     <tr><td class="paramname">in_pFieldname</td><td>Name of the field. </td></tr>
    520. 

  520.     <tr><td class="paramname">in_fieldType</td><td>Type of the field. </td></tr>
    521. 

  521.   </table>
    522. 

  522.   </dd>
    523. 

  523. </dl>
    524. 

  524. <dl class="section see"><dt>See also</dt><dd>ConsoleDynamicTypes </dd></dl>
    525. 

  525. <dl class="params"><dt>Parameters</dt><dd>
    526. 

  526.   <table class="params">
    527. 

  527.     <tr><td class="paramname">in_fieldOffset</td><td>Offset to the field from the start of the class; calculated using the Offset() macro. </td></tr>
    528. 

  528.     <tr><td class="paramname">in_writeDataFn</td><td>This method will return whether the field should be written or not. </td></tr>
    529. 

  529.     <tr><td class="paramname">in_elementCount</td><td>Number of elements in this field. Arrays of elements are assumed to be contiguous in memory. </td></tr>
    530. 

  530.     <tr><td class="paramname">in_table</td><td>An <a class="el" href="struct_enum_table.html">EnumTable</a>, if this is an enumerated field. </td></tr>
    531. 

  531.     <tr><td class="paramname">in_pFieldDocs</td><td>Usage string for this field. </td></tr>
    532. 

  532.   </table>
    533. 

  533.   </dd>
    534. 

  534. </dl>
    535. 

  535. <dl class="section see"><dt>See also</dt><dd>console_autodoc </dd></dl>
    536. 

  536. 

  537. </div>
    538. 

  538. </div>
    539. 

  539. <a id="a7fe0d513b2bea8f6a1710c35189f550c" name="a7fe0d513b2bea8f6a1710c35189f550c"></a>
    540. 

  540. <h2 class="memtitle"><span class="permalink"><a href="#a7fe0d513b2bea8f6a1710c35189f550c">&#9670;&#160;</a></span>addField() <span class="overload">[3/4]</span></h2>
    541. 

  541. 

  542. <div class="memitem">
    543. 

  543. <div class="memproto">
    544. 

  544. <table class="mlabels">
    545. 

  545.   <tr>
    546. 

  546.   <td class="mlabels-left">
    547. 

  547.       <table class="memname">
    548. 

  548.         <tr>
    549. 

  549.           <td class="memname">void addField </td>
    550. 

  550.           <td>(</td>
    551. 

  551.           <td class="paramtype">const char *&#160;</td>
    552. 

  552.           <td class="paramname"><em>in_pFieldname</em>, </td>
    553. 

  553.         </tr>
    554. 

  554.         <tr>
    555. 

  555.           <td class="paramkey"></td>
    556. 

  556.           <td></td>
    557. 

  557.           <td class="paramtype">const U32&#160;</td>
    558. 

  558.           <td class="paramname"><em>in_fieldType</em>, </td>
    559. 

  559.         </tr>
    560. 

  560.         <tr>
    561. 

  561.           <td class="paramkey"></td>
    562. 

  562.           <td></td>
    563. 

  563.           <td class="paramtype">const dsize_t&#160;</td>
    564. 

  564.           <td class="paramname"><em>in_fieldOffset</em>, </td>
    565. 

  565.         </tr>
    566. 

  566.         <tr>
    567. 

  567.           <td class="paramkey"></td>
    568. 

  568.           <td></td>
    569. 

  569.           <td class="paramtype">const char *&#160;</td>
    570. 

  570.           <td class="paramname"><em>in_pFieldDocs</em>&#160;</td>
    571. 

  571.         </tr>
    572. 

  572.         <tr>
    573. 

  573.           <td></td>
    574. 

  574.           <td>)</td>
    575. 

  575.           <td></td><td></td>
    576. 

  576.         </tr>
    577. 

  577.       </table>
    578. 

  578.   </td>
    579. 

  579.   <td class="mlabels-right">
    580. 

  580. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span>  </td>
    581. 

  581.   </tr>
    582. 

  582. </table>
    583. 

  583. </div><div class="memdoc">
    584. 

  584. <p>Register a simple field.</p>
    585. 

  585. <dl class="params"><dt>Parameters</dt><dd>
    586. 

  586.   <table class="params">
    587. 

  587.     <tr><td class="paramname">in_pFieldname</td><td>Name of the field. </td></tr>
    588. 

  588.     <tr><td class="paramname">in_fieldType</td><td>Type of the field. </td></tr>
    589. 

  589.   </table>
    590. 

  590.   </dd>
    591. 

  591. </dl>
    592. 

  592. <dl class="section see"><dt>See also</dt><dd>ConsoleDynamicTypes </dd></dl>
    593. 

  593. <dl class="params"><dt>Parameters</dt><dd>
    594. 

  594.   <table class="params">
    595. 

  595.     <tr><td class="paramname">in_fieldOffset</td><td>Offset to the field from the start of the class; calculated using the Offset() macro. </td></tr>
    596. 

  596.     <tr><td class="paramname">in_pFieldDocs</td><td>Usage string for this field. </td></tr>
    597. 

  597.   </table>
    598. 

  598.   </dd>
    599. 

  599. </dl>
    600. 

  600. <dl class="section see"><dt>See also</dt><dd>console_autodoc </dd></dl>
    601. 

  601. 

  602. </div>
    603. 

  603. </div>
    604. 

  604. <a id="a1e61452413a8cd497dfc1a2b62f072cd" name="a1e61452413a8cd497dfc1a2b62f072cd"></a>
    605. 

  605. <h2 class="memtitle"><span class="permalink"><a href="#a1e61452413a8cd497dfc1a2b62f072cd">&#9670;&#160;</a></span>addField() <span class="overload">[4/4]</span></h2>
    606. 

  606. 

  607. <div class="memitem">
    608. 

  608. <div class="memproto">
    609. 

  609. <table class="mlabels">
    610. 

  610.   <tr>
    611. 

  611.   <td class="mlabels-left">
    612. 

  612.       <table class="memname">
    613. 

  613.         <tr>
    614. 

  614.           <td class="memname">void addField </td>
    615. 

  615.           <td>(</td>
    616. 

  616.           <td class="paramtype">const char *&#160;</td>
    617. 

  617.           <td class="paramname"><em>in_pFieldname</em>, </td>
    618. 

  618.         </tr>
    619. 

  619.         <tr>
    620. 

  620.           <td class="paramkey"></td>
    621. 

  621.           <td></td>
    622. 

  622.           <td class="paramtype">const U32&#160;</td>
    623. 

  623.           <td class="paramname"><em>in_fieldType</em>, </td>
    624. 

  624.         </tr>
    625. 

  625.         <tr>
    626. 

  626.           <td class="paramkey"></td>
    627. 

  627.           <td></td>
    628. 

  628.           <td class="paramtype">const dsize_t&#160;</td>
    629. 

  629.           <td class="paramname"><em>in_fieldOffset</em>, </td>
    630. 

  630.         </tr>
    631. 

  631.         <tr>
    632. 

  632.           <td class="paramkey"></td>
    633. 

  633.           <td></td>
    634. 

  634.           <td class="paramtype">const U32&#160;</td>
    635. 

  635.           <td class="paramname"><em>in_elementCount</em> = <code>1</code>, </td>
    636. 

  636.         </tr>
    637. 

  637.         <tr>
    638. 

  638.           <td class="paramkey"></td>
    639. 

  639.           <td></td>
    640. 

  640.           <td class="paramtype"><a class="el" href="struct_enum_table.html">EnumTable</a> *&#160;</td>
    641. 

  641.           <td class="paramname"><em>in_table</em> = <code>NULL</code>, </td>
    642. 

  642.         </tr>
    643. 

  643.         <tr>
    644. 

  644.           <td class="paramkey"></td>
    645. 

  645.           <td></td>
    646. 

  646.           <td class="paramtype">const char *&#160;</td>
    647. 

  647.           <td class="paramname"><em>in_pFieldDocs</em> = <code>NULL</code>&#160;</td>
    648. 

  648.         </tr>
    649. 

  649.         <tr>
    650. 

  650.           <td></td>
    651. 

  651.           <td>)</td>
    652. 

  652.           <td></td><td></td>
    653. 

  653.         </tr>
    654. 

  654.       </table>
    655. 

  655.   </td>
    656. 

  656.   <td class="mlabels-right">
    657. 

  657. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span>  </td>
    658. 

  658.   </tr>
    659. 

  659. </table>
    660. 

  660. </div><div class="memdoc">
    661. 

  661. <p>Register a complex field.</p>
    662. 

  662. <dl class="params"><dt>Parameters</dt><dd>
    663. 

  663.   <table class="params">
    664. 

  664.     <tr><td class="paramname">in_pFieldname</td><td>Name of the field. </td></tr>
    665. 

  665.     <tr><td class="paramname">in_fieldType</td><td>Type of the field. </td></tr>
    666. 

  666.   </table>
    667. 

  667.   </dd>
    668. 

  668. </dl>
    669. 

  669. <dl class="section see"><dt>See also</dt><dd>ConsoleDynamicTypes </dd></dl>
    670. 

  670. <dl class="params"><dt>Parameters</dt><dd>
    671. 

  671.   <table class="params">
    672. 

  672.     <tr><td class="paramname">in_fieldOffset</td><td>Offset to the field from the start of the class; calculated using the Offset() macro. </td></tr>
    673. 

  673.     <tr><td class="paramname">in_elementCount</td><td>Number of elements in this field. Arrays of elements are assumed to be contiguous in memory. </td></tr>
    674. 

  674.     <tr><td class="paramname">in_table</td><td>An <a class="el" href="struct_enum_table.html">EnumTable</a>, if this is an enumerated field. </td></tr>
    675. 

  675.     <tr><td class="paramname">in_pFieldDocs</td><td>Usage string for this field. </td></tr>
    676. 

  676.   </table>
    677. 

  677.   </dd>
    678. 

  678. </dl>
    679. 

  679. <dl class="section see"><dt>See also</dt><dd>console_autodoc </dd></dl>
    680. 

  680. 

  681. </div>
    682. 

  682. </div>
    683. 

  683. <a id="a3356a3140575cbc1e4466883937daf0b" name="a3356a3140575cbc1e4466883937daf0b"></a>
    684. 

  684. <h2 class="memtitle"><span class="permalink"><a href="#a3356a3140575cbc1e4466883937daf0b">&#9670;&#160;</a></span>addFieldV()</h2>
    685. 

  685. 

  686. <div class="memitem">
    687. 

  687. <div class="memproto">
    688. 

  688. <table class="mlabels">
    689. 

  689.   <tr>
    690. 

  690.   <td class="mlabels-left">
    691. 

  691.       <table class="memname">
    692. 

  692.         <tr>
    693. 

  693.           <td class="memname">void addFieldV </td>
    694. 

  694.           <td>(</td>
    695. 

  695.           <td class="paramtype">const char *&#160;</td>
    696. 

  696.           <td class="paramname"><em>in_pFieldname</em>, </td>
    697. 

  697.         </tr>
    698. 

  698.         <tr>
    699. 

  699.           <td class="paramkey"></td>
    700. 

  700.           <td></td>
    701. 

  701.           <td class="paramtype">const U32&#160;</td>
    702. 

  702.           <td class="paramname"><em>in_fieldType</em>, </td>
    703. 

  703.         </tr>
    704. 

  704.         <tr>
    705. 

  705.           <td class="paramkey"></td>
    706. 

  706.           <td></td>
    707. 

  707.           <td class="paramtype">const dsize_t&#160;</td>
    708. 

  708.           <td class="paramname"><em>in_fieldOffset</em>, </td>
    709. 

  709.         </tr>
    710. 

  710.         <tr>
    711. 

  711.           <td class="paramkey"></td>
    712. 

  712.           <td></td>
    713. 

  713.           <td class="paramtype"><a class="el" href="class_console_type_validator.html">ConsoleTypeValidator</a> *&#160;</td>
    714. 

  714.           <td class="paramname"><em>v</em>, </td>
    715. 

  715.         </tr>
    716. 

  716.         <tr>
    717. 

  717.           <td class="paramkey"></td>
    718. 

  718.           <td></td>
    719. 

  719.           <td class="paramtype">const char *&#160;</td>
    720. 

  720.           <td class="paramname"><em>in_pFieldDocs</em> = <code>NULL</code>&#160;</td>
    721. 

  721.         </tr>
    722. 

  722.         <tr>
    723. 

  723.           <td></td>
    724. 

  724.           <td>)</td>
    725. 

  725.           <td></td><td></td>
    726. 

  726.         </tr>
    727. 

  727.       </table>
    728. 

  728.   </td>
    729. 

  729.   <td class="mlabels-right">
    730. 

  730. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span>  </td>
    731. 

  731.   </tr>
    732. 

  732. </table>
    733. 

  733. </div><div class="memdoc">
    734. 

  734. <p>Register a validated field.</p>
    735. 

  735. <p>A validated field is just like a normal field except that you can't have it be an array, and that you give it a pointer to a <a class="el" href="class_console_type_validator.html">ConsoleTypeValidator</a> subclass, which is then used to validate any value placed in it. Invalid values are ignored and an error is printed to the console.</p>
    736. 

  736. <dl class="section see"><dt>See also</dt><dd><a class="el" href="class_console_object.html#a1e61452413a8cd497dfc1a2b62f072cd">addField</a> </dd>
    737. 

  737. <dd>
    738. 

  738. typeValidators.h </dd></dl>
    739. 

  739. 

  740. </div>
    741. 

  741. </div>
    742. 

  742. <a id="a38f3095c01e8b2055e4c2e58d9a133e8" name="a38f3095c01e8b2055e4c2e58d9a133e8"></a>
    743. 

  743. <h2 class="memtitle"><span class="permalink"><a href="#a38f3095c01e8b2055e4c2e58d9a133e8">&#9670;&#160;</a></span>addGroup()</h2>
    744. 

  744. 

  745. <div class="memitem">
    746. 

  746. <div class="memproto">
    747. 

  747. <table class="mlabels">
    748. 

  748.   <tr>
    749. 

  749.   <td class="mlabels-left">
    750. 

  750.       <table class="memname">
    751. 

  751.         <tr>
    752. 

  752.           <td class="memname">void addGroup </td>
    753. 

  753.           <td>(</td>
    754. 

  754.           <td class="paramtype">const char *&#160;</td>
    755. 

  755.           <td class="paramname"><em>in_pGroupname</em>, </td>
    756. 

  756.         </tr>
    757. 

  757.         <tr>
    758. 

  758.           <td class="paramkey"></td>
    759. 

  759.           <td></td>
    760. 

  760.           <td class="paramtype">const char *&#160;</td>
    761. 

  761.           <td class="paramname"><em>in_pGroupDocs</em> = <code>NULL</code>&#160;</td>
    762. 

  762.         </tr>
    763. 

  763.         <tr>
    764. 

  764.           <td></td>
    765. 

  765.           <td>)</td>
    766. 

  766.           <td></td><td></td>
    767. 

  767.         </tr>
    768. 

  768.       </table>
    769. 

  769.   </td>
    770. 

  770.   <td class="mlabels-right">
    771. 

  771. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span>  </td>
    772. 

  772.   </tr>
    773. 

  773. </table>
    774. 

  774. </div><div class="memdoc">
    775. 

  775. <p>Mark the beginning of a group of fields.</p>
    776. 

  776. <p>This is used in the consoleDoc system. </p><dl class="section see"><dt>See also</dt><dd>console_autodoc </dd></dl>
    777. 

  777. 

  778. </div>
    779. 

  779. </div>
    780. 

  780. <a id="aed96a36e73e2eee15cf6a3ae1412d9bd" name="aed96a36e73e2eee15cf6a3ae1412d9bd"></a>
    781. 

  781. <h2 class="memtitle"><span class="permalink"><a href="#aed96a36e73e2eee15cf6a3ae1412d9bd">&#9670;&#160;</a></span>addProtectedField() <span class="overload">[1/4]</span></h2>
    782. 

  782. 

  783. <div class="memitem">
    784. 

  784. <div class="memproto">
    785. 

  785. <table class="mlabels">
    786. 

  786.   <tr>
    787. 

  787.   <td class="mlabels-left">
    788. 

  788.       <table class="memname">
    789. 

  789.         <tr>
    790. 

  790.           <td class="memname">void addProtectedField </td>
    791. 

  791.           <td>(</td>
    792. 

  792.           <td class="paramtype">const char *&#160;</td>
    793. 

  793.           <td class="paramname"><em>in_pFieldname</em>, </td>
    794. 

  794.         </tr>
    795. 

  795.         <tr>
    796. 

  796.           <td class="paramkey"></td>
    797. 

  797.           <td></td>
    798. 

  798.           <td class="paramtype">const U32&#160;</td>
    799. 

  799.           <td class="paramname"><em>in_fieldType</em>, </td>
    800. 

  800.         </tr>
    801. 

  801.         <tr>
    802. 

  802.           <td class="paramkey"></td>
    803. 

  803.           <td></td>
    804. 

  804.           <td class="paramtype">const dsize_t&#160;</td>
    805. 

  805.           <td class="paramname"><em>in_fieldOffset</em>, </td>
    806. 

  806.         </tr>
    807. 

  807.         <tr>
    808. 

  808.           <td class="paramkey"></td>
    809. 

  809.           <td></td>
    810. 

  810.           <td class="paramtype"><a class="el" href="class_abstract_class_rep.html#a23fe751b9b844d180a5e8ee921968aa5">AbstractClassRep::SetDataNotify</a>&#160;</td>
    811. 

  811.           <td class="paramname"><em>in_setDataFn</em>, </td>
    812. 

  812.         </tr>
    813. 

  813.         <tr>
    814. 

  814.           <td class="paramkey"></td>
    815. 

  815.           <td></td>
    816. 

  816.           <td class="paramtype"><a class="el" href="class_abstract_class_rep.html#a11f286fc60ce139f916571059ec35e22">AbstractClassRep::GetDataNotify</a>&#160;</td>
    817. 

  817.           <td class="paramname"><em>in_getDataFn</em> = <code>&amp;defaultProtectedGetFn</code>, </td>
    818. 

  818.         </tr>
    819. 

  819.         <tr>
    820. 

  820.           <td class="paramkey"></td>
    821. 

  821.           <td></td>
    822. 

  822.           <td class="paramtype"><a class="el" href="class_abstract_class_rep.html#ab897bbd2116b331da38ac71717dbb3b3">AbstractClassRep::WriteDataNotify</a>&#160;</td>
    823. 

  823.           <td class="paramname"><em>in_writeDataFn</em> = <code>&amp;defaultProtectedWriteFn</code>, </td>
    824. 

  824.         </tr>
    825. 

  825.         <tr>
    826. 

  826.           <td class="paramkey"></td>
    827. 

  827.           <td></td>
    828. 

  828.           <td class="paramtype">const char *&#160;</td>
    829. 

  829.           <td class="paramname"><em>in_pFieldDocs</em> = <code>NULL</code>&#160;</td>
    830. 

  830.         </tr>
    831. 

  831.         <tr>
    832. 

  832.           <td></td>
    833. 

  833.           <td>)</td>
    834. 

  834.           <td></td><td></td>
    835. 

  835.         </tr>
    836. 

  836.       </table>
    837. 

  837.   </td>
    838. 

  838.   <td class="mlabels-right">
    839. 

  839. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span>  </td>
    840. 

  840.   </tr>
    841. 

  841. </table>
    842. 

  842. </div><div class="memdoc">
    843. 

  843. <p>Register a simple protected field.</p>
    844. 

  844. <dl class="params"><dt>Parameters</dt><dd>
    845. 

  845.   <table class="params">
    846. 

  846.     <tr><td class="paramname">in_pFieldname</td><td>Name of the field. </td></tr>
    847. 

  847.     <tr><td class="paramname">in_fieldType</td><td>Type of the field. </td></tr>
    848. 

  848.   </table>
    849. 

  849.   </dd>
    850. 

  850. </dl>
    851. 

  851. <dl class="section see"><dt>See also</dt><dd>ConsoleDynamicTypes </dd></dl>
    852. 

  852. <dl class="params"><dt>Parameters</dt><dd>
    853. 

  853.   <table class="params">
    854. 

  854.     <tr><td class="paramname">in_fieldOffset</td><td>Offset to the field from the start of the class; calculated using the Offset() macro. </td></tr>
    855. 

  855.     <tr><td class="paramname">in_setDataFn</td><td>When this field gets set, it will call the callback provided. </td></tr>
    856. 

  856.   </table>
    857. 

  857.   </dd>
    858. 

  858. </dl>
    859. 

  859. <dl class="section see"><dt>See also</dt><dd>console_protected </dd></dl>
    860. 

  860. <dl class="params"><dt>Parameters</dt><dd>
    861. 

  861.   <table class="params">
    862. 

  862.     <tr><td class="paramname">in_getDataFn</td><td>When this field is accessed for it's data, it will return the value of this function </td></tr>
    863. 

  863.     <tr><td class="paramname">in_writeDataFn</td><td>This method will return whether the field should be written or not. </td></tr>
    864. 

  864.     <tr><td class="paramname">in_pFieldDocs</td><td>Usage string for this field. </td></tr>
    865. 

  865.   </table>
    866. 

  866.   </dd>
    867. 

  867. </dl>
    868. 

  868. <dl class="section see"><dt>See also</dt><dd>console_autodoc </dd></dl>
    869. 

  869. 

  870. </div>
    871. 

  871. </div>
    872. 

  872. <a id="a5161f628159e510b744cef47fd6598a3" name="a5161f628159e510b744cef47fd6598a3"></a>
    873. 

  873. <h2 class="memtitle"><span class="permalink"><a href="#a5161f628159e510b744cef47fd6598a3">&#9670;&#160;</a></span>addProtectedField() <span class="overload">[2/4]</span></h2>
    874. 

  874. 

  875. <div class="memitem">
    876. 

  876. <div class="memproto">
    877. 

  877. <table class="mlabels">
    878. 

  878.   <tr>
    879. 

  879.   <td class="mlabels-left">
    880. 

  880.       <table class="memname">
    881. 

  881.         <tr>
    882. 

  882.           <td class="memname">void addProtectedField </td>
    883. 

  883.           <td>(</td>
    884. 

  884.           <td class="paramtype">const char *&#160;</td>
    885. 

  885.           <td class="paramname"><em>in_pFieldname</em>, </td>
    886. 

  886.         </tr>
    887. 

  887.         <tr>
    888. 

  888.           <td class="paramkey"></td>
    889. 

  889.           <td></td>
    890. 

  890.           <td class="paramtype">const U32&#160;</td>
    891. 

  891.           <td class="paramname"><em>in_fieldType</em>, </td>
    892. 

  892.         </tr>
    893. 

  893.         <tr>
    894. 

  894.           <td class="paramkey"></td>
    895. 

  895.           <td></td>
    896. 

  896.           <td class="paramtype">const dsize_t&#160;</td>
    897. 

  897.           <td class="paramname"><em>in_fieldOffset</em>, </td>
    898. 

  898.         </tr>
    899. 

  899.         <tr>
    900. 

  900.           <td class="paramkey"></td>
    901. 

  901.           <td></td>
    902. 

  902.           <td class="paramtype"><a class="el" href="class_abstract_class_rep.html#a23fe751b9b844d180a5e8ee921968aa5">AbstractClassRep::SetDataNotify</a>&#160;</td>
    903. 

  903.           <td class="paramname"><em>in_setDataFn</em>, </td>
    904. 

  904.         </tr>
    905. 

  905.         <tr>
    906. 

  906.           <td class="paramkey"></td>
    907. 

  907.           <td></td>
    908. 

  908.           <td class="paramtype"><a class="el" href="class_abstract_class_rep.html#a11f286fc60ce139f916571059ec35e22">AbstractClassRep::GetDataNotify</a>&#160;</td>
    909. 

  909.           <td class="paramname"><em>in_getDataFn</em> = <code>&amp;defaultProtectedGetFn</code>, </td>
    910. 

  910.         </tr>
    911. 

  911.         <tr>
    912. 

  912.           <td class="paramkey"></td>
    913. 

  913.           <td></td>
    914. 

  914.           <td class="paramtype"><a class="el" href="class_abstract_class_rep.html#ab897bbd2116b331da38ac71717dbb3b3">AbstractClassRep::WriteDataNotify</a>&#160;</td>
    915. 

  915.           <td class="paramname"><em>in_writeDataFn</em> = <code>&amp;defaultProtectedWriteFn</code>, </td>
    916. 

  916.         </tr>
    917. 

  917.         <tr>
    918. 

  918.           <td class="paramkey"></td>
    919. 

  919.           <td></td>
    920. 

  920.           <td class="paramtype">const U32&#160;</td>
    921. 

  921.           <td class="paramname"><em>in_elementCount</em> = <code>1</code>, </td>
    922. 

  922.         </tr>
    923. 

  923.         <tr>
    924. 

  924.           <td class="paramkey"></td>
    925. 

  925.           <td></td>
    926. 

  926.           <td class="paramtype"><a class="el" href="struct_enum_table.html">EnumTable</a> *&#160;</td>
    927. 

  927.           <td class="paramname"><em>in_table</em> = <code>NULL</code>, </td>
    928. 

  928.         </tr>
    929. 

  929.         <tr>
    930. 

  930.           <td class="paramkey"></td>
    931. 

  931.           <td></td>
    932. 

  932.           <td class="paramtype">const char *&#160;</td>
    933. 

  933.           <td class="paramname"><em>in_pFieldDocs</em> = <code>NULL</code>&#160;</td>
    934. 

  934.         </tr>
    935. 

  935.         <tr>
    936. 

  936.           <td></td>
    937. 

  937.           <td>)</td>
    938. 

  938.           <td></td><td></td>
    939. 

  939.         </tr>
    940. 

  940.       </table>
    941. 

  941.   </td>
    942. 

  942.   <td class="mlabels-right">
    943. 

  943. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span>  </td>
    944. 

  944.   </tr>
    945. 

  945. </table>
    946. 

  946. </div><div class="memdoc">
    947. 

  947. <p>Register a complex protected field.</p>
    948. 

  948. <dl class="params"><dt>Parameters</dt><dd>
    949. 

  949.   <table class="params">
    950. 

  950.     <tr><td class="paramname">in_pFieldname</td><td>Name of the field. </td></tr>
    951. 

  951.     <tr><td class="paramname">in_fieldType</td><td>Type of the field. </td></tr>
    952. 

  952.   </table>
    953. 

  953.   </dd>
    954. 

  954. </dl>
    955. 

  955. <dl class="section see"><dt>See also</dt><dd>ConsoleDynamicTypes </dd></dl>
    956. 

  956. <dl class="params"><dt>Parameters</dt><dd>
    957. 

  957.   <table class="params">
    958. 

  958.     <tr><td class="paramname">in_fieldOffset</td><td>Offset to the field from the start of the class; calculated using the Offset() macro. </td></tr>
    959. 

  959.     <tr><td class="paramname">in_setDataFn</td><td>When this field gets set, it will call the callback provided. </td></tr>
    960. 

  960.   </table>
    961. 

  961.   </dd>
    962. 

  962. </dl>
    963. 

  963. <dl class="section see"><dt>See also</dt><dd>console_protected </dd></dl>
    964. 

  964. <dl class="params"><dt>Parameters</dt><dd>
    965. 

  965.   <table class="params">
    966. 

  966.     <tr><td class="paramname">in_getDataFn</td><td>When this field is accessed for it's data, it will return the value of this function </td></tr>
    967. 

  967.     <tr><td class="paramname">in_writeDataFn</td><td>This method will return whether the field should be written or not. </td></tr>
    968. 

  968.     <tr><td class="paramname">in_elementCount</td><td>Number of elements in this field. Arrays of elements are assumed to be contiguous in memory. </td></tr>
    969. 

  969.     <tr><td class="paramname">in_table</td><td>An <a class="el" href="struct_enum_table.html">EnumTable</a>, if this is an enumerated field. </td></tr>
    970. 

  970.     <tr><td class="paramname">in_pFieldDocs</td><td>Usage string for this field. </td></tr>
    971. 

  971.   </table>
    972. 

  972.   </dd>
    973. 

  973. </dl>
    974. 

  974. <dl class="section see"><dt>See also</dt><dd>console_autodoc </dd></dl>
    975. 

  975. 

  976. </div>
    977. 

  977. </div>
    978. 

  978. <a id="a2df2d873096113f009661c676c4d0c81" name="a2df2d873096113f009661c676c4d0c81"></a>
    979. 

  979. <h2 class="memtitle"><span class="permalink"><a href="#a2df2d873096113f009661c676c4d0c81">&#9670;&#160;</a></span>addProtectedField() <span class="overload">[3/4]</span></h2>
    980. 

  980. 

  981. <div class="memitem">
    982. 

  982. <div class="memproto">
    983. 

  983. <table class="mlabels">
    984. 

  984.   <tr>
    985. 

  985.   <td class="mlabels-left">
    986. 

  986.       <table class="memname">
    987. 

  987.         <tr>
    988. 

  988.           <td class="memname">void addProtectedField </td>
    989. 

  989.           <td>(</td>
    990. 

  990.           <td class="paramtype">const char *&#160;</td>
    991. 

  991.           <td class="paramname"><em>in_pFieldname</em>, </td>
    992. 

  992.         </tr>
    993. 

  993.         <tr>
    994. 

  994.           <td class="paramkey"></td>
    995. 

  995.           <td></td>
    996. 

  996.           <td class="paramtype">const U32&#160;</td>
    997. 

  997.           <td class="paramname"><em>in_fieldType</em>, </td>
    998. 

  998.         </tr>
    999. 

  999.         <tr>
    1000. 

  1000.           <td class="paramkey"></td>
    1001. 

  1001.           <td></td>
    1002. 

  1002.           <td class="paramtype">const dsize_t&#160;</td>
    1003. 

  1003.           <td class="paramname"><em>in_fieldOffset</em>, </td>
    1004. 

  1004.         </tr>
    1005. 

  1005.         <tr>
    1006. 

  1006.           <td class="paramkey"></td>
    1007. 

  1007.           <td></td>
    1008. 

  1008.           <td class="paramtype"><a class="el" href="class_abstract_class_rep.html#a23fe751b9b844d180a5e8ee921968aa5">AbstractClassRep::SetDataNotify</a>&#160;</td>
    1009. 

  1009.           <td class="paramname"><em>in_setDataFn</em>, </td>
    1010. 

  1010.         </tr>
    1011. 

  1011.         <tr>
    1012. 

  1012.           <td class="paramkey"></td>
    1013. 

  1013.           <td></td>
    1014. 

  1014.           <td class="paramtype"><a class="el" href="class_abstract_class_rep.html#a11f286fc60ce139f916571059ec35e22">AbstractClassRep::GetDataNotify</a>&#160;</td>
    1015. 

  1015.           <td class="paramname"><em>in_getDataFn</em> = <code>&amp;defaultProtectedGetFn</code>, </td>
    1016. 

  1016.         </tr>
    1017. 

  1017.         <tr>
    1018. 

  1018.           <td class="paramkey"></td>
    1019. 

  1019.           <td></td>
    1020. 

  1020.           <td class="paramtype">const char *&#160;</td>
    1021. 

  1021.           <td class="paramname"><em>in_pFieldDocs</em> = <code>NULL</code>&#160;</td>
    1022. 

  1022.         </tr>
    1023. 

  1023.         <tr>
    1024. 

  1024.           <td></td>
    1025. 

  1025.           <td>)</td>
    1026. 

  1026.           <td></td><td></td>
    1027. 

  1027.         </tr>
    1028. 

  1028.       </table>
    1029. 

  1029.   </td>
    1030. 

  1030.   <td class="mlabels-right">
    1031. 

  1031. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span>  </td>
    1032. 

  1032.   </tr>
    1033. 

  1033. </table>
    1034. 

  1034. </div><div class="memdoc">
    1035. 

  1035. <p>Register a simple protected field.</p>
    1036. 

  1036. <dl class="params"><dt>Parameters</dt><dd>
    1037. 

  1037.   <table class="params">
    1038. 

  1038.     <tr><td class="paramname">in_pFieldname</td><td>Name of the field. </td></tr>
    1039. 

  1039.     <tr><td class="paramname">in_fieldType</td><td>Type of the field. </td></tr>
    1040. 

  1040.   </table>
    1041. 

  1041.   </dd>
    1042. 

  1042. </dl>
    1043. 

  1043. <dl class="section see"><dt>See also</dt><dd>ConsoleDynamicTypes </dd></dl>
    1044. 

  1044. <dl class="params"><dt>Parameters</dt><dd>
    1045. 

  1045.   <table class="params">
    1046. 

  1046.     <tr><td class="paramname">in_fieldOffset</td><td>Offset to the field from the start of the class; calculated using the Offset() macro. </td></tr>
    1047. 

  1047.     <tr><td class="paramname">in_setDataFn</td><td>When this field gets set, it will call the callback provided. </td></tr>
    1048. 

  1048.   </table>
    1049. 

  1049.   </dd>
    1050. 

  1050. </dl>
    1051. 

  1051. <dl class="section see"><dt>See also</dt><dd>console_protected </dd></dl>
    1052. 

  1052. <dl class="params"><dt>Parameters</dt><dd>
    1053. 

  1053.   <table class="params">
    1054. 

  1054.     <tr><td class="paramname">in_getDataFn</td><td>When this field is accessed for it's data, it will return the value of this function </td></tr>
    1055. 

  1055.     <tr><td class="paramname">in_pFieldDocs</td><td>Usage string for this field. </td></tr>
    1056. 

  1056.   </table>
    1057. 

  1057.   </dd>
    1058. 

  1058. </dl>
    1059. 

  1059. <dl class="section see"><dt>See also</dt><dd>console_autodoc </dd></dl>
    1060. 

  1060. 

  1061. </div>
    1062. 

  1062. </div>
    1063. 

  1063. <a id="ae5af434e7146816044ce3be70f61ebb8" name="ae5af434e7146816044ce3be70f61ebb8"></a>
    1064. 

  1064. <h2 class="memtitle"><span class="permalink"><a href="#ae5af434e7146816044ce3be70f61ebb8">&#9670;&#160;</a></span>addProtectedField() <span class="overload">[4/4]</span></h2>
    1065. 

  1065. 

  1066. <div class="memitem">
    1067. 

  1067. <div class="memproto">
    1068. 

  1068. <table class="mlabels">
    1069. 

  1069.   <tr>
    1070. 

  1070.   <td class="mlabels-left">
    1071. 

  1071.       <table class="memname">
    1072. 

  1072.         <tr>
    1073. 

  1073.           <td class="memname">void addProtectedField </td>
    1074. 

  1074.           <td>(</td>
    1075. 

  1075.           <td class="paramtype">const char *&#160;</td>
    1076. 

  1076.           <td class="paramname"><em>in_pFieldname</em>, </td>
    1077. 

  1077.         </tr>
    1078. 

  1078.         <tr>
    1079. 

  1079.           <td class="paramkey"></td>
    1080. 

  1080.           <td></td>
    1081. 

  1081.           <td class="paramtype">const U32&#160;</td>
    1082. 

  1082.           <td class="paramname"><em>in_fieldType</em>, </td>
    1083. 

  1083.         </tr>
    1084. 

  1084.         <tr>
    1085. 

  1085.           <td class="paramkey"></td>
    1086. 

  1086.           <td></td>
    1087. 

  1087.           <td class="paramtype">const dsize_t&#160;</td>
    1088. 

  1088.           <td class="paramname"><em>in_fieldOffset</em>, </td>
    1089. 

  1089.         </tr>
    1090. 

  1090.         <tr>
    1091. 

  1091.           <td class="paramkey"></td>
    1092. 

  1092.           <td></td>
    1093. 

  1093.           <td class="paramtype"><a class="el" href="class_abstract_class_rep.html#a23fe751b9b844d180a5e8ee921968aa5">AbstractClassRep::SetDataNotify</a>&#160;</td>
    1094. 

  1094.           <td class="paramname"><em>in_setDataFn</em>, </td>
    1095. 

  1095.         </tr>
    1096. 

  1096.         <tr>
    1097. 

  1097.           <td class="paramkey"></td>
    1098. 

  1098.           <td></td>
    1099. 

  1099.           <td class="paramtype"><a class="el" href="class_abstract_class_rep.html#a11f286fc60ce139f916571059ec35e22">AbstractClassRep::GetDataNotify</a>&#160;</td>
    1100. 

  1100.           <td class="paramname"><em>in_getDataFn</em> = <code>&amp;defaultProtectedGetFn</code>, </td>
    1101. 

  1101.         </tr>
    1102. 

  1102.         <tr>
    1103. 

  1103.           <td class="paramkey"></td>
    1104. 

  1104.           <td></td>
    1105. 

  1105.           <td class="paramtype">const U32&#160;</td>
    1106. 

  1106.           <td class="paramname"><em>in_elementCount</em> = <code>1</code>, </td>
    1107. 

  1107.         </tr>
    1108. 

  1108.         <tr>
    1109. 

  1109.           <td class="paramkey"></td>
    1110. 

  1110.           <td></td>
    1111. 

  1111.           <td class="paramtype"><a class="el" href="struct_enum_table.html">EnumTable</a> *&#160;</td>
    1112. 

  1112.           <td class="paramname"><em>in_table</em> = <code>NULL</code>, </td>
    1113. 

  1113.         </tr>
    1114. 

  1114.         <tr>
    1115. 

  1115.           <td class="paramkey"></td>
    1116. 

  1116.           <td></td>
    1117. 

  1117.           <td class="paramtype">const char *&#160;</td>
    1118. 

  1118.           <td class="paramname"><em>in_pFieldDocs</em> = <code>NULL</code>&#160;</td>
    1119. 

  1119.         </tr>
    1120. 

  1120.         <tr>
    1121. 

  1121.           <td></td>
    1122. 

  1122.           <td>)</td>
    1123. 

  1123.           <td></td><td></td>
    1124. 

  1124.         </tr>
    1125. 

  1125.       </table>
    1126. 

  1126.   </td>
    1127. 

  1127.   <td class="mlabels-right">
    1128. 

  1128. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span>  </td>
    1129. 

  1129.   </tr>
    1130. 

  1130. </table>
    1131. 

  1131. </div><div class="memdoc">
    1132. 

  1132. <p>Register a complex protected field.</p>
    1133. 

  1133. <dl class="params"><dt>Parameters</dt><dd>
    1134. 

  1134.   <table class="params">
    1135. 

  1135.     <tr><td class="paramname">in_pFieldname</td><td>Name of the field. </td></tr>
    1136. 

  1136.     <tr><td class="paramname">in_fieldType</td><td>Type of the field. </td></tr>
    1137. 

  1137.   </table>
    1138. 

  1138.   </dd>
    1139. 

  1139. </dl>
    1140. 

  1140. <dl class="section see"><dt>See also</dt><dd>ConsoleDynamicTypes </dd></dl>
    1141. 

  1141. <dl class="params"><dt>Parameters</dt><dd>
    1142. 

  1142.   <table class="params">
    1143. 

  1143.     <tr><td class="paramname">in_fieldOffset</td><td>Offset to the field from the start of the class; calculated using the Offset() macro. </td></tr>
    1144. 

  1144.     <tr><td class="paramname">in_setDataFn</td><td>When this field gets set, it will call the callback provided. </td></tr>
    1145. 

  1145.   </table>
    1146. 

  1146.   </dd>
    1147. 

  1147. </dl>
    1148. 

  1148. <dl class="section see"><dt>See also</dt><dd>console_protected </dd></dl>
    1149. 

  1149. <dl class="params"><dt>Parameters</dt><dd>
    1150. 

  1150.   <table class="params">
    1151. 

  1151.     <tr><td class="paramname">in_getDataFn</td><td>When this field is accessed for it's data, it will return the value of this function </td></tr>
    1152. 

  1152.     <tr><td class="paramname">in_elementCount</td><td>Number of elements in this field. Arrays of elements are assumed to be contiguous in memory. </td></tr>
    1153. 

  1153.     <tr><td class="paramname">in_table</td><td>An <a class="el" href="struct_enum_table.html">EnumTable</a>, if this is an enumerated field. </td></tr>
    1154. 

  1154.     <tr><td class="paramname">in_pFieldDocs</td><td>Usage string for this field. </td></tr>
    1155. 

  1155.   </table>
    1156. 

  1156.   </dd>
    1157. 

  1157. </dl>
    1158. 

  1158. <dl class="section see"><dt>See also</dt><dd>console_autodoc </dd></dl>
    1159. 

  1159. 

  1160. </div>
    1161. 

  1161. </div>
    1162. 

  1162. <a id="a95c239afc15d197ae11798bc11e5c28b" name="a95c239afc15d197ae11798bc11e5c28b"></a>
    1163. 

  1163. <h2 class="memtitle"><span class="permalink"><a href="#a95c239afc15d197ae11798bc11e5c28b">&#9670;&#160;</a></span>consoleInit()</h2>
    1164. 

  1164. 

  1165. <div class="memitem">
    1166. 

  1166. <div class="memproto">
    1167. 

  1167. <table class="mlabels">
    1168. 

  1168.   <tr>
    1169. 

  1169.   <td class="mlabels-left">
    1170. 

  1170.       <table class="memname">
    1171. 

  1171.         <tr>
    1172. 

  1172.           <td class="memname">void consoleInit </td>
    1173. 

  1173.           <td>(</td>
    1174. 

  1174.           <td class="paramname"></td><td>)</td>
    1175. 

  1175.           <td></td>
    1176. 

  1176.         </tr>
    1177. 

  1177.       </table>
    1178. 

  1178.   </td>
    1179. 

  1179.   <td class="mlabels-right">
    1180. 

  1180. <span class="mlabels"><span class="mlabel">static</span></span>  </td>
    1181. 

  1181.   </tr>
    1182. 

  1182. </table>
    1183. 

  1183. </div><div class="memdoc">
    1184. 

  1184. <p>Register global constant variables and do other one-time initialization tasks in a subclass of <a class="el" href="class_console_object.html">ConsoleObject</a>.</p>
    1185. 

  1185. <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000006">Deprecated:</a></b></dt><dd>You should use ConsoleMethod and ConsoleFunction, not this, to register methods or commands. </dd></dl>
    1186. 

  1186. <dl class="section see"><dt>See also</dt><dd>console </dd></dl>
    1187. 

  1187. 

  1188. </div>
    1189. 

  1189. </div>
    1190. 

  1190. <a id="aa8b4ee59c729a0704b4a2f7b52246f98" name="aa8b4ee59c729a0704b4a2f7b52246f98"></a>
    1191. 

  1191. <h2 class="memtitle"><span class="permalink"><a href="#aa8b4ee59c729a0704b4a2f7b52246f98">&#9670;&#160;</a></span>create() <span class="overload">[1/2]</span></h2>
    1192. 

  1192. 

  1193. <div class="memitem">
    1194. 

  1194. <div class="memproto">
    1195. 

  1195. <table class="mlabels">
    1196. 

  1196.   <tr>
    1197. 

  1197.   <td class="mlabels-left">
    1198. 

  1198.       <table class="memname">
    1199. 

  1199.         <tr>
    1200. 

  1200.           <td class="memname"><a class="el" href="class_console_object.html">ConsoleObject</a> * create </td>
    1201. 

  1201.           <td>(</td>
    1202. 

  1202.           <td class="paramtype">const char *&#160;</td>
    1203. 

  1203.           <td class="paramname"><em>in_pClassName</em></td><td>)</td>
    1204. 

  1204.           <td></td>
    1205. 

  1205.         </tr>
    1206. 

  1206.       </table>
    1207. 

  1207.   </td>
    1208. 

  1208.   <td class="mlabels-right">
    1209. 

  1209. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
    1210. 

  1210.   </tr>
    1211. 

  1211. </table>
    1212. 

  1212. </div><div class="memdoc">
    1213. 

  1213. 

  1214. </div>
    1215. 

  1215. </div>
    1216. 

  1216. <a id="abeb358d6fc89fc282b4e401de2895965" name="abeb358d6fc89fc282b4e401de2895965"></a>
    1217. 

  1217. <h2 class="memtitle"><span class="permalink"><a href="#abeb358d6fc89fc282b4e401de2895965">&#9670;&#160;</a></span>create() <span class="overload">[2/2]</span></h2>
    1218. 

  1218. 

  1219. <div class="memitem">
    1220. 

  1220. <div class="memproto">
    1221. 

  1221. <table class="mlabels">
    1222. 

  1222.   <tr>
    1223. 

  1223.   <td class="mlabels-left">
    1224. 

  1224.       <table class="memname">
    1225. 

  1225.         <tr>
    1226. 

  1226.           <td class="memname"><a class="el" href="class_console_object.html">ConsoleObject</a> * create </td>
    1227. 

  1227.           <td>(</td>
    1228. 

  1228.           <td class="paramtype">const U32&#160;</td>
    1229. 

  1229.           <td class="paramname"><em>groupId</em>, </td>
    1230. 

  1230.         </tr>
    1231. 

  1231.         <tr>
    1232. 

  1232.           <td class="paramkey"></td>
    1233. 

  1233.           <td></td>
    1234. 

  1234.           <td class="paramtype">const U32&#160;</td>
    1235. 

  1235.           <td class="paramname"><em>typeId</em>, </td>
    1236. 

  1236.         </tr>
    1237. 

  1237.         <tr>
    1238. 

  1238.           <td class="paramkey"></td>
    1239. 

  1239.           <td></td>
    1240. 

  1240.           <td class="paramtype">const U32&#160;</td>
    1241. 

  1241.           <td class="paramname"><em>in_classId</em>&#160;</td>
    1242. 

  1242.         </tr>
    1243. 

  1243.         <tr>
    1244. 

  1244.           <td></td>
    1245. 

  1245.           <td>)</td>
    1246. 

  1246.           <td></td><td></td>
    1247. 

  1247.         </tr>
    1248. 

  1248.       </table>
    1249. 

  1249.   </td>
    1250. 

  1250.   <td class="mlabels-right">
    1251. 

  1251. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
    1252. 

  1252.   </tr>
    1253. 

  1253. </table>
    1254. 

  1254. </div><div class="memdoc">
    1255. 

  1255. 

  1256. </div>
    1257. 

  1257. </div>
    1258. 

  1258. <a id="a1918263ead95ed1906c7027651938e0c" name="a1918263ead95ed1906c7027651938e0c"></a>
    1259. 

  1259. <h2 class="memtitle"><span class="permalink"><a href="#a1918263ead95ed1906c7027651938e0c">&#9670;&#160;</a></span>endGroup()</h2>
    1260. 

  1260. 

  1261. <div class="memitem">
    1262. 

  1262. <div class="memproto">
    1263. 

  1263. <table class="mlabels">
    1264. 

  1264.   <tr>
    1265. 

  1265.   <td class="mlabels-left">
    1266. 

  1266.       <table class="memname">
    1267. 

  1267.         <tr>
    1268. 

  1268.           <td class="memname">void endGroup </td>
    1269. 

  1269.           <td>(</td>
    1270. 

  1270.           <td class="paramtype">const char *&#160;</td>
    1271. 

  1271.           <td class="paramname"><em>in_pGroupname</em></td><td>)</td>
    1272. 

  1272.           <td></td>
    1273. 

  1273.         </tr>
    1274. 

  1274.       </table>
    1275. 

  1275.   </td>
    1276. 

  1276.   <td class="mlabels-right">
    1277. 

  1277. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span>  </td>
    1278. 

  1278.   </tr>
    1279. 

  1279. </table>
    1280. 

  1280. </div><div class="memdoc">
    1281. 

  1281. <p>Mark the end of a group of fields.</p>
    1282. 

  1282. <p>This is used in the consoleDoc system. </p><dl class="section see"><dt>See also</dt><dd>console_autodoc </dd></dl>
    1283. 

  1283. 

  1284. </div>
    1285. 

  1285. </div>
    1286. 

  1286. <a id="a1126670f9cef40e89f356669cd373252" name="a1126670f9cef40e89f356669cd373252"></a>
    1287. 

  1287. <h2 class="memtitle"><span class="permalink"><a href="#a1126670f9cef40e89f356669cd373252">&#9670;&#160;</a></span>findField()</h2>
    1288. 

  1288. 

  1289. <div class="memitem">
    1290. 

  1290. <div class="memproto">
    1291. 

  1291. <table class="mlabels">
    1292. 

  1292.   <tr>
    1293. 

  1293.   <td class="mlabels-left">
    1294. 

  1294.       <table class="memname">
    1295. 

  1295.         <tr>
    1296. 

  1296.           <td class="memname">const <a class="el" href="struct_abstract_class_rep_1_1_field.html">AbstractClassRep::Field</a> * findField </td>
    1297. 

  1297.           <td>(</td>
    1298. 

  1298.           <td class="paramtype">StringTableEntry&#160;</td>
    1299. 

  1299.           <td class="paramname"><em>fieldName</em></td><td>)</td>
    1300. 

  1300.           <td> const</td>
    1301. 

  1301.         </tr>
    1302. 

  1302.       </table>
    1303. 

  1303.   </td>
    1304. 

  1304.   <td class="mlabels-right">
    1305. 

  1305. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
    1306. 

  1306.   </tr>
    1307. 

  1307. </table>
    1308. 

  1308. </div><div class="memdoc">
    1309. 

  1309. 

  1310. <p>Get a reference to a field by name. </p>
    1311. 

  1311. 

  1312. </div>
    1313. 

  1313. </div>
    1314. 

  1314. <a id="ae7913c7a8d1966a725b93f657456b66a" name="ae7913c7a8d1966a725b93f657456b66a"></a>
    1315. 

  1315. <h2 class="memtitle"><span class="permalink"><a href="#ae7913c7a8d1966a725b93f657456b66a">&#9670;&#160;</a></span>getClassId()</h2>
    1316. 

  1316. 

  1317. <div class="memitem">
    1318. 

  1318. <div class="memproto">
    1319. 

  1319. <table class="mlabels">
    1320. 

  1320.   <tr>
    1321. 

  1321.   <td class="mlabels-left">
    1322. 

  1322.       <table class="memname">
    1323. 

  1323.         <tr>
    1324. 

  1324.           <td class="memname">S32 getClassId </td>
    1325. 

  1325.           <td>(</td>
    1326. 

  1326.           <td class="paramtype">U32&#160;</td>
    1327. 

  1327.           <td class="paramname"><em>netClassGroup</em></td><td>)</td>
    1328. 

  1328.           <td> const</td>
    1329. 

  1329.         </tr>
    1330. 

  1330.       </table>
    1331. 

  1331.   </td>
    1332. 

  1332.   <td class="mlabels-right">
    1333. 

  1333. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
    1334. 

  1334.   </tr>
    1335. 

  1335. </table>
    1336. 

  1336. </div><div class="memdoc">
    1337. 

  1337. <p>Get our network-layer class id.</p>
    1338. 

  1338. <dl class="params"><dt>Parameters</dt><dd>
    1339. 

  1339.   <table class="params">
    1340. 

  1340.     <tr><td class="paramname">netClassGroup</td><td>The net class for which we want our ID. </td></tr>
    1341. 

  1341.   </table>
    1342. 

  1342.   </dd>
    1343. 

  1343. </dl>
    1344. 

  1344. <dl class="section see"><dt>See also</dt><dd></dd></dl>
    1345. 

  1345. 

  1346. </div>
    1347. 

  1347. </div>
    1348. 

  1348. <a id="a45b489f436c9d32a63f9c3d62f66c892" name="a45b489f436c9d32a63f9c3d62f66c892"></a>
    1349. 

  1349. <h2 class="memtitle"><span class="permalink"><a href="#a45b489f436c9d32a63f9c3d62f66c892">&#9670;&#160;</a></span>getClassName()</h2>
    1350. 

  1350. 

  1351. <div class="memitem">
    1352. 

  1352. <div class="memproto">
    1353. 

  1353. <table class="mlabels">
    1354. 

  1354.   <tr>
    1355. 

  1355.   <td class="mlabels-left">
    1356. 

  1356.       <table class="memname">
    1357. 

  1357.         <tr>
    1358. 

  1358.           <td class="memname">const char * getClassName </td>
    1359. 

  1359.           <td>(</td>
    1360. 

  1360.           <td class="paramname"></td><td>)</td>
    1361. 

  1361.           <td> const</td>
    1362. 

  1362.         </tr>
    1363. 

  1363.       </table>
    1364. 

  1364.   </td>
    1365. 

  1365.   <td class="mlabels-right">
    1366. 

  1366. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
    1367. 

  1367.   </tr>
    1368. 

  1368. </table>
    1369. 

  1369. </div><div class="memdoc">
    1370. 

  1370. <p>Get our compiler and platform independent class name.</p>
    1371. 

  1371. <dl class="section note"><dt>Note</dt><dd>This name can be used to instantiate another instance using <a class="el" href="class_console_object.html#aa8b4ee59c729a0704b4a2f7b52246f98">create()</a> </dd></dl>
    1372. 

  1372. 

  1373. </div>
    1374. 

  1374. </div>
    1375. 

  1375. <a id="aa8453ccfe6d778d5612ae246b05c488b" name="aa8453ccfe6d778d5612ae246b05c488b"></a>
    1376. 

  1376. <h2 class="memtitle"><span class="permalink"><a href="#aa8453ccfe6d778d5612ae246b05c488b">&#9670;&#160;</a></span>getClassRep()</h2>
    1377. 

  1377. 

  1378. <div class="memitem">
    1379. 

  1379. <div class="memproto">
    1380. 

  1380. <table class="mlabels">
    1381. 

  1381.   <tr>
    1382. 

  1382.   <td class="mlabels-left">
    1383. 

  1383.       <table class="memname">
    1384. 

  1384.         <tr>
    1385. 

  1385.           <td class="memname"><a class="el" href="class_abstract_class_rep.html">AbstractClassRep</a> * getClassRep </td>
    1386. 

  1386.           <td>(</td>
    1387. 

  1387.           <td class="paramname"></td><td>)</td>
    1388. 

  1388.           <td> const</td>
    1389. 

  1389.         </tr>
    1390. 

  1390.       </table>
    1391. 

  1391.   </td>
    1392. 

  1392.   <td class="mlabels-right">
    1393. 

  1393. <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
    1394. 

  1394.   </tr>
    1395. 

  1395. </table>
    1396. 

  1396. </div><div class="memdoc">
    1397. 

  1397. 

  1398. <p>Gets the ClassRep. </p>
    1399. 

  1399. 

  1400. </div>
    1401. 

  1401. </div>
    1402. 

  1402. <a id="a546fd9261e6104b86b947e417bef1228" name="a546fd9261e6104b86b947e417bef1228"></a>
    1403. 

  1403. <h2 class="memtitle"><span class="permalink"><a href="#a546fd9261e6104b86b947e417bef1228">&#9670;&#160;</a></span>getDynamicGroupExpand()</h2>
    1404. 

  1404. 

  1405. <div class="memitem">
    1406. 

  1406. <div class="memproto">
    1407. 

  1407. <table class="mlabels">
    1408. 

  1408.   <tr>
    1409. 

  1409.   <td class="mlabels-left">
    1410. 

  1410.       <table class="memname">
    1411. 

  1411.         <tr>
    1412. 

  1412.           <td class="memname">bool &amp; getDynamicGroupExpand </td>
    1413. 

  1413.           <td>(</td>
    1414. 

  1414.           <td class="paramname"></td><td>)</td>
    1415. 

  1415.           <td></td>
    1416. 

  1416.         </tr>
    1417. 

  1417.       </table>
    1418. 

  1418.   </td>
    1419. 

  1419.   <td class="mlabels-right">
    1420. 

  1420. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
    1421. 

  1421.   </tr>
    1422. 

  1422. </table>
    1423. 

  1423. </div><div class="memdoc">
    1424. 

  1424. <p>Get a handle to a boolean telling us if we expanded the dynamic group.</p>
    1425. 

  1425. <dl class="section see"><dt>See also</dt><dd>GuiInspector::Inspect() </dd></dl>
    1426. 

  1426. 

  1427. </div>
    1428. 

  1428. </div>
    1429. 

  1429. <a id="a2f9f31b3f4acbf8bdfefa15f78c49729" name="a2f9f31b3f4acbf8bdfefa15f78c49729"></a>
    1430. 

  1430. <h2 class="memtitle"><span class="permalink"><a href="#a2f9f31b3f4acbf8bdfefa15f78c49729">&#9670;&#160;</a></span>getFieldList()</h2>
    1431. 

  1431. 

  1432. <div class="memitem">
    1433. 

  1433. <div class="memproto">
    1434. 

  1434. <table class="mlabels">
    1435. 

  1435.   <tr>
    1436. 

  1436.   <td class="mlabels-left">
    1437. 

  1437.       <table class="memname">
    1438. 

  1438.         <tr>
    1439. 

  1439.           <td class="memname">const <a class="el" href="class_abstract_class_rep.html#a470d9814acbdf9bd6a2b054c6ff7f3a6">AbstractClassRep::FieldList</a> &amp; getFieldList </td>
    1440. 

  1440.           <td>(</td>
    1441. 

  1441.           <td class="paramname"></td><td>)</td>
    1442. 

  1442.           <td> const</td>
    1443. 

  1443.         </tr>
    1444. 

  1444.       </table>
    1445. 

  1445.   </td>
    1446. 

  1446.   <td class="mlabels-right">
    1447. 

  1447. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
    1448. 

  1448.   </tr>
    1449. 

  1449. </table>
    1450. 

  1450. </div><div class="memdoc">
    1451. 

  1451. 

  1452. <p>Get a list of all the fields. This information cannot be modified. </p>
    1453. 

  1453. 

  1454. </div>
    1455. 

  1455. </div>
    1456. 

  1456. <a id="ab33e449170ae2f52341c47138da4996c" name="ab33e449170ae2f52341c47138da4996c"></a>
    1457. 

  1457. <h2 class="memtitle"><span class="permalink"><a href="#ab33e449170ae2f52341c47138da4996c">&#9670;&#160;</a></span>getModifiableFieldList()</h2>
    1458. 

  1458. 

  1459. <div class="memitem">
    1460. 

  1460. <div class="memproto">
    1461. 

  1461. <table class="mlabels">
    1462. 

  1462.   <tr>
    1463. 

  1463.   <td class="mlabels-left">
    1464. 

  1464.       <table class="memname">
    1465. 

  1465.         <tr>
    1466. 

  1466.           <td class="memname"><a class="el" href="class_abstract_class_rep.html#a470d9814acbdf9bd6a2b054c6ff7f3a6">AbstractClassRep::FieldList</a> &amp; getModifiableFieldList </td>
    1467. 

  1467.           <td>(</td>
    1468. 

  1468.           <td class="paramname"></td><td>)</td>
    1469. 

  1469.           <td></td>
    1470. 

  1470.         </tr>
    1471. 

  1471.       </table>
    1472. 

  1472.   </td>
    1473. 

  1473.   <td class="mlabels-right">
    1474. 

  1474. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
    1475. 

  1475.   </tr>
    1476. 

  1476. </table>
    1477. 

  1477. </div><div class="memdoc">
    1478. 

  1478. <p>Get a list of all the fields, set up so we can modify them.</p>
    1479. 

  1479. <dl class="section note"><dt>Note</dt><dd>This is a bad trick to pull if you aren't very careful, since you can blast field data! </dd></dl>
    1480. 

  1480. 

  1481. </div>
    1482. 

  1482. </div>
    1483. 

  1483. <a id="ac93219672441a5e91bcfc02abeed29cb" name="ac93219672441a5e91bcfc02abeed29cb"></a>
    1484. 

  1484. <h2 class="memtitle"><span class="permalink"><a href="#ac93219672441a5e91bcfc02abeed29cb">&#9670;&#160;</a></span>getParentStaticClassRep()</h2>
    1485. 

  1485. 

  1486. <div class="memitem">
    1487. 

  1487. <div class="memproto">
    1488. 

  1488. <table class="mlabels">
    1489. 

  1489.   <tr>
    1490. 

  1490.   <td class="mlabels-left">
    1491. 

  1491.       <table class="memname">
    1492. 

  1492.         <tr>
    1493. 

  1493.           <td class="memname">static <a class="el" href="class_abstract_class_rep.html">AbstractClassRep</a> * getParentStaticClassRep </td>
    1494. 

  1494.           <td>(</td>
    1495. 

  1495.           <td class="paramname"></td><td>)</td>
    1496. 

  1496.           <td></td>
    1497. 

  1497.         </tr>
    1498. 

  1498.       </table>
    1499. 

  1499.   </td>
    1500. 

  1500.   <td class="mlabels-right">
    1501. 

  1501. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
    1502. 

  1502.   </tr>
    1503. 

  1503. </table>
    1504. 

  1504. </div><div class="memdoc">
    1505. 

  1505. 

  1506. <p>Get the abstract class information for this class's superclass. </p>
    1507. 

  1507. 

  1508. </div>
    1509. 

  1509. </div>
    1510. 

  1510. <a id="af6128f2158606edc40e1cb210ba92bd0" name="af6128f2158606edc40e1cb210ba92bd0"></a>
    1511. 

  1511. <h2 class="memtitle"><span class="permalink"><a href="#af6128f2158606edc40e1cb210ba92bd0">&#9670;&#160;</a></span>getStaticClassRep()</h2>
    1512. 

  1512. 

  1513. <div class="memitem">
    1514. 

  1514. <div class="memproto">
    1515. 

  1515. <table class="mlabels">
    1516. 

  1516.   <tr>
    1517. 

  1517.   <td class="mlabels-left">
    1518. 

  1518.       <table class="memname">
    1519. 

  1519.         <tr>
    1520. 

  1520.           <td class="memname">static <a class="el" href="class_abstract_class_rep.html">AbstractClassRep</a> * getStaticClassRep </td>
    1521. 

  1521.           <td>(</td>
    1522. 

  1522.           <td class="paramname"></td><td>)</td>
    1523. 

  1523.           <td></td>
    1524. 

  1524.         </tr>
    1525. 

  1525.       </table>
    1526. 

  1526.   </td>
    1527. 

  1527.   <td class="mlabels-right">
    1528. 

  1528. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
    1529. 

  1529.   </tr>
    1530. 

  1530. </table>
    1531. 

  1531. </div><div class="memdoc">
    1532. 

  1532. 

  1533. <p>Get the abstract class information for this class. </p>
    1534. 

  1534. 

  1535. </div>
    1536. 

  1536. </div>
    1537. 

  1537. <a id="a67420d3593db1aae6efb2c3abb23c690" name="a67420d3593db1aae6efb2c3abb23c690"></a>
    1538. 

  1538. <h2 class="memtitle"><span class="permalink"><a href="#a67420d3593db1aae6efb2c3abb23c690">&#9670;&#160;</a></span>initPersistFields()</h2>
    1539. 

  1539. 

  1540. <div class="memitem">
    1541. 

  1541. <div class="memproto">
    1542. 

  1542. <table class="mlabels">
    1543. 

  1543.   <tr>
    1544. 

  1544.   <td class="mlabels-left">
    1545. 

  1545.       <table class="memname">
    1546. 

  1546.         <tr>
    1547. 

  1547.           <td class="memname">void initPersistFields </td>
    1548. 

  1548.           <td>(</td>
    1549. 

  1549.           <td class="paramname"></td><td>)</td>
    1550. 

  1550.           <td></td>
    1551. 

  1551.         </tr>
    1552. 

  1552.       </table>
    1553. 

  1553.   </td>
    1554. 

  1554.   <td class="mlabels-right">
    1555. 

  1555. <span class="mlabels"><span class="mlabel">static</span></span>  </td>
    1556. 

  1556.   </tr>
    1557. 

  1557. </table>
    1558. 

  1558. </div><div class="memdoc">
    1559. 

  1559. <p>Register dynamic fields in a subclass of <a class="el" href="class_console_object.html">ConsoleObject</a>.</p>
    1560. 

  1560. <dl class="section see"><dt>See also</dt><dd><a class="el" href="class_console_object.html#a1e61452413a8cd497dfc1a2b62f072cd">addField()</a>, <a class="el" href="class_console_object.html#a3356a3140575cbc1e4466883937daf0b">addFieldV()</a>, <a class="el" href="class_console_object.html#aed3d0d1abd7ba4a17e792ca80f3478a7">addDepricatedField()</a>, <a class="el" href="class_console_object.html#a38f3095c01e8b2055e4c2e58d9a133e8">addGroup()</a>, <a class="el" href="class_console_object.html#a1918263ead95ed1906c7027651938e0c">endGroup()</a> </dd></dl>
    1561. 

  1561. 

  1562. </div>
    1563. 

  1563. </div>
    1564. 

  1564. <a id="a336cc354c2d28bd8a502405466282db9" name="a336cc354c2d28bd8a502405466282db9"></a>
    1565. 

  1565. <h2 class="memtitle"><span class="permalink"><a href="#a336cc354c2d28bd8a502405466282db9">&#9670;&#160;</a></span>lookupClassName()</h2>
    1566. 

  1566. 

  1567. <div class="memitem">
    1568. 

  1568. <div class="memproto">
    1569. 

  1569. <table class="mlabels">
    1570. 

  1570.   <tr>
    1571. 

  1571.   <td class="mlabels-left">
    1572. 

  1572.       <table class="memname">
    1573. 

  1573.         <tr>
    1574. 

  1574.           <td class="memname">static const char * lookupClassName </td>
    1575. 

  1575.           <td>(</td>
    1576. 

  1576.           <td class="paramtype">const U32&#160;</td>
    1577. 

  1577.           <td class="paramname"><em>in_classTag</em></td><td>)</td>
    1578. 

  1578.           <td></td>
    1579. 

  1579.         </tr>
    1580. 

  1580.       </table>
    1581. 

  1581.   </td>
    1582. 

  1582.   <td class="mlabels-right">
    1583. 

  1583. <span class="mlabels"><span class="mlabel">static</span></span>  </td>
    1584. 

  1584.   </tr>
    1585. 

  1585. </table>
    1586. 

  1586. </div><div class="memdoc">
    1587. 

  1587. 

  1588. <p>Get the classname from a class tag. </p>
    1589. 

  1589. 

  1590. </div>
    1591. 

  1591. </div>
    1592. 

  1592. <a id="a7a47772574721164fe83b2fd5e3c6fc8" name="a7a47772574721164fe83b2fd5e3c6fc8"></a>
    1593. 

  1593. <h2 class="memtitle"><span class="permalink"><a href="#a7a47772574721164fe83b2fd5e3c6fc8">&#9670;&#160;</a></span>removeField()</h2>
    1594. 

  1594. 

  1595. <div class="memitem">
    1596. 

  1596. <div class="memproto">
    1597. 

  1597. <table class="mlabels">
    1598. 

  1598.   <tr>
    1599. 

  1599.   <td class="mlabels-left">
    1600. 

  1600.       <table class="memname">
    1601. 

  1601.         <tr>
    1602. 

  1602.           <td class="memname">bool removeField </td>
    1603. 

  1603.           <td>(</td>
    1604. 

  1604.           <td class="paramtype">const char *&#160;</td>
    1605. 

  1605.           <td class="paramname"><em>in_pFieldname</em></td><td>)</td>
    1606. 

  1606.           <td></td>
    1607. 

  1607.         </tr>
    1608. 

  1608.       </table>
    1609. 

  1609.   </td>
    1610. 

  1610.   <td class="mlabels-right">
    1611. 

  1611. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span>  </td>
    1612. 

  1612.   </tr>
    1613. 

  1613. </table>
    1614. 

  1614. </div><div class="memdoc">
    1615. 

  1615. <p>Remove a field.</p>
    1616. 

  1616. <p>Sometimes, you just have to remove a field! </p><dl class="section return"><dt>Returns</dt><dd>True on success. </dd></dl>
    1617. 

  1617. 

  1618. </div>
    1619. 

  1619. </div>
    1620. 

  1620. <a id="ac980ffce7987a95385fe04d6fd934a6a" name="ac980ffce7987a95385fe04d6fd934a6a"></a>
    1621. 

  1621. <h2 class="memtitle"><span class="permalink"><a href="#ac980ffce7987a95385fe04d6fd934a6a">&#9670;&#160;</a></span>setField()</h2>
    1622. 

  1622. 

  1623. <div class="memitem">
    1624. 

  1624. <div class="memproto">
    1625. 

  1625. <table class="mlabels">
    1626. 

  1626.   <tr>
    1627. 

  1627.   <td class="mlabels-left">
    1628. 

  1628.       <table class="memname">
    1629. 

  1629.         <tr>
    1630. 

  1630.           <td class="memname">bool setField </td>
    1631. 

  1631.           <td>(</td>
    1632. 

  1632.           <td class="paramtype">const char *&#160;</td>
    1633. 

  1633.           <td class="paramname"><em>fieldName</em>, </td>
    1634. 

  1634.         </tr>
    1635. 

  1635.         <tr>
    1636. 

  1636.           <td class="paramkey"></td>
    1637. 

  1637.           <td></td>
    1638. 

  1638.           <td class="paramtype">const char *&#160;</td>
    1639. 

  1639.           <td class="paramname"><em>value</em>&#160;</td>
    1640. 

  1640.         </tr>
    1641. 

  1641.         <tr>
    1642. 

  1642.           <td></td>
    1643. 

  1643.           <td>)</td>
    1644. 

  1644.           <td></td><td></td>
    1645. 

  1645.         </tr>
    1646. 

  1646.       </table>
    1647. 

  1647.   </td>
    1648. 

  1648.   <td class="mlabels-right">
    1649. 

  1649. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
    1650. 

  1650.   </tr>
    1651. 

  1651. </table>
    1652. 

  1652. </div><div class="memdoc">
    1653. 

  1653. 

  1654. <p>Set the value of a field. </p>
    1655. 

  1655. 

  1656. </div>
    1657. 

  1657. </div>
    1658. 

  1658. <hr/>The documentation for this class was generated from the following files:<ul>
    1659. 

  1659. <li>console/<b>consoleObject.h</b></li>
    1660. 

  1660. <li>console/<b>consoleObject.cc</b></li>
    1661. 

  1661. </ul>
    1662. 

  1662. </div><!-- contents -->
    1663. 

  1663. <!-- start footer part -->
    1664. 

  1664. <hr class="footer"/><address class="footer"><small>
    1665. 

  1665. 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
    1666. 

  1666. </small></address>
    1667. 

  1667. </body>
    1668. 

  1668. </html>
    1669.