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

classc_world_object.html 8.7KB

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