| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982 |
- <!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: File System</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="#func-members">Functions</a> </div>
- <div class="headertitle"><div class="title">File System<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div></div>
- </div><!--header-->
- <div class="contents">
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
- Functions</h2></td></tr>
- <tr class="memitem:ga9f70c1b8d1401f86fe00e211123ab59e" id="r_ga9f70c1b8d1401f86fe00e211123ab59e"><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="group__FileSystem.html#ga9f70c1b8d1401f86fe00e211123ab59e">createPath</a> (pathName)</td></tr>
- <tr class="separator:ga9f70c1b8d1401f86fe00e211123ab59e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga1d3dbbea9591e8c3797143571bf2058c" id="r_ga1d3dbbea9591e8c3797143571bf2058c"><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="group__FileSystem.html#ga1d3dbbea9591e8c3797143571bf2058c">directoryDelete</a> (directoryName)</td></tr>
- <tr class="separator:ga1d3dbbea9591e8c3797143571bf2058c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga4217a66947928b4f3f4e002cdd13f8ac" id="r_ga4217a66947928b4f3f4e002cdd13f8ac"><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="group__FileSystem.html#ga4217a66947928b4f3f4e002cdd13f8ac">fileBase</a> (<a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>)</td></tr>
- <tr class="separator:ga4217a66947928b4f3f4e002cdd13f8ac"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga5bd9eca8f7b5f3cd7b0798183bdc9ad0" id="r_ga5bd9eca8f7b5f3cd7b0798183bdc9ad0"><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="group__FileSystem.html#ga5bd9eca8f7b5f3cd7b0798183bdc9ad0">fileDelete</a> (<a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>)</td></tr>
- <tr class="separator:ga5bd9eca8f7b5f3cd7b0798183bdc9ad0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga8c4eb6a3ad70131e429ab3c83fc248f8" id="r_ga8c4eb6a3ad70131e429ab3c83fc248f8"><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="group__FileSystem.html#ga8c4eb6a3ad70131e429ab3c83fc248f8">fileExt</a> (<a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>)</td></tr>
- <tr class="separator:ga8c4eb6a3ad70131e429ab3c83fc248f8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga4ea5109dc203259fb3c01292345bc0ee" id="r_ga4ea5109dc203259fb3c01292345bc0ee"><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="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a> (filePathName)</td></tr>
- <tr class="separator:ga4ea5109dc203259fb3c01292345bc0ee"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaf4d848bc40ceee4c027cdc33b2b17dd6" id="r_gaf4d848bc40ceee4c027cdc33b2b17dd6"><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="group__FileSystem.html#gaf4d848bc40ceee4c027cdc33b2b17dd6">filePath</a> (<a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>)</td></tr>
- <tr class="separator:gaf4d848bc40ceee4c027cdc33b2b17dd6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaa0cf3dfa10bef5f416db92c20a96654b" id="r_gaa0cf3dfa10bef5f416db92c20a96654b"><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="group__FileSystem.html#gaa0cf3dfa10bef5f416db92c20a96654b">fileSize</a> (<a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>)</td></tr>
- <tr class="separator:gaa0cf3dfa10bef5f416db92c20a96654b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gae1ed75e046037cdce2dea4ce352ac617" id="r_gae1ed75e046037cdce2dea4ce352ac617"><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="group__FileSystem.html#gae1ed75e046037cdce2dea4ce352ac617">findFirstFile</a> (strPattern)</td></tr>
- <tr class="separator:gae1ed75e046037cdce2dea4ce352ac617"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga2466418c331b4e01d83edda0c638a5dd" id="r_ga2466418c331b4e01d83edda0c638a5dd"><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="group__FileSystem.html#ga2466418c331b4e01d83edda0c638a5dd">findFirstFileMultiExpr</a> (strPattern)</td></tr>
- <tr class="separator:ga2466418c331b4e01d83edda0c638a5dd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga1f48febed436261f2a259efce7b93f21" id="r_ga1f48febed436261f2a259efce7b93f21"><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="group__FileSystem.html#ga1f48febed436261f2a259efce7b93f21">findNextFile</a> (strPattern)</td></tr>
- <tr class="separator:ga1f48febed436261f2a259efce7b93f21"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga12eb15575c7cdbf2a030086b46fb8d20" id="r_ga12eb15575c7cdbf2a030086b46fb8d20"><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="group__FileSystem.html#ga12eb15575c7cdbf2a030086b46fb8d20">findNextFileMultiExpr</a> (string pattern)</td></tr>
- <tr class="separator:ga12eb15575c7cdbf2a030086b46fb8d20"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga470ad7dd8c391d6aaa07d35c24fd1026" id="r_ga470ad7dd8c391d6aaa07d35c24fd1026"><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="group__FileSystem.html#ga470ad7dd8c391d6aaa07d35c24fd1026">getCurrentDate</a> (bool reverse)</td></tr>
- <tr class="separator:ga470ad7dd8c391d6aaa07d35c24fd1026"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga17af02b4662e4b0d85a117d6cd656877" id="r_ga17af02b4662e4b0d85a117d6cd656877"><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="group__FileSystem.html#ga17af02b4662e4b0d85a117d6cd656877">getCurrentDirectory</a> ()</td></tr>
- <tr class="separator:ga17af02b4662e4b0d85a117d6cd656877"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga6884e331ad1fa4f2e2b827854015b0b6" id="r_ga6884e331ad1fa4f2e2b827854015b0b6"><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="group__FileSystem.html#ga6884e331ad1fa4f2e2b827854015b0b6">getDirectoryList</a> (strPath, [intDepth]?)</td></tr>
- <tr class="separator:ga6884e331ad1fa4f2e2b827854015b0b6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga0d68f8a65eca1904fa09a9980b064d4a" id="r_ga0d68f8a65eca1904fa09a9980b064d4a"><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="group__FileSystem.html#ga0d68f8a65eca1904fa09a9980b064d4a">getExecutableName</a> ()</td></tr>
- <tr class="separator:ga0d68f8a65eca1904fa09a9980b064d4a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga4b7f7ce1623086a21260d71cc28cf368" id="r_ga4b7f7ce1623086a21260d71cc28cf368"><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="group__FileSystem.html#ga4b7f7ce1623086a21260d71cc28cf368">getFileCount</a> (strPattern)</td></tr>
- <tr class="separator:ga4b7f7ce1623086a21260d71cc28cf368"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga6072195cebf5cb6031a2509657e2f748" id="r_ga6072195cebf5cb6031a2509657e2f748"><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="group__FileSystem.html#ga6072195cebf5cb6031a2509657e2f748">getFileCountMultiExpr</a> (strPattern)</td></tr>
- <tr class="separator:ga6072195cebf5cb6031a2509657e2f748"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gad7f94c1e696ebb99c6721a48e2ffe248" id="r_gad7f94c1e696ebb99c6721a48e2ffe248"><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="group__FileSystem.html#gad7f94c1e696ebb99c6721a48e2ffe248">getFileCRC</a> (filename)</td></tr>
- <tr class="separator:gad7f94c1e696ebb99c6721a48e2ffe248"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga795b208786b255e9595132c066d11b30" id="r_ga795b208786b255e9595132c066d11b30"><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="group__FileSystem.html#ga795b208786b255e9595132c066d11b30">getFileList</a> (strPath)</td></tr>
- <tr class="separator:ga795b208786b255e9595132c066d11b30"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga3b0e41b11ab6859e00eacf997358805e" id="r_ga3b0e41b11ab6859e00eacf997358805e"><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="group__FileSystem.html#ga3b0e41b11ab6859e00eacf997358805e">getMainDotCsDir</a> ()</td></tr>
- <tr class="separator:ga3b0e41b11ab6859e00eacf997358805e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga58fe9a762c3b8b0bbce9cc9952711230" id="r_ga58fe9a762c3b8b0bbce9cc9952711230"><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="group__FileSystem.html#ga58fe9a762c3b8b0bbce9cc9952711230">getTemporaryDirectory</a> ()</td></tr>
- <tr class="separator:ga58fe9a762c3b8b0bbce9cc9952711230"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaeba6d1178d6ac3447c779e968df3c773" id="r_gaeba6d1178d6ac3447c779e968df3c773"><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="group__FileSystem.html#gaeba6d1178d6ac3447c779e968df3c773">getTemporaryFileName</a> ()</td></tr>
- <tr class="separator:gaeba6d1178d6ac3447c779e968df3c773"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gad7b9968aa8c151314c514121eb4e4e8d" id="r_gad7b9968aa8c151314c514121eb4e4e8d"><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="group__FileSystem.html#gad7b9968aa8c151314c514121eb4e4e8d">getUserDataDirectory</a> ()</td></tr>
- <tr class="separator:gad7b9968aa8c151314c514121eb4e4e8d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gae3f16f82c521bc566d03409a2a44aaea" id="r_gae3f16f82c521bc566d03409a2a44aaea"><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="group__FileSystem.html#gae3f16f82c521bc566d03409a2a44aaea">getUserHomeDirectory</a> ()</td></tr>
- <tr class="separator:gae3f16f82c521bc566d03409a2a44aaea"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gac2050a8dc00972ef1050a8680d80f768" id="r_gac2050a8dc00972ef1050a8680d80f768"><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="group__FileSystem.html#gac2050a8dc00972ef1050a8680d80f768">isDirectory</a> (path)</td></tr>
- <tr class="separator:gac2050a8dc00972ef1050a8680d80f768"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga4cf79e8a44c6c3cc499e9a3442ebf297" id="r_ga4cf79e8a44c6c3cc499e9a3442ebf297"><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="group__FileSystem.html#ga4cf79e8a44c6c3cc499e9a3442ebf297">isFile</a> (<a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>)</td></tr>
- <tr class="separator:ga4cf79e8a44c6c3cc499e9a3442ebf297"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga722b3c5aba9c010f74d011d34db57df4" id="r_ga722b3c5aba9c010f74d011d34db57df4"><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="group__FileSystem.html#ga722b3c5aba9c010f74d011d34db57df4">isValidImageFile</a> (string <a class="el" href="group__FileSystem.html#gaf4d848bc40ceee4c027cdc33b2b17dd6">filePath</a>)</td></tr>
- <tr class="separator:ga722b3c5aba9c010f74d011d34db57df4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga0cebe12721100f107d531807f92fe2f4" id="r_ga0cebe12721100f107d531807f92fe2f4"><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="group__FileSystem.html#ga0cebe12721100f107d531807f92fe2f4">isWriteableFileName</a> (<a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>)</td></tr>
- <tr class="separator:ga0cebe12721100f107d531807f92fe2f4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga71003026f4c7833539d12ec7c1a8a5d8" id="r_ga71003026f4c7833539d12ec7c1a8a5d8"><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="group__FileSystem.html#ga71003026f4c7833539d12ec7c1a8a5d8">makeFullPath</a> (string path, [string currentWorkingDir]?)</td></tr>
- <tr class="separator:ga71003026f4c7833539d12ec7c1a8a5d8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga6920b3c3be8e66f5ce1c19ea9c9b8bc4" id="r_ga6920b3c3be8e66f5ce1c19ea9c9b8bc4"><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="group__FileSystem.html#ga6920b3c3be8e66f5ce1c19ea9c9b8bc4">makeRelativePath</a> (string path, string to)</td></tr>
- <tr class="separator:ga6920b3c3be8e66f5ce1c19ea9c9b8bc4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga6ed8d04b39e458d9c96572a615c10c34" id="r_ga6ed8d04b39e458d9c96572a615c10c34"><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="group__FileSystem.html#ga6ed8d04b39e458d9c96572a615c10c34">openFolder</a> (path)</td></tr>
- <tr class="separator:ga6ed8d04b39e458d9c96572a615c10c34"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gab6f0ed624b2b88d9a69cdf5285ec1dfc" id="r_gab6f0ed624b2b88d9a69cdf5285ec1dfc"><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="group__FileSystem.html#gab6f0ed624b2b88d9a69cdf5285ec1dfc">pathConcat</a> (string path, string file1, [... fileN] *)</td></tr>
- <tr class="separator:gab6f0ed624b2b88d9a69cdf5285ec1dfc"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga89eb9e650f47bc43f58de53ccb8b2494" id="r_ga89eb9e650f47bc43f58de53ccb8b2494"><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="group__FileSystem.html#ga89eb9e650f47bc43f58de53ccb8b2494">pathCopy</a> (fromFile, toFile, [nooverwrite=true]?)</td></tr>
- <tr class="separator:ga89eb9e650f47bc43f58de53ccb8b2494"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga55cac30dc1287e0d4ed638af5797c9e8" id="r_ga55cac30dc1287e0d4ed638af5797c9e8"><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="group__FileSystem.html#ga55cac30dc1287e0d4ed638af5797c9e8">restartInstance</a> ()</td></tr>
- <tr class="separator:ga55cac30dc1287e0d4ed638af5797c9e8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga36c8e423674e67a7bd45312eec3896fe" id="r_ga36c8e423674e67a7bd45312eec3896fe"><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="group__FileSystem.html#ga36c8e423674e67a7bd45312eec3896fe">setCurrentDirectory</a> (absolutePathName)</td></tr>
- <tr class="separator:ga36c8e423674e67a7bd45312eec3896fe"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga03dcde5a130201f7bb0c79f432cf359f" id="r_ga03dcde5a130201f7bb0c79f432cf359f"><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="group__FileSystem.html#ga03dcde5a130201f7bb0c79f432cf359f">setMainDotCsDir</a> (path)</td></tr>
- <tr class="separator:ga03dcde5a130201f7bb0c79f432cf359f"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <h2 class="groupheader">Function Documentation</h2>
- <a id="ga9f70c1b8d1401f86fe00e211123ab59e" name="ga9f70c1b8d1401f86fe00e211123ab59e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga9f70c1b8d1401f86fe00e211123ab59e">◆ </a></span>createPath()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> createPath </td>
- <td>(</td>
- <td class="paramtype">pathName </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Creates the path, verifing all the elements in a path exist or creating them if they do not. Note that the path should end with a slash (/). Otherwise, the last element in the path will be assumed to be a filename and not a path component, and it will not be created. For example "data/stage2/part1" will verify or create "data/stage2/" and not "part1". </p>
- </div>
- </div>
- <a id="ga1d3dbbea9591e8c3797143571bf2058c" name="ga1d3dbbea9591e8c3797143571bf2058c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga1d3dbbea9591e8c3797143571bf2058c">◆ </a></span>directoryDelete()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> directoryDelete </td>
- <td>(</td>
- <td class="paramtype">directoryName </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">directoryName</td><td>Name of the directory to remove </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns true on success and false on failure </dd></dl>
- </div>
- </div>
- <a id="ga4217a66947928b4f3f4e002cdd13f8ac" name="ga4217a66947928b4f3f4e002cdd13f8ac"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga4217a66947928b4f3f4e002cdd13f8ac">◆ </a></span>fileBase()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> fileBase </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a> </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ga5bd9eca8f7b5f3cd7b0798183bdc9ad0" name="ga5bd9eca8f7b5f3cd7b0798183bdc9ad0"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga5bd9eca8f7b5f3cd7b0798183bdc9ad0">◆ </a></span>fileDelete()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> fileDelete </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a> </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">fileName</td><td>Name of the file to remove </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns true on success and false on failure </dd></dl>
- </div>
- </div>
- <a id="ga8c4eb6a3ad70131e429ab3c83fc248f8" name="ga8c4eb6a3ad70131e429ab3c83fc248f8"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga8c4eb6a3ad70131e429ab3c83fc248f8">◆ </a></span>fileExt()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> fileExt </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a> </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">Name</td><td>of file from which to extract extension </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>A string containing the file's extension (assuming all data after first '.' is the extension) or returns empty string on failure </dd></dl>
- </div>
- </div>
- <a id="ga4ea5109dc203259fb3c01292345bc0ee" name="ga4ea5109dc203259fb3c01292345bc0ee"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga4ea5109dc203259fb3c01292345bc0ee">◆ </a></span>fileName()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> fileName </td>
- <td>(</td>
- <td class="paramtype">filePathName </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Extract the filename from the full path description </p>
- </div>
- </div>
- <a id="gaf4d848bc40ceee4c027cdc33b2b17dd6" name="gaf4d848bc40ceee4c027cdc33b2b17dd6"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gaf4d848bc40ceee4c027cdc33b2b17dd6">◆ </a></span>filePath()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> filePath </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a> </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Extract the file path from a file's full desciption </p>
- </div>
- </div>
- <a id="gaa0cf3dfa10bef5f416db92c20a96654b" name="gaa0cf3dfa10bef5f416db92c20a96654b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gaa0cf3dfa10bef5f416db92c20a96654b">◆ </a></span>fileSize()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> fileSize </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a> </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">fileName</td><td>The name of the file to check. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns the size of the file as an integer or -1 if file not found </dd></dl>
- </div>
- </div>
- <a id="gae1ed75e046037cdce2dea4ce352ac617" name="gae1ed75e046037cdce2dea4ce352ac617"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gae1ed75e046037cdce2dea4ce352ac617">◆ </a></span>findFirstFile()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> findFirstFile </td>
- <td>(</td>
- <td class="paramtype">strPattern </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">strPattern</td><td>The string pattern to search for. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns a string representing the first file in the directory system matching the given pattern. </dd></dl>
- </div>
- </div>
- <a id="ga2466418c331b4e01d83edda0c638a5dd" name="ga2466418c331b4e01d83edda0c638a5dd"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga2466418c331b4e01d83edda0c638a5dd">◆ </a></span>findFirstFileMultiExpr()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> findFirstFileMultiExpr </td>
- <td>(</td>
- <td class="paramtype">strPattern </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">strPattern</td><td>The string pattern to search for. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns the first file in the directory system matching the given pattern. </dd></dl>
- </div>
- </div>
- <a id="ga1f48febed436261f2a259efce7b93f21" name="ga1f48febed436261f2a259efce7b93f21"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga1f48febed436261f2a259efce7b93f21">◆ </a></span>findNextFile()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> findNextFile </td>
- <td>(</td>
- <td class="paramtype">strPattern </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">strPattern</td><td>The string pattern to search for. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns the next file matching a search begun in findFirstFile. </dd></dl>
- </div>
- </div>
- <a id="ga12eb15575c7cdbf2a030086b46fb8d20" name="ga12eb15575c7cdbf2a030086b46fb8d20"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga12eb15575c7cdbf2a030086b46fb8d20">◆ </a></span>findNextFileMultiExpr()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> findNextFileMultiExpr </td>
- <td>(</td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>pattern</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the next file matching a search begun in findFirstFile. </p>
- </div>
- </div>
- <a id="ga470ad7dd8c391d6aaa07d35c24fd1026" name="ga470ad7dd8c391d6aaa07d35c24fd1026"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga470ad7dd8c391d6aaa07d35c24fd1026">◆ </a></span>getCurrentDate()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getCurrentDate </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>reverse</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Gets the current date and time. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">reverse</td><td>Determines if the format will be Month/Day/Year/Hour:Min:Seconds or Year/Month/Day/Hour:Min:Seconds </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="ga17af02b4662e4b0d85a117d6cd656877" name="ga17af02b4662e4b0d85a117d6cd656877"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga17af02b4662e4b0d85a117d6cd656877">◆ </a></span>getCurrentDirectory()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getCurrentDirectory </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ga6884e331ad1fa4f2e2b827854015b0b6" name="ga6884e331ad1fa4f2e2b827854015b0b6"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga6884e331ad1fa4f2e2b827854015b0b6">◆ </a></span>getDirectoryList()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getDirectoryList </td>
- <td>(</td>
- <td class="paramtype">strPath </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">[intDepth] ? </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">strPath</td><td>The path in which to check </td></tr>
- <tr><td class="paramname">intDepth</td><td>The depth in which to return (default 0 if not specified) </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>The directory contents </dd></dl>
- </div>
- </div>
- <a id="ga0d68f8a65eca1904fa09a9980b064d4a" name="ga0d68f8a65eca1904fa09a9980b064d4a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga0d68f8a65eca1904fa09a9980b064d4a">◆ </a></span>getExecutableName()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getExecutableName </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ga4b7f7ce1623086a21260d71cc28cf368" name="ga4b7f7ce1623086a21260d71cc28cf368"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga4b7f7ce1623086a21260d71cc28cf368">◆ </a></span>getFileCount()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getFileCount </td>
- <td>(</td>
- <td class="paramtype">strPattern </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">strPattern</td><td>The string pattern to search for. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns the number of files in the directory tree that match the given pattern </dd></dl>
- </div>
- </div>
- <a id="ga6072195cebf5cb6031a2509657e2f748" name="ga6072195cebf5cb6031a2509657e2f748"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga6072195cebf5cb6031a2509657e2f748">◆ </a></span>getFileCountMultiExpr()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getFileCountMultiExpr </td>
- <td>(</td>
- <td class="paramtype">strPattern </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">strPattern</td><td>The string pattern to search for. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns the number of files in the directory tree that match the given pattern </dd></dl>
- </div>
- </div>
- <a id="gad7f94c1e696ebb99c6721a48e2ffe248" name="gad7f94c1e696ebb99c6721a48e2ffe248"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gad7f94c1e696ebb99c6721a48e2ffe248">◆ </a></span>getFileCRC()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getFileCRC </td>
- <td>(</td>
- <td class="paramtype">filename </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">filename</td><td>The string representing the file from which to get the CRC </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>An integer </dd></dl>
- </div>
- </div>
- <a id="ga795b208786b255e9595132c066d11b30" name="ga795b208786b255e9595132c066d11b30"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga795b208786b255e9595132c066d11b30">◆ </a></span>getFileList()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getFileList </td>
- <td>(</td>
- <td class="paramtype">strPath </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Gets all the files in the specified directory. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">strPath</td><td>The path in which to check </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>A list of files in the specified directory. </dd></dl>
- </div>
- </div>
- <a id="ga3b0e41b11ab6859e00eacf997358805e" name="ga3b0e41b11ab6859e00eacf997358805e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga3b0e41b11ab6859e00eacf997358805e">◆ </a></span>getMainDotCsDir()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getMainDotCsDir </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ga58fe9a762c3b8b0bbce9cc9952711230" name="ga58fe9a762c3b8b0bbce9cc9952711230"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga58fe9a762c3b8b0bbce9cc9952711230">◆ </a></span>getTemporaryDirectory()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getTemporaryDirectory </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Gets the path to the system's temporary directory </p><dl class="section return"><dt>Returns</dt><dd>Returns the path to the temporary directory as a string </dd></dl>
- </div>
- </div>
- <a id="gaeba6d1178d6ac3447c779e968df3c773" name="gaeba6d1178d6ac3447c779e968df3c773"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gaeba6d1178d6ac3447c779e968df3c773">◆ </a></span>getTemporaryFileName()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getTemporaryFileName </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Generates a temporary filename for use. </p><dl class="section return"><dt>Returns</dt><dd>Returns the formatted temporary filename for use </dd></dl>
- </div>
- </div>
- <a id="gad7b9968aa8c151314c514121eb4e4e8d" name="gad7b9968aa8c151314c514121eb4e4e8d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gad7b9968aa8c151314c514121eb4e4e8d">◆ </a></span>getUserDataDirectory()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getUserDataDirectory </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>Returns a string to the directory storing the user's data </dd></dl>
- </div>
- </div>
- <a id="gae3f16f82c521bc566d03409a2a44aaea" name="gae3f16f82c521bc566d03409a2a44aaea"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gae3f16f82c521bc566d03409a2a44aaea">◆ </a></span>getUserHomeDirectory()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getUserHomeDirectory </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>Returns the path to the user's home directory. </dd></dl>
- </div>
- </div>
- <a id="gac2050a8dc00972ef1050a8680d80f768" name="gac2050a8dc00972ef1050a8680d80f768"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gac2050a8dc00972ef1050a8680d80f768">◆ </a></span>isDirectory()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isDirectory </td>
- <td>(</td>
- <td class="paramtype">path </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">pathName</td><td>Path to check. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns true if the given path is a folder/directory, false otherwise </dd></dl>
- </div>
- </div>
- <a id="ga4cf79e8a44c6c3cc499e9a3442ebf297" name="ga4cf79e8a44c6c3cc499e9a3442ebf297"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga4cf79e8a44c6c3cc499e9a3442ebf297">◆ </a></span>isFile()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isFile </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a> </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">fileName</td><td>Filename to check. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns true if the given filename is an existing file or false otherwise </dd></dl>
- </div>
- </div>
- <a id="ga722b3c5aba9c010f74d011d34db57df4" name="ga722b3c5aba9c010f74d011d34db57df4"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga722b3c5aba9c010f74d011d34db57df4">◆ </a></span>isValidImageFile()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isValidImageFile </td>
- <td>(</td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>filePath</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">filePath</td><td>Full path of file to check. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns true if the given filename is a valid image file or false otherwise </dd></dl>
- </div>
- </div>
- <a id="ga0cebe12721100f107d531807f92fe2f4" name="ga0cebe12721100f107d531807f92fe2f4"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga0cebe12721100f107d531807f92fe2f4">◆ </a></span>isWriteableFileName()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isWriteableFileName </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a> </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">fileName</td><td>Filename to check. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns true if the given filename is an existing file and is not Read-Only or false otherwise </dd></dl>
- </div>
- </div>
- <a id="ga71003026f4c7833539d12ec7c1a8a5d8" name="ga71003026f4c7833539d12ec7c1a8a5d8"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga71003026f4c7833539d12ec7c1a8a5d8">◆ </a></span>makeFullPath()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> makeFullPath </td>
- <td>(</td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>path</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">[string currentWorkingDir] ? </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ga6920b3c3be8e66f5ce1c19ea9c9b8bc4" name="ga6920b3c3be8e66f5ce1c19ea9c9b8bc4"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga6920b3c3be8e66f5ce1c19ea9c9b8bc4">◆ </a></span>makeRelativePath()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> makeRelativePath </td>
- <td>(</td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>path</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>to</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ga6ed8d04b39e458d9c96572a615c10c34" name="ga6ed8d04b39e458d9c96572a615c10c34"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga6ed8d04b39e458d9c96572a615c10c34">◆ </a></span>openFolder()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> openFolder </td>
- <td>(</td>
- <td class="paramtype">path </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>; </p>
- </div>
- </div>
- <a id="gab6f0ed624b2b88d9a69cdf5285ec1dfc" name="gab6f0ed624b2b88d9a69cdf5285ec1dfc"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gab6f0ed624b2b88d9a69cdf5285ec1dfc">◆ </a></span>pathConcat()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> pathConcat </td>
- <td>(</td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>path</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>file1</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">[... fileN] * </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ga89eb9e650f47bc43f58de53ccb8b2494" name="ga89eb9e650f47bc43f58de53ccb8b2494"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga89eb9e650f47bc43f58de53ccb8b2494">◆ </a></span>pathCopy()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> pathCopy </td>
- <td>(</td>
- <td class="paramtype">fromFile </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">toFile </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">[nooverwrite = true] ? </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ga55cac30dc1287e0d4ed638af5797c9e8" name="ga55cac30dc1287e0d4ed638af5797c9e8"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga55cac30dc1287e0d4ed638af5797c9e8">◆ </a></span>restartInstance()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> restartInstance </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ga36c8e423674e67a7bd45312eec3896fe" name="ga36c8e423674e67a7bd45312eec3896fe"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga36c8e423674e67a7bd45312eec3896fe">◆ </a></span>setCurrentDirectory()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> setCurrentDirectory </td>
- <td>(</td>
- <td class="paramtype">absolutePathName </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ga03dcde5a130201f7bb0c79f432cf359f" name="ga03dcde5a130201f7bb0c79f432cf359f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga03dcde5a130201f7bb0c79f432cf359f">◆ </a></span>setMainDotCsDir()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setMainDotCsDir </td>
- <td>(</td>
- <td class="paramtype">path </td>
- <td class="paramname"></td><td>)</td>
- <td></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>
|