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

classc_healing_kits.html 13KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238
  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: cHealingKits 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>cHealingKits Class Reference</h1><!-- doxytag: class="cHealingKits" --><!-- doxytag: inherits="cObject" --><div class="dynheader">
  29. Inheritance diagram for cHealingKits:</div>
  30. <div class="dynsection">
  31. <div class="center">
  32. <img src="classc_healing_kits.png" usemap="#cHealingKits_map" alt=""/>
  33. <map id="cHealingKits_map" name="cHealingKits_map">
  34. <area href="classc_object.html" alt="cObject" shape="rect" coords="0,0,82,24"/>
  35. </map>
  36. </div>
  37. </div>
  38. <p><a href="classc_healing_kits-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_healing_kits.html#a643cba292fce6c581ae68e5cfd3ec4fe">cHealingKits</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, DWORD dwValue, WORD wWeight, WORD wUses, WORD wUseLimit)</td></tr>
  42. <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_healing_kits.html#a202123662e64bf7b91e71636b613634f">CreatePacket</a> ()</td></tr>
  43. <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_healing_kits.html#af1aaaa03464b1041de5240dfa3cac5ce">Assess</a> (<a class="el" href="classc_client.html">cClient</a> *pcAssesser)</td></tr>
  44. <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_healing_kits.html#a3cd8e5ccb307ff7705435590ca0bba6b">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="ac7308c4d0523773c34745b26f2f8acfc"></a><!-- doxytag: member="cHealingKits::GetItemModelID" ref="ac7308c4d0523773c34745b26f2f8acfc" args="()" -->
  46. DWORD&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetItemModelID</b> ()</td></tr>
  47. <tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
  48. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac6a72cabf7dd42cf00cd7b2d2adb00ac"></a><!-- doxytag: member="cHealingKits::m_dwItemModelID" ref="ac6a72cabf7dd42cf00cd7b2d2adb00ac" args="" -->
  49. DWORD&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_dwItemModelID</b></td></tr>
  50. <tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
  51. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adeaaf03b4b32d166be0e94f3a2134e68"></a><!-- doxytag: member="cHealingKits::m_wWeight" ref="adeaaf03b4b32d166be0e94f3a2134e68" args="" -->
  52. WORD&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_wWeight</b></td></tr>
  53. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa9496ae775862ff6591a20658ef312d9"></a><!-- doxytag: member="cHealingKits::m_dwValue" ref="aa9496ae775862ff6591a20658ef312d9" args="" -->
  54. DWORD&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_dwValue</b></td></tr>
  55. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a40a1c086a8fa3869fb05c97e83b260e5"></a><!-- doxytag: member="cHealingKits::m_wUses" ref="a40a1c086a8fa3869fb05c97e83b260e5" args="" -->
  56. DWORD&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_wUses</b></td></tr>
  57. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6c890bf8bea50a2f820e75413caab9f6"></a><!-- doxytag: member="cHealingKits::m_wUseLimit" ref="a6c890bf8bea50a2f820e75413caab9f6" args="" -->
  58. DWORD&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_wUseLimit</b></td></tr>
  59. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e14ea2a240c4240d3849b7ca495622d"></a><!-- doxytag: member="cHealingKits::m_fIsStackable" ref="a4e14ea2a240c4240d3849b7ca495622d" args="" -->
  60. BOOL&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_fIsStackable</b></td></tr>
  61. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae463b1520e43790a82062325779848e5"></a><!-- doxytag: member="cHealingKits::m_fEquippable" ref="ae463b1520e43790a82062325779848e5" args="" -->
  62. BOOL&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_fEquippable</b></td></tr>
  63. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac37c0efc5972adec1027427daf445703"></a><!-- doxytag: member="cHealingKits::m_fIsSolid" ref="ac37c0efc5972adec1027427daf445703" args="" -->
  64. BOOL&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_fIsSolid</b></td></tr>
  65. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a47fe97fa12bff70e2bad831a0c5f55ee"></a><!-- doxytag: member="cHealingKits::m_strDescription" ref="a47fe97fa12bff70e2bad831a0c5f55ee" args="" -->
  66. std::string&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_strDescription</b></td></tr>
  67. </table>
  68. <hr/><h2>Constructor &amp; Destructor Documentation</h2>
  69. <a class="anchor" id="a643cba292fce6c581ae68e5cfd3ec4fe"></a><!-- doxytag: member="cHealingKits::cHealingKits" ref="a643cba292fce6c581ae68e5cfd3ec4fe" args="(DWORD dwGUID, cLocation &amp;Loc, DWORD dwModel, float flScale, BOOL fSolid, DWORD dwIcon, std::string strName, std::string strDescription, DWORD dwValue, WORD wWeight, WORD wUses, WORD wUseLimit)" -->
  70. <div class="memitem">
  71. <div class="memproto">
  72. <table class="memname">
  73. <tr>
  74. <td class="memname">cHealingKits::cHealingKits </td>
  75. <td>(</td>
  76. <td class="paramtype">DWORD&nbsp;</td>
  77. <td class="paramname"> <em>dwGUID</em>, </td>
  78. </tr>
  79. <tr>
  80. <td class="paramkey"></td>
  81. <td></td>
  82. <td class="paramtype"><a class="el" href="structc_location.html">cLocation</a> &amp;&nbsp;</td>
  83. <td class="paramname"> <em>Loc</em>, </td>
  84. </tr>
  85. <tr>
  86. <td class="paramkey"></td>
  87. <td></td>
  88. <td class="paramtype">DWORD&nbsp;</td>
  89. <td class="paramname"> <em>dwModel</em>, </td>
  90. </tr>
  91. <tr>
  92. <td class="paramkey"></td>
  93. <td></td>
  94. <td class="paramtype">float&nbsp;</td>
  95. <td class="paramname"> <em>flScale</em>, </td>
  96. </tr>
  97. <tr>
  98. <td class="paramkey"></td>
  99. <td></td>
  100. <td class="paramtype">BOOL&nbsp;</td>
  101. <td class="paramname"> <em>fSolid</em>, </td>
  102. </tr>
  103. <tr>
  104. <td class="paramkey"></td>
  105. <td></td>
  106. <td class="paramtype">DWORD&nbsp;</td>
  107. <td class="paramname"> <em>dwIcon</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>strName</em>, </td>
  114. </tr>
  115. <tr>
  116. <td class="paramkey"></td>
  117. <td></td>
  118. <td class="paramtype">std::string&nbsp;</td>
  119. <td class="paramname"> <em>strDescription</em>, </td>
  120. </tr>
  121. <tr>
  122. <td class="paramkey"></td>
  123. <td></td>
  124. <td class="paramtype">DWORD&nbsp;</td>
  125. <td class="paramname"> <em>dwValue</em>, </td>
  126. </tr>
  127. <tr>
  128. <td class="paramkey"></td>
  129. <td></td>
  130. <td class="paramtype">WORD&nbsp;</td>
  131. <td class="paramname"> <em>wWeight</em>, </td>
  132. </tr>
  133. <tr>
  134. <td class="paramkey"></td>
  135. <td></td>
  136. <td class="paramtype">WORD&nbsp;</td>
  137. <td class="paramname"> <em>wUses</em>, </td>
  138. </tr>
  139. <tr>
  140. <td class="paramkey"></td>
  141. <td></td>
  142. <td class="paramtype">WORD&nbsp;</td>
  143. <td class="paramname"> <em>wUseLimit</em></td><td>&nbsp;</td>
  144. </tr>
  145. <tr>
  146. <td></td>
  147. <td>)</td>
  148. <td></td><td></td><td><code> [inline]</code></td>
  149. </tr>
  150. </table>
  151. </div>
  152. <div class="memdoc">
  153. <p>A constructor.</p>
  154. <p>Called whenever a healing kit object is initialized. </p>
  155. </div>
  156. </div>
  157. <hr/><h2>Member Function Documentation</h2>
  158. <a class="anchor" id="a3cd8e5ccb307ff7705435590ca0bba6b"></a><!-- doxytag: member="cHealingKits::Action" ref="a3cd8e5ccb307ff7705435590ca0bba6b" args="(cClient *who)" -->
  159. <div class="memitem">
  160. <div class="memproto">
  161. <table class="memname">
  162. <tr>
  163. <td class="memname">void cHealingKits::Action </td>
  164. <td>(</td>
  165. <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> *&nbsp;</td>
  166. <td class="paramname"> <em>who</em></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 healing kits in a container.</p>
  174. <p>This function is called whenever a healing kit should be created in the inventory of another object.</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. <a class="anchor" id="af1aaaa03464b1041de5240dfa3cac5ce"></a><!-- doxytag: member="cHealingKits::Assess" ref="af1aaaa03464b1041de5240dfa3cac5ce" args="(cClient *pcAssesser)" -->
  180. <div class="memitem">
  181. <div class="memproto">
  182. <table class="memname">
  183. <tr>
  184. <td class="memname">void cHealingKits::Assess </td>
  185. <td>(</td>
  186. <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> *&nbsp;</td>
  187. <td class="paramname"> <em>pcAssesser</em></td>
  188. <td>&nbsp;)&nbsp;</td>
  189. <td><code> [virtual]</code></td>
  190. </tr>
  191. </table>
  192. </div>
  193. <div class="memdoc">
  194. <p>Handles the assessment of healing kit objects.</p>
  195. <p>This function is called whenever a healing kit is assessed by a client.</p>
  196. <p>Returns a Game Event (0x0000F7B0) server message of type Identify Object (0x000000C9). </p>
  197. <p>Reimplemented from <a class="el" href="classc_object.html">cObject</a>.</p>
  198. </div>
  199. </div>
  200. <a class="anchor" id="a202123662e64bf7b91e71636b613634f"></a><!-- doxytag: member="cHealingKits::CreatePacket" ref="a202123662e64bf7b91e71636b613634f" args="()" -->
  201. <div class="memitem">
  202. <div class="memproto">
  203. <table class="memname">
  204. <tr>
  205. <td class="memname"><a class="el" href="classc_message.html">cMessage</a> cHealingKits::CreatePacket </td>
  206. <td>(</td>
  207. <td class="paramname"></td>
  208. <td>&nbsp;)&nbsp;</td>
  209. <td><code> [virtual]</code></td>
  210. </tr>
  211. </table>
  212. </div>
  213. <div class="memdoc">
  214. <p>Handles the message sent for the creation of healing kits in the world.</p>
  215. <p>This function is called whenever a healing kit should be created in the world for a client.</p>
  216. <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>
  217. <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
  218. </div>
  219. </div>
  220. <hr/>The documentation for this class was generated from the following files:<ul>
  221. <li>E:/uas2/Server/<a class="el" href="_object_8h_source.html">Object.h</a></li>
  222. <li>E:/uas2/Server/<a class="el" href="c_healing_kits_8cpp.html">cHealingKits.cpp</a></li>
  223. </ul>
  224. </div>
  225. <hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
  226. <a href="http://www.doxygen.org/index.html">
  227. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
  228. </body>
  229. </html>