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

classc_scrolls.html 15KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308
  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: cScrolls 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>cScrolls Class Reference</h1><!-- doxytag: class="cScrolls" --><!-- doxytag: inherits="cObject" --><div class="dynheader">
  29. Inheritance diagram for cScrolls:</div>
  30. <div class="dynsection">
  31. <div class="center">
  32. <img src="classc_scrolls.png" usemap="#cScrolls_map" alt=""/>
  33. <map id="cScrolls_map" name="cScrolls_map">
  34. <area href="classc_object.html" alt="cObject" shape="rect" coords="0,0,58,24"/>
  35. </map>
  36. </div>
  37. </div>
  38. <p><a href="classc_scrolls-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_scrolls.html#a243331d90851ce7a197428559af49ff1">cScrolls</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_scrolls.html#a5747c876c0f35af12ed594f32a0c99d5">cScrolls</a> (DWORD dwGUID, DWORD Container, DWORD dwModel, float flScale, BOOL fSolid, DWORD dwIcon, std::string strName, std::string strDescription)</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_scrolls.html#af703d42585d28116840af9f6981b5a5a">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_scrolls.html#add9f95f2c0c83746d0e1decb8d1b95fa">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_scrolls.html#a8865ea39e17cba9a4cc4e10d7c1f2e6b">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_scrolls.html#ae5c35c6b858303e0248a0772ef228f6d">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="aa018f5ffe9c2ad3e3e34a7f0681efe8d"></a><!-- doxytag: member="cScrolls::GetItemModelID" ref="aa018f5ffe9c2ad3e3e34a7f0681efe8d" 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="a9ddf5c16d9091e7249d858b7a2865d02"></a><!-- doxytag: member="cScrolls::GetContainerID" ref="a9ddf5c16d9091e7249d858b7a2865d02" 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="a87e20626db30b50a22d109d0af33477f"></a><!-- doxytag: member="cScrolls::m_dwItemModelID" ref="a87e20626db30b50a22d109d0af33477f" 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="aa12e757c595ad3d08d5229037b5fbfd0"></a><!-- doxytag: member="cScrolls::m_dwWeight" ref="aa12e757c595ad3d08d5229037b5fbfd0" 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="aa32f5097cc3c737a99e8495cb2f6f19e"></a><!-- doxytag: member="cScrolls::m_dwValue" ref="aa32f5097cc3c737a99e8495cb2f6f19e" 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="a3d03985938d3b7657a50430b300c6ba5"></a><!-- doxytag: member="cScrolls::m_fIsStackable" ref="a3d03985938d3b7657a50430b300c6ba5" 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="aad713a6af717e7346e6ce26e2f014db4"></a><!-- doxytag: member="cScrolls::m_fEquippable" ref="aad713a6af717e7346e6ce26e2f014db4" 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="aabff04095b70d94df7add0e362f4e4ff"></a><!-- doxytag: member="cScrolls::m_fIsSolid" ref="aabff04095b70d94df7add0e362f4e4ff" 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="a1b551f9b5a6224c2126ae4b7db85aea9"></a><!-- doxytag: member="cScrolls::m_strDescription" ref="a1b551f9b5a6224c2126ae4b7db85aea9" 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="a243331d90851ce7a197428559af49ff1"></a><!-- doxytag: member="cScrolls::cScrolls" ref="a243331d90851ce7a197428559af49ff1" args="(DWORD dwGUID, cLocation &amp;Loc, DWORD dwModel, float flScale, BOOL fSolid, DWORD dwIcon, std::string strName, std::string strDescription)" -->
  70. <div class="memitem">
  71. <div class="memproto">
  72. <table class="memname">
  73. <tr>
  74. <td class="memname">cScrolls::cScrolls </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><td>&nbsp;</td>
  120. </tr>
  121. <tr>
  122. <td></td>
  123. <td>)</td>
  124. <td></td><td></td><td><code> [inline]</code></td>
  125. </tr>
  126. </table>
  127. </div>
  128. <div class="memdoc">
  129. <p>A constructor.</p>
  130. <p>Called whenever a scroll object is initialized in the world. </p>
  131. </div>
  132. </div>
  133. <a class="anchor" id="a5747c876c0f35af12ed594f32a0c99d5"></a><!-- doxytag: member="cScrolls::cScrolls" ref="a5747c876c0f35af12ed594f32a0c99d5" args="(DWORD dwGUID, DWORD Container, DWORD dwModel, float flScale, BOOL fSolid, DWORD dwIcon, std::string strName, std::string strDescription)" -->
  134. <div class="memitem">
  135. <div class="memproto">
  136. <table class="memname">
  137. <tr>
  138. <td class="memname">cScrolls::cScrolls </td>
  139. <td>(</td>
  140. <td class="paramtype">DWORD&nbsp;</td>
  141. <td class="paramname"> <em>dwGUID</em>, </td>
  142. </tr>
  143. <tr>
  144. <td class="paramkey"></td>
  145. <td></td>
  146. <td class="paramtype">DWORD&nbsp;</td>
  147. <td class="paramname"> <em>Container</em>, </td>
  148. </tr>
  149. <tr>
  150. <td class="paramkey"></td>
  151. <td></td>
  152. <td class="paramtype">DWORD&nbsp;</td>
  153. <td class="paramname"> <em>dwModel</em>, </td>
  154. </tr>
  155. <tr>
  156. <td class="paramkey"></td>
  157. <td></td>
  158. <td class="paramtype">float&nbsp;</td>
  159. <td class="paramname"> <em>flScale</em>, </td>
  160. </tr>
  161. <tr>
  162. <td class="paramkey"></td>
  163. <td></td>
  164. <td class="paramtype">BOOL&nbsp;</td>
  165. <td class="paramname"> <em>fSolid</em>, </td>
  166. </tr>
  167. <tr>
  168. <td class="paramkey"></td>
  169. <td></td>
  170. <td class="paramtype">DWORD&nbsp;</td>
  171. <td class="paramname"> <em>dwIcon</em>, </td>
  172. </tr>
  173. <tr>
  174. <td class="paramkey"></td>
  175. <td></td>
  176. <td class="paramtype">std::string&nbsp;</td>
  177. <td class="paramname"> <em>strName</em>, </td>
  178. </tr>
  179. <tr>
  180. <td class="paramkey"></td>
  181. <td></td>
  182. <td class="paramtype">std::string&nbsp;</td>
  183. <td class="paramname"> <em>strDescription</em></td><td>&nbsp;</td>
  184. </tr>
  185. <tr>
  186. <td></td>
  187. <td>)</td>
  188. <td></td><td></td><td><code> [inline]</code></td>
  189. </tr>
  190. </table>
  191. </div>
  192. <div class="memdoc">
  193. <p>A constructor.</p>
  194. <p>Called whenever a scroll object is initialized in a container. </p>
  195. </div>
  196. </div>
  197. <hr/><h2>Member Function Documentation</h2>
  198. <a class="anchor" id="ae5c35c6b858303e0248a0772ef228f6d"></a><!-- doxytag: member="cScrolls::Action" ref="ae5c35c6b858303e0248a0772ef228f6d" args="(cClient *who)" -->
  199. <div class="memitem">
  200. <div class="memproto">
  201. <table class="memname">
  202. <tr>
  203. <td class="memname">void cScrolls::Action </td>
  204. <td>(</td>
  205. <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> *&nbsp;</td>
  206. <td class="paramname"> <em>who</em></td>
  207. <td>&nbsp;)&nbsp;</td>
  208. <td><code> [virtual]</code></td>
  209. </tr>
  210. </table>
  211. </div>
  212. <div class="memdoc">
  213. <p>Handles the actions of scroll objects.</p>
  214. <p>This function is called whenever a scroll is used or should perform an action. </p>
  215. <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
  216. </div>
  217. </div>
  218. <a class="anchor" id="a8865ea39e17cba9a4cc4e10d7c1f2e6b"></a><!-- doxytag: member="cScrolls::Assess" ref="a8865ea39e17cba9a4cc4e10d7c1f2e6b" args="(cClient *pcAssesser)" -->
  219. <div class="memitem">
  220. <div class="memproto">
  221. <table class="memname">
  222. <tr>
  223. <td class="memname">void cScrolls::Assess </td>
  224. <td>(</td>
  225. <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> *&nbsp;</td>
  226. <td class="paramname"> <em>pcAssesser</em></td>
  227. <td>&nbsp;)&nbsp;</td>
  228. <td><code> [virtual]</code></td>
  229. </tr>
  230. </table>
  231. </div>
  232. <div class="memdoc">
  233. <p>Handles the assessment of scroll objects.</p>
  234. <p>This function is called whenever a scroll is assessed by a client.</p>
  235. <p>Returns a Game Event (0x0000F7B0) server message of type Identify Object (0x000000C9). </p>
  236. <p>Reimplemented from <a class="el" href="classc_object.html">cObject</a>.</p>
  237. </div>
  238. </div>
  239. <a class="anchor" id="af703d42585d28116840af9f6981b5a5a"></a><!-- doxytag: member="cScrolls::CreatePacket" ref="af703d42585d28116840af9f6981b5a5a" args="()" -->
  240. <div class="memitem">
  241. <div class="memproto">
  242. <table class="memname">
  243. <tr>
  244. <td class="memname"><a class="el" href="classc_message.html">cMessage</a> cScrolls::CreatePacket </td>
  245. <td>(</td>
  246. <td class="paramname"></td>
  247. <td>&nbsp;)&nbsp;</td>
  248. <td><code> [virtual]</code></td>
  249. </tr>
  250. </table>
  251. </div>
  252. <div class="memdoc">
  253. <p>Handles the message sent for the creation of scrolls in the world.</p>
  254. <p>This function is called whenever a scroll should be created in the world for a client.</p>
  255. <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>
  256. <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
  257. </div>
  258. </div>
  259. <a class="anchor" id="add9f95f2c0c83746d0e1decb8d1b95fa"></a><!-- doxytag: member="cScrolls::CreatePacketContainer" ref="add9f95f2c0c83746d0e1decb8d1b95fa" args="(DWORD Container, DWORD ItemModelID)" -->
  260. <div class="memitem">
  261. <div class="memproto">
  262. <table class="memname">
  263. <tr>
  264. <td class="memname"><a class="el" href="classc_message.html">cMessage</a> cScrolls::CreatePacketContainer </td>
  265. <td>(</td>
  266. <td class="paramtype">DWORD&nbsp;</td>
  267. <td class="paramname"> <em>Container</em>, </td>
  268. </tr>
  269. <tr>
  270. <td class="paramkey"></td>
  271. <td></td>
  272. <td class="paramtype">DWORD&nbsp;</td>
  273. <td class="paramname"> <em>ItemModelID</em></td><td>&nbsp;</td>
  274. </tr>
  275. <tr>
  276. <td></td>
  277. <td>)</td>
  278. <td></td><td></td><td></td>
  279. </tr>
  280. </table>
  281. </div>
  282. <div class="memdoc">
  283. <p>Handles the message sent for the creation of scrolls in a container.</p>
  284. <p>This function is called whenever a scroll should be created in the inventory of another object.</p>
  285. <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>
  286. </div>
  287. </div>
  288. <hr/>The documentation for this class was generated from the following files:<ul>
  289. <li>E:/uas2/Server/<a class="el" href="_object_8h_source.html">Object.h</a></li>
  290. <li>E:/uas2/Server/<a class="el" href="c_scrolls_8cpp.html">cScrolls.cpp</a></li>
  291. </ul>
  292. </div>
  293. <hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
  294. <a href="http://www.doxygen.org/index.html">
  295. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
  296. </body>
  297. </html>