| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.8.3.1"/>
- <title>TorqueScript Reference: SimXMLDocument Class Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td style="padding-left: 0.5em;">
- <div id="projectname">TorqueScript Reference
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.3.1 -->
- <div id="navrow1" class="tabs">
- <ul class="tablist">
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li><a href="pages.html"><span>Related Pages</span></a></li>
- <li><a href="modules.html"><span>Modules</span></a></li>
- <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
- </ul>
- </div>
- <div id="navrow2" class="tabs2">
- <ul class="tablist">
- <li><a href="annotated.html"><span>Class List</span></a></li>
- <li><a href="classes.html"><span>Class Index</span></a></li>
- <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
- <li><a href="functions.html"><span>Class Members</span></a></li>
- </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="classSimXMLDocument-members.html">List of all members</a> </div>
- <div class="headertitle">
- <div class="title">SimXMLDocument Class Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>Inherits <a class="el" href="classSimObject.html">SimObject</a>.</p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:aa2f9ffceadf2e149d66ebd9ba4527752"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#aa2f9ffceadf2e149d66ebd9ba4527752">addComment</a> (string comment)</td></tr>
- <tr class="separator:aa2f9ffceadf2e149d66ebd9ba4527752"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2845b7ec8d8c307b3ab88ce29c380e93"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a2845b7ec8d8c307b3ab88ce29c380e93">addData</a> (string text)</td></tr>
- <tr class="separator:a2845b7ec8d8c307b3ab88ce29c380e93"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3e6cc0aef931838972cb3adfcc780b44"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a3e6cc0aef931838972cb3adfcc780b44">addHeader</a> ()</td></tr>
- <tr class="separator:a3e6cc0aef931838972cb3adfcc780b44"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a203646719edb7b16b29d179dcc56af94"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a203646719edb7b16b29d179dcc56af94">addNewElement</a> (string name)</td></tr>
- <tr class="separator:a203646719edb7b16b29d179dcc56af94"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac610bcfeeeec91977cec5bee9d53d3e9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#ac610bcfeeeec91977cec5bee9d53d3e9">addText</a> (string text)</td></tr>
- <tr class="separator:ac610bcfeeeec91977cec5bee9d53d3e9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aca76734afa3853c527b6aba9c0f0cd28"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#aca76734afa3853c527b6aba9c0f0cd28">attribute</a> (string attribute)</td></tr>
- <tr class="separator:aca76734afa3853c527b6aba9c0f0cd28"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a596cda3b1efad3fa0d090f6a2a911061"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </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>
- <tr class="separator:a596cda3b1efad3fa0d090f6a2a911061"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5532d1f6e289931b5e4e8b45160465da"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </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>
- <tr class="separator:a5532d1f6e289931b5e4e8b45160465da"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae98bba22de9d366fec14517102c84dc0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </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>
- <tr class="separator:ae98bba22de9d366fec14517102c84dc0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac8bb3912a3ce86b15842e79d0b421204"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#ac8bb3912a3ce86b15842e79d0b421204">clear</a> ()</td></tr>
- <tr class="separator:ac8bb3912a3ce86b15842e79d0b421204"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a926ead67a784f455ddd56590f2928e76"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a926ead67a784f455ddd56590f2928e76">clearError</a> ()</td></tr>
- <tr class="separator:a926ead67a784f455ddd56590f2928e76"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab18e6f3d333708ae66f0ede3d6628980"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#ab18e6f3d333708ae66f0ede3d6628980">elementValue</a> ()</td></tr>
- <tr class="separator:ab18e6f3d333708ae66f0ede3d6628980"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a97bd3818b4d8df6a6d3b88b169cb7f6b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a97bd3818b4d8df6a6d3b88b169cb7f6b">firstAttribute</a> ()</td></tr>
- <tr class="separator:a97bd3818b4d8df6a6d3b88b169cb7f6b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae9dea42fcae074448f7cf65759642b7e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#ae9dea42fcae074448f7cf65759642b7e">getData</a> ()</td></tr>
- <tr class="separator:ae9dea42fcae074448f7cf65759642b7e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a93d1695df022a0419a10695bd75f12b8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a93d1695df022a0419a10695bd75f12b8">getErrorDesc</a> ()</td></tr>
- <tr class="separator:a93d1695df022a0419a10695bd75f12b8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afab766445043570e6a82c14851366933"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#afab766445043570e6a82c14851366933">getText</a> ()</td></tr>
- <tr class="separator:afab766445043570e6a82c14851366933"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a998a8bf9682fb0345edc8915dae22233"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a998a8bf9682fb0345edc8915dae22233">lastAttribute</a> ()</td></tr>
- <tr class="separator:a998a8bf9682fb0345edc8915dae22233"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4775645bb372e1d55bf448ca9a057ea7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </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>
- <tr class="separator:a4775645bb372e1d55bf448ca9a057ea7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3454a9d4fee84e52124b87dccb2b2af5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a3454a9d4fee84e52124b87dccb2b2af5">nextAttribute</a> ()</td></tr>
- <tr class="separator:a3454a9d4fee84e52124b87dccb2b2af5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a187341af9440caadbda9c65e38bae3d7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a187341af9440caadbda9c65e38bae3d7">nextSiblingElement</a> (string name)</td></tr>
- <tr class="separator:a187341af9440caadbda9c65e38bae3d7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af0730fad9d39b9fb5829aeab65acb297"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#af0730fad9d39b9fb5829aeab65acb297">parse</a> (string txtXML)</td></tr>
- <tr class="separator:af0730fad9d39b9fb5829aeab65acb297"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab381b336a3144bf89707335ce3582318"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#ab381b336a3144bf89707335ce3582318">popElement</a> ()</td></tr>
- <tr class="separator:ab381b336a3144bf89707335ce3582318"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac786b845f39e57027b3e5b25ccb70398"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#ac786b845f39e57027b3e5b25ccb70398">prevAttribute</a> ()</td></tr>
- <tr class="separator:ac786b845f39e57027b3e5b25ccb70398"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5cf2ba0766774e237cdfbc49d4fd6358"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a5cf2ba0766774e237cdfbc49d4fd6358">pushChildElement</a> (int index)</td></tr>
- <tr class="separator:a5cf2ba0766774e237cdfbc49d4fd6358"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa2632292e6006dd960b81e8547829040"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#aa2632292e6006dd960b81e8547829040">pushFirstChildElement</a> (string name)</td></tr>
- <tr class="separator:aa2632292e6006dd960b81e8547829040"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a31b82c65567a999a3ac712a7e0b66edc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a31b82c65567a999a3ac712a7e0b66edc">pushNewElement</a> (string name)</td></tr>
- <tr class="separator:a31b82c65567a999a3ac712a7e0b66edc"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a73c8e877c9ad432db10fb4d18dacd227"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a73c8e877c9ad432db10fb4d18dacd227">readComment</a> (S32 index)</td></tr>
- <tr class="separator:a73c8e877c9ad432db10fb4d18dacd227"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a267fcc4de41221da0969abbe0257cf09"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a267fcc4de41221da0969abbe0257cf09">removeText</a> ()</td></tr>
- <tr class="separator:a267fcc4de41221da0969abbe0257cf09"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad20897c5c8bd47f5d4005989bead0e55"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#ad20897c5c8bd47f5d4005989bead0e55">reset</a> ()</td></tr>
- <tr class="separator:ad20897c5c8bd47f5d4005989bead0e55"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a037860d940d6efc41aa0f6bc0c6d6b84"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </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>
- <tr class="separator:a037860d940d6efc41aa0f6bc0c6d6b84"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5a21ea9de7a3577b77f5dbe26e9f50d8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#a5a21ea9de7a3577b77f5dbe26e9f50d8">setAttribute</a> (string attributeName, string attributeValue)</td></tr>
- <tr class="separator:a5a21ea9de7a3577b77f5dbe26e9f50d8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae6fe2d098e65cc33f45d7a58f6cd83b7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimXMLDocument.html#ae6fe2d098e65cc33f45d7a58f6cd83b7">setObjectAttributes</a> (string attributeValue)</td></tr>
- <tr class="separator:ae6fe2d098e65cc33f45d7a58f6cd83b7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_methods_classSimObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classSimObject')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classSimObject.html">SimObject</a></td></tr>
- <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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a22437f451ceb1429fa2a3be23d523954">clone</a> ([copyDynamicFields=false]?)</td></tr>
- <tr class="separator:a22437f451ceb1429fa2a3be23d523954 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7a4721d0a51e952c211e9b0fea4d8090">delete</a> ()</td></tr>
- <tr class="separator:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a929e1325a515b279faca90a65028782e">getId</a> ()</td></tr>
- <tr class="separator:a929e1325a515b279faca90a65028782e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a4f673cd959711ae09927e7c44dae5fdb">setName</a> (newName)</td></tr>
- <tr class="separator:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a78ee178b6a73658d65ca60da4d1e6683">getName</a> ()</td></tr>
- <tr class="separator:a78ee178b6a73658d65ca60da4d1e6683 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab8b0f8b874af628d7204d9cc2630ced7">getClassNamespace</a> ()</td></tr>
- <tr class="separator:ab8b0f8b874af628d7204d9cc2630ced7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a6e266d4432d70cad58461d96e1d2cbdf">getSuperClassNamespace</a> ()</td></tr>
- <tr class="separator:a6e266d4432d70cad58461d96e1d2cbdf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a847e859bcc5b58df83fa7f331c167c32 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a847e859bcc5b58df83fa7f331c167c32">setClassNamespace</a> (nameSpace)</td></tr>
- <tr class="separator:a847e859bcc5b58df83fa7f331c167c32 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9cbf471b97387d5bdefb88f92094ad54">setSuperClassNamespace</a> ()</td></tr>
- <tr class="separator:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a8f4e85d0903526235ed2ca86df69cdef">isMethod</a> (string methodName)</td></tr>
- <tr class="separator:a8f4e85d0903526235ed2ca86df69cdef inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa9873d392a76100738de2337c882f477">call</a> (methodName,[args]*)</td></tr>
- <tr class="separator:aa9873d392a76100738de2337c882f477 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1810f5aba25efd242c24232c2c2bbd1a">dumpClassHierarchy</a> ()</td></tr>
- <tr class="separator:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#accd2600060dbaee3a3b41aed4034c63c">dump</a> ()</td></tr>
- <tr class="separator:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a66ac731a8dc088fe8c8ab17bf7c9eecd">isMemberOfClass</a> (string classname)</td></tr>
- <tr class="separator:a66ac731a8dc088fe8c8ab17bf7c9eecd inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a3e97a324df2af082cdb089491757ce11">getClassName</a> ()</td></tr>
- <tr class="separator:a3e97a324df2af082cdb089491757ce11 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#abc2222a9649b5c033810e753b07f26a3">getFieldValue</a> (fieldName)</td></tr>
- <tr class="separator:abc2222a9649b5c033810e753b07f26a3 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1084f1964e446b3d279943cf6e575069">setFieldValue</a> (fieldName, value)</td></tr>
- <tr class="separator:a1084f1964e446b3d279943cf6e575069 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7543b8dc494ec0d9034cb73ae504f3ca">getDynamicFieldCount</a> ()</td></tr>
- <tr class="separator:a7543b8dc494ec0d9034cb73ae504f3ca inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0e143217119b68d557d17ac2f13b173e">getDynamicField</a> (index)</td></tr>
- <tr class="separator:a0e143217119b68d557d17ac2f13b173e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af2e74f6b683da8d2085f0991dab7948b">getFieldCount</a> ()</td></tr>
- <tr class="separator:af2e74f6b683da8d2085f0991dab7948b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ac636f89189406eef1b401292459b1a3b">getField</a> (int index)</td></tr>
- <tr class="separator:ac636f89189406eef1b401292459b1a3b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa8f68d1e6d8c6601c39b3f676f0e9c70">setProgenitorFile</a> (file)</td></tr>
- <tr class="separator:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a88c8d99755a07ac4648360dd40ff67a5">getProgenitorFile</a> ()</td></tr>
- <tr class="separator:a88c8d99755a07ac4648360dd40ff67a5 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a367706e675179342e6153c45f1ba06ae">getType</a> ()</td></tr>
- <tr class="separator:a367706e675179342e6153c45f1ba06ae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0570b7f6eb94a0ed941fd75f6f01555b">getFieldType</a> (fieldName)</td></tr>
- <tr class="separator:a0570b7f6eb94a0ed941fd75f6f01555b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5aaca360a719feabae0e4e57b921deae">setInternalName</a> (string InternalName)</td></tr>
- <tr class="separator:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af9f341b474a28f4bcf79bc02439b7c18">getInternalName</a> ()</td></tr>
- <tr class="separator:af9f341b474a28f4bcf79bc02439b7c18 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a986f1b4a76969bac5dfd50b22af8dec6">isChildOfGroup</a> (groupID)</td></tr>
- <tr class="separator:a986f1b4a76969bac5dfd50b22af8dec6 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ae329d6593bb3f9b8046e7cae693ccc09">getGroup</a> ()</td></tr>
- <tr class="separator:ae329d6593bb3f9b8046e7cae693ccc09 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a2dd2c7a365c19267d7a26923c7616afd">startTimer</a> (callbackFunction, float timePeriod,[repeat]?)</td></tr>
- <tr class="separator:a2dd2c7a365c19267d7a26923c7616afd inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa6f6bfef028c7b053444cbd48567d286">stopTimer</a> ()</td></tr>
- <tr class="separator:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5807c03d2b725a54732d09b53d5da631">isTimerActive</a> ()</td></tr>
- <tr class="separator:a5807c03d2b725a54732d09b53d5da631 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a6b70a037ad6cea86b10fd5188f42bf52">schedule</a> (time, command,[arg]*)</td></tr>
- <tr class="separator:a6b70a037ad6cea86b10fd5188f42bf52 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </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>
- <tr class="separator:ad4944a7132f9ee90f801f4cd57014836 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a216228c27df224ac5e8d3590494bfb3f inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a216228c27df224ac5e8d3590494bfb3f">addFieldFilter</a> (fieldName)</td></tr>
- <tr class="separator:a216228c27df224ac5e8d3590494bfb3f inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad517bd83c1c853985ab07cd22775c43d inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad517bd83c1c853985ab07cd22775c43d">removeFieldFilter</a> (fieldName)</td></tr>
- <tr class="separator:ad517bd83c1c853985ab07cd22775c43d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a class="anchor" id="aa2f9ffceadf2e149d66ebd9ba4527752"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void addComment </td>
- <td>(</td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>comment</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Add the given comment as a child of current stack element. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">comment</td><td>The desired comment to add </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a2845b7ec8d8c307b3ab88ce29c380e93"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void addData </td>
- <td>(</td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>text</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Add the given text as a child of current stack element. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">The</td><td>desired text to add </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a3e6cc0aef931838972cb3adfcc780b44"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void addHeader </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Add XML header to document. </p>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a203646719edb7b16b29d179dcc56af94"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void addNewElement </td>
- <td>(</td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>name</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <table class="params">
- <tr><td class="paramname">name</td><td>The anme of the new element </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ac610bcfeeeec91977cec5bee9d53d3e9"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void addText </td>
- <td>(</td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>text</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Add the given text as a child of current stack element. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">text</td><td>The desired text to add </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="aca76734afa3853c527b6aba9c0f0cd28"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> attribute </td>
- <td>(</td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>attribute</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get attribute value if it exists. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">attribute</td><td>The desired <a class="el" href="classSimXMLDocument.html">SimXMLDocument</a> attribute </td></tr>
- </table>
- </dd>
- </dl>
- <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>
- </div>
- </div>
- <a class="anchor" id="a596cda3b1efad3fa0d090f6a2a911061"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> attributeExists </td>
- <td>(</td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>attribute</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get true if named attribute exists. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">attribute</td><td>The desired attribute's name </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns true if attribute exists and false otherwise </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a5532d1f6e289931b5e4e8b45160465da"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> attributeF32 </td>
- <td>(</td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>attribute</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get attribute value if it exists. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">attribute</td><td>The desired <a class="el" href="classSimXMLDocument.html">SimXMLDocument</a> attribute </td></tr>
- </table>
- </dd>
- </dl>
- <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>
- </div>
- </div>
- <a class="anchor" id="ae98bba22de9d366fec14517102c84dc0"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> attributeS32 </td>
- <td>(</td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>attribute</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get attribute value if it exists. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">attribute</td><td>The desired <a class="el" href="classSimXMLDocument.html">SimXMLDocument</a> attribute </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns the value of the attribute converted to 32-bit integer value from string </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ac8bb3912a3ce86b15842e79d0b421204"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void clear </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Clear contents of XML document. </p>
- <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a926ead67a784f455ddd56590f2928e76"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void clearError </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Clear error description. </p>
- <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ab18e6f3d333708ae66f0ede3d6628980"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> elementValue </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="a97bd3818b4d8df6a6d3b88b169cb7f6b"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> firstAttribute </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="ae9dea42fcae074448f7cf65759642b7e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getData </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="a93d1695df022a0419a10695bd75f12b8"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getErrorDesc </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get current error description. </p>
- <dl class="section return"><dt>Returns</dt><dd>Returns a string with the error description </dd></dl>
- </div>
- </div>
- <a class="anchor" id="afab766445043570e6a82c14851366933"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getText </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="a998a8bf9682fb0345edc8915dae22233"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> lastAttribute </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="a4775645bb372e1d55bf448ca9a057ea7"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> loadFile </td>
- <td>(</td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>fileName</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Load file from given filename. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">fileName</td><td>The name of the desired file </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns 1 on success and 0 otherwise </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a3454a9d4fee84e52124b87dccb2b2af5"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> nextAttribute </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="a187341af9440caadbda9c65e38bae3d7"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> nextSiblingElement </td>
- <td>(</td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>name</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set top element on stack to next element with given name. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">name</td><td>The name of the element. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns true on success, false otherwise </dd></dl>
- </div>
- </div>
- <a class="anchor" id="af0730fad9d39b9fb5829aeab65acb297"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> parse </td>
- <td>(</td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>txtXML</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Create document from XML string. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">txtXML</td><td>The text of the XML document </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns 1 on success </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ab381b336a3144bf89707335ce3582318"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void popElement </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Pop last element off of stack. </p>
- <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ac786b845f39e57027b3e5b25ccb70398"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> prevAttribute </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="a5cf2ba0766774e237cdfbc49d4fd6358"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> pushChildElement </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>index</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Push the child element at the given index onto stack. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">index</td><td>A nonnegative integer representing the index of the child element </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns true on success, and false otherwise </dd></dl>
- </div>
- </div>
- <a class="anchor" id="aa2632292e6006dd960b81e8547829040"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> pushFirstChildElement </td>
- <td>(</td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>name</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Push first child element with given name onto stack. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">name</td><td>The name of the child element </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>returns true on success, false otherwise. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a31b82c65567a999a3ac712a7e0b66edc"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void pushNewElement </td>
- <td>(</td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>name</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <table class="params">
- <tr><td class="paramname">name</td><td>The anme of the new element </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a73c8e877c9ad432db10fb4d18dacd227"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> readComment </td>
- <td>(</td>
- <td class="paramtype">S32 </td>
- <td class="paramname"><em>index</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the comment at the specified index. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">index</td><td>The index of the desired comment as a nonnegative integer value </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>The comment as a string </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a267fcc4de41221da0969abbe0257cf09"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void removeText </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Remove any text on the current stack element. </p>
- <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ad20897c5c8bd47f5d4005989bead0e55"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void reset </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set this to default state at construction. </p>
- <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a037860d940d6efc41aa0f6bc0c6d6b84"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> saveFile </td>
- <td>(</td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>fileName</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Save file to given filename. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">fileName</td><td>A string presenting the filename to save the XML document as </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns 1 on success, and 0 otherwise </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a5a21ea9de7a3577b77f5dbe26e9f50d8"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void setAttribute </td>
- <td>(</td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>attributeName</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>attributeValue</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set attribute of top stack element to given value. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">attributeName</td><td>The name of the attribute of the element you wish to set </td></tr>
- <tr><td class="paramname">attributeValue</td><td>The value you wish to set the given attribute to </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ae6fe2d098e65cc33f45d7a58f6cd83b7"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void setObjectAttributes </td>
- <td>(</td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>attributeValue</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set attribute of top stack element to given value. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">attributeValue</td><td>The value you wish to set the given attribute to </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- </div>
- </div>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.3.1
- </small></address>
- </body>
- </html>
|