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

classc_war_spell.html 17KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360
  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: cWarSpell 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>cWarSpell Class Reference</h1><!-- doxytag: class="cWarSpell" --><!-- doxytag: inherits="cObject" --><div class="dynheader">
  29. Inheritance diagram for cWarSpell:</div>
  30. <div class="dynsection">
  31. <div class="center">
  32. <img src="classc_war_spell.png" usemap="#cWarSpell_map" alt=""/>
  33. <map id="cWarSpell_map" name="cWarSpell_map">
  34. <area href="classc_object.html" alt="cObject" shape="rect" coords="0,0,70,24"/>
  35. </map>
  36. </div>
  37. </div>
  38. <p><a href="classc_war_spell-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_war_spell.html#a7c191dc5ab8ddf64e87ecbabe6d1d834">cWarSpell</a> (DWORD dwGUID, DWORD dwSpellID, <a class="el" href="structc_location.html">cLocation</a> &amp;Loc, <a class="el" href="structc_velocity.html">cVelocity</a> tarVel, DWORD dwSpellModel)</td></tr>
  42. <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_war_spell.html#add6d30d37271bbb78f5e405afd66ffcf">CreatePacket</a> ()</td></tr>
  43. <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_war_spell.html#a283dba5efdd20687249adcd1d5600bac">Assess</a> (<a class="el" href="classc_client.html">cClient</a> *pcAssesser)</td></tr>
  44. <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_war_spell.html#ab5472610ded8a20fb6b463be96b0f53e">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="el" href="classc_message.html">cMessage</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_war_spell.html#af13cee1ac53277bf82bc645b681dec7c">WarParticle</a> (<a class="el" href="classc_war_spell.html">cWarSpell</a> *pcWarSpell, DWORD dwEffect, float flSpeed)</td></tr>
  46. <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_war_spell.html#abc86c660f7666699d199d17fa541d74e">SpellAnim</a> (<a class="el" href="classc_war_spell.html">cWarSpell</a> *pcWarSpell, WORD wWarAnim, WORD wWarAnim2)</td></tr>
  47. <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_war_spell.html#ae776c832cd7218ae6ec3b25e7eaeac50">SetPosition</a> ()</td></tr>
  48. <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_war_spell.html#a5a594bd8410ee159d5b5f0287d76f647">SpellImpact</a> (<a class="el" href="classc_war_spell.html">cWarSpell</a> *pcWarSpell, DWORD dwEffect, float flSpeed)</td></tr>
  49. <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_war_spell.html#aa1faff9979e28270e4748118111d9688">SpellVis</a> (<a class="el" href="classc_war_spell.html">cWarSpell</a> *pcWarSpell)</td></tr>
  50. <tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
  51. <tr><td class="memItemLeft" align="right" valign="top">static int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_war_spell.html#a32b1c87fe57acfe28c39694da110c0b0">Move</a> (LPVOID wp, LPVOID lp)</td></tr>
  52. <tr><td colspan="2"><h2>Friends</h2></td></tr>
  53. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a78e9d7036b7c968e4844315ec857b73d"></a><!-- doxytag: member="cWarSpell::cClient" ref="a78e9d7036b7c968e4844315ec857b73d" args="" -->
  54. class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_war_spell.html#a78e9d7036b7c968e4844315ec857b73d">cClient</a></td></tr>
  55. </table>
  56. <hr/><h2>Constructor &amp; Destructor Documentation</h2>
  57. <a class="anchor" id="a7c191dc5ab8ddf64e87ecbabe6d1d834"></a><!-- doxytag: member="cWarSpell::cWarSpell" ref="a7c191dc5ab8ddf64e87ecbabe6d1d834" args="(DWORD dwGUID, DWORD dwSpellID, cLocation &amp;Loc, cVelocity tarVel, DWORD dwSpellModel)" -->
  58. <div class="memitem">
  59. <div class="memproto">
  60. <table class="memname">
  61. <tr>
  62. <td class="memname">cWarSpell::cWarSpell </td>
  63. <td>(</td>
  64. <td class="paramtype">DWORD&nbsp;</td>
  65. <td class="paramname"> <em>dwGUID</em>, </td>
  66. </tr>
  67. <tr>
  68. <td class="paramkey"></td>
  69. <td></td>
  70. <td class="paramtype">DWORD&nbsp;</td>
  71. <td class="paramname"> <em>dwSpellID</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"><a class="el" href="structc_velocity.html">cVelocity</a>&nbsp;</td>
  83. <td class="paramname"> <em>tarVel</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>dwSpellModel</em></td><td>&nbsp;</td>
  90. </tr>
  91. <tr>
  92. <td></td>
  93. <td>)</td>
  94. <td></td><td></td><td><code> [inline]</code></td>
  95. </tr>
  96. </table>
  97. </div>
  98. <div class="memdoc">
  99. <p>A constructor.</p>
  100. <p>Called whenever a warspell object is initialized. </p>
  101. </div>
  102. </div>
  103. <hr/><h2>Member Function Documentation</h2>
  104. <a class="anchor" id="ab5472610ded8a20fb6b463be96b0f53e"></a><!-- doxytag: member="cWarSpell::Action" ref="ab5472610ded8a20fb6b463be96b0f53e" args="(cClient *who)" -->
  105. <div class="memitem">
  106. <div class="memproto">
  107. <table class="memname">
  108. <tr>
  109. <td class="memname">void cWarSpell::Action </td>
  110. <td>(</td>
  111. <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> *&nbsp;</td>
  112. <td class="paramname"> <em>who</em></td>
  113. <td>&nbsp;)&nbsp;</td>
  114. <td><code> [virtual]</code></td>
  115. </tr>
  116. </table>
  117. </div>
  118. <div class="memdoc">
  119. <p>Handles the general actions of war spell objects. </p>
  120. <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
  121. </div>
  122. </div>
  123. <a class="anchor" id="a283dba5efdd20687249adcd1d5600bac"></a><!-- doxytag: member="cWarSpell::Assess" ref="a283dba5efdd20687249adcd1d5600bac" args="(cClient *pcAssesser)" -->
  124. <div class="memitem">
  125. <div class="memproto">
  126. <table class="memname">
  127. <tr>
  128. <td class="memname">void cWarSpell::Assess </td>
  129. <td>(</td>
  130. <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> *&nbsp;</td>
  131. <td class="paramname"> <em>pcAssesser</em></td>
  132. <td>&nbsp;)&nbsp;</td>
  133. <td><code> [virtual]</code></td>
  134. </tr>
  135. </table>
  136. </div>
  137. <div class="memdoc">
  138. <p>Handles the assessment of war spell objects. This should not be called. </p>
  139. <p>Reimplemented from <a class="el" href="classc_object.html">cObject</a>.</p>
  140. </div>
  141. </div>
  142. <a class="anchor" id="add6d30d37271bbb78f5e405afd66ffcf"></a><!-- doxytag: member="cWarSpell::CreatePacket" ref="add6d30d37271bbb78f5e405afd66ffcf" args="()" -->
  143. <div class="memitem">
  144. <div class="memproto">
  145. <table class="memname">
  146. <tr>
  147. <td class="memname"><a class="el" href="classc_message.html">cMessage</a> cWarSpell::CreatePacket </td>
  148. <td>(</td>
  149. <td class="paramname"></td>
  150. <td>&nbsp;)&nbsp;</td>
  151. <td><code> [virtual]</code></td>
  152. </tr>
  153. </table>
  154. </div>
  155. <div class="memdoc">
  156. <p>Handles the message sent for the creation of war spells.</p>
  157. <p>This function is called whenever a war spells should be created for a client. </p>
  158. <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>
  159. <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
  160. </div>
  161. </div>
  162. <a class="anchor" id="a32b1c87fe57acfe28c39694da110c0b0"></a><!-- doxytag: member="cWarSpell::Move" ref="a32b1c87fe57acfe28c39694da110c0b0" args="(LPVOID wp, LPVOID lp)" -->
  163. <div class="memitem">
  164. <div class="memproto">
  165. <table class="memname">
  166. <tr>
  167. <td class="memname">int cWarSpell::Move </td>
  168. <td>(</td>
  169. <td class="paramtype">LPVOID&nbsp;</td>
  170. <td class="paramname"> <em>wp</em>, </td>
  171. </tr>
  172. <tr>
  173. <td class="paramkey"></td>
  174. <td></td>
  175. <td class="paramtype">LPVOID&nbsp;</td>
  176. <td class="paramname"> <em>lp</em></td><td>&nbsp;</td>
  177. </tr>
  178. <tr>
  179. <td></td>
  180. <td>)</td>
  181. <td></td><td></td><td><code> [static]</code></td>
  182. </tr>
  183. </table>
  184. </div>
  185. <div class="memdoc">
  186. <p>Handles the movement of war spells.</p>
  187. <p>This function is called whenever a war spell's position should be updated. </p>
  188. </div>
  189. </div>
  190. <a class="anchor" id="ae776c832cd7218ae6ec3b25e7eaeac50"></a><!-- doxytag: member="cWarSpell::SetPosition" ref="ae776c832cd7218ae6ec3b25e7eaeac50" args="()" -->
  191. <div class="memitem">
  192. <div class="memproto">
  193. <table class="memname">
  194. <tr>
  195. <td class="memname"><a class="el" href="classc_message.html">cMessage</a> cWarSpell::SetPosition </td>
  196. <td>(</td>
  197. <td class="paramname"></td>
  198. <td>&nbsp;)&nbsp;</td>
  199. <td><code> [virtual]</code></td>
  200. </tr>
  201. </table>
  202. </div>
  203. <div class="memdoc">
  204. <p>Sets the location for war spell objects.</p>
  205. <p>This function is called whenever the location of a war spell should be updated for a client. </p>
  206. <dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classc_message.html">cMessage</a> - Returns a Set Position and Motion (0x0000F748) server message. </dd></dl>
  207. <p>Reimplemented from <a class="el" href="classc_object.html">cObject</a>.</p>
  208. </div>
  209. </div>
  210. <a class="anchor" id="abc86c660f7666699d199d17fa541d74e"></a><!-- doxytag: member="cWarSpell::SpellAnim" ref="abc86c660f7666699d199d17fa541d74e" args="(cWarSpell *pcWarSpell, WORD wWarAnim, WORD wWarAnim2)" -->
  211. <div class="memitem">
  212. <div class="memproto">
  213. <table class="memname">
  214. <tr>
  215. <td class="memname"><a class="el" href="classc_message.html">cMessage</a> cWarSpell::SpellAnim </td>
  216. <td>(</td>
  217. <td class="paramtype"><a class="el" href="classc_war_spell.html">cWarSpell</a> *&nbsp;</td>
  218. <td class="paramname"> <em>pcWarSpell</em>, </td>
  219. </tr>
  220. <tr>
  221. <td class="paramkey"></td>
  222. <td></td>
  223. <td class="paramtype">WORD&nbsp;</td>
  224. <td class="paramname"> <em>wWarAnim</em>, </td>
  225. </tr>
  226. <tr>
  227. <td class="paramkey"></td>
  228. <td></td>
  229. <td class="paramtype">WORD&nbsp;</td>
  230. <td class="paramname"> <em>wWarAnim2</em></td><td>&nbsp;</td>
  231. </tr>
  232. <tr>
  233. <td></td>
  234. <td>)</td>
  235. <td></td><td></td><td></td>
  236. </tr>
  237. </table>
  238. </div>
  239. <div class="memdoc">
  240. <p>Sends a war spell animation.</p>
  241. <p>This function is called when an animation for a war spell should sent to a client. </p>
  242. <dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classc_message.html">cMessage</a> - Returns a Set Animation (0x0000F74C) server message. </dd></dl>
  243. </div>
  244. </div>
  245. <a class="anchor" id="a5a594bd8410ee159d5b5f0287d76f647"></a><!-- doxytag: member="cWarSpell::SpellImpact" ref="a5a594bd8410ee159d5b5f0287d76f647" args="(cWarSpell *pcWarSpell, DWORD dwEffect, float flSpeed)" -->
  246. <div class="memitem">
  247. <div class="memproto">
  248. <table class="memname">
  249. <tr>
  250. <td class="memname"><a class="el" href="classc_message.html">cMessage</a> cWarSpell::SpellImpact </td>
  251. <td>(</td>
  252. <td class="paramtype"><a class="el" href="classc_war_spell.html">cWarSpell</a> *&nbsp;</td>
  253. <td class="paramname"> <em>pcWarSpell</em>, </td>
  254. </tr>
  255. <tr>
  256. <td class="paramkey"></td>
  257. <td></td>
  258. <td class="paramtype">DWORD&nbsp;</td>
  259. <td class="paramname"> <em>dwEffect</em>, </td>
  260. </tr>
  261. <tr>
  262. <td class="paramkey"></td>
  263. <td></td>
  264. <td class="paramtype">float&nbsp;</td>
  265. <td class="paramname"> <em>flSpeed</em></td><td>&nbsp;</td>
  266. </tr>
  267. <tr>
  268. <td></td>
  269. <td>)</td>
  270. <td></td><td></td><td></td>
  271. </tr>
  272. </table>
  273. </div>
  274. <div class="memdoc">
  275. <p>Impact effects for war spell objects.</p>
  276. <p>This function is called when a war spell should display an impact effect. </p>
  277. <dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classc_message.html">cMessage</a> - Returns an Apply Visual/Sound Effect (0x0000F755) server message. </dd></dl>
  278. </div>
  279. </div>
  280. <a class="anchor" id="aa1faff9979e28270e4748118111d9688"></a><!-- doxytag: member="cWarSpell::SpellVis" ref="aa1faff9979e28270e4748118111d9688" args="(cWarSpell *pcWarSpell)" -->
  281. <div class="memitem">
  282. <div class="memproto">
  283. <table class="memname">
  284. <tr>
  285. <td class="memname"><a class="el" href="classc_message.html">cMessage</a> cWarSpell::SpellVis </td>
  286. <td>(</td>
  287. <td class="paramtype"><a class="el" href="classc_war_spell.html">cWarSpell</a> *&nbsp;</td>
  288. <td class="paramname"> <em>pcWarSpell</em></td>
  289. <td>&nbsp;)&nbsp;</td>
  290. <td></td>
  291. </tr>
  292. </table>
  293. </div>
  294. <div class="memdoc">
  295. <p>Toggles war spell visibility.</p>
  296. <p>This function is called when the visibility of a war spell should change for a client. </p>
  297. <dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classc_message.html">cMessage</a> - Returns a Toggle Object Visibility (0x0000F74B) server message. </dd></dl>
  298. </div>
  299. </div>
  300. <a class="anchor" id="af13cee1ac53277bf82bc645b681dec7c"></a><!-- doxytag: member="cWarSpell::WarParticle" ref="af13cee1ac53277bf82bc645b681dec7c" args="(cWarSpell *pcWarSpell, DWORD dwEffect, float flSpeed)" -->
  301. <div class="memitem">
  302. <div class="memproto">
  303. <table class="memname">
  304. <tr>
  305. <td class="memname"><a class="el" href="classc_message.html">cMessage</a> cWarSpell::WarParticle </td>
  306. <td>(</td>
  307. <td class="paramtype"><a class="el" href="classc_war_spell.html">cWarSpell</a> *&nbsp;</td>
  308. <td class="paramname"> <em>pcWarSpell</em>, </td>
  309. </tr>
  310. <tr>
  311. <td class="paramkey"></td>
  312. <td></td>
  313. <td class="paramtype">DWORD&nbsp;</td>
  314. <td class="paramname"> <em>dwEffect</em>, </td>
  315. </tr>
  316. <tr>
  317. <td class="paramkey"></td>
  318. <td></td>
  319. <td class="paramtype">float&nbsp;</td>
  320. <td class="paramname"> <em>flSpeed</em></td><td>&nbsp;</td>
  321. </tr>
  322. <tr>
  323. <td></td>
  324. <td>)</td>
  325. <td></td><td></td><td></td>
  326. </tr>
  327. </table>
  328. </div>
  329. <div class="memdoc">
  330. <p>Particle effects for war spell objects.</p>
  331. <p>This function is called when a war spell should display a particle effect. </p>
  332. <dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classc_message.html">cMessage</a> - Returns an Apply Visual/Sound Effect (0x0000F755) server message. </dd></dl>
  333. </div>
  334. </div>
  335. <hr/>The documentation for this class was generated from the following files:<ul>
  336. <li>E:/uas2/Server/<a class="el" href="_object_8h_source.html">Object.h</a></li>
  337. <li>E:/uas2/Server/<a class="el" href="_war_spell_8cpp.html">WarSpell.cpp</a></li>
  338. </ul>
  339. </div>
  340. <hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
  341. <a href="http://www.doxygen.org/index.html">
  342. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
  343. </body>
  344. </html>