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

classc_healing_con.html 16KB

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