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

classc_mana_stones.html 14KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290
  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: cManaStones 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>cManaStones Class Reference</h1><!-- doxytag: class="cManaStones" --><!-- doxytag: inherits="cObject" --><div class="dynheader">
  29. Inheritance diagram for cManaStones:</div>
  30. <div class="dynsection">
  31. <div class="center">
  32. <img src="classc_mana_stones.png" usemap="#cManaStones_map" alt=""/>
  33. <map id="cManaStones_map" name="cManaStones_map">
  34. <area href="classc_object.html" alt="cObject" shape="rect" coords="0,0,89,24"/>
  35. </map>
  36. </div>
  37. </div>
  38. <p><a href="classc_mana_stones-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_mana_stones.html#a6a4963778e9c302752bc7472b5b5214b">cManaStones</a> (DWORD dwGUID, <a class="el" href="structc_location.html">cLocation</a> &amp;Loc, DWORD dwModel, 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_mana_stones.html#ae4d1d3e8aed99cd13aed2ef383d5231e">cManaStones</a> (DWORD dwGUID, DWORD dwContainer, DWORD dwModel, 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_mana_stones.html#a4129e92dba9bb8af633d9e2a6d9e74ad">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_mana_stones.html#a06a227e69dfc8e1eda253e6d0f87822f">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_mana_stones.html#ad4f75a9e334f4ad5e0667025f0899293">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_mana_stones.html#a96f10b991478788393cdd5a81037ca9a">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="a5154ab7dbbb9ac42375d59896212c42b"></a><!-- doxytag: member="cManaStones::GetItemModelID" ref="a5154ab7dbbb9ac42375d59896212c42b" 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="aa9476e2134cfddccbbb8fbfd1056aa29"></a><!-- doxytag: member="cManaStones::GetContainerID" ref="aa9476e2134cfddccbbb8fbfd1056aa29" 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="a09e17437daee964c9e7b419eed7543f5"></a><!-- doxytag: member="cManaStones::m_dwItemModelID" ref="a09e17437daee964c9e7b419eed7543f5" 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="a6b5653cab7b9d19837cfe7b110f956a7"></a><!-- doxytag: member="cManaStones::m_wWeight" ref="a6b5653cab7b9d19837cfe7b110f956a7" 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="a903593d4fe83ec33f721fb9f10095a8c"></a><!-- doxytag: member="cManaStones::m_dwValue" ref="a903593d4fe83ec33f721fb9f10095a8c" 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="a3239ee46c613638ccef432a01fd411c8"></a><!-- doxytag: member="cManaStones::m_strDescription" ref="a3239ee46c613638ccef432a01fd411c8" args="" -->
  60. std::string&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_strDescription</b></td></tr>
  61. </table>
  62. <hr/><h2>Constructor &amp; Destructor Documentation</h2>
  63. <a class="anchor" id="a6a4963778e9c302752bc7472b5b5214b"></a><!-- doxytag: member="cManaStones::cManaStones" ref="a6a4963778e9c302752bc7472b5b5214b" args="(DWORD dwGUID, cLocation &amp;Loc, DWORD dwModel, DWORD dwIcon, std::string strName, std::string strDescription)" -->
  64. <div class="memitem">
  65. <div class="memproto">
  66. <table class="memname">
  67. <tr>
  68. <td class="memname">cManaStones::cManaStones </td>
  69. <td>(</td>
  70. <td class="paramtype">DWORD&nbsp;</td>
  71. <td class="paramname"> <em>dwGUID</em>, </td>
  72. </tr>
  73. <tr>
  74. <td class="paramkey"></td>
  75. <td></td>
  76. <td class="paramtype"><a class="el" href="structc_location.html">cLocation</a> &amp;&nbsp;</td>
  77. <td class="paramname"> <em>Loc</em>, </td>
  78. </tr>
  79. <tr>
  80. <td class="paramkey"></td>
  81. <td></td>
  82. <td class="paramtype">DWORD&nbsp;</td>
  83. <td class="paramname"> <em>dwModel</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>dwIcon</em>, </td>
  90. </tr>
  91. <tr>
  92. <td class="paramkey"></td>
  93. <td></td>
  94. <td class="paramtype">std::string&nbsp;</td>
  95. <td class="paramname"> <em>strName</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>strDescription</em></td><td>&nbsp;</td>
  102. </tr>
  103. <tr>
  104. <td></td>
  105. <td>)</td>
  106. <td></td><td></td><td><code> [inline]</code></td>
  107. </tr>
  108. </table>
  109. </div>
  110. <div class="memdoc">
  111. <p>A constructor.</p>
  112. <p>Called whenever a mana stone object is initialized in the world. </p>
  113. </div>
  114. </div>
  115. <a class="anchor" id="ae4d1d3e8aed99cd13aed2ef383d5231e"></a><!-- doxytag: member="cManaStones::cManaStones" ref="ae4d1d3e8aed99cd13aed2ef383d5231e" args="(DWORD dwGUID, DWORD dwContainer, DWORD dwModel, DWORD dwIcon, std::string strName, std::string strDescription, DWORD dwValue, WORD wWeight)" -->
  116. <div class="memitem">
  117. <div class="memproto">
  118. <table class="memname">
  119. <tr>
  120. <td class="memname">cManaStones::cManaStones </td>
  121. <td>(</td>
  122. <td class="paramtype">DWORD&nbsp;</td>
  123. <td class="paramname"> <em>dwGUID</em>, </td>
  124. </tr>
  125. <tr>
  126. <td class="paramkey"></td>
  127. <td></td>
  128. <td class="paramtype">DWORD&nbsp;</td>
  129. <td class="paramname"> <em>dwContainer</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>dwModel</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>dwIcon</em>, </td>
  142. </tr>
  143. <tr>
  144. <td class="paramkey"></td>
  145. <td></td>
  146. <td class="paramtype">std::string&nbsp;</td>
  147. <td class="paramname"> <em>strName</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>strDescription</em>, </td>
  154. </tr>
  155. <tr>
  156. <td class="paramkey"></td>
  157. <td></td>
  158. <td class="paramtype">DWORD&nbsp;</td>
  159. <td class="paramname"> <em>dwValue</em>, </td>
  160. </tr>
  161. <tr>
  162. <td class="paramkey"></td>
  163. <td></td>
  164. <td class="paramtype">WORD&nbsp;</td>
  165. <td class="paramname"> <em>wWeight</em></td><td>&nbsp;</td>
  166. </tr>
  167. <tr>
  168. <td></td>
  169. <td>)</td>
  170. <td></td><td></td><td><code> [inline]</code></td>
  171. </tr>
  172. </table>
  173. </div>
  174. <div class="memdoc">
  175. <p>A constructor.</p>
  176. <p>Called whenever a mana stone object is initialized in a container. </p>
  177. </div>
  178. </div>
  179. <hr/><h2>Member Function Documentation</h2>
  180. <a class="anchor" id="a96f10b991478788393cdd5a81037ca9a"></a><!-- doxytag: member="cManaStones::Action" ref="a96f10b991478788393cdd5a81037ca9a" args="(cClient *who)" -->
  181. <div class="memitem">
  182. <div class="memproto">
  183. <table class="memname">
  184. <tr>
  185. <td class="memname">void cManaStones::Action </td>
  186. <td>(</td>
  187. <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> *&nbsp;</td>
  188. <td class="paramname"> <em>who</em></td>
  189. <td>&nbsp;)&nbsp;</td>
  190. <td><code> [virtual]</code></td>
  191. </tr>
  192. </table>
  193. </div>
  194. <div class="memdoc">
  195. <p>Handles the actions of mana stone objects.</p>
  196. <p>This function is called whenever a mana stone is used or should perform an action. </p>
  197. <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
  198. </div>
  199. </div>
  200. <a class="anchor" id="ad4f75a9e334f4ad5e0667025f0899293"></a><!-- doxytag: member="cManaStones::Assess" ref="ad4f75a9e334f4ad5e0667025f0899293" args="(cClient *pcAssesser)" -->
  201. <div class="memitem">
  202. <div class="memproto">
  203. <table class="memname">
  204. <tr>
  205. <td class="memname">void cManaStones::Assess </td>
  206. <td>(</td>
  207. <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> *&nbsp;</td>
  208. <td class="paramname"> <em>pcAssesser</em></td>
  209. <td>&nbsp;)&nbsp;</td>
  210. <td><code> [virtual]</code></td>
  211. </tr>
  212. </table>
  213. </div>
  214. <div class="memdoc">
  215. <p>Handles the assessment of mana stone objects.</p>
  216. <p>This function is called whenever a mana stone is assessed by a client.</p>
  217. <p>Returns a Game Event (0x0000F7B0) server message of type Identify Object (0x000000C9). </p>
  218. <p>Reimplemented from <a class="el" href="classc_object.html">cObject</a>.</p>
  219. </div>
  220. </div>
  221. <a class="anchor" id="a4129e92dba9bb8af633d9e2a6d9e74ad"></a><!-- doxytag: member="cManaStones::CreatePacket" ref="a4129e92dba9bb8af633d9e2a6d9e74ad" args="()" -->
  222. <div class="memitem">
  223. <div class="memproto">
  224. <table class="memname">
  225. <tr>
  226. <td class="memname"><a class="el" href="classc_message.html">cMessage</a> cManaStones::CreatePacket </td>
  227. <td>(</td>
  228. <td class="paramname"></td>
  229. <td>&nbsp;)&nbsp;</td>
  230. <td><code> [virtual]</code></td>
  231. </tr>
  232. </table>
  233. </div>
  234. <div class="memdoc">
  235. <p>Handles the message sent for the creation of mana stones in the world.</p>
  236. <p>This function is called whenever a mana stone should be created in the world for a client.</p>
  237. <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>
  238. <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
  239. </div>
  240. </div>
  241. <a class="anchor" id="a06a227e69dfc8e1eda253e6d0f87822f"></a><!-- doxytag: member="cManaStones::CreatePacketContainer" ref="a06a227e69dfc8e1eda253e6d0f87822f" args="(DWORD Container, DWORD ItemModelID)" -->
  242. <div class="memitem">
  243. <div class="memproto">
  244. <table class="memname">
  245. <tr>
  246. <td class="memname"><a class="el" href="classc_message.html">cMessage</a> cManaStones::CreatePacketContainer </td>
  247. <td>(</td>
  248. <td class="paramtype">DWORD&nbsp;</td>
  249. <td class="paramname"> <em>Container</em>, </td>
  250. </tr>
  251. <tr>
  252. <td class="paramkey"></td>
  253. <td></td>
  254. <td class="paramtype">DWORD&nbsp;</td>
  255. <td class="paramname"> <em>ItemModelID</em></td><td>&nbsp;</td>
  256. </tr>
  257. <tr>
  258. <td></td>
  259. <td>)</td>
  260. <td></td><td></td><td></td>
  261. </tr>
  262. </table>
  263. </div>
  264. <div class="memdoc">
  265. <p>Handles the message sent for the creation of mana stones in a container.</p>
  266. <p>This function is called whenever a mana stone should be created in the inventory of another object.</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. </div>
  269. </div>
  270. <hr/>The documentation for this class was generated from the following files:<ul>
  271. <li>E:/uas2/Server/<a class="el" href="_object_8h_source.html">Object.h</a></li>
  272. <li>E:/uas2/Server/<a class="el" href="c_mana_stones_8cpp.html">cManaStones.cpp</a></li>
  273. </ul>
  274. </div>
  275. <hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
  276. <a href="http://www.doxygen.org/index.html">
  277. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
  278. </body>
  279. </html>