classStreamObject.html 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457
  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.10"/>
  7. <title>TorqueScript Reference: StreamObject 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 id="projectalign" 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.10 -->
  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="modules.html"><span>Modules</span></a></li>
  34. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  35. </ul>
  36. </div>
  37. <div id="navrow2" class="tabs2">
  38. <ul class="tablist">
  39. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  40. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  41. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  42. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  43. </ul>
  44. </div>
  45. </div><!-- top -->
  46. <div class="header">
  47. <div class="summary">
  48. <a href="#pub-methods">Public Member Functions</a> &#124;
  49. <a href="classStreamObject-members.html">List of all members</a> </div>
  50. <div class="headertitle">
  51. <div class="title">StreamObject Class Reference</div> </div>
  52. </div><!--header-->
  53. <div class="contents">
  54. <p>Inherits <a class="el" href="classSimObject.html">SimObject</a>.</p>
  55. <p>Inherited by <a class="el" href="classFileStreamObject.html">FileStreamObject</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:ad25831358006a0ea071f4c8c105bd69f"><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="classStreamObject.html#ad25831358006a0ea071f4c8c105bd69f">copyFrom</a> (<a class="el" href="classStreamObject.html">StreamObject</a> other)</td></tr>
  60. <tr class="separator:ad25831358006a0ea071f4c8c105bd69f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61. <tr class="memitem:a0a6408da8dee8f37e4ab9071fdf521a0"><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="classStreamObject.html#a0a6408da8dee8f37e4ab9071fdf521a0">getPosition</a> ()</td></tr>
  62. <tr class="separator:a0a6408da8dee8f37e4ab9071fdf521a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:ae95bd1ef2a1463049e69f40f28eeb8f1"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStreamObject.html#ae95bd1ef2a1463049e69f40f28eeb8f1">getStatus</a> ()</td></tr>
  64. <tr class="separator:ae95bd1ef2a1463049e69f40f28eeb8f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:abbdd2c947774c1d6455e8b832ccc27c9"><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="classStreamObject.html#abbdd2c947774c1d6455e8b832ccc27c9">getStreamSize</a> ()</td></tr>
  66. <tr class="separator:abbdd2c947774c1d6455e8b832ccc27c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr class="memitem:a9df4f169391e3e516b96cca62f857f7d"><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="classStreamObject.html#a9df4f169391e3e516b96cca62f857f7d">isEOF</a> ()</td></tr>
  68. <tr class="separator:a9df4f169391e3e516b96cca62f857f7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. <tr class="memitem:a4f3dda0939fcc4bae51db52670e70a52"><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="classStreamObject.html#a4f3dda0939fcc4bae51db52670e70a52">isEOS</a> ()</td></tr>
  70. <tr class="separator:a4f3dda0939fcc4bae51db52670e70a52"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:a000a4c174c3dce2a5e1d87d8e9be7efa"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStreamObject.html#a000a4c174c3dce2a5e1d87d8e9be7efa">readLine</a> ()</td></tr>
  72. <tr class="separator:a000a4c174c3dce2a5e1d87d8e9be7efa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:ad7ba882479e87e667141e6015b17ce9b"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStreamObject.html#ad7ba882479e87e667141e6015b17ce9b">readLongString</a> (maxLength)</td></tr>
  74. <tr class="separator:ad7ba882479e87e667141e6015b17ce9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:a601a36343ca706bd6dcc14945c72967e"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStreamObject.html#a601a36343ca706bd6dcc14945c72967e">readString</a> ()</td></tr>
  76. <tr class="separator:a601a36343ca706bd6dcc14945c72967e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:aca0bb3dc91eebee4c26597cdcdc296c1"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStreamObject.html#aca0bb3dc91eebee4c26597cdcdc296c1">readSTString</a> ([caseSensitive=false])</td></tr>
  78. <tr class="separator:aca0bb3dc91eebee4c26597cdcdc296c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:aafccfed55be9bae35cb3f09862f49023"><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="classStreamObject.html#aafccfed55be9bae35cb3f09862f49023">setPosition</a> (newPosition)</td></tr>
  80. <tr class="separator:aafccfed55be9bae35cb3f09862f49023"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a4479e7828e190e17a15d4281ff791e62"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStreamObject.html#a4479e7828e190e17a15d4281ff791e62">writeLine</a> (line)</td></tr>
  82. <tr class="separator:a4479e7828e190e17a15d4281ff791e62"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:a0aad5fd8818bbbdb4430ad6cb66bedca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStreamObject.html#a0aad5fd8818bbbdb4430ad6cb66bedca">writeLongString</a> (maxLength, string)</td></tr>
  84. <tr class="separator:a0aad5fd8818bbbdb4430ad6cb66bedca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:adac36557e94ee557fe7eaa3db4c77542"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStreamObject.html#adac36557e94ee557fe7eaa3db4c77542">writeString</a> (string, [maxLength=255])</td></tr>
  86. <tr class="separator:adac36557e94ee557fe7eaa3db4c77542"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <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>
  88. <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>
  89. <tr class="separator:a22437f451ceb1429fa2a3be23d523954 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <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>
  91. <tr class="separator:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <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>
  93. <tr class="separator:a929e1325a515b279faca90a65028782e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <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>
  95. <tr class="separator:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <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>
  97. <tr class="separator:a78ee178b6a73658d65ca60da4d1e6683 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <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>
  99. <tr class="separator:ab8b0f8b874af628d7204d9cc2630ced7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <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>
  101. <tr class="separator:a6e266d4432d70cad58461d96e1d2cbdf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <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>
  103. <tr class="separator:a847e859bcc5b58df83fa7f331c167c32 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <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>
  105. <tr class="separator:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <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>
  107. <tr class="separator:a8f4e85d0903526235ed2ca86df69cdef inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:abd9730d5538d1713b82fe92bca7b5cba 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#abd9730d5538d1713b82fe92bca7b5cba">call</a> (methodName, [args]*)</td></tr>
  109. <tr class="separator:abd9730d5538d1713b82fe92bca7b5cba inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <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>
  111. <tr class="separator:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <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>
  113. <tr class="separator:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <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>
  115. <tr class="separator:a66ac731a8dc088fe8c8ab17bf7c9eecd inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <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>
  117. <tr class="separator:a3e97a324df2af082cdb089491757ce11 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <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>
  119. <tr class="separator:abc2222a9649b5c033810e753b07f26a3 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <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>
  121. <tr class="separator:a1084f1964e446b3d279943cf6e575069 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <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>
  123. <tr class="separator:a7543b8dc494ec0d9034cb73ae504f3ca inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <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>
  125. <tr class="separator:a0e143217119b68d557d17ac2f13b173e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <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>
  127. <tr class="separator:af2e74f6b683da8d2085f0991dab7948b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <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>
  129. <tr class="separator:ac636f89189406eef1b401292459b1a3b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <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>
  131. <tr class="separator:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <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>
  133. <tr class="separator:a88c8d99755a07ac4648360dd40ff67a5 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <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>
  135. <tr class="separator:a367706e675179342e6153c45f1ba06ae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <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>
  137. <tr class="separator:a0570b7f6eb94a0ed941fd75f6f01555b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <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>
  139. <tr class="separator:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <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>
  141. <tr class="separator:af9f341b474a28f4bcf79bc02439b7c18 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <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>
  143. <tr class="separator:a986f1b4a76969bac5dfd50b22af8dec6 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <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>
  145. <tr class="separator:ae329d6593bb3f9b8046e7cae693ccc09 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a39653bc04e82875f2dc8d6dea25acdaa 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#a39653bc04e82875f2dc8d6dea25acdaa">startTimer</a> (callbackFunction, float timePeriod, [repeat]?)</td></tr>
  147. <tr class="separator:a39653bc04e82875f2dc8d6dea25acdaa inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <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>
  149. <tr class="separator:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <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>
  151. <tr class="separator:a5807c03d2b725a54732d09b53d5da631 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:ab5179f3203c92793cb8f4e6066b55e39 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#ab5179f3203c92793cb8f4e6066b55e39">schedule</a> (time, command, [arg]*)</td></tr>
  153. <tr class="separator:ab5179f3203c92793cb8f4e6066b55e39 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:ab6e816c3694e8b6119bf9ac3f5556f32 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#ab6e816c3694e8b6119bf9ac3f5556f32">save</a> (<a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>, [selectedOnly]?)</td></tr>
  155. <tr class="separator:ab6e816c3694e8b6119bf9ac3f5556f32 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <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>
  157. <tr class="separator:a216228c27df224ac5e8d3590494bfb3f inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <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>
  159. <tr class="separator:ad517bd83c1c853985ab07cd22775c43d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. </table>
  161. <h2 class="groupheader">Member Function Documentation</h2>
  162. <a class="anchor" id="ad25831358006a0ea071f4c8c105bd69f"></a>
  163. <div class="memitem">
  164. <div class="memproto">
  165. <table class="memname">
  166. <tr>
  167. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> copyFrom </td>
  168. <td>(</td>
  169. <td class="paramtype"><a class="el" href="classStreamObject.html">StreamObject</a>&#160;</td>
  170. <td class="paramname"><em>other</em></td><td>)</td>
  171. <td></td>
  172. </tr>
  173. </table>
  174. </div><div class="memdoc">
  175. <p>Copies stream contents from current position </p><dl class="params"><dt>Parameters</dt><dd>
  176. <table class="params">
  177. <tr><td class="paramname">other</td><td>The <a class="el" href="classStreamObject.html">StreamObject</a> from which to copy </td></tr>
  178. </table>
  179. </dd>
  180. </dl>
  181. <dl class="section return"><dt>Returns</dt><dd>Returns true on success, and false otherwise. </dd></dl>
  182. </div>
  183. </div>
  184. <a class="anchor" id="a0a6408da8dee8f37e4ab9071fdf521a0"></a>
  185. <div class="memitem">
  186. <div class="memproto">
  187. <table class="memname">
  188. <tr>
  189. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getPosition </td>
  190. <td>(</td>
  191. <td class="paramname"></td><td>)</td>
  192. <td></td>
  193. </tr>
  194. </table>
  195. </div><div class="memdoc">
  196. <dl class="section return"><dt>Returns</dt><dd>Returns the current position in the stream as an integer or zero if failed </dd></dl>
  197. </div>
  198. </div>
  199. <a class="anchor" id="ae95bd1ef2a1463049e69f40f28eeb8f1"></a>
  200. <div class="memitem">
  201. <div class="memproto">
  202. <table class="memname">
  203. <tr>
  204. <td class="memname">const char* getStatus </td>
  205. <td>(</td>
  206. <td class="paramname"></td><td>)</td>
  207. <td></td>
  208. </tr>
  209. </table>
  210. </div><div class="memdoc">
  211. <p>Gets the current status of the <a class="el" href="classStreamObject.html">StreamObject</a> </p><dl class="section return"><dt>Returns</dt><dd>The current status as a string (Ok, IOError, EOS, IllegalCall, Closed, UnknownError, Invalid) </dd></dl>
  212. </div>
  213. </div>
  214. <a class="anchor" id="abbdd2c947774c1d6455e8b832ccc27c9"></a>
  215. <div class="memitem">
  216. <div class="memproto">
  217. <table class="memname">
  218. <tr>
  219. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getStreamSize </td>
  220. <td>(</td>
  221. <td class="paramname"></td><td>)</td>
  222. <td></td>
  223. </tr>
  224. </table>
  225. </div><div class="memdoc">
  226. <p>Get the size of the stream </p><dl class="section return"><dt>Returns</dt><dd>The size of the stream as an integer </dd></dl>
  227. </div>
  228. </div>
  229. <a class="anchor" id="a9df4f169391e3e516b96cca62f857f7d"></a>
  230. <div class="memitem">
  231. <div class="memproto">
  232. <table class="memname">
  233. <tr>
  234. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isEOF </td>
  235. <td>(</td>
  236. <td class="paramname"></td><td>)</td>
  237. <td></td>
  238. </tr>
  239. </table>
  240. </div><div class="memdoc">
  241. <p>Test for end of file stream (identical to <a class="el" href="classStreamObject.html#a4f3dda0939fcc4bae51db52670e70a52">isEOS()</a> </p><dl class="section return"><dt>Returns</dt><dd>Returns true if at the end of the stream, false otherwise. </dd></dl>
  242. <dl class="section see"><dt>See also</dt><dd><a class="el" href="classStreamObject.html#a4f3dda0939fcc4bae51db52670e70a52">isEOS</a> </dd></dl>
  243. </div>
  244. </div>
  245. <a class="anchor" id="a4f3dda0939fcc4bae51db52670e70a52"></a>
  246. <div class="memitem">
  247. <div class="memproto">
  248. <table class="memname">
  249. <tr>
  250. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isEOS </td>
  251. <td>(</td>
  252. <td class="paramname"></td><td>)</td>
  253. <td></td>
  254. </tr>
  255. </table>
  256. </div><div class="memdoc">
  257. <p>Test for end of stream </p><dl class="section return"><dt>Returns</dt><dd>Returns true if at the end of the stream, false otherwise. </dd></dl>
  258. </div>
  259. </div>
  260. <a class="anchor" id="a000a4c174c3dce2a5e1d87d8e9be7efa"></a>
  261. <div class="memitem">
  262. <div class="memproto">
  263. <table class="memname">
  264. <tr>
  265. <td class="memname">const char* readLine </td>
  266. <td>(</td>
  267. <td class="paramname"></td><td>)</td>
  268. <td></td>
  269. </tr>
  270. </table>
  271. </div><div class="memdoc">
  272. <p>Read the stream until '\' or EOS </p><dl class="section return"><dt>Returns</dt><dd>A string containing the read line or an empty string if failed </dd></dl>
  273. </div>
  274. </div>
  275. <a class="anchor" id="ad7ba882479e87e667141e6015b17ce9b"></a>
  276. <div class="memitem">
  277. <div class="memproto">
  278. <table class="memname">
  279. <tr>
  280. <td class="memname">const char* readLongString </td>
  281. <td>(</td>
  282. <td class="paramtype">maxLength&#160;</td>
  283. <td class="paramname"></td><td>)</td>
  284. <td></td>
  285. </tr>
  286. </table>
  287. </div><div class="memdoc">
  288. <p>Reads a string of provided length from the stream buffer. </p><dl class="params"><dt>Parameters</dt><dd>
  289. <table class="params">
  290. <tr><td class="paramname">The</td><td>maximum length to read in </td></tr>
  291. </table>
  292. </dd>
  293. </dl>
  294. <dl class="section return"><dt>Returns</dt><dd>The requested string </dd></dl>
  295. </div>
  296. </div>
  297. <a class="anchor" id="a601a36343ca706bd6dcc14945c72967e"></a>
  298. <div class="memitem">
  299. <div class="memproto">
  300. <table class="memname">
  301. <tr>
  302. <td class="memname">const char* readString </td>
  303. <td>(</td>
  304. <td class="paramname"></td><td>)</td>
  305. <td></td>
  306. </tr>
  307. </table>
  308. </div><div class="memdoc">
  309. <p>Reads a string from a stream buffer </p><dl class="section return"><dt>Returns</dt><dd>The string or an empty string if failed. </dd></dl>
  310. </div>
  311. </div>
  312. <a class="anchor" id="aca0bb3dc91eebee4c26597cdcdc296c1"></a>
  313. <div class="memitem">
  314. <div class="memproto">
  315. <table class="memname">
  316. <tr>
  317. <td class="memname">const char* readSTString </td>
  318. <td>(</td>
  319. <td class="paramname"></td><td>)</td>
  320. <td></td>
  321. </tr>
  322. </table>
  323. </div><div class="memdoc">
  324. <p>Read a String and insert it into a StringTable </p><dl class="params"><dt>Parameters</dt><dd>
  325. <table class="params">
  326. <tr><td class="paramname">caseSensitive</td><td>A boolean representing whether the parser should ignore case or not (default false) </td></tr>
  327. </table>
  328. </dd>
  329. </dl>
  330. <dl class="section return"><dt>Returns</dt><dd>Returns the string, or empty string if failed </dd></dl>
  331. </div>
  332. </div>
  333. <a class="anchor" id="aafccfed55be9bae35cb3f09862f49023"></a>
  334. <div class="memitem">
  335. <div class="memproto">
  336. <table class="memname">
  337. <tr>
  338. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> setPosition </td>
  339. <td>(</td>
  340. <td class="paramtype">newPosition&#160;</td>
  341. <td class="paramname"></td><td>)</td>
  342. <td></td>
  343. </tr>
  344. </table>
  345. </div><div class="memdoc">
  346. <p>Resets the current stream position </p><dl class="params"><dt>Parameters</dt><dd>
  347. <table class="params">
  348. <tr><td class="paramname">The</td><td>desired index </td></tr>
  349. </table>
  350. </dd>
  351. </dl>
  352. <dl class="section return"><dt>Returns</dt><dd>Returns true if succeeded, flase otherwise </dd></dl>
  353. </div>
  354. </div>
  355. <a class="anchor" id="a4479e7828e190e17a15d4281ff791e62"></a>
  356. <div class="memitem">
  357. <div class="memproto">
  358. <table class="memname">
  359. <tr>
  360. <td class="memname">void writeLine </td>
  361. <td>(</td>
  362. <td class="paramtype">line&#160;</td>
  363. <td class="paramname"></td><td>)</td>
  364. <td></td>
  365. </tr>
  366. </table>
  367. </div><div class="memdoc">
  368. <p>Writes a line of text to the stream buffer </p><dl class="params"><dt>Parameters</dt><dd>
  369. <table class="params">
  370. <tr><td class="paramname">The</td><td>line to write </td></tr>
  371. </table>
  372. </dd>
  373. </dl>
  374. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  375. </div>
  376. </div>
  377. <a class="anchor" id="a0aad5fd8818bbbdb4430ad6cb66bedca"></a>
  378. <div class="memitem">
  379. <div class="memproto">
  380. <table class="memname">
  381. <tr>
  382. <td class="memname">void writeLongString </td>
  383. <td>(</td>
  384. <td class="paramtype">maxLength&#160;</td>
  385. <td class="paramname">, </td>
  386. </tr>
  387. <tr>
  388. <td class="paramkey"></td>
  389. <td></td>
  390. <td class="paramtype">string&#160;</td>
  391. <td class="paramname">&#160;</td>
  392. </tr>
  393. <tr>
  394. <td></td>
  395. <td>)</td>
  396. <td></td><td></td>
  397. </tr>
  398. </table>
  399. </div><div class="memdoc">
  400. <p>Writes a string to buffer or provided length </p><dl class="params"><dt>Parameters</dt><dd>
  401. <table class="params">
  402. <tr><td class="paramname">maxLength</td><td>The maximum length to write </td></tr>
  403. <tr><td class="paramname">string</td><td>The string to write </td></tr>
  404. </table>
  405. </dd>
  406. </dl>
  407. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  408. </div>
  409. </div>
  410. <a class="anchor" id="adac36557e94ee557fe7eaa3db4c77542"></a>
  411. <div class="memitem">
  412. <div class="memproto">
  413. <table class="memname">
  414. <tr>
  415. <td class="memname">void writeString </td>
  416. <td>(</td>
  417. <td class="paramtype">string&#160;</td>
  418. <td class="paramname"></td><td>)</td>
  419. <td></td>
  420. </tr>
  421. </table>
  422. </div><div class="memdoc">
  423. <p>Write a string to the stream buffer </p><dl class="params"><dt>Parameters</dt><dd>
  424. <table class="params">
  425. <tr><td class="paramname">string</td><td>The string to write </td></tr>
  426. <tr><td class="paramname">maxLength</td><td>The maximum length to write (default 255). </td></tr>
  427. </table>
  428. </dd>
  429. </dl>
  430. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  431. </div>
  432. </div>
  433. </div><!-- contents -->
  434. <!-- start footer part -->
  435. <hr class="footer"/><address class="footer"><small>
  436. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  437. <img class="footer" src="doxygen.png" alt="doxygen"/>
  438. </a> 1.8.10
  439. </small></address>
  440. </body>
  441. </html>