-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclass_t_c_o_d_parser_struct.html
462 lines (436 loc) · 27.3 KB
/
class_t_c_o_d_parser_struct.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
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
<!-- HTML header for doxygen 1.9.5-->
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-772NXFFJ4E"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag() { dataLayer.push(arguments); }
gtag('js', new Date());
gtag('config', 'G-772NXFFJ4E');
</script>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=11" />
<meta name="generator" content="Doxygen 1.9.5" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>libtcod: TCODParserStruct 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>
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript" src="doxygen-awesome-fragment-copy-button.js"></script>
<script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
<script type="text/javascript" src="doxygen-awesome-interactive-toc.js"></script>
<script type="text/javascript">
DoxygenAwesomeDarkModeToggle.init()
DoxygenAwesomeFragmentCopyButton.init()
DoxygenAwesomeParagraphLink.init()
DoxygenAwesomeInteractiveToc.init()
</script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only-darkmode-toggle.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 id="projectrow">
<td id="projectalign">
<div id="projectname">libtcod
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(document).ready(function(){initNavTree('class_t_c_o_d_parser_struct.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="class_t_c_o_d_parser_struct-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">TCODParserStruct Class Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a93524dad5f387b324bdaf0f006159c71"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_t_c_o_d_parser_struct.html">TCODParserStruct</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_parser_struct.html#a93524dad5f387b324bdaf0f006159c71">addFlag</a> (const char *propname)</td></tr>
<tr class="memdesc:a93524dad5f387b324bdaf0f006159c71"><td class="mdescLeft"> </td><td class="mdescRight">Use this function to add a flag property to a structure type. <a href="class_t_c_o_d_parser_struct.html#a93524dad5f387b324bdaf0f006159c71">More...</a><br /></td></tr>
<tr class="separator:a93524dad5f387b324bdaf0f006159c71"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5b9d26e3570c0cd699673f6fb0171e2e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_t_c_o_d_parser_struct.html">TCODParserStruct</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_parser_struct.html#a5b9d26e3570c0cd699673f6fb0171e2e">addProperty</a> (const char *propname, TCOD_value_type_t type, bool mandatory)</td></tr>
<tr class="memdesc:a5b9d26e3570c0cd699673f6fb0171e2e"><td class="mdescLeft"> </td><td class="mdescRight">Use this function to add a standard property to a structure type. <a href="class_t_c_o_d_parser_struct.html#a5b9d26e3570c0cd699673f6fb0171e2e">More...</a><br /></td></tr>
<tr class="separator:a5b9d26e3570c0cd699673f6fb0171e2e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a264e360d7c7e2845c652bf1b400158cc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_t_c_o_d_parser_struct.html">TCODParserStruct</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_parser_struct.html#a264e360d7c7e2845c652bf1b400158cc">addValueList</a> (const char *propname, const char **value_list, bool mandatory)</td></tr>
<tr class="memdesc:a264e360d7c7e2845c652bf1b400158cc"><td class="mdescLeft"> </td><td class="mdescRight">A value-list property is a string property for which we define the list of allowed values. <a href="class_t_c_o_d_parser_struct.html#a264e360d7c7e2845c652bf1b400158cc">More...</a><br /></td></tr>
<tr class="separator:a264e360d7c7e2845c652bf1b400158cc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a88b1303608879e91eb7faea5f5f5b8ff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_t_c_o_d_parser_struct.html">TCODParserStruct</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_parser_struct.html#a88b1303608879e91eb7faea5f5f5b8ff">addListProperty</a> (const char *propname, TCOD_value_type_t type, bool mandatory)</td></tr>
<tr class="memdesc:a88b1303608879e91eb7faea5f5f5b8ff"><td class="mdescLeft"> </td><td class="mdescRight">Use this function to add a list property to a structure type. <a href="class_t_c_o_d_parser_struct.html#a88b1303608879e91eb7faea5f5f5b8ff">More...</a><br /></td></tr>
<tr class="separator:a88b1303608879e91eb7faea5f5f5b8ff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4b2291958db3438b915c29d39735fd85"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_t_c_o_d_parser_struct.html">TCODParserStruct</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_parser_struct.html#a4b2291958db3438b915c29d39735fd85">addStructure</a> (<a class="el" href="class_t_c_o_d_parser_struct.html">TCODParserStruct</a> *sub_entity)</td></tr>
<tr class="memdesc:a4b2291958db3438b915c29d39735fd85"><td class="mdescLeft"> </td><td class="mdescRight">A structure can contain others structures. <a href="class_t_c_o_d_parser_struct.html#a4b2291958db3438b915c29d39735fd85">More...</a><br /></td></tr>
<tr class="separator:a4b2291958db3438b915c29d39735fd85"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7717ee4f9c563f6308c7da68a6dcf87d"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_parser_struct.html#a7717ee4f9c563f6308c7da68a6dcf87d">getName</a> () const</td></tr>
<tr class="memdesc:a7717ee4f9c563f6308c7da68a6dcf87d"><td class="mdescLeft"> </td><td class="mdescRight">You can retrieve the name of the structure type with these functions. <a href="class_t_c_o_d_parser_struct.html#a7717ee4f9c563f6308c7da68a6dcf87d">More...</a><br /></td></tr>
<tr class="separator:a7717ee4f9c563f6308c7da68a6dcf87d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a1884b85fbb41405f1758c9f5396ae3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_parser_struct.html#a3a1884b85fbb41405f1758c9f5396ae3">isPropertyMandatory</a> (const char *propname) const</td></tr>
<tr class="memdesc:a3a1884b85fbb41405f1758c9f5396ae3"><td class="mdescLeft"> </td><td class="mdescRight">You can know if a property is mandatory : <a href="class_t_c_o_d_parser_struct.html#a3a1884b85fbb41405f1758c9f5396ae3">More...</a><br /></td></tr>
<tr class="separator:a3a1884b85fbb41405f1758c9f5396ae3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3b9b8be72c52ca05b181fa25faf20ba7"><td class="memItemLeft" align="right" valign="top">TCOD_value_type_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_c_o_d_parser_struct.html#a3b9b8be72c52ca05b181fa25faf20ba7">getPropertyType</a> (const char *propname) const</td></tr>
<tr class="memdesc:a3b9b8be72c52ca05b181fa25faf20ba7"><td class="mdescLeft"> </td><td class="mdescRight">You get the type of a property : In the case of a list property, the value returned is a bitwise or of TCOD_TYPE_LIST and the list element's type. <a href="class_t_c_o_d_parser_struct.html#a3b9b8be72c52ca05b181fa25faf20ba7">More...</a><br /></td></tr>
<tr class="separator:a3b9b8be72c52ca05b181fa25faf20ba7"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a2f9f6b4aec3edee6d489db3662b8fd25"><td class="memItemLeft" align="right" valign="top"><a id="a2f9f6b4aec3edee6d489db3662b8fd25" name="a2f9f6b4aec3edee6d489db3662b8fd25"></a>
<a class="el" href="struct_t_c_o_d___parser_struct.html">TCOD_parser_struct_t</a> </td><td class="memItemRight" valign="bottom"><b>data</b></td></tr>
<tr class="separator:a2f9f6b4aec3edee6d489db3662b8fd25"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a93524dad5f387b324bdaf0f006159c71" name="a93524dad5f387b324bdaf0f006159c71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93524dad5f387b324bdaf0f006159c71">◆ </a></span>addFlag()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_t_c_o_d_parser_struct.html">TCODParserStruct</a> * TCODParserStruct::addFlag </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>propname</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Use this function to add a flag property to a structure type. </p>
<p >A flag is a simplified boolean property. It cannot be mandatory: either it's present and it's true, or it's absent and it's false.<br />
Note that in the C++ version, the function returns its parent object, allowing for chaining.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>In the C version, the structure handler, returned by TCOD_parser_new_struct. </td></tr>
<tr><td class="paramname">name</td><td>The name of the flag (in the example, this would be "abstract"). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a88b1303608879e91eb7faea5f5f5b8ff" name="a88b1303608879e91eb7faea5f5f5b8ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88b1303608879e91eb7faea5f5f5b8ff">◆ </a></span>addListProperty()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_t_c_o_d_parser_struct.html">TCODParserStruct</a> * TCODParserStruct::addListProperty </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>propname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TCOD_value_type_t </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>mandatory</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Use this function to add a list property to a structure type. </p>
<p ><br />
Note that in the C++ version, the function returns its parent object, allowing for chaining.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>In the C version, the structure handler, returned by TCOD_parser_new_struct. </td></tr>
<tr><td class="paramname">name</td><td>The name of the property (in the example, this would be "cost" or "damages" or ...). </td></tr>
<tr><td class="paramname">type</td><td>The type of the list elements. It must be a standard type (see <a href="parser_types.html">this</a>). It cannot be TCOD_TYPE_LIST. </td></tr>
<tr><td class="paramname">mandatory</td><td>Is this property mandatory ? If true and the property is not defined in the file, the parser will raise an error.</td></tr>
</table>
</dd>
</dl>
<p>itemTypeStruct->addListProperty("intList",TCOD_TYPE_INT,true) ->addListProperty("floatList",TCOD_TYPE_FLOAT,true) ->addListProperty("stringList",TCOD_TYPE_STRING,true);</p>
<p >TCOD_struct_add_list_property(item_type_struct, "intList", TCOD_TYPE_INT, true); TCOD_struct_add_list_property(item_type_struct, "floatList", TCOD_TYPE_FLOAT, true); TCOD_struct_add_list_property(item_type_struct, "stringList", TCOD_TYPE_STRING, true);</p>
<p >libtcod.struct_add_list_property(item_type_struct, "intList", libtcod.TYPE_INT, True) libtcod.struct_add_list_property(item_type_struct, "floatList", libtcod.TYPE_FLOAT, True) libtcod.struct_add_list_property(item_type_struct, "stringList", libtcod.TYPE_STRING, True) </p>
</div>
</div>
<a id="a5b9d26e3570c0cd699673f6fb0171e2e" name="a5b9d26e3570c0cd699673f6fb0171e2e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5b9d26e3570c0cd699673f6fb0171e2e">◆ </a></span>addProperty()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_t_c_o_d_parser_struct.html">TCODParserStruct</a> * TCODParserStruct::addProperty </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>propname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TCOD_value_type_t </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>mandatory</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Use this function to add a standard property to a structure type. </p>
<p >Check standard property types here.<br />
Note that in the C++ version, the function returns its parent object, allowing for chaining.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>In the C version, the structure handler, returned by TCOD_parser_new_struct. </td></tr>
<tr><td class="paramname">name</td><td>The name of the property (in the example, this would be "cost" or "damage" or ...). </td></tr>
<tr><td class="paramname">type</td><td>The type of the property. It can be a standard type (see <a href="parser_types.html">this</a>). </td></tr>
<tr><td class="paramname">mandatory</td><td>Is this property mandatory? If true and the property is not defined in the file, the parser will raise an error.</td></tr>
</table>
</dd>
</dl>
<p>itemTypeStruct->addProperty("cost",TCOD_TYPE_INT,true) ->addProperty("weight",TCOD_TYPE_FLOAT,true) ->addProperty("deal_damage",TCOD_TYPE_BOOL,true) ->addProperty("damaged_color",TCOD_TYPE_COLOR,true);</p>
<p >TCOD_struct_add_property(item_type_struct, "cost", TCOD_TYPE_INT, true); TCOD_struct_add_property(item_type_struct, "damages", TCOD_TYPE_DICE, true); TCOD_struct_add_property(item_type_struct, "color", TCOD_TYPE_COLOR, true); TCOD_struct_add_property(item_type_struct, "damaged_color", TCOD_TYPE_COLOR, true);</p>
<p >libtcod.struct_add_property(item_type_struct, "cost", libtcod.TYPE_INT, True) libtcod.struct_add_property(item_type_struct, "damages", libtcod.TYPE_DICE, True) libtcod.struct_add_property(item_type_struct, "color", libtcod.TYPE_COLOR, True) libtcod.struct_add_property(item_type_struct, "damaged_color", libtcod.TYPE_COLOR, True) </p>
</div>
</div>
<a id="a4b2291958db3438b915c29d39735fd85" name="a4b2291958db3438b915c29d39735fd85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b2291958db3438b915c29d39735fd85">◆ </a></span>addStructure()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_t_c_o_d_parser_struct.html">TCODParserStruct</a> * TCODParserStruct::addStructure </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_t_c_o_d_parser_struct.html">TCODParserStruct</a> * </td>
<td class="paramname"><em>sub_entity</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>A structure can contain others structures. </p>
<p >You can tell the parser which structures are allowed inside one structure type with this function.<br />
Note that in the C++ version, the function returns its parent object, allowing for chaining.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>In the C version, the structure handler, returned by TCOD_parser_new_struct. </td></tr>
<tr><td class="paramname">sub_structure</td><td>The structure type that can be embedded.</td></tr>
</table>
</dd>
</dl>
<p>The item_type structure can contain itself itemTypeStruct->addStructure(itemTypeStruct); </p>
</div>
</div>
<a id="a264e360d7c7e2845c652bf1b400158cc" name="a264e360d7c7e2845c652bf1b400158cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a264e360d7c7e2845c652bf1b400158cc">◆ </a></span>addValueList()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_t_c_o_d_parser_struct.html">TCODParserStruct</a> * TCODParserStruct::addValueList </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>propname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char ** </td>
<td class="paramname"><em>value_list</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>mandatory</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>A value-list property is a string property for which we define the list of allowed values. </p>
<p >The parser will raise an error if the file contains an unauthorized value for this property. The first value-list property that you add to a structure type will have the TCOD_TYPE_VALUELIST00 type. The next TCOD_TYPE_VALUELIST01. You can define up to 16 value list property for each structure type. The last one has the type TCOD_TYPE_VALUELIST15. You must provide a value list as a NULL terminated array of strings.<br />
Note that in the C++ version, the function returns its parent object, allowing for chaining.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>In the C version, the structure handler, returned by TCOD_parser_new_struct. </td></tr>
<tr><td class="paramname">name</td><td>The name of the property (in the example, this would be "damage_type"). </td></tr>
<tr><td class="paramname">value_list</td><td>The list of allowed strings. </td></tr>
<tr><td class="paramname">mandatory</td><td>Is this property mandatory ? If true and the property is not defined in the file, the parser will raise an error.</td></tr>
</table>
</dd>
</dl>
<p>static const char *damageTypes[] = { "slash", "pierce", "bludgeon", NULL }; // note the ending NULL itemTypeStruct->addValueList("damage_type", damageTypes, true);</p>
<p >static const char *damage_types[] = { "slash", "pierce", "bludgeon", NULL }; TCOD_struct_add_value_list(item_type_struct, "damage_type", damage_types, true);</p>
<p >damage_types = [ "slash", "pierce", "bludgeon" ] libtcod.struct_add_value_list(item_type_struct, "damage_type", damage_types, True) </p>
</div>
</div>
<a id="a7717ee4f9c563f6308c7da68a6dcf87d" name="a7717ee4f9c563f6308c7da68a6dcf87d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7717ee4f9c563f6308c7da68a6dcf87d">◆ </a></span>getName()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * TCODParserStruct::getName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>You can retrieve the name of the structure type with these functions. </p>
<p >Warning ! Do not confuse the structure type's name with the structure's name : </p><div class="code"></div><div class="code">item_type "sword" { ... }</div><div class="code"></div><p> Here, the structure type's name is "item_type", the structure name is "sword". Obviously, the structure name cannot be retrieved from the <a class="el" href="class_t_c_o_d_parser_struct.html">TCODParserStruct</a> object because it's only known at "runtime" (while parsing the file).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>In the C version, the structure handler, returned by TCOD_parser_new_struct. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3b9b8be72c52ca05b181fa25faf20ba7" name="a3b9b8be72c52ca05b181fa25faf20ba7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b9b8be72c52ca05b181fa25faf20ba7">◆ </a></span>getPropertyType()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TCOD_value_type_t TCODParserStruct::getPropertyType </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>propname</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>You get the type of a property : In the case of a list property, the value returned is a bitwise or of TCOD_TYPE_LIST and the list element's type. </p>
<p >For example, for a list of int, it will return TCOD_TYPE_LIST | TCOD_TYPE_INT.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>In the C version, the structure handler, returned by TCOD_parser_new_struct. </td></tr>
<tr><td class="paramname">name</td><td>The name of the property, as defined when you called addProperty or addValueList or addListProperty.</td></tr>
</table>
</dd>
</dl>
<p>TCOD_value_type_t costType = itemTypeStruct->getPropertyType("cost"); // returns TCOD_TYPE_INT TCOD_value_type_t intListType = itemTypeStruct->getPropertyType("intList"); // returns TCOD_TYPE_LIST|TCOD_TYPE_INT </p>
</div>
</div>
<a id="a3a1884b85fbb41405f1758c9f5396ae3" name="a3a1884b85fbb41405f1758c9f5396ae3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a1884b85fbb41405f1758c9f5396ae3">◆ </a></span>isPropertyMandatory()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool TCODParserStruct::isPropertyMandatory </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>propname</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>You can know if a property is mandatory : </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>In the C version, the structure handler, returned by TCOD_parser_new_struct. </td></tr>
<tr><td class="paramname">name</td><td>The name of the property, as defined when you called addProperty or addValueList or addListProperty. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>C:/Users/4b796/Projects/libtcod/src/libtcod/<a class="el" href="parser_8hpp_source.html">parser.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_t_c_o_d_parser_struct.html">TCODParserStruct</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5 </li>
</ul>
</div>
</body>
</html>