-
Notifications
You must be signed in to change notification settings - Fork 0
/
classesx_1_1_faction_form.html
304 lines (287 loc) · 14.7 KB
/
classesx_1_1_faction_form.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OpenCK: esx::FactionForm Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="openck48x48.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OpenCK
 <span id="projectnumber">0.0.alpha1</span>
</div>
<div id="projectbrief">An Open Source replacement for Bethesda's Creation Kit written in C++ in the Qt framework.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>esx</b></li><li class="navelem"><a class="el" href="classesx_1_1_faction_form.html">FactionForm</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="classesx_1_1_faction_form-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">esx::FactionForm Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for esx::FactionForm:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="classesx_1_1_faction_form.png" usemap="#esx::FactionForm_map" alt=""/>
<map id="esx::FactionForm_map" name="esx::FactionForm_map">
<area href="classesx_1_1_form.html" title="The base class for forms in .esp and .esm files. " alt="esx::Form" shape="rect" coords="0,56,108,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a05999796664ffbc30540c040434b4415"><td class="memItemLeft" align="right" valign="top"><a id="a05999796664ffbc30540c040434b4415"></a>
virtual void </td><td class="memItemRight" valign="bottom"><b>load</b> (<a class="el" href="classio_1_1_reader.html">io::Reader</a> &r)</td></tr>
<tr class="separator:a05999796664ffbc30540c040434b4415"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2e4ade9a7e760c6ebb08faf858e82deb"><td class="memItemLeft" align="right" valign="top"><a id="a2e4ade9a7e760c6ebb08faf858e82deb"></a>
virtual void </td><td class="memItemRight" valign="bottom"><b>addForm</b> ()</td></tr>
<tr class="separator:a2e4ade9a7e760c6ebb08faf858e82deb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a50fb8ca2d0db1f4ad80a8705290e2759"><td class="memItemLeft" align="right" valign="top"><a id="a50fb8ca2d0db1f4ad80a8705290e2759"></a>
virtual void </td><td class="memItemRight" valign="bottom"><b>readForm</b> ()</td></tr>
<tr class="separator:a50fb8ca2d0db1f4ad80a8705290e2759"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0255f2821ec1d4dc6eee2e6d05ddb301"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classesx_1_1_form.html#a0255f2821ec1d4dc6eee2e6d05ddb301">readHeader</a> (<a class="el" href="classio_1_1_reader.html">io::Reader</a> &r, const quint32 type)</td></tr>
<tr class="memdesc:a0255f2821ec1d4dc6eee2e6d05ddb301"><td class="mdescLeft"> </td><td class="mdescRight">Reads a record header. <a href="#a0255f2821ec1d4dc6eee2e6d05ddb301">More...</a><br /></td></tr>
<tr class="separator:a0255f2821ec1d4dc6eee2e6d05ddb301"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acb0592c52a0bbd1f93d6b50bfc06e7fa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classesx_1_1_form_header.html">FormHeader</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classesx_1_1_form.html#acb0592c52a0bbd1f93d6b50bfc06e7fa">getHeader</a> () const</td></tr>
<tr class="memdesc:acb0592c52a0bbd1f93d6b50bfc06e7fa"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve form header. <a href="#acb0592c52a0bbd1f93d6b50bfc06e7fa">More...</a><br /></td></tr>
<tr class="separator:acb0592c52a0bbd1f93d6b50bfc06e7fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a14b615f9646c060333a66c9d8a6f7a9c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structesx_1_1_subrecord_header.html">SubrecordHeader</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classesx_1_1_form.html#a14b615f9646c060333a66c9d8a6f7a9c">readSubrecord</a> (<a class="el" href="classio_1_1_reader.html">io::Reader</a> &r, quint32 *read)</td></tr>
<tr class="memdesc:a14b615f9646c060333a66c9d8a6f7a9c"><td class="mdescLeft"> </td><td class="mdescRight">Loads the header. <a href="#a14b615f9646c060333a66c9d8a6f7a9c">More...</a><br /></td></tr>
<tr class="separator:a14b615f9646c060333a66c9d8a6f7a9c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a955a03a290fd8cedd725cc9b4d24dc76"><td class="memItemLeft" align="right" valign="top">quint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classesx_1_1_form.html#a955a03a290fd8cedd725cc9b4d24dc76">getSize</a> () const</td></tr>
<tr class="memdesc:a955a03a290fd8cedd725cc9b4d24dc76"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve form size. <a href="#a955a03a290fd8cedd725cc9b4d24dc76">More...</a><br /></td></tr>
<tr class="separator:a955a03a290fd8cedd725cc9b4d24dc76"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a61483cc9f38e8da57caeedc9053ffc2f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classesx_1_1_form_header.html">FormHeader</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classesx_1_1_form.html#a61483cc9f38e8da57caeedc9053ffc2f">header</a></td></tr>
<tr class="memdesc:a61483cc9f38e8da57caeedc9053ffc2f"><td class="mdescLeft"> </td><td class="mdescRight">header <a class="el" href="classesx_1_1_form.html" title="The base class for forms in .esp and .esm files. ">Form</a> header. <a href="#a61483cc9f38e8da57caeedc9053ffc2f">More...</a><br /></td></tr>
<tr class="separator:a61483cc9f38e8da57caeedc9053ffc2f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="acb0592c52a0bbd1f93d6b50bfc06e7fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb0592c52a0bbd1f93d6b50bfc06e7fa">◆ </a></span>getHeader()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classesx_1_1_form_header.html">FormHeader</a> esx::Form::getHeader </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve form header. </p>
<p>Retrieve the header from a form. </p><dl class="section return"><dt>Returns</dt><dd><a class="el" href="classesx_1_1_form.html" title="The base class for forms in .esp and .esm files. ">Form</a> header. </dd></dl>
</div>
</div>
<a id="a955a03a290fd8cedd725cc9b4d24dc76"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a955a03a290fd8cedd725cc9b4d24dc76">◆ </a></span>getSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">quint32 esx::Form::getSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve form size. </p>
<p>Retrieve the size of the form. </p><dl class="section return"><dt>Returns</dt><dd><a class="el" href="classesx_1_1_form.html" title="The base class for forms in .esp and .esm files. ">Form</a> size. </dd></dl>
</div>
</div>
<a id="a0255f2821ec1d4dc6eee2e6d05ddb301"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0255f2821ec1d4dc6eee2e6d05ddb301">◆ </a></span>readHeader()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void esx::Form::readHeader </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classio_1_1_reader.html">io::Reader</a> & </td>
<td class="paramname"><em>r</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const quint32 </td>
<td class="paramname"><em>type</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads a record header. </p>
<p>Reads record header values from file. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">r</td><td>Provides raw data reading functionality. </td></tr>
<tr><td class="paramname">type</td><td>Record type code, identified by parser. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a14b615f9646c060333a66c9d8a6f7a9c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14b615f9646c060333a66c9d8a6f7a9c">◆ </a></span>readSubrecord()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structesx_1_1_subrecord_header.html">SubrecordHeader</a> esx::Form::readSubrecord </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classio_1_1_reader.html">io::Reader</a> & </td>
<td class="paramname"><em>r</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">quint32 * </td>
<td class="paramname"><em>read</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Loads the header. </p>
<p>Loads the GMST header from the data stream. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">r</td><td>Reader object that performs all parsing functions. </td></tr>
<tr><td class="paramname">read</td><td>Pointer to Integer representing the amount of bytes read. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Subrecord header. </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a61483cc9f38e8da57caeedc9053ffc2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61483cc9f38e8da57caeedc9053ffc2f">◆ </a></span>header</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classesx_1_1_form_header.html">FormHeader</a> esx::Form::header</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>header <a class="el" href="classesx_1_1_form.html" title="The base class for forms in .esp and .esm files. ">Form</a> header. </p>
<p><a class="el" href="classesx_1_1_form.html" title="The base class for forms in .esp and .esm files. ">Form</a> header. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="factionform_8h_source.html">factionform.h</a></li>
<li>factionform.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 14 2018 18:39:57 for OpenCK by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>