| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <title>FileObject Class Reference</title>
- <link href="torquedoc.css" rel="stylesheet" type="text/css"/>
- </head>
- <body>
- <table width="100%" class="header">
- <tr>
- </tr>
- <tr><td class="headermenu">
- <center>
- <a class="qindex" href="index.html">Main</a>
- <a class="qindex" target="_blank" href="https://github.com/GarageGames/Torque2D">GitHub</a>
- </center>
- </td></tr>
- </table>
- <br>
- <!-- END HEADER -->
- <!-- Generated by Doxygen 1.8.3.1 -->
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="classFileObject-members.html">List of all members</a> |
- <a href="#pub-methods">Public Member Functions</a> </div>
- <div class="headertitle">
- <div class="title">FileObject Class Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>Inherits <a class="el" href="classSimObject.html">SimObject</a>.</p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:a32c1b5f1eb47280ac608fb18d249e364"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#a32c1b5f1eb47280ac608fb18d249e364">close</a> ()</td></tr>
- <tr class="separator:a32c1b5f1eb47280ac608fb18d249e364"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:add1bb76c25da8c0e2d0124f7af708e29"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#add1bb76c25da8c0e2d0124f7af708e29">isEOF</a> ()</td></tr>
- <tr class="separator:add1bb76c25da8c0e2d0124f7af708e29"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a118f147e0d85896ccec8bea3e0baa482"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#a118f147e0d85896ccec8bea3e0baa482">openForAppend</a> (filename)</td></tr>
- <tr class="separator:a118f147e0d85896ccec8bea3e0baa482"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a69a94afd2520b4781661a87d464944f8"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#a69a94afd2520b4781661a87d464944f8">openForRead</a> (filename)</td></tr>
- <tr class="separator:a69a94afd2520b4781661a87d464944f8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a487b112f6ba7e985ebea15d8057257be"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#a487b112f6ba7e985ebea15d8057257be">openForWrite</a> (filename)</td></tr>
- <tr class="separator:a487b112f6ba7e985ebea15d8057257be"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae50932f54495c3dd9621a6fb65755c55"><td class="memItemLeft" align="right" valign="top">virtual string </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#ae50932f54495c3dd9621a6fb65755c55">peekLine</a> ()</td></tr>
- <tr class="separator:ae50932f54495c3dd9621a6fb65755c55"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aea784f430816e21c2ae3c3feea752a29"><td class="memItemLeft" align="right" valign="top">virtual string </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#aea784f430816e21c2ae3c3feea752a29">readLine</a> ()</td></tr>
- <tr class="separator:aea784f430816e21c2ae3c3feea752a29"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac7e9c4b626b6d25eebb639499fc7ed44"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#ac7e9c4b626b6d25eebb639499fc7ed44">writeLine</a> (text)</td></tr>
- <tr class="separator:ac7e9c4b626b6d25eebb639499fc7ed44"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a83893d13eabe610837e5b48185cc5457"><td class="memItemLeft" align="right" valign="top">virtual void </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>
- <tr class="separator:a83893d13eabe610837e5b48185cc5457"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_methods_classSimObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classSimObject')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classSimObject.html">SimObject</a></td></tr>
- <tr class="memitem:aa19815069e82c393e2c10885eabf8016 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa19815069e82c393e2c10885eabf8016">addFieldFilter</a> (fieldName)</td></tr>
- <tr class="separator:aa19815069e82c393e2c10885eabf8016 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a804a3fb06b864699c7bc2601e685756d inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a804a3fb06b864699c7bc2601e685756d">call</a> (%args)</td></tr>
- <tr class="separator:a804a3fb06b864699c7bc2601e685756d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abce68a893b7efa10c06ea780ddda7f06 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#abce68a893b7efa10c06ea780ddda7f06">clone</a> ([bool copyDynamicFields?=false])</td></tr>
- <tr class="separator:abce68a893b7efa10c06ea780ddda7f06 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0407d340f60883977e60e7414f804be8 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0407d340f60883977e60e7414f804be8">delete</a> ()</td></tr>
- <tr class="separator:a0407d340f60883977e60e7414f804be8 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6a5e4ea85ff866ed5340d20993541c50 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a6a5e4ea85ff866ed5340d20993541c50">dump</a> ()</td></tr>
- <tr class="separator:a6a5e4ea85ff866ed5340d20993541c50 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7b595302fce08857b11a01bbb1083a7e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7b595302fce08857b11a01bbb1083a7e">dumpClassHierarchy</a> ()</td></tr>
- <tr class="separator:a7b595302fce08857b11a01bbb1083a7e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8e927f41d38b279dc8684f7ced03c0fb inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a8e927f41d38b279dc8684f7ced03c0fb">getClassName</a> ()</td></tr>
- <tr class="separator:a8e927f41d38b279dc8684f7ced03c0fb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a90cc89c3cebc772fdadfd9ac87ecd24e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a90cc89c3cebc772fdadfd9ac87ecd24e">getClassNamespace</a> ()</td></tr>
- <tr class="separator:a90cc89c3cebc772fdadfd9ac87ecd24e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a09ab8f9a6a8e3ee0cfc3c78ebb54f113 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a09ab8f9a6a8e3ee0cfc3c78ebb54f113">getDynamicField</a> (index)</td></tr>
- <tr class="separator:a09ab8f9a6a8e3ee0cfc3c78ebb54f113 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2d78d37eac1f119baf560cd273c03538 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a2d78d37eac1f119baf560cd273c03538">getDynamicFieldCount</a> ()</td></tr>
- <tr class="separator:a2d78d37eac1f119baf560cd273c03538 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a55ace9339e968c26428e0082bd190693 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a55ace9339e968c26428e0082bd190693">getField</a> (int index)</td></tr>
- <tr class="separator:a55ace9339e968c26428e0082bd190693 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abef30dc0fc312dd3334e2a4a8491da37 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#abef30dc0fc312dd3334e2a4a8491da37">getFieldCount</a> ()</td></tr>
- <tr class="separator:abef30dc0fc312dd3334e2a4a8491da37 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6e9001db89eb8822430f0d02c6108b43 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a6e9001db89eb8822430f0d02c6108b43">getFieldType</a> (fieldName)</td></tr>
- <tr class="separator:a6e9001db89eb8822430f0d02c6108b43 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:addb1c5fbb1495cf580318456b639548d inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#addb1c5fbb1495cf580318456b639548d">getFieldValue</a> (fieldName)</td></tr>
- <tr class="separator:addb1c5fbb1495cf580318456b639548d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1a4f6c730ac5325e79cc4554e43db26e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1a4f6c730ac5325e79cc4554e43db26e">getGroup</a> ()</td></tr>
- <tr class="separator:a1a4f6c730ac5325e79cc4554e43db26e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a230cd7c02705a8d3eea78cacb320591f inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a230cd7c02705a8d3eea78cacb320591f">getId</a> ()</td></tr>
- <tr class="separator:a230cd7c02705a8d3eea78cacb320591f inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9b026d477bdd586a8ad5ee0e7a6fb7fe inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9b026d477bdd586a8ad5ee0e7a6fb7fe">getInternalName</a> ()</td></tr>
- <tr class="separator:a9b026d477bdd586a8ad5ee0e7a6fb7fe inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a84e32f38cdb775bfe739867d55737b4d inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a84e32f38cdb775bfe739867d55737b4d">getName</a> ()</td></tr>
- <tr class="separator:a84e32f38cdb775bfe739867d55737b4d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1058915844541a6bebebc75415bbe7e0 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1058915844541a6bebebc75415bbe7e0">getProgenitorFile</a> ()</td></tr>
- <tr class="separator:a1058915844541a6bebebc75415bbe7e0 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4b464b66407955fa435f66dc684971c8 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a4b464b66407955fa435f66dc684971c8">getSuperClassNamespace</a> ()</td></tr>
- <tr class="separator:a4b464b66407955fa435f66dc684971c8 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a320f74b22aa85775725f8569154d667e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a320f74b22aa85775725f8569154d667e">getType</a> ()</td></tr>
- <tr class="separator:a320f74b22aa85775725f8569154d667e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1260a9ecd13cdbea359d9fe7c045794e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1260a9ecd13cdbea359d9fe7c045794e">isChildOfGroup</a> ()</td></tr>
- <tr class="separator:a1260a9ecd13cdbea359d9fe7c045794e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a86048647be436a21246de6a92f807ea4 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a86048647be436a21246de6a92f807ea4">isMemberOfClass</a> (string classname)</td></tr>
- <tr class="separator:a86048647be436a21246de6a92f807ea4 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a89bdccd1d3b307d9caf08496003a63cb inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a89bdccd1d3b307d9caf08496003a63cb">isMethod</a> (string method name)</td></tr>
- <tr class="separator:a89bdccd1d3b307d9caf08496003a63cb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4d77984a510b832f0f2a87d132192af1 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a4d77984a510b832f0f2a87d132192af1">isTimerActive</a> ()</td></tr>
- <tr class="separator:a4d77984a510b832f0f2a87d132192af1 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5a3e025c27ebe1d34a8485ee53199dcb inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5a3e025c27ebe1d34a8485ee53199dcb">removeFieldFilter</a> (fieldName)</td></tr>
- <tr class="separator:a5a3e025c27ebe1d34a8485ee53199dcb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aac4f9db0033e9192254a8308f6101909 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aac4f9db0033e9192254a8308f6101909">save</a> (fileName,[selectedOnly])</td></tr>
- <tr class="separator:aac4f9db0033e9192254a8308f6101909 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a38c14c64f403c3df7749ca315c325386 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a38c14c64f403c3df7749ca315c325386">schedule</a> (time, command,< arg1...argN >)</td></tr>
- <tr class="separator:a38c14c64f403c3df7749ca315c325386 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac70958a4cae93deda0d031947d187892 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ac70958a4cae93deda0d031947d187892">setClassNamespace</a> ()</td></tr>
- <tr class="separator:ac70958a4cae93deda0d031947d187892 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a29f97240eeaf780e9c02bee7aa6e7b25 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a29f97240eeaf780e9c02bee7aa6e7b25">setFieldValue</a> (fieldName, value)</td></tr>
- <tr class="separator:a29f97240eeaf780e9c02bee7aa6e7b25 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acf355cf2001b85ffcf07958400c97605 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#acf355cf2001b85ffcf07958400c97605">setInternalName</a> ()</td></tr>
- <tr class="separator:acf355cf2001b85ffcf07958400c97605 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1e799de6b4329f9ce9b94a176ad1cfbb inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1e799de6b4329f9ce9b94a176ad1cfbb">setName</a> (newName)</td></tr>
- <tr class="separator:a1e799de6b4329f9ce9b94a176ad1cfbb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad2b00ab622649aa8b1b2b5600ea4abb1 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad2b00ab622649aa8b1b2b5600ea4abb1">setProgenitorFile</a> (file)</td></tr>
- <tr class="separator:ad2b00ab622649aa8b1b2b5600ea4abb1 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a94f53f0f93ced24b597de83aa122e824 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a94f53f0f93ced24b597de83aa122e824">setSuperClassNamespace</a> ()</td></tr>
- <tr class="separator:a94f53f0f93ced24b597de83aa122e824 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab928f21c5a7e13a0c2cdbcf479c9e07d inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab928f21c5a7e13a0c2cdbcf479c9e07d">startTimer</a> (callbackFunction, float timePeriod,[repeat])</td></tr>
- <tr class="separator:ab928f21c5a7e13a0c2cdbcf479c9e07d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acd9c4032150dd0566eca593062588e9f inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#acd9c4032150dd0566eca593062588e9f">stopTimer</a> ()</td></tr>
- <tr class="separator:acd9c4032150dd0566eca593062588e9f inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
- Public Attributes</h2></td></tr>
- <tr><td colspan="2"><div class="groupHeader">SimBase</div></td></tr>
- <tr class="memitem:ac7b0fabdab24a5e869ca14f072c00c4f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#ac7b0fabdab24a5e869ca14f072c00c4f">canSaveDynamicFields</a></td></tr>
- <tr class="separator:ac7b0fabdab24a5e869ca14f072c00c4f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1be4a135417bdc3b788ff94432d28eff"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#a1be4a135417bdc3b788ff94432d28eff">internalName</a></td></tr>
- <tr class="separator:a1be4a135417bdc3b788ff94432d28eff"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a12e3047486a99c6a73218cbd391db99d"><td class="memItemLeft" align="right" valign="top">SimObjectPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#a12e3047486a99c6a73218cbd391db99d">parentGroup</a></td></tr>
- <tr class="separator:a12e3047486a99c6a73218cbd391db99d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr><td colspan="2"><div class="groupHeader">Namespace Linking</div></td></tr>
- <tr class="memitem:a38837858ed24b063bcf369c004a1fb34"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#a38837858ed24b063bcf369c004a1fb34">superclass</a></td></tr>
- <tr class="separator:a38837858ed24b063bcf369c004a1fb34"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a259e395e5801ebe2378341ab83636aca"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileObject.html#a259e395e5801ebe2378341ab83636aca">class</a></td></tr>
- <tr class="separator:a259e395e5801ebe2378341ab83636aca"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_attribs_classSimObject"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classSimObject')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="classSimObject.html">SimObject</a></td></tr>
- <tr class="memitem:ab49fae316a2d0c12834f50c3d77202e6 inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab49fae316a2d0c12834f50c3d77202e6">canSaveDynamicFields</a></td></tr>
- <tr class="separator:ab49fae316a2d0c12834f50c3d77202e6 inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad03202387165717f164f996a5b22c9bb inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad03202387165717f164f996a5b22c9bb">internalName</a></td></tr>
- <tr class="separator:ad03202387165717f164f996a5b22c9bb inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0f783d7e37cad2b0a9d6f7b0d1672a28 inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">SimObjectPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0f783d7e37cad2b0a9d6f7b0d1672a28">parentGroup</a></td></tr>
- <tr class="separator:a0f783d7e37cad2b0a9d6f7b0d1672a28 inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa0d134072878053537fefb1768b63d3f inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa0d134072878053537fefb1768b63d3f">superclass</a></td></tr>
- <tr class="separator:aa0d134072878053537fefb1768b63d3f inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab83c7a59a66018d9b5eec3c8dcd3397d inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab83c7a59a66018d9b5eec3c8dcd3397d">class</a></td></tr>
- <tr class="separator:ab83c7a59a66018d9b5eec3c8dcd3397d inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a class="anchor" id="a32c1b5f1eb47280ac608fb18d249e364"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void FileObject::close </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- <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>
- </div>
- </div>
- <a class="anchor" id="add1bb76c25da8c0e2d0124f7af708e29"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual bool FileObject::isEOF </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the isEOF method to check to see if the end of the current file (opened for read) has been reached. </p>
- <dl class="section return"><dt>Returns</dt><dd>Returns true if the end of file has been reached, false otherwise. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classFileObject.html#a69a94afd2520b4781661a87d464944f8">openForRead</a> </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a118f147e0d85896ccec8bea3e0baa482"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual bool FileObject::openForAppend </td>
- <td>(</td>
- <td class="paramtype">filename </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">filename</td><td>The path and filename of the file to open for appending. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns true if the file was successfully opened for appending, false otherwise. </dd></dl>
- <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>
- </div>
- </div>
- <a class="anchor" id="a69a94afd2520b4781661a87d464944f8"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual bool FileObject::openForRead </td>
- <td>(</td>
- <td class="paramtype">filename </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the openForRead method to open a previously created file for reading. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">filename</td><td>The path and filename of the file to open for reading. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns true if the file was successfully opened for reading, false otherwise. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classFileObject.html#a32c1b5f1eb47280ac608fb18d249e364">close</a>, OpenForAppend, OpenForWrite </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a487b112f6ba7e985ebea15d8057257be"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual bool FileObject::openForWrite </td>
- <td>(</td>
- <td class="paramtype">filename </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the openForWrite method to previously created or a new file for writing. In either case, the file will be overwritten. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">filename</td><td>The path and filename of the file to open for writing. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns true if the file was successfully opened for writing, false otherwise. </dd></dl>
- <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>
- </div>
- </div>
- <a class="anchor" id="ae50932f54495c3dd9621a6fb65755c55"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual string FileObject::peekLine </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Read a line from the file without moving the stream position. </p>
- </div>
- </div>
- <a class="anchor" id="aea784f430816e21c2ae3c3feea752a29"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual string FileObject::readLine </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <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>
- <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>
- </div>
- </div>
- <a class="anchor" id="ac7e9c4b626b6d25eebb639499fc7ed44"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void FileObject::writeLine </td>
- <td>(</td>
- <td class="paramtype">text </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the writeLine method to write a value ( text ) into a file that was previously opened for appending or over-writing. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">text</td><td>The value to write to the file. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- <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>
- </div>
- </div>
- <a class="anchor" id="a83893d13eabe610837e5b48185cc5457"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void FileObject::writeObject </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classSimObject.html">SimObject</a> </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">object </td>
- <td class="paramname"><em>prepend</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <h2 class="groupheader">Member Data Documentation</h2>
- <a class="anchor" id="ac7b0fabdab24a5e869ca14f072c00c4f"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool FileObject::canSaveDynamicFields</td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a class="anchor" id="a259e395e5801ebe2378341ab83636aca"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string FileObject::class</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Script SuperClass of object. </p>
- </div>
- </div>
- <a class="anchor" id="a1be4a135417bdc3b788ff94432d28eff"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string FileObject::internalName</td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a class="anchor" id="a12e3047486a99c6a73218cbd391db99d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">SimObjectPtr FileObject::parentGroup</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Group hierarchy parent of the object. </p>
- </div>
- </div>
- <a class="anchor" id="a38837858ed24b063bcf369c004a1fb34"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string FileObject::superclass</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Script Class of object. </p>
- </div>
- </div>
- </div><!-- contents -->
- <!-- START FOOTER -->
- <br>
- <br>
- <center>
- <div style="color: #777777;">
- Copyright © 2013 <a style="color: #777777;" target="_blank" href="http://www.garagegames.com">GarageGames, LLC</a>. All Rights Reserved.
- </div>
- </center>
- </body>
- </html>
|