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

classc_food.html 16KB

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