Clone of UAS2 @ https://github.com/drudgedance/uas2

classc_storage.html 10KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <title>UAS2: cStorage Class Reference</title>
  6. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  7. <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  8. </head>
  9. <body>
  10. <!-- Generated by Doxygen 1.6.2 -->
  11. <div class="navigation" id="top">
  12. <div class="tabs">
  13. <ul>
  14. <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
  15. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  16. <li><a href="files.html"><span>Files</span></a></li>
  17. </ul>
  18. </div>
  19. <div class="tabs">
  20. <ul>
  21. <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
  22. <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
  23. <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  24. </ul>
  25. </div>
  26. </div>
  27. <div class="contents">
  28. <h1>cStorage Class Reference</h1><!-- doxytag: class="cStorage" --><!-- doxytag: inherits="cObject" --><div class="dynheader">
  29. Inheritance diagram for cStorage:</div>
  30. <div class="dynsection">
  31. <div class="center">
  32. <img src="classc_storage.png" usemap="#cStorage_map" alt=""/>
  33. <map id="cStorage_map" name="cStorage_map">
  34. <area href="classc_object.html" alt="cObject" shape="rect" coords="0,0,63,24"/>
  35. </map>
  36. </div>
  37. </div>
  38. <p><a href="classc_storage-members.html">List of all members.</a></p>
  39. <table border="0" cellpadding="0" cellspacing="0">
  40. <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
  41. <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_storage.html#a4c28e915c47b76b4b911f88cc37d4366">cStorage</a> (WORD type, DWORD dwGUID, DWORD houseID, char *szName, char *szDescription, <a class="el" href="structc_location.html">cLocation</a> *pcLoc=NULL)</td></tr>
  42. <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_storage.html#a475351ecddba552296f053f292321cb0">Assess</a> (<a class="el" href="classc_client.html">cClient</a> *pcAssesser)</td></tr>
  43. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classc_message.html">cMessage</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_storage.html#ae2691f46b0c8ff7e302c4a28afd17674">CreatePacket</a> ()</td></tr>
  44. <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_storage.html#ad10555476c49f2ea764ac9b8fdbb82d9">Action</a> (<a class="el" href="classc_client.html">cClient</a> *who)</td></tr>
  45. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af38d9634c960d07a3d20f5e6bb65a493"></a><!-- doxytag: member="cStorage::SetMode" ref="af38d9634c960d07a3d20f5e6bb65a493" args="(DWORD mode)" -->
  46. void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetMode</b> (DWORD mode)</td></tr>
  47. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a705da26243f4eedd314f7ea07f38da81"></a><!-- doxytag: member="cStorage::GetMode" ref="a705da26243f4eedd314f7ea07f38da81" args="()" -->
  48. DWORD&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetMode</b> ()</td></tr>
  49. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e71eeae64789afb378a6b67a8885357"></a><!-- doxytag: member="cStorage::SetGUID" ref="a4e71eeae64789afb378a6b67a8885357" args="(DWORD GUID)" -->
  50. void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetGUID</b> (DWORD GUID)</td></tr>
  51. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1632e2a706de01f68b892b1fa350bf67"></a><!-- doxytag: member="cStorage::SetData" ref="a1632e2a706de01f68b892b1fa350bf67" args="(WORD wAnimConfig, WORD wSoundSet, WORD wModel, WORD wIcon)" -->
  52. void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetData</b> (WORD wAnimConfig, WORD wSoundSet, WORD wModel, WORD wIcon)</td></tr>
  53. <tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
  54. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acf9cdc61cd588932ce24b63aaeff6b7e"></a><!-- doxytag: member="cStorage::m_dwHouseID" ref="acf9cdc61cd588932ce24b63aaeff6b7e" args="" -->
  55. DWORD&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_dwHouseID</b></td></tr>
  56. <tr><td colspan="2"><h2>Friends</h2></td></tr>
  57. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a78e9d7036b7c968e4844315ec857b73d"></a><!-- doxytag: member="cStorage::cClient" ref="a78e9d7036b7c968e4844315ec857b73d" args="" -->
  58. class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_storage.html#a78e9d7036b7c968e4844315ec857b73d">cClient</a></td></tr>
  59. </table>
  60. <hr/><h2>Constructor &amp; Destructor Documentation</h2>
  61. <a class="anchor" id="a4c28e915c47b76b4b911f88cc37d4366"></a><!-- doxytag: member="cStorage::cStorage" ref="a4c28e915c47b76b4b911f88cc37d4366" args="(WORD type, DWORD dwGUID, DWORD houseID, char *szName, char *szDescription, cLocation *pcLoc=NULL)" -->
  62. <div class="memitem">
  63. <div class="memproto">
  64. <table class="memname">
  65. <tr>
  66. <td class="memname">cStorage::cStorage </td>
  67. <td>(</td>
  68. <td class="paramtype">WORD&nbsp;</td>
  69. <td class="paramname"> <em>type</em>, </td>
  70. </tr>
  71. <tr>
  72. <td class="paramkey"></td>
  73. <td></td>
  74. <td class="paramtype">DWORD&nbsp;</td>
  75. <td class="paramname"> <em>dwGUID</em>, </td>
  76. </tr>
  77. <tr>
  78. <td class="paramkey"></td>
  79. <td></td>
  80. <td class="paramtype">DWORD&nbsp;</td>
  81. <td class="paramname"> <em>dwHouseID</em>, </td>
  82. </tr>
  83. <tr>
  84. <td class="paramkey"></td>
  85. <td></td>
  86. <td class="paramtype">char *&nbsp;</td>
  87. <td class="paramname"> <em>szName</em>, </td>
  88. </tr>
  89. <tr>
  90. <td class="paramkey"></td>
  91. <td></td>
  92. <td class="paramtype">char *&nbsp;</td>
  93. <td class="paramname"> <em>szDescription</em>, </td>
  94. </tr>
  95. <tr>
  96. <td class="paramkey"></td>
  97. <td></td>
  98. <td class="paramtype"><a class="el" href="structc_location.html">cLocation</a> *&nbsp;</td>
  99. <td class="paramname"> <em>pcLoc</em> = <code>NULL</code></td><td>&nbsp;</td>
  100. </tr>
  101. <tr>
  102. <td></td>
  103. <td>)</td>
  104. <td></td><td></td><td></td>
  105. </tr>
  106. </table>
  107. </div>
  108. <div class="memdoc">
  109. <p>A constructor.</p>
  110. <p>Called whenever a housing storage chest object is initialized.</p>
  111. <p>Handles the creation of housing storage chests.</p>
  112. <p>Called whenever a housing storage chest object should be initialized. </p>
  113. </div>
  114. </div>
  115. <hr/><h2>Member Function Documentation</h2>
  116. <a class="anchor" id="ad10555476c49f2ea764ac9b8fdbb82d9"></a><!-- doxytag: member="cStorage::Action" ref="ad10555476c49f2ea764ac9b8fdbb82d9" args="(cClient *who)" -->
  117. <div class="memitem">
  118. <div class="memproto">
  119. <table class="memname">
  120. <tr>
  121. <td class="memname">void cStorage::Action </td>
  122. <td>(</td>
  123. <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> *&nbsp;</td>
  124. <td class="paramname"> <em>who</em></td>
  125. <td>&nbsp;)&nbsp;</td>
  126. <td><code> [virtual]</code></td>
  127. </tr>
  128. </table>
  129. </div>
  130. <div class="memdoc">
  131. <p>Handles the actions of housing storage chest objects.</p>
  132. <p>This function is called whenever a housing storage chest is used or should perform an action. </p>
  133. <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
  134. </div>
  135. </div>
  136. <a class="anchor" id="a475351ecddba552296f053f292321cb0"></a><!-- doxytag: member="cStorage::Assess" ref="a475351ecddba552296f053f292321cb0" args="(cClient *pcAssesser)" -->
  137. <div class="memitem">
  138. <div class="memproto">
  139. <table class="memname">
  140. <tr>
  141. <td class="memname">void cStorage::Assess </td>
  142. <td>(</td>
  143. <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> *&nbsp;</td>
  144. <td class="paramname"> <em>pcAssesser</em></td>
  145. <td>&nbsp;)&nbsp;</td>
  146. <td><code> [virtual]</code></td>
  147. </tr>
  148. </table>
  149. </div>
  150. <div class="memdoc">
  151. <p>Handles the assessment of housing storage chest objects.</p>
  152. <p>This function is called whenever a housing storage chest is assessed by a client.</p>
  153. <p>Returns a Game Event (0x0000F7B0) server message of type Identify Object (0x000000C9). </p>
  154. <p>Reimplemented from <a class="el" href="classc_object.html">cObject</a>.</p>
  155. </div>
  156. </div>
  157. <a class="anchor" id="ae2691f46b0c8ff7e302c4a28afd17674"></a><!-- doxytag: member="cStorage::CreatePacket" ref="ae2691f46b0c8ff7e302c4a28afd17674" args="()" -->
  158. <div class="memitem">
  159. <div class="memproto">
  160. <table class="memname">
  161. <tr>
  162. <td class="memname"><a class="el" href="classc_message.html">cMessage</a> cStorage::CreatePacket </td>
  163. <td>(</td>
  164. <td class="paramname"></td>
  165. <td>&nbsp;)&nbsp;</td>
  166. <td><code> [virtual]</code></td>
  167. </tr>
  168. </table>
  169. </div>
  170. <div class="memdoc">
  171. <p>Handles the message sent for the creation of housing storage chests in the world.</p>
  172. <p>This function is called whenever a housing storage chest object should be created in the world for a client.</p>
  173. <dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classc_message.html">cMessage</a> - Returns a Create Object (0x0000F745) server message. </dd></dl>
  174. <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
  175. </div>
  176. </div>
  177. <hr/>The documentation for this class was generated from the following files:<ul>
  178. <li>E:/uas2/Server/<a class="el" href="_object_8h_source.html">Object.h</a></li>
  179. <li>E:/uas2/Server/<a class="el" href="c_storage_8cpp.html">cStorage.cpp</a></li>
  180. </ul>
  181. </div>
  182. <hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
  183. <a href="http://www.doxygen.org/index.html">
  184. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
  185. </body>
  186. </html>