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

classc_salvage.html 16KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320
  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: cSalvage 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>cSalvage Class Reference</h1><!-- doxytag: class="cSalvage" --><!-- doxytag: inherits="cObject" --><div class="dynheader">
  29. Inheritance diagram for cSalvage:</div>
  30. <div class="dynsection">
  31. <div class="center">
  32. <img src="classc_salvage.png" usemap="#cSalvage_map" alt=""/>
  33. <map id="cSalvage_map" name="cSalvage_map">
  34. <area href="classc_object.html" alt="cObject" shape="rect" coords="0,0,65,24"/>
  35. </map>
  36. </div>
  37. </div>
  38. <p><a href="classc_salvage-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_salvage.html#a9af13b1628fc709cbf5258b986e2ed89">cSalvage</a> (DWORD dwGUID, <a class="el" href="structc_location.html">cLocation</a> &amp;Loc, DWORD dwModel, float flScale, BOOL fSolid, DWORD dwIcon, std::string strName, std::string strDescription)</td></tr>
  42. <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_salvage.html#a00bc460e32f6591da1b50747de1d8fe9">cSalvage</a> (DWORD dwGUID, DWORD dwContainer, DWORD dwModel, float flScale, BOOL fSolid, DWORD dwIcon, std::string strName, std::string strDescription, DWORD dwValue, WORD wWeight)</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_salvage.html#a87c3efcc600646e700e14b3612a5885d">CreatePacket</a> ()</td></tr>
  44. <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_salvage.html#a21bb331c721b50e24baa56ddc7040427">CreatePacketContainer</a> (DWORD Container, DWORD ItemModelID)</td></tr>
  45. <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_salvage.html#a869c04ddb90a9a1b2205fa6e667dc5c6">Assess</a> (<a class="el" href="classc_client.html">cClient</a> *pcAssesser)</td></tr>
  46. <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_salvage.html#a3ff775c40eda9786afed8d6e6d2794bb">Action</a> (<a class="el" href="classc_client.html">cClient</a> *who)</td></tr>
  47. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adcb63df2c25be6f8bb12bbe15f3d333b"></a><!-- doxytag: member="cSalvage::GetItemModelID" ref="adcb63df2c25be6f8bb12bbe15f3d333b" args="()" -->
  48. DWORD&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetItemModelID</b> ()</td></tr>
  49. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0ffd24c1dbe17c60cca620951bc172b0"></a><!-- doxytag: member="cSalvage::GetContainerID" ref="a0ffd24c1dbe17c60cca620951bc172b0" args="()" -->
  50. DWORD&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetContainerID</b> ()</td></tr>
  51. <tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
  52. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad2e6a7ad3ba043762d6ec3bbf31e9689"></a><!-- doxytag: member="cSalvage::m_dwItemModelID" ref="ad2e6a7ad3ba043762d6ec3bbf31e9689" args="" -->
  53. DWORD&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_dwItemModelID</b></td></tr>
  54. <tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
  55. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4df7c54c7872de8606347966ae6a5e42"></a><!-- doxytag: member="cSalvage::m_wWeight" ref="a4df7c54c7872de8606347966ae6a5e42" args="" -->
  56. WORD&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_wWeight</b></td></tr>
  57. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a06bc9653fe0d51cf73ee1ef52d6c8190"></a><!-- doxytag: member="cSalvage::m_dwValue" ref="a06bc9653fe0d51cf73ee1ef52d6c8190" args="" -->
  58. DWORD&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_dwValue</b></td></tr>
  59. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6eb6bca8cc0e5f7fc5809a8db8ad6959"></a><!-- doxytag: member="cSalvage::m_fIsStackable" ref="a6eb6bca8cc0e5f7fc5809a8db8ad6959" args="" -->
  60. BOOL&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_fIsStackable</b></td></tr>
  61. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af5e1e1cb241446661d7e8a56e10268f4"></a><!-- doxytag: member="cSalvage::m_fEquippable" ref="af5e1e1cb241446661d7e8a56e10268f4" args="" -->
  62. BOOL&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_fEquippable</b></td></tr>
  63. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae635cbf099fe550d298ad6346326b2c1"></a><!-- doxytag: member="cSalvage::m_fIsSolid" ref="ae635cbf099fe550d298ad6346326b2c1" args="" -->
  64. BOOL&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_fIsSolid</b></td></tr>
  65. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67821f52a5660a5b78546a6aaff38a00"></a><!-- doxytag: member="cSalvage::m_strDescription" ref="a67821f52a5660a5b78546a6aaff38a00" args="" -->
  66. std::string&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_strDescription</b></td></tr>
  67. </table>
  68. <hr/><h2>Constructor &amp; Destructor Documentation</h2>
  69. <a class="anchor" id="a9af13b1628fc709cbf5258b986e2ed89"></a><!-- doxytag: member="cSalvage::cSalvage" ref="a9af13b1628fc709cbf5258b986e2ed89" args="(DWORD dwGUID, cLocation &amp;Loc, DWORD dwModel, float flScale, BOOL fSolid, DWORD dwIcon, std::string strName, std::string strDescription)" -->
  70. <div class="memitem">
  71. <div class="memproto">
  72. <table class="memname">
  73. <tr>
  74. <td class="memname">cSalvage::cSalvage </td>
  75. <td>(</td>
  76. <td class="paramtype">DWORD&nbsp;</td>
  77. <td class="paramname"> <em>dwGUID</em>, </td>
  78. </tr>
  79. <tr>
  80. <td class="paramkey"></td>
  81. <td></td>
  82. <td class="paramtype"><a class="el" href="structc_location.html">cLocation</a> &amp;&nbsp;</td>
  83. <td class="paramname"> <em>Loc</em>, </td>
  84. </tr>
  85. <tr>
  86. <td class="paramkey"></td>
  87. <td></td>
  88. <td class="paramtype">DWORD&nbsp;</td>
  89. <td class="paramname"> <em>dwModel</em>, </td>
  90. </tr>
  91. <tr>
  92. <td class="paramkey"></td>
  93. <td></td>
  94. <td class="paramtype">float&nbsp;</td>
  95. <td class="paramname"> <em>flScale</em>, </td>
  96. </tr>
  97. <tr>
  98. <td class="paramkey"></td>
  99. <td></td>
  100. <td class="paramtype">BOOL&nbsp;</td>
  101. <td class="paramname"> <em>fSolid</em>, </td>
  102. </tr>
  103. <tr>
  104. <td class="paramkey"></td>
  105. <td></td>
  106. <td class="paramtype">DWORD&nbsp;</td>
  107. <td class="paramname"> <em>dwIcon</em>, </td>
  108. </tr>
  109. <tr>
  110. <td class="paramkey"></td>
  111. <td></td>
  112. <td class="paramtype">std::string&nbsp;</td>
  113. <td class="paramname"> <em>strName</em>, </td>
  114. </tr>
  115. <tr>
  116. <td class="paramkey"></td>
  117. <td></td>
  118. <td class="paramtype">std::string&nbsp;</td>
  119. <td class="paramname"> <em>strDescription</em></td><td>&nbsp;</td>
  120. </tr>
  121. <tr>
  122. <td></td>
  123. <td>)</td>
  124. <td></td><td></td><td><code> [inline]</code></td>
  125. </tr>
  126. </table>
  127. </div>
  128. <div class="memdoc">
  129. <p>A constructor.</p>
  130. <p>Called whenever a salvage object is initialized in the world. </p>
  131. </div>
  132. </div>
  133. <a class="anchor" id="a00bc460e32f6591da1b50747de1d8fe9"></a><!-- doxytag: member="cSalvage::cSalvage" ref="a00bc460e32f6591da1b50747de1d8fe9" args="(DWORD dwGUID, DWORD dwContainer, DWORD dwModel, float flScale, BOOL fSolid, DWORD dwIcon, std::string strName, std::string strDescription, DWORD dwValue, WORD wWeight)" -->
  134. <div class="memitem">
  135. <div class="memproto">
  136. <table class="memname">
  137. <tr>
  138. <td class="memname">cSalvage::cSalvage </td>
  139. <td>(</td>
  140. <td class="paramtype">DWORD&nbsp;</td>
  141. <td class="paramname"> <em>dwGUID</em>, </td>
  142. </tr>
  143. <tr>
  144. <td class="paramkey"></td>
  145. <td></td>
  146. <td class="paramtype">DWORD&nbsp;</td>
  147. <td class="paramname"> <em>dwContainer</em>, </td>
  148. </tr>
  149. <tr>
  150. <td class="paramkey"></td>
  151. <td></td>
  152. <td class="paramtype">DWORD&nbsp;</td>
  153. <td class="paramname"> <em>dwModel</em>, </td>
  154. </tr>
  155. <tr>
  156. <td class="paramkey"></td>
  157. <td></td>
  158. <td class="paramtype">float&nbsp;</td>
  159. <td class="paramname"> <em>flScale</em>, </td>
  160. </tr>
  161. <tr>
  162. <td class="paramkey"></td>
  163. <td></td>
  164. <td class="paramtype">BOOL&nbsp;</td>
  165. <td class="paramname"> <em>fSolid</em>, </td>
  166. </tr>
  167. <tr>
  168. <td class="paramkey"></td>
  169. <td></td>
  170. <td class="paramtype">DWORD&nbsp;</td>
  171. <td class="paramname"> <em>dwIcon</em>, </td>
  172. </tr>
  173. <tr>
  174. <td class="paramkey"></td>
  175. <td></td>
  176. <td class="paramtype">std::string&nbsp;</td>
  177. <td class="paramname"> <em>strName</em>, </td>
  178. </tr>
  179. <tr>
  180. <td class="paramkey"></td>
  181. <td></td>
  182. <td class="paramtype">std::string&nbsp;</td>
  183. <td class="paramname"> <em>strDescription</em>, </td>
  184. </tr>
  185. <tr>
  186. <td class="paramkey"></td>
  187. <td></td>
  188. <td class="paramtype">DWORD&nbsp;</td>
  189. <td class="paramname"> <em>dwValue</em>, </td>
  190. </tr>
  191. <tr>
  192. <td class="paramkey"></td>
  193. <td></td>
  194. <td class="paramtype">WORD&nbsp;</td>
  195. <td class="paramname"> <em>wWeight</em></td><td>&nbsp;</td>
  196. </tr>
  197. <tr>
  198. <td></td>
  199. <td>)</td>
  200. <td></td><td></td><td><code> [inline]</code></td>
  201. </tr>
  202. </table>
  203. </div>
  204. <div class="memdoc">
  205. <p>A constructor.</p>
  206. <p>Called whenever a salvage object is initialized in a container. </p>
  207. </div>
  208. </div>
  209. <hr/><h2>Member Function Documentation</h2>
  210. <a class="anchor" id="a3ff775c40eda9786afed8d6e6d2794bb"></a><!-- doxytag: member="cSalvage::Action" ref="a3ff775c40eda9786afed8d6e6d2794bb" args="(cClient *who)" -->
  211. <div class="memitem">
  212. <div class="memproto">
  213. <table class="memname">
  214. <tr>
  215. <td class="memname">void cSalvage::Action </td>
  216. <td>(</td>
  217. <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> *&nbsp;</td>
  218. <td class="paramname"> <em>who</em></td>
  219. <td>&nbsp;)&nbsp;</td>
  220. <td><code> [virtual]</code></td>
  221. </tr>
  222. </table>
  223. </div>
  224. <div class="memdoc">
  225. <p>Handles the actions of salvage objects.</p>
  226. <p>This function is called whenever salvage is used or should perform an action. </p>
  227. <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
  228. </div>
  229. </div>
  230. <a class="anchor" id="a869c04ddb90a9a1b2205fa6e667dc5c6"></a><!-- doxytag: member="cSalvage::Assess" ref="a869c04ddb90a9a1b2205fa6e667dc5c6" args="(cClient *pcAssesser)" -->
  231. <div class="memitem">
  232. <div class="memproto">
  233. <table class="memname">
  234. <tr>
  235. <td class="memname">void cSalvage::Assess </td>
  236. <td>(</td>
  237. <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> *&nbsp;</td>
  238. <td class="paramname"> <em>pcAssesser</em></td>
  239. <td>&nbsp;)&nbsp;</td>
  240. <td><code> [virtual]</code></td>
  241. </tr>
  242. </table>
  243. </div>
  244. <div class="memdoc">
  245. <p>Handles the assessment of salvage objects.</p>
  246. <p>This function is called whenever salvage is assessed by a client.</p>
  247. <p>Returns a Game Event (0x0000F7B0) server message of type Identify Object (0x000000C9). </p>
  248. <p>Reimplemented from <a class="el" href="classc_object.html">cObject</a>.</p>
  249. </div>
  250. </div>
  251. <a class="anchor" id="a87c3efcc600646e700e14b3612a5885d"></a><!-- doxytag: member="cSalvage::CreatePacket" ref="a87c3efcc600646e700e14b3612a5885d" args="()" -->
  252. <div class="memitem">
  253. <div class="memproto">
  254. <table class="memname">
  255. <tr>
  256. <td class="memname"><a class="el" href="classc_message.html">cMessage</a> cSalvage::CreatePacket </td>
  257. <td>(</td>
  258. <td class="paramname"></td>
  259. <td>&nbsp;)&nbsp;</td>
  260. <td><code> [virtual]</code></td>
  261. </tr>
  262. </table>
  263. </div>
  264. <div class="memdoc">
  265. <p>Handles the message sent for the creation of salvage in the world.</p>
  266. <p>This function is called whenever salvage should be created in the world for a client.</p>
  267. <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>
  268. <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
  269. </div>
  270. </div>
  271. <a class="anchor" id="a21bb331c721b50e24baa56ddc7040427"></a><!-- doxytag: member="cSalvage::CreatePacketContainer" ref="a21bb331c721b50e24baa56ddc7040427" args="(DWORD Container, DWORD ItemModelID)" -->
  272. <div class="memitem">
  273. <div class="memproto">
  274. <table class="memname">
  275. <tr>
  276. <td class="memname"><a class="el" href="classc_message.html">cMessage</a> cSalvage::CreatePacketContainer </td>
  277. <td>(</td>
  278. <td class="paramtype">DWORD&nbsp;</td>
  279. <td class="paramname"> <em>Container</em>, </td>
  280. </tr>
  281. <tr>
  282. <td class="paramkey"></td>
  283. <td></td>
  284. <td class="paramtype">DWORD&nbsp;</td>
  285. <td class="paramname"> <em>ItemModelID</em></td><td>&nbsp;</td>
  286. </tr>
  287. <tr>
  288. <td></td>
  289. <td>)</td>
  290. <td></td><td></td><td></td>
  291. </tr>
  292. </table>
  293. </div>
  294. <div class="memdoc">
  295. <p>Handles the message sent for the creation of salvage in a container.</p>
  296. <p>This function is called whenever salvage should be created in the inventory of another object.</p>
  297. <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>
  298. </div>
  299. </div>
  300. <hr/>The documentation for this class was generated from the following files:<ul>
  301. <li>E:/uas2/Server/<a class="el" href="_object_8h_source.html">Object.h</a></li>
  302. <li>E:/uas2/Server/<a class="el" href="c_salvage_8cpp.html">cSalvage.cpp</a></li>
  303. </ul>
  304. </div>
  305. <hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
  306. <a href="http://www.doxygen.org/index.html">
  307. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
  308. </body>
  309. </html>