classSimXMLDocument.html 58 KB

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