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

classc_trade_notes.html 16KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332
  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: cTradeNotes 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>cTradeNotes Class Reference</h1><!-- doxytag: class="cTradeNotes" --><!-- doxytag: inherits="cObject" --><div class="dynheader">
  29. Inheritance diagram for cTradeNotes:</div>
  30. <div class="dynsection">
  31. <div class="center">
  32. <img src="classc_trade_notes.png" usemap="#cTradeNotes_map" alt=""/>
  33. <map id="cTradeNotes_map" name="cTradeNotes_map">
  34. <area href="classc_object.html" alt="cObject" shape="rect" coords="0,0,84,24"/>
  35. </map>
  36. </div>
  37. </div>
  38. <p><a href="classc_trade_notes-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_trade_notes.html#a487203d474f918e90abd3d99ce30c547">cTradeNotes</a> (DWORD dwGUID, <a class="el" href="structc_location.html">cLocation</a> &amp;Loc, DWORD dwModel, float flScale, BOOL fSolid, WORD wIcon, std::string strName, std::string strDescription, DWORD dwValue, WORD wWeight)</td></tr>
  42. <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_trade_notes.html#a47f7c75c2db12c8ce6785b42b81fbdda">cTradeNotes</a> (DWORD dwGUID, DWORD dwContainer, DWORD dwModel, float flScale, BOOL fSolid, DWORD dwIcon, std::string strName, std::string strDescription, DWORD dwValue, WORD 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_trade_notes.html#a8bf74eb38db44d0bca026ab5102830a1">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_trade_notes.html#a108a1b32677e2f74c256012f2c0c346a">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_trade_notes.html#ab748e9e39e49f1b93e58f995f12ad4b2">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_trade_notes.html#a0f95699209d067900e65e1762fae1bdc">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="a0f8c5f098f9e1638f27eeeb6de578cc9"></a><!-- doxytag: member="cTradeNotes::GetItemModelID" ref="a0f8c5f098f9e1638f27eeeb6de578cc9" 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="ad1ec26a049a88cccb8bd457965e5ed2d"></a><!-- doxytag: member="cTradeNotes::GetContainerID" ref="ad1ec26a049a88cccb8bd457965e5ed2d" 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="a5a8d79148cd8041668a55bfb43043e84"></a><!-- doxytag: member="cTradeNotes::m_dwItemModelID" ref="a5a8d79148cd8041668a55bfb43043e84" 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="a971c35b684afd803a926ef0d92adf03c"></a><!-- doxytag: member="cTradeNotes::m_wWeight" ref="a971c35b684afd803a926ef0d92adf03c" 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="ad99482449ccd50d8ce87c9d482b7e533"></a><!-- doxytag: member="cTradeNotes::m_dwValue" ref="ad99482449ccd50d8ce87c9d482b7e533" 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="aa00248c83e0e2b9b2db9d9e5fd8d0402"></a><!-- doxytag: member="cTradeNotes::m_fIsStackable" ref="aa00248c83e0e2b9b2db9d9e5fd8d0402" 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="a39eddc100ed70cd3ecc58667b48199c9"></a><!-- doxytag: member="cTradeNotes::m_fEquippable" ref="a39eddc100ed70cd3ecc58667b48199c9" 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="a3e0d414adb5a7eb1f22eecc4a2252481"></a><!-- doxytag: member="cTradeNotes::m_fIsSolid" ref="a3e0d414adb5a7eb1f22eecc4a2252481" 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="ab1c204186c7d6865637af2e9b735f86e"></a><!-- doxytag: member="cTradeNotes::m_strDescription" ref="ab1c204186c7d6865637af2e9b735f86e" 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="a487203d474f918e90abd3d99ce30c547"></a><!-- doxytag: member="cTradeNotes::cTradeNotes" ref="a487203d474f918e90abd3d99ce30c547" args="(DWORD dwGUID, cLocation &amp;Loc, DWORD dwModel, float flScale, BOOL fSolid, WORD wIcon, std::string strName, std::string strDescription, DWORD dwValue, WORD wWeight)" -->
  70. <div class="memitem">
  71. <div class="memproto">
  72. <table class="memname">
  73. <tr>
  74. <td class="memname">cTradeNotes::cTradeNotes </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">WORD&nbsp;</td>
  107. <td class="paramname"> <em>wIcon</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><td>&nbsp;</td>
  132. </tr>
  133. <tr>
  134. <td></td>
  135. <td>)</td>
  136. <td></td><td></td><td><code> [inline]</code></td>
  137. </tr>
  138. </table>
  139. </div>
  140. <div class="memdoc">
  141. <p>A constructor.</p>
  142. <p>Called whenever a trade note object is initialized in the world. </p>
  143. </div>
  144. </div>
  145. <a class="anchor" id="a47f7c75c2db12c8ce6785b42b81fbdda"></a><!-- doxytag: member="cTradeNotes::cTradeNotes" ref="a47f7c75c2db12c8ce6785b42b81fbdda" args="(DWORD dwGUID, DWORD dwContainer, DWORD dwModel, float flScale, BOOL fSolid, DWORD dwIcon, std::string strName, std::string strDescription, DWORD dwValue, WORD wWeight)" -->
  146. <div class="memitem">
  147. <div class="memproto">
  148. <table class="memname">
  149. <tr>
  150. <td class="memname">cTradeNotes::cTradeNotes </td>
  151. <td>(</td>
  152. <td class="paramtype">DWORD&nbsp;</td>
  153. <td class="paramname"> <em>dwGUID</em>, </td>
  154. </tr>
  155. <tr>
  156. <td class="paramkey"></td>
  157. <td></td>
  158. <td class="paramtype">DWORD&nbsp;</td>
  159. <td class="paramname"> <em>dwContainer</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>dwModel</em>, </td>
  166. </tr>
  167. <tr>
  168. <td class="paramkey"></td>
  169. <td></td>
  170. <td class="paramtype">float&nbsp;</td>
  171. <td class="paramname"> <em>flScale</em>, </td>
  172. </tr>
  173. <tr>
  174. <td class="paramkey"></td>
  175. <td></td>
  176. <td class="paramtype">BOOL&nbsp;</td>
  177. <td class="paramname"> <em>fSolid</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>dwIcon</em>, </td>
  184. </tr>
  185. <tr>
  186. <td class="paramkey"></td>
  187. <td></td>
  188. <td class="paramtype">std::string&nbsp;</td>
  189. <td class="paramname"> <em>strName</em>, </td>
  190. </tr>
  191. <tr>
  192. <td class="paramkey"></td>
  193. <td></td>
  194. <td class="paramtype">std::string&nbsp;</td>
  195. <td class="paramname"> <em>strDescription</em>, </td>
  196. </tr>
  197. <tr>
  198. <td class="paramkey"></td>
  199. <td></td>
  200. <td class="paramtype">DWORD&nbsp;</td>
  201. <td class="paramname"> <em>dwValue</em>, </td>
  202. </tr>
  203. <tr>
  204. <td class="paramkey"></td>
  205. <td></td>
  206. <td class="paramtype">WORD&nbsp;</td>
  207. <td class="paramname"> <em>wWeight</em></td><td>&nbsp;</td>
  208. </tr>
  209. <tr>
  210. <td></td>
  211. <td>)</td>
  212. <td></td><td></td><td><code> [inline]</code></td>
  213. </tr>
  214. </table>
  215. </div>
  216. <div class="memdoc">
  217. <p>A constructor.</p>
  218. <p>Called whenever a trade note object is initialized in a container. </p>
  219. </div>
  220. </div>
  221. <hr/><h2>Member Function Documentation</h2>
  222. <a class="anchor" id="a0f95699209d067900e65e1762fae1bdc"></a><!-- doxytag: member="cTradeNotes::Action" ref="a0f95699209d067900e65e1762fae1bdc" args="(cClient *who)" -->
  223. <div class="memitem">
  224. <div class="memproto">
  225. <table class="memname">
  226. <tr>
  227. <td class="memname">void cTradeNotes::Action </td>
  228. <td>(</td>
  229. <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> *&nbsp;</td>
  230. <td class="paramname"> <em>who</em></td>
  231. <td>&nbsp;)&nbsp;</td>
  232. <td><code> [virtual]</code></td>
  233. </tr>
  234. </table>
  235. </div>
  236. <div class="memdoc">
  237. <p>Handles the actions of trade note objects.</p>
  238. <p>This function is called whenever a trade note is used or should perform an action. </p>
  239. <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
  240. </div>
  241. </div>
  242. <a class="anchor" id="ab748e9e39e49f1b93e58f995f12ad4b2"></a><!-- doxytag: member="cTradeNotes::Assess" ref="ab748e9e39e49f1b93e58f995f12ad4b2" args="(cClient *pcAssesser)" -->
  243. <div class="memitem">
  244. <div class="memproto">
  245. <table class="memname">
  246. <tr>
  247. <td class="memname">void cTradeNotes::Assess </td>
  248. <td>(</td>
  249. <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> *&nbsp;</td>
  250. <td class="paramname"> <em>pcAssesser</em></td>
  251. <td>&nbsp;)&nbsp;</td>
  252. <td><code> [virtual]</code></td>
  253. </tr>
  254. </table>
  255. </div>
  256. <div class="memdoc">
  257. <p>Handles the assessment of trade note objects.</p>
  258. <p>This function is called whenever a trade note is assessed by a client.</p>
  259. <p>Returns a Game Event (0x0000F7B0) server message of type Identify Object (0x000000C9). </p>
  260. <p>Reimplemented from <a class="el" href="classc_object.html">cObject</a>.</p>
  261. </div>
  262. </div>
  263. <a class="anchor" id="a8bf74eb38db44d0bca026ab5102830a1"></a><!-- doxytag: member="cTradeNotes::CreatePacket" ref="a8bf74eb38db44d0bca026ab5102830a1" args="()" -->
  264. <div class="memitem">
  265. <div class="memproto">
  266. <table class="memname">
  267. <tr>
  268. <td class="memname"><a class="el" href="classc_message.html">cMessage</a> cTradeNotes::CreatePacket </td>
  269. <td>(</td>
  270. <td class="paramname"></td>
  271. <td>&nbsp;)&nbsp;</td>
  272. <td><code> [virtual]</code></td>
  273. </tr>
  274. </table>
  275. </div>
  276. <div class="memdoc">
  277. <p>Handles the message sent for the creation of trade notes in the world.</p>
  278. <p>This function is called whenever a trade note should be created in the world for a client.</p>
  279. <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>
  280. <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
  281. </div>
  282. </div>
  283. <a class="anchor" id="a108a1b32677e2f74c256012f2c0c346a"></a><!-- doxytag: member="cTradeNotes::CreatePacketContainer" ref="a108a1b32677e2f74c256012f2c0c346a" args="(DWORD Container, DWORD ItemModelID)" -->
  284. <div class="memitem">
  285. <div class="memproto">
  286. <table class="memname">
  287. <tr>
  288. <td class="memname"><a class="el" href="classc_message.html">cMessage</a> cTradeNotes::CreatePacketContainer </td>
  289. <td>(</td>
  290. <td class="paramtype">DWORD&nbsp;</td>
  291. <td class="paramname"> <em>Container</em>, </td>
  292. </tr>
  293. <tr>
  294. <td class="paramkey"></td>
  295. <td></td>
  296. <td class="paramtype">DWORD&nbsp;</td>
  297. <td class="paramname"> <em>ItemModelID</em></td><td>&nbsp;</td>
  298. </tr>
  299. <tr>
  300. <td></td>
  301. <td>)</td>
  302. <td></td><td></td><td></td>
  303. </tr>
  304. </table>
  305. </div>
  306. <div class="memdoc">
  307. <p>Handles the message sent for the creation of trade notes in a container.</p>
  308. <p>This function is called whenever trade note should be created in the inventory of another object.</p>
  309. <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>
  310. </div>
  311. </div>
  312. <hr/>The documentation for this class was generated from the following files:<ul>
  313. <li>E:/uas2/Server/<a class="el" href="_object_8h_source.html">Object.h</a></li>
  314. <li>E:/uas2/Server/<a class="el" href="c_trade_notes_8cpp.html">cTradeNotes.cpp</a></li>
  315. </ul>
  316. </div>
  317. <hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
  318. <a href="http://www.doxygen.org/index.html">
  319. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
  320. </body>
  321. </html>