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

classc_plants.html 15KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314
  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: cPlants 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>cPlants Class Reference</h1><!-- doxytag: class="cPlants" --><!-- doxytag: inherits="cObject" --><div class="dynheader">
  29. Inheritance diagram for cPlants:</div>
  30. <div class="dynsection">
  31. <div class="center">
  32. <img src="classc_plants.png" usemap="#cPlants_map" alt=""/>
  33. <map id="cPlants_map" name="cPlants_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_plants-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_plants.html#a40302d42029d6756e28ccf666c893dc3">cPlants</a> (DWORD dwGUID, <a class="el" href="structc_location.html">cLocation</a> &amp;Loc, DWORD dwModel, float flScale, BOOL fSolid, DWORD dwIcon, std::string strName, std::string strDescription)</td></tr>
  42. <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_plants.html#a4c6e74b830de45f53bd8f8a79dd7bc9e">cPlants</a> (DWORD dwGUID, DWORD dwContainer, DWORD dwModel, float flScale, BOOL fSolid, DWORD dwIcon, std::string strName, std::string strDescription, DWORD dwValue, DWORD wWeight)</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_plants.html#aa77f3470a38c125773462ec6678f4eee">CreatePacket</a> ()</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_plants.html#a8f4a096c6c68ab04c76e7c31158c026d">CreatePacketContainer</a> (DWORD Container, DWORD ItemModelID)</td></tr>
  45. <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_plants.html#ac939d98e92f70be83472ac03d65eca3a">Assess</a> (<a class="el" href="classc_client.html">cClient</a> *pcAssesser)</td></tr>
  46. <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_plants.html#a444db123f7305a3f34715293e5b49e16">Action</a> (<a class="el" href="classc_client.html">cClient</a> *who)</td></tr>
  47. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af6d7cef4a8fa25e7c44e606e9ee20f37"></a><!-- doxytag: member="cPlants::GetItemModelID" ref="af6d7cef4a8fa25e7c44e606e9ee20f37" args="()" -->
  48. DWORD&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetItemModelID</b> ()</td></tr>
  49. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2800a4b47985b496be8c765474c38e02"></a><!-- doxytag: member="cPlants::GetContainerID" ref="a2800a4b47985b496be8c765474c38e02" args="()" -->
  50. DWORD&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetContainerID</b> ()</td></tr>
  51. <tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
  52. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a302f66dff190ebea2e4b1627d1e390d4"></a><!-- doxytag: member="cPlants::m_dwItemModelID" ref="a302f66dff190ebea2e4b1627d1e390d4" args="" -->
  53. DWORD&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_dwItemModelID</b></td></tr>
  54. <tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
  55. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a91b02112edf009d18ceb25387f049c97"></a><!-- doxytag: member="cPlants::m_wWeight" ref="a91b02112edf009d18ceb25387f049c97" args="" -->
  56. WORD&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_wWeight</b></td></tr>
  57. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a705ec428eabb54042a84442f16ba8768"></a><!-- doxytag: member="cPlants::m_dwValue" ref="a705ec428eabb54042a84442f16ba8768" args="" -->
  58. DWORD&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_dwValue</b></td></tr>
  59. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a021e9d897cd41b36bdc263c7c93b5b3e"></a><!-- doxytag: member="cPlants::m_strDescription" ref="a021e9d897cd41b36bdc263c7c93b5b3e" args="" -->
  60. std::string&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_strDescription</b></td></tr>
  61. </table>
  62. <hr/><h2>Constructor &amp; Destructor Documentation</h2>
  63. <a class="anchor" id="a40302d42029d6756e28ccf666c893dc3"></a><!-- doxytag: member="cPlants::cPlants" ref="a40302d42029d6756e28ccf666c893dc3" args="(DWORD dwGUID, cLocation &amp;Loc, DWORD dwModel, float flScale, BOOL fSolid, DWORD dwIcon, std::string strName, std::string strDescription)" -->
  64. <div class="memitem">
  65. <div class="memproto">
  66. <table class="memname">
  67. <tr>
  68. <td class="memname">cPlants::cPlants </td>
  69. <td>(</td>
  70. <td class="paramtype">DWORD&nbsp;</td>
  71. <td class="paramname"> <em>dwGUID</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> &amp;&nbsp;</td>
  77. <td class="paramname"> <em>Loc</em>, </td>
  78. </tr>
  79. <tr>
  80. <td class="paramkey"></td>
  81. <td></td>
  82. <td class="paramtype">DWORD&nbsp;</td>
  83. <td class="paramname"> <em>dwModel</em>, </td>
  84. </tr>
  85. <tr>
  86. <td class="paramkey"></td>
  87. <td></td>
  88. <td class="paramtype">float&nbsp;</td>
  89. <td class="paramname"> <em>flScale</em>, </td>
  90. </tr>
  91. <tr>
  92. <td class="paramkey"></td>
  93. <td></td>
  94. <td class="paramtype">BOOL&nbsp;</td>
  95. <td class="paramname"> <em>fSolid</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>dwIcon</em>, </td>
  102. </tr>
  103. <tr>
  104. <td class="paramkey"></td>
  105. <td></td>
  106. <td class="paramtype">std::string&nbsp;</td>
  107. <td class="paramname"> <em>strName</em>, </td>
  108. </tr>
  109. <tr>
  110. <td class="paramkey"></td>
  111. <td></td>
  112. <td class="paramtype">std::string&nbsp;</td>
  113. <td class="paramname"> <em>strDescription</em></td><td>&nbsp;</td>
  114. </tr>
  115. <tr>
  116. <td></td>
  117. <td>)</td>
  118. <td></td><td></td><td><code> [inline]</code></td>
  119. </tr>
  120. </table>
  121. </div>
  122. <div class="memdoc">
  123. <p>A constructor.</p>
  124. <p>Called whenever a plant object is initialized in the world. </p>
  125. </div>
  126. </div>
  127. <a class="anchor" id="a4c6e74b830de45f53bd8f8a79dd7bc9e"></a><!-- doxytag: member="cPlants::cPlants" ref="a4c6e74b830de45f53bd8f8a79dd7bc9e" args="(DWORD dwGUID, DWORD dwContainer, DWORD dwModel, float flScale, BOOL fSolid, DWORD dwIcon, std::string strName, std::string strDescription, DWORD dwValue, DWORD wWeight)" -->
  128. <div class="memitem">
  129. <div class="memproto">
  130. <table class="memname">
  131. <tr>
  132. <td class="memname">cPlants::cPlants </td>
  133. <td>(</td>
  134. <td class="paramtype">DWORD&nbsp;</td>
  135. <td class="paramname"> <em>dwGUID</em>, </td>
  136. </tr>
  137. <tr>
  138. <td class="paramkey"></td>
  139. <td></td>
  140. <td class="paramtype">DWORD&nbsp;</td>
  141. <td class="paramname"> <em>dwContainer</em>, </td>
  142. </tr>
  143. <tr>
  144. <td class="paramkey"></td>
  145. <td></td>
  146. <td class="paramtype">DWORD&nbsp;</td>
  147. <td class="paramname"> <em>dwModel</em>, </td>
  148. </tr>
  149. <tr>
  150. <td class="paramkey"></td>
  151. <td></td>
  152. <td class="paramtype">float&nbsp;</td>
  153. <td class="paramname"> <em>flScale</em>, </td>
  154. </tr>
  155. <tr>
  156. <td class="paramkey"></td>
  157. <td></td>
  158. <td class="paramtype">BOOL&nbsp;</td>
  159. <td class="paramname"> <em>fSolid</em>, </td>
  160. </tr>
  161. <tr>
  162. <td class="paramkey"></td>
  163. <td></td>
  164. <td class="paramtype">DWORD&nbsp;</td>
  165. <td class="paramname"> <em>dwIcon</em>, </td>
  166. </tr>
  167. <tr>
  168. <td class="paramkey"></td>
  169. <td></td>
  170. <td class="paramtype">std::string&nbsp;</td>
  171. <td class="paramname"> <em>strName</em>, </td>
  172. </tr>
  173. <tr>
  174. <td class="paramkey"></td>
  175. <td></td>
  176. <td class="paramtype">std::string&nbsp;</td>
  177. <td class="paramname"> <em>strDescription</em>, </td>
  178. </tr>
  179. <tr>
  180. <td class="paramkey"></td>
  181. <td></td>
  182. <td class="paramtype">DWORD&nbsp;</td>
  183. <td class="paramname"> <em>dwValue</em>, </td>
  184. </tr>
  185. <tr>
  186. <td class="paramkey"></td>
  187. <td></td>
  188. <td class="paramtype">DWORD&nbsp;</td>
  189. <td class="paramname"> <em>wWeight</em></td><td>&nbsp;</td>
  190. </tr>
  191. <tr>
  192. <td></td>
  193. <td>)</td>
  194. <td></td><td></td><td><code> [inline]</code></td>
  195. </tr>
  196. </table>
  197. </div>
  198. <div class="memdoc">
  199. <p>A constructor.</p>
  200. <p>Called whenever a plant object is initialized a container. </p>
  201. </div>
  202. </div>
  203. <hr/><h2>Member Function Documentation</h2>
  204. <a class="anchor" id="a444db123f7305a3f34715293e5b49e16"></a><!-- doxytag: member="cPlants::Action" ref="a444db123f7305a3f34715293e5b49e16" args="(cClient *who)" -->
  205. <div class="memitem">
  206. <div class="memproto">
  207. <table class="memname">
  208. <tr>
  209. <td class="memname">void cPlants::Action </td>
  210. <td>(</td>
  211. <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> *&nbsp;</td>
  212. <td class="paramname"> <em>who</em></td>
  213. <td>&nbsp;)&nbsp;</td>
  214. <td><code> [virtual]</code></td>
  215. </tr>
  216. </table>
  217. </div>
  218. <div class="memdoc">
  219. <p>Handles the actions of plant objects.</p>
  220. <p>This function is called whenever a plant is used or should perform an action. </p>
  221. <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
  222. </div>
  223. </div>
  224. <a class="anchor" id="ac939d98e92f70be83472ac03d65eca3a"></a><!-- doxytag: member="cPlants::Assess" ref="ac939d98e92f70be83472ac03d65eca3a" args="(cClient *pcAssesser)" -->
  225. <div class="memitem">
  226. <div class="memproto">
  227. <table class="memname">
  228. <tr>
  229. <td class="memname">void cPlants::Assess </td>
  230. <td>(</td>
  231. <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> *&nbsp;</td>
  232. <td class="paramname"> <em>pcAssesser</em></td>
  233. <td>&nbsp;)&nbsp;</td>
  234. <td><code> [virtual]</code></td>
  235. </tr>
  236. </table>
  237. </div>
  238. <div class="memdoc">
  239. <p>Handles the assessment of plant objects.</p>
  240. <p>This function is called whenever a plant is assessed by a client.</p>
  241. <p>Returns a Game Event (0x0000F7B0) server message of type Identify Object (0x000000C9). </p>
  242. <p>Reimplemented from <a class="el" href="classc_object.html">cObject</a>.</p>
  243. </div>
  244. </div>
  245. <a class="anchor" id="aa77f3470a38c125773462ec6678f4eee"></a><!-- doxytag: member="cPlants::CreatePacket" ref="aa77f3470a38c125773462ec6678f4eee" args="()" -->
  246. <div class="memitem">
  247. <div class="memproto">
  248. <table class="memname">
  249. <tr>
  250. <td class="memname"><a class="el" href="classc_message.html">cMessage</a> cPlants::CreatePacket </td>
  251. <td>(</td>
  252. <td class="paramname"></td>
  253. <td>&nbsp;)&nbsp;</td>
  254. <td><code> [virtual]</code></td>
  255. </tr>
  256. </table>
  257. </div>
  258. <div class="memdoc">
  259. <p>Handles the message sent for the creation of plants in the world.</p>
  260. <p>This function is called whenever a plant should be created in the world for a client.</p>
  261. <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>
  262. <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
  263. </div>
  264. </div>
  265. <a class="anchor" id="a8f4a096c6c68ab04c76e7c31158c026d"></a><!-- doxytag: member="cPlants::CreatePacketContainer" ref="a8f4a096c6c68ab04c76e7c31158c026d" args="(DWORD Container, DWORD ItemModelID)" -->
  266. <div class="memitem">
  267. <div class="memproto">
  268. <table class="memname">
  269. <tr>
  270. <td class="memname"><a class="el" href="classc_message.html">cMessage</a> cPlants::CreatePacketContainer </td>
  271. <td>(</td>
  272. <td class="paramtype">DWORD&nbsp;</td>
  273. <td class="paramname"> <em>Container</em>, </td>
  274. </tr>
  275. <tr>
  276. <td class="paramkey"></td>
  277. <td></td>
  278. <td class="paramtype">DWORD&nbsp;</td>
  279. <td class="paramname"> <em>ItemModelID</em></td><td>&nbsp;</td>
  280. </tr>
  281. <tr>
  282. <td></td>
  283. <td>)</td>
  284. <td></td><td></td><td></td>
  285. </tr>
  286. </table>
  287. </div>
  288. <div class="memdoc">
  289. <p>Handles the message sent for the creation of plants in a container.</p>
  290. <p>This function is called whenever a plant should be created in the inventory of another object.</p>
  291. <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>
  292. </div>
  293. </div>
  294. <hr/>The documentation for this class was generated from the following files:<ul>
  295. <li>E:/uas2/Server/<a class="el" href="_object_8h_source.html">Object.h</a></li>
  296. <li>E:/uas2/Server/<a class="el" href="c_plants_8cpp.html">cPlants.cpp</a></li>
  297. </ul>
  298. </div>
  299. <hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
  300. <a href="http://www.doxygen.org/index.html">
  301. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
  302. </body>
  303. </html>