| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=11"/>
- <meta name="generator" content="Doxygen 1.9.8"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>TorqueScript Reference: ZipObject Class Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr id="projectrow">
- <td id="projectalign">
- <div id="projectname">TorqueScript Reference
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.9.8 -->
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function() {
- initMenu('',false,false,'search.php','Search');
- });
- /* @license-end */
- </script>
- <div id="main-nav"></div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#pub-static-attribs">Static Public Attributes</a> |
- <a href="classZipObject-members.html">List of all members</a> </div>
- <div class="headertitle"><div class="title">ZipObject Class Reference</div></div>
- </div><!--header-->
- <div class="contents">
- <p><code>#include <zipObject_ScriptBinding.h></code></p>
- <p>Inherits <a class="el" href="classSimObject.html">SimObject</a>.</p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:a8a6158d04c36d9389663bb7d9a30ac1d" id="r_a8a6158d04c36d9389663bb7d9a30ac1d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classZipObject.html#a8a6158d04c36d9389663bb7d9a30ac1d">addFile</a> (filename, pathInZip, [replace=true]?)</td></tr>
- <tr class="separator:a8a6158d04c36d9389663bb7d9a30ac1d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3a5c2200839483da2c31b171e993a0c0" id="r_a3a5c2200839483da2c31b171e993a0c0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classZipObject.html#a3a5c2200839483da2c31b171e993a0c0">closeArchive</a> ()</td></tr>
- <tr class="separator:a3a5c2200839483da2c31b171e993a0c0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad2232b510598c27d3c93f7e06a145e02" id="r_ad2232b510598c27d3c93f7e06a145e02"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classZipObject.html#ad2232b510598c27d3c93f7e06a145e02">closeFile</a> (stream)</td></tr>
- <tr class="separator:ad2232b510598c27d3c93f7e06a145e02"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9ea24f64d8382a1adb616f7b9b919157" id="r_a9ea24f64d8382a1adb616f7b9b919157"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classZipObject.html#a9ea24f64d8382a1adb616f7b9b919157">deleteFile</a> (pathInZip)</td></tr>
- <tr class="separator:a9ea24f64d8382a1adb616f7b9b919157"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6e059666988d183751fd67b4a6e13960" id="r_a6e059666988d183751fd67b4a6e13960"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classZipObject.html#a6e059666988d183751fd67b4a6e13960">extractFile</a> (pathInZip, filename)</td></tr>
- <tr class="separator:a6e059666988d183751fd67b4a6e13960"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2dedb9bcbe10b75235c47bd5b4397365" id="r_a2dedb9bcbe10b75235c47bd5b4397365"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classZipObject.html#a2dedb9bcbe10b75235c47bd5b4397365">getFileEntry</a> (index)</td></tr>
- <tr class="separator:a2dedb9bcbe10b75235c47bd5b4397365"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4ba9f9f5018d90e92211555779cf7208" id="r_a4ba9f9f5018d90e92211555779cf7208"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classZipObject.html#a4ba9f9f5018d90e92211555779cf7208">getFileEntryCount</a> ()</td></tr>
- <tr class="separator:a4ba9f9f5018d90e92211555779cf7208"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afdd3d54419656ce143cd927960d6ca31" id="r_afdd3d54419656ce143cd927960d6ca31"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classZipObject.html#afdd3d54419656ce143cd927960d6ca31">openArchive</a> (filename, [accessMode=Read]?)</td></tr>
- <tr class="separator:afdd3d54419656ce143cd927960d6ca31"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af7d3c416a6ba223b849f9c1e39baec8c" id="r_af7d3c416a6ba223b849f9c1e39baec8c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classZipObject.html#af7d3c416a6ba223b849f9c1e39baec8c">openFileForRead</a> (filename)</td></tr>
- <tr class="separator:af7d3c416a6ba223b849f9c1e39baec8c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad3c46eac18e8f56a652511d278e5eb01" id="r_ad3c46eac18e8f56a652511d278e5eb01"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classZipObject.html#ad3c46eac18e8f56a652511d278e5eb01">openFileForWrite</a> (filename)</td></tr>
- <tr class="separator:ad3c46eac18e8f56a652511d278e5eb01"><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:a2375929bea4901d98ae352231b0721ad inherit pub_methods_classSimObject" id="r_a2375929bea4901d98ae352231b0721ad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a2375929bea4901d98ae352231b0721ad">assignFieldsFrom</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
- <tr class="separator:a2375929bea4901d98ae352231b0721ad inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a22437f451ceb1429fa2a3be23d523954 inherit pub_methods_classSimObject" id="r_a22437f451ceb1429fa2a3be23d523954"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a22437f451ceb1429fa2a3be23d523954">clone</a> ([copyDynamicFields=false]?)</td></tr>
- <tr class="separator:a22437f451ceb1429fa2a3be23d523954 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject" id="r_a7a4721d0a51e952c211e9b0fea4d8090"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7a4721d0a51e952c211e9b0fea4d8090">delete</a> ()</td></tr>
- <tr class="separator:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a929e1325a515b279faca90a65028782e inherit pub_methods_classSimObject" id="r_a929e1325a515b279faca90a65028782e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a929e1325a515b279faca90a65028782e">getId</a> ()</td></tr>
- <tr class="separator:a929e1325a515b279faca90a65028782e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject" id="r_a4f673cd959711ae09927e7c44dae5fdb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a4f673cd959711ae09927e7c44dae5fdb">setName</a> (newName)</td></tr>
- <tr class="separator:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a78ee178b6a73658d65ca60da4d1e6683 inherit pub_methods_classSimObject" id="r_a78ee178b6a73658d65ca60da4d1e6683"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a78ee178b6a73658d65ca60da4d1e6683">getName</a> ()</td></tr>
- <tr class="separator:a78ee178b6a73658d65ca60da4d1e6683 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab8b0f8b874af628d7204d9cc2630ced7 inherit pub_methods_classSimObject" id="r_ab8b0f8b874af628d7204d9cc2630ced7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab8b0f8b874af628d7204d9cc2630ced7">getClassNamespace</a> ()</td></tr>
- <tr class="separator:ab8b0f8b874af628d7204d9cc2630ced7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6e266d4432d70cad58461d96e1d2cbdf inherit pub_methods_classSimObject" id="r_a6e266d4432d70cad58461d96e1d2cbdf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a6e266d4432d70cad58461d96e1d2cbdf">getSuperClassNamespace</a> ()</td></tr>
- <tr class="separator:a6e266d4432d70cad58461d96e1d2cbdf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a847e859bcc5b58df83fa7f331c167c32 inherit pub_methods_classSimObject" id="r_a847e859bcc5b58df83fa7f331c167c32"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a847e859bcc5b58df83fa7f331c167c32">setClassNamespace</a> (nameSpace)</td></tr>
- <tr class="separator:a847e859bcc5b58df83fa7f331c167c32 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject" id="r_a9cbf471b97387d5bdefb88f92094ad54"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9cbf471b97387d5bdefb88f92094ad54">setSuperClassNamespace</a> ()</td></tr>
- <tr class="separator:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8f4e85d0903526235ed2ca86df69cdef inherit pub_methods_classSimObject" id="r_a8f4e85d0903526235ed2ca86df69cdef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a8f4e85d0903526235ed2ca86df69cdef">isMethod</a> (string methodName)</td></tr>
- <tr class="separator:a8f4e85d0903526235ed2ca86df69cdef inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9ce8801999cf2228ddde6d58ca3773d5 inherit pub_methods_classSimObject" id="r_a9ce8801999cf2228ddde6d58ca3773d5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9ce8801999cf2228ddde6d58ca3773d5">call</a> (methodName, [args] *)</td></tr>
- <tr class="separator:a9ce8801999cf2228ddde6d58ca3773d5 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject" id="r_a1810f5aba25efd242c24232c2c2bbd1a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1810f5aba25efd242c24232c2c2bbd1a">dumpClassHierarchy</a> ()</td></tr>
- <tr class="separator:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject" id="r_accd2600060dbaee3a3b41aed4034c63c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#accd2600060dbaee3a3b41aed4034c63c">dump</a> ()</td></tr>
- <tr class="separator:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a66ac731a8dc088fe8c8ab17bf7c9eecd inherit pub_methods_classSimObject" id="r_a66ac731a8dc088fe8c8ab17bf7c9eecd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a66ac731a8dc088fe8c8ab17bf7c9eecd">isMemberOfClass</a> (string classname)</td></tr>
- <tr class="separator:a66ac731a8dc088fe8c8ab17bf7c9eecd inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3e97a324df2af082cdb089491757ce11 inherit pub_methods_classSimObject" id="r_a3e97a324df2af082cdb089491757ce11"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a3e97a324df2af082cdb089491757ce11">getClassName</a> ()</td></tr>
- <tr class="separator:a3e97a324df2af082cdb089491757ce11 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abc2222a9649b5c033810e753b07f26a3 inherit pub_methods_classSimObject" id="r_abc2222a9649b5c033810e753b07f26a3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#abc2222a9649b5c033810e753b07f26a3">getFieldValue</a> (fieldName)</td></tr>
- <tr class="separator:abc2222a9649b5c033810e753b07f26a3 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1084f1964e446b3d279943cf6e575069 inherit pub_methods_classSimObject" id="r_a1084f1964e446b3d279943cf6e575069"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1084f1964e446b3d279943cf6e575069">setFieldValue</a> (fieldName, value)</td></tr>
- <tr class="separator:a1084f1964e446b3d279943cf6e575069 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab4e32fb984d9ce6584b0fa57c8772d3e inherit pub_methods_classSimObject" id="r_ab4e32fb984d9ce6584b0fa57c8772d3e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab4e32fb984d9ce6584b0fa57c8772d3e">setEditFieldValue</a> (fieldName, value)</td></tr>
- <tr class="separator:ab4e32fb984d9ce6584b0fa57c8772d3e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7543b8dc494ec0d9034cb73ae504f3ca inherit pub_methods_classSimObject" id="r_a7543b8dc494ec0d9034cb73ae504f3ca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7543b8dc494ec0d9034cb73ae504f3ca">getDynamicFieldCount</a> ()</td></tr>
- <tr class="separator:a7543b8dc494ec0d9034cb73ae504f3ca inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0e143217119b68d557d17ac2f13b173e inherit pub_methods_classSimObject" id="r_a0e143217119b68d557d17ac2f13b173e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0e143217119b68d557d17ac2f13b173e">getDynamicField</a> (index)</td></tr>
- <tr class="separator:a0e143217119b68d557d17ac2f13b173e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af2e74f6b683da8d2085f0991dab7948b inherit pub_methods_classSimObject" id="r_af2e74f6b683da8d2085f0991dab7948b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af2e74f6b683da8d2085f0991dab7948b">getFieldCount</a> ()</td></tr>
- <tr class="separator:af2e74f6b683da8d2085f0991dab7948b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac636f89189406eef1b401292459b1a3b inherit pub_methods_classSimObject" id="r_ac636f89189406eef1b401292459b1a3b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ac636f89189406eef1b401292459b1a3b">getField</a> (int index)</td></tr>
- <tr class="separator:ac636f89189406eef1b401292459b1a3b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject" id="r_aa8f68d1e6d8c6601c39b3f676f0e9c70"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa8f68d1e6d8c6601c39b3f676f0e9c70">setProgenitorFile</a> (file)</td></tr>
- <tr class="separator:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a88c8d99755a07ac4648360dd40ff67a5 inherit pub_methods_classSimObject" id="r_a88c8d99755a07ac4648360dd40ff67a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a88c8d99755a07ac4648360dd40ff67a5">getProgenitorFile</a> ()</td></tr>
- <tr class="separator:a88c8d99755a07ac4648360dd40ff67a5 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a367706e675179342e6153c45f1ba06ae inherit pub_methods_classSimObject" id="r_a367706e675179342e6153c45f1ba06ae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a367706e675179342e6153c45f1ba06ae">getType</a> ()</td></tr>
- <tr class="separator:a367706e675179342e6153c45f1ba06ae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0570b7f6eb94a0ed941fd75f6f01555b inherit pub_methods_classSimObject" id="r_a0570b7f6eb94a0ed941fd75f6f01555b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0570b7f6eb94a0ed941fd75f6f01555b">getFieldType</a> (fieldName)</td></tr>
- <tr class="separator:a0570b7f6eb94a0ed941fd75f6f01555b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject" id="r_a5aaca360a719feabae0e4e57b921deae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5aaca360a719feabae0e4e57b921deae">setInternalName</a> (string InternalName)</td></tr>
- <tr class="separator:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af9f341b474a28f4bcf79bc02439b7c18 inherit pub_methods_classSimObject" id="r_af9f341b474a28f4bcf79bc02439b7c18"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af9f341b474a28f4bcf79bc02439b7c18">getInternalName</a> ()</td></tr>
- <tr class="separator:af9f341b474a28f4bcf79bc02439b7c18 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a986f1b4a76969bac5dfd50b22af8dec6 inherit pub_methods_classSimObject" id="r_a986f1b4a76969bac5dfd50b22af8dec6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a986f1b4a76969bac5dfd50b22af8dec6">isChildOfGroup</a> (groupID)</td></tr>
- <tr class="separator:a986f1b4a76969bac5dfd50b22af8dec6 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae329d6593bb3f9b8046e7cae693ccc09 inherit pub_methods_classSimObject" id="r_ae329d6593bb3f9b8046e7cae693ccc09"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ae329d6593bb3f9b8046e7cae693ccc09">getGroup</a> ()</td></tr>
- <tr class="separator:ae329d6593bb3f9b8046e7cae693ccc09 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a39653bc04e82875f2dc8d6dea25acdaa inherit pub_methods_classSimObject" id="r_a39653bc04e82875f2dc8d6dea25acdaa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a39653bc04e82875f2dc8d6dea25acdaa">startTimer</a> (callbackFunction, float timePeriod, [repeat]?)</td></tr>
- <tr class="separator:a39653bc04e82875f2dc8d6dea25acdaa inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject" id="r_aa6f6bfef028c7b053444cbd48567d286"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa6f6bfef028c7b053444cbd48567d286">stopTimer</a> ()</td></tr>
- <tr class="separator:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5807c03d2b725a54732d09b53d5da631 inherit pub_methods_classSimObject" id="r_a5807c03d2b725a54732d09b53d5da631"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5807c03d2b725a54732d09b53d5da631">isTimerActive</a> ()</td></tr>
- <tr class="separator:a5807c03d2b725a54732d09b53d5da631 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a16d537cd7a1c438045bb756fe1e22d2d inherit pub_methods_classSimObject" id="r_a16d537cd7a1c438045bb756fe1e22d2d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a16d537cd7a1c438045bb756fe1e22d2d">schedule</a> (time, command, [arg] *)</td></tr>
- <tr class="separator:a16d537cd7a1c438045bb756fe1e22d2d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9f05bc4a94b98e2e3347fe34aeefe7c4 inherit pub_methods_classSimObject" id="r_a9f05bc4a94b98e2e3347fe34aeefe7c4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9f05bc4a94b98e2e3347fe34aeefe7c4">startListening</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
- <tr class="separator:a9f05bc4a94b98e2e3347fe34aeefe7c4 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3f7f0520846a222310415ad7a8f8a4bf inherit pub_methods_classSimObject" id="r_a3f7f0520846a222310415ad7a8f8a4bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a3f7f0520846a222310415ad7a8f8a4bf">stopListening</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
- <tr class="separator:a3f7f0520846a222310415ad7a8f8a4bf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afa6eac5990b02024e77e3815161159df inherit pub_methods_classSimObject" id="r_afa6eac5990b02024e77e3815161159df"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#afa6eac5990b02024e77e3815161159df">addListener</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
- <tr class="separator:afa6eac5990b02024e77e3815161159df inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a07dd4cf0d113ff4a8943b900bda68a1c inherit pub_methods_classSimObject" id="r_a07dd4cf0d113ff4a8943b900bda68a1c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a07dd4cf0d113ff4a8943b900bda68a1c">removeListener</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
- <tr class="separator:a07dd4cf0d113ff4a8943b900bda68a1c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a87be48ec4599c3d02a118cee89e47f55 inherit pub_methods_classSimObject" id="r_a87be48ec4599c3d02a118cee89e47f55"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a87be48ec4599c3d02a118cee89e47f55">removeAllListeners</a> ()</td></tr>
- <tr class="separator:a87be48ec4599c3d02a118cee89e47f55 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1dcaa2910d6405134c74a71745d29154 inherit pub_methods_classSimObject" id="r_a1dcaa2910d6405134c74a71745d29154"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1dcaa2910d6405134c74a71745d29154">postEvent</a> (<a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> eventName, <a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> data)</td></tr>
- <tr class="separator:a1dcaa2910d6405134c74a71745d29154 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab6e816c3694e8b6119bf9ac3f5556f32 inherit pub_methods_classSimObject" id="r_ab6e816c3694e8b6119bf9ac3f5556f32"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab6e816c3694e8b6119bf9ac3f5556f32">save</a> (<a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>, [selectedOnly]?)</td></tr>
- <tr class="separator:ab6e816c3694e8b6119bf9ac3f5556f32 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a216228c27df224ac5e8d3590494bfb3f inherit pub_methods_classSimObject" id="r_a216228c27df224ac5e8d3590494bfb3f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a216228c27df224ac5e8d3590494bfb3f">addFieldFilter</a> (fieldName)</td></tr>
- <tr class="separator:a216228c27df224ac5e8d3590494bfb3f inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad517bd83c1c853985ab07cd22775c43d inherit pub_methods_classSimObject" id="r_ad517bd83c1c853985ab07cd22775c43d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad517bd83c1c853985ab07cd22775c43d">removeFieldFilter</a> (fieldName)</td></tr>
- <tr class="separator:ad517bd83c1c853985ab07cd22775c43d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
- Static Public Attributes</h2></td></tr>
- <tr class="memitem:a0b0e4ed1db1fd206b2cc4a8851262d13" id="r_a0b0e4ed1db1fd206b2cc4a8851262d13"><td class="memItemLeft" >struct { </td><td class="memItemRight" valign="bottom"></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac6c3dfb4c3a68f849f32cbfb21da4e77" id="r_ac6c3dfb4c3a68f849f32cbfb21da4e77"><td class="memItemLeft" >   Zip::ZipArchive::AccessMode   <a class="el" href="classZipObject.html#ac6c3dfb4c3a68f849f32cbfb21da4e77">mode</a> </td><td class="memItemRight" valign="bottom"></td></tr>
- <tr class="separator:ac6c3dfb4c3a68f849f32cbfb21da4e77"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab9eced2c5fab5729cc642106eaf65d9a" id="r_ab9eced2c5fab5729cc642106eaf65d9a"><td class="memItemLeft" >   const char *   <a class="el" href="classZipObject.html#ab9eced2c5fab5729cc642106eaf65d9a">strMode</a> </td><td class="memItemRight" valign="bottom"></td></tr>
- <tr class="separator:ab9eced2c5fab5729cc642106eaf65d9a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0b0e4ed1db1fd206b2cc4a8851262d13" id="r_a0b0e4ed1db1fd206b2cc4a8851262d13"><td class="memItemLeft" valign="top">} </td><td class="memItemRight" valign="bottom"><a class="el" href="classZipObject.html#a0b0e4ed1db1fd206b2cc4a8851262d13">gModeMap</a> [] </td><td class="memItemRight" valign="bottom"></td></tr>
- <tr class="separator:a0b0e4ed1db1fd206b2cc4a8851262d13"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="a8a6158d04c36d9389663bb7d9a30ac1d" name="a8a6158d04c36d9389663bb7d9a30ac1d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8a6158d04c36d9389663bb7d9a30ac1d">◆ </a></span>addFile()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> addFile </td>
- <td>(</td>
- <td class="paramtype">filename </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">pathInZip </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">[replace = true] ? </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Add a file to the zip </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">filename</td><td>The name of the file </td></tr>
- <tr><td class="paramname">pathInZip</td><td>The internal (to the zip) path to the file </td></tr>
- <tr><td class="paramname">replace</td><td>Set whether to replace the file if one already exists with the name in the path (default true) </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns true on success and false otherwise </dd></dl>
- </div>
- </div>
- <a id="a3a5c2200839483da2c31b171e993a0c0" name="a3a5c2200839483da2c31b171e993a0c0"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3a5c2200839483da2c31b171e993a0c0">◆ </a></span>closeArchive()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> closeArchive </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Close the zip file </p><dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- </div>
- </div>
- <a id="ad2232b510598c27d3c93f7e06a145e02" name="ad2232b510598c27d3c93f7e06a145e02"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad2232b510598c27d3c93f7e06a145e02">◆ </a></span>closeFile()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> closeFile </td>
- <td>(</td>
- <td class="paramtype">stream </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Close a file within the zip </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">stream</td><td>The file stream ID </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- </div>
- </div>
- <a id="a9ea24f64d8382a1adb616f7b9b919157" name="a9ea24f64d8382a1adb616f7b9b919157"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9ea24f64d8382a1adb616f7b9b919157">◆ </a></span>deleteFile()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> deleteFile </td>
- <td>(</td>
- <td class="paramtype">pathInZip </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Delete a file from the zip </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">pathInZip</td><td>The full internal path of the file </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns true on success and false otherwise. </dd></dl>
- </div>
- </div>
- <a id="a6e059666988d183751fd67b4a6e13960" name="a6e059666988d183751fd67b4a6e13960"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6e059666988d183751fd67b4a6e13960">◆ </a></span>extractFile()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> extractFile </td>
- <td>(</td>
- <td class="paramtype">pathInZip </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">filename </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Extract a file from the zip </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">pathInZip</td><td>The internal path of the desired file </td></tr>
- <tr><td class="paramname">filename</td><td>The file's name </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns true on success and false otherwise </dd></dl>
- </div>
- </div>
- <a id="a2dedb9bcbe10b75235c47bd5b4397365" name="a2dedb9bcbe10b75235c47bd5b4397365"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2dedb9bcbe10b75235c47bd5b4397365">◆ </a></span>getFileEntry()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getFileEntry </td>
- <td>(</td>
- <td class="paramtype">index </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get file entry. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">index</td><td>Index to file entry </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns tab separated string containing filename, uncompressed size, compressed size, compression method and CRC32 </dd></dl>
- </div>
- </div>
- <a id="a4ba9f9f5018d90e92211555779cf7208" name="a4ba9f9f5018d90e92211555779cf7208"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4ba9f9f5018d90e92211555779cf7208">◆ </a></span>getFileEntryCount()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getFileEntryCount </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get number of files in the zip </p><dl class="section return"><dt>Returns</dt><dd>Returns the number of files found in zip </dd></dl>
- </div>
- </div>
- <a id="afdd3d54419656ce143cd927960d6ca31" name="afdd3d54419656ce143cd927960d6ca31"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#afdd3d54419656ce143cd927960d6ca31">◆ </a></span>openArchive()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> openArchive </td>
- <td>(</td>
- <td class="paramtype">filename </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">[accessMode = Read] ? </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Open a zip file </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">filename</td><td>The file's name </td></tr>
- <tr><td class="paramname">accessMode</td><td>The mode in which to open the file (default Read) </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns true on success, false otherwise </dd></dl>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="classZipObject.html#a3a5c2200839483da2c31b171e993a0c0">closeArchive</a>, <a class="el" href="classZipObject.html#af7d3c416a6ba223b849f9c1e39baec8c">openFileForRead</a>, <a class="el" href="classZipObject.html#ad3c46eac18e8f56a652511d278e5eb01">openFileForWrite</a>, <a class="el" href="classZipObject.html#ad2232b510598c27d3c93f7e06a145e02">closeFile</a> </dd></dl>
- </div>
- </div>
- <a id="af7d3c416a6ba223b849f9c1e39baec8c" name="af7d3c416a6ba223b849f9c1e39baec8c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af7d3c416a6ba223b849f9c1e39baec8c">◆ </a></span>openFileForRead()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> openFileForRead </td>
- <td>(</td>
- <td class="paramtype">filename </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Open a file within the zip for reading </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">filename</td><td>The file's name to open in current zip file </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>The file stream ID as an integer or zero on failure. </dd></dl>
- </div>
- </div>
- <a id="ad3c46eac18e8f56a652511d278e5eb01" name="ad3c46eac18e8f56a652511d278e5eb01"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad3c46eac18e8f56a652511d278e5eb01">◆ </a></span>openFileForWrite()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> openFileForWrite </td>
- <td>(</td>
- <td class="paramtype">filename </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Open a file within the zip for writing </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">filename</td><td>The file's name to open in current zip file </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>The file stream ID as an integer or 0 on failure. </dd></dl>
- </div>
- </div>
- <h2 class="groupheader">Member Data Documentation</h2>
- <a id="a0b0e4ed1db1fd206b2cc4a8851262d13" name="a0b0e4ed1db1fd206b2cc4a8851262d13"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0b0e4ed1db1fd206b2cc4a8851262d13">◆ </a></span>[struct]</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">const struct { ... } gModeMap[]</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <b>Initial value:</b><div class="fragment"><div class="line">=</div>
- <div class="line">{</div>
- <div class="line"> { <span class="stringliteral">"read"</span>, Zip::ZipArchive::Read },</div>
- <div class="line"> { <span class="stringliteral">"write"</span>, Zip::ZipArchive::Write },</div>
- <div class="line"> { <span class="stringliteral">"readwrite"</span>, Zip::ZipArchive::ReadWrite },</div>
- <div class="line"> { NULL, (Zip::ZipArchive::AccessMode)0 }</div>
- <div class="line">}</div>
- </div><!-- fragment -->
- </div>
- </div>
- <a id="ac6c3dfb4c3a68f849f32cbfb21da4e77" name="ac6c3dfb4c3a68f849f32cbfb21da4e77"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac6c3dfb4c3a68f849f32cbfb21da4e77">◆ </a></span>mode</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">Zip::ZipArchive::AccessMode mode</td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ab9eced2c5fab5729cc642106eaf65d9a" name="ab9eced2c5fab5729cc642106eaf65d9a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab9eced2c5fab5729cc642106eaf65d9a">◆ </a></span>strMode</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">const char* strMode</td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
- </small></address>
- </body>
- </html>
|