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

classc_spell_comps.html 15KB

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