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

classc_door.html 8.9KB

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