group__FileSystem.html 46 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.10"/>
  7. <title>TorqueScript Reference: File System</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  13. </head>
  14. <body>
  15. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16. <div id="titlearea">
  17. <table cellspacing="0" cellpadding="0">
  18. <tbody>
  19. <tr style="height: 56px;">
  20. <td id="projectalign" style="padding-left: 0.5em;">
  21. <div id="projectname">TorqueScript Reference
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.10 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="modules.html"><span>Modules</span></a></li>
  34. <li><a href="annotated.html"><span>Classes</span></a></li>
  35. </ul>
  36. </div>
  37. </div><!-- top -->
  38. <div class="header">
  39. <div class="summary">
  40. <a href="#func-members">Functions</a> </div>
  41. <div class="headertitle">
  42. <div class="title">File System<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div> </div>
  43. </div><!--header-->
  44. <div class="contents">
  45. <table class="memberdecls">
  46. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  47. Functions</h2></td></tr>
  48. <tr class="memitem:ga9f70c1b8d1401f86fe00e211123ab59e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga9f70c1b8d1401f86fe00e211123ab59e">createPath</a> (pathName)</td></tr>
  49. <tr class="separator:ga9f70c1b8d1401f86fe00e211123ab59e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  50. <tr class="memitem:ga1d3dbbea9591e8c3797143571bf2058c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga1d3dbbea9591e8c3797143571bf2058c">directoryDelete</a> (directoryName)</td></tr>
  51. <tr class="separator:ga1d3dbbea9591e8c3797143571bf2058c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  52. <tr class="memitem:ga4217a66947928b4f3f4e002cdd13f8ac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga4217a66947928b4f3f4e002cdd13f8ac">fileBase</a> (<a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>)</td></tr>
  53. <tr class="separator:ga4217a66947928b4f3f4e002cdd13f8ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  54. <tr class="memitem:ga5bd9eca8f7b5f3cd7b0798183bdc9ad0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga5bd9eca8f7b5f3cd7b0798183bdc9ad0">fileDelete</a> (<a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>)</td></tr>
  55. <tr class="separator:ga5bd9eca8f7b5f3cd7b0798183bdc9ad0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  56. <tr class="memitem:ga8c4eb6a3ad70131e429ab3c83fc248f8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga8c4eb6a3ad70131e429ab3c83fc248f8">fileExt</a> (<a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>)</td></tr>
  57. <tr class="separator:ga8c4eb6a3ad70131e429ab3c83fc248f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  58. <tr class="memitem:ga4ea5109dc203259fb3c01292345bc0ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a> (filePathName)</td></tr>
  59. <tr class="separator:ga4ea5109dc203259fb3c01292345bc0ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60. <tr class="memitem:gaf4d848bc40ceee4c027cdc33b2b17dd6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#gaf4d848bc40ceee4c027cdc33b2b17dd6">filePath</a> (<a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>)</td></tr>
  61. <tr class="separator:gaf4d848bc40ceee4c027cdc33b2b17dd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. <tr class="memitem:gaa0cf3dfa10bef5f416db92c20a96654b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#gaa0cf3dfa10bef5f416db92c20a96654b">fileSize</a> (<a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>)</td></tr>
  63. <tr class="separator:gaa0cf3dfa10bef5f416db92c20a96654b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64. <tr class="memitem:gae1ed75e046037cdce2dea4ce352ac617"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#gae1ed75e046037cdce2dea4ce352ac617">findFirstFile</a> (strPattern)</td></tr>
  65. <tr class="separator:gae1ed75e046037cdce2dea4ce352ac617"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:ga2466418c331b4e01d83edda0c638a5dd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga2466418c331b4e01d83edda0c638a5dd">findFirstFileMultiExpr</a> (strPattern)</td></tr>
  67. <tr class="separator:ga2466418c331b4e01d83edda0c638a5dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:ga1f48febed436261f2a259efce7b93f21"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga1f48febed436261f2a259efce7b93f21">findNextFile</a> (strPattern)</td></tr>
  69. <tr class="separator:ga1f48febed436261f2a259efce7b93f21"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:ga12eb15575c7cdbf2a030086b46fb8d20"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga12eb15575c7cdbf2a030086b46fb8d20">findNextFileMultiExpr</a> (string pattern)</td></tr>
  71. <tr class="separator:ga12eb15575c7cdbf2a030086b46fb8d20"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:ga470ad7dd8c391d6aaa07d35c24fd1026"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga470ad7dd8c391d6aaa07d35c24fd1026">getCurrentDate</a> (bool reverse)</td></tr>
  73. <tr class="separator:ga470ad7dd8c391d6aaa07d35c24fd1026"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:ga17af02b4662e4b0d85a117d6cd656877"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga17af02b4662e4b0d85a117d6cd656877">getCurrentDirectory</a> ()</td></tr>
  75. <tr class="separator:ga17af02b4662e4b0d85a117d6cd656877"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:ga6884e331ad1fa4f2e2b827854015b0b6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga6884e331ad1fa4f2e2b827854015b0b6">getDirectoryList</a> (strPath, [intDepth]?)</td></tr>
  77. <tr class="separator:ga6884e331ad1fa4f2e2b827854015b0b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:ga0d68f8a65eca1904fa09a9980b064d4a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga0d68f8a65eca1904fa09a9980b064d4a">getExecutableName</a> ()</td></tr>
  79. <tr class="separator:ga0d68f8a65eca1904fa09a9980b064d4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:ga4b7f7ce1623086a21260d71cc28cf368"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga4b7f7ce1623086a21260d71cc28cf368">getFileCount</a> (strPattern)</td></tr>
  81. <tr class="separator:ga4b7f7ce1623086a21260d71cc28cf368"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:ga6072195cebf5cb6031a2509657e2f748"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga6072195cebf5cb6031a2509657e2f748">getFileCountMultiExpr</a> (strPattern)</td></tr>
  83. <tr class="separator:ga6072195cebf5cb6031a2509657e2f748"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:gad7f94c1e696ebb99c6721a48e2ffe248"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#gad7f94c1e696ebb99c6721a48e2ffe248">getFileCRC</a> (filename)</td></tr>
  85. <tr class="separator:gad7f94c1e696ebb99c6721a48e2ffe248"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:ga795b208786b255e9595132c066d11b30"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga795b208786b255e9595132c066d11b30">getFileList</a> (strPath)</td></tr>
  87. <tr class="separator:ga795b208786b255e9595132c066d11b30"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:ga3b0e41b11ab6859e00eacf997358805e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga3b0e41b11ab6859e00eacf997358805e">getMainDotCsDir</a> ()</td></tr>
  89. <tr class="separator:ga3b0e41b11ab6859e00eacf997358805e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:ga58fe9a762c3b8b0bbce9cc9952711230"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga58fe9a762c3b8b0bbce9cc9952711230">getTemporaryDirectory</a> ()</td></tr>
  91. <tr class="separator:ga58fe9a762c3b8b0bbce9cc9952711230"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:gaeba6d1178d6ac3447c779e968df3c773"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#gaeba6d1178d6ac3447c779e968df3c773">getTemporaryFileName</a> ()</td></tr>
  93. <tr class="separator:gaeba6d1178d6ac3447c779e968df3c773"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:gad7b9968aa8c151314c514121eb4e4e8d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#gad7b9968aa8c151314c514121eb4e4e8d">getUserDataDirectory</a> ()</td></tr>
  95. <tr class="separator:gad7b9968aa8c151314c514121eb4e4e8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:gae3f16f82c521bc566d03409a2a44aaea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#gae3f16f82c521bc566d03409a2a44aaea">getUserHomeDirectory</a> ()</td></tr>
  97. <tr class="separator:gae3f16f82c521bc566d03409a2a44aaea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:gac2050a8dc00972ef1050a8680d80f768"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#gac2050a8dc00972ef1050a8680d80f768">isDirectory</a> (path)</td></tr>
  99. <tr class="separator:gac2050a8dc00972ef1050a8680d80f768"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:ga4cf79e8a44c6c3cc499e9a3442ebf297"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga4cf79e8a44c6c3cc499e9a3442ebf297">isFile</a> (<a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>)</td></tr>
  101. <tr class="separator:ga4cf79e8a44c6c3cc499e9a3442ebf297"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:ga722b3c5aba9c010f74d011d34db57df4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga722b3c5aba9c010f74d011d34db57df4">isValidImageFile</a> (string <a class="el" href="group__FileSystem.html#gaf4d848bc40ceee4c027cdc33b2b17dd6">filePath</a>)</td></tr>
  103. <tr class="separator:ga722b3c5aba9c010f74d011d34db57df4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:ga0cebe12721100f107d531807f92fe2f4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga0cebe12721100f107d531807f92fe2f4">isWriteableFileName</a> (<a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>)</td></tr>
  105. <tr class="separator:ga0cebe12721100f107d531807f92fe2f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:ga71003026f4c7833539d12ec7c1a8a5d8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga71003026f4c7833539d12ec7c1a8a5d8">makeFullPath</a> (string path, [string currentWorkingDir]?)</td></tr>
  107. <tr class="separator:ga71003026f4c7833539d12ec7c1a8a5d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:ga6920b3c3be8e66f5ce1c19ea9c9b8bc4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga6920b3c3be8e66f5ce1c19ea9c9b8bc4">makeRelativePath</a> (string path, string to)</td></tr>
  109. <tr class="separator:ga6920b3c3be8e66f5ce1c19ea9c9b8bc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:ga6ed8d04b39e458d9c96572a615c10c34"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga6ed8d04b39e458d9c96572a615c10c34">openFolder</a> (path)</td></tr>
  111. <tr class="separator:ga6ed8d04b39e458d9c96572a615c10c34"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:ga05a3e6cbe1cb37acb405bf47c2bb17c6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga05a3e6cbe1cb37acb405bf47c2bb17c6">pathConcat</a> (string path, string file1, [...fileN]*)</td></tr>
  113. <tr class="separator:ga05a3e6cbe1cb37acb405bf47c2bb17c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:ga89eb9e650f47bc43f58de53ccb8b2494"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga89eb9e650f47bc43f58de53ccb8b2494">pathCopy</a> (fromFile, toFile, [nooverwrite=true]?)</td></tr>
  115. <tr class="separator:ga89eb9e650f47bc43f58de53ccb8b2494"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:ga55cac30dc1287e0d4ed638af5797c9e8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga55cac30dc1287e0d4ed638af5797c9e8">restartInstance</a> ()</td></tr>
  117. <tr class="separator:ga55cac30dc1287e0d4ed638af5797c9e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:ga36c8e423674e67a7bd45312eec3896fe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga36c8e423674e67a7bd45312eec3896fe">setCurrentDirectory</a> (absolutePathName)</td></tr>
  119. <tr class="separator:ga36c8e423674e67a7bd45312eec3896fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. </table>
  121. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  122. <h2 class="groupheader">Function Documentation</h2>
  123. <a class="anchor" id="ga9f70c1b8d1401f86fe00e211123ab59e"></a>
  124. <div class="memitem">
  125. <div class="memproto">
  126. <table class="memname">
  127. <tr>
  128. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> createPath </td>
  129. <td>(</td>
  130. <td class="paramtype">pathName&#160;</td>
  131. <td class="paramname"></td><td>)</td>
  132. <td></td>
  133. </tr>
  134. </table>
  135. </div><div class="memdoc">
  136. <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>
  137. </div>
  138. </div>
  139. <a class="anchor" id="ga1d3dbbea9591e8c3797143571bf2058c"></a>
  140. <div class="memitem">
  141. <div class="memproto">
  142. <table class="memname">
  143. <tr>
  144. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> directoryDelete </td>
  145. <td>(</td>
  146. <td class="paramtype">directoryName&#160;</td>
  147. <td class="paramname"></td><td>)</td>
  148. <td></td>
  149. </tr>
  150. </table>
  151. </div><div class="memdoc">
  152. <dl class="params"><dt>Parameters</dt><dd>
  153. <table class="params">
  154. <tr><td class="paramname">directoryName</td><td>Name of the directory to remove </td></tr>
  155. </table>
  156. </dd>
  157. </dl>
  158. <dl class="section return"><dt>Returns</dt><dd>Returns true on success and false on failure </dd></dl>
  159. </div>
  160. </div>
  161. <a class="anchor" id="ga4217a66947928b4f3f4e002cdd13f8ac"></a>
  162. <div class="memitem">
  163. <div class="memproto">
  164. <table class="memname">
  165. <tr>
  166. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> fileBase </td>
  167. <td>(</td>
  168. <td class="paramtype"><a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>&#160;</td>
  169. <td class="paramname"></td><td>)</td>
  170. <td></td>
  171. </tr>
  172. </table>
  173. </div><div class="memdoc">
  174. </div>
  175. </div>
  176. <a class="anchor" id="ga5bd9eca8f7b5f3cd7b0798183bdc9ad0"></a>
  177. <div class="memitem">
  178. <div class="memproto">
  179. <table class="memname">
  180. <tr>
  181. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> fileDelete </td>
  182. <td>(</td>
  183. <td class="paramtype"><a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>&#160;</td>
  184. <td class="paramname"></td><td>)</td>
  185. <td></td>
  186. </tr>
  187. </table>
  188. </div><div class="memdoc">
  189. <dl class="params"><dt>Parameters</dt><dd>
  190. <table class="params">
  191. <tr><td class="paramname">fileName</td><td>Name of the file to remove </td></tr>
  192. </table>
  193. </dd>
  194. </dl>
  195. <dl class="section return"><dt>Returns</dt><dd>Returns true on success and false on failure </dd></dl>
  196. </div>
  197. </div>
  198. <a class="anchor" id="ga8c4eb6a3ad70131e429ab3c83fc248f8"></a>
  199. <div class="memitem">
  200. <div class="memproto">
  201. <table class="memname">
  202. <tr>
  203. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> fileExt </td>
  204. <td>(</td>
  205. <td class="paramtype"><a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>&#160;</td>
  206. <td class="paramname"></td><td>)</td>
  207. <td></td>
  208. </tr>
  209. </table>
  210. </div><div class="memdoc">
  211. <dl class="params"><dt>Parameters</dt><dd>
  212. <table class="params">
  213. <tr><td class="paramname">Name</td><td>of file from which to extract extension </td></tr>
  214. </table>
  215. </dd>
  216. </dl>
  217. <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>
  218. </div>
  219. </div>
  220. <a class="anchor" id="ga4ea5109dc203259fb3c01292345bc0ee"></a>
  221. <div class="memitem">
  222. <div class="memproto">
  223. <table class="memname">
  224. <tr>
  225. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> fileName </td>
  226. <td>(</td>
  227. <td class="paramtype">filePathName&#160;</td>
  228. <td class="paramname"></td><td>)</td>
  229. <td></td>
  230. </tr>
  231. </table>
  232. </div><div class="memdoc">
  233. <p>Extract the filename from the full path description </p>
  234. </div>
  235. </div>
  236. <a class="anchor" id="gaf4d848bc40ceee4c027cdc33b2b17dd6"></a>
  237. <div class="memitem">
  238. <div class="memproto">
  239. <table class="memname">
  240. <tr>
  241. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> filePath </td>
  242. <td>(</td>
  243. <td class="paramtype"><a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>&#160;</td>
  244. <td class="paramname"></td><td>)</td>
  245. <td></td>
  246. </tr>
  247. </table>
  248. </div><div class="memdoc">
  249. <p>Extract the file path from a file's full desciption </p>
  250. </div>
  251. </div>
  252. <a class="anchor" id="gaa0cf3dfa10bef5f416db92c20a96654b"></a>
  253. <div class="memitem">
  254. <div class="memproto">
  255. <table class="memname">
  256. <tr>
  257. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> fileSize </td>
  258. <td>(</td>
  259. <td class="paramtype"><a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>&#160;</td>
  260. <td class="paramname"></td><td>)</td>
  261. <td></td>
  262. </tr>
  263. </table>
  264. </div><div class="memdoc">
  265. <dl class="params"><dt>Parameters</dt><dd>
  266. <table class="params">
  267. <tr><td class="paramname">fileName</td><td>The name of the file to check. </td></tr>
  268. </table>
  269. </dd>
  270. </dl>
  271. <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>
  272. </div>
  273. </div>
  274. <a class="anchor" id="gae1ed75e046037cdce2dea4ce352ac617"></a>
  275. <div class="memitem">
  276. <div class="memproto">
  277. <table class="memname">
  278. <tr>
  279. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> findFirstFile </td>
  280. <td>(</td>
  281. <td class="paramtype">strPattern&#160;</td>
  282. <td class="paramname"></td><td>)</td>
  283. <td></td>
  284. </tr>
  285. </table>
  286. </div><div class="memdoc">
  287. <dl class="params"><dt>Parameters</dt><dd>
  288. <table class="params">
  289. <tr><td class="paramname">strPattern</td><td>The string pattern to search for. </td></tr>
  290. </table>
  291. </dd>
  292. </dl>
  293. <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>
  294. </div>
  295. </div>
  296. <a class="anchor" id="ga2466418c331b4e01d83edda0c638a5dd"></a>
  297. <div class="memitem">
  298. <div class="memproto">
  299. <table class="memname">
  300. <tr>
  301. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> findFirstFileMultiExpr </td>
  302. <td>(</td>
  303. <td class="paramtype">strPattern&#160;</td>
  304. <td class="paramname"></td><td>)</td>
  305. <td></td>
  306. </tr>
  307. </table>
  308. </div><div class="memdoc">
  309. <dl class="params"><dt>Parameters</dt><dd>
  310. <table class="params">
  311. <tr><td class="paramname">strPattern</td><td>The string pattern to search for. </td></tr>
  312. </table>
  313. </dd>
  314. </dl>
  315. <dl class="section return"><dt>Returns</dt><dd>Returns the first file in the directory system matching the given pattern. </dd></dl>
  316. </div>
  317. </div>
  318. <a class="anchor" id="ga1f48febed436261f2a259efce7b93f21"></a>
  319. <div class="memitem">
  320. <div class="memproto">
  321. <table class="memname">
  322. <tr>
  323. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> findNextFile </td>
  324. <td>(</td>
  325. <td class="paramtype">strPattern&#160;</td>
  326. <td class="paramname"></td><td>)</td>
  327. <td></td>
  328. </tr>
  329. </table>
  330. </div><div class="memdoc">
  331. <dl class="params"><dt>Parameters</dt><dd>
  332. <table class="params">
  333. <tr><td class="paramname">strPattern</td><td>The string pattern to search for. </td></tr>
  334. </table>
  335. </dd>
  336. </dl>
  337. <dl class="section return"><dt>Returns</dt><dd>Returns the next file matching a search begun in findFirstFile. </dd></dl>
  338. </div>
  339. </div>
  340. <a class="anchor" id="ga12eb15575c7cdbf2a030086b46fb8d20"></a>
  341. <div class="memitem">
  342. <div class="memproto">
  343. <table class="memname">
  344. <tr>
  345. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> findNextFileMultiExpr </td>
  346. <td>(</td>
  347. <td class="paramtype">string&#160;</td>
  348. <td class="paramname"><em>pattern</em></td><td>)</td>
  349. <td></td>
  350. </tr>
  351. </table>
  352. </div><div class="memdoc">
  353. <p>Returns the next file matching a search begun in findFirstFile. </p>
  354. </div>
  355. </div>
  356. <a class="anchor" id="ga470ad7dd8c391d6aaa07d35c24fd1026"></a>
  357. <div class="memitem">
  358. <div class="memproto">
  359. <table class="memname">
  360. <tr>
  361. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getCurrentDate </td>
  362. <td>(</td>
  363. <td class="paramtype">bool&#160;</td>
  364. <td class="paramname"><em>reverse</em></td><td>)</td>
  365. <td></td>
  366. </tr>
  367. </table>
  368. </div><div class="memdoc">
  369. <p>Gets the current date and time. </p><dl class="params"><dt>Parameters</dt><dd>
  370. <table class="params">
  371. <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>
  372. </table>
  373. </dd>
  374. </dl>
  375. </div>
  376. </div>
  377. <a class="anchor" id="ga17af02b4662e4b0d85a117d6cd656877"></a>
  378. <div class="memitem">
  379. <div class="memproto">
  380. <table class="memname">
  381. <tr>
  382. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getCurrentDirectory </td>
  383. <td>(</td>
  384. <td class="paramname"></td><td>)</td>
  385. <td></td>
  386. </tr>
  387. </table>
  388. </div><div class="memdoc">
  389. </div>
  390. </div>
  391. <a class="anchor" id="ga6884e331ad1fa4f2e2b827854015b0b6"></a>
  392. <div class="memitem">
  393. <div class="memproto">
  394. <table class="memname">
  395. <tr>
  396. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getDirectoryList </td>
  397. <td>(</td>
  398. <td class="paramtype">strPath&#160;</td>
  399. <td class="paramname">, </td>
  400. </tr>
  401. <tr>
  402. <td class="paramkey"></td>
  403. <td></td>
  404. <td class="paramtype">[intDepth] ?&#160;</td>
  405. <td class="paramname">&#160;</td>
  406. </tr>
  407. <tr>
  408. <td></td>
  409. <td>)</td>
  410. <td></td><td></td>
  411. </tr>
  412. </table>
  413. </div><div class="memdoc">
  414. <dl class="params"><dt>Parameters</dt><dd>
  415. <table class="params">
  416. <tr><td class="paramname">strPath</td><td>The path in which to check </td></tr>
  417. <tr><td class="paramname">intDepth</td><td>The depth in which to return (default 0 if not specified) </td></tr>
  418. </table>
  419. </dd>
  420. </dl>
  421. <dl class="section return"><dt>Returns</dt><dd>The directory contents </dd></dl>
  422. </div>
  423. </div>
  424. <a class="anchor" id="ga0d68f8a65eca1904fa09a9980b064d4a"></a>
  425. <div class="memitem">
  426. <div class="memproto">
  427. <table class="memname">
  428. <tr>
  429. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getExecutableName </td>
  430. <td>(</td>
  431. <td class="paramname"></td><td>)</td>
  432. <td></td>
  433. </tr>
  434. </table>
  435. </div><div class="memdoc">
  436. </div>
  437. </div>
  438. <a class="anchor" id="ga4b7f7ce1623086a21260d71cc28cf368"></a>
  439. <div class="memitem">
  440. <div class="memproto">
  441. <table class="memname">
  442. <tr>
  443. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getFileCount </td>
  444. <td>(</td>
  445. <td class="paramtype">strPattern&#160;</td>
  446. <td class="paramname"></td><td>)</td>
  447. <td></td>
  448. </tr>
  449. </table>
  450. </div><div class="memdoc">
  451. <dl class="params"><dt>Parameters</dt><dd>
  452. <table class="params">
  453. <tr><td class="paramname">strPattern</td><td>The string pattern to search for. </td></tr>
  454. </table>
  455. </dd>
  456. </dl>
  457. <dl class="section return"><dt>Returns</dt><dd>Returns the number of files in the directory tree that match the given pattern </dd></dl>
  458. </div>
  459. </div>
  460. <a class="anchor" id="ga6072195cebf5cb6031a2509657e2f748"></a>
  461. <div class="memitem">
  462. <div class="memproto">
  463. <table class="memname">
  464. <tr>
  465. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getFileCountMultiExpr </td>
  466. <td>(</td>
  467. <td class="paramtype">strPattern&#160;</td>
  468. <td class="paramname"></td><td>)</td>
  469. <td></td>
  470. </tr>
  471. </table>
  472. </div><div class="memdoc">
  473. <dl class="params"><dt>Parameters</dt><dd>
  474. <table class="params">
  475. <tr><td class="paramname">strPattern</td><td>The string pattern to search for. </td></tr>
  476. </table>
  477. </dd>
  478. </dl>
  479. <dl class="section return"><dt>Returns</dt><dd>Returns the number of files in the directory tree that match the given pattern </dd></dl>
  480. </div>
  481. </div>
  482. <a class="anchor" id="gad7f94c1e696ebb99c6721a48e2ffe248"></a>
  483. <div class="memitem">
  484. <div class="memproto">
  485. <table class="memname">
  486. <tr>
  487. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getFileCRC </td>
  488. <td>(</td>
  489. <td class="paramtype">filename&#160;</td>
  490. <td class="paramname"></td><td>)</td>
  491. <td></td>
  492. </tr>
  493. </table>
  494. </div><div class="memdoc">
  495. <dl class="params"><dt>Parameters</dt><dd>
  496. <table class="params">
  497. <tr><td class="paramname">filename</td><td>The string representing the file from which to get the CRC </td></tr>
  498. </table>
  499. </dd>
  500. </dl>
  501. <dl class="section return"><dt>Returns</dt><dd>An integer </dd></dl>
  502. </div>
  503. </div>
  504. <a class="anchor" id="ga795b208786b255e9595132c066d11b30"></a>
  505. <div class="memitem">
  506. <div class="memproto">
  507. <table class="memname">
  508. <tr>
  509. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getFileList </td>
  510. <td>(</td>
  511. <td class="paramtype">strPath&#160;</td>
  512. <td class="paramname"></td><td>)</td>
  513. <td></td>
  514. </tr>
  515. </table>
  516. </div><div class="memdoc">
  517. <p>Gets all the files in the specified directory. </p><dl class="params"><dt>Parameters</dt><dd>
  518. <table class="params">
  519. <tr><td class="paramname">strPath</td><td>The path in which to check </td></tr>
  520. </table>
  521. </dd>
  522. </dl>
  523. <dl class="section return"><dt>Returns</dt><dd>A list of files in the specified directory. </dd></dl>
  524. </div>
  525. </div>
  526. <a class="anchor" id="ga3b0e41b11ab6859e00eacf997358805e"></a>
  527. <div class="memitem">
  528. <div class="memproto">
  529. <table class="memname">
  530. <tr>
  531. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getMainDotCsDir </td>
  532. <td>(</td>
  533. <td class="paramname"></td><td>)</td>
  534. <td></td>
  535. </tr>
  536. </table>
  537. </div><div class="memdoc">
  538. </div>
  539. </div>
  540. <a class="anchor" id="ga58fe9a762c3b8b0bbce9cc9952711230"></a>
  541. <div class="memitem">
  542. <div class="memproto">
  543. <table class="memname">
  544. <tr>
  545. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getTemporaryDirectory </td>
  546. <td>(</td>
  547. <td class="paramname"></td><td>)</td>
  548. <td></td>
  549. </tr>
  550. </table>
  551. </div><div class="memdoc">
  552. <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>
  553. </div>
  554. </div>
  555. <a class="anchor" id="gaeba6d1178d6ac3447c779e968df3c773"></a>
  556. <div class="memitem">
  557. <div class="memproto">
  558. <table class="memname">
  559. <tr>
  560. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getTemporaryFileName </td>
  561. <td>(</td>
  562. <td class="paramname"></td><td>)</td>
  563. <td></td>
  564. </tr>
  565. </table>
  566. </div><div class="memdoc">
  567. <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>
  568. </div>
  569. </div>
  570. <a class="anchor" id="gad7b9968aa8c151314c514121eb4e4e8d"></a>
  571. <div class="memitem">
  572. <div class="memproto">
  573. <table class="memname">
  574. <tr>
  575. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getUserDataDirectory </td>
  576. <td>(</td>
  577. <td class="paramname"></td><td>)</td>
  578. <td></td>
  579. </tr>
  580. </table>
  581. </div><div class="memdoc">
  582. <dl class="section return"><dt>Returns</dt><dd>Returns a string to the directory storing the user's data </dd></dl>
  583. </div>
  584. </div>
  585. <a class="anchor" id="gae3f16f82c521bc566d03409a2a44aaea"></a>
  586. <div class="memitem">
  587. <div class="memproto">
  588. <table class="memname">
  589. <tr>
  590. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getUserHomeDirectory </td>
  591. <td>(</td>
  592. <td class="paramname"></td><td>)</td>
  593. <td></td>
  594. </tr>
  595. </table>
  596. </div><div class="memdoc">
  597. <dl class="section return"><dt>Returns</dt><dd>Returns the path to the user's home directory. </dd></dl>
  598. </div>
  599. </div>
  600. <a class="anchor" id="gac2050a8dc00972ef1050a8680d80f768"></a>
  601. <div class="memitem">
  602. <div class="memproto">
  603. <table class="memname">
  604. <tr>
  605. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isDirectory </td>
  606. <td>(</td>
  607. <td class="paramtype">path&#160;</td>
  608. <td class="paramname"></td><td>)</td>
  609. <td></td>
  610. </tr>
  611. </table>
  612. </div><div class="memdoc">
  613. <dl class="params"><dt>Parameters</dt><dd>
  614. <table class="params">
  615. <tr><td class="paramname">pathName</td><td>Path to check. </td></tr>
  616. </table>
  617. </dd>
  618. </dl>
  619. <dl class="section return"><dt>Returns</dt><dd>Returns true if the given path is a folder/directory, false otherwise </dd></dl>
  620. </div>
  621. </div>
  622. <a class="anchor" id="ga4cf79e8a44c6c3cc499e9a3442ebf297"></a>
  623. <div class="memitem">
  624. <div class="memproto">
  625. <table class="memname">
  626. <tr>
  627. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isFile </td>
  628. <td>(</td>
  629. <td class="paramtype"><a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>&#160;</td>
  630. <td class="paramname"></td><td>)</td>
  631. <td></td>
  632. </tr>
  633. </table>
  634. </div><div class="memdoc">
  635. <dl class="params"><dt>Parameters</dt><dd>
  636. <table class="params">
  637. <tr><td class="paramname">fileName</td><td>Filename to check. </td></tr>
  638. </table>
  639. </dd>
  640. </dl>
  641. <dl class="section return"><dt>Returns</dt><dd>Returns true if the given filename is an existing file or false otherwise </dd></dl>
  642. </div>
  643. </div>
  644. <a class="anchor" id="ga722b3c5aba9c010f74d011d34db57df4"></a>
  645. <div class="memitem">
  646. <div class="memproto">
  647. <table class="memname">
  648. <tr>
  649. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isValidImageFile </td>
  650. <td>(</td>
  651. <td class="paramtype">string&#160;</td>
  652. <td class="paramname"><em>filePath</em></td><td>)</td>
  653. <td></td>
  654. </tr>
  655. </table>
  656. </div><div class="memdoc">
  657. <dl class="params"><dt>Parameters</dt><dd>
  658. <table class="params">
  659. <tr><td class="paramname">filePath</td><td>Full path of file to check. </td></tr>
  660. </table>
  661. </dd>
  662. </dl>
  663. <dl class="section return"><dt>Returns</dt><dd>Returns true if the given filename is a valid image file or false otherwise </dd></dl>
  664. </div>
  665. </div>
  666. <a class="anchor" id="ga0cebe12721100f107d531807f92fe2f4"></a>
  667. <div class="memitem">
  668. <div class="memproto">
  669. <table class="memname">
  670. <tr>
  671. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isWriteableFileName </td>
  672. <td>(</td>
  673. <td class="paramtype"><a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>&#160;</td>
  674. <td class="paramname"></td><td>)</td>
  675. <td></td>
  676. </tr>
  677. </table>
  678. </div><div class="memdoc">
  679. <dl class="params"><dt>Parameters</dt><dd>
  680. <table class="params">
  681. <tr><td class="paramname">fileName</td><td>Filename to check. </td></tr>
  682. </table>
  683. </dd>
  684. </dl>
  685. <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>
  686. </div>
  687. </div>
  688. <a class="anchor" id="ga71003026f4c7833539d12ec7c1a8a5d8"></a>
  689. <div class="memitem">
  690. <div class="memproto">
  691. <table class="memname">
  692. <tr>
  693. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> makeFullPath </td>
  694. <td>(</td>
  695. <td class="paramtype">string&#160;</td>
  696. <td class="paramname"><em>path</em>, </td>
  697. </tr>
  698. <tr>
  699. <td class="paramkey"></td>
  700. <td></td>
  701. <td class="paramtype">[string currentWorkingDir] ?&#160;</td>
  702. <td class="paramname">&#160;</td>
  703. </tr>
  704. <tr>
  705. <td></td>
  706. <td>)</td>
  707. <td></td><td></td>
  708. </tr>
  709. </table>
  710. </div><div class="memdoc">
  711. </div>
  712. </div>
  713. <a class="anchor" id="ga6920b3c3be8e66f5ce1c19ea9c9b8bc4"></a>
  714. <div class="memitem">
  715. <div class="memproto">
  716. <table class="memname">
  717. <tr>
  718. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> makeRelativePath </td>
  719. <td>(</td>
  720. <td class="paramtype">string&#160;</td>
  721. <td class="paramname"><em>path</em>, </td>
  722. </tr>
  723. <tr>
  724. <td class="paramkey"></td>
  725. <td></td>
  726. <td class="paramtype">string&#160;</td>
  727. <td class="paramname"><em>to</em>&#160;</td>
  728. </tr>
  729. <tr>
  730. <td></td>
  731. <td>)</td>
  732. <td></td><td></td>
  733. </tr>
  734. </table>
  735. </div><div class="memdoc">
  736. </div>
  737. </div>
  738. <a class="anchor" id="ga6ed8d04b39e458d9c96572a615c10c34"></a>
  739. <div class="memitem">
  740. <div class="memproto">
  741. <table class="memname">
  742. <tr>
  743. <td class="memname">void openFolder </td>
  744. <td>(</td>
  745. <td class="paramtype">path&#160;</td>
  746. <td class="paramname"></td><td>)</td>
  747. <td></td>
  748. </tr>
  749. </table>
  750. </div><div class="memdoc">
  751. <p>; </p>
  752. </div>
  753. </div>
  754. <a class="anchor" id="ga05a3e6cbe1cb37acb405bf47c2bb17c6"></a>
  755. <div class="memitem">
  756. <div class="memproto">
  757. <table class="memname">
  758. <tr>
  759. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> pathConcat </td>
  760. <td>(</td>
  761. <td class="paramtype">string&#160;</td>
  762. <td class="paramname"><em>path</em>, </td>
  763. </tr>
  764. <tr>
  765. <td class="paramkey"></td>
  766. <td></td>
  767. <td class="paramtype">string&#160;</td>
  768. <td class="paramname"><em>file1</em>, </td>
  769. </tr>
  770. <tr>
  771. <td class="paramkey"></td>
  772. <td></td>
  773. <td class="paramtype">[... fileN] *&#160;</td>
  774. <td class="paramname">&#160;</td>
  775. </tr>
  776. <tr>
  777. <td></td>
  778. <td>)</td>
  779. <td></td><td></td>
  780. </tr>
  781. </table>
  782. </div><div class="memdoc">
  783. </div>
  784. </div>
  785. <a class="anchor" id="ga89eb9e650f47bc43f58de53ccb8b2494"></a>
  786. <div class="memitem">
  787. <div class="memproto">
  788. <table class="memname">
  789. <tr>
  790. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> pathCopy </td>
  791. <td>(</td>
  792. <td class="paramtype">fromFile&#160;</td>
  793. <td class="paramname">, </td>
  794. </tr>
  795. <tr>
  796. <td class="paramkey"></td>
  797. <td></td>
  798. <td class="paramtype">toFile&#160;</td>
  799. <td class="paramname">, </td>
  800. </tr>
  801. <tr>
  802. <td class="paramkey"></td>
  803. <td></td>
  804. <td class="paramtype">[nooverwrite = true] ?&#160;</td>
  805. <td class="paramname">&#160;</td>
  806. </tr>
  807. <tr>
  808. <td></td>
  809. <td>)</td>
  810. <td></td><td></td>
  811. </tr>
  812. </table>
  813. </div><div class="memdoc">
  814. </div>
  815. </div>
  816. <a class="anchor" id="ga55cac30dc1287e0d4ed638af5797c9e8"></a>
  817. <div class="memitem">
  818. <div class="memproto">
  819. <table class="memname">
  820. <tr>
  821. <td class="memname">void restartInstance </td>
  822. <td>(</td>
  823. <td class="paramname"></td><td>)</td>
  824. <td></td>
  825. </tr>
  826. </table>
  827. </div><div class="memdoc">
  828. </div>
  829. </div>
  830. <a class="anchor" id="ga36c8e423674e67a7bd45312eec3896fe"></a>
  831. <div class="memitem">
  832. <div class="memproto">
  833. <table class="memname">
  834. <tr>
  835. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> setCurrentDirectory </td>
  836. <td>(</td>
  837. <td class="paramtype">absolutePathName&#160;</td>
  838. <td class="paramname"></td><td>)</td>
  839. <td></td>
  840. </tr>
  841. </table>
  842. </div><div class="memdoc">
  843. </div>
  844. </div>
  845. </div><!-- contents -->
  846. <!-- start footer part -->
  847. <hr class="footer"/><address class="footer"><small>
  848. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  849. <img class="footer" src="doxygen.png" alt="doxygen"/>
  850. </a> 1.8.10
  851. </small></address>
  852. </body>
  853. </html>