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

classc_portal_dat.html 9.6KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197
  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: cPortalDat 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>cPortalDat Class Reference</h1><!-- doxytag: class="cPortalDat" -->
  29. <p><a href="classc_portal_dat-members.html">List of all members.</a></p>
  30. <table border="0" cellpadding="0" cellspacing="0">
  31. <tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
  32. <tr><td class="memItemLeft" align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_portal_dat.html#ae8ca396f22b1f579fc434e60b7a89ae5">LoadStartingInfo</a> (<a class="el" href="classc_avatar.html">cAvatar</a> *pcAvatar)</td></tr>
  33. <tr><td class="memItemLeft" align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_portal_dat.html#a6c8107db937e73132eaded6b2666b5ce">LoadItemModel</a> (<a class="el" href="classc_object.html">cObject</a> *pcObject, DWORD dwModelID, DWORD dwColorID=0, double dblColorValue=-1)</td></tr>
  34. <tr><td class="memItemLeft" align="right" valign="top">static int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_portal_dat.html#a940524424142a7d06f770be36f68355b">CalcPalette</a> (int numPalettes, double palValue=-1)</td></tr>
  35. <tr><td class="memItemLeft" align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classc_portal_dat.html#a3f390fc24d3d6d64194239e4d38fbbb2">Load_PortalDat</a> (UCHAR *&amp;buf, char file[9])</td></tr>
  36. </table>
  37. <hr/><h2>Member Function Documentation</h2>
  38. <a class="anchor" id="a940524424142a7d06f770be36f68355b"></a><!-- doxytag: member="cPortalDat::CalcPalette" ref="a940524424142a7d06f770be36f68355b" args="(int numPalettes, double palValue=&#45;1)" -->
  39. <div class="memitem">
  40. <div class="memproto">
  41. <table class="memname">
  42. <tr>
  43. <td class="memname">int cPortalDat::CalcPalette </td>
  44. <td>(</td>
  45. <td class="paramtype">int&nbsp;</td>
  46. <td class="paramname"> <em>numPalettes</em>, </td>
  47. </tr>
  48. <tr>
  49. <td class="paramkey"></td>
  50. <td></td>
  51. <td class="paramtype">double&nbsp;</td>
  52. <td class="paramname"> <em>palValue</em> = <code>-1</code></td><td>&nbsp;</td>
  53. </tr>
  54. <tr>
  55. <td></td>
  56. <td>)</td>
  57. <td></td><td></td><td><code> [static]</code></td>
  58. </tr>
  59. </table>
  60. </div>
  61. <div class="memdoc">
  62. <p>Determines the CLUT (0x04000000 object in the portal.dat) to be used.</p>
  63. <p>The palette to use is determined by rounding the value of numPalettes minus one (as the palettes are zero-indexed) multiplied by the palValue value.</p>
  64. <dl><dt><b>Parameters:</b></dt><dd>
  65. <table border="0" cellspacing="2" cellpadding="0">
  66. <tr><td valign="top"></td><td valign="top"><em>numPalettes</em>&nbsp;</td><td>- The number of palettes in the palette list. </td></tr>
  67. <tr><td valign="top"></td><td valign="top"><em>palValue</em>&nbsp;</td><td>- The shading value used to determine the palette (between 0 and 1).</td></tr>
  68. </table>
  69. </dd>
  70. </dl>
  71. <dl class="return"><dt><b>Returns:</b></dt><dd>palette - The palette index (beginning with 0) to use. </dd></dl>
  72. </div>
  73. </div>
  74. <a class="anchor" id="a3f390fc24d3d6d64194239e4d38fbbb2"></a><!-- doxytag: member="cPortalDat::Load_PortalDat" ref="a3f390fc24d3d6d64194239e4d38fbbb2" args="(UCHAR *&amp;buf, char file[9])" -->
  75. <div class="memitem">
  76. <div class="memproto">
  77. <table class="memname">
  78. <tr>
  79. <td class="memname">static void cPortalDat::Load_PortalDat </td>
  80. <td>(</td>
  81. <td class="paramtype">UCHAR *&amp;&nbsp;</td>
  82. <td class="paramname"> <em>buf</em>, </td>
  83. </tr>
  84. <tr>
  85. <td class="paramkey"></td>
  86. <td></td>
  87. <td class="paramtype">char&nbsp;</td>
  88. <td class="paramname"> <em>file</em>[9]</td><td>&nbsp;</td>
  89. </tr>
  90. <tr>
  91. <td></td>
  92. <td>)</td>
  93. <td></td><td></td><td><code> [inline, static]</code></td>
  94. </tr>
  95. </table>
  96. </div>
  97. <div class="memdoc">
  98. <p>Loads the portal.dat information for the specified file.</p>
  99. <p>Calls FetchPortalFilePos to find a file's position. Calls FetchPortalFile to fetch a file from its found position.</p>
  100. <dl><dt><b>Parameters:</b></dt><dd>
  101. <table border="0" cellspacing="2" cellpadding="0">
  102. <tr><td valign="top"></td><td valign="top"><em>&amp;buf</em>&nbsp;</td><td>- The address of the buffer that should receive the file information. </td></tr>
  103. <tr><td valign="top"></td><td valign="top"><em>file</em>&nbsp;</td><td>- The file to be loaded from the portal.dat. </td></tr>
  104. </table>
  105. </dd>
  106. </dl>
  107. </div>
  108. </div>
  109. <a class="anchor" id="a6c8107db937e73132eaded6b2666b5ce"></a><!-- doxytag: member="cPortalDat::LoadItemModel" ref="a6c8107db937e73132eaded6b2666b5ce" args="(cObject *pcObject, DWORD dwModelID, DWORD dwColorID=0, double dblColorValue=&#45;1)" -->
  110. <div class="memitem">
  111. <div class="memproto">
  112. <table class="memname">
  113. <tr>
  114. <td class="memname">void cPortalDat::LoadItemModel </td>
  115. <td>(</td>
  116. <td class="paramtype"><a class="el" href="classc_object.html">cObject</a> *&nbsp;</td>
  117. <td class="paramname"> <em>pcObject</em>, </td>
  118. </tr>
  119. <tr>
  120. <td class="paramkey"></td>
  121. <td></td>
  122. <td class="paramtype">DWORD&nbsp;</td>
  123. <td class="paramname"> <em>dwModelID</em>, </td>
  124. </tr>
  125. <tr>
  126. <td class="paramkey"></td>
  127. <td></td>
  128. <td class="paramtype">DWORD&nbsp;</td>
  129. <td class="paramname"> <em>dwColorID</em> = <code>0</code>, </td>
  130. </tr>
  131. <tr>
  132. <td class="paramkey"></td>
  133. <td></td>
  134. <td class="paramtype">double&nbsp;</td>
  135. <td class="paramname"> <em>dblColorValue</em> = <code>-1</code></td><td>&nbsp;</td>
  136. </tr>
  137. <tr>
  138. <td></td>
  139. <td>)</td>
  140. <td></td><td></td><td><code> [static]</code></td>
  141. </tr>
  142. </table>
  143. </div>
  144. <div class="memdoc">
  145. <p>Handles the loading of item models (palette, texture, and model information).</p>
  146. <p>Called whenever an object's p/t/m information should be initialized or updated.</p>
  147. <dl><dt><b>Parameters:</b></dt><dd>
  148. <table border="0" cellspacing="2" cellpadding="0">
  149. <tr><td valign="top"></td><td valign="top"><em>*pcObject</em>&nbsp;</td><td>- A pointer to the object whose p/t/m information will be initialized or updated. </td></tr>
  150. <tr><td valign="top"></td><td valign="top"><em>dwModelID</em>&nbsp;</td><td>- The item model to be used (world, male, female) for the object. </td></tr>
  151. <tr><td valign="top"></td><td valign="top"><em>dwColorID</em>&nbsp;</td><td>- The color of the object. </td></tr>
  152. <tr><td valign="top"></td><td valign="top"><em>dblColorValue</em>&nbsp;</td><td>- The color shade of the object. </td></tr>
  153. </table>
  154. </dd>
  155. </dl>
  156. </div>
  157. </div>
  158. <a class="anchor" id="ae8ca396f22b1f579fc434e60b7a89ae5"></a><!-- doxytag: member="cPortalDat::LoadStartingInfo" ref="ae8ca396f22b1f579fc434e60b7a89ae5" args="(cAvatar *pcAvatar)" -->
  159. <div class="memitem">
  160. <div class="memproto">
  161. <table class="memname">
  162. <tr>
  163. <td class="memname">void cPortalDat::LoadStartingInfo </td>
  164. <td>(</td>
  165. <td class="paramtype"><a class="el" href="classc_avatar.html">cAvatar</a> *&nbsp;</td>
  166. <td class="paramname"> <em>pcAvatar</em></td>
  167. <td>&nbsp;)&nbsp;</td>
  168. <td><code> [static]</code></td>
  169. </tr>
  170. </table>
  171. </div>
  172. <div class="memdoc">
  173. <p>Navigates the Character Creation Information (0x0E000002) file in the portal.dat. This file contains the starting locations, race- and gender-specific clothing and color selections, and the male and female palette, texture, and model information. This model information includes the female/male models, skin shade, hair color, hair shade, hair style, eye color, forehead style, chin style, and nose style.</p>
  174. <dl><dt><b>Parameters:</b></dt><dd>
  175. <table border="0" cellspacing="2" cellpadding="0">
  176. <tr><td valign="top"></td><td valign="top"><em>*pcAvatar</em>&nbsp;</td><td>- A pointer to the avatar whose information should be loaded or updated.</td></tr>
  177. </table>
  178. </dd>
  179. </dl>
  180. <p>Author: eLeM </p>
  181. </div>
  182. </div>
  183. <hr/>The documentation for this class was generated from the following files:<ul>
  184. <li>E:/uas2/Server/<a class="el" href="_dat_file_8h_source.html">DatFile.h</a></li>
  185. <li>E:/uas2/Server/<a class="el" href="_dat_file_8cpp.html">DatFile.cpp</a></li>
  186. </ul>
  187. </div>
  188. <hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
  189. <a href="http://www.doxygen.org/index.html">
  190. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
  191. </body>
  192. </html>