classFileObject.html 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497
  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. <title>FileObject Class Reference</title>
  6. <link href="torquedoc.css" rel="stylesheet" type="text/css"/>
  7. </head>
  8. <body>
  9. <table width="100%" class="header">
  10. <tr>
  11. </tr>
  12. <tr><td class="headermenu">
  13. <center>
  14. <a class="qindex" href="index.html">Main</a> &nbsp;
  15. <a class="qindex" target="_blank" href="https://github.com/GarageGames/Torque2D">GitHub</a>
  16. </center>
  17. </td></tr>
  18. </table>
  19. <br>
  20. <!-- END HEADER -->
  21. <!-- Generated by Doxygen 1.8.3.1 -->
  22. </div><!-- top -->
  23. <div class="header">
  24. <div class="summary">
  25. <a href="classFileObject-members.html">List of all members</a> &#124;
  26. <a href="#pub-methods">Public Member Functions</a> </div>
  27. <div class="headertitle">
  28. <div class="title">FileObject Class Reference</div> </div>
  29. </div><!--header-->
  30. <div class="contents">
  31. <p>Inherits <a class="el" href="classSimObject.html">SimObject</a>.</p>
  32. <table class="memberdecls">
  33. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  34. Public Member Functions</h2></td></tr>
  35. <tr class="memitem:a32c1b5f1eb47280ac608fb18d249e364"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#a32c1b5f1eb47280ac608fb18d249e364">close</a> ()</td></tr>
  36. <tr class="separator:a32c1b5f1eb47280ac608fb18d249e364"><td class="memSeparator" colspan="2">&#160;</td></tr>
  37. <tr class="memitem:add1bb76c25da8c0e2d0124f7af708e29"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#add1bb76c25da8c0e2d0124f7af708e29">isEOF</a> ()</td></tr>
  38. <tr class="separator:add1bb76c25da8c0e2d0124f7af708e29"><td class="memSeparator" colspan="2">&#160;</td></tr>
  39. <tr class="memitem:a118f147e0d85896ccec8bea3e0baa482"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#a118f147e0d85896ccec8bea3e0baa482">openForAppend</a> (filename)</td></tr>
  40. <tr class="separator:a118f147e0d85896ccec8bea3e0baa482"><td class="memSeparator" colspan="2">&#160;</td></tr>
  41. <tr class="memitem:a69a94afd2520b4781661a87d464944f8"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#a69a94afd2520b4781661a87d464944f8">openForRead</a> (filename)</td></tr>
  42. <tr class="separator:a69a94afd2520b4781661a87d464944f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  43. <tr class="memitem:a487b112f6ba7e985ebea15d8057257be"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#a487b112f6ba7e985ebea15d8057257be">openForWrite</a> (filename)</td></tr>
  44. <tr class="separator:a487b112f6ba7e985ebea15d8057257be"><td class="memSeparator" colspan="2">&#160;</td></tr>
  45. <tr class="memitem:ae50932f54495c3dd9621a6fb65755c55"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#ae50932f54495c3dd9621a6fb65755c55">peekLine</a> ()</td></tr>
  46. <tr class="separator:ae50932f54495c3dd9621a6fb65755c55"><td class="memSeparator" colspan="2">&#160;</td></tr>
  47. <tr class="memitem:aea784f430816e21c2ae3c3feea752a29"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#aea784f430816e21c2ae3c3feea752a29">readLine</a> ()</td></tr>
  48. <tr class="separator:aea784f430816e21c2ae3c3feea752a29"><td class="memSeparator" colspan="2">&#160;</td></tr>
  49. <tr class="memitem:ac7e9c4b626b6d25eebb639499fc7ed44"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#ac7e9c4b626b6d25eebb639499fc7ed44">writeLine</a> (text)</td></tr>
  50. <tr class="separator:ac7e9c4b626b6d25eebb639499fc7ed44"><td class="memSeparator" colspan="2">&#160;</td></tr>
  51. <tr class="memitem:a83893d13eabe610837e5b48185cc5457"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#a83893d13eabe610837e5b48185cc5457">writeObject</a> (<a class="el" href="classSimObject.html">SimObject</a>, object prepend)</td></tr>
  52. <tr class="separator:a83893d13eabe610837e5b48185cc5457"><td class="memSeparator" colspan="2">&#160;</td></tr>
  53. <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>
  54. <tr class="memitem:aa19815069e82c393e2c10885eabf8016 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa19815069e82c393e2c10885eabf8016">addFieldFilter</a> (fieldName)</td></tr>
  55. <tr class="separator:aa19815069e82c393e2c10885eabf8016 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  56. <tr class="memitem:a804a3fb06b864699c7bc2601e685756d inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a804a3fb06b864699c7bc2601e685756d">call</a> (%args)</td></tr>
  57. <tr class="separator:a804a3fb06b864699c7bc2601e685756d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  58. <tr class="memitem:abce68a893b7efa10c06ea780ddda7f06 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#abce68a893b7efa10c06ea780ddda7f06">clone</a> ([bool copyDynamicFields?=false])</td></tr>
  59. <tr class="separator:abce68a893b7efa10c06ea780ddda7f06 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60. <tr class="memitem:a0407d340f60883977e60e7414f804be8 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0407d340f60883977e60e7414f804be8">delete</a> ()</td></tr>
  61. <tr class="separator:a0407d340f60883977e60e7414f804be8 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. <tr class="memitem:a6a5e4ea85ff866ed5340d20993541c50 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a6a5e4ea85ff866ed5340d20993541c50">dump</a> ()</td></tr>
  63. <tr class="separator:a6a5e4ea85ff866ed5340d20993541c50 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64. <tr class="memitem:a7b595302fce08857b11a01bbb1083a7e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7b595302fce08857b11a01bbb1083a7e">dumpClassHierarchy</a> ()</td></tr>
  65. <tr class="separator:a7b595302fce08857b11a01bbb1083a7e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:a8e927f41d38b279dc8684f7ced03c0fb inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a8e927f41d38b279dc8684f7ced03c0fb">getClassName</a> ()</td></tr>
  67. <tr class="separator:a8e927f41d38b279dc8684f7ced03c0fb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:a90cc89c3cebc772fdadfd9ac87ecd24e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a90cc89c3cebc772fdadfd9ac87ecd24e">getClassNamespace</a> ()</td></tr>
  69. <tr class="separator:a90cc89c3cebc772fdadfd9ac87ecd24e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:a09ab8f9a6a8e3ee0cfc3c78ebb54f113 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a09ab8f9a6a8e3ee0cfc3c78ebb54f113">getDynamicField</a> (index)</td></tr>
  71. <tr class="separator:a09ab8f9a6a8e3ee0cfc3c78ebb54f113 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:a2d78d37eac1f119baf560cd273c03538 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a2d78d37eac1f119baf560cd273c03538">getDynamicFieldCount</a> ()</td></tr>
  73. <tr class="separator:a2d78d37eac1f119baf560cd273c03538 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:a55ace9339e968c26428e0082bd190693 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a55ace9339e968c26428e0082bd190693">getField</a> (int index)</td></tr>
  75. <tr class="separator:a55ace9339e968c26428e0082bd190693 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:abef30dc0fc312dd3334e2a4a8491da37 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#abef30dc0fc312dd3334e2a4a8491da37">getFieldCount</a> ()</td></tr>
  77. <tr class="separator:abef30dc0fc312dd3334e2a4a8491da37 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:a6e9001db89eb8822430f0d02c6108b43 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a6e9001db89eb8822430f0d02c6108b43">getFieldType</a> (fieldName)</td></tr>
  79. <tr class="separator:a6e9001db89eb8822430f0d02c6108b43 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:addb1c5fbb1495cf580318456b639548d inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#addb1c5fbb1495cf580318456b639548d">getFieldValue</a> (fieldName)</td></tr>
  81. <tr class="separator:addb1c5fbb1495cf580318456b639548d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a1a4f6c730ac5325e79cc4554e43db26e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1a4f6c730ac5325e79cc4554e43db26e">getGroup</a> ()</td></tr>
  83. <tr class="separator:a1a4f6c730ac5325e79cc4554e43db26e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a230cd7c02705a8d3eea78cacb320591f inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a230cd7c02705a8d3eea78cacb320591f">getId</a> ()</td></tr>
  85. <tr class="separator:a230cd7c02705a8d3eea78cacb320591f inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a9b026d477bdd586a8ad5ee0e7a6fb7fe inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9b026d477bdd586a8ad5ee0e7a6fb7fe">getInternalName</a> ()</td></tr>
  87. <tr class="separator:a9b026d477bdd586a8ad5ee0e7a6fb7fe inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a84e32f38cdb775bfe739867d55737b4d inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a84e32f38cdb775bfe739867d55737b4d">getName</a> ()</td></tr>
  89. <tr class="separator:a84e32f38cdb775bfe739867d55737b4d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a1058915844541a6bebebc75415bbe7e0 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1058915844541a6bebebc75415bbe7e0">getProgenitorFile</a> ()</td></tr>
  91. <tr class="separator:a1058915844541a6bebebc75415bbe7e0 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a4b464b66407955fa435f66dc684971c8 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a4b464b66407955fa435f66dc684971c8">getSuperClassNamespace</a> ()</td></tr>
  93. <tr class="separator:a4b464b66407955fa435f66dc684971c8 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a320f74b22aa85775725f8569154d667e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a320f74b22aa85775725f8569154d667e">getType</a> ()</td></tr>
  95. <tr class="separator:a320f74b22aa85775725f8569154d667e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a1260a9ecd13cdbea359d9fe7c045794e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1260a9ecd13cdbea359d9fe7c045794e">isChildOfGroup</a> ()</td></tr>
  97. <tr class="separator:a1260a9ecd13cdbea359d9fe7c045794e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a86048647be436a21246de6a92f807ea4 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a86048647be436a21246de6a92f807ea4">isMemberOfClass</a> (string classname)</td></tr>
  99. <tr class="separator:a86048647be436a21246de6a92f807ea4 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a89bdccd1d3b307d9caf08496003a63cb inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a89bdccd1d3b307d9caf08496003a63cb">isMethod</a> (string method name)</td></tr>
  101. <tr class="separator:a89bdccd1d3b307d9caf08496003a63cb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a4d77984a510b832f0f2a87d132192af1 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a4d77984a510b832f0f2a87d132192af1">isTimerActive</a> ()</td></tr>
  103. <tr class="separator:a4d77984a510b832f0f2a87d132192af1 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a5a3e025c27ebe1d34a8485ee53199dcb inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5a3e025c27ebe1d34a8485ee53199dcb">removeFieldFilter</a> (fieldName)</td></tr>
  105. <tr class="separator:a5a3e025c27ebe1d34a8485ee53199dcb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:aac4f9db0033e9192254a8308f6101909 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aac4f9db0033e9192254a8308f6101909">save</a> (fileName,[selectedOnly])</td></tr>
  107. <tr class="separator:aac4f9db0033e9192254a8308f6101909 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a38c14c64f403c3df7749ca315c325386 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a38c14c64f403c3df7749ca315c325386">schedule</a> (time, command,&lt; arg1...argN &gt;)</td></tr>
  109. <tr class="separator:a38c14c64f403c3df7749ca315c325386 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:ac70958a4cae93deda0d031947d187892 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ac70958a4cae93deda0d031947d187892">setClassNamespace</a> ()</td></tr>
  111. <tr class="separator:ac70958a4cae93deda0d031947d187892 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a29f97240eeaf780e9c02bee7aa6e7b25 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a29f97240eeaf780e9c02bee7aa6e7b25">setFieldValue</a> (fieldName, value)</td></tr>
  113. <tr class="separator:a29f97240eeaf780e9c02bee7aa6e7b25 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:acf355cf2001b85ffcf07958400c97605 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#acf355cf2001b85ffcf07958400c97605">setInternalName</a> ()</td></tr>
  115. <tr class="separator:acf355cf2001b85ffcf07958400c97605 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:a1e799de6b4329f9ce9b94a176ad1cfbb inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1e799de6b4329f9ce9b94a176ad1cfbb">setName</a> (newName)</td></tr>
  117. <tr class="separator:a1e799de6b4329f9ce9b94a176ad1cfbb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:ad2b00ab622649aa8b1b2b5600ea4abb1 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad2b00ab622649aa8b1b2b5600ea4abb1">setProgenitorFile</a> (file)</td></tr>
  119. <tr class="separator:ad2b00ab622649aa8b1b2b5600ea4abb1 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:a94f53f0f93ced24b597de83aa122e824 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a94f53f0f93ced24b597de83aa122e824">setSuperClassNamespace</a> ()</td></tr>
  121. <tr class="separator:a94f53f0f93ced24b597de83aa122e824 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:ab928f21c5a7e13a0c2cdbcf479c9e07d inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab928f21c5a7e13a0c2cdbcf479c9e07d">startTimer</a> (callbackFunction, float timePeriod,[repeat])</td></tr>
  123. <tr class="separator:ab928f21c5a7e13a0c2cdbcf479c9e07d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:acd9c4032150dd0566eca593062588e9f inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#acd9c4032150dd0566eca593062588e9f">stopTimer</a> ()</td></tr>
  125. <tr class="separator:acd9c4032150dd0566eca593062588e9f inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. </table><table class="memberdecls">
  127. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  128. Public Attributes</h2></td></tr>
  129. <tr><td colspan="2"><div class="groupHeader">SimBase</div></td></tr>
  130. <tr class="memitem:ac7b0fabdab24a5e869ca14f072c00c4f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#ac7b0fabdab24a5e869ca14f072c00c4f">canSaveDynamicFields</a></td></tr>
  131. <tr class="separator:ac7b0fabdab24a5e869ca14f072c00c4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a1be4a135417bdc3b788ff94432d28eff"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#a1be4a135417bdc3b788ff94432d28eff">internalName</a></td></tr>
  133. <tr class="separator:a1be4a135417bdc3b788ff94432d28eff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a12e3047486a99c6a73218cbd391db99d"><td class="memItemLeft" align="right" valign="top">SimObjectPtr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#a12e3047486a99c6a73218cbd391db99d">parentGroup</a></td></tr>
  135. <tr class="separator:a12e3047486a99c6a73218cbd391db99d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr><td colspan="2"><div class="groupHeader">Namespace Linking</div></td></tr>
  137. <tr class="memitem:a38837858ed24b063bcf369c004a1fb34"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#a38837858ed24b063bcf369c004a1fb34">superclass</a></td></tr>
  138. <tr class="separator:a38837858ed24b063bcf369c004a1fb34"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:a259e395e5801ebe2378341ab83636aca"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#a259e395e5801ebe2378341ab83636aca">class</a></td></tr>
  140. <tr class="separator:a259e395e5801ebe2378341ab83636aca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="inherit_header pub_attribs_classSimObject"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classSimObject')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="classSimObject.html">SimObject</a></td></tr>
  142. <tr class="memitem:ab49fae316a2d0c12834f50c3d77202e6 inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab49fae316a2d0c12834f50c3d77202e6">canSaveDynamicFields</a></td></tr>
  143. <tr class="separator:ab49fae316a2d0c12834f50c3d77202e6 inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:ad03202387165717f164f996a5b22c9bb inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad03202387165717f164f996a5b22c9bb">internalName</a></td></tr>
  145. <tr class="separator:ad03202387165717f164f996a5b22c9bb inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a0f783d7e37cad2b0a9d6f7b0d1672a28 inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">SimObjectPtr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0f783d7e37cad2b0a9d6f7b0d1672a28">parentGroup</a></td></tr>
  147. <tr class="separator:a0f783d7e37cad2b0a9d6f7b0d1672a28 inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:aa0d134072878053537fefb1768b63d3f inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa0d134072878053537fefb1768b63d3f">superclass</a></td></tr>
  149. <tr class="separator:aa0d134072878053537fefb1768b63d3f inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:ab83c7a59a66018d9b5eec3c8dcd3397d inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab83c7a59a66018d9b5eec3c8dcd3397d">class</a></td></tr>
  151. <tr class="separator:ab83c7a59a66018d9b5eec3c8dcd3397d inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. </table>
  153. <h2 class="groupheader">Member Function Documentation</h2>
  154. <a class="anchor" id="a32c1b5f1eb47280ac608fb18d249e364"></a>
  155. <div class="memitem">
  156. <div class="memproto">
  157. <table class="mlabels">
  158. <tr>
  159. <td class="mlabels-left">
  160. <table class="memname">
  161. <tr>
  162. <td class="memname">virtual void FileObject::close </td>
  163. <td>(</td>
  164. <td class="paramname"></td><td>)</td>
  165. <td></td>
  166. </tr>
  167. </table>
  168. </td>
  169. <td class="mlabels-right">
  170. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  171. </tr>
  172. </table>
  173. </div><div class="memdoc">
  174. <p>Use the close method to close the current file handle. If the file was opened for writing, this flushes the contents of the last write to disk. </p>
  175. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  176. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classFileObject.html#a118f147e0d85896ccec8bea3e0baa482">openForAppend</a>, <a class="el" href="classFileObject.html#a69a94afd2520b4781661a87d464944f8">openForRead</a>, <a class="el" href="classFileObject.html#a487b112f6ba7e985ebea15d8057257be">openForWrite</a> </dd></dl>
  177. </div>
  178. </div>
  179. <a class="anchor" id="add1bb76c25da8c0e2d0124f7af708e29"></a>
  180. <div class="memitem">
  181. <div class="memproto">
  182. <table class="mlabels">
  183. <tr>
  184. <td class="mlabels-left">
  185. <table class="memname">
  186. <tr>
  187. <td class="memname">virtual bool FileObject::isEOF </td>
  188. <td>(</td>
  189. <td class="paramname"></td><td>)</td>
  190. <td></td>
  191. </tr>
  192. </table>
  193. </td>
  194. <td class="mlabels-right">
  195. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  196. </tr>
  197. </table>
  198. </div><div class="memdoc">
  199. <p>Use the isEOF method to check to see if the end of the current file (opened for read) has been reached. </p>
  200. <dl class="section return"><dt>Returns</dt><dd>Returns true if the end of file has been reached, false otherwise. </dd></dl>
  201. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classFileObject.html#a69a94afd2520b4781661a87d464944f8">openForRead</a> </dd></dl>
  202. </div>
  203. </div>
  204. <a class="anchor" id="a118f147e0d85896ccec8bea3e0baa482"></a>
  205. <div class="memitem">
  206. <div class="memproto">
  207. <table class="mlabels">
  208. <tr>
  209. <td class="mlabels-left">
  210. <table class="memname">
  211. <tr>
  212. <td class="memname">virtual bool FileObject::openForAppend </td>
  213. <td>(</td>
  214. <td class="paramtype">filename&#160;</td>
  215. <td class="paramname"></td><td>)</td>
  216. <td></td>
  217. </tr>
  218. </table>
  219. </td>
  220. <td class="mlabels-right">
  221. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  222. </tr>
  223. </table>
  224. </div><div class="memdoc">
  225. <p>Use the openForAppend method to open a previously created file for appending. If the file specified by filename does not exist, the file is created first. </p>
  226. <dl class="params"><dt>Parameters</dt><dd>
  227. <table class="params">
  228. <tr><td class="paramname">filename</td><td>The path and filename of the file to open for appending. </td></tr>
  229. </table>
  230. </dd>
  231. </dl>
  232. <dl class="section return"><dt>Returns</dt><dd>Returns true if the file was successfully opened for appending, false otherwise. </dd></dl>
  233. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classFileObject.html#a32c1b5f1eb47280ac608fb18d249e364">close</a>, <a class="el" href="classFileObject.html#a69a94afd2520b4781661a87d464944f8">openForRead</a>, <a class="el" href="classFileObject.html#a487b112f6ba7e985ebea15d8057257be">openForWrite</a> </dd></dl>
  234. </div>
  235. </div>
  236. <a class="anchor" id="a69a94afd2520b4781661a87d464944f8"></a>
  237. <div class="memitem">
  238. <div class="memproto">
  239. <table class="mlabels">
  240. <tr>
  241. <td class="mlabels-left">
  242. <table class="memname">
  243. <tr>
  244. <td class="memname">virtual bool FileObject::openForRead </td>
  245. <td>(</td>
  246. <td class="paramtype">filename&#160;</td>
  247. <td class="paramname"></td><td>)</td>
  248. <td></td>
  249. </tr>
  250. </table>
  251. </td>
  252. <td class="mlabels-right">
  253. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  254. </tr>
  255. </table>
  256. </div><div class="memdoc">
  257. <p>Use the openForRead method to open a previously created file for reading. </p>
  258. <dl class="params"><dt>Parameters</dt><dd>
  259. <table class="params">
  260. <tr><td class="paramname">filename</td><td>The path and filename of the file to open for reading. </td></tr>
  261. </table>
  262. </dd>
  263. </dl>
  264. <dl class="section return"><dt>Returns</dt><dd>Returns true if the file was successfully opened for reading, false otherwise. </dd></dl>
  265. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classFileObject.html#a32c1b5f1eb47280ac608fb18d249e364">close</a>, OpenForAppend, OpenForWrite </dd></dl>
  266. </div>
  267. </div>
  268. <a class="anchor" id="a487b112f6ba7e985ebea15d8057257be"></a>
  269. <div class="memitem">
  270. <div class="memproto">
  271. <table class="mlabels">
  272. <tr>
  273. <td class="mlabels-left">
  274. <table class="memname">
  275. <tr>
  276. <td class="memname">virtual bool FileObject::openForWrite </td>
  277. <td>(</td>
  278. <td class="paramtype">filename&#160;</td>
  279. <td class="paramname"></td><td>)</td>
  280. <td></td>
  281. </tr>
  282. </table>
  283. </td>
  284. <td class="mlabels-right">
  285. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  286. </tr>
  287. </table>
  288. </div><div class="memdoc">
  289. <p>Use the openForWrite method to previously created or a new file for writing. In either case, the file will be overwritten. </p>
  290. <dl class="params"><dt>Parameters</dt><dd>
  291. <table class="params">
  292. <tr><td class="paramname">filename</td><td>The path and filename of the file to open for writing. </td></tr>
  293. </table>
  294. </dd>
  295. </dl>
  296. <dl class="section return"><dt>Returns</dt><dd>Returns true if the file was successfully opened for writing, false otherwise. </dd></dl>
  297. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classFileObject.html#a32c1b5f1eb47280ac608fb18d249e364">close</a>, OpenForAppend, <a class="el" href="classFileObject.html#a69a94afd2520b4781661a87d464944f8">openForRead</a> </dd></dl>
  298. </div>
  299. </div>
  300. <a class="anchor" id="ae50932f54495c3dd9621a6fb65755c55"></a>
  301. <div class="memitem">
  302. <div class="memproto">
  303. <table class="mlabels">
  304. <tr>
  305. <td class="mlabels-left">
  306. <table class="memname">
  307. <tr>
  308. <td class="memname">virtual string FileObject::peekLine </td>
  309. <td>(</td>
  310. <td class="paramname"></td><td>)</td>
  311. <td></td>
  312. </tr>
  313. </table>
  314. </td>
  315. <td class="mlabels-right">
  316. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  317. </tr>
  318. </table>
  319. </div><div class="memdoc">
  320. <p>Read a line from the file without moving the stream position. </p>
  321. </div>
  322. </div>
  323. <a class="anchor" id="aea784f430816e21c2ae3c3feea752a29"></a>
  324. <div class="memitem">
  325. <div class="memproto">
  326. <table class="mlabels">
  327. <tr>
  328. <td class="mlabels-left">
  329. <table class="memname">
  330. <tr>
  331. <td class="memname">virtual string FileObject::readLine </td>
  332. <td>(</td>
  333. <td class="paramname"></td><td>)</td>
  334. <td></td>
  335. </tr>
  336. </table>
  337. </td>
  338. <td class="mlabels-right">
  339. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  340. </tr>
  341. </table>
  342. </div><div class="memdoc">
  343. <p>Use the readLine method to read a single line from a file previously opened for reading. Use isEOF to check for end of file while reading. </p>
  344. <dl class="section return"><dt>Returns</dt><dd>Returns the next line in the file, or a NULL string if the end-of-file has been reached. </dd></dl>
  345. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classFileObject.html#add1bb76c25da8c0e2d0124f7af708e29">isEOF</a>, <a class="el" href="classFileObject.html#a69a94afd2520b4781661a87d464944f8">openForRead</a> </dd></dl>
  346. </div>
  347. </div>
  348. <a class="anchor" id="ac7e9c4b626b6d25eebb639499fc7ed44"></a>
  349. <div class="memitem">
  350. <div class="memproto">
  351. <table class="mlabels">
  352. <tr>
  353. <td class="mlabels-left">
  354. <table class="memname">
  355. <tr>
  356. <td class="memname">virtual void FileObject::writeLine </td>
  357. <td>(</td>
  358. <td class="paramtype">text&#160;</td>
  359. <td class="paramname"></td><td>)</td>
  360. <td></td>
  361. </tr>
  362. </table>
  363. </td>
  364. <td class="mlabels-right">
  365. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  366. </tr>
  367. </table>
  368. </div><div class="memdoc">
  369. <p>Use the writeLine method to write a value ( text ) into a file that was previously opened for appending or over-writing. </p>
  370. <dl class="params"><dt>Parameters</dt><dd>
  371. <table class="params">
  372. <tr><td class="paramname">text</td><td>The value to write to the file. </td></tr>
  373. </table>
  374. </dd>
  375. </dl>
  376. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  377. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classFileObject.html#a118f147e0d85896ccec8bea3e0baa482">openForAppend</a>, <a class="el" href="classFileObject.html#a487b112f6ba7e985ebea15d8057257be">openForWrite</a> </dd></dl>
  378. </div>
  379. </div>
  380. <a class="anchor" id="a83893d13eabe610837e5b48185cc5457"></a>
  381. <div class="memitem">
  382. <div class="memproto">
  383. <table class="mlabels">
  384. <tr>
  385. <td class="mlabels-left">
  386. <table class="memname">
  387. <tr>
  388. <td class="memname">virtual void FileObject::writeObject </td>
  389. <td>(</td>
  390. <td class="paramtype"><a class="el" href="classSimObject.html">SimObject</a>&#160;</td>
  391. <td class="paramname">, </td>
  392. </tr>
  393. <tr>
  394. <td class="paramkey"></td>
  395. <td></td>
  396. <td class="paramtype">object&#160;</td>
  397. <td class="paramname"><em>prepend</em>&#160;</td>
  398. </tr>
  399. <tr>
  400. <td></td>
  401. <td>)</td>
  402. <td></td><td></td>
  403. </tr>
  404. </table>
  405. </td>
  406. <td class="mlabels-right">
  407. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  408. </tr>
  409. </table>
  410. </div><div class="memdoc">
  411. </div>
  412. </div>
  413. <h2 class="groupheader">Member Data Documentation</h2>
  414. <a class="anchor" id="ac7b0fabdab24a5e869ca14f072c00c4f"></a>
  415. <div class="memitem">
  416. <div class="memproto">
  417. <table class="memname">
  418. <tr>
  419. <td class="memname">bool FileObject::canSaveDynamicFields</td>
  420. </tr>
  421. </table>
  422. </div><div class="memdoc">
  423. </div>
  424. </div>
  425. <a class="anchor" id="a259e395e5801ebe2378341ab83636aca"></a>
  426. <div class="memitem">
  427. <div class="memproto">
  428. <table class="memname">
  429. <tr>
  430. <td class="memname">string FileObject::class</td>
  431. </tr>
  432. </table>
  433. </div><div class="memdoc">
  434. <p>Script SuperClass of object. </p>
  435. </div>
  436. </div>
  437. <a class="anchor" id="a1be4a135417bdc3b788ff94432d28eff"></a>
  438. <div class="memitem">
  439. <div class="memproto">
  440. <table class="memname">
  441. <tr>
  442. <td class="memname">string FileObject::internalName</td>
  443. </tr>
  444. </table>
  445. </div><div class="memdoc">
  446. </div>
  447. </div>
  448. <a class="anchor" id="a12e3047486a99c6a73218cbd391db99d"></a>
  449. <div class="memitem">
  450. <div class="memproto">
  451. <table class="memname">
  452. <tr>
  453. <td class="memname">SimObjectPtr FileObject::parentGroup</td>
  454. </tr>
  455. </table>
  456. </div><div class="memdoc">
  457. <p>Group hierarchy parent of the object. </p>
  458. </div>
  459. </div>
  460. <a class="anchor" id="a38837858ed24b063bcf369c004a1fb34"></a>
  461. <div class="memitem">
  462. <div class="memproto">
  463. <table class="memname">
  464. <tr>
  465. <td class="memname">string FileObject::superclass</td>
  466. </tr>
  467. </table>
  468. </div><div class="memdoc">
  469. <p>Script Class of object. </p>
  470. </div>
  471. </div>
  472. </div><!-- contents -->
  473. <!-- START FOOTER -->
  474. <br>
  475. <br>
  476. <center>
  477. <div style="color: #777777;">
  478. Copyright &copy; 2013 <a style="color: #777777;" target="_blank" href="http://www.garagegames.com">GarageGames, LLC</a>. All Rights Reserved.
  479. </div>
  480. </center>
  481. </body>
  482. </html>