class_res_manager.html 65 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Torque2D Reference: ResManager Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr id="projectrow">
  24. <td id="projectalign">
  25. <div id="projectname">Torque2D Reference
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.9.8 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  36. var searchBox = new SearchBox("searchBox", "search/",'.html');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */
  48. </script>
  49. <div id="main-nav"></div>
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <div id="MSearchResults">
  59. <div class="SRPage">
  60. <div id="SRIndex">
  61. <div id="SRResults"></div>
  62. <div class="SRStatus" id="Loading">Loading...</div>
  63. <div class="SRStatus" id="Searching">Searching...</div>
  64. <div class="SRStatus" id="NoMatches">No Matches</div>
  65. </div>
  66. </div>
  67. </div>
  68. </div>
  69. </div><!-- top -->
  70. <div class="header">
  71. <div class="summary">
  72. <a href="#nested-classes">Classes</a> &#124;
  73. <a href="#pub-methods">Public Member Functions</a> &#124;
  74. <a href="class_res_manager-members.html">List of all members</a> </div>
  75. <div class="headertitle"><div class="title">ResManager Class Reference</div></div>
  76. </div><!--header-->
  77. <div class="contents">
  78. <p><code>#include &lt;resourceManager.h&gt;</code></p>
  79. <table class="memberdecls">
  80. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  81. Public Member Functions</h2></td></tr>
  82. <tr class="memitem:a4a5d086cb79babfc31314dccf11e9924" id="r_a4a5d086cb79babfc31314dccf11e9924"><td class="memItemLeft" align="right" valign="top">RESOURCE_CREATE_FN&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#a4a5d086cb79babfc31314dccf11e9924">getCreateFunction</a> (const char *name)</td></tr>
  83. <tr class="separator:a4a5d086cb79babfc31314dccf11e9924"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a7fa361904249ce83fa54bfcb9becdc15" id="r_a7fa361904249ce83fa54bfcb9becdc15"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#a7fa361904249ce83fa54bfcb9becdc15">~ResManager</a> ()</td></tr>
  85. <tr class="separator:a7fa361904249ce83fa54bfcb9becdc15"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:ae68c1cad604c655bd6bda74301192f0f" id="r_ae68c1cad604c655bd6bda74301192f0f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#ae68c1cad604c655bd6bda74301192f0f">setFileNameEcho</a> (bool on)</td></tr>
  87. <tr class="memdesc:ae68c1cad604c655bd6bda74301192f0f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets whether or not to echo filenames that have been accessed by means of openStream. <br /></td></tr>
  88. <tr class="separator:ae68c1cad604c655bd6bda74301192f0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a6dd8a00088408806ba412b3e2f71ee02" id="r_a6dd8a00088408806ba412b3e2f71ee02"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#a6dd8a00088408806ba412b3e2f71ee02">setModPaths</a> (U32 numPaths, const char **dirs)</td></tr>
  90. <tr class="memdesc:a6dd8a00088408806ba412b3e2f71ee02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the path for the current game mod. <br /></td></tr>
  91. <tr class="separator:a6dd8a00088408806ba412b3e2f71ee02"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a50b85edadf4775b261e1fd418e97c2a7" id="r_a50b85edadf4775b261e1fd418e97c2a7"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#a50b85edadf4775b261e1fd418e97c2a7">getModPaths</a> ()</td></tr>
  93. <tr class="memdesc:a50b85edadf4775b261e1fd418e97c2a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the path for the current game mod. <br /></td></tr>
  94. <tr class="separator:a50b85edadf4775b261e1fd418e97c2a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:a52e99dc0123598a9eeb4fac2268b0874" id="r_a52e99dc0123598a9eeb4fac2268b0874"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#a52e99dc0123598a9eeb4fac2268b0874">addPath</a> (const char *path, bool ignoreZips=false)</td></tr>
  96. <tr class="memdesc:a52e99dc0123598a9eeb4fac2268b0874"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a path. <br /></td></tr>
  97. <tr class="separator:a52e99dc0123598a9eeb4fac2268b0874"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a9676796780b94b46809af809d83b1107" id="r_a9676796780b94b46809af809d83b1107"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#a9676796780b94b46809af809d83b1107">removePath</a> (const char *path)</td></tr>
  99. <tr class="memdesc:a9676796780b94b46809af809d83b1107"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove a path. Only removes resources that are not loaded. <br /></td></tr>
  100. <tr class="separator:a9676796780b94b46809af809d83b1107"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:ab014294b9e7470365bde5d9321a9a69f" id="r_ab014294b9e7470365bde5d9321a9a69f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#ab014294b9e7470365bde5d9321a9a69f">setMissingFileLogging</a> (bool log)</td></tr>
  102. <tr class="memdesc:ab014294b9e7470365bde5d9321a9a69f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Should we log missing files? <br /></td></tr>
  103. <tr class="separator:ab014294b9e7470365bde5d9321a9a69f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a690104ab8617fcbe0a083f9c183ac524" id="r_a690104ab8617fcbe0a083f9c183ac524"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#a690104ab8617fcbe0a083f9c183ac524">getMissingFileList</a> (<a class="el" href="class_vector.html">Vector</a>&lt; char * &gt; &amp;list)</td></tr>
  105. <tr class="memdesc:a690104ab8617fcbe0a083f9c183ac524"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets which files are missing. <br /></td></tr>
  106. <tr class="separator:a690104ab8617fcbe0a083f9c183ac524"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a7a438214f9ea092ff121347211ef576d" id="r_a7a438214f9ea092ff121347211ef576d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#a7a438214f9ea092ff121347211ef576d">clearMissingFileList</a> ()</td></tr>
  108. <tr class="memdesc:a7a438214f9ea092ff121347211ef576d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears the missing file list. <br /></td></tr>
  109. <tr class="separator:a7a438214f9ea092ff121347211ef576d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a0036ffad373b2d87df5abf674cb4cda1" id="r_a0036ffad373b2d87df5abf674cb4cda1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#a0036ffad373b2d87df5abf674cb4cda1">registerExtension</a> (const char *extension, RESOURCE_CREATE_FN create_fn)</td></tr>
  111. <tr class="memdesc:a0036ffad373b2d87df5abf674cb4cda1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tells the resource manager what to do with a resource that it loads. <br /></td></tr>
  112. <tr class="separator:a0036ffad373b2d87df5abf674cb4cda1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:a390a79c065d86c2991531f312504ba36" id="r_a390a79c065d86c2991531f312504ba36"><td class="memItemLeft" align="right" valign="top">S32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#a390a79c065d86c2991531f312504ba36">getSize</a> (const char *filename)</td></tr>
  114. <tr class="memdesc:a390a79c065d86c2991531f312504ba36"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the size of the file. <br /></td></tr>
  115. <tr class="separator:a390a79c065d86c2991531f312504ba36"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:ac127e3c18b370acf31b4bc9dea2951a1" id="r_ac127e3c18b370acf31b4bc9dea2951a1"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#ac127e3c18b370acf31b4bc9dea2951a1">getFullPath</a> (const char *filename, char *path, U32 pathLen)</td></tr>
  117. <tr class="memdesc:ac127e3c18b370acf31b4bc9dea2951a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the full path of the file. <br /></td></tr>
  118. <tr class="separator:ac127e3c18b370acf31b4bc9dea2951a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:ae28d77efb22c87453dfbb6cd506a7805" id="r_ae28d77efb22c87453dfbb6cd506a7805"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#ae28d77efb22c87453dfbb6cd506a7805">getModPathOf</a> (const char *fileName)</td></tr>
  120. <tr class="memdesc:ae28d77efb22c87453dfbb6cd506a7805"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the path of the file local to the mod. <br /></td></tr>
  121. <tr class="separator:ae28d77efb22c87453dfbb6cd506a7805"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a46ec5091237d4f4f1b5f208225a91e86" id="r_a46ec5091237d4f4f1b5f208225a91e86"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#a46ec5091237d4f4f1b5f208225a91e86">getPathOf</a> (const char *filename)</td></tr>
  123. <tr class="memdesc:a46ec5091237d4f4f1b5f208225a91e86"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the path of the file from the base directory. <br /></td></tr>
  124. <tr class="separator:a46ec5091237d4f4f1b5f208225a91e86"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:a5f20f448e965709d7a972aad65fb556f" id="r_a5f20f448e965709d7a972aad65fb556f"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#a5f20f448e965709d7a972aad65fb556f">getBasePath</a> ()</td></tr>
  126. <tr class="memdesc:a5f20f448e965709d7a972aad65fb556f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the base path. <br /></td></tr>
  127. <tr class="separator:a5f20f448e965709d7a972aad65fb556f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a4080a45dae0e383c73df4ec7283f0bf1" id="r_a4080a45dae0e383c73df4ec7283f0bf1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_resource_object.html">ResourceObject</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#a4080a45dae0e383c73df4ec7283f0bf1">load</a> (const char *fileName, bool computeCRC=false)</td></tr>
  129. <tr class="memdesc:a4080a45dae0e383c73df4ec7283f0bf1"><td class="mdescLeft">&#160;</td><td class="mdescRight">loads an instance of an object <br /></td></tr>
  130. <tr class="separator:a4080a45dae0e383c73df4ec7283f0bf1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a204a91f8dded120cd11cb2014778965b" id="r_a204a91f8dded120cd11cb2014778965b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_stream.html">Stream</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#a204a91f8dded120cd11cb2014778965b">openStream</a> (const char *fileName)</td></tr>
  132. <tr class="memdesc:a204a91f8dded120cd11cb2014778965b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Opens a stream for an object. <br /></td></tr>
  133. <tr class="separator:a204a91f8dded120cd11cb2014778965b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a06309af7a58d67eec4013313ded568d2" id="r_a06309af7a58d67eec4013313ded568d2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_stream.html">Stream</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#a06309af7a58d67eec4013313ded568d2">openStream</a> (<a class="el" href="class_resource_object.html">ResourceObject</a> *object)</td></tr>
  135. <tr class="memdesc:a06309af7a58d67eec4013313ded568d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Opens a stream for an object. <br /></td></tr>
  136. <tr class="separator:a06309af7a58d67eec4013313ded568d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:a24ddf472b6f0408d10b24a1691b360d1" id="r_a24ddf472b6f0408d10b24a1691b360d1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#a24ddf472b6f0408d10b24a1691b360d1">closeStream</a> (<a class="el" href="class_stream.html">Stream</a> *stream)</td></tr>
  138. <tr class="memdesc:a24ddf472b6f0408d10b24a1691b360d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Closes the stream. <br /></td></tr>
  139. <tr class="separator:a24ddf472b6f0408d10b24a1691b360d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:adf0e315d8a675bab8abb666cf6d5f4dc" id="r_adf0e315d8a675bab8abb666cf6d5f4dc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#adf0e315d8a675bab8abb666cf6d5f4dc">unlock</a> (<a class="el" href="class_resource_object.html">ResourceObject</a> *)</td></tr>
  141. <tr class="separator:adf0e315d8a675bab8abb666cf6d5f4dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:a02bfcd7c3949f04c69814b12cf8977e3" id="r_a02bfcd7c3949f04c69814b12cf8977e3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#a02bfcd7c3949f04c69814b12cf8977e3">add</a> (const char *name, <a class="el" href="class_resource_instance.html">ResourceInstance</a> *addInstance, bool extraLock=false)</td></tr>
  143. <tr class="memdesc:a02bfcd7c3949f04c69814b12cf8977e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a new resource instance. <br /></td></tr>
  144. <tr class="separator:a02bfcd7c3949f04c69814b12cf8977e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:a93ff71e394db0ce3f058396d7c39bc61" id="r_a93ff71e394db0ce3f058396d7c39bc61"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_resource_object.html">ResourceObject</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#a93ff71e394db0ce3f058396d7c39bc61">find</a> (const char *fileName)</td></tr>
  146. <tr class="memdesc:a93ff71e394db0ce3f058396d7c39bc61"><td class="mdescLeft">&#160;</td><td class="mdescRight">Searches the hash list for the filename and returns it's object if found, otherwise NULL. <br /></td></tr>
  147. <tr class="separator:a93ff71e394db0ce3f058396d7c39bc61"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:a9dc3b86678a0363daa6a76fa7c60798a" id="r_a9dc3b86678a0363daa6a76fa7c60798a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_resource_instance.html">ResourceInstance</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#a9dc3b86678a0363daa6a76fa7c60798a">loadInstance</a> (const char *fileName, bool computeCRC=false)</td></tr>
  149. <tr class="memdesc:a9dc3b86678a0363daa6a76fa7c60798a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads a new instance of an object by means of a filename. <br /></td></tr>
  150. <tr class="separator:a9dc3b86678a0363daa6a76fa7c60798a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:aaa22ccbb37f4f6d135181a95d3347aa3" id="r_aaa22ccbb37f4f6d135181a95d3347aa3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_resource_instance.html">ResourceInstance</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#aaa22ccbb37f4f6d135181a95d3347aa3">loadInstance</a> (<a class="el" href="class_resource_object.html">ResourceObject</a> *object, bool computeCRC=false)</td></tr>
  152. <tr class="memdesc:aaa22ccbb37f4f6d135181a95d3347aa3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads a new instance of an object by means of a resource object. <br /></td></tr>
  153. <tr class="separator:aaa22ccbb37f4f6d135181a95d3347aa3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:a64c05085ec0f365dfb02bf2f643a9ebd" id="r_a64c05085ec0f365dfb02bf2f643a9ebd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_resource_object.html">ResourceObject</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#a64c05085ec0f365dfb02bf2f643a9ebd">find</a> (const char *fileName, U32 flags)</td></tr>
  155. <tr class="memdesc:a64c05085ec0f365dfb02bf2f643a9ebd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Searches the hash list for the filename and returns it's object if found, otherwise NULL. <br /></td></tr>
  156. <tr class="separator:a64c05085ec0f365dfb02bf2f643a9ebd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:a900cfe63e864fffb5f60fa1fb61f9027" id="r_a900cfe63e864fffb5f60fa1fb61f9027"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_resource_object.html">ResourceObject</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#a900cfe63e864fffb5f60fa1fb61f9027">findMatch</a> (const char *expression, const char **fn, <a class="el" href="class_resource_object.html">ResourceObject</a> *start=NULL)</td></tr>
  158. <tr class="memdesc:a900cfe63e864fffb5f60fa1fb61f9027"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finds a resource object with given expression. <br /></td></tr>
  159. <tr class="separator:a900cfe63e864fffb5f60fa1fb61f9027"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <tr class="memitem:a9708bd7f94e08ad390ea8f5403d89a7a" id="r_a9708bd7f94e08ad390ea8f5403d89a7a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_resource_object.html">ResourceObject</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#a9708bd7f94e08ad390ea8f5403d89a7a">findMatchMultiExprs</a> (const char *multiExpression, const char **fn, <a class="el" href="class_resource_object.html">ResourceObject</a> *start=NULL)</td></tr>
  161. <tr class="memdesc:a9708bd7f94e08ad390ea8f5403d89a7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finds a resource object with given expressions, seperated by " ". <br /></td></tr>
  162. <tr class="separator:a9708bd7f94e08ad390ea8f5403d89a7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. <tr class="memitem:a7cacf22c33094f6fe66818f2e939c291" id="r_a7cacf22c33094f6fe66818f2e939c291"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#a7cacf22c33094f6fe66818f2e939c291">purge</a> ()</td></tr>
  164. <tr class="memdesc:a7cacf22c33094f6fe66818f2e939c291"><td class="mdescLeft">&#160;</td><td class="mdescRight">Goes through the timeoutList and deletes it all. BURN!!! <br /></td></tr>
  165. <tr class="separator:a7cacf22c33094f6fe66818f2e939c291"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. <tr class="memitem:ac66c94d38f71707840b4843f60c95514" id="r_ac66c94d38f71707840b4843f60c95514"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#ac66c94d38f71707840b4843f60c95514">purge</a> (<a class="el" href="class_resource_object.html">ResourceObject</a> *obj)</td></tr>
  167. <tr class="memdesc:ac66c94d38f71707840b4843f60c95514"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deletes one resource object. <br /></td></tr>
  168. <tr class="separator:ac66c94d38f71707840b4843f60c95514"><td class="memSeparator" colspan="2">&#160;</td></tr>
  169. <tr class="memitem:ae1dd5cdfdd0c6aed8fce0e7b4b57654b" id="r_ae1dd5cdfdd0c6aed8fce0e7b4b57654b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#ae1dd5cdfdd0c6aed8fce0e7b4b57654b">freeResource</a> (<a class="el" href="class_resource_object.html">ResourceObject</a> *resObject)</td></tr>
  170. <tr class="memdesc:ae1dd5cdfdd0c6aed8fce0e7b4b57654b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frees a resource! <br /></td></tr>
  171. <tr class="separator:ae1dd5cdfdd0c6aed8fce0e7b4b57654b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  172. <tr class="memitem:a6450aab646022538d469983e8106fcfe" id="r_a6450aab646022538d469983e8106fcfe"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#a6450aab646022538d469983e8106fcfe">serialize</a> (<a class="el" href="class_vector_ptr.html">VectorPtr</a>&lt; const char * &gt; &amp;filenames)</td></tr>
  173. <tr class="memdesc:a6450aab646022538d469983e8106fcfe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sorts the resource objects. <br /></td></tr>
  174. <tr class="separator:a6450aab646022538d469983e8106fcfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  175. <tr class="memitem:af412e2bdb2e2c3f19516dab5340c70c3" id="r_af412e2bdb2e2c3f19516dab5340c70c3"><td class="memItemLeft" align="right" valign="top">S32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#af412e2bdb2e2c3f19516dab5340c70c3">findMatches</a> (<a class="el" href="class_find_match.html">FindMatch</a> *pFM)</td></tr>
  176. <tr class="memdesc:af412e2bdb2e2c3f19516dab5340c70c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finds multiple matches to an expression. <br /></td></tr>
  177. <tr class="separator:af412e2bdb2e2c3f19516dab5340c70c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  178. <tr class="memitem:af81e4d818b12b0f3df331d05ad06662c" id="r_af81e4d818b12b0f3df331d05ad06662c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#af81e4d818b12b0f3df331d05ad06662c">findFile</a> (const char *name)</td></tr>
  179. <tr class="memdesc:af81e4d818b12b0f3df331d05ad06662c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks to see if a file exists. <br /></td></tr>
  180. <tr class="separator:af81e4d818b12b0f3df331d05ad06662c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  181. <tr class="memitem:ad74be953f8f6391d4f8e7fca34d25ba6" id="r_ad74be953f8f6391d4f8e7fca34d25ba6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#ad74be953f8f6391d4f8e7fca34d25ba6">addVFSRoot</a> (<a class="el" href="class_zip_1_1_zip_archive.html">Zip::ZipArchive</a> *vfs)</td></tr>
  182. <tr class="separator:ad74be953f8f6391d4f8e7fca34d25ba6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  183. <tr class="memitem:ae1e05ddbd00addd63790d2fca9e35112" id="r_ae1e05ddbd00addd63790d2fca9e35112"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#ae1e05ddbd00addd63790d2fca9e35112">isUsingVFS</a> ()</td></tr>
  184. <tr class="separator:ae1e05ddbd00addd63790d2fca9e35112"><td class="memSeparator" colspan="2">&#160;</td></tr>
  185. <tr class="memitem:aca38866ce8062de2a75e02140cb4c399" id="r_aca38866ce8062de2a75e02140cb4c399"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#aca38866ce8062de2a75e02140cb4c399">getCrc</a> (const char *fileName, U32 &amp;crcVal, const U32 crcInitialVal=INITIAL_CRC_VALUE)</td></tr>
  186. <tr class="separator:aca38866ce8062de2a75e02140cb4c399"><td class="memSeparator" colspan="2">&#160;</td></tr>
  187. <tr class="memitem:a4d273b28da1ac885e6e2bd94cdd4080d" id="r_a4d273b28da1ac885e6e2bd94cdd4080d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#a4d273b28da1ac885e6e2bd94cdd4080d">setWriteablePath</a> (const char *path)</td></tr>
  188. <tr class="memdesc:a4d273b28da1ac885e6e2bd94cdd4080d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the writable path for a file to the one given. <br /></td></tr>
  189. <tr class="separator:a4d273b28da1ac885e6e2bd94cdd4080d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  190. <tr class="memitem:aee291d985ac1f8a08753ac6bb8794522" id="r_aee291d985ac1f8a08753ac6bb8794522"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#aee291d985ac1f8a08753ac6bb8794522">isValidWriteFileName</a> (const char *fn)</td></tr>
  191. <tr class="memdesc:aee291d985ac1f8a08753ac6bb8794522"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks to see if the given path is valid for writing. <br /></td></tr>
  192. <tr class="separator:aee291d985ac1f8a08753ac6bb8794522"><td class="memSeparator" colspan="2">&#160;</td></tr>
  193. <tr class="memitem:a319b56473244f280f1aa19715c7dc735" id="r_a319b56473244f280f1aa19715c7dc735"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#a319b56473244f280f1aa19715c7dc735">openFileForWrite</a> (<a class="el" href="class_file_stream.html">FileStream</a> &amp;fs, const char *fileName, U32 accessMode=<a class="el" href="class_file.html#ab22d35ed086a478dd91e93ac78037f40aa56670174817e3fed92bfd8182d7c0d1">File::Write</a>)</td></tr>
  194. <tr class="memdesc:a319b56473244f280f1aa19715c7dc735"><td class="mdescLeft">&#160;</td><td class="mdescRight">Opens a file for writing! <br /></td></tr>
  195. <tr class="separator:a319b56473244f280f1aa19715c7dc735"><td class="memSeparator" colspan="2">&#160;</td></tr>
  196. <tr class="memitem:af6b44612d77a4820347d4c93a2d53588" id="r_af6b44612d77a4820347d4c93a2d53588"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#af6b44612d77a4820347d4c93a2d53588">dumpResources</a> (const bool onlyLoaded=true)</td></tr>
  197. <tr class="memdesc:af6b44612d77a4820347d4c93a2d53588"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dumps all loaded resources to the console. <br /></td></tr>
  198. <tr class="separator:af6b44612d77a4820347d4c93a2d53588"><td class="memSeparator" colspan="2">&#160;</td></tr>
  199. </table><table class="memberdecls">
  200. <tr class="heading"><td colspan="2"><h2 class="groupheader">Global Control</h2></td></tr>
  201. <tr><td class="ititle" colspan="2"><p>These are called to initialize/destroy the resource manager at runtime. </p>
  202. </td></tr>
  203. <tr class="memitem:ae2ee59f7cc16ee42559c87e81c433039" id="r_ae2ee59f7cc16ee42559c87e81c433039"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#ae2ee59f7cc16ee42559c87e81c433039">create</a> ()</td></tr>
  204. <tr class="separator:ae2ee59f7cc16ee42559c87e81c433039"><td class="memSeparator" colspan="2">&#160;</td></tr>
  205. <tr class="memitem:a3a80b6032f86a56bec74609034b3246f" id="r_a3a80b6032f86a56bec74609034b3246f"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#a3a80b6032f86a56bec74609034b3246f">destroy</a> ()</td></tr>
  206. <tr class="separator:a3a80b6032f86a56bec74609034b3246f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  207. <tr class="memitem:abae60ec1deabfad0080e0e7f7b87999b" id="r_abae60ec1deabfad0080e0e7f7b87999b"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_manager.html#abae60ec1deabfad0080e0e7f7b87999b">initExcludedDirectories</a> ()</td></tr>
  208. <tr class="separator:abae60ec1deabfad0080e0e7f7b87999b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  209. </table>
  210. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  211. <div class="textblock"><p>A virtual file system for the storage and retrieval of ResourceObjects.</p>
  212. <p>Basic resource manager behavior:</p><ul>
  213. <li>Set the mod path.<ul>
  214. <li><a class="el" href="class_res_manager.html">ResManager</a> scans directory tree under listed base directories</li>
  215. <li>Any volume (.zip) file in the root directory of a mod is scanned for resources.</li>
  216. <li>Any files currently in the resource manager become memory resources.</li>
  217. <li>They can be "reattached" to the first file that matches the file name.</li>
  218. </ul>
  219. </li>
  220. </ul>
  221. <p>All classes which wish to be handled by the resource manager need:</p><ol type="1">
  222. <li>To be derived from <a class="el" href="class_resource_instance.html">ResourceInstance</a>.</li>
  223. <li>To register a creation function and file extension with the manager. </li>
  224. </ol>
  225. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  226. <a id="a7fa361904249ce83fa54bfcb9becdc15" name="a7fa361904249ce83fa54bfcb9becdc15"></a>
  227. <h2 class="memtitle"><span class="permalink"><a href="#a7fa361904249ce83fa54bfcb9becdc15">&#9670;&#160;</a></span>~ResManager()</h2>
  228. <div class="memitem">
  229. <div class="memproto">
  230. <table class="memname">
  231. <tr>
  232. <td class="memname">~<a class="el" href="class_res_manager.html">ResManager</a> </td>
  233. <td>(</td>
  234. <td class="paramname"></td><td>)</td>
  235. <td></td>
  236. </tr>
  237. </table>
  238. </div><div class="memdoc">
  239. </div>
  240. </div>
  241. <h2 class="groupheader">Member Function Documentation</h2>
  242. <a id="a02bfcd7c3949f04c69814b12cf8977e3" name="a02bfcd7c3949f04c69814b12cf8977e3"></a>
  243. <h2 class="memtitle"><span class="permalink"><a href="#a02bfcd7c3949f04c69814b12cf8977e3">&#9670;&#160;</a></span>add()</h2>
  244. <div class="memitem">
  245. <div class="memproto">
  246. <table class="memname">
  247. <tr>
  248. <td class="memname">bool add </td>
  249. <td>(</td>
  250. <td class="paramtype">const char *&#160;</td>
  251. <td class="paramname"><em>name</em>, </td>
  252. </tr>
  253. <tr>
  254. <td class="paramkey"></td>
  255. <td></td>
  256. <td class="paramtype"><a class="el" href="class_resource_instance.html">ResourceInstance</a> *&#160;</td>
  257. <td class="paramname"><em>addInstance</em>, </td>
  258. </tr>
  259. <tr>
  260. <td class="paramkey"></td>
  261. <td></td>
  262. <td class="paramtype">bool&#160;</td>
  263. <td class="paramname"><em>extraLock</em> = <code>false</code>&#160;</td>
  264. </tr>
  265. <tr>
  266. <td></td>
  267. <td>)</td>
  268. <td></td><td></td>
  269. </tr>
  270. </table>
  271. </div><div class="memdoc">
  272. <p>Add a new resource instance. </p>
  273. </div>
  274. </div>
  275. <a id="a52e99dc0123598a9eeb4fac2268b0874" name="a52e99dc0123598a9eeb4fac2268b0874"></a>
  276. <h2 class="memtitle"><span class="permalink"><a href="#a52e99dc0123598a9eeb4fac2268b0874">&#9670;&#160;</a></span>addPath()</h2>
  277. <div class="memitem">
  278. <div class="memproto">
  279. <table class="memname">
  280. <tr>
  281. <td class="memname">void addPath </td>
  282. <td>(</td>
  283. <td class="paramtype">const char *&#160;</td>
  284. <td class="paramname"><em>path</em>, </td>
  285. </tr>
  286. <tr>
  287. <td class="paramkey"></td>
  288. <td></td>
  289. <td class="paramtype">bool&#160;</td>
  290. <td class="paramname"><em>ignoreZips</em> = <code>false</code>&#160;</td>
  291. </tr>
  292. <tr>
  293. <td></td>
  294. <td>)</td>
  295. <td></td><td></td>
  296. </tr>
  297. </table>
  298. </div><div class="memdoc">
  299. <p>Add a path. </p>
  300. </div>
  301. </div>
  302. <a id="ad74be953f8f6391d4f8e7fca34d25ba6" name="ad74be953f8f6391d4f8e7fca34d25ba6"></a>
  303. <h2 class="memtitle"><span class="permalink"><a href="#ad74be953f8f6391d4f8e7fca34d25ba6">&#9670;&#160;</a></span>addVFSRoot()</h2>
  304. <div class="memitem">
  305. <div class="memproto">
  306. <table class="memname">
  307. <tr>
  308. <td class="memname">bool addVFSRoot </td>
  309. <td>(</td>
  310. <td class="paramtype"><a class="el" href="class_zip_1_1_zip_archive.html">Zip::ZipArchive</a> *&#160;</td>
  311. <td class="paramname"><em>vfs</em></td><td>)</td>
  312. <td></td>
  313. </tr>
  314. </table>
  315. </div><div class="memdoc">
  316. </div>
  317. </div>
  318. <a id="a7a438214f9ea092ff121347211ef576d" name="a7a438214f9ea092ff121347211ef576d"></a>
  319. <h2 class="memtitle"><span class="permalink"><a href="#a7a438214f9ea092ff121347211ef576d">&#9670;&#160;</a></span>clearMissingFileList()</h2>
  320. <div class="memitem">
  321. <div class="memproto">
  322. <table class="memname">
  323. <tr>
  324. <td class="memname">void clearMissingFileList </td>
  325. <td>(</td>
  326. <td class="paramname"></td><td>)</td>
  327. <td></td>
  328. </tr>
  329. </table>
  330. </div><div class="memdoc">
  331. <p>Clears the missing file list. </p>
  332. </div>
  333. </div>
  334. <a id="a24ddf472b6f0408d10b24a1691b360d1" name="a24ddf472b6f0408d10b24a1691b360d1"></a>
  335. <h2 class="memtitle"><span class="permalink"><a href="#a24ddf472b6f0408d10b24a1691b360d1">&#9670;&#160;</a></span>closeStream()</h2>
  336. <div class="memitem">
  337. <div class="memproto">
  338. <table class="memname">
  339. <tr>
  340. <td class="memname">void closeStream </td>
  341. <td>(</td>
  342. <td class="paramtype"><a class="el" href="class_stream.html">Stream</a> *&#160;</td>
  343. <td class="paramname"><em>stream</em></td><td>)</td>
  344. <td></td>
  345. </tr>
  346. </table>
  347. </div><div class="memdoc">
  348. <p>Closes the stream. </p>
  349. </div>
  350. </div>
  351. <a id="ae2ee59f7cc16ee42559c87e81c433039" name="ae2ee59f7cc16ee42559c87e81c433039"></a>
  352. <h2 class="memtitle"><span class="permalink"><a href="#ae2ee59f7cc16ee42559c87e81c433039">&#9670;&#160;</a></span>create()</h2>
  353. <div class="memitem">
  354. <div class="memproto">
  355. <table class="mlabels">
  356. <tr>
  357. <td class="mlabels-left">
  358. <table class="memname">
  359. <tr>
  360. <td class="memname">void create </td>
  361. <td>(</td>
  362. <td class="paramname"></td><td>)</td>
  363. <td></td>
  364. </tr>
  365. </table>
  366. </td>
  367. <td class="mlabels-right">
  368. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  369. </tr>
  370. </table>
  371. </div><div class="memdoc">
  372. </div>
  373. </div>
  374. <a id="a3a80b6032f86a56bec74609034b3246f" name="a3a80b6032f86a56bec74609034b3246f"></a>
  375. <h2 class="memtitle"><span class="permalink"><a href="#a3a80b6032f86a56bec74609034b3246f">&#9670;&#160;</a></span>destroy()</h2>
  376. <div class="memitem">
  377. <div class="memproto">
  378. <table class="mlabels">
  379. <tr>
  380. <td class="mlabels-left">
  381. <table class="memname">
  382. <tr>
  383. <td class="memname">void destroy </td>
  384. <td>(</td>
  385. <td class="paramname"></td><td>)</td>
  386. <td></td>
  387. </tr>
  388. </table>
  389. </td>
  390. <td class="mlabels-right">
  391. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  392. </tr>
  393. </table>
  394. </div><div class="memdoc">
  395. </div>
  396. </div>
  397. <a id="af6b44612d77a4820347d4c93a2d53588" name="af6b44612d77a4820347d4c93a2d53588"></a>
  398. <h2 class="memtitle"><span class="permalink"><a href="#af6b44612d77a4820347d4c93a2d53588">&#9670;&#160;</a></span>dumpResources()</h2>
  399. <div class="memitem">
  400. <div class="memproto">
  401. <table class="memname">
  402. <tr>
  403. <td class="memname">void dumpResources </td>
  404. <td>(</td>
  405. <td class="paramtype">const bool&#160;</td>
  406. <td class="paramname"><em>onlyLoaded</em> = <code>true</code></td><td>)</td>
  407. <td></td>
  408. </tr>
  409. </table>
  410. </div><div class="memdoc">
  411. <p>Dumps all loaded resources to the console. </p>
  412. </div>
  413. </div>
  414. <a id="a93ff71e394db0ce3f058396d7c39bc61" name="a93ff71e394db0ce3f058396d7c39bc61"></a>
  415. <h2 class="memtitle"><span class="permalink"><a href="#a93ff71e394db0ce3f058396d7c39bc61">&#9670;&#160;</a></span>find() <span class="overload">[1/2]</span></h2>
  416. <div class="memitem">
  417. <div class="memproto">
  418. <table class="memname">
  419. <tr>
  420. <td class="memname"><a class="el" href="class_resource_object.html">ResourceObject</a> * find </td>
  421. <td>(</td>
  422. <td class="paramtype">const char *&#160;</td>
  423. <td class="paramname"><em>fileName</em></td><td>)</td>
  424. <td></td>
  425. </tr>
  426. </table>
  427. </div><div class="memdoc">
  428. <p>Searches the hash list for the filename and returns it's object if found, otherwise NULL. </p>
  429. </div>
  430. </div>
  431. <a id="a64c05085ec0f365dfb02bf2f643a9ebd" name="a64c05085ec0f365dfb02bf2f643a9ebd"></a>
  432. <h2 class="memtitle"><span class="permalink"><a href="#a64c05085ec0f365dfb02bf2f643a9ebd">&#9670;&#160;</a></span>find() <span class="overload">[2/2]</span></h2>
  433. <div class="memitem">
  434. <div class="memproto">
  435. <table class="memname">
  436. <tr>
  437. <td class="memname"><a class="el" href="class_resource_object.html">ResourceObject</a> * find </td>
  438. <td>(</td>
  439. <td class="paramtype">const char *&#160;</td>
  440. <td class="paramname"><em>fileName</em>, </td>
  441. </tr>
  442. <tr>
  443. <td class="paramkey"></td>
  444. <td></td>
  445. <td class="paramtype">U32&#160;</td>
  446. <td class="paramname"><em>flags</em>&#160;</td>
  447. </tr>
  448. <tr>
  449. <td></td>
  450. <td>)</td>
  451. <td></td><td></td>
  452. </tr>
  453. </table>
  454. </div><div class="memdoc">
  455. <p>Searches the hash list for the filename and returns it's object if found, otherwise NULL. </p>
  456. </div>
  457. </div>
  458. <a id="af81e4d818b12b0f3df331d05ad06662c" name="af81e4d818b12b0f3df331d05ad06662c"></a>
  459. <h2 class="memtitle"><span class="permalink"><a href="#af81e4d818b12b0f3df331d05ad06662c">&#9670;&#160;</a></span>findFile()</h2>
  460. <div class="memitem">
  461. <div class="memproto">
  462. <table class="memname">
  463. <tr>
  464. <td class="memname">bool findFile </td>
  465. <td>(</td>
  466. <td class="paramtype">const char *&#160;</td>
  467. <td class="paramname"><em>name</em></td><td>)</td>
  468. <td></td>
  469. </tr>
  470. </table>
  471. </div><div class="memdoc">
  472. <p>Checks to see if a file exists. </p>
  473. </div>
  474. </div>
  475. <a id="a900cfe63e864fffb5f60fa1fb61f9027" name="a900cfe63e864fffb5f60fa1fb61f9027"></a>
  476. <h2 class="memtitle"><span class="permalink"><a href="#a900cfe63e864fffb5f60fa1fb61f9027">&#9670;&#160;</a></span>findMatch()</h2>
  477. <div class="memitem">
  478. <div class="memproto">
  479. <table class="memname">
  480. <tr>
  481. <td class="memname"><a class="el" href="class_resource_object.html">ResourceObject</a> * findMatch </td>
  482. <td>(</td>
  483. <td class="paramtype">const char *&#160;</td>
  484. <td class="paramname"><em>expression</em>, </td>
  485. </tr>
  486. <tr>
  487. <td class="paramkey"></td>
  488. <td></td>
  489. <td class="paramtype">const char **&#160;</td>
  490. <td class="paramname"><em>fn</em>, </td>
  491. </tr>
  492. <tr>
  493. <td class="paramkey"></td>
  494. <td></td>
  495. <td class="paramtype"><a class="el" href="class_resource_object.html">ResourceObject</a> *&#160;</td>
  496. <td class="paramname"><em>start</em> = <code>NULL</code>&#160;</td>
  497. </tr>
  498. <tr>
  499. <td></td>
  500. <td>)</td>
  501. <td></td><td></td>
  502. </tr>
  503. </table>
  504. </div><div class="memdoc">
  505. <p>Finds a resource object with given expression. </p>
  506. </div>
  507. </div>
  508. <a id="af412e2bdb2e2c3f19516dab5340c70c3" name="af412e2bdb2e2c3f19516dab5340c70c3"></a>
  509. <h2 class="memtitle"><span class="permalink"><a href="#af412e2bdb2e2c3f19516dab5340c70c3">&#9670;&#160;</a></span>findMatches()</h2>
  510. <div class="memitem">
  511. <div class="memproto">
  512. <table class="memname">
  513. <tr>
  514. <td class="memname">S32 findMatches </td>
  515. <td>(</td>
  516. <td class="paramtype"><a class="el" href="class_find_match.html">FindMatch</a> *&#160;</td>
  517. <td class="paramname"><em>pFM</em></td><td>)</td>
  518. <td></td>
  519. </tr>
  520. </table>
  521. </div><div class="memdoc">
  522. <p>Finds multiple matches to an expression. </p>
  523. </div>
  524. </div>
  525. <a id="a9708bd7f94e08ad390ea8f5403d89a7a" name="a9708bd7f94e08ad390ea8f5403d89a7a"></a>
  526. <h2 class="memtitle"><span class="permalink"><a href="#a9708bd7f94e08ad390ea8f5403d89a7a">&#9670;&#160;</a></span>findMatchMultiExprs()</h2>
  527. <div class="memitem">
  528. <div class="memproto">
  529. <table class="memname">
  530. <tr>
  531. <td class="memname"><a class="el" href="class_resource_object.html">ResourceObject</a> * findMatchMultiExprs </td>
  532. <td>(</td>
  533. <td class="paramtype">const char *&#160;</td>
  534. <td class="paramname"><em>multiExpression</em>, </td>
  535. </tr>
  536. <tr>
  537. <td class="paramkey"></td>
  538. <td></td>
  539. <td class="paramtype">const char **&#160;</td>
  540. <td class="paramname"><em>fn</em>, </td>
  541. </tr>
  542. <tr>
  543. <td class="paramkey"></td>
  544. <td></td>
  545. <td class="paramtype"><a class="el" href="class_resource_object.html">ResourceObject</a> *&#160;</td>
  546. <td class="paramname"><em>start</em> = <code>NULL</code>&#160;</td>
  547. </tr>
  548. <tr>
  549. <td></td>
  550. <td>)</td>
  551. <td></td><td></td>
  552. </tr>
  553. </table>
  554. </div><div class="memdoc">
  555. <p>Finds a resource object with given expressions, seperated by " ". </p>
  556. </div>
  557. </div>
  558. <a id="ae1dd5cdfdd0c6aed8fce0e7b4b57654b" name="ae1dd5cdfdd0c6aed8fce0e7b4b57654b"></a>
  559. <h2 class="memtitle"><span class="permalink"><a href="#ae1dd5cdfdd0c6aed8fce0e7b4b57654b">&#9670;&#160;</a></span>freeResource()</h2>
  560. <div class="memitem">
  561. <div class="memproto">
  562. <table class="memname">
  563. <tr>
  564. <td class="memname">void freeResource </td>
  565. <td>(</td>
  566. <td class="paramtype"><a class="el" href="class_resource_object.html">ResourceObject</a> *&#160;</td>
  567. <td class="paramname"><em>resObject</em></td><td>)</td>
  568. <td></td>
  569. </tr>
  570. </table>
  571. </div><div class="memdoc">
  572. <p>Frees a resource! </p>
  573. </div>
  574. </div>
  575. <a id="a5f20f448e965709d7a972aad65fb556f" name="a5f20f448e965709d7a972aad65fb556f"></a>
  576. <h2 class="memtitle"><span class="permalink"><a href="#a5f20f448e965709d7a972aad65fb556f">&#9670;&#160;</a></span>getBasePath()</h2>
  577. <div class="memitem">
  578. <div class="memproto">
  579. <table class="memname">
  580. <tr>
  581. <td class="memname">const char * getBasePath </td>
  582. <td>(</td>
  583. <td class="paramname"></td><td>)</td>
  584. <td></td>
  585. </tr>
  586. </table>
  587. </div><div class="memdoc">
  588. <p>Gets the base path. </p>
  589. </div>
  590. </div>
  591. <a id="aca38866ce8062de2a75e02140cb4c399" name="aca38866ce8062de2a75e02140cb4c399"></a>
  592. <h2 class="memtitle"><span class="permalink"><a href="#aca38866ce8062de2a75e02140cb4c399">&#9670;&#160;</a></span>getCrc()</h2>
  593. <div class="memitem">
  594. <div class="memproto">
  595. <table class="memname">
  596. <tr>
  597. <td class="memname">bool getCrc </td>
  598. <td>(</td>
  599. <td class="paramtype">const char *&#160;</td>
  600. <td class="paramname"><em>fileName</em>, </td>
  601. </tr>
  602. <tr>
  603. <td class="paramkey"></td>
  604. <td></td>
  605. <td class="paramtype">U32 &amp;&#160;</td>
  606. <td class="paramname"><em>crcVal</em>, </td>
  607. </tr>
  608. <tr>
  609. <td class="paramkey"></td>
  610. <td></td>
  611. <td class="paramtype">const U32&#160;</td>
  612. <td class="paramname"><em>crcInitialVal</em> = <code>INITIAL_CRC_VALUE</code>&#160;</td>
  613. </tr>
  614. <tr>
  615. <td></td>
  616. <td>)</td>
  617. <td></td><td></td>
  618. </tr>
  619. </table>
  620. </div><div class="memdoc">
  621. <p>Computes the CRC of a file.</p>
  622. <p>By passing a different crcInitialVal, you can take the CRC of multiple files. </p>
  623. </div>
  624. </div>
  625. <a id="a4a5d086cb79babfc31314dccf11e9924" name="a4a5d086cb79babfc31314dccf11e9924"></a>
  626. <h2 class="memtitle"><span class="permalink"><a href="#a4a5d086cb79babfc31314dccf11e9924">&#9670;&#160;</a></span>getCreateFunction()</h2>
  627. <div class="memitem">
  628. <div class="memproto">
  629. <table class="memname">
  630. <tr>
  631. <td class="memname">RESOURCE_CREATE_FN getCreateFunction </td>
  632. <td>(</td>
  633. <td class="paramtype">const char *&#160;</td>
  634. <td class="paramname"><em>name</em></td><td>)</td>
  635. <td></td>
  636. </tr>
  637. </table>
  638. </div><div class="memdoc">
  639. </div>
  640. </div>
  641. <a id="ac127e3c18b370acf31b4bc9dea2951a1" name="ac127e3c18b370acf31b4bc9dea2951a1"></a>
  642. <h2 class="memtitle"><span class="permalink"><a href="#ac127e3c18b370acf31b4bc9dea2951a1">&#9670;&#160;</a></span>getFullPath()</h2>
  643. <div class="memitem">
  644. <div class="memproto">
  645. <table class="memname">
  646. <tr>
  647. <td class="memname">const char * getFullPath </td>
  648. <td>(</td>
  649. <td class="paramtype">const char *&#160;</td>
  650. <td class="paramname"><em>filename</em>, </td>
  651. </tr>
  652. <tr>
  653. <td class="paramkey"></td>
  654. <td></td>
  655. <td class="paramtype">char *&#160;</td>
  656. <td class="paramname"><em>path</em>, </td>
  657. </tr>
  658. <tr>
  659. <td class="paramkey"></td>
  660. <td></td>
  661. <td class="paramtype">U32&#160;</td>
  662. <td class="paramname"><em>pathLen</em>&#160;</td>
  663. </tr>
  664. <tr>
  665. <td></td>
  666. <td>)</td>
  667. <td></td><td></td>
  668. </tr>
  669. </table>
  670. </div><div class="memdoc">
  671. <p>Gets the full path of the file. </p>
  672. </div>
  673. </div>
  674. <a id="a690104ab8617fcbe0a083f9c183ac524" name="a690104ab8617fcbe0a083f9c183ac524"></a>
  675. <h2 class="memtitle"><span class="permalink"><a href="#a690104ab8617fcbe0a083f9c183ac524">&#9670;&#160;</a></span>getMissingFileList()</h2>
  676. <div class="memitem">
  677. <div class="memproto">
  678. <table class="memname">
  679. <tr>
  680. <td class="memname">bool getMissingFileList </td>
  681. <td>(</td>
  682. <td class="paramtype"><a class="el" href="class_vector.html">Vector</a>&lt; char * &gt; &amp;&#160;</td>
  683. <td class="paramname"><em>list</em></td><td>)</td>
  684. <td></td>
  685. </tr>
  686. </table>
  687. </div><div class="memdoc">
  688. <p>Gets which files are missing. </p>
  689. </div>
  690. </div>
  691. <a id="ae28d77efb22c87453dfbb6cd506a7805" name="ae28d77efb22c87453dfbb6cd506a7805"></a>
  692. <h2 class="memtitle"><span class="permalink"><a href="#ae28d77efb22c87453dfbb6cd506a7805">&#9670;&#160;</a></span>getModPathOf()</h2>
  693. <div class="memitem">
  694. <div class="memproto">
  695. <table class="memname">
  696. <tr>
  697. <td class="memname">const char * getModPathOf </td>
  698. <td>(</td>
  699. <td class="paramtype">const char *&#160;</td>
  700. <td class="paramname"><em>fileName</em></td><td>)</td>
  701. <td></td>
  702. </tr>
  703. </table>
  704. </div><div class="memdoc">
  705. <p>Gets the path of the file local to the mod. </p>
  706. </div>
  707. </div>
  708. <a id="a50b85edadf4775b261e1fd418e97c2a7" name="a50b85edadf4775b261e1fd418e97c2a7"></a>
  709. <h2 class="memtitle"><span class="permalink"><a href="#a50b85edadf4775b261e1fd418e97c2a7">&#9670;&#160;</a></span>getModPaths()</h2>
  710. <div class="memitem">
  711. <div class="memproto">
  712. <table class="memname">
  713. <tr>
  714. <td class="memname">const char * getModPaths </td>
  715. <td>(</td>
  716. <td class="paramname"></td><td>)</td>
  717. <td></td>
  718. </tr>
  719. </table>
  720. </div><div class="memdoc">
  721. <p>Gets the path for the current game mod. </p>
  722. </div>
  723. </div>
  724. <a id="a46ec5091237d4f4f1b5f208225a91e86" name="a46ec5091237d4f4f1b5f208225a91e86"></a>
  725. <h2 class="memtitle"><span class="permalink"><a href="#a46ec5091237d4f4f1b5f208225a91e86">&#9670;&#160;</a></span>getPathOf()</h2>
  726. <div class="memitem">
  727. <div class="memproto">
  728. <table class="memname">
  729. <tr>
  730. <td class="memname">const char * getPathOf </td>
  731. <td>(</td>
  732. <td class="paramtype">const char *&#160;</td>
  733. <td class="paramname"><em>filename</em></td><td>)</td>
  734. <td></td>
  735. </tr>
  736. </table>
  737. </div><div class="memdoc">
  738. <p>Gets the path of the file from the base directory. </p>
  739. </div>
  740. </div>
  741. <a id="a390a79c065d86c2991531f312504ba36" name="a390a79c065d86c2991531f312504ba36"></a>
  742. <h2 class="memtitle"><span class="permalink"><a href="#a390a79c065d86c2991531f312504ba36">&#9670;&#160;</a></span>getSize()</h2>
  743. <div class="memitem">
  744. <div class="memproto">
  745. <table class="memname">
  746. <tr>
  747. <td class="memname">S32 getSize </td>
  748. <td>(</td>
  749. <td class="paramtype">const char *&#160;</td>
  750. <td class="paramname"><em>filename</em></td><td>)</td>
  751. <td></td>
  752. </tr>
  753. </table>
  754. </div><div class="memdoc">
  755. <p>Gets the size of the file. </p>
  756. </div>
  757. </div>
  758. <a id="abae60ec1deabfad0080e0e7f7b87999b" name="abae60ec1deabfad0080e0e7f7b87999b"></a>
  759. <h2 class="memtitle"><span class="permalink"><a href="#abae60ec1deabfad0080e0e7f7b87999b">&#9670;&#160;</a></span>initExcludedDirectories()</h2>
  760. <div class="memitem">
  761. <div class="memproto">
  762. <table class="mlabels">
  763. <tr>
  764. <td class="mlabels-left">
  765. <table class="memname">
  766. <tr>
  767. <td class="memname">void initExcludedDirectories </td>
  768. <td>(</td>
  769. <td class="paramname"></td><td>)</td>
  770. <td></td>
  771. </tr>
  772. </table>
  773. </td>
  774. <td class="mlabels-right">
  775. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  776. </tr>
  777. </table>
  778. </div><div class="memdoc">
  779. <p>Load the excluded directories from the resource manager pref and stuff it into the platform layer. </p>
  780. </div>
  781. </div>
  782. <a id="ae1e05ddbd00addd63790d2fca9e35112" name="ae1e05ddbd00addd63790d2fca9e35112"></a>
  783. <h2 class="memtitle"><span class="permalink"><a href="#ae1e05ddbd00addd63790d2fca9e35112">&#9670;&#160;</a></span>isUsingVFS()</h2>
  784. <div class="memitem">
  785. <div class="memproto">
  786. <table class="mlabels">
  787. <tr>
  788. <td class="mlabels-left">
  789. <table class="memname">
  790. <tr>
  791. <td class="memname">bool isUsingVFS </td>
  792. <td>(</td>
  793. <td class="paramname"></td><td>)</td>
  794. <td></td>
  795. </tr>
  796. </table>
  797. </td>
  798. <td class="mlabels-right">
  799. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  800. </tr>
  801. </table>
  802. </div><div class="memdoc">
  803. </div>
  804. </div>
  805. <a id="aee291d985ac1f8a08753ac6bb8794522" name="aee291d985ac1f8a08753ac6bb8794522"></a>
  806. <h2 class="memtitle"><span class="permalink"><a href="#aee291d985ac1f8a08753ac6bb8794522">&#9670;&#160;</a></span>isValidWriteFileName()</h2>
  807. <div class="memitem">
  808. <div class="memproto">
  809. <table class="memname">
  810. <tr>
  811. <td class="memname">bool isValidWriteFileName </td>
  812. <td>(</td>
  813. <td class="paramtype">const char *&#160;</td>
  814. <td class="paramname"><em>fn</em></td><td>)</td>
  815. <td></td>
  816. </tr>
  817. </table>
  818. </div><div class="memdoc">
  819. <p>Checks to see if the given path is valid for writing. </p>
  820. </div>
  821. </div>
  822. <a id="a4080a45dae0e383c73df4ec7283f0bf1" name="a4080a45dae0e383c73df4ec7283f0bf1"></a>
  823. <h2 class="memtitle"><span class="permalink"><a href="#a4080a45dae0e383c73df4ec7283f0bf1">&#9670;&#160;</a></span>load()</h2>
  824. <div class="memitem">
  825. <div class="memproto">
  826. <table class="memname">
  827. <tr>
  828. <td class="memname"><a class="el" href="class_resource_object.html">ResourceObject</a> * load </td>
  829. <td>(</td>
  830. <td class="paramtype">const char *&#160;</td>
  831. <td class="paramname"><em>fileName</em>, </td>
  832. </tr>
  833. <tr>
  834. <td class="paramkey"></td>
  835. <td></td>
  836. <td class="paramtype">bool&#160;</td>
  837. <td class="paramname"><em>computeCRC</em> = <code>false</code>&#160;</td>
  838. </tr>
  839. <tr>
  840. <td></td>
  841. <td>)</td>
  842. <td></td><td></td>
  843. </tr>
  844. </table>
  845. </div><div class="memdoc">
  846. <p>loads an instance of an object </p>
  847. </div>
  848. </div>
  849. <a id="a9dc3b86678a0363daa6a76fa7c60798a" name="a9dc3b86678a0363daa6a76fa7c60798a"></a>
  850. <h2 class="memtitle"><span class="permalink"><a href="#a9dc3b86678a0363daa6a76fa7c60798a">&#9670;&#160;</a></span>loadInstance() <span class="overload">[1/2]</span></h2>
  851. <div class="memitem">
  852. <div class="memproto">
  853. <table class="memname">
  854. <tr>
  855. <td class="memname"><a class="el" href="class_resource_instance.html">ResourceInstance</a> * loadInstance </td>
  856. <td>(</td>
  857. <td class="paramtype">const char *&#160;</td>
  858. <td class="paramname"><em>fileName</em>, </td>
  859. </tr>
  860. <tr>
  861. <td class="paramkey"></td>
  862. <td></td>
  863. <td class="paramtype">bool&#160;</td>
  864. <td class="paramname"><em>computeCRC</em> = <code>false</code>&#160;</td>
  865. </tr>
  866. <tr>
  867. <td></td>
  868. <td>)</td>
  869. <td></td><td></td>
  870. </tr>
  871. </table>
  872. </div><div class="memdoc">
  873. <p>Loads a new instance of an object by means of a filename. </p>
  874. </div>
  875. </div>
  876. <a id="aaa22ccbb37f4f6d135181a95d3347aa3" name="aaa22ccbb37f4f6d135181a95d3347aa3"></a>
  877. <h2 class="memtitle"><span class="permalink"><a href="#aaa22ccbb37f4f6d135181a95d3347aa3">&#9670;&#160;</a></span>loadInstance() <span class="overload">[2/2]</span></h2>
  878. <div class="memitem">
  879. <div class="memproto">
  880. <table class="memname">
  881. <tr>
  882. <td class="memname"><a class="el" href="class_resource_instance.html">ResourceInstance</a> * loadInstance </td>
  883. <td>(</td>
  884. <td class="paramtype"><a class="el" href="class_resource_object.html">ResourceObject</a> *&#160;</td>
  885. <td class="paramname"><em>object</em>, </td>
  886. </tr>
  887. <tr>
  888. <td class="paramkey"></td>
  889. <td></td>
  890. <td class="paramtype">bool&#160;</td>
  891. <td class="paramname"><em>computeCRC</em> = <code>false</code>&#160;</td>
  892. </tr>
  893. <tr>
  894. <td></td>
  895. <td>)</td>
  896. <td></td><td></td>
  897. </tr>
  898. </table>
  899. </div><div class="memdoc">
  900. <p>Loads a new instance of an object by means of a resource object. </p>
  901. </div>
  902. </div>
  903. <a id="a319b56473244f280f1aa19715c7dc735" name="a319b56473244f280f1aa19715c7dc735"></a>
  904. <h2 class="memtitle"><span class="permalink"><a href="#a319b56473244f280f1aa19715c7dc735">&#9670;&#160;</a></span>openFileForWrite()</h2>
  905. <div class="memitem">
  906. <div class="memproto">
  907. <table class="memname">
  908. <tr>
  909. <td class="memname">bool openFileForWrite </td>
  910. <td>(</td>
  911. <td class="paramtype"><a class="el" href="class_file_stream.html">FileStream</a> &amp;&#160;</td>
  912. <td class="paramname"><em>fs</em>, </td>
  913. </tr>
  914. <tr>
  915. <td class="paramkey"></td>
  916. <td></td>
  917. <td class="paramtype">const char *&#160;</td>
  918. <td class="paramname"><em>fileName</em>, </td>
  919. </tr>
  920. <tr>
  921. <td class="paramkey"></td>
  922. <td></td>
  923. <td class="paramtype">U32&#160;</td>
  924. <td class="paramname"><em>accessMode</em> = <code><a class="el" href="class_file.html#ab22d35ed086a478dd91e93ac78037f40aa56670174817e3fed92bfd8182d7c0d1">File::Write</a></code>&#160;</td>
  925. </tr>
  926. <tr>
  927. <td></td>
  928. <td>)</td>
  929. <td></td><td></td>
  930. </tr>
  931. </table>
  932. </div><div class="memdoc">
  933. <p>Opens a file for writing! </p>
  934. </div>
  935. </div>
  936. <a id="a204a91f8dded120cd11cb2014778965b" name="a204a91f8dded120cd11cb2014778965b"></a>
  937. <h2 class="memtitle"><span class="permalink"><a href="#a204a91f8dded120cd11cb2014778965b">&#9670;&#160;</a></span>openStream() <span class="overload">[1/2]</span></h2>
  938. <div class="memitem">
  939. <div class="memproto">
  940. <table class="memname">
  941. <tr>
  942. <td class="memname"><a class="el" href="class_stream.html">Stream</a> * openStream </td>
  943. <td>(</td>
  944. <td class="paramtype">const char *&#160;</td>
  945. <td class="paramname"><em>fileName</em></td><td>)</td>
  946. <td></td>
  947. </tr>
  948. </table>
  949. </div><div class="memdoc">
  950. <p>Opens a stream for an object. </p>
  951. </div>
  952. </div>
  953. <a id="a06309af7a58d67eec4013313ded568d2" name="a06309af7a58d67eec4013313ded568d2"></a>
  954. <h2 class="memtitle"><span class="permalink"><a href="#a06309af7a58d67eec4013313ded568d2">&#9670;&#160;</a></span>openStream() <span class="overload">[2/2]</span></h2>
  955. <div class="memitem">
  956. <div class="memproto">
  957. <table class="memname">
  958. <tr>
  959. <td class="memname"><a class="el" href="class_stream.html">Stream</a> * openStream </td>
  960. <td>(</td>
  961. <td class="paramtype"><a class="el" href="class_resource_object.html">ResourceObject</a> *&#160;</td>
  962. <td class="paramname"><em>object</em></td><td>)</td>
  963. <td></td>
  964. </tr>
  965. </table>
  966. </div><div class="memdoc">
  967. <p>Opens a stream for an object. </p>
  968. </div>
  969. </div>
  970. <a id="a7cacf22c33094f6fe66818f2e939c291" name="a7cacf22c33094f6fe66818f2e939c291"></a>
  971. <h2 class="memtitle"><span class="permalink"><a href="#a7cacf22c33094f6fe66818f2e939c291">&#9670;&#160;</a></span>purge() <span class="overload">[1/2]</span></h2>
  972. <div class="memitem">
  973. <div class="memproto">
  974. <table class="memname">
  975. <tr>
  976. <td class="memname">void purge </td>
  977. <td>(</td>
  978. <td class="paramname"></td><td>)</td>
  979. <td></td>
  980. </tr>
  981. </table>
  982. </div><div class="memdoc">
  983. <p>Goes through the timeoutList and deletes it all. BURN!!! </p>
  984. </div>
  985. </div>
  986. <a id="ac66c94d38f71707840b4843f60c95514" name="ac66c94d38f71707840b4843f60c95514"></a>
  987. <h2 class="memtitle"><span class="permalink"><a href="#ac66c94d38f71707840b4843f60c95514">&#9670;&#160;</a></span>purge() <span class="overload">[2/2]</span></h2>
  988. <div class="memitem">
  989. <div class="memproto">
  990. <table class="memname">
  991. <tr>
  992. <td class="memname">void purge </td>
  993. <td>(</td>
  994. <td class="paramtype"><a class="el" href="class_resource_object.html">ResourceObject</a> *&#160;</td>
  995. <td class="paramname"><em>obj</em></td><td>)</td>
  996. <td></td>
  997. </tr>
  998. </table>
  999. </div><div class="memdoc">
  1000. <p>Deletes one resource object. </p>
  1001. </div>
  1002. </div>
  1003. <a id="a0036ffad373b2d87df5abf674cb4cda1" name="a0036ffad373b2d87df5abf674cb4cda1"></a>
  1004. <h2 class="memtitle"><span class="permalink"><a href="#a0036ffad373b2d87df5abf674cb4cda1">&#9670;&#160;</a></span>registerExtension()</h2>
  1005. <div class="memitem">
  1006. <div class="memproto">
  1007. <table class="memname">
  1008. <tr>
  1009. <td class="memname">void registerExtension </td>
  1010. <td>(</td>
  1011. <td class="paramtype">const char *&#160;</td>
  1012. <td class="paramname"><em>extension</em>, </td>
  1013. </tr>
  1014. <tr>
  1015. <td class="paramkey"></td>
  1016. <td></td>
  1017. <td class="paramtype">RESOURCE_CREATE_FN&#160;</td>
  1018. <td class="paramname"><em>create_fn</em>&#160;</td>
  1019. </tr>
  1020. <tr>
  1021. <td></td>
  1022. <td>)</td>
  1023. <td></td><td></td>
  1024. </tr>
  1025. </table>
  1026. </div><div class="memdoc">
  1027. <p>Tells the resource manager what to do with a resource that it loads. </p>
  1028. </div>
  1029. </div>
  1030. <a id="a9676796780b94b46809af809d83b1107" name="a9676796780b94b46809af809d83b1107"></a>
  1031. <h2 class="memtitle"><span class="permalink"><a href="#a9676796780b94b46809af809d83b1107">&#9670;&#160;</a></span>removePath()</h2>
  1032. <div class="memitem">
  1033. <div class="memproto">
  1034. <table class="memname">
  1035. <tr>
  1036. <td class="memname">void removePath </td>
  1037. <td>(</td>
  1038. <td class="paramtype">const char *&#160;</td>
  1039. <td class="paramname"><em>path</em></td><td>)</td>
  1040. <td></td>
  1041. </tr>
  1042. </table>
  1043. </div><div class="memdoc">
  1044. <p>Remove a path. Only removes resources that are not loaded. </p>
  1045. </div>
  1046. </div>
  1047. <a id="a6450aab646022538d469983e8106fcfe" name="a6450aab646022538d469983e8106fcfe"></a>
  1048. <h2 class="memtitle"><span class="permalink"><a href="#a6450aab646022538d469983e8106fcfe">&#9670;&#160;</a></span>serialize()</h2>
  1049. <div class="memitem">
  1050. <div class="memproto">
  1051. <table class="memname">
  1052. <tr>
  1053. <td class="memname">void serialize </td>
  1054. <td>(</td>
  1055. <td class="paramtype"><a class="el" href="class_vector_ptr.html">VectorPtr</a>&lt; const char * &gt; &amp;&#160;</td>
  1056. <td class="paramname"><em>filenames</em></td><td>)</td>
  1057. <td></td>
  1058. </tr>
  1059. </table>
  1060. </div><div class="memdoc">
  1061. <p>Sorts the resource objects. </p>
  1062. </div>
  1063. </div>
  1064. <a id="ae68c1cad604c655bd6bda74301192f0f" name="ae68c1cad604c655bd6bda74301192f0f"></a>
  1065. <h2 class="memtitle"><span class="permalink"><a href="#ae68c1cad604c655bd6bda74301192f0f">&#9670;&#160;</a></span>setFileNameEcho()</h2>
  1066. <div class="memitem">
  1067. <div class="memproto">
  1068. <table class="memname">
  1069. <tr>
  1070. <td class="memname">void setFileNameEcho </td>
  1071. <td>(</td>
  1072. <td class="paramtype">bool&#160;</td>
  1073. <td class="paramname"><em>on</em></td><td>)</td>
  1074. <td></td>
  1075. </tr>
  1076. </table>
  1077. </div><div class="memdoc">
  1078. <p>Sets whether or not to echo filenames that have been accessed by means of openStream. </p>
  1079. </div>
  1080. </div>
  1081. <a id="ab014294b9e7470365bde5d9321a9a69f" name="ab014294b9e7470365bde5d9321a9a69f"></a>
  1082. <h2 class="memtitle"><span class="permalink"><a href="#ab014294b9e7470365bde5d9321a9a69f">&#9670;&#160;</a></span>setMissingFileLogging()</h2>
  1083. <div class="memitem">
  1084. <div class="memproto">
  1085. <table class="memname">
  1086. <tr>
  1087. <td class="memname">void setMissingFileLogging </td>
  1088. <td>(</td>
  1089. <td class="paramtype">bool&#160;</td>
  1090. <td class="paramname"><em>log</em></td><td>)</td>
  1091. <td></td>
  1092. </tr>
  1093. </table>
  1094. </div><div class="memdoc">
  1095. <p>Should we log missing files? </p>
  1096. </div>
  1097. </div>
  1098. <a id="a6dd8a00088408806ba412b3e2f71ee02" name="a6dd8a00088408806ba412b3e2f71ee02"></a>
  1099. <h2 class="memtitle"><span class="permalink"><a href="#a6dd8a00088408806ba412b3e2f71ee02">&#9670;&#160;</a></span>setModPaths()</h2>
  1100. <div class="memitem">
  1101. <div class="memproto">
  1102. <table class="memname">
  1103. <tr>
  1104. <td class="memname">void setModPaths </td>
  1105. <td>(</td>
  1106. <td class="paramtype">U32&#160;</td>
  1107. <td class="paramname"><em>numPaths</em>, </td>
  1108. </tr>
  1109. <tr>
  1110. <td class="paramkey"></td>
  1111. <td></td>
  1112. <td class="paramtype">const char **&#160;</td>
  1113. <td class="paramname"><em>dirs</em>&#160;</td>
  1114. </tr>
  1115. <tr>
  1116. <td></td>
  1117. <td>)</td>
  1118. <td></td><td></td>
  1119. </tr>
  1120. </table>
  1121. </div><div class="memdoc">
  1122. <p>Sets the path for the current game mod. </p>
  1123. </div>
  1124. </div>
  1125. <a id="a4d273b28da1ac885e6e2bd94cdd4080d" name="a4d273b28da1ac885e6e2bd94cdd4080d"></a>
  1126. <h2 class="memtitle"><span class="permalink"><a href="#a4d273b28da1ac885e6e2bd94cdd4080d">&#9670;&#160;</a></span>setWriteablePath()</h2>
  1127. <div class="memitem">
  1128. <div class="memproto">
  1129. <table class="memname">
  1130. <tr>
  1131. <td class="memname">void setWriteablePath </td>
  1132. <td>(</td>
  1133. <td class="paramtype">const char *&#160;</td>
  1134. <td class="paramname"><em>path</em></td><td>)</td>
  1135. <td></td>
  1136. </tr>
  1137. </table>
  1138. </div><div class="memdoc">
  1139. <p>Sets the writable path for a file to the one given. </p>
  1140. </div>
  1141. </div>
  1142. <a id="adf0e315d8a675bab8abb666cf6d5f4dc" name="adf0e315d8a675bab8abb666cf6d5f4dc"></a>
  1143. <h2 class="memtitle"><span class="permalink"><a href="#adf0e315d8a675bab8abb666cf6d5f4dc">&#9670;&#160;</a></span>unlock()</h2>
  1144. <div class="memitem">
  1145. <div class="memproto">
  1146. <table class="memname">
  1147. <tr>
  1148. <td class="memname">void unlock </td>
  1149. <td>(</td>
  1150. <td class="paramtype"><a class="el" href="class_resource_object.html">ResourceObject</a> *&#160;</td>
  1151. <td class="paramname"><em>obj</em></td><td>)</td>
  1152. <td></td>
  1153. </tr>
  1154. </table>
  1155. </div><div class="memdoc">
  1156. <p>Decrements the lock count of an object. If the lock count is zero post-decrement, the object is added to the timeoutList for deletion upon call of flush. </p>
  1157. </div>
  1158. </div>
  1159. <hr/>The documentation for this class was generated from the following files:<ul>
  1160. <li>io/resource/<b>resourceManager.h</b></li>
  1161. <li>io/resource/<b>resourceManager.cc</b></li>
  1162. </ul>
  1163. </div><!-- contents -->
  1164. <!-- start footer part -->
  1165. <hr class="footer"/><address class="footer"><small>
  1166. 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
  1167. </small></address>
  1168. </body>
  1169. </html>