classTaml.html 42 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566
  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: Taml 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="classTaml-members.html">List of all members</a> </div>
  51. <div class="headertitle">
  52. <div class="title">Taml 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:afd822ddde9d8d1f62e99a9c3e284e8d1"><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="classTaml.html#afd822ddde9d8d1f62e99a9c3e284e8d1">getAutoFormat</a> ()</td></tr>
  60. <tr class="separator:afd822ddde9d8d1f62e99a9c3e284e8d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61. <tr class="memitem:ac808107dbbc2b041f8146d679f02b25e"><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="classTaml.html#ac808107dbbc2b041f8146d679f02b25e">getAutoFormatBinaryExtension</a> ()</td></tr>
  62. <tr class="separator:ac808107dbbc2b041f8146d679f02b25e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:a004ac73cb71ec7221f4d9e32824bc9b5"><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="classTaml.html#a004ac73cb71ec7221f4d9e32824bc9b5">getAutoFormatXmlExtension</a> ()</td></tr>
  64. <tr class="separator:a004ac73cb71ec7221f4d9e32824bc9b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:a0ee4e3b811a0ba390018bd1590e0bb58"><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="classTaml.html#a0ee4e3b811a0ba390018bd1590e0bb58">getBinaryCompression</a> ()</td></tr>
  66. <tr class="separator:a0ee4e3b811a0ba390018bd1590e0bb58"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr class="memitem:a2b59cd5ab6324ae81ec0348cd5da7fb8"><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="classTaml.html#a2b59cd5ab6324ae81ec0348cd5da7fb8">getFormat</a> ()</td></tr>
  68. <tr class="separator:a2b59cd5ab6324ae81ec0348cd5da7fb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. <tr class="memitem:a44ba12bc3d31a6c121b1cc0005502b5e"><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="classTaml.html#a44ba12bc3d31a6c121b1cc0005502b5e">getJSONStrict</a> ()</td></tr>
  70. <tr class="separator:a44ba12bc3d31a6c121b1cc0005502b5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:a3ded3224ff4497b27146971f9e1425d3"><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="classTaml.html#a3ded3224ff4497b27146971f9e1425d3">getProgenitorUpdate</a> ()</td></tr>
  72. <tr class="separator:a3ded3224ff4497b27146971f9e1425d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:abc3567ce2535571936ebb7a873ce1e6d"><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="classTaml.html#abc3567ce2535571936ebb7a873ce1e6d">getWriteDefaults</a> ()</td></tr>
  74. <tr class="separator:abc3567ce2535571936ebb7a873ce1e6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:a9d1b0515b848a69d7ad5b81cd83d77c7"><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="classTaml.html#a9d1b0515b848a69d7ad5b81cd83d77c7">read</a> (filename)</td></tr>
  76. <tr class="separator:a9d1b0515b848a69d7ad5b81cd83d77c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:a94fe0663c1139e75526dea549b54a1af"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTaml.html#a94fe0663c1139e75526dea549b54a1af">setAutoFormat</a> (autoFormat)</td></tr>
  78. <tr class="separator:a94fe0663c1139e75526dea549b54a1af"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:aaec13623de6a1d1ec1e8610184b81fd0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTaml.html#aaec13623de6a1d1ec1e8610184b81fd0">setAutoFormatBinaryExtension</a> (extension)</td></tr>
  80. <tr class="separator:aaec13623de6a1d1ec1e8610184b81fd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a837b478e51ee798106a18032fbd1637c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTaml.html#a837b478e51ee798106a18032fbd1637c">setAutoFormatXmlExtension</a> (extension)</td></tr>
  82. <tr class="separator:a837b478e51ee798106a18032fbd1637c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:a4729343b7637a9e33d691cf77baba11e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTaml.html#a4729343b7637a9e33d691cf77baba11e">setBinaryCompression</a> (compressed)</td></tr>
  84. <tr class="separator:a4729343b7637a9e33d691cf77baba11e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:ab05c70d3c9b31e17cd439e2e70190518"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTaml.html#ab05c70d3c9b31e17cd439e2e70190518">setFormat</a> (format)</td></tr>
  86. <tr class="separator:ab05c70d3c9b31e17cd439e2e70190518"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:afe5d248747ab517a8a8bcf1e29d2d991"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTaml.html#afe5d248747ab517a8a8bcf1e29d2d991">setJSONStrict</a> (jsonStrict)</td></tr>
  88. <tr class="separator:afe5d248747ab517a8a8bcf1e29d2d991"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:ad3f6baef92730b73d8664605553fee24"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTaml.html#ad3f6baef92730b73d8664605553fee24">setProgenitorUpdate</a> (progenitorUpdate)</td></tr>
  90. <tr class="separator:ad3f6baef92730b73d8664605553fee24"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:ae3c8e893048cd7b2078fdd7ca379d505"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTaml.html#ae3c8e893048cd7b2078fdd7ca379d505">setWriteDefaults</a> (writeDefaults)</td></tr>
  92. <tr class="separator:ae3c8e893048cd7b2078fdd7ca379d505"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a8c9bf6a0151aa6d20178382f63f8b08f"><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="classTaml.html#a8c9bf6a0151aa6d20178382f63f8b08f">write</a> (object, filename)</td></tr>
  94. <tr class="separator:a8c9bf6a0151aa6d20178382f63f8b08f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <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>
  96. <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>
  97. <tr class="separator:a22437f451ceb1429fa2a3be23d523954 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <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>
  99. <tr class="separator:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <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>
  101. <tr class="separator:a929e1325a515b279faca90a65028782e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <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>
  103. <tr class="separator:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <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>
  105. <tr class="separator:a78ee178b6a73658d65ca60da4d1e6683 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <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>
  107. <tr class="separator:ab8b0f8b874af628d7204d9cc2630ced7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <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>
  109. <tr class="separator:a6e266d4432d70cad58461d96e1d2cbdf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <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>
  111. <tr class="separator:a847e859bcc5b58df83fa7f331c167c32 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <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>
  113. <tr class="separator:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <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>
  115. <tr class="separator:a8f4e85d0903526235ed2ca86df69cdef inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <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>
  117. <tr class="separator:aa9873d392a76100738de2337c882f477 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <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>
  119. <tr class="separator:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <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>
  121. <tr class="separator:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <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>
  123. <tr class="separator:a66ac731a8dc088fe8c8ab17bf7c9eecd inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <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>
  125. <tr class="separator:a3e97a324df2af082cdb089491757ce11 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <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>
  127. <tr class="separator:abc2222a9649b5c033810e753b07f26a3 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <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>
  129. <tr class="separator:a1084f1964e446b3d279943cf6e575069 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <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>
  131. <tr class="separator:a7543b8dc494ec0d9034cb73ae504f3ca inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <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>
  133. <tr class="separator:a0e143217119b68d557d17ac2f13b173e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <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>
  135. <tr class="separator:af2e74f6b683da8d2085f0991dab7948b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <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>
  137. <tr class="separator:ac636f89189406eef1b401292459b1a3b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <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>
  139. <tr class="separator:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <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>
  141. <tr class="separator:a88c8d99755a07ac4648360dd40ff67a5 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <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>
  143. <tr class="separator:a367706e675179342e6153c45f1ba06ae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <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>
  145. <tr class="separator:a0570b7f6eb94a0ed941fd75f6f01555b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <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>
  147. <tr class="separator:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <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>
  149. <tr class="separator:af9f341b474a28f4bcf79bc02439b7c18 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <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>
  151. <tr class="separator:a986f1b4a76969bac5dfd50b22af8dec6 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <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>
  153. <tr class="separator:ae329d6593bb3f9b8046e7cae693ccc09 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <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>
  155. <tr class="separator:a2dd2c7a365c19267d7a26923c7616afd inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <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>
  157. <tr class="separator:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <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>
  159. <tr class="separator:a5807c03d2b725a54732d09b53d5da631 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <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>
  161. <tr class="separator:a6b70a037ad6cea86b10fd5188f42bf52 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <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>
  163. <tr class="separator:ad4944a7132f9ee90f801f4cd57014836 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <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>
  165. <tr class="separator:a216228c27df224ac5e8d3590494bfb3f inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. <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>
  167. <tr class="separator:ad517bd83c1c853985ab07cd22775c43d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. </table>
  169. <h2 class="groupheader">Member Function Documentation</h2>
  170. <a class="anchor" id="afd822ddde9d8d1f62e99a9c3e284e8d1"></a>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="memname">
  174. <tr>
  175. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> getAutoFormat </td>
  176. <td>(</td>
  177. <td class="paramname"></td><td>)</td>
  178. <td></td>
  179. </tr>
  180. </table>
  181. </div><div class="memdoc">
  182. <p>Gets whether the format type is automatically determined by the filename extension or not. </p>
  183. <dl class="section return"><dt>Returns</dt><dd>Whether the format type is automatically determined by the filename extension or not. </dd></dl>
  184. </div>
  185. </div>
  186. <a class="anchor" id="ac808107dbbc2b041f8146d679f02b25e"></a>
  187. <div class="memitem">
  188. <div class="memproto">
  189. <table class="memname">
  190. <tr>
  191. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getAutoFormatBinaryExtension </td>
  192. <td>(</td>
  193. <td class="paramname"></td><td>)</td>
  194. <td></td>
  195. </tr>
  196. </table>
  197. </div><div class="memdoc">
  198. <p>Gets the extension (end of filename) used to detect the Binary format. </p>
  199. <dl class="section return"><dt>Returns</dt><dd>The extension (end of filename) used to detect the Binary format. </dd></dl>
  200. </div>
  201. </div>
  202. <a class="anchor" id="a004ac73cb71ec7221f4d9e32824bc9b5"></a>
  203. <div class="memitem">
  204. <div class="memproto">
  205. <table class="memname">
  206. <tr>
  207. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getAutoFormatXmlExtension </td>
  208. <td>(</td>
  209. <td class="paramname"></td><td>)</td>
  210. <td></td>
  211. </tr>
  212. </table>
  213. </div><div class="memdoc">
  214. <p>Gets the extension (end of filename) used to detect the XML format. </p>
  215. <dl class="section return"><dt>Returns</dt><dd>The extension (end of filename) used to detect the XML format. </dd></dl>
  216. </div>
  217. </div>
  218. <a class="anchor" id="a0ee4e3b811a0ba390018bd1590e0bb58"></a>
  219. <div class="memitem">
  220. <div class="memproto">
  221. <table class="memname">
  222. <tr>
  223. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> getBinaryCompression </td>
  224. <td>(</td>
  225. <td class="paramname"></td><td>)</td>
  226. <td></td>
  227. </tr>
  228. </table>
  229. </div><div class="memdoc">
  230. <p>Gets whether ZIP compression is used on binary formatting or not. </p>
  231. <dl class="section return"><dt>Returns</dt><dd>Whether ZIP compression is used on binary formatting or not. </dd></dl>
  232. </div>
  233. </div>
  234. <a class="anchor" id="a2b59cd5ab6324ae81ec0348cd5da7fb8"></a>
  235. <div class="memitem">
  236. <div class="memproto">
  237. <table class="memname">
  238. <tr>
  239. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getFormat </td>
  240. <td>(</td>
  241. <td class="paramname"></td><td>)</td>
  242. <td></td>
  243. </tr>
  244. </table>
  245. </div><div class="memdoc">
  246. <p>Gets the format that <a class="el" href="classTaml.html">Taml</a> should use to read/write. </p>
  247. <dl class="section return"><dt>Returns</dt><dd>The format that <a class="el" href="classTaml.html">Taml</a> should use to read/write. </dd></dl>
  248. </div>
  249. </div>
  250. <a class="anchor" id="a44ba12bc3d31a6c121b1cc0005502b5e"></a>
  251. <div class="memitem">
  252. <div class="memproto">
  253. <table class="memname">
  254. <tr>
  255. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> getJSONStrict </td>
  256. <td>(</td>
  257. <td class="paramname"></td><td>)</td>
  258. <td></td>
  259. </tr>
  260. </table>
  261. </div><div class="memdoc">
  262. <p>Gets whether to write JSON that is strictly compatible with RFC4627 or not. </p>
  263. <dl class="section return"><dt>Returns</dt><dd>whether to write JSON that is strictly compatible with RFC4627 or not. </dd></dl>
  264. </div>
  265. </div>
  266. <a class="anchor" id="a3ded3224ff4497b27146971f9e1425d3"></a>
  267. <div class="memitem">
  268. <div class="memproto">
  269. <table class="memname">
  270. <tr>
  271. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> getProgenitorUpdate </td>
  272. <td>(</td>
  273. <td class="paramname"></td><td>)</td>
  274. <td></td>
  275. </tr>
  276. </table>
  277. </div><div class="memdoc">
  278. <p>Gets whether to update each type instances file-progenitor or not. </p>
  279. <dl class="section return"><dt>Returns</dt><dd>Whether to update each type instances file-progenitor or not. </dd></dl>
  280. </div>
  281. </div>
  282. <a class="anchor" id="abc3567ce2535571936ebb7a873ce1e6d"></a>
  283. <div class="memitem">
  284. <div class="memproto">
  285. <table class="memname">
  286. <tr>
  287. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> getWriteDefaults </td>
  288. <td>(</td>
  289. <td class="paramname"></td><td>)</td>
  290. <td></td>
  291. </tr>
  292. </table>
  293. </div><div class="memdoc">
  294. <p>Gets whether to write static fields that are at their default or not. </p>
  295. <dl class="section return"><dt>Returns</dt><dd>Whether to write static fields that are at their default or not. </dd></dl>
  296. </div>
  297. </div>
  298. <a class="anchor" id="a9d1b0515b848a69d7ad5b81cd83d77c7"></a>
  299. <div class="memitem">
  300. <div class="memproto">
  301. <table class="memname">
  302. <tr>
  303. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> read </td>
  304. <td>(</td>
  305. <td class="paramtype">filename&#160;</td>
  306. <td class="paramname"></td><td>)</td>
  307. <td></td>
  308. </tr>
  309. </table>
  310. </div><div class="memdoc">
  311. <p>Read an object from a file using <a class="el" href="classTaml.html">Taml</a>. </p>
  312. <dl class="params"><dt>Parameters</dt><dd>
  313. <table class="params">
  314. <tr><td class="paramname">filename</td><td>The filename to read from. </td></tr>
  315. </table>
  316. </dd>
  317. </dl>
  318. <dl class="section return"><dt>Returns</dt><dd>(Object) The object read from the file or an empty string if read failed. </dd></dl>
  319. </div>
  320. </div>
  321. <a class="anchor" id="a94fe0663c1139e75526dea549b54a1af"></a>
  322. <div class="memitem">
  323. <div class="memproto">
  324. <table class="memname">
  325. <tr>
  326. <td class="memname">void setAutoFormat </td>
  327. <td>(</td>
  328. <td class="paramtype">autoFormat&#160;</td>
  329. <td class="paramname"></td><td>)</td>
  330. <td></td>
  331. </tr>
  332. </table>
  333. </div><div class="memdoc">
  334. <p>Sets whether the format type is automatically determined by the filename extension or not. </p>
  335. <dl class="params"><dt>Parameters</dt><dd>
  336. <table class="params">
  337. <tr><td class="paramname">autoFormat</td><td>Whether the format type is automatically determined by the filename extension or not. </td></tr>
  338. </table>
  339. </dd>
  340. </dl>
  341. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  342. </div>
  343. </div>
  344. <a class="anchor" id="aaec13623de6a1d1ec1e8610184b81fd0"></a>
  345. <div class="memitem">
  346. <div class="memproto">
  347. <table class="memname">
  348. <tr>
  349. <td class="memname">void setAutoFormatBinaryExtension </td>
  350. <td>(</td>
  351. <td class="paramtype">extension&#160;</td>
  352. <td class="paramname"></td><td>)</td>
  353. <td></td>
  354. </tr>
  355. </table>
  356. </div><div class="memdoc">
  357. <p>Sets the extension (end of filename) used to detect the Binary format. </p>
  358. <dl class="params"><dt>Parameters</dt><dd>
  359. <table class="params">
  360. <tr><td class="paramname">extension</td><td>The extension (end of filename) used to detect the Binary format. </td></tr>
  361. </table>
  362. </dd>
  363. </dl>
  364. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  365. </div>
  366. </div>
  367. <a class="anchor" id="a837b478e51ee798106a18032fbd1637c"></a>
  368. <div class="memitem">
  369. <div class="memproto">
  370. <table class="memname">
  371. <tr>
  372. <td class="memname">void setAutoFormatXmlExtension </td>
  373. <td>(</td>
  374. <td class="paramtype">extension&#160;</td>
  375. <td class="paramname"></td><td>)</td>
  376. <td></td>
  377. </tr>
  378. </table>
  379. </div><div class="memdoc">
  380. <p>Sets the extension (end of filename) used to detect the XML format. </p>
  381. <dl class="params"><dt>Parameters</dt><dd>
  382. <table class="params">
  383. <tr><td class="paramname">extension</td><td>The extension (end of filename) used to detect the XML format. </td></tr>
  384. </table>
  385. </dd>
  386. </dl>
  387. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  388. </div>
  389. </div>
  390. <a class="anchor" id="a4729343b7637a9e33d691cf77baba11e"></a>
  391. <div class="memitem">
  392. <div class="memproto">
  393. <table class="memname">
  394. <tr>
  395. <td class="memname">void setBinaryCompression </td>
  396. <td>(</td>
  397. <td class="paramtype">compressed&#160;</td>
  398. <td class="paramname"></td><td>)</td>
  399. <td></td>
  400. </tr>
  401. </table>
  402. </div><div class="memdoc">
  403. <p>Sets whether ZIP compression is used on binary formatting or not. </p>
  404. <dl class="params"><dt>Parameters</dt><dd>
  405. <table class="params">
  406. <tr><td class="paramname">compressed</td><td>Whether compression is on or off. </td></tr>
  407. </table>
  408. </dd>
  409. </dl>
  410. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  411. </div>
  412. </div>
  413. <a class="anchor" id="ab05c70d3c9b31e17cd439e2e70190518"></a>
  414. <div class="memitem">
  415. <div class="memproto">
  416. <table class="memname">
  417. <tr>
  418. <td class="memname">void setFormat </td>
  419. <td>(</td>
  420. <td class="paramtype">format&#160;</td>
  421. <td class="paramname"></td><td>)</td>
  422. <td></td>
  423. </tr>
  424. </table>
  425. </div><div class="memdoc">
  426. <p>Sets the format that <a class="el" href="classTaml.html">Taml</a> should use to read/write. </p>
  427. <dl class="params"><dt>Parameters</dt><dd>
  428. <table class="params">
  429. <tr><td class="paramname">format</td><td>The format to use: 'xml' or 'binary'. </td></tr>
  430. </table>
  431. </dd>
  432. </dl>
  433. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  434. </div>
  435. </div>
  436. <a class="anchor" id="afe5d248747ab517a8a8bcf1e29d2d991"></a>
  437. <div class="memitem">
  438. <div class="memproto">
  439. <table class="memname">
  440. <tr>
  441. <td class="memname">void setJSONStrict </td>
  442. <td>(</td>
  443. <td class="paramtype">jsonStrict&#160;</td>
  444. <td class="paramname"></td><td>)</td>
  445. <td></td>
  446. </tr>
  447. </table>
  448. </div><div class="memdoc">
  449. <p>Sets whether to write JSON that is strictly compatible with RFC4627 or not. </p>
  450. <dl class="params"><dt>Parameters</dt><dd>
  451. <table class="params">
  452. <tr><td class="paramname">jsonStrict</td><td>Whether to write JSON that is strictly compatible with RFC4627 or not. </td></tr>
  453. </table>
  454. </dd>
  455. </dl>
  456. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  457. </div>
  458. </div>
  459. <a class="anchor" id="ad3f6baef92730b73d8664605553fee24"></a>
  460. <div class="memitem">
  461. <div class="memproto">
  462. <table class="memname">
  463. <tr>
  464. <td class="memname">void setProgenitorUpdate </td>
  465. <td>(</td>
  466. <td class="paramtype">progenitorUpdate&#160;</td>
  467. <td class="paramname"></td><td>)</td>
  468. <td></td>
  469. </tr>
  470. </table>
  471. </div><div class="memdoc">
  472. <p>Sets whether to update each type instances file-progenitor or not. If not updating then the progenitor stay as the script that executed the call to <a class="el" href="classTaml.html">Taml</a>. </p>
  473. <dl class="params"><dt>Parameters</dt><dd>
  474. <table class="params">
  475. <tr><td class="paramname">progenitorUpdate</td><td>Whether to update each type instances file-progenitor or not. </td></tr>
  476. </table>
  477. </dd>
  478. </dl>
  479. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  480. </div>
  481. </div>
  482. <a class="anchor" id="ae3c8e893048cd7b2078fdd7ca379d505"></a>
  483. <div class="memitem">
  484. <div class="memproto">
  485. <table class="memname">
  486. <tr>
  487. <td class="memname">void setWriteDefaults </td>
  488. <td>(</td>
  489. <td class="paramtype">writeDefaults&#160;</td>
  490. <td class="paramname"></td><td>)</td>
  491. <td></td>
  492. </tr>
  493. </table>
  494. </div><div class="memdoc">
  495. <p>Sets whether to write static fields that are at their default or not. </p>
  496. <dl class="params"><dt>Parameters</dt><dd>
  497. <table class="params">
  498. <tr><td class="paramname">writeDefaults</td><td>Whether to write static fields that are at their default or not. </td></tr>
  499. </table>
  500. </dd>
  501. </dl>
  502. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  503. </div>
  504. </div>
  505. <a class="anchor" id="a8c9bf6a0151aa6d20178382f63f8b08f"></a>
  506. <div class="memitem">
  507. <div class="memproto">
  508. <table class="memname">
  509. <tr>
  510. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> write </td>
  511. <td>(</td>
  512. <td class="paramtype">object&#160;</td>
  513. <td class="paramname">, </td>
  514. </tr>
  515. <tr>
  516. <td class="paramkey"></td>
  517. <td></td>
  518. <td class="paramtype">filename&#160;</td>
  519. <td class="paramname">&#160;</td>
  520. </tr>
  521. <tr>
  522. <td></td>
  523. <td>)</td>
  524. <td></td><td></td>
  525. </tr>
  526. </table>
  527. </div><div class="memdoc">
  528. <p>Writes an object to a file using <a class="el" href="classTaml.html">Taml</a>. </p>
  529. <dl class="params"><dt>Parameters</dt><dd>
  530. <table class="params">
  531. <tr><td class="paramname">object</td><td>The object to write. </td></tr>
  532. <tr><td class="paramname">filename</td><td>The filename to write to. </td></tr>
  533. </table>
  534. </dd>
  535. </dl>
  536. <dl class="section return"><dt>Returns</dt><dd>Whether the write was successful or not. </dd></dl>
  537. </div>
  538. </div>
  539. </div><!-- contents -->
  540. <!-- start footer part -->
  541. <hr class="footer"/><address class="footer"><small>
  542. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  543. <img class="footer" src="doxygen.png" alt="doxygen"/>
  544. </a> 1.8.3.1
  545. </small></address>
  546. </body>
  547. </html>