| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346 |
- <!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>Torque2D Reference: ResDictionary Class Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.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">Torque2D Reference
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.9.8 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- var searchBox = new SearchBox("searchBox", "search/",'.html');
- /* @license-end */
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- /* @license-end */
- </script>
- <div id="main-nav"></div>
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <div id="MSearchResults">
- <div class="SRPage">
- <div id="SRIndex">
- <div id="SRResults"></div>
- <div class="SRStatus" id="Loading">Loading...</div>
- <div class="SRStatus" id="Searching">Searching...</div>
- <div class="SRStatus" id="NoMatches">No Matches</div>
- </div>
- </div>
- </div>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="class_res_dictionary-members.html">List of all members</a> </div>
- <div class="headertitle"><div class="title">ResDictionary Class Reference</div></div>
- </div><!--header-->
- <div class="contents">
- <p><code>#include <resourceManager.h></code></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:a4a9ce8782df77d00a34fb4e4da97db2b" id="r_a4a9ce8782df77d00a34fb4e4da97db2b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_dictionary.html#a4a9ce8782df77d00a34fb4e4da97db2b">ResDictionary</a> ()</td></tr>
- <tr class="separator:a4a9ce8782df77d00a34fb4e4da97db2b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a169e9edbb00120362c70286769f13de4" id="r_a169e9edbb00120362c70286769f13de4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_dictionary.html#a169e9edbb00120362c70286769f13de4">~ResDictionary</a> ()</td></tr>
- <tr class="separator:a169e9edbb00120362c70286769f13de4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a98ee3e70b196e791db1a2e6e9e15fc7d" id="r_a98ee3e70b196e791db1a2e6e9e15fc7d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_dictionary.html#a98ee3e70b196e791db1a2e6e9e15fc7d">insert</a> (<a class="el" href="class_resource_object.html">ResourceObject</a> *obj, StringTableEntry path, StringTableEntry file)</td></tr>
- <tr class="memdesc:a98ee3e70b196e791db1a2e6e9e15fc7d"><td class="mdescLeft"> </td><td class="mdescRight">Add a <a class="el" href="class_resource_object.html">ResourceObject</a> to the dictionary. <br /></td></tr>
- <tr class="separator:a98ee3e70b196e791db1a2e6e9e15fc7d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a32bbd516b817208cf31d22bdc7372e0e" id="r_a32bbd516b817208cf31d22bdc7372e0e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_dictionary.html#a32bbd516b817208cf31d22bdc7372e0e">pushBehind</a> (<a class="el" href="class_resource_object.html">ResourceObject</a> *obj, S32 mask)</td></tr>
- <tr class="memdesc:a32bbd516b817208cf31d22bdc7372e0e"><td class="mdescLeft"> </td><td class="mdescRight">Move a previously added resource object to be in the list after everything that matches the specified mask. <br /></td></tr>
- <tr class="separator:a32bbd516b817208cf31d22bdc7372e0e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a228b89a5674d80282b863361cf4d7f5a" id="r_a228b89a5674d80282b863361cf4d7f5a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_dictionary.html#a228b89a5674d80282b863361cf4d7f5a">remove</a> (<a class="el" href="class_resource_object.html">ResourceObject</a> *obj)</td></tr>
- <tr class="memdesc:a228b89a5674d80282b863361cf4d7f5a"><td class="mdescLeft"> </td><td class="mdescRight">Remove a resource object from the dictionary. <br /></td></tr>
- <tr class="separator:a228b89a5674d80282b863361cf4d7f5a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr><td colspan="2"><div class="groupHeader">Find</div></td></tr>
- <tr><td colspan="2"><div class="groupText"><p>These functions search the hash table for an individual resource. If the resource has already been loaded, it will find the resource and return its object. If not, it will return NULL. </p>
- </div></td></tr>
- <tr class="memitem:a3c16e0a98a5da4e5001ee60a338c9647" id="r_a3c16e0a98a5da4e5001ee60a338c9647"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_resource_object.html">ResourceObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_dictionary.html#a3c16e0a98a5da4e5001ee60a338c9647">find</a> (StringTableEntry path, StringTableEntry file)</td></tr>
- <tr class="separator:a3c16e0a98a5da4e5001ee60a338c9647"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a20ee91b81acddfad07f5eb92eb4380d0" id="r_a20ee91b81acddfad07f5eb92eb4380d0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_resource_object.html">ResourceObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_dictionary.html#a20ee91b81acddfad07f5eb92eb4380d0">find</a> (StringTableEntry path, StringTableEntry file, StringTableEntry filePath, StringTableEntry fileName)</td></tr>
- <tr class="separator:a20ee91b81acddfad07f5eb92eb4380d0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab3f373eb1b055914e783d28de1c39bd5" id="r_ab3f373eb1b055914e783d28de1c39bd5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_resource_object.html">ResourceObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_res_dictionary.html#ab3f373eb1b055914e783d28de1c39bd5">find</a> (StringTableEntry path, StringTableEntry file, U32 flags)</td></tr>
- <tr class="separator:ab3f373eb1b055914e783d28de1c39bd5"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p><a class="el" href="class_resource.html">Resource</a> <a class="el" href="class_dictionary.html">Dictionary</a>.</p>
- <p>Maps of names and object IDs to objects.</p>
- <p>Provides fast lookup for name->object, id->object and for fast removal of an object given a pointer to it.</p>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="class_res_manager.html">ResManager</a> </dd></dl>
- </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a id="a4a9ce8782df77d00a34fb4e4da97db2b" name="a4a9ce8782df77d00a34fb4e4da97db2b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4a9ce8782df77d00a34fb4e4da97db2b">◆ </a></span>ResDictionary()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_res_dictionary.html">ResDictionary</a> </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a169e9edbb00120362c70286769f13de4" name="a169e9edbb00120362c70286769f13de4"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a169e9edbb00120362c70286769f13de4">◆ </a></span>~ResDictionary()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">~<a class="el" href="class_res_dictionary.html">ResDictionary</a> </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="a3c16e0a98a5da4e5001ee60a338c9647" name="a3c16e0a98a5da4e5001ee60a338c9647"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3c16e0a98a5da4e5001ee60a338c9647">◆ </a></span>find() <span class="overload">[1/3]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_resource_object.html">ResourceObject</a> * find </td>
- <td>(</td>
- <td class="paramtype">StringTableEntry </td>
- <td class="paramname"><em>path</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">StringTableEntry </td>
- <td class="paramname"><em>file</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a20ee91b81acddfad07f5eb92eb4380d0" name="a20ee91b81acddfad07f5eb92eb4380d0"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a20ee91b81acddfad07f5eb92eb4380d0">◆ </a></span>find() <span class="overload">[2/3]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_resource_object.html">ResourceObject</a> * find </td>
- <td>(</td>
- <td class="paramtype">StringTableEntry </td>
- <td class="paramname"><em>path</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">StringTableEntry </td>
- <td class="paramname"><em>file</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">StringTableEntry </td>
- <td class="paramname"><em>filePath</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">StringTableEntry </td>
- <td class="paramname"><em>fileName</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ab3f373eb1b055914e783d28de1c39bd5" name="ab3f373eb1b055914e783d28de1c39bd5"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab3f373eb1b055914e783d28de1c39bd5">◆ </a></span>find() <span class="overload">[3/3]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_resource_object.html">ResourceObject</a> * find </td>
- <td>(</td>
- <td class="paramtype">StringTableEntry </td>
- <td class="paramname"><em>path</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">StringTableEntry </td>
- <td class="paramname"><em>file</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">U32 </td>
- <td class="paramname"><em>flags</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a98ee3e70b196e791db1a2e6e9e15fc7d" name="a98ee3e70b196e791db1a2e6e9e15fc7d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a98ee3e70b196e791db1a2e6e9e15fc7d">◆ </a></span>insert()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void insert </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_resource_object.html">ResourceObject</a> * </td>
- <td class="paramname"><em>obj</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">StringTableEntry </td>
- <td class="paramname"><em>path</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">StringTableEntry </td>
- <td class="paramname"><em>file</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Add a <a class="el" href="class_resource_object.html">ResourceObject</a> to the dictionary. </p>
- </div>
- </div>
- <a id="a32bbd516b817208cf31d22bdc7372e0e" name="a32bbd516b817208cf31d22bdc7372e0e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a32bbd516b817208cf31d22bdc7372e0e">◆ </a></span>pushBehind()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void pushBehind </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_resource_object.html">ResourceObject</a> * </td>
- <td class="paramname"><em>obj</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">S32 </td>
- <td class="paramname"><em>mask</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Move a previously added resource object to be in the list after everything that matches the specified mask. </p>
- </div>
- </div>
- <a id="a228b89a5674d80282b863361cf4d7f5a" name="a228b89a5674d80282b863361cf4d7f5a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a228b89a5674d80282b863361cf4d7f5a">◆ </a></span>remove()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void remove </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_resource_object.html">ResourceObject</a> * </td>
- <td class="paramname"><em>obj</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Remove a resource object from the dictionary. </p>
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following files:<ul>
- <li>io/resource/<b>resourceManager.h</b></li>
- <li>io/resource/<b>resourceDictionary.cc</b></li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
- </small></address>
- </body>
- </html>
|