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

classc_house.html 9.6KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187
  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: cHouse 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>cHouse Class Reference</h1><!-- doxytag: class="cHouse" --><!-- doxytag: inherits="cObject" --><div class="dynheader">
  29. Inheritance diagram for cHouse:</div>
  30. <div class="dynsection">
  31. <div class="center">
  32. <img src="classc_house.png" usemap="#cHouse_map" alt=""/>
  33. <map id="cHouse_map" name="cHouse_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_house-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_house.html#a2a5223d191facbafa04bf2dbfd7fd66d">cHouse</a> (char *szName, char *szDescription, WORD type, DWORD GUID, <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_house.html#add6330dfe0a1915c8c52c3a9f90f6b6a">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_house.html#a5d61720fe1037b01843af8f500c21a8e">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_house.html#a1d23dc324192cad49a26fa115f37c12d">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="a05014643cc390a8ff87c78b034012388"></a><!-- doxytag: member="cHouse::SetGUID" ref="a05014643cc390a8ff87c78b034012388" args="(DWORD GUID)" -->
  46. void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetGUID</b> (DWORD GUID)</td></tr>
  47. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a189e4c3b89fb958e55c33afef19a5bd3"></a><!-- doxytag: member="cHouse::SetOwner" ref="a189e4c3b89fb958e55c33afef19a5bd3" args="(DWORD ownerID)" -->
  48. void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetOwner</b> (DWORD ownerID)</td></tr>
  49. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a62d9b9f1c101f52b58665ed4a5d8b70a"></a><!-- doxytag: member="cHouse::SetData" ref="a62d9b9f1c101f52b58665ed4a5d8b70a" args="(WORD wModel, WORD wIcon)" -->
  50. void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetData</b> (WORD wModel, WORD wIcon)</td></tr>
  51. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8e6db3e91628209daea223eb766a995a"></a><!-- doxytag: member="cHouse::SetIsOpen" ref="a8e6db3e91628209daea223eb766a995a" args="(DWORD open)" -->
  52. void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetIsOpen</b> (DWORD open)</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="cHouse::cClient" ref="a78e9d7036b7c968e4844315ec857b73d" args="" -->
  55. class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_house.html#a78e9d7036b7c968e4844315ec857b73d">cClient</a></td></tr>
  56. </table>
  57. <hr/><h2>Constructor &amp; Destructor Documentation</h2>
  58. <a class="anchor" id="a2a5223d191facbafa04bf2dbfd7fd66d"></a><!-- doxytag: member="cHouse::cHouse" ref="a2a5223d191facbafa04bf2dbfd7fd66d" args="(char *szName, char *szDescription, WORD type, DWORD GUID, cLocation *pcLoc=NULL)" -->
  59. <div class="memitem">
  60. <div class="memproto">
  61. <table class="memname">
  62. <tr>
  63. <td class="memname">cHouse::cHouse </td>
  64. <td>(</td>
  65. <td class="paramtype">char *&nbsp;</td>
  66. <td class="paramname"> <em>szName</em>, </td>
  67. </tr>
  68. <tr>
  69. <td class="paramkey"></td>
  70. <td></td>
  71. <td class="paramtype">char *&nbsp;</td>
  72. <td class="paramname"> <em>szDescription</em>, </td>
  73. </tr>
  74. <tr>
  75. <td class="paramkey"></td>
  76. <td></td>
  77. <td class="paramtype">WORD&nbsp;</td>
  78. <td class="paramname"> <em>type</em>, </td>
  79. </tr>
  80. <tr>
  81. <td class="paramkey"></td>
  82. <td></td>
  83. <td class="paramtype">DWORD&nbsp;</td>
  84. <td class="paramname"> <em>dwGUID</em>, </td>
  85. </tr>
  86. <tr>
  87. <td class="paramkey"></td>
  88. <td></td>
  89. <td class="paramtype"><a class="el" href="structc_location.html">cLocation</a> *&nbsp;</td>
  90. <td class="paramname"> <em>pcLoc</em> = <code>NULL</code></td><td>&nbsp;</td>
  91. </tr>
  92. <tr>
  93. <td></td>
  94. <td>)</td>
  95. <td></td><td></td><td></td>
  96. </tr>
  97. </table>
  98. </div>
  99. <div class="memdoc">
  100. <p>A constructor.</p>
  101. <p>Called whenever a house object is initialized.</p>
  102. <p>Handles the creation of houses.</p>
  103. <p>Called whenever a house object should be initialized.</p>
  104. <p>Generally, house objects reside where the house models are located in the world. By default, the houses are inaccessable (restricted client-side) by characters unless the proper house object is created. </p>
  105. </div>
  106. </div>
  107. <hr/><h2>Member Function Documentation</h2>
  108. <a class="anchor" id="a1d23dc324192cad49a26fa115f37c12d"></a><!-- doxytag: member="cHouse::Action" ref="a1d23dc324192cad49a26fa115f37c12d" args="(cClient *who)" -->
  109. <div class="memitem">
  110. <div class="memproto">
  111. <table class="memname">
  112. <tr>
  113. <td class="memname">void cHouse::Action </td>
  114. <td>(</td>
  115. <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> *&nbsp;</td>
  116. <td class="paramname"> <em>who</em></td>
  117. <td>&nbsp;)&nbsp;</td>
  118. <td><code> [virtual]</code></td>
  119. </tr>
  120. </table>
  121. </div>
  122. <div class="memdoc">
  123. <p>Handles the actions of house objects.</p>
  124. <p>This function is called whenever a house object is used or should perform an action. </p>
  125. <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
  126. </div>
  127. </div>
  128. <a class="anchor" id="add6330dfe0a1915c8c52c3a9f90f6b6a"></a><!-- doxytag: member="cHouse::Assess" ref="add6330dfe0a1915c8c52c3a9f90f6b6a" args="(cClient *pcAssesser)" -->
  129. <div class="memitem">
  130. <div class="memproto">
  131. <table class="memname">
  132. <tr>
  133. <td class="memname">void cHouse::Assess </td>
  134. <td>(</td>
  135. <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> *&nbsp;</td>
  136. <td class="paramname"> <em>pcAssesser</em></td>
  137. <td>&nbsp;)&nbsp;</td>
  138. <td><code> [virtual]</code></td>
  139. </tr>
  140. </table>
  141. </div>
  142. <div class="memdoc">
  143. <p>Handles the assessment of house objects.</p>
  144. <p>This function is called whenever a house object is assessed by a client. House objects are intended to be imperceptible to the client.</p>
  145. <p>Returns a Game Event (0x0000F7B0) server message of type Identify Object (0x000000C9). </p>
  146. <p>Reimplemented from <a class="el" href="classc_object.html">cObject</a>.</p>
  147. </div>
  148. </div>
  149. <a class="anchor" id="a5d61720fe1037b01843af8f500c21a8e"></a><!-- doxytag: member="cHouse::CreatePacket" ref="a5d61720fe1037b01843af8f500c21a8e" args="()" -->
  150. <div class="memitem">
  151. <div class="memproto">
  152. <table class="memname">
  153. <tr>
  154. <td class="memname"><a class="el" href="classc_message.html">cMessage</a> cHouse::CreatePacket </td>
  155. <td>(</td>
  156. <td class="paramname"></td>
  157. <td>&nbsp;)&nbsp;</td>
  158. <td><code> [virtual]</code></td>
  159. </tr>
  160. </table>
  161. </div>
  162. <div class="memdoc">
  163. <p>Handles the message sent for the creation of house objects in the world.</p>
  164. <p>This function is called whenever a house object should be created in the world for a client.</p>
  165. <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>
  166. <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
  167. </div>
  168. </div>
  169. <hr/>The documentation for this class was generated from the following files:<ul>
  170. <li>E:/uas2/Server/<a class="el" href="_object_8h_source.html">Object.h</a></li>
  171. <li>E:/uas2/Server/<a class="el" href="c_house_8cpp.html">cHouse.cpp</a></li>
  172. </ul>
  173. </div>
  174. <hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
  175. <a href="http://www.doxygen.org/index.html">
  176. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
  177. </body>
  178. </html>