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

classc_merchant_sign.html 14KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259
  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: cMerchantSign 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>cMerchantSign Class Reference</h1><!-- doxytag: class="cMerchantSign" --><!-- doxytag: inherits="cObject" --><div class="dynheader">
  29. Inheritance diagram for cMerchantSign:</div>
  30. <div class="dynsection">
  31. <div class="center">
  32. <img src="classc_merchant_sign.png" usemap="#cMerchantSign_map" alt=""/>
  33. <map id="cMerchantSign_map" name="cMerchantSign_map">
  34. <area href="classc_object.html" alt="cObject" shape="rect" coords="0,0,98,24"/>
  35. </map>
  36. </div>
  37. </div>
  38. <p><a href="classc_merchant_sign-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_merchant_sign.html#a33ba91238604d87682a0f5c1375ce132">cMerchantSign</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, DWORD dwWeight, DWORD dwValue, BOOL fSelectable=TRUE, BOOL fEquippable=TRUE, BOOL fStackable=FALSE, BOOL fIsOwned=FALSE, DWORD dwContainer=0)</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_merchant_sign.html#a3e6da8dac0a91dbdfc79d76aaffbdc7e">CreatePacket</a> ()</td></tr>
  43. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6ede626a1fb94562b835d2e19739c957"></a><!-- doxytag: member="cMerchantSign::Animation" ref="a6ede626a1fb94562b835d2e19739c957" args="(WORD wAnim, float flPlaySpeed)" -->
  44. <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>
  45. <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_merchant_sign.html#a4139eeed33bb33fe3dd8ade902d6094c">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_merchant_sign.html#a3df1a0e086eefceddd3eda3372dcc1ad">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="a5dd44cc0ae89e3f1a1e37ab9a800a1d6"></a><!-- doxytag: member="cMerchantSign::GetWorldObject" ref="a5dd44cc0ae89e3f1a1e37ab9a800a1d6" args="()" -->
  48. DWORD&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetWorldObject</b> ()</td></tr>
  49. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a99f8d850c1d6c9467102e863f043c869"></a><!-- doxytag: member="cMerchantSign::SetObjectType" ref="a99f8d850c1d6c9467102e863f043c869" args="(int ot)" -->
  50. void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetObjectType</b> (int ot)</td></tr>
  51. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a443b33f6728623253d0bcfa414504001"></a><!-- doxytag: member="cMerchantSign::GetObjectType" ref="a443b33f6728623253d0bcfa414504001" args="()" -->
  52. int&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetObjectType</b> ()</td></tr>
  53. <tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
  54. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a79fc8400f680f5e73bc4da0be971e49e"></a><!-- doxytag: member="cMerchantSign::iObjectType" ref="a79fc8400f680f5e73bc4da0be971e49e" args="" -->
  55. int&nbsp;</td><td class="memItemRight" valign="bottom"><b>iObjectType</b></td></tr>
  56. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a60451c26b2a80682fd5b3d54222bdf58"></a><!-- doxytag: member="cMerchantSign::m_dwWOModelID" ref="a60451c26b2a80682fd5b3d54222bdf58" args="" -->
  57. DWORD&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_dwWOModelID</b></td></tr>
  58. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1b50789cca93312555598d0acb35699d"></a><!-- doxytag: member="cMerchantSign::m_dwWeight" ref="a1b50789cca93312555598d0acb35699d" 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="a4adfbb51b47bc718f31c2caea3516a68"></a><!-- doxytag: member="cMerchantSign::m_dwValue" ref="a4adfbb51b47bc718f31c2caea3516a68" 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="a1f11f8d92b17326831e9dda89b7eb0c7"></a><!-- doxytag: member="cMerchantSign::m_fIsStackable" ref="a1f11f8d92b17326831e9dda89b7eb0c7" args="" -->
  63. BOOL&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_fIsStackable</b></td></tr>
  64. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab0f72e2fe2dd3b3390b9e3ffbf8437b7"></a><!-- doxytag: member="cMerchantSign::m_fEquippable" ref="ab0f72e2fe2dd3b3390b9e3ffbf8437b7" args="" -->
  65. BOOL&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_fEquippable</b></td></tr>
  66. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0f13ea944423f1a4fea3e9dcf6a22ea9"></a><!-- doxytag: member="cMerchantSign::m_fIsSolid" ref="a0f13ea944423f1a4fea3e9dcf6a22ea9" args="" -->
  67. BOOL&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_fIsSolid</b></td></tr>
  68. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2940f15a1af00d4ee937d15cc52a87b0"></a><!-- doxytag: member="cMerchantSign::m_strDescription" ref="a2940f15a1af00d4ee937d15cc52a87b0" args="" -->
  69. std::string&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_strDescription</b></td></tr>
  70. </table>
  71. <hr/><h2>Constructor &amp; Destructor Documentation</h2>
  72. <a class="anchor" id="a33ba91238604d87682a0f5c1375ce132"></a><!-- doxytag: member="cMerchantSign::cMerchantSign" ref="a33ba91238604d87682a0f5c1375ce132" args="(DWORD dwGUID, cLocation &amp;Loc, DWORD dwModel, float flScale, BOOL fSolid, DWORD dwIcon, std::string strName, std::string strDescription, DWORD dwWeight, DWORD dwValue, BOOL fSelectable=TRUE, BOOL fEquippable=TRUE, BOOL fStackable=FALSE, BOOL fIsOwned=FALSE, DWORD dwContainer=0)" -->
  73. <div class="memitem">
  74. <div class="memproto">
  75. <table class="memname">
  76. <tr>
  77. <td class="memname">cMerchantSign::cMerchantSign </td>
  78. <td>(</td>
  79. <td class="paramtype">DWORD&nbsp;</td>
  80. <td class="paramname"> <em>dwGUID</em>, </td>
  81. </tr>
  82. <tr>
  83. <td class="paramkey"></td>
  84. <td></td>
  85. <td class="paramtype"><a class="el" href="structc_location.html">cLocation</a> &amp;&nbsp;</td>
  86. <td class="paramname"> <em>Loc</em>, </td>
  87. </tr>
  88. <tr>
  89. <td class="paramkey"></td>
  90. <td></td>
  91. <td class="paramtype">DWORD&nbsp;</td>
  92. <td class="paramname"> <em>dwModel</em>, </td>
  93. </tr>
  94. <tr>
  95. <td class="paramkey"></td>
  96. <td></td>
  97. <td class="paramtype">float&nbsp;</td>
  98. <td class="paramname"> <em>flScale</em>, </td>
  99. </tr>
  100. <tr>
  101. <td class="paramkey"></td>
  102. <td></td>
  103. <td class="paramtype">BOOL&nbsp;</td>
  104. <td class="paramname"> <em>fSolid</em>, </td>
  105. </tr>
  106. <tr>
  107. <td class="paramkey"></td>
  108. <td></td>
  109. <td class="paramtype">DWORD&nbsp;</td>
  110. <td class="paramname"> <em>dwIcon</em>, </td>
  111. </tr>
  112. <tr>
  113. <td class="paramkey"></td>
  114. <td></td>
  115. <td class="paramtype">std::string&nbsp;</td>
  116. <td class="paramname"> <em>strName</em>, </td>
  117. </tr>
  118. <tr>
  119. <td class="paramkey"></td>
  120. <td></td>
  121. <td class="paramtype">std::string&nbsp;</td>
  122. <td class="paramname"> <em>strDescription</em>, </td>
  123. </tr>
  124. <tr>
  125. <td class="paramkey"></td>
  126. <td></td>
  127. <td class="paramtype">DWORD&nbsp;</td>
  128. <td class="paramname"> <em>dwWeight</em>, </td>
  129. </tr>
  130. <tr>
  131. <td class="paramkey"></td>
  132. <td></td>
  133. <td class="paramtype">DWORD&nbsp;</td>
  134. <td class="paramname"> <em>dwValue</em>, </td>
  135. </tr>
  136. <tr>
  137. <td class="paramkey"></td>
  138. <td></td>
  139. <td class="paramtype">BOOL&nbsp;</td>
  140. <td class="paramname"> <em>fSelectable</em> = <code>TRUE</code>, </td>
  141. </tr>
  142. <tr>
  143. <td class="paramkey"></td>
  144. <td></td>
  145. <td class="paramtype">BOOL&nbsp;</td>
  146. <td class="paramname"> <em>fEquippable</em> = <code>TRUE</code>, </td>
  147. </tr>
  148. <tr>
  149. <td class="paramkey"></td>
  150. <td></td>
  151. <td class="paramtype">BOOL&nbsp;</td>
  152. <td class="paramname"> <em>fStackable</em> = <code>FALSE</code>, </td>
  153. </tr>
  154. <tr>
  155. <td class="paramkey"></td>
  156. <td></td>
  157. <td class="paramtype">BOOL&nbsp;</td>
  158. <td class="paramname"> <em>fIsOwned</em> = <code>FALSE</code>, </td>
  159. </tr>
  160. <tr>
  161. <td class="paramkey"></td>
  162. <td></td>
  163. <td class="paramtype">DWORD&nbsp;</td>
  164. <td class="paramname"> <em>dwContainer</em> = <code>0</code></td><td>&nbsp;</td>
  165. </tr>
  166. <tr>
  167. <td></td>
  168. <td>)</td>
  169. <td></td><td></td><td><code> [inline]</code></td>
  170. </tr>
  171. </table>
  172. </div>
  173. <div class="memdoc">
  174. <p>A constructor.</p>
  175. <p>Called whenever a merchant sign object is initialized. </p>
  176. </div>
  177. </div>
  178. <hr/><h2>Member Function Documentation</h2>
  179. <a class="anchor" id="a3df1a0e086eefceddd3eda3372dcc1ad"></a><!-- doxytag: member="cMerchantSign::Action" ref="a3df1a0e086eefceddd3eda3372dcc1ad" args="(cClient *who)" -->
  180. <div class="memitem">
  181. <div class="memproto">
  182. <table class="memname">
  183. <tr>
  184. <td class="memname">void cMerchantSign::Action </td>
  185. <td>(</td>
  186. <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> *&nbsp;</td>
  187. <td class="paramname"> <em>who</em></td>
  188. <td>&nbsp;)&nbsp;</td>
  189. <td><code> [virtual]</code></td>
  190. </tr>
  191. </table>
  192. </div>
  193. <div class="memdoc">
  194. <p>Handles the actions of merchant sign objects.</p>
  195. <p>This function is called whenever a merchant sign is used or should perform an action. </p>
  196. <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
  197. </div>
  198. </div>
  199. <a class="anchor" id="a4139eeed33bb33fe3dd8ade902d6094c"></a><!-- doxytag: member="cMerchantSign::Assess" ref="a4139eeed33bb33fe3dd8ade902d6094c" args="(cClient *pcAssesser)" -->
  200. <div class="memitem">
  201. <div class="memproto">
  202. <table class="memname">
  203. <tr>
  204. <td class="memname">void cMerchantSign::Assess </td>
  205. <td>(</td>
  206. <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> *&nbsp;</td>
  207. <td class="paramname"> <em>pcAssesser</em></td>
  208. <td>&nbsp;)&nbsp;</td>
  209. <td><code> [virtual]</code></td>
  210. </tr>
  211. </table>
  212. </div>
  213. <div class="memdoc">
  214. <p>Handles the assessment of merchant sign objects.</p>
  215. <p>This function is called whenever a merchant sign is assessed by a client.</p>
  216. <p>Returns a Game Event (0x0000F7B0) server message of type Identify Object (0x000000C9). </p>
  217. <p>Reimplemented from <a class="el" href="classc_object.html">cObject</a>.</p>
  218. </div>
  219. </div>
  220. <a class="anchor" id="a3e6da8dac0a91dbdfc79d76aaffbdc7e"></a><!-- doxytag: member="cMerchantSign::CreatePacket" ref="a3e6da8dac0a91dbdfc79d76aaffbdc7e" args="()" -->
  221. <div class="memitem">
  222. <div class="memproto">
  223. <table class="memname">
  224. <tr>
  225. <td class="memname"><a class="el" href="classc_message.html">cMessage</a> cMerchantSign::CreatePacket </td>
  226. <td>(</td>
  227. <td class="paramname"></td>
  228. <td>&nbsp;)&nbsp;</td>
  229. <td><code> [virtual]</code></td>
  230. </tr>
  231. </table>
  232. </div>
  233. <div class="memdoc">
  234. <p>Handles the creation of merchant signs.</p>
  235. <p>Called whenever a merchant sign object should be initialized.</p>
  236. <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>
  237. <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
  238. </div>
  239. </div>
  240. <hr/>The documentation for this class was generated from the following files:<ul>
  241. <li>E:/uas2/Server/<a class="el" href="_object_8h_source.html">Object.h</a></li>
  242. <li>E:/uas2/Server/<a class="el" href="c_merchant_sign_8cpp.html">cMerchantSign.cpp</a></li>
  243. <li>E:/uas2/Server/<a class="el" href="world__object2_8cpp.html">world_object2.cpp</a></li>
  244. </ul>
  245. </div>
  246. <hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
  247. <a href="http://www.doxygen.org/index.html">
  248. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
  249. </body>
  250. </html>