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

classc_hooks.html 11KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199
  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: cHooks 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>cHooks Class Reference</h1><!-- doxytag: class="cHooks" --><!-- doxytag: inherits="cObject" --><div class="dynheader">
  29. Inheritance diagram for cHooks:</div>
  30. <div class="dynsection">
  31. <div class="center">
  32. <img src="classc_hooks.png" usemap="#cHooks_map" alt=""/>
  33. <map id="cHooks_map" name="cHooks_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_hooks-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_hooks.html#a1f2327c151cd36339ec03b3e3bbea97e">cHooks</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_hooks.html#afa54251d389ffa1ef1915290417e7b65">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_hooks.html#ae5517cb7019583fb98b88f02c264be82">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_hooks.html#a61318e41fa0e79b479f03c8301868c7a">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="a20c77f6e0dc41dd8440241fa99349f8e"></a><!-- doxytag: member="cHooks::SetMode" ref="a20c77f6e0dc41dd8440241fa99349f8e" 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="abb93491eeffd07a863f60f78f818a615"></a><!-- doxytag: member="cHooks::SetGUID" ref="abb93491eeffd07a863f60f78f818a615" 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="a4bc660d34eed12411043f112b2573775"></a><!-- doxytag: member="cHooks::Set_hook_id" ref="a4bc660d34eed12411043f112b2573775" args="(int hookid)" -->
  50. void&nbsp;</td><td class="memItemRight" valign="bottom"><b>Set_hook_id</b> (int hookid)</td></tr>
  51. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aae736c34dba4d53f593f109417d2040f"></a><!-- doxytag: member="cHooks::Get_hook_id" ref="aae736c34dba4d53f593f109417d2040f" args="()" -->
  52. int&nbsp;</td><td class="memItemRight" valign="bottom"><b>Get_hook_id</b> ()</td></tr>
  53. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a83db7b3dbab2b25c2c8d79ae67998699"></a><!-- doxytag: member="cHooks::SetData" ref="a83db7b3dbab2b25c2c8d79ae67998699" args="(WORD wAnimConfig, WORD wSoundSet, WORD wModel, WORD wIcon)" -->
  54. void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetData</b> (WORD wAnimConfig, WORD wSoundSet, WORD wModel, WORD wIcon)</td></tr>
  55. <tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
  56. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4bc8a3f404f4209e41e6832d8c8bbd3d"></a><!-- doxytag: member="cHooks::v_guids" ref="a4bc8a3f404f4209e41e6832d8c8bbd3d" args="[255]" -->
  57. DWORD&nbsp;</td><td class="memItemRight" valign="bottom"><b>v_guids</b> [255]</td></tr>
  58. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2f6fbd72678ca5b7b9d6786ce32a3e68"></a><!-- doxytag: member="cHooks::m_dwHouseID" ref="a2f6fbd72678ca5b7b9d6786ce32a3e68" args="" -->
  59. DWORD&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_dwHouseID</b></td></tr>
  60. <tr><td colspan="2"><h2>Friends</h2></td></tr>
  61. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a78e9d7036b7c968e4844315ec857b73d"></a><!-- doxytag: member="cHooks::cClient" ref="a78e9d7036b7c968e4844315ec857b73d" args="" -->
  62. class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_hooks.html#a78e9d7036b7c968e4844315ec857b73d">cClient</a></td></tr>
  63. </table>
  64. <hr/><h2>Constructor &amp; Destructor Documentation</h2>
  65. <a class="anchor" id="a1f2327c151cd36339ec03b3e3bbea97e"></a><!-- doxytag: member="cHooks::cHooks" ref="a1f2327c151cd36339ec03b3e3bbea97e" args="(WORD type, DWORD dwGUID, DWORD houseID, char *szName, char *szDescription, cLocation *pcLoc=NULL)" -->
  66. <div class="memitem">
  67. <div class="memproto">
  68. <table class="memname">
  69. <tr>
  70. <td class="memname">cHooks::cHooks </td>
  71. <td>(</td>
  72. <td class="paramtype">WORD&nbsp;</td>
  73. <td class="paramname"> <em>type</em>, </td>
  74. </tr>
  75. <tr>
  76. <td class="paramkey"></td>
  77. <td></td>
  78. <td class="paramtype">DWORD&nbsp;</td>
  79. <td class="paramname"> <em>dwGUID</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>dwHouseID</em>, </td>
  86. </tr>
  87. <tr>
  88. <td class="paramkey"></td>
  89. <td></td>
  90. <td class="paramtype">char *&nbsp;</td>
  91. <td class="paramname"> <em>szName</em>, </td>
  92. </tr>
  93. <tr>
  94. <td class="paramkey"></td>
  95. <td></td>
  96. <td class="paramtype">char *&nbsp;</td>
  97. <td class="paramname"> <em>szDescription</em>, </td>
  98. </tr>
  99. <tr>
  100. <td class="paramkey"></td>
  101. <td></td>
  102. <td class="paramtype"><a class="el" href="structc_location.html">cLocation</a> *&nbsp;</td>
  103. <td class="paramname"> <em>pcLoc</em> = <code>NULL</code></td><td>&nbsp;</td>
  104. </tr>
  105. <tr>
  106. <td></td>
  107. <td>)</td>
  108. <td></td><td></td><td></td>
  109. </tr>
  110. </table>
  111. </div>
  112. <div class="memdoc">
  113. <p>A constructor.</p>
  114. <p>Called whenever a housing hook object is initialized.</p>
  115. <p>Handles the creation of housing hooks.</p>
  116. <p>Called whenever a housing hook object should be initialized. </p>
  117. </div>
  118. </div>
  119. <hr/><h2>Member Function Documentation</h2>
  120. <a class="anchor" id="a61318e41fa0e79b479f03c8301868c7a"></a><!-- doxytag: member="cHooks::Action" ref="a61318e41fa0e79b479f03c8301868c7a" args="(cClient *who)" -->
  121. <div class="memitem">
  122. <div class="memproto">
  123. <table class="memname">
  124. <tr>
  125. <td class="memname">void cHooks::Action </td>
  126. <td>(</td>
  127. <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> *&nbsp;</td>
  128. <td class="paramname"> <em>who</em></td>
  129. <td>&nbsp;)&nbsp;</td>
  130. <td><code> [virtual]</code></td>
  131. </tr>
  132. </table>
  133. </div>
  134. <div class="memdoc">
  135. <p>Handles the actions of housing hook objects.</p>
  136. <p>This function is called whenever a housing hook is used or should perform an action. </p>
  137. <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
  138. </div>
  139. </div>
  140. <a class="anchor" id="afa54251d389ffa1ef1915290417e7b65"></a><!-- doxytag: member="cHooks::Assess" ref="afa54251d389ffa1ef1915290417e7b65" args="(cClient *pcAssesser)" -->
  141. <div class="memitem">
  142. <div class="memproto">
  143. <table class="memname">
  144. <tr>
  145. <td class="memname">void cHooks::Assess </td>
  146. <td>(</td>
  147. <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> *&nbsp;</td>
  148. <td class="paramname"> <em>pcAssesser</em></td>
  149. <td>&nbsp;)&nbsp;</td>
  150. <td><code> [virtual]</code></td>
  151. </tr>
  152. </table>
  153. </div>
  154. <div class="memdoc">
  155. <p>Handles the assessment of housing hook objects.</p>
  156. <p>This function is called whenever a housing hook is assessed by a client.</p>
  157. <p>Returns a Game Event (0x0000F7B0) server message of type Identify Object (0x000000C9). </p>
  158. <p>Reimplemented from <a class="el" href="classc_object.html">cObject</a>.</p>
  159. </div>
  160. </div>
  161. <a class="anchor" id="ae5517cb7019583fb98b88f02c264be82"></a><!-- doxytag: member="cHooks::CreatePacket" ref="ae5517cb7019583fb98b88f02c264be82" args="()" -->
  162. <div class="memitem">
  163. <div class="memproto">
  164. <table class="memname">
  165. <tr>
  166. <td class="memname"><a class="el" href="classc_message.html">cMessage</a> cHooks::CreatePacket </td>
  167. <td>(</td>
  168. <td class="paramname"></td>
  169. <td>&nbsp;)&nbsp;</td>
  170. <td><code> [virtual]</code></td>
  171. </tr>
  172. </table>
  173. </div>
  174. <div class="memdoc">
  175. <p>Handles the message sent for the creation of housing hooks in the world.</p>
  176. <p>This function is called whenever a housing hook should be created for a client.</p>
  177. <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>
  178. <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
  179. </div>
  180. </div>
  181. <hr/>The documentation for this class was generated from the following files:<ul>
  182. <li>E:/uas2/Server/<a class="el" href="_object_8h_source.html">Object.h</a></li>
  183. <li>E:/uas2/Server/<a class="el" href="c_hooks_8cpp.html">cHooks.cpp</a></li>
  184. </ul>
  185. </div>
  186. <hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
  187. <a href="http://www.doxygen.org/index.html">
  188. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
  189. </body>
  190. </html>