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

classc_lockpicks.html 16KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324
  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: cLockpicks 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>cLockpicks Class Reference</h1><!-- doxytag: class="cLockpicks" --><!-- doxytag: inherits="cObject" --><div class="dynheader">
  29. Inheritance diagram for cLockpicks:</div>
  30. <div class="dynsection">
  31. <div class="center">
  32. <img src="classc_lockpicks.png" usemap="#cLockpicks_map" alt=""/>
  33. <map id="cLockpicks_map" name="cLockpicks_map">
  34. <area href="classc_object.html" alt="cObject" shape="rect" coords="0,0,75,24"/>
  35. </map>
  36. </div>
  37. </div>
  38. <p><a href="classc_lockpicks-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_lockpicks.html#aa6636f9fce983a526ff900de14bad2f2">cLockpicks</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_lockpicks.html#aec42a0d25d33b01a5645a620f23965d9">cLockpicks</a> (DWORD dwGUID, DWORD dwContainer, DWORD dwModel, float flScale, BOOL fSolid, DWORD dwIcon, std::string strName, std::string strDescription, WORD wUses, WORD wUseLimit)</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_lockpicks.html#a7952611d976150722d129a7ea6b3f391">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_lockpicks.html#a192650b1993116b1296e46b5f4a6d7c7">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_lockpicks.html#a33be7472b72433846dfba52bd640d463">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_lockpicks.html#a08ccc5e641c9b8137738b90e0c7798b8">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="af01e4660c3ce9729d36e83f9b279f1a0"></a><!-- doxytag: member="cLockpicks::GetItemModelID" ref="af01e4660c3ce9729d36e83f9b279f1a0" 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="afc31dad0ff918fdef711a45defacb613"></a><!-- doxytag: member="cLockpicks::GetContainerID" ref="afc31dad0ff918fdef711a45defacb613" 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="abfa9783c2c3536aef5dae136f4c8cd52"></a><!-- doxytag: member="cLockpicks::m_dwItemModelID" ref="abfa9783c2c3536aef5dae136f4c8cd52" 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="aca4d7c8ea11e5124e5cb4635e5f31fd9"></a><!-- doxytag: member="cLockpicks::m_dwWeight" ref="aca4d7c8ea11e5124e5cb4635e5f31fd9" args="" -->
  56. DWORD&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_dwWeight</b></td></tr>
  57. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3636547fe870643802fff5907704dbb4"></a><!-- doxytag: member="cLockpicks::m_dwValue" ref="a3636547fe870643802fff5907704dbb4" 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="a49e5630af9dfcfa4d46f4c0b46e8d6a7"></a><!-- doxytag: member="cLockpicks::m_fIsStackable" ref="a49e5630af9dfcfa4d46f4c0b46e8d6a7" 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="affb10d0960de3b41c8b2112689dfd182"></a><!-- doxytag: member="cLockpicks::m_fEquippable" ref="affb10d0960de3b41c8b2112689dfd182" 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="a0e6b7c3e10d2ce4137732372cafca0a0"></a><!-- doxytag: member="cLockpicks::m_fIsSolid" ref="a0e6b7c3e10d2ce4137732372cafca0a0" 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="a4d6129ff372607ff091a3891011eeb34"></a><!-- doxytag: member="cLockpicks::m_wUses" ref="a4d6129ff372607ff091a3891011eeb34" args="" -->
  66. WORD&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_wUses</b></td></tr>
  67. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad077a5dde408e1a169b4bae1ab257f68"></a><!-- doxytag: member="cLockpicks::m_wUseLimit" ref="ad077a5dde408e1a169b4bae1ab257f68" args="" -->
  68. WORD&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_wUseLimit</b></td></tr>
  69. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acdc837a134d64d09d83ce180e3ae09bc"></a><!-- doxytag: member="cLockpicks::m_strDescription" ref="acdc837a134d64d09d83ce180e3ae09bc" args="" -->
  70. std::string&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_strDescription</b></td></tr>
  71. </table>
  72. <hr/><h2>Constructor &amp; Destructor Documentation</h2>
  73. <a class="anchor" id="aa6636f9fce983a526ff900de14bad2f2"></a><!-- doxytag: member="cLockpicks::cLockpicks" ref="aa6636f9fce983a526ff900de14bad2f2" args="(DWORD dwGUID, cLocation &amp;Loc, DWORD dwModel, float flScale, BOOL fSolid, DWORD dwIcon, std::string strName, std::string strDescription)" -->
  74. <div class="memitem">
  75. <div class="memproto">
  76. <table class="memname">
  77. <tr>
  78. <td class="memname">cLockpicks::cLockpicks </td>
  79. <td>(</td>
  80. <td class="paramtype">DWORD&nbsp;</td>
  81. <td class="paramname"> <em>dwGUID</em>, </td>
  82. </tr>
  83. <tr>
  84. <td class="paramkey"></td>
  85. <td></td>
  86. <td class="paramtype"><a class="el" href="structc_location.html">cLocation</a> &amp;&nbsp;</td>
  87. <td class="paramname"> <em>Loc</em>, </td>
  88. </tr>
  89. <tr>
  90. <td class="paramkey"></td>
  91. <td></td>
  92. <td class="paramtype">DWORD&nbsp;</td>
  93. <td class="paramname"> <em>dwModel</em>, </td>
  94. </tr>
  95. <tr>
  96. <td class="paramkey"></td>
  97. <td></td>
  98. <td class="paramtype">float&nbsp;</td>
  99. <td class="paramname"> <em>flScale</em>, </td>
  100. </tr>
  101. <tr>
  102. <td class="paramkey"></td>
  103. <td></td>
  104. <td class="paramtype">BOOL&nbsp;</td>
  105. <td class="paramname"> <em>fSolid</em>, </td>
  106. </tr>
  107. <tr>
  108. <td class="paramkey"></td>
  109. <td></td>
  110. <td class="paramtype">DWORD&nbsp;</td>
  111. <td class="paramname"> <em>dwIcon</em>, </td>
  112. </tr>
  113. <tr>
  114. <td class="paramkey"></td>
  115. <td></td>
  116. <td class="paramtype">std::string&nbsp;</td>
  117. <td class="paramname"> <em>strName</em>, </td>
  118. </tr>
  119. <tr>
  120. <td class="paramkey"></td>
  121. <td></td>
  122. <td class="paramtype">std::string&nbsp;</td>
  123. <td class="paramname"> <em>strDescription</em></td><td>&nbsp;</td>
  124. </tr>
  125. <tr>
  126. <td></td>
  127. <td>)</td>
  128. <td></td><td></td><td><code> [inline]</code></td>
  129. </tr>
  130. </table>
  131. </div>
  132. <div class="memdoc">
  133. <p>A constructor.</p>
  134. <p>Called whenever a lockpick object is initialized in the world. </p>
  135. </div>
  136. </div>
  137. <a class="anchor" id="aec42a0d25d33b01a5645a620f23965d9"></a><!-- doxytag: member="cLockpicks::cLockpicks" ref="aec42a0d25d33b01a5645a620f23965d9" args="(DWORD dwGUID, DWORD dwContainer, DWORD dwModel, float flScale, BOOL fSolid, DWORD dwIcon, std::string strName, std::string strDescription, WORD wUses, WORD wUseLimit)" -->
  138. <div class="memitem">
  139. <div class="memproto">
  140. <table class="memname">
  141. <tr>
  142. <td class="memname">cLockpicks::cLockpicks </td>
  143. <td>(</td>
  144. <td class="paramtype">DWORD&nbsp;</td>
  145. <td class="paramname"> <em>dwGUID</em>, </td>
  146. </tr>
  147. <tr>
  148. <td class="paramkey"></td>
  149. <td></td>
  150. <td class="paramtype">DWORD&nbsp;</td>
  151. <td class="paramname"> <em>dwContainer</em>, </td>
  152. </tr>
  153. <tr>
  154. <td class="paramkey"></td>
  155. <td></td>
  156. <td class="paramtype">DWORD&nbsp;</td>
  157. <td class="paramname"> <em>dwModel</em>, </td>
  158. </tr>
  159. <tr>
  160. <td class="paramkey"></td>
  161. <td></td>
  162. <td class="paramtype">float&nbsp;</td>
  163. <td class="paramname"> <em>flScale</em>, </td>
  164. </tr>
  165. <tr>
  166. <td class="paramkey"></td>
  167. <td></td>
  168. <td class="paramtype">BOOL&nbsp;</td>
  169. <td class="paramname"> <em>fSolid</em>, </td>
  170. </tr>
  171. <tr>
  172. <td class="paramkey"></td>
  173. <td></td>
  174. <td class="paramtype">DWORD&nbsp;</td>
  175. <td class="paramname"> <em>dwIcon</em>, </td>
  176. </tr>
  177. <tr>
  178. <td class="paramkey"></td>
  179. <td></td>
  180. <td class="paramtype">std::string&nbsp;</td>
  181. <td class="paramname"> <em>strName</em>, </td>
  182. </tr>
  183. <tr>
  184. <td class="paramkey"></td>
  185. <td></td>
  186. <td class="paramtype">std::string&nbsp;</td>
  187. <td class="paramname"> <em>strDescription</em>, </td>
  188. </tr>
  189. <tr>
  190. <td class="paramkey"></td>
  191. <td></td>
  192. <td class="paramtype">WORD&nbsp;</td>
  193. <td class="paramname"> <em>wUses</em>, </td>
  194. </tr>
  195. <tr>
  196. <td class="paramkey"></td>
  197. <td></td>
  198. <td class="paramtype">WORD&nbsp;</td>
  199. <td class="paramname"> <em>wUseLimit</em></td><td>&nbsp;</td>
  200. </tr>
  201. <tr>
  202. <td></td>
  203. <td>)</td>
  204. <td></td><td></td><td><code> [inline]</code></td>
  205. </tr>
  206. </table>
  207. </div>
  208. <div class="memdoc">
  209. <p>A constructor.</p>
  210. <p>Called whenever a lockpick object is initialized in a container. </p>
  211. </div>
  212. </div>
  213. <hr/><h2>Member Function Documentation</h2>
  214. <a class="anchor" id="a08ccc5e641c9b8137738b90e0c7798b8"></a><!-- doxytag: member="cLockpicks::Action" ref="a08ccc5e641c9b8137738b90e0c7798b8" args="(cClient *who)" -->
  215. <div class="memitem">
  216. <div class="memproto">
  217. <table class="memname">
  218. <tr>
  219. <td class="memname">void cLockpicks::Action </td>
  220. <td>(</td>
  221. <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> *&nbsp;</td>
  222. <td class="paramname"> <em>who</em></td>
  223. <td>&nbsp;)&nbsp;</td>
  224. <td><code> [virtual]</code></td>
  225. </tr>
  226. </table>
  227. </div>
  228. <div class="memdoc">
  229. <p>Handles the actions of lockpick objects.</p>
  230. <p>This function is called whenever a lockpick is used or should perform an action. </p>
  231. <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
  232. </div>
  233. </div>
  234. <a class="anchor" id="a33be7472b72433846dfba52bd640d463"></a><!-- doxytag: member="cLockpicks::Assess" ref="a33be7472b72433846dfba52bd640d463" args="(cClient *pcAssesser)" -->
  235. <div class="memitem">
  236. <div class="memproto">
  237. <table class="memname">
  238. <tr>
  239. <td class="memname">void cLockpicks::Assess </td>
  240. <td>(</td>
  241. <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> *&nbsp;</td>
  242. <td class="paramname"> <em>pcAssesser</em></td>
  243. <td>&nbsp;)&nbsp;</td>
  244. <td><code> [virtual]</code></td>
  245. </tr>
  246. </table>
  247. </div>
  248. <div class="memdoc">
  249. <p>Handles the assessment of lockpick objects.</p>
  250. <p>This function is called whenever a lockpick is assessed by a client.</p>
  251. <p>Returns a Game Event (0x0000F7B0) server message of type Identify Object (0x000000C9). </p>
  252. <p>Reimplemented from <a class="el" href="classc_object.html">cObject</a>.</p>
  253. </div>
  254. </div>
  255. <a class="anchor" id="a7952611d976150722d129a7ea6b3f391"></a><!-- doxytag: member="cLockpicks::CreatePacket" ref="a7952611d976150722d129a7ea6b3f391" args="()" -->
  256. <div class="memitem">
  257. <div class="memproto">
  258. <table class="memname">
  259. <tr>
  260. <td class="memname"><a class="el" href="classc_message.html">cMessage</a> cLockpicks::CreatePacket </td>
  261. <td>(</td>
  262. <td class="paramname"></td>
  263. <td>&nbsp;)&nbsp;</td>
  264. <td><code> [virtual]</code></td>
  265. </tr>
  266. </table>
  267. </div>
  268. <div class="memdoc">
  269. <p>Handles the message sent for the creation of lockpicks in the world.</p>
  270. <p>This function is called whenever a lockpick should be created in the world for a client.</p>
  271. <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>
  272. <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
  273. </div>
  274. </div>
  275. <a class="anchor" id="a192650b1993116b1296e46b5f4a6d7c7"></a><!-- doxytag: member="cLockpicks::CreatePacketContainer" ref="a192650b1993116b1296e46b5f4a6d7c7" args="(DWORD Container, DWORD ItemModelID)" -->
  276. <div class="memitem">
  277. <div class="memproto">
  278. <table class="memname">
  279. <tr>
  280. <td class="memname"><a class="el" href="classc_message.html">cMessage</a> cLockpicks::CreatePacketContainer </td>
  281. <td>(</td>
  282. <td class="paramtype">DWORD&nbsp;</td>
  283. <td class="paramname"> <em>Container</em>, </td>
  284. </tr>
  285. <tr>
  286. <td class="paramkey"></td>
  287. <td></td>
  288. <td class="paramtype">DWORD&nbsp;</td>
  289. <td class="paramname"> <em>ItemModelID</em></td><td>&nbsp;</td>
  290. </tr>
  291. <tr>
  292. <td></td>
  293. <td>)</td>
  294. <td></td><td></td><td></td>
  295. </tr>
  296. </table>
  297. </div>
  298. <div class="memdoc">
  299. <p>Handles the message sent for the creation of lockpicks in a container.</p>
  300. <p>This function is called whenever a lockpick should be created in the inventory of another object.</p>
  301. <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>
  302. </div>
  303. </div>
  304. <hr/>The documentation for this class was generated from the following files:<ul>
  305. <li>E:/uas2/Server/<a class="el" href="_object_8h_source.html">Object.h</a></li>
  306. <li>E:/uas2/Server/<a class="el" href="c_lockpicks_8cpp.html">cLockpicks.cpp</a></li>
  307. </ul>
  308. </div>
  309. <hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
  310. <a href="http://www.doxygen.org/index.html">
  311. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
  312. </body>
  313. </html>