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

classc_portal.html 9.2KB

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