Accueil Explorer Aide
Connexion
ac
/
uas2
miroir de https://github.com/drudgedance/uas2
Suivre 2
Voter 0
Fork 0
Code Tickets 0 Commits 4 Publications 0 Wiki

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

Aborescence: 6eb8ebcdd4
Branches Tags
uas2
/
Documentation
/
html
/
classc_books...

classc_books.html 15KB
Historique Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <title>UAS2: cBooks Class Reference</title>
    6. 

  6. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    7. 

  7. <link href="doxygen.css" rel="stylesheet" type="text/css"/>
    8. 

  8. </head>
    9. 

  9. <body>
    10. 

  10. <!-- Generated by Doxygen 1.6.2 -->
    11. 

  11. <div class="navigation" id="top">
    12. 

  12.   <div class="tabs">
    13. 

  13.     <ul>
    14. 

  14.       <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
    15. 

  15.       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
    16. 

  16.       <li><a href="files.html"><span>Files</span></a></li>
    17. 

  17.     </ul>
    18. 

  18.   </div>
    19. 

  19.   <div class="tabs">
    20. 

  20.     <ul>
    21. 

  21.       <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    22. 

  22.       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    23. 

  23.       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    24. 

  24.     </ul>
    25. 

  25.   </div>
    26. 

  26. </div>
    27. 

  27. <div class="contents">
    28. 

  28. <h1>cBooks Class Reference</h1><!-- doxytag: class="cBooks" --><!-- doxytag: inherits="cObject" --><div class="dynheader">
    29. 

  29. Inheritance diagram for cBooks:</div>
    30. 

  30. <div class="dynsection">
    31. 

  31.  <div class="center">
    32. 

  32.   <img src="classc_books.png" usemap="#cBooks_map" alt=""/>
    33. 

  33.   <map id="cBooks_map" name="cBooks_map">
    34. 

  34. <area href="classc_object.html" alt="cObject" shape="rect" coords="0,0,56,24"/>
    35. 

  35. </map>
    36. 

  36.  </div>
    37. 

  37. </div>
    38. 

  38. 

  39. <p><a href="classc_books-members.html">List of all members.</a></p>
    40. 

  40. <table border="0" cellpadding="0" cellspacing="0">
    41. 

  41. <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
    42. 

  42. <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_books.html#af3383046cf9fba77af3d4f98e6867fdd">cBooks</a> (DWORD dwGUID, <a class="el" href="structc_location.html">cLocation</a> &amp;Loc, DWORD dwModel, WORD wIcon, std::string strName, std::string strDescription)</td></tr>
    43. 

  43. <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_books.html#ab1e4f9db06ee8332b56cf3e67a4bc0f9">cBooks</a> (DWORD dwGUID, DWORD dwContainer, DWORD dwModel, WORD wIcon, std::string strName, std::string strDescription, DWORD dwValue, WORD wBurden)</td></tr>
    44. 

  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_books.html#a9376afe31c1a47b613aee60d64fd5baa">CreatePacket</a> ()</td></tr>
    45. 

  45. <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_books.html#a607b564dd7512863e8d036556a1262bd">CreatePacketContainer</a> (DWORD Container, DWORD ItemModelID)</td></tr>
    46. 

  46. <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_books.html#a3a3c64348af1972aca69d182b2c7f779">Assess</a> (<a class="el" href="classc_client.html">cClient</a> *pcAssesser)</td></tr>
    47. 

  47. <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_books.html#abb2a47a0b494927930729deef92dfe4c">Action</a> (<a class="el" href="classc_client.html">cClient</a> *who)</td></tr>
    48. 

  48. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9e5a56efb33757f9bdbbd02732a74bee"></a><!-- doxytag: member="cBooks::Read" ref="a9e5a56efb33757f9bdbbd02732a74bee" args="(cClient *who, DWORD GUID, DWORD PageNumber)" -->
    49. 

  49. void&nbsp;</td><td class="memItemRight" valign="bottom"><b>Read</b> (<a class="el" href="classc_client.html">cClient</a> *who, DWORD GUID, DWORD PageNumber)</td></tr>
    50. 

  50. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a64e36acf1269db32d13f7d5de9a5fe47"></a><!-- doxytag: member="cBooks::GetItemModelID" ref="a64e36acf1269db32d13f7d5de9a5fe47" args="()" -->
    51. 

  51. DWORD&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetItemModelID</b> ()</td></tr>
    52. 

  52. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab906929dbdcbed20eb92d0fdebb166a6"></a><!-- doxytag: member="cBooks::GetContainerID" ref="ab906929dbdcbed20eb92d0fdebb166a6" args="()" -->
    53. 

  53. DWORD&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetContainerID</b> ()</td></tr>
    54. 

  54. <tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
    55. 

  55. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a06e4980c446107078a1582f872542b8e"></a><!-- doxytag: member="cBooks::m_dwItemModelID" ref="a06e4980c446107078a1582f872542b8e" args="" -->
    56. 

  56. DWORD&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_dwItemModelID</b></td></tr>
    57. 

  57. <tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
    58. 

  58. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a65c06fbe76a1e41eafeaa21f98f8472e"></a><!-- doxytag: member="cBooks::m_wBurden" ref="a65c06fbe76a1e41eafeaa21f98f8472e" args="" -->
    59. 

  59. WORD&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_wBurden</b></td></tr>
    60. 

  60. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a502f4047656d18645d4d082b57752f74"></a><!-- doxytag: member="cBooks::m_dwValue" ref="a502f4047656d18645d4d082b57752f74" args="" -->
    61. 

  61. DWORD&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_dwValue</b></td></tr>
    62. 

  62. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aab75d834e01f21940684f88be85ca87c"></a><!-- doxytag: member="cBooks::m_fIsStackable" ref="aab75d834e01f21940684f88be85ca87c" args="" -->
    63. 

  63. BOOL&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_fIsStackable</b></td></tr>
    64. 

  64. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a004f4970803c58ffd93b37bd239c9977"></a><!-- doxytag: member="cBooks::m_fEquippable" ref="a004f4970803c58ffd93b37bd239c9977" args="" -->
    65. 

  65. BOOL&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_fEquippable</b></td></tr>
    66. 

  66. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a14af88c1c74d99bf0de97043706a0618"></a><!-- doxytag: member="cBooks::m_fIsSolid" ref="a14af88c1c74d99bf0de97043706a0618" args="" -->
    67. 

  67. BOOL&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_fIsSolid</b></td></tr>
    68. 

  68. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a91e46353a7002d4025099de26590c689"></a><!-- doxytag: member="cBooks::m_strDescription" ref="a91e46353a7002d4025099de26590c689" args="" -->
    69. 

  69. std::string&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_strDescription</b></td></tr>
    70. 

  70. </table>
    71. 

  71. <hr/><h2>Constructor &amp; Destructor Documentation</h2>
    72. 

  72. <a class="anchor" id="af3383046cf9fba77af3d4f98e6867fdd"></a><!-- doxytag: member="cBooks::cBooks" ref="af3383046cf9fba77af3d4f98e6867fdd" args="(DWORD dwGUID, cLocation &amp;Loc, DWORD dwModel, WORD wIcon, std::string strName, std::string strDescription)" -->
    73. 

  73. <div class="memitem">
    74. 

  74. <div class="memproto">
    75. 

  75.       <table class="memname">
    76. 

  76.         <tr>
    77. 

  77.           <td class="memname">cBooks::cBooks </td>
    78. 

  78.           <td>(</td>
    79. 

  79.           <td class="paramtype">DWORD&nbsp;</td>
    80. 

  80.           <td class="paramname"> <em>dwGUID</em>, </td>
    81. 

  81.         </tr>
    82. 

  82.         <tr>
    83. 

  83.           <td class="paramkey"></td>
    84. 

  84.           <td></td>
    85. 

  85.           <td class="paramtype"><a class="el" href="structc_location.html">cLocation</a> &amp;&nbsp;</td>
    86. 

  86.           <td class="paramname"> <em>Loc</em>, </td>
    87. 

  87.         </tr>
    88. 

  88.         <tr>
    89. 

  89.           <td class="paramkey"></td>
    90. 

  90.           <td></td>
    91. 

  91.           <td class="paramtype">DWORD&nbsp;</td>
    92. 

  92.           <td class="paramname"> <em>dwModel</em>, </td>
    93. 

  93.         </tr>
    94. 

  94.         <tr>
    95. 

  95.           <td class="paramkey"></td>
    96. 

  96.           <td></td>
    97. 

  97.           <td class="paramtype">WORD&nbsp;</td>
    98. 

  98.           <td class="paramname"> <em>wIcon</em>, </td>
    99. 

  99.         </tr>
    100. 

  100.         <tr>
    101. 

  101.           <td class="paramkey"></td>
    102. 

  102.           <td></td>
    103. 

  103.           <td class="paramtype">std::string&nbsp;</td>
    104. 

  104.           <td class="paramname"> <em>strName</em>, </td>
    105. 

  105.         </tr>
    106. 

  106.         <tr>
    107. 

  107.           <td class="paramkey"></td>
    108. 

  108.           <td></td>
    109. 

  109.           <td class="paramtype">std::string&nbsp;</td>
    110. 

  110.           <td class="paramname"> <em>strDescription</em></td><td>&nbsp;</td>
    111. 

  111.         </tr>
    112. 

  112.         <tr>
    113. 

  113.           <td></td>
    114. 

  114.           <td>)</td>
    115. 

  115.           <td></td><td></td><td><code> [inline]</code></td>
    116. 

  116.         </tr>
    117. 

  117.       </table>
    118. 

  118. </div>
    119. 

  119. <div class="memdoc">
    120. 

  120. <p>A constructor.</p>
    121. 

  121. <p>Called whenever a book object is initialized in the world. </p>
    122. 

  122. 

  123. </div>
    124. 

  124. </div>
    125. 

  125. <a class="anchor" id="ab1e4f9db06ee8332b56cf3e67a4bc0f9"></a><!-- doxytag: member="cBooks::cBooks" ref="ab1e4f9db06ee8332b56cf3e67a4bc0f9" args="(DWORD dwGUID, DWORD dwContainer, DWORD dwModel, WORD wIcon, std::string strName, std::string strDescription, DWORD dwValue, WORD wBurden)" -->
    126. 

  126. <div class="memitem">
    127. 

  127. <div class="memproto">
    128. 

  128.       <table class="memname">
    129. 

  129.         <tr>
    130. 

  130.           <td class="memname">cBooks::cBooks </td>
    131. 

  131.           <td>(</td>
    132. 

  132.           <td class="paramtype">DWORD&nbsp;</td>
    133. 

  133.           <td class="paramname"> <em>dwGUID</em>, </td>
    134. 

  134.         </tr>
    135. 

  135.         <tr>
    136. 

  136.           <td class="paramkey"></td>
    137. 

  137.           <td></td>
    138. 

  138.           <td class="paramtype">DWORD&nbsp;</td>
    139. 

  139.           <td class="paramname"> <em>dwContainer</em>, </td>
    140. 

  140.         </tr>
    141. 

  141.         <tr>
    142. 

  142.           <td class="paramkey"></td>
    143. 

  143.           <td></td>
    144. 

  144.           <td class="paramtype">DWORD&nbsp;</td>
    145. 

  145.           <td class="paramname"> <em>dwModel</em>, </td>
    146. 

  146.         </tr>
    147. 

  147.         <tr>
    148. 

  148.           <td class="paramkey"></td>
    149. 

  149.           <td></td>
    150. 

  150.           <td class="paramtype">WORD&nbsp;</td>
    151. 

  151.           <td class="paramname"> <em>wIcon</em>, </td>
    152. 

  152.         </tr>
    153. 

  153.         <tr>
    154. 

  154.           <td class="paramkey"></td>
    155. 

  155.           <td></td>
    156. 

  156.           <td class="paramtype">std::string&nbsp;</td>
    157. 

  157.           <td class="paramname"> <em>strName</em>, </td>
    158. 

  158.         </tr>
    159. 

  159.         <tr>
    160. 

  160.           <td class="paramkey"></td>
    161. 

  161.           <td></td>
    162. 

  162.           <td class="paramtype">std::string&nbsp;</td>
    163. 

  163.           <td class="paramname"> <em>strDescription</em>, </td>
    164. 

  164.         </tr>
    165. 

  165.         <tr>
    166. 

  166.           <td class="paramkey"></td>
    167. 

  167.           <td></td>
    168. 

  168.           <td class="paramtype">DWORD&nbsp;</td>
    169. 

  169.           <td class="paramname"> <em>dwValue</em>, </td>
    170. 

  170.         </tr>
    171. 

  171.         <tr>
    172. 

  172.           <td class="paramkey"></td>
    173. 

  173.           <td></td>
    174. 

  174.           <td class="paramtype">WORD&nbsp;</td>
    175. 

  175.           <td class="paramname"> <em>wBurden</em></td><td>&nbsp;</td>
    176. 

  176.         </tr>
    177. 

  177.         <tr>
    178. 

  178.           <td></td>
    179. 

  179.           <td>)</td>
    180. 

  180.           <td></td><td></td><td><code> [inline]</code></td>
    181. 

  181.         </tr>
    182. 

  182.       </table>
    183. 

  183. </div>
    184. 

  184. <div class="memdoc">
    185. 

  185. <p>A constructor.</p>
    186. 

  186. <p>Called whenever a book object is initialized in a container. </p>
    187. 

  187. 

  188. </div>
    189. 

  189. </div>
    190. 

  190. <hr/><h2>Member Function Documentation</h2>
    191. 

  191. <a class="anchor" id="abb2a47a0b494927930729deef92dfe4c"></a><!-- doxytag: member="cBooks::Action" ref="abb2a47a0b494927930729deef92dfe4c" args="(cClient *who)" -->
    192. 

  192. <div class="memitem">
    193. 

  193. <div class="memproto">
    194. 

  194.       <table class="memname">
    195. 

  195.         <tr>
    196. 

  196.           <td class="memname">void cBooks::Action </td>
    197. 

  197.           <td>(</td>
    198. 

  198.           <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> *&nbsp;</td>
    199. 

  199.           <td class="paramname"> <em>who</em></td>
    200. 

  200.           <td>&nbsp;)&nbsp;</td>
    201. 

  201.           <td><code> [virtual]</code></td>
    202. 

  202.         </tr>
    203. 

  203.       </table>
    204. 

  204. </div>
    205. 

  205. <div class="memdoc">
    206. 

  206. <p>Handles the actions of book objects.</p>
    207. 

  207. <p>This function is called whenever book is used or should perform an action. k109: This is the table of contents message. Reading the pages function is below </p>
    208. 

  208. 

  209. <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
    210. 

  210. 

  211. </div>
    212. 

  212. </div>
    213. 

  213. <a class="anchor" id="a3a3c64348af1972aca69d182b2c7f779"></a><!-- doxytag: member="cBooks::Assess" ref="a3a3c64348af1972aca69d182b2c7f779" args="(cClient *pcAssesser)" -->
    214. 

  214. <div class="memitem">
    215. 

  215. <div class="memproto">
    216. 

  216.       <table class="memname">
    217. 

  217.         <tr>
    218. 

  218.           <td class="memname">void cBooks::Assess </td>
    219. 

  219.           <td>(</td>
    220. 

  220.           <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> *&nbsp;</td>
    221. 

  221.           <td class="paramname"> <em>pcAssesser</em></td>
    222. 

  222.           <td>&nbsp;)&nbsp;</td>
    223. 

  223.           <td><code> [virtual]</code></td>
    224. 

  224.         </tr>
    225. 

  225.       </table>
    226. 

  226. </div>
    227. 

  227. <div class="memdoc">
    228. 

  228. <p>Handles the assessment of book objects.</p>
    229. 

  229. <p>This function is called whenever a book is assessed by a client.</p>
    230. 

  230. <p>Returns a Game Event (0x0000F7B0) server message of type Identify Object (0x000000C9). </p>
    231. 

  231. 

  232. <p>Reimplemented from <a class="el" href="classc_object.html">cObject</a>.</p>
    233. 

  233. 

  234. </div>
    235. 

  235. </div>
    236. 

  236. <a class="anchor" id="a9376afe31c1a47b613aee60d64fd5baa"></a><!-- doxytag: member="cBooks::CreatePacket" ref="a9376afe31c1a47b613aee60d64fd5baa" args="()" -->
    237. 

  237. <div class="memitem">
    238. 

  238. <div class="memproto">
    239. 

  239.       <table class="memname">
    240. 

  240.         <tr>
    241. 

  241.           <td class="memname"><a class="el" href="classc_message.html">cMessage</a> cBooks::CreatePacket </td>
    242. 

  242.           <td>(</td>
    243. 

  243.           <td class="paramname"></td>
    244. 

  244.           <td>&nbsp;)&nbsp;</td>
    245. 

  245.           <td><code> [virtual]</code></td>
    246. 

  246.         </tr>
    247. 

  247.       </table>
    248. 

  248. </div>
    249. 

  249. <div class="memdoc">
    250. 

  250. <p>Handles the message sent for the creation of books in the world.</p>
    251. 

  251. <p>This function is called whenever a book should be created in the world for a client.</p>
    252. 

  252. <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>
    253. 

  253. 

  254. <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
    255. 

  255. 

  256. </div>
    257. 

  257. </div>
    258. 

  258. <a class="anchor" id="a607b564dd7512863e8d036556a1262bd"></a><!-- doxytag: member="cBooks::CreatePacketContainer" ref="a607b564dd7512863e8d036556a1262bd" args="(DWORD Container, DWORD ItemModelID)" -->
    259. 

  259. <div class="memitem">
    260. 

  260. <div class="memproto">
    261. 

  261.       <table class="memname">
    262. 

  262.         <tr>
    263. 

  263.           <td class="memname"><a class="el" href="classc_message.html">cMessage</a> cBooks::CreatePacketContainer </td>
    264. 

  264.           <td>(</td>
    265. 

  265.           <td class="paramtype">DWORD&nbsp;</td>
    266. 

  266.           <td class="paramname"> <em>Container</em>, </td>
    267. 

  267.         </tr>
    268. 

  268.         <tr>
    269. 

  269.           <td class="paramkey"></td>
    270. 

  270.           <td></td>
    271. 

  271.           <td class="paramtype">DWORD&nbsp;</td>
    272. 

  272.           <td class="paramname"> <em>ItemModelID</em></td><td>&nbsp;</td>
    273. 

  273.         </tr>
    274. 

  274.         <tr>
    275. 

  275.           <td></td>
    276. 

  276.           <td>)</td>
    277. 

  277.           <td></td><td></td><td></td>
    278. 

  278.         </tr>
    279. 

  279.       </table>
    280. 

  280. </div>
    281. 

  281. <div class="memdoc">
    282. 

  282. <p>Handles the message sent for the creation of books in a container.</p>
    283. 

  283. <p>This function is called whenever a book should be created in the inventory of another object.</p>
    284. 

  284. <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>
    285. 

  285. 

  286. </div>
    287. 

  287. </div>
    288. 

  288. <hr/>The documentation for this class was generated from the following files:<ul>
    289. 

  289. <li>E:/uas2/Server/<a class="el" href="_object_8h_source.html">Object.h</a></li>
    290. 

  290. <li>E:/uas2/Server/<a class="el" href="c_books_8cpp.html">cBooks.cpp</a></li>
    291. 

  291. </ul>
    292. 

  292. </div>
    293. 

  293. <hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
    294. 

  294. <a href="http://www.doxygen.org/index.html">
    295. 

  295. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
    296. 

  296. </body>
    297. 

  297. </html>
    298. 

  298.