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

classc_covenant.html 9.7KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192
  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: cCovenant 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>cCovenant Class Reference</h1><!-- doxytag: class="cCovenant" --><!-- doxytag: inherits="cObject" --><div class="dynheader">
  29. Inheritance diagram for cCovenant:</div>
  30. <div class="dynsection">
  31. <div class="center">
  32. <img src="classc_covenant.png" usemap="#cCovenant_map" alt=""/>
  33. <map id="cCovenant_map" name="cCovenant_map">
  34. <area href="classc_object.html" alt="cObject" shape="rect" coords="0,0,73,24"/>
  35. </map>
  36. </div>
  37. </div>
  38. <p><a href="classc_covenant-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_covenant.html#afc920028bc2320e84092649297bdec04">cCovenant</a> (WORD type, DWORD dwGUID, DWORD houseID, char *szName, char *szDescription, <a class="el" href="structc_location.html">cLocation</a> *pcLoc=NULL)</td></tr>
  42. <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_covenant.html#a227c13f7db128d072e4cd3ce36cbc5ba">Assess</a> (<a class="el" href="classc_client.html">cClient</a> *pcAssesser)</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_covenant.html#a3f976d181ff11e2c41d6bf6185802f32">CreatePacket</a> ()</td></tr>
  44. <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_covenant.html#a7b037e07846fc17dd2a08b70dca5ec08">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="anchor" id="ada30b2fa6eee3c2196c1f641ac9da94a"></a><!-- doxytag: member="cCovenant::SetMode" ref="ada30b2fa6eee3c2196c1f641ac9da94a" args="(DWORD mode)" -->
  46. void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetMode</b> (DWORD mode)</td></tr>
  47. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7fa74580a570fa049450623d0234846d"></a><!-- doxytag: member="cCovenant::SetGUID" ref="a7fa74580a570fa049450623d0234846d" args="(DWORD GUID)" -->
  48. void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetGUID</b> (DWORD GUID)</td></tr>
  49. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af9a9b979ce16c42bfddb02b5b6dc8bfc"></a><!-- doxytag: member="cCovenant::SetOwner" ref="af9a9b979ce16c42bfddb02b5b6dc8bfc" args="(DWORD ownerID)" -->
  50. void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetOwner</b> (DWORD ownerID)</td></tr>
  51. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af52ece035efdede60586b05cbf74b70d"></a><!-- doxytag: member="cCovenant::SetData" ref="af52ece035efdede60586b05cbf74b70d" args="(DWORD wAnimConfig, WORD wModel, WORD wIcon)" -->
  52. void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetData</b> (DWORD wAnimConfig, WORD wModel, WORD wIcon)</td></tr>
  53. <tr><td colspan="2"><h2>Friends</h2></td></tr>
  54. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a78e9d7036b7c968e4844315ec857b73d"></a><!-- doxytag: member="cCovenant::cClient" ref="a78e9d7036b7c968e4844315ec857b73d" args="" -->
  55. class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_covenant.html#a78e9d7036b7c968e4844315ec857b73d">cClient</a></td></tr>
  56. </table>
  57. <hr/><h2>Constructor &amp; Destructor Documentation</h2>
  58. <a class="anchor" id="afc920028bc2320e84092649297bdec04"></a><!-- doxytag: member="cCovenant::cCovenant" ref="afc920028bc2320e84092649297bdec04" args="(WORD type, DWORD dwGUID, DWORD houseID, char *szName, char *szDescription, cLocation *pcLoc=NULL)" -->
  59. <div class="memitem">
  60. <div class="memproto">
  61. <table class="memname">
  62. <tr>
  63. <td class="memname">cCovenant::cCovenant </td>
  64. <td>(</td>
  65. <td class="paramtype">WORD&nbsp;</td>
  66. <td class="paramname"> <em>type</em>, </td>
  67. </tr>
  68. <tr>
  69. <td class="paramkey"></td>
  70. <td></td>
  71. <td class="paramtype">DWORD&nbsp;</td>
  72. <td class="paramname"> <em>dwGUID</em>, </td>
  73. </tr>
  74. <tr>
  75. <td class="paramkey"></td>
  76. <td></td>
  77. <td class="paramtype">DWORD&nbsp;</td>
  78. <td class="paramname"> <em>dwHouseID</em>, </td>
  79. </tr>
  80. <tr>
  81. <td class="paramkey"></td>
  82. <td></td>
  83. <td class="paramtype">char *&nbsp;</td>
  84. <td class="paramname"> <em>szName</em>, </td>
  85. </tr>
  86. <tr>
  87. <td class="paramkey"></td>
  88. <td></td>
  89. <td class="paramtype">char *&nbsp;</td>
  90. <td class="paramname"> <em>szDescription</em>, </td>
  91. </tr>
  92. <tr>
  93. <td class="paramkey"></td>
  94. <td></td>
  95. <td class="paramtype"><a class="el" href="structc_location.html">cLocation</a> *&nbsp;</td>
  96. <td class="paramname"> <em>pcLoc</em> = <code>NULL</code></td><td>&nbsp;</td>
  97. </tr>
  98. <tr>
  99. <td></td>
  100. <td>)</td>
  101. <td></td><td></td><td></td>
  102. </tr>
  103. </table>
  104. </div>
  105. <div class="memdoc">
  106. <p>A constructor.</p>
  107. <p>Called whenever a covenant crystal object is initialized.</p>
  108. <p>Handles the creation of covenant crystals.</p>
  109. <p>Called whenever a covenant crystal object should be initialized. </p>
  110. </div>
  111. </div>
  112. <hr/><h2>Member Function Documentation</h2>
  113. <a class="anchor" id="a7b037e07846fc17dd2a08b70dca5ec08"></a><!-- doxytag: member="cCovenant::Action" ref="a7b037e07846fc17dd2a08b70dca5ec08" args="(cClient *who)" -->
  114. <div class="memitem">
  115. <div class="memproto">
  116. <table class="memname">
  117. <tr>
  118. <td class="memname">void cCovenant::Action </td>
  119. <td>(</td>
  120. <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> *&nbsp;</td>
  121. <td class="paramname"> <em>who</em></td>
  122. <td>&nbsp;)&nbsp;</td>
  123. <td><code> [virtual]</code></td>
  124. </tr>
  125. </table>
  126. </div>
  127. <div class="memdoc">
  128. <p>Handles the actions of covenant crystal objects.</p>
  129. <p>This function is called whenever a covenant crystal is used or should perform an action. </p>
  130. <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
  131. </div>
  132. </div>
  133. <a class="anchor" id="a227c13f7db128d072e4cd3ce36cbc5ba"></a><!-- doxytag: member="cCovenant::Assess" ref="a227c13f7db128d072e4cd3ce36cbc5ba" args="(cClient *pcAssesser)" -->
  134. <div class="memitem">
  135. <div class="memproto">
  136. <table class="memname">
  137. <tr>
  138. <td class="memname">void cCovenant::Assess </td>
  139. <td>(</td>
  140. <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> *&nbsp;</td>
  141. <td class="paramname"> <em>pcAssesser</em></td>
  142. <td>&nbsp;)&nbsp;</td>
  143. <td><code> [virtual]</code></td>
  144. </tr>
  145. </table>
  146. </div>
  147. <div class="memdoc">
  148. <p>Handles the assessment of covenant crystal objects.</p>
  149. <p>This function is called whenever a covenant crystal is assessed by a client.</p>
  150. <p>Returns a Game Event (0x0000F7B0) server message of type Identify Object (0x000000C9). </p>
  151. <p>Reimplemented from <a class="el" href="classc_object.html">cObject</a>.</p>
  152. </div>
  153. </div>
  154. <a class="anchor" id="a3f976d181ff11e2c41d6bf6185802f32"></a><!-- doxytag: member="cCovenant::CreatePacket" ref="a3f976d181ff11e2c41d6bf6185802f32" args="()" -->
  155. <div class="memitem">
  156. <div class="memproto">
  157. <table class="memname">
  158. <tr>
  159. <td class="memname"><a class="el" href="classc_message.html">cMessage</a> cCovenant::CreatePacket </td>
  160. <td>(</td>
  161. <td class="paramname"></td>
  162. <td>&nbsp;)&nbsp;</td>
  163. <td><code> [virtual]</code></td>
  164. </tr>
  165. </table>
  166. </div>
  167. <div class="memdoc">
  168. <p>Handles the message sent for the creation of covenant crystals in the world.</p>
  169. <p>This function is called whenever a covenant crystal should be created in the world for a client.</p>
  170. <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>
  171. <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
  172. </div>
  173. </div>
  174. <hr/>The documentation for this class was generated from the following files:<ul>
  175. <li>E:/uas2/Server/<a class="el" href="_object_8h_source.html">Object.h</a></li>
  176. <li>E:/uas2/Server/<a class="el" href="c_covenant_crystal_8cpp.html">cCovenantCrystal.cpp</a></li>
  177. </ul>
  178. </div>
  179. <hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
  180. <a href="http://www.doxygen.org/index.html">
  181. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
  182. </body>
  183. </html>