TorqueEngine
/
Torque2D
зеркало из https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224
							<!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: Resource Manager</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&amp;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">Resource Manager<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:gaf90374265a9aa9167de5e814f4ed388b" id="r_gaf90374265a9aa9167de5e814f4ed388b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ResourceManagerFunctions.html#gaf90374265a9aa9167de5e814f4ed388b">addResPath</a> (path, [ignoreZips=false]?)</td></tr>
<tr class="separator:gaf90374265a9aa9167de5e814f4ed388b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1e287bacda6e93d1205aed454068a592" id="r_ga1e287bacda6e93d1205aed454068a592"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ResourceManagerFunctions.html#ga1e287bacda6e93d1205aed454068a592">dumpResources</a> (onlyLoaded?)</td></tr>
<tr class="separator:ga1e287bacda6e93d1205aed454068a592"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga68182e298cac77ff7b44385dfbb28a71" id="r_ga68182e298cac77ff7b44385dfbb28a71"><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__ResourceManagerFunctions.html#ga68182e298cac77ff7b44385dfbb28a71">getModPaths</a> ()</td></tr>
<tr class="separator:ga68182e298cac77ff7b44385dfbb28a71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad376ece5e1aff25b307f102b5667cf81" id="r_gad376ece5e1aff25b307f102b5667cf81"><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__ResourceManagerFunctions.html#gad376ece5e1aff25b307f102b5667cf81">isUsingVFS</a> ()</td></tr>
<tr class="separator:gad376ece5e1aff25b307f102b5667cf81"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga848d090f4e510d3fb74843f4010a56d2" id="r_ga848d090f4e510d3fb74843f4010a56d2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ResourceManagerFunctions.html#ga848d090f4e510d3fb74843f4010a56d2">purgeResources</a> ()</td></tr>
<tr class="separator:ga848d090f4e510d3fb74843f4010a56d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2ac7fc839151445a5798c07fe17b1960" id="r_ga2ac7fc839151445a5798c07fe17b1960"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ResourceManagerFunctions.html#ga2ac7fc839151445a5798c07fe17b1960">removeResPath</a> (pathExpression)</td></tr>
<tr class="separator:ga2ac7fc839151445a5798c07fe17b1960"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga454a40d6137a904e67d0f0fe4f9b59ca" id="r_ga454a40d6137a904e67d0f0fe4f9b59ca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ResourceManagerFunctions.html#ga454a40d6137a904e67d0f0fe4f9b59ca">setModPaths</a> (path)</td></tr>
<tr class="separator:ga454a40d6137a904e67d0f0fe4f9b59ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaf90374265a9aa9167de5e814f4ed388b" name="gaf90374265a9aa9167de5e814f4ed388b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf90374265a9aa9167de5e814f4ed388b">&#9670;&#160;</a></span>addResPath()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> addResPath </td>
          <td>(</td>
          <td class="paramtype">path&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">[ignoreZips=false] ?&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Add a path to the resource manager </p>

</div>
</div>
<a id="ga1e287bacda6e93d1205aed454068a592" name="ga1e287bacda6e93d1205aed454068a592"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1e287bacda6e93d1205aed454068a592">&#9670;&#160;</a></span>dumpResources()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> dumpResources </td>
          <td>(</td>
          <td class="paramtype">onlyLoaded?&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the dumpLoadedResources function to dump a listing of the currently in-use resources to the console. This will include such things as sound files, font files, etc. For this to work, the engine must have been compiled with TORQUE_DEBUG defined. </p><dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ResourceManagerFunctions.html#ga848d090f4e510d3fb74843f4010a56d2">purgeResources</a> </dd></dl>

</div>
</div>
<a id="ga68182e298cac77ff7b44385dfbb28a71" name="ga68182e298cac77ff7b44385dfbb28a71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga68182e298cac77ff7b44385dfbb28a71">&#9670;&#160;</a></span>getModPaths()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getModPaths </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the getModPaths function to get the current mod path information. </p><dl class="section return"><dt>Returns</dt><dd>Returns a string equivalent to the complete current mod path, that is all pads that are visible to the file manager. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ResourceManagerFunctions.html#ga454a40d6137a904e67d0f0fe4f9b59ca">setModPaths</a> </dd></dl>

</div>
</div>
<a id="gad376ece5e1aff25b307f102b5667cf81" name="gad376ece5e1aff25b307f102b5667cf81"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad376ece5e1aff25b307f102b5667cf81">&#9670;&#160;</a></span>isUsingVFS()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isUsingVFS </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 true if using Virtual File System </dd></dl>

</div>
</div>
<a id="ga848d090f4e510d3fb74843f4010a56d2" name="ga848d090f4e510d3fb74843f4010a56d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga848d090f4e510d3fb74843f4010a56d2">&#9670;&#160;</a></span>purgeResources()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> purgeResources </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the purgeResources function to purge all game resources. </p><dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See also</dt><dd>clearTextureHolds, dumpResourceStats, dumpTextureStats, <a class="el" href="group__TextureManagerFunctions.html#ga88eac6217cf938cf36e3d50b6b227919">flushTextureCache</a> </dd></dl>

</div>
</div>
<a id="ga2ac7fc839151445a5798c07fe17b1960" name="ga2ac7fc839151445a5798c07fe17b1960"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2ac7fc839151445a5798c07fe17b1960">&#9670;&#160;</a></span>removeResPath()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> removeResPath </td>
          <td>(</td>
          <td class="paramtype">pathExpression&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Remove a path from the resource manager. Path is an expression as in <a class="el" href="group__FileSystem.html#gae1ed75e046037cdce2dea4ce352ac617">findFirstFile()</a> </p>

</div>
</div>
<a id="ga454a40d6137a904e67d0f0fe4f9b59ca" name="ga454a40d6137a904e67d0f0fe4f9b59ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga454a40d6137a904e67d0f0fe4f9b59ca">&#9670;&#160;</a></span>setModPaths()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setModPaths </td>
          <td>(</td>
          <td class="paramtype">path&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the setModPaths function to set the current mod path to the value specified in path. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">path</td><td>A string containing a semi-colon (;) separated list of game and mod paths. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ResourceManagerFunctions.html#ga68182e298cac77ff7b44385dfbb28a71">getModPaths</a> </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>