classSimXMLDocument.html 74 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>TorqueScript Reference: SimXMLDocument Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  14. </head>
  15. <body>
  16. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  17. <div id="titlearea">
  18. <table cellspacing="0" cellpadding="0">
  19. <tbody>
  20. <tr id="projectrow">
  21. <td id="projectalign">
  22. <div id="projectname">TorqueScript Reference
  23. </div>
  24. </td>
  25. </tr>
  26. </tbody>
  27. </table>
  28. </div>
  29. <!-- end header part -->
  30. <!-- Generated by Doxygen 1.9.8 -->
  31. <script type="text/javascript" src="menudata.js"></script>
  32. <script type="text/javascript" src="menu.js"></script>
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  35. $(function() {
  36. initMenu('',false,false,'search.php','Search');
  37. });
  38. /* @license-end */
  39. </script>
  40. <div id="main-nav"></div>
  41. </div><!-- top -->
  42. <div class="header">
  43. <div class="summary">
  44. <a href="#pub-methods">Public Member Functions</a> &#124;
  45. <a href="classSimXMLDocument-members.html">List of all members</a> </div>
  46. <div class="headertitle"><div class="title">SimXMLDocument Class Reference</div></div>
  47. </div><!--header-->
  48. <div class="contents">
  49. <p><code>#include &lt;SimXMLDocument_ScriptBinding.h&gt;</code></p>
  50. <p>Inherits <a class="el" href="classSimObject.html">SimObject</a>.</p>
  51. <table class="memberdecls">
  52. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  53. Public Member Functions</h2></td></tr>
  54. <tr class="memitem:aa2f9ffceadf2e149d66ebd9ba4527752" id="r_aa2f9ffceadf2e149d66ebd9ba4527752"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#aa2f9ffceadf2e149d66ebd9ba4527752">addComment</a> (string comment)</td></tr>
  55. <tr class="separator:aa2f9ffceadf2e149d66ebd9ba4527752"><td class="memSeparator" colspan="2">&#160;</td></tr>
  56. <tr class="memitem:a2845b7ec8d8c307b3ab88ce29c380e93" id="r_a2845b7ec8d8c307b3ab88ce29c380e93"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a2845b7ec8d8c307b3ab88ce29c380e93">addData</a> (string text)</td></tr>
  57. <tr class="separator:a2845b7ec8d8c307b3ab88ce29c380e93"><td class="memSeparator" colspan="2">&#160;</td></tr>
  58. <tr class="memitem:a3e6cc0aef931838972cb3adfcc780b44" id="r_a3e6cc0aef931838972cb3adfcc780b44"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a3e6cc0aef931838972cb3adfcc780b44">addHeader</a> ()</td></tr>
  59. <tr class="separator:a3e6cc0aef931838972cb3adfcc780b44"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60. <tr class="memitem:a203646719edb7b16b29d179dcc56af94" id="r_a203646719edb7b16b29d179dcc56af94"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a203646719edb7b16b29d179dcc56af94">addNewElement</a> (string name)</td></tr>
  61. <tr class="separator:a203646719edb7b16b29d179dcc56af94"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. <tr class="memitem:ac610bcfeeeec91977cec5bee9d53d3e9" id="r_ac610bcfeeeec91977cec5bee9d53d3e9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#ac610bcfeeeec91977cec5bee9d53d3e9">addText</a> (string text)</td></tr>
  63. <tr class="separator:ac610bcfeeeec91977cec5bee9d53d3e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64. <tr class="memitem:aca76734afa3853c527b6aba9c0f0cd28" id="r_aca76734afa3853c527b6aba9c0f0cd28"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#aca76734afa3853c527b6aba9c0f0cd28">attribute</a> (string attribute)</td></tr>
  65. <tr class="separator:aca76734afa3853c527b6aba9c0f0cd28"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:a596cda3b1efad3fa0d090f6a2a911061" id="r_a596cda3b1efad3fa0d090f6a2a911061"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a596cda3b1efad3fa0d090f6a2a911061">attributeExists</a> (string <a class="el" href="classSimXMLDocument.html#aca76734afa3853c527b6aba9c0f0cd28">attribute</a>)</td></tr>
  67. <tr class="separator:a596cda3b1efad3fa0d090f6a2a911061"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:a5532d1f6e289931b5e4e8b45160465da" id="r_a5532d1f6e289931b5e4e8b45160465da"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a5532d1f6e289931b5e4e8b45160465da">attributeF32</a> (string <a class="el" href="classSimXMLDocument.html#aca76734afa3853c527b6aba9c0f0cd28">attribute</a>)</td></tr>
  69. <tr class="separator:a5532d1f6e289931b5e4e8b45160465da"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:ae98bba22de9d366fec14517102c84dc0" id="r_ae98bba22de9d366fec14517102c84dc0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#ae98bba22de9d366fec14517102c84dc0">attributeS32</a> (string <a class="el" href="classSimXMLDocument.html#aca76734afa3853c527b6aba9c0f0cd28">attribute</a>)</td></tr>
  71. <tr class="separator:ae98bba22de9d366fec14517102c84dc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:ac8bb3912a3ce86b15842e79d0b421204" id="r_ac8bb3912a3ce86b15842e79d0b421204"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#ac8bb3912a3ce86b15842e79d0b421204">clear</a> ()</td></tr>
  73. <tr class="separator:ac8bb3912a3ce86b15842e79d0b421204"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:a926ead67a784f455ddd56590f2928e76" id="r_a926ead67a784f455ddd56590f2928e76"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a926ead67a784f455ddd56590f2928e76">clearError</a> ()</td></tr>
  75. <tr class="separator:a926ead67a784f455ddd56590f2928e76"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:ab18e6f3d333708ae66f0ede3d6628980" id="r_ab18e6f3d333708ae66f0ede3d6628980"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#ab18e6f3d333708ae66f0ede3d6628980">elementValue</a> ()</td></tr>
  77. <tr class="separator:ab18e6f3d333708ae66f0ede3d6628980"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:a97bd3818b4d8df6a6d3b88b169cb7f6b" id="r_a97bd3818b4d8df6a6d3b88b169cb7f6b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a97bd3818b4d8df6a6d3b88b169cb7f6b">firstAttribute</a> ()</td></tr>
  79. <tr class="separator:a97bd3818b4d8df6a6d3b88b169cb7f6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:ae9dea42fcae074448f7cf65759642b7e" id="r_ae9dea42fcae074448f7cf65759642b7e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#ae9dea42fcae074448f7cf65759642b7e">getData</a> ()</td></tr>
  81. <tr class="separator:ae9dea42fcae074448f7cf65759642b7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a93d1695df022a0419a10695bd75f12b8" id="r_a93d1695df022a0419a10695bd75f12b8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a93d1695df022a0419a10695bd75f12b8">getErrorDesc</a> ()</td></tr>
  83. <tr class="separator:a93d1695df022a0419a10695bd75f12b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:afab766445043570e6a82c14851366933" id="r_afab766445043570e6a82c14851366933"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#afab766445043570e6a82c14851366933">getText</a> ()</td></tr>
  85. <tr class="separator:afab766445043570e6a82c14851366933"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a998a8bf9682fb0345edc8915dae22233" id="r_a998a8bf9682fb0345edc8915dae22233"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a998a8bf9682fb0345edc8915dae22233">lastAttribute</a> ()</td></tr>
  87. <tr class="separator:a998a8bf9682fb0345edc8915dae22233"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a4775645bb372e1d55bf448ca9a057ea7" id="r_a4775645bb372e1d55bf448ca9a057ea7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a4775645bb372e1d55bf448ca9a057ea7">loadFile</a> (string <a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>)</td></tr>
  89. <tr class="separator:a4775645bb372e1d55bf448ca9a057ea7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a3454a9d4fee84e52124b87dccb2b2af5" id="r_a3454a9d4fee84e52124b87dccb2b2af5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a3454a9d4fee84e52124b87dccb2b2af5">nextAttribute</a> ()</td></tr>
  91. <tr class="separator:a3454a9d4fee84e52124b87dccb2b2af5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a187341af9440caadbda9c65e38bae3d7" id="r_a187341af9440caadbda9c65e38bae3d7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a187341af9440caadbda9c65e38bae3d7">nextSiblingElement</a> (string name)</td></tr>
  93. <tr class="separator:a187341af9440caadbda9c65e38bae3d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:af0730fad9d39b9fb5829aeab65acb297" id="r_af0730fad9d39b9fb5829aeab65acb297"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#af0730fad9d39b9fb5829aeab65acb297">parse</a> (string txtXML)</td></tr>
  95. <tr class="separator:af0730fad9d39b9fb5829aeab65acb297"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:ab381b336a3144bf89707335ce3582318" id="r_ab381b336a3144bf89707335ce3582318"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#ab381b336a3144bf89707335ce3582318">popElement</a> ()</td></tr>
  97. <tr class="separator:ab381b336a3144bf89707335ce3582318"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:ac786b845f39e57027b3e5b25ccb70398" id="r_ac786b845f39e57027b3e5b25ccb70398"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#ac786b845f39e57027b3e5b25ccb70398">prevAttribute</a> ()</td></tr>
  99. <tr class="separator:ac786b845f39e57027b3e5b25ccb70398"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a5cf2ba0766774e237cdfbc49d4fd6358" id="r_a5cf2ba0766774e237cdfbc49d4fd6358"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a5cf2ba0766774e237cdfbc49d4fd6358">pushChildElement</a> (int index)</td></tr>
  101. <tr class="separator:a5cf2ba0766774e237cdfbc49d4fd6358"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:aa2632292e6006dd960b81e8547829040" id="r_aa2632292e6006dd960b81e8547829040"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#aa2632292e6006dd960b81e8547829040">pushFirstChildElement</a> (string name)</td></tr>
  103. <tr class="separator:aa2632292e6006dd960b81e8547829040"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a31b82c65567a999a3ac712a7e0b66edc" id="r_a31b82c65567a999a3ac712a7e0b66edc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a31b82c65567a999a3ac712a7e0b66edc">pushNewElement</a> (string name)</td></tr>
  105. <tr class="separator:a31b82c65567a999a3ac712a7e0b66edc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a73c8e877c9ad432db10fb4d18dacd227" id="r_a73c8e877c9ad432db10fb4d18dacd227"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a73c8e877c9ad432db10fb4d18dacd227">readComment</a> (S32 index)</td></tr>
  107. <tr class="separator:a73c8e877c9ad432db10fb4d18dacd227"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a267fcc4de41221da0969abbe0257cf09" id="r_a267fcc4de41221da0969abbe0257cf09"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a267fcc4de41221da0969abbe0257cf09">removeText</a> ()</td></tr>
  109. <tr class="separator:a267fcc4de41221da0969abbe0257cf09"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:ad20897c5c8bd47f5d4005989bead0e55" id="r_ad20897c5c8bd47f5d4005989bead0e55"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#ad20897c5c8bd47f5d4005989bead0e55">reset</a> ()</td></tr>
  111. <tr class="separator:ad20897c5c8bd47f5d4005989bead0e55"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a037860d940d6efc41aa0f6bc0c6d6b84" id="r_a037860d940d6efc41aa0f6bc0c6d6b84"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a037860d940d6efc41aa0f6bc0c6d6b84">saveFile</a> (string <a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>)</td></tr>
  113. <tr class="separator:a037860d940d6efc41aa0f6bc0c6d6b84"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a5a21ea9de7a3577b77f5dbe26e9f50d8" id="r_a5a21ea9de7a3577b77f5dbe26e9f50d8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a5a21ea9de7a3577b77f5dbe26e9f50d8">setAttribute</a> (string attributeName, string attributeValue)</td></tr>
  115. <tr class="separator:a5a21ea9de7a3577b77f5dbe26e9f50d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:ae6fe2d098e65cc33f45d7a58f6cd83b7" id="r_ae6fe2d098e65cc33f45d7a58f6cd83b7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#ae6fe2d098e65cc33f45d7a58f6cd83b7">setObjectAttributes</a> (string attributeValue)</td></tr>
  117. <tr class="separator:ae6fe2d098e65cc33f45d7a58f6cd83b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="inherit_header pub_methods_classSimObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classSimObject')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classSimObject.html">SimObject</a></td></tr>
  119. <tr class="memitem:a2375929bea4901d98ae352231b0721ad inherit pub_methods_classSimObject" id="r_a2375929bea4901d98ae352231b0721ad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a2375929bea4901d98ae352231b0721ad">assignFieldsFrom</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
  120. <tr class="separator:a2375929bea4901d98ae352231b0721ad inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:a22437f451ceb1429fa2a3be23d523954 inherit pub_methods_classSimObject" id="r_a22437f451ceb1429fa2a3be23d523954"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a22437f451ceb1429fa2a3be23d523954">clone</a> ([copyDynamicFields=false]?)</td></tr>
  122. <tr class="separator:a22437f451ceb1429fa2a3be23d523954 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject" id="r_a7a4721d0a51e952c211e9b0fea4d8090"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7a4721d0a51e952c211e9b0fea4d8090">delete</a> ()</td></tr>
  124. <tr class="separator:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:a929e1325a515b279faca90a65028782e inherit pub_methods_classSimObject" id="r_a929e1325a515b279faca90a65028782e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a929e1325a515b279faca90a65028782e">getId</a> ()</td></tr>
  126. <tr class="separator:a929e1325a515b279faca90a65028782e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject" id="r_a4f673cd959711ae09927e7c44dae5fdb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a4f673cd959711ae09927e7c44dae5fdb">setName</a> (newName)</td></tr>
  128. <tr class="separator:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a78ee178b6a73658d65ca60da4d1e6683 inherit pub_methods_classSimObject" id="r_a78ee178b6a73658d65ca60da4d1e6683"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a78ee178b6a73658d65ca60da4d1e6683">getName</a> ()</td></tr>
  130. <tr class="separator:a78ee178b6a73658d65ca60da4d1e6683 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:ab8b0f8b874af628d7204d9cc2630ced7 inherit pub_methods_classSimObject" id="r_ab8b0f8b874af628d7204d9cc2630ced7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab8b0f8b874af628d7204d9cc2630ced7">getClassNamespace</a> ()</td></tr>
  132. <tr class="separator:ab8b0f8b874af628d7204d9cc2630ced7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:a6e266d4432d70cad58461d96e1d2cbdf inherit pub_methods_classSimObject" id="r_a6e266d4432d70cad58461d96e1d2cbdf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a6e266d4432d70cad58461d96e1d2cbdf">getSuperClassNamespace</a> ()</td></tr>
  134. <tr class="separator:a6e266d4432d70cad58461d96e1d2cbdf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:a847e859bcc5b58df83fa7f331c167c32 inherit pub_methods_classSimObject" id="r_a847e859bcc5b58df83fa7f331c167c32"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a847e859bcc5b58df83fa7f331c167c32">setClassNamespace</a> (nameSpace)</td></tr>
  136. <tr class="separator:a847e859bcc5b58df83fa7f331c167c32 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject" id="r_a9cbf471b97387d5bdefb88f92094ad54"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9cbf471b97387d5bdefb88f92094ad54">setSuperClassNamespace</a> ()</td></tr>
  138. <tr class="separator:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:a8f4e85d0903526235ed2ca86df69cdef inherit pub_methods_classSimObject" id="r_a8f4e85d0903526235ed2ca86df69cdef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a8f4e85d0903526235ed2ca86df69cdef">isMethod</a> (string methodName)</td></tr>
  140. <tr class="separator:a8f4e85d0903526235ed2ca86df69cdef inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:a9ce8801999cf2228ddde6d58ca3773d5 inherit pub_methods_classSimObject" id="r_a9ce8801999cf2228ddde6d58ca3773d5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9ce8801999cf2228ddde6d58ca3773d5">call</a> (methodName, [args] *)</td></tr>
  142. <tr class="separator:a9ce8801999cf2228ddde6d58ca3773d5 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject" id="r_a1810f5aba25efd242c24232c2c2bbd1a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1810f5aba25efd242c24232c2c2bbd1a">dumpClassHierarchy</a> ()</td></tr>
  144. <tr class="separator:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject" id="r_accd2600060dbaee3a3b41aed4034c63c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#accd2600060dbaee3a3b41aed4034c63c">dump</a> ()</td></tr>
  146. <tr class="separator:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:a66ac731a8dc088fe8c8ab17bf7c9eecd inherit pub_methods_classSimObject" id="r_a66ac731a8dc088fe8c8ab17bf7c9eecd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a66ac731a8dc088fe8c8ab17bf7c9eecd">isMemberOfClass</a> (string classname)</td></tr>
  148. <tr class="separator:a66ac731a8dc088fe8c8ab17bf7c9eecd inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:a3e97a324df2af082cdb089491757ce11 inherit pub_methods_classSimObject" id="r_a3e97a324df2af082cdb089491757ce11"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a3e97a324df2af082cdb089491757ce11">getClassName</a> ()</td></tr>
  150. <tr class="separator:a3e97a324df2af082cdb089491757ce11 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:abc2222a9649b5c033810e753b07f26a3 inherit pub_methods_classSimObject" id="r_abc2222a9649b5c033810e753b07f26a3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#abc2222a9649b5c033810e753b07f26a3">getFieldValue</a> (fieldName)</td></tr>
  152. <tr class="separator:abc2222a9649b5c033810e753b07f26a3 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="memitem:a1084f1964e446b3d279943cf6e575069 inherit pub_methods_classSimObject" id="r_a1084f1964e446b3d279943cf6e575069"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1084f1964e446b3d279943cf6e575069">setFieldValue</a> (fieldName, value)</td></tr>
  154. <tr class="separator:a1084f1964e446b3d279943cf6e575069 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:ab4e32fb984d9ce6584b0fa57c8772d3e inherit pub_methods_classSimObject" id="r_ab4e32fb984d9ce6584b0fa57c8772d3e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab4e32fb984d9ce6584b0fa57c8772d3e">setEditFieldValue</a> (fieldName, value)</td></tr>
  156. <tr class="separator:ab4e32fb984d9ce6584b0fa57c8772d3e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:a7543b8dc494ec0d9034cb73ae504f3ca inherit pub_methods_classSimObject" id="r_a7543b8dc494ec0d9034cb73ae504f3ca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7543b8dc494ec0d9034cb73ae504f3ca">getDynamicFieldCount</a> ()</td></tr>
  158. <tr class="separator:a7543b8dc494ec0d9034cb73ae504f3ca inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <tr class="memitem:a0e143217119b68d557d17ac2f13b173e inherit pub_methods_classSimObject" id="r_a0e143217119b68d557d17ac2f13b173e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0e143217119b68d557d17ac2f13b173e">getDynamicField</a> (index)</td></tr>
  160. <tr class="separator:a0e143217119b68d557d17ac2f13b173e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. <tr class="memitem:af2e74f6b683da8d2085f0991dab7948b inherit pub_methods_classSimObject" id="r_af2e74f6b683da8d2085f0991dab7948b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af2e74f6b683da8d2085f0991dab7948b">getFieldCount</a> ()</td></tr>
  162. <tr class="separator:af2e74f6b683da8d2085f0991dab7948b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. <tr class="memitem:ac636f89189406eef1b401292459b1a3b inherit pub_methods_classSimObject" id="r_ac636f89189406eef1b401292459b1a3b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ac636f89189406eef1b401292459b1a3b">getField</a> (int index)</td></tr>
  164. <tr class="separator:ac636f89189406eef1b401292459b1a3b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <tr class="memitem:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject" id="r_aa8f68d1e6d8c6601c39b3f676f0e9c70"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa8f68d1e6d8c6601c39b3f676f0e9c70">setProgenitorFile</a> (file)</td></tr>
  166. <tr class="separator:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. <tr class="memitem:a88c8d99755a07ac4648360dd40ff67a5 inherit pub_methods_classSimObject" id="r_a88c8d99755a07ac4648360dd40ff67a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a88c8d99755a07ac4648360dd40ff67a5">getProgenitorFile</a> ()</td></tr>
  168. <tr class="separator:a88c8d99755a07ac4648360dd40ff67a5 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  169. <tr class="memitem:a367706e675179342e6153c45f1ba06ae inherit pub_methods_classSimObject" id="r_a367706e675179342e6153c45f1ba06ae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a367706e675179342e6153c45f1ba06ae">getType</a> ()</td></tr>
  170. <tr class="separator:a367706e675179342e6153c45f1ba06ae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  171. <tr class="memitem:a0570b7f6eb94a0ed941fd75f6f01555b inherit pub_methods_classSimObject" id="r_a0570b7f6eb94a0ed941fd75f6f01555b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0570b7f6eb94a0ed941fd75f6f01555b">getFieldType</a> (fieldName)</td></tr>
  172. <tr class="separator:a0570b7f6eb94a0ed941fd75f6f01555b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  173. <tr class="memitem:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject" id="r_a5aaca360a719feabae0e4e57b921deae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5aaca360a719feabae0e4e57b921deae">setInternalName</a> (string InternalName)</td></tr>
  174. <tr class="separator:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  175. <tr class="memitem:af9f341b474a28f4bcf79bc02439b7c18 inherit pub_methods_classSimObject" id="r_af9f341b474a28f4bcf79bc02439b7c18"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af9f341b474a28f4bcf79bc02439b7c18">getInternalName</a> ()</td></tr>
  176. <tr class="separator:af9f341b474a28f4bcf79bc02439b7c18 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  177. <tr class="memitem:a986f1b4a76969bac5dfd50b22af8dec6 inherit pub_methods_classSimObject" id="r_a986f1b4a76969bac5dfd50b22af8dec6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a986f1b4a76969bac5dfd50b22af8dec6">isChildOfGroup</a> (groupID)</td></tr>
  178. <tr class="separator:a986f1b4a76969bac5dfd50b22af8dec6 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  179. <tr class="memitem:ae329d6593bb3f9b8046e7cae693ccc09 inherit pub_methods_classSimObject" id="r_ae329d6593bb3f9b8046e7cae693ccc09"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ae329d6593bb3f9b8046e7cae693ccc09">getGroup</a> ()</td></tr>
  180. <tr class="separator:ae329d6593bb3f9b8046e7cae693ccc09 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  181. <tr class="memitem:a39653bc04e82875f2dc8d6dea25acdaa inherit pub_methods_classSimObject" id="r_a39653bc04e82875f2dc8d6dea25acdaa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a39653bc04e82875f2dc8d6dea25acdaa">startTimer</a> (callbackFunction, float timePeriod, [repeat]?)</td></tr>
  182. <tr class="separator:a39653bc04e82875f2dc8d6dea25acdaa inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  183. <tr class="memitem:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject" id="r_aa6f6bfef028c7b053444cbd48567d286"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa6f6bfef028c7b053444cbd48567d286">stopTimer</a> ()</td></tr>
  184. <tr class="separator:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  185. <tr class="memitem:a5807c03d2b725a54732d09b53d5da631 inherit pub_methods_classSimObject" id="r_a5807c03d2b725a54732d09b53d5da631"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5807c03d2b725a54732d09b53d5da631">isTimerActive</a> ()</td></tr>
  186. <tr class="separator:a5807c03d2b725a54732d09b53d5da631 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  187. <tr class="memitem:a16d537cd7a1c438045bb756fe1e22d2d inherit pub_methods_classSimObject" id="r_a16d537cd7a1c438045bb756fe1e22d2d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a16d537cd7a1c438045bb756fe1e22d2d">schedule</a> (time, command, [arg] *)</td></tr>
  188. <tr class="separator:a16d537cd7a1c438045bb756fe1e22d2d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  189. <tr class="memitem:a9f05bc4a94b98e2e3347fe34aeefe7c4 inherit pub_methods_classSimObject" id="r_a9f05bc4a94b98e2e3347fe34aeefe7c4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9f05bc4a94b98e2e3347fe34aeefe7c4">startListening</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
  190. <tr class="separator:a9f05bc4a94b98e2e3347fe34aeefe7c4 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  191. <tr class="memitem:a3f7f0520846a222310415ad7a8f8a4bf inherit pub_methods_classSimObject" id="r_a3f7f0520846a222310415ad7a8f8a4bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a3f7f0520846a222310415ad7a8f8a4bf">stopListening</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
  192. <tr class="separator:a3f7f0520846a222310415ad7a8f8a4bf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  193. <tr class="memitem:afa6eac5990b02024e77e3815161159df inherit pub_methods_classSimObject" id="r_afa6eac5990b02024e77e3815161159df"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#afa6eac5990b02024e77e3815161159df">addListener</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
  194. <tr class="separator:afa6eac5990b02024e77e3815161159df inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  195. <tr class="memitem:a07dd4cf0d113ff4a8943b900bda68a1c inherit pub_methods_classSimObject" id="r_a07dd4cf0d113ff4a8943b900bda68a1c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a07dd4cf0d113ff4a8943b900bda68a1c">removeListener</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
  196. <tr class="separator:a07dd4cf0d113ff4a8943b900bda68a1c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  197. <tr class="memitem:a87be48ec4599c3d02a118cee89e47f55 inherit pub_methods_classSimObject" id="r_a87be48ec4599c3d02a118cee89e47f55"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a87be48ec4599c3d02a118cee89e47f55">removeAllListeners</a> ()</td></tr>
  198. <tr class="separator:a87be48ec4599c3d02a118cee89e47f55 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  199. <tr class="memitem:a1dcaa2910d6405134c74a71745d29154 inherit pub_methods_classSimObject" id="r_a1dcaa2910d6405134c74a71745d29154"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1dcaa2910d6405134c74a71745d29154">postEvent</a> (<a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> eventName, <a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> data)</td></tr>
  200. <tr class="separator:a1dcaa2910d6405134c74a71745d29154 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  201. <tr class="memitem:ab6e816c3694e8b6119bf9ac3f5556f32 inherit pub_methods_classSimObject" id="r_ab6e816c3694e8b6119bf9ac3f5556f32"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab6e816c3694e8b6119bf9ac3f5556f32">save</a> (<a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>, [selectedOnly]?)</td></tr>
  202. <tr class="separator:ab6e816c3694e8b6119bf9ac3f5556f32 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  203. <tr class="memitem:a216228c27df224ac5e8d3590494bfb3f inherit pub_methods_classSimObject" id="r_a216228c27df224ac5e8d3590494bfb3f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a216228c27df224ac5e8d3590494bfb3f">addFieldFilter</a> (fieldName)</td></tr>
  204. <tr class="separator:a216228c27df224ac5e8d3590494bfb3f inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  205. <tr class="memitem:ad517bd83c1c853985ab07cd22775c43d inherit pub_methods_classSimObject" id="r_ad517bd83c1c853985ab07cd22775c43d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad517bd83c1c853985ab07cd22775c43d">removeFieldFilter</a> (fieldName)</td></tr>
  206. <tr class="separator:ad517bd83c1c853985ab07cd22775c43d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  207. </table>
  208. <h2 class="groupheader">Member Function Documentation</h2>
  209. <a id="aa2f9ffceadf2e149d66ebd9ba4527752" name="aa2f9ffceadf2e149d66ebd9ba4527752"></a>
  210. <h2 class="memtitle"><span class="permalink"><a href="#aa2f9ffceadf2e149d66ebd9ba4527752">&#9670;&#160;</a></span>addComment()</h2>
  211. <div class="memitem">
  212. <div class="memproto">
  213. <table class="memname">
  214. <tr>
  215. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> addComment </td>
  216. <td>(</td>
  217. <td class="paramtype">string&#160;</td>
  218. <td class="paramname"><em>comment</em></td><td>)</td>
  219. <td></td>
  220. </tr>
  221. </table>
  222. </div><div class="memdoc">
  223. <p>Add the given comment as a child of current stack element. </p><dl class="params"><dt>Parameters</dt><dd>
  224. <table class="params">
  225. <tr><td class="paramname">comment</td><td>The desired comment to add </td></tr>
  226. </table>
  227. </dd>
  228. </dl>
  229. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  230. </div>
  231. </div>
  232. <a id="a2845b7ec8d8c307b3ab88ce29c380e93" name="a2845b7ec8d8c307b3ab88ce29c380e93"></a>
  233. <h2 class="memtitle"><span class="permalink"><a href="#a2845b7ec8d8c307b3ab88ce29c380e93">&#9670;&#160;</a></span>addData()</h2>
  234. <div class="memitem">
  235. <div class="memproto">
  236. <table class="memname">
  237. <tr>
  238. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> addData </td>
  239. <td>(</td>
  240. <td class="paramtype">string&#160;</td>
  241. <td class="paramname"><em>text</em></td><td>)</td>
  242. <td></td>
  243. </tr>
  244. </table>
  245. </div><div class="memdoc">
  246. <p>Add the given text as a child of current stack element. </p><dl class="params"><dt>Parameters</dt><dd>
  247. <table class="params">
  248. <tr><td class="paramname">The</td><td>desired text to add </td></tr>
  249. </table>
  250. </dd>
  251. </dl>
  252. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  253. </div>
  254. </div>
  255. <a id="a3e6cc0aef931838972cb3adfcc780b44" name="a3e6cc0aef931838972cb3adfcc780b44"></a>
  256. <h2 class="memtitle"><span class="permalink"><a href="#a3e6cc0aef931838972cb3adfcc780b44">&#9670;&#160;</a></span>addHeader()</h2>
  257. <div class="memitem">
  258. <div class="memproto">
  259. <table class="memname">
  260. <tr>
  261. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> addHeader </td>
  262. <td>(</td>
  263. <td class="paramname"></td><td>)</td>
  264. <td></td>
  265. </tr>
  266. </table>
  267. </div><div class="memdoc">
  268. <p>Add XML header to document. </p><dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  269. </div>
  270. </div>
  271. <a id="a203646719edb7b16b29d179dcc56af94" name="a203646719edb7b16b29d179dcc56af94"></a>
  272. <h2 class="memtitle"><span class="permalink"><a href="#a203646719edb7b16b29d179dcc56af94">&#9670;&#160;</a></span>addNewElement()</h2>
  273. <div class="memitem">
  274. <div class="memproto">
  275. <table class="memname">
  276. <tr>
  277. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> addNewElement </td>
  278. <td>(</td>
  279. <td class="paramtype">string&#160;</td>
  280. <td class="paramname"><em>name</em></td><td>)</td>
  281. <td></td>
  282. </tr>
  283. </table>
  284. </div><div class="memdoc">
  285. <p>Create new element as child of current stack element and push new element on to stack. </p><dl class="params"><dt>Parameters</dt><dd>
  286. <table class="params">
  287. <tr><td class="paramname">name</td><td>The anme of the new element </td></tr>
  288. </table>
  289. </dd>
  290. </dl>
  291. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  292. </div>
  293. </div>
  294. <a id="ac610bcfeeeec91977cec5bee9d53d3e9" name="ac610bcfeeeec91977cec5bee9d53d3e9"></a>
  295. <h2 class="memtitle"><span class="permalink"><a href="#ac610bcfeeeec91977cec5bee9d53d3e9">&#9670;&#160;</a></span>addText()</h2>
  296. <div class="memitem">
  297. <div class="memproto">
  298. <table class="memname">
  299. <tr>
  300. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> addText </td>
  301. <td>(</td>
  302. <td class="paramtype">string&#160;</td>
  303. <td class="paramname"><em>text</em></td><td>)</td>
  304. <td></td>
  305. </tr>
  306. </table>
  307. </div><div class="memdoc">
  308. <p>Add the given text as a child of current stack element. </p><dl class="params"><dt>Parameters</dt><dd>
  309. <table class="params">
  310. <tr><td class="paramname">text</td><td>The desired text to add </td></tr>
  311. </table>
  312. </dd>
  313. </dl>
  314. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  315. </div>
  316. </div>
  317. <a id="aca76734afa3853c527b6aba9c0f0cd28" name="aca76734afa3853c527b6aba9c0f0cd28"></a>
  318. <h2 class="memtitle"><span class="permalink"><a href="#aca76734afa3853c527b6aba9c0f0cd28">&#9670;&#160;</a></span>attribute()</h2>
  319. <div class="memitem">
  320. <div class="memproto">
  321. <table class="memname">
  322. <tr>
  323. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> attribute </td>
  324. <td>(</td>
  325. <td class="paramtype">string&#160;</td>
  326. <td class="paramname"><em>attribute</em></td><td>)</td>
  327. <td></td>
  328. </tr>
  329. </table>
  330. </div><div class="memdoc">
  331. <p>Get attribute value if it exists. </p><dl class="params"><dt>Parameters</dt><dd>
  332. <table class="params">
  333. <tr><td class="paramname">attribute</td><td>The desired <a class="el" href="classSimXMLDocument.html">SimXMLDocument</a> attribute </td></tr>
  334. </table>
  335. </dd>
  336. </dl>
  337. <dl class="section return"><dt>Returns</dt><dd>Returns the value of the attribute as a string, or an empty string on failure </dd></dl>
  338. </div>
  339. </div>
  340. <a id="a596cda3b1efad3fa0d090f6a2a911061" name="a596cda3b1efad3fa0d090f6a2a911061"></a>
  341. <h2 class="memtitle"><span class="permalink"><a href="#a596cda3b1efad3fa0d090f6a2a911061">&#9670;&#160;</a></span>attributeExists()</h2>
  342. <div class="memitem">
  343. <div class="memproto">
  344. <table class="memname">
  345. <tr>
  346. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> attributeExists </td>
  347. <td>(</td>
  348. <td class="paramtype">string&#160;</td>
  349. <td class="paramname"><em>attribute</em></td><td>)</td>
  350. <td></td>
  351. </tr>
  352. </table>
  353. </div><div class="memdoc">
  354. <p>Get true if named attribute exists. </p><dl class="params"><dt>Parameters</dt><dd>
  355. <table class="params">
  356. <tr><td class="paramname">attribute</td><td>The desired attribute's name </td></tr>
  357. </table>
  358. </dd>
  359. </dl>
  360. <dl class="section return"><dt>Returns</dt><dd>Returns true if attribute exists and false otherwise </dd></dl>
  361. </div>
  362. </div>
  363. <a id="a5532d1f6e289931b5e4e8b45160465da" name="a5532d1f6e289931b5e4e8b45160465da"></a>
  364. <h2 class="memtitle"><span class="permalink"><a href="#a5532d1f6e289931b5e4e8b45160465da">&#9670;&#160;</a></span>attributeF32()</h2>
  365. <div class="memitem">
  366. <div class="memproto">
  367. <table class="memname">
  368. <tr>
  369. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> attributeF32 </td>
  370. <td>(</td>
  371. <td class="paramtype">string&#160;</td>
  372. <td class="paramname"><em>attribute</em></td><td>)</td>
  373. <td></td>
  374. </tr>
  375. </table>
  376. </div><div class="memdoc">
  377. <p>Get attribute value if it exists. </p><dl class="params"><dt>Parameters</dt><dd>
  378. <table class="params">
  379. <tr><td class="paramname">attribute</td><td>The desired <a class="el" href="classSimXMLDocument.html">SimXMLDocument</a> attribute </td></tr>
  380. </table>
  381. </dd>
  382. </dl>
  383. <dl class="section return"><dt>Returns</dt><dd>Returns the value of the attribute converted to 32-bit floating-point value from string </dd></dl>
  384. </div>
  385. </div>
  386. <a id="ae98bba22de9d366fec14517102c84dc0" name="ae98bba22de9d366fec14517102c84dc0"></a>
  387. <h2 class="memtitle"><span class="permalink"><a href="#ae98bba22de9d366fec14517102c84dc0">&#9670;&#160;</a></span>attributeS32()</h2>
  388. <div class="memitem">
  389. <div class="memproto">
  390. <table class="memname">
  391. <tr>
  392. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> attributeS32 </td>
  393. <td>(</td>
  394. <td class="paramtype">string&#160;</td>
  395. <td class="paramname"><em>attribute</em></td><td>)</td>
  396. <td></td>
  397. </tr>
  398. </table>
  399. </div><div class="memdoc">
  400. <p>Get attribute value if it exists. </p><dl class="params"><dt>Parameters</dt><dd>
  401. <table class="params">
  402. <tr><td class="paramname">attribute</td><td>The desired <a class="el" href="classSimXMLDocument.html">SimXMLDocument</a> attribute </td></tr>
  403. </table>
  404. </dd>
  405. </dl>
  406. <dl class="section return"><dt>Returns</dt><dd>Returns the value of the attribute converted to 32-bit integer value from string </dd></dl>
  407. </div>
  408. </div>
  409. <a id="ac8bb3912a3ce86b15842e79d0b421204" name="ac8bb3912a3ce86b15842e79d0b421204"></a>
  410. <h2 class="memtitle"><span class="permalink"><a href="#ac8bb3912a3ce86b15842e79d0b421204">&#9670;&#160;</a></span>clear()</h2>
  411. <div class="memitem">
  412. <div class="memproto">
  413. <table class="memname">
  414. <tr>
  415. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> clear </td>
  416. <td>(</td>
  417. <td class="paramname"></td><td>)</td>
  418. <td></td>
  419. </tr>
  420. </table>
  421. </div><div class="memdoc">
  422. <p>Clear contents of XML document. </p><dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  423. </div>
  424. </div>
  425. <a id="a926ead67a784f455ddd56590f2928e76" name="a926ead67a784f455ddd56590f2928e76"></a>
  426. <h2 class="memtitle"><span class="permalink"><a href="#a926ead67a784f455ddd56590f2928e76">&#9670;&#160;</a></span>clearError()</h2>
  427. <div class="memitem">
  428. <div class="memproto">
  429. <table class="memname">
  430. <tr>
  431. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> clearError </td>
  432. <td>(</td>
  433. <td class="paramname"></td><td>)</td>
  434. <td></td>
  435. </tr>
  436. </table>
  437. </div><div class="memdoc">
  438. <p>Clear error description. </p><dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  439. </div>
  440. </div>
  441. <a id="ab18e6f3d333708ae66f0ede3d6628980" name="ab18e6f3d333708ae66f0ede3d6628980"></a>
  442. <h2 class="memtitle"><span class="permalink"><a href="#ab18e6f3d333708ae66f0ede3d6628980">&#9670;&#160;</a></span>elementValue()</h2>
  443. <div class="memitem">
  444. <div class="memproto">
  445. <table class="memname">
  446. <tr>
  447. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> elementValue </td>
  448. <td>(</td>
  449. <td class="paramname"></td><td>)</td>
  450. <td></td>
  451. </tr>
  452. </table>
  453. </div><div class="memdoc">
  454. <p>Get element value if it exists. </p><dl class="section return"><dt>Returns</dt><dd>A string with the desired value, or empty if not found. </dd></dl>
  455. </div>
  456. </div>
  457. <a id="a97bd3818b4d8df6a6d3b88b169cb7f6b" name="a97bd3818b4d8df6a6d3b88b169cb7f6b"></a>
  458. <h2 class="memtitle"><span class="permalink"><a href="#a97bd3818b4d8df6a6d3b88b169cb7f6b">&#9670;&#160;</a></span>firstAttribute()</h2>
  459. <div class="memitem">
  460. <div class="memproto">
  461. <table class="memname">
  462. <tr>
  463. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> firstAttribute </td>
  464. <td>(</td>
  465. <td class="paramname"></td><td>)</td>
  466. <td></td>
  467. </tr>
  468. </table>
  469. </div><div class="memdoc">
  470. <p>Obtain the name of the current element's first attribute. </p><dl class="section return"><dt>Returns</dt><dd>A string with the name of the first attribute </dd></dl>
  471. </div>
  472. </div>
  473. <a id="ae9dea42fcae074448f7cf65759642b7e" name="ae9dea42fcae074448f7cf65759642b7e"></a>
  474. <h2 class="memtitle"><span class="permalink"><a href="#ae9dea42fcae074448f7cf65759642b7e">&#9670;&#160;</a></span>getData()</h2>
  475. <div class="memitem">
  476. <div class="memproto">
  477. <table class="memname">
  478. <tr>
  479. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getData </td>
  480. <td>(</td>
  481. <td class="paramname"></td><td>)</td>
  482. <td></td>
  483. </tr>
  484. </table>
  485. </div><div class="memdoc">
  486. <p>Gets the text from the current stack element. </p><dl class="section return"><dt>Returns</dt><dd>Returns the desired text or empty string if failed (no text) </dd></dl>
  487. </div>
  488. </div>
  489. <a id="a93d1695df022a0419a10695bd75f12b8" name="a93d1695df022a0419a10695bd75f12b8"></a>
  490. <h2 class="memtitle"><span class="permalink"><a href="#a93d1695df022a0419a10695bd75f12b8">&#9670;&#160;</a></span>getErrorDesc()</h2>
  491. <div class="memitem">
  492. <div class="memproto">
  493. <table class="memname">
  494. <tr>
  495. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getErrorDesc </td>
  496. <td>(</td>
  497. <td class="paramname"></td><td>)</td>
  498. <td></td>
  499. </tr>
  500. </table>
  501. </div><div class="memdoc">
  502. <p>Get current error description. </p><dl class="section return"><dt>Returns</dt><dd>Returns a string with the error description </dd></dl>
  503. </div>
  504. </div>
  505. <a id="afab766445043570e6a82c14851366933" name="afab766445043570e6a82c14851366933"></a>
  506. <h2 class="memtitle"><span class="permalink"><a href="#afab766445043570e6a82c14851366933">&#9670;&#160;</a></span>getText()</h2>
  507. <div class="memitem">
  508. <div class="memproto">
  509. <table class="memname">
  510. <tr>
  511. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getText </td>
  512. <td>(</td>
  513. <td class="paramname"></td><td>)</td>
  514. <td></td>
  515. </tr>
  516. </table>
  517. </div><div class="memdoc">
  518. <p>Gets the text from the current stack element. </p><dl class="section return"><dt>Returns</dt><dd>Returns the desired text, or empty string on failure </dd></dl>
  519. </div>
  520. </div>
  521. <a id="a998a8bf9682fb0345edc8915dae22233" name="a998a8bf9682fb0345edc8915dae22233"></a>
  522. <h2 class="memtitle"><span class="permalink"><a href="#a998a8bf9682fb0345edc8915dae22233">&#9670;&#160;</a></span>lastAttribute()</h2>
  523. <div class="memitem">
  524. <div class="memproto">
  525. <table class="memname">
  526. <tr>
  527. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> lastAttribute </td>
  528. <td>(</td>
  529. <td class="paramname"></td><td>)</td>
  530. <td></td>
  531. </tr>
  532. </table>
  533. </div><div class="memdoc">
  534. <p>Obtain the name of the current element's last attribute. </p><dl class="section return"><dt>Returns</dt><dd>A string with the name of the last attribute </dd></dl>
  535. </div>
  536. </div>
  537. <a id="a4775645bb372e1d55bf448ca9a057ea7" name="a4775645bb372e1d55bf448ca9a057ea7"></a>
  538. <h2 class="memtitle"><span class="permalink"><a href="#a4775645bb372e1d55bf448ca9a057ea7">&#9670;&#160;</a></span>loadFile()</h2>
  539. <div class="memitem">
  540. <div class="memproto">
  541. <table class="memname">
  542. <tr>
  543. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> loadFile </td>
  544. <td>(</td>
  545. <td class="paramtype">string&#160;</td>
  546. <td class="paramname"><em>fileName</em></td><td>)</td>
  547. <td></td>
  548. </tr>
  549. </table>
  550. </div><div class="memdoc">
  551. <p>Load file from given filename. </p><dl class="params"><dt>Parameters</dt><dd>
  552. <table class="params">
  553. <tr><td class="paramname">fileName</td><td>The name of the desired file </td></tr>
  554. </table>
  555. </dd>
  556. </dl>
  557. <dl class="section return"><dt>Returns</dt><dd>Returns 1 on success and 0 otherwise </dd></dl>
  558. </div>
  559. </div>
  560. <a id="a3454a9d4fee84e52124b87dccb2b2af5" name="a3454a9d4fee84e52124b87dccb2b2af5"></a>
  561. <h2 class="memtitle"><span class="permalink"><a href="#a3454a9d4fee84e52124b87dccb2b2af5">&#9670;&#160;</a></span>nextAttribute()</h2>
  562. <div class="memitem">
  563. <div class="memproto">
  564. <table class="memname">
  565. <tr>
  566. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> nextAttribute </td>
  567. <td>(</td>
  568. <td class="paramname"></td><td>)</td>
  569. <td></td>
  570. </tr>
  571. </table>
  572. </div><div class="memdoc">
  573. <p>Get the name of the next attribute for the current element after a call to <a class="el" href="classSimXMLDocument.html#a97bd3818b4d8df6a6d3b88b169cb7f6b">firstAttribute()</a>. </p><dl class="section return"><dt>Returns</dt><dd>A string with the name of the next attribute </dd></dl>
  574. </div>
  575. </div>
  576. <a id="a187341af9440caadbda9c65e38bae3d7" name="a187341af9440caadbda9c65e38bae3d7"></a>
  577. <h2 class="memtitle"><span class="permalink"><a href="#a187341af9440caadbda9c65e38bae3d7">&#9670;&#160;</a></span>nextSiblingElement()</h2>
  578. <div class="memitem">
  579. <div class="memproto">
  580. <table class="memname">
  581. <tr>
  582. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> nextSiblingElement </td>
  583. <td>(</td>
  584. <td class="paramtype">string&#160;</td>
  585. <td class="paramname"><em>name</em></td><td>)</td>
  586. <td></td>
  587. </tr>
  588. </table>
  589. </div><div class="memdoc">
  590. <p>Set top element on stack to next element with given name. </p><dl class="params"><dt>Parameters</dt><dd>
  591. <table class="params">
  592. <tr><td class="paramname">name</td><td>The name of the element. </td></tr>
  593. </table>
  594. </dd>
  595. </dl>
  596. <dl class="section return"><dt>Returns</dt><dd>Returns true on success, false otherwise </dd></dl>
  597. </div>
  598. </div>
  599. <a id="af0730fad9d39b9fb5829aeab65acb297" name="af0730fad9d39b9fb5829aeab65acb297"></a>
  600. <h2 class="memtitle"><span class="permalink"><a href="#af0730fad9d39b9fb5829aeab65acb297">&#9670;&#160;</a></span>parse()</h2>
  601. <div class="memitem">
  602. <div class="memproto">
  603. <table class="memname">
  604. <tr>
  605. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> parse </td>
  606. <td>(</td>
  607. <td class="paramtype">string&#160;</td>
  608. <td class="paramname"><em>txtXML</em></td><td>)</td>
  609. <td></td>
  610. </tr>
  611. </table>
  612. </div><div class="memdoc">
  613. <p>Create document from XML string. </p><dl class="params"><dt>Parameters</dt><dd>
  614. <table class="params">
  615. <tr><td class="paramname">txtXML</td><td>The text of the XML document </td></tr>
  616. </table>
  617. </dd>
  618. </dl>
  619. <dl class="section return"><dt>Returns</dt><dd>Returns 1 on success </dd></dl>
  620. </div>
  621. </div>
  622. <a id="ab381b336a3144bf89707335ce3582318" name="ab381b336a3144bf89707335ce3582318"></a>
  623. <h2 class="memtitle"><span class="permalink"><a href="#ab381b336a3144bf89707335ce3582318">&#9670;&#160;</a></span>popElement()</h2>
  624. <div class="memitem">
  625. <div class="memproto">
  626. <table class="memname">
  627. <tr>
  628. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> popElement </td>
  629. <td>(</td>
  630. <td class="paramname"></td><td>)</td>
  631. <td></td>
  632. </tr>
  633. </table>
  634. </div><div class="memdoc">
  635. <p>Pop last element off of stack. </p><dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  636. </div>
  637. </div>
  638. <a id="ac786b845f39e57027b3e5b25ccb70398" name="ac786b845f39e57027b3e5b25ccb70398"></a>
  639. <h2 class="memtitle"><span class="permalink"><a href="#ac786b845f39e57027b3e5b25ccb70398">&#9670;&#160;</a></span>prevAttribute()</h2>
  640. <div class="memitem">
  641. <div class="memproto">
  642. <table class="memname">
  643. <tr>
  644. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> prevAttribute </td>
  645. <td>(</td>
  646. <td class="paramname"></td><td>)</td>
  647. <td></td>
  648. </tr>
  649. </table>
  650. </div><div class="memdoc">
  651. <p>Get the name of the previous attribute for the current element after a call to <a class="el" href="classSimXMLDocument.html#a998a8bf9682fb0345edc8915dae22233">lastAttribute()</a>. </p><dl class="section return"><dt>Returns</dt><dd>A string with the name of the previous attribute </dd></dl>
  652. </div>
  653. </div>
  654. <a id="a5cf2ba0766774e237cdfbc49d4fd6358" name="a5cf2ba0766774e237cdfbc49d4fd6358"></a>
  655. <h2 class="memtitle"><span class="permalink"><a href="#a5cf2ba0766774e237cdfbc49d4fd6358">&#9670;&#160;</a></span>pushChildElement()</h2>
  656. <div class="memitem">
  657. <div class="memproto">
  658. <table class="memname">
  659. <tr>
  660. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> pushChildElement </td>
  661. <td>(</td>
  662. <td class="paramtype">int&#160;</td>
  663. <td class="paramname"><em>index</em></td><td>)</td>
  664. <td></td>
  665. </tr>
  666. </table>
  667. </div><div class="memdoc">
  668. <p>Push the child element at the given index onto stack. </p><dl class="params"><dt>Parameters</dt><dd>
  669. <table class="params">
  670. <tr><td class="paramname">index</td><td>A nonnegative integer representing the index of the child element </td></tr>
  671. </table>
  672. </dd>
  673. </dl>
  674. <dl class="section return"><dt>Returns</dt><dd>Returns true on success, and false otherwise </dd></dl>
  675. </div>
  676. </div>
  677. <a id="aa2632292e6006dd960b81e8547829040" name="aa2632292e6006dd960b81e8547829040"></a>
  678. <h2 class="memtitle"><span class="permalink"><a href="#aa2632292e6006dd960b81e8547829040">&#9670;&#160;</a></span>pushFirstChildElement()</h2>
  679. <div class="memitem">
  680. <div class="memproto">
  681. <table class="memname">
  682. <tr>
  683. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> pushFirstChildElement </td>
  684. <td>(</td>
  685. <td class="paramtype">string&#160;</td>
  686. <td class="paramname"><em>name</em></td><td>)</td>
  687. <td></td>
  688. </tr>
  689. </table>
  690. </div><div class="memdoc">
  691. <p>Push first child element with given name onto stack. </p><dl class="params"><dt>Parameters</dt><dd>
  692. <table class="params">
  693. <tr><td class="paramname">name</td><td>The name of the child element </td></tr>
  694. </table>
  695. </dd>
  696. </dl>
  697. <dl class="section return"><dt>Returns</dt><dd>returns true on success, false otherwise. </dd></dl>
  698. </div>
  699. </div>
  700. <a id="a31b82c65567a999a3ac712a7e0b66edc" name="a31b82c65567a999a3ac712a7e0b66edc"></a>
  701. <h2 class="memtitle"><span class="permalink"><a href="#a31b82c65567a999a3ac712a7e0b66edc">&#9670;&#160;</a></span>pushNewElement()</h2>
  702. <div class="memitem">
  703. <div class="memproto">
  704. <table class="memname">
  705. <tr>
  706. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> pushNewElement </td>
  707. <td>(</td>
  708. <td class="paramtype">string&#160;</td>
  709. <td class="paramname"><em>name</em></td><td>)</td>
  710. <td></td>
  711. </tr>
  712. </table>
  713. </div><div class="memdoc">
  714. <p>Create new element as child of current stack element and push new element on to stack. </p><dl class="params"><dt>Parameters</dt><dd>
  715. <table class="params">
  716. <tr><td class="paramname">name</td><td>The anme of the new element </td></tr>
  717. </table>
  718. </dd>
  719. </dl>
  720. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  721. </div>
  722. </div>
  723. <a id="a73c8e877c9ad432db10fb4d18dacd227" name="a73c8e877c9ad432db10fb4d18dacd227"></a>
  724. <h2 class="memtitle"><span class="permalink"><a href="#a73c8e877c9ad432db10fb4d18dacd227">&#9670;&#160;</a></span>readComment()</h2>
  725. <div class="memitem">
  726. <div class="memproto">
  727. <table class="memname">
  728. <tr>
  729. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> readComment </td>
  730. <td>(</td>
  731. <td class="paramtype">S32&#160;</td>
  732. <td class="paramname"><em>index</em></td><td>)</td>
  733. <td></td>
  734. </tr>
  735. </table>
  736. </div><div class="memdoc">
  737. <p>Returns the comment at the specified index. </p><dl class="params"><dt>Parameters</dt><dd>
  738. <table class="params">
  739. <tr><td class="paramname">index</td><td>The index of the desired comment as a nonnegative integer value </td></tr>
  740. </table>
  741. </dd>
  742. </dl>
  743. <dl class="section return"><dt>Returns</dt><dd>The comment as a string </dd></dl>
  744. </div>
  745. </div>
  746. <a id="a267fcc4de41221da0969abbe0257cf09" name="a267fcc4de41221da0969abbe0257cf09"></a>
  747. <h2 class="memtitle"><span class="permalink"><a href="#a267fcc4de41221da0969abbe0257cf09">&#9670;&#160;</a></span>removeText()</h2>
  748. <div class="memitem">
  749. <div class="memproto">
  750. <table class="memname">
  751. <tr>
  752. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> removeText </td>
  753. <td>(</td>
  754. <td class="paramname"></td><td>)</td>
  755. <td></td>
  756. </tr>
  757. </table>
  758. </div><div class="memdoc">
  759. <p>Remove any text on the current stack element. </p><dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  760. </div>
  761. </div>
  762. <a id="ad20897c5c8bd47f5d4005989bead0e55" name="ad20897c5c8bd47f5d4005989bead0e55"></a>
  763. <h2 class="memtitle"><span class="permalink"><a href="#ad20897c5c8bd47f5d4005989bead0e55">&#9670;&#160;</a></span>reset()</h2>
  764. <div class="memitem">
  765. <div class="memproto">
  766. <table class="memname">
  767. <tr>
  768. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> reset </td>
  769. <td>(</td>
  770. <td class="paramname"></td><td>)</td>
  771. <td></td>
  772. </tr>
  773. </table>
  774. </div><div class="memdoc">
  775. <p>Set this to default state at construction. </p><dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  776. </div>
  777. </div>
  778. <a id="a037860d940d6efc41aa0f6bc0c6d6b84" name="a037860d940d6efc41aa0f6bc0c6d6b84"></a>
  779. <h2 class="memtitle"><span class="permalink"><a href="#a037860d940d6efc41aa0f6bc0c6d6b84">&#9670;&#160;</a></span>saveFile()</h2>
  780. <div class="memitem">
  781. <div class="memproto">
  782. <table class="memname">
  783. <tr>
  784. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> saveFile </td>
  785. <td>(</td>
  786. <td class="paramtype">string&#160;</td>
  787. <td class="paramname"><em>fileName</em></td><td>)</td>
  788. <td></td>
  789. </tr>
  790. </table>
  791. </div><div class="memdoc">
  792. <p>Save file to given filename. </p><dl class="params"><dt>Parameters</dt><dd>
  793. <table class="params">
  794. <tr><td class="paramname">fileName</td><td>A string presenting the filename to save the XML document as </td></tr>
  795. </table>
  796. </dd>
  797. </dl>
  798. <dl class="section return"><dt>Returns</dt><dd>Returns 1 on success, and 0 otherwise </dd></dl>
  799. </div>
  800. </div>
  801. <a id="a5a21ea9de7a3577b77f5dbe26e9f50d8" name="a5a21ea9de7a3577b77f5dbe26e9f50d8"></a>
  802. <h2 class="memtitle"><span class="permalink"><a href="#a5a21ea9de7a3577b77f5dbe26e9f50d8">&#9670;&#160;</a></span>setAttribute()</h2>
  803. <div class="memitem">
  804. <div class="memproto">
  805. <table class="memname">
  806. <tr>
  807. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setAttribute </td>
  808. <td>(</td>
  809. <td class="paramtype">string&#160;</td>
  810. <td class="paramname"><em>attributeName</em>, </td>
  811. </tr>
  812. <tr>
  813. <td class="paramkey"></td>
  814. <td></td>
  815. <td class="paramtype">string&#160;</td>
  816. <td class="paramname"><em>attributeValue</em>&#160;</td>
  817. </tr>
  818. <tr>
  819. <td></td>
  820. <td>)</td>
  821. <td></td><td></td>
  822. </tr>
  823. </table>
  824. </div><div class="memdoc">
  825. <p>Set attribute of top stack element to given value. </p><dl class="params"><dt>Parameters</dt><dd>
  826. <table class="params">
  827. <tr><td class="paramname">attributeName</td><td>The name of the attribute of the element you wish to set </td></tr>
  828. <tr><td class="paramname">attributeValue</td><td>The value you wish to set the given attribute to </td></tr>
  829. </table>
  830. </dd>
  831. </dl>
  832. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  833. </div>
  834. </div>
  835. <a id="ae6fe2d098e65cc33f45d7a58f6cd83b7" name="ae6fe2d098e65cc33f45d7a58f6cd83b7"></a>
  836. <h2 class="memtitle"><span class="permalink"><a href="#ae6fe2d098e65cc33f45d7a58f6cd83b7">&#9670;&#160;</a></span>setObjectAttributes()</h2>
  837. <div class="memitem">
  838. <div class="memproto">
  839. <table class="memname">
  840. <tr>
  841. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setObjectAttributes </td>
  842. <td>(</td>
  843. <td class="paramtype">string&#160;</td>
  844. <td class="paramname"><em>attributeValue</em></td><td>)</td>
  845. <td></td>
  846. </tr>
  847. </table>
  848. </div><div class="memdoc">
  849. <p>Set attribute of top stack element to given value. </p><dl class="params"><dt>Parameters</dt><dd>
  850. <table class="params">
  851. <tr><td class="paramname">attributeValue</td><td>The value you wish to set the given attribute to </td></tr>
  852. </table>
  853. </dd>
  854. </dl>
  855. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  856. </div>
  857. </div>
  858. </div><!-- contents -->
  859. <!-- start footer part -->
  860. <hr class="footer"/><address class="footer"><small>
  861. 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
  862. </small></address>
  863. </body>
  864. </html>