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

classc_gems.html 15KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296
  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: cGems 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>cGems Class Reference</h1><!-- doxytag: class="cGems" --><!-- doxytag: inherits="cObject" --><div class="dynheader">
  29. Inheritance diagram for cGems:</div>
  30. <div class="dynsection">
  31. <div class="center">
  32. <img src="classc_gems.png" usemap="#cGems_map" alt=""/>
  33. <map id="cGems_map" name="cGems_map">
  34. <area href="classc_object.html" alt="cObject" shape="rect" coords="0,0,56,24"/>
  35. </map>
  36. </div>
  37. </div>
  38. <p><a href="classc_gems-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_gems.html#aa049755d72016f212e5c9cc6d67cf92f">cGems</a> (DWORD dwGUID, <a class="el" href="structc_location.html">cLocation</a> &amp;Loc, DWORD dwModel, WORD wIcon, 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_gems.html#aeca76388de65c049559d63c9ee8e0b35">cGems</a> (DWORD dwGUID, DWORD dwContainer, DWORD dwModel, WORD wIcon, 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_gems.html#a64ed8898c8451c3095f9c7f87bab79a5">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_gems.html#a93d2da1cd382d4b4af58a49b32ebf0e1">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_gems.html#a0961bea6bd7d8aafd57b9cc0dc32342b">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_gems.html#a9368553848bd5e0a8b4e0767650c4f5e">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="a11cfc23f3c2e7fe2be589f18502402b8"></a><!-- doxytag: member="cGems::GetItemModelID" ref="a11cfc23f3c2e7fe2be589f18502402b8" 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="ab2c5ffc52fd13929b112f5796950b735"></a><!-- doxytag: member="cGems::GetContainerID" ref="ab2c5ffc52fd13929b112f5796950b735" 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="af52396daa9a8511bb50bfa92f4431889"></a><!-- doxytag: member="cGems::m_dwItemModelID" ref="af52396daa9a8511bb50bfa92f4431889" 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="af9557c53287eaa04f48b5223707e3106"></a><!-- doxytag: member="cGems::m_wWeight" ref="af9557c53287eaa04f48b5223707e3106" 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="aaa69c2fd3bf3866b373997ab280196bc"></a><!-- doxytag: member="cGems::m_dwValue" ref="aaa69c2fd3bf3866b373997ab280196bc" 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="ace7a59fa39fec69c9030642c6f89621f"></a><!-- doxytag: member="cGems::m_fIsStackable" ref="ace7a59fa39fec69c9030642c6f89621f" 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="a4906c28e68e0455a9748e590d4a7454e"></a><!-- doxytag: member="cGems::m_fEquippable" ref="a4906c28e68e0455a9748e590d4a7454e" 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="a7583a3e7510674efe249c2b455e50273"></a><!-- doxytag: member="cGems::m_fIsSolid" ref="a7583a3e7510674efe249c2b455e50273" 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="a43477b54e0583d835886d9a56fc1629f"></a><!-- doxytag: member="cGems::m_strDescription" ref="a43477b54e0583d835886d9a56fc1629f" 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="aa049755d72016f212e5c9cc6d67cf92f"></a><!-- doxytag: member="cGems::cGems" ref="aa049755d72016f212e5c9cc6d67cf92f" args="(DWORD dwGUID, cLocation &amp;Loc, DWORD dwModel, WORD wIcon, std::string strName, std::string strDescription)" -->
  70. <div class="memitem">
  71. <div class="memproto">
  72. <table class="memname">
  73. <tr>
  74. <td class="memname">cGems::cGems </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">WORD&nbsp;</td>
  95. <td class="paramname"> <em>wIcon</em>, </td>
  96. </tr>
  97. <tr>
  98. <td class="paramkey"></td>
  99. <td></td>
  100. <td class="paramtype">std::string&nbsp;</td>
  101. <td class="paramname"> <em>strName</em>, </td>
  102. </tr>
  103. <tr>
  104. <td class="paramkey"></td>
  105. <td></td>
  106. <td class="paramtype">std::string&nbsp;</td>
  107. <td class="paramname"> <em>strDescription</em></td><td>&nbsp;</td>
  108. </tr>
  109. <tr>
  110. <td></td>
  111. <td>)</td>
  112. <td></td><td></td><td><code> [inline]</code></td>
  113. </tr>
  114. </table>
  115. </div>
  116. <div class="memdoc">
  117. <p>A constructor.</p>
  118. <p>Called whenever a gem object is initialized in the world. </p>
  119. </div>
  120. </div>
  121. <a class="anchor" id="aeca76388de65c049559d63c9ee8e0b35"></a><!-- doxytag: member="cGems::cGems" ref="aeca76388de65c049559d63c9ee8e0b35" args="(DWORD dwGUID, DWORD dwContainer, DWORD dwModel, WORD wIcon, std::string strName, std::string strDescription, DWORD dwValue, WORD wWeight)" -->
  122. <div class="memitem">
  123. <div class="memproto">
  124. <table class="memname">
  125. <tr>
  126. <td class="memname">cGems::cGems </td>
  127. <td>(</td>
  128. <td class="paramtype">DWORD&nbsp;</td>
  129. <td class="paramname"> <em>dwGUID</em>, </td>
  130. </tr>
  131. <tr>
  132. <td class="paramkey"></td>
  133. <td></td>
  134. <td class="paramtype">DWORD&nbsp;</td>
  135. <td class="paramname"> <em>dwContainer</em>, </td>
  136. </tr>
  137. <tr>
  138. <td class="paramkey"></td>
  139. <td></td>
  140. <td class="paramtype">DWORD&nbsp;</td>
  141. <td class="paramname"> <em>dwModel</em>, </td>
  142. </tr>
  143. <tr>
  144. <td class="paramkey"></td>
  145. <td></td>
  146. <td class="paramtype">WORD&nbsp;</td>
  147. <td class="paramname"> <em>wIcon</em>, </td>
  148. </tr>
  149. <tr>
  150. <td class="paramkey"></td>
  151. <td></td>
  152. <td class="paramtype">std::string&nbsp;</td>
  153. <td class="paramname"> <em>strName</em>, </td>
  154. </tr>
  155. <tr>
  156. <td class="paramkey"></td>
  157. <td></td>
  158. <td class="paramtype">std::string&nbsp;</td>
  159. <td class="paramname"> <em>strDescription</em>, </td>
  160. </tr>
  161. <tr>
  162. <td class="paramkey"></td>
  163. <td></td>
  164. <td class="paramtype">DWORD&nbsp;</td>
  165. <td class="paramname"> <em>dwValue</em>, </td>
  166. </tr>
  167. <tr>
  168. <td class="paramkey"></td>
  169. <td></td>
  170. <td class="paramtype">WORD&nbsp;</td>
  171. <td class="paramname"> <em>wWeight</em></td><td>&nbsp;</td>
  172. </tr>
  173. <tr>
  174. <td></td>
  175. <td>)</td>
  176. <td></td><td></td><td><code> [inline]</code></td>
  177. </tr>
  178. </table>
  179. </div>
  180. <div class="memdoc">
  181. <p>A constructor.</p>
  182. <p>Called whenever a gem object is initialized in a container. </p>
  183. </div>
  184. </div>
  185. <hr/><h2>Member Function Documentation</h2>
  186. <a class="anchor" id="a9368553848bd5e0a8b4e0767650c4f5e"></a><!-- doxytag: member="cGems::Action" ref="a9368553848bd5e0a8b4e0767650c4f5e" args="(cClient *who)" -->
  187. <div class="memitem">
  188. <div class="memproto">
  189. <table class="memname">
  190. <tr>
  191. <td class="memname">void cGems::Action </td>
  192. <td>(</td>
  193. <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> *&nbsp;</td>
  194. <td class="paramname"> <em>who</em></td>
  195. <td>&nbsp;)&nbsp;</td>
  196. <td><code> [virtual]</code></td>
  197. </tr>
  198. </table>
  199. </div>
  200. <div class="memdoc">
  201. <p>Handles the actions of gem objects.</p>
  202. <p>This function is called whenever a gem is used or should perform an action. </p>
  203. <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
  204. </div>
  205. </div>
  206. <a class="anchor" id="a0961bea6bd7d8aafd57b9cc0dc32342b"></a><!-- doxytag: member="cGems::Assess" ref="a0961bea6bd7d8aafd57b9cc0dc32342b" args="(cClient *pcAssesser)" -->
  207. <div class="memitem">
  208. <div class="memproto">
  209. <table class="memname">
  210. <tr>
  211. <td class="memname">void cGems::Assess </td>
  212. <td>(</td>
  213. <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> *&nbsp;</td>
  214. <td class="paramname"> <em>pcAssesser</em></td>
  215. <td>&nbsp;)&nbsp;</td>
  216. <td><code> [virtual]</code></td>
  217. </tr>
  218. </table>
  219. </div>
  220. <div class="memdoc">
  221. <p>Handles the assessment of gem objects.</p>
  222. <p>This function is called whenever a gem is assessed by a client.</p>
  223. <p>Returns a Game Event (0x0000F7B0) server message of type Identify Object (0x000000C9). </p>
  224. <p>Reimplemented from <a class="el" href="classc_object.html">cObject</a>.</p>
  225. </div>
  226. </div>
  227. <a class="anchor" id="a64ed8898c8451c3095f9c7f87bab79a5"></a><!-- doxytag: member="cGems::CreatePacket" ref="a64ed8898c8451c3095f9c7f87bab79a5" args="()" -->
  228. <div class="memitem">
  229. <div class="memproto">
  230. <table class="memname">
  231. <tr>
  232. <td class="memname"><a class="el" href="classc_message.html">cMessage</a> cGems::CreatePacket </td>
  233. <td>(</td>
  234. <td class="paramname"></td>
  235. <td>&nbsp;)&nbsp;</td>
  236. <td><code> [virtual]</code></td>
  237. </tr>
  238. </table>
  239. </div>
  240. <div class="memdoc">
  241. <p>Handles the message sent for the creation of gems in the world.</p>
  242. <p>This function is called whenever a gem should be created in the world for a client.</p>
  243. <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>
  244. <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
  245. </div>
  246. </div>
  247. <a class="anchor" id="a93d2da1cd382d4b4af58a49b32ebf0e1"></a><!-- doxytag: member="cGems::CreatePacketContainer" ref="a93d2da1cd382d4b4af58a49b32ebf0e1" args="(DWORD Container, DWORD ItemModelID)" -->
  248. <div class="memitem">
  249. <div class="memproto">
  250. <table class="memname">
  251. <tr>
  252. <td class="memname"><a class="el" href="classc_message.html">cMessage</a> cGems::CreatePacketContainer </td>
  253. <td>(</td>
  254. <td class="paramtype">DWORD&nbsp;</td>
  255. <td class="paramname"> <em>Container</em>, </td>
  256. </tr>
  257. <tr>
  258. <td class="paramkey"></td>
  259. <td></td>
  260. <td class="paramtype">DWORD&nbsp;</td>
  261. <td class="paramname"> <em>ItemModelID</em></td><td>&nbsp;</td>
  262. </tr>
  263. <tr>
  264. <td></td>
  265. <td>)</td>
  266. <td></td><td></td><td></td>
  267. </tr>
  268. </table>
  269. </div>
  270. <div class="memdoc">
  271. <p>Handles the message sent for the creation of gems in a container.</p>
  272. <p>This function is called whenever a gem should be created in the inventory of another object.</p>
  273. <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>
  274. </div>
  275. </div>
  276. <hr/>The documentation for this class was generated from the following files:<ul>
  277. <li>E:/uas2/Server/<a class="el" href="_object_8h_source.html">Object.h</a></li>
  278. <li>E:/uas2/Server/<a class="el" href="c_gems_8cpp.html">cGems.cpp</a></li>
  279. </ul>
  280. </div>
  281. <hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
  282. <a href="http://www.doxygen.org/index.html">
  283. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
  284. </body>
  285. </html>