-
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathnamegen_generate.html
More file actions
231 lines (227 loc) · 14.1 KB
/
namegen_generate.html
File metadata and controls
231 lines (227 loc) · 14.1 KB
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-C2YXLNQ21C"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag() { dataLayer.push(arguments); }
gtag('js', new Date());
gtag('config', 'G-C2YXLNQ21C');
</script>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
<title>libtcod documentation | Generating a name</title>
<script type="text/javascript" src="../js/doctcod.js"></script>
<link href="../css/style.css" rel="stylesheet" type="text/css">
</head>
<link type="text/css" rel="stylesheet" href="../css/shCore.css">
</link>
<link type="text/css" rel="stylesheet" href="../css/shThemeDefault.css">
</link>
<script language="javascript" src="../js/shCore.js"></script>
<script language="javascript" src="../js/shBrushBash.js"></script>
<body>
<div class="header">
<p><span class="title1">libtcod</span><span class="title2">documentation</span></p>
</div>
<div class="breadcrumb">
<div class="breadcrumbtext">
<p>
you are here: <a onclick="link('../index2.html')">Index</a> > <a onclick="link('namegen.html')">15. Name
generator</a> > <a onclick="link('namegen_generate.html')">15.2. Generating a name</a><br>
<a class="prev" onclick="link('namegen_init.html')">15.1. Creating a generator</a> | <a class="next"
onclick="link('namegen_file.html')">15.3. Syllable set configuration</a>
</p>
</div>
</div>
<div class="filter"><input type="checkbox" id="chk_c" name="chk_c" onchange="enable('c',this.checked)"
checked='checked'><label for='chk_c'> C </label><input type="checkbox" id="chk_cpp" name="chk_cpp"
onchange="enable('cpp',this.checked)" checked='checked'><label for='chk_cpp'> C++ </label><input type="checkbox"
id="chk_py" name="chk_py" onchange="enable('py',this.checked)" checked='checked'><label for='chk_py'> Py
</label><input type="checkbox" id="chk_lua" name="chk_lua" onchange="enable('lua',this.checked)"
disabled='disabled'><label class='disabled' for='chk_lua'> Lua </label><input type="checkbox" id="chk_cs"
name="chk_cs" onchange="enable('cs',this.checked)" disabled='disabled'><label class='disabled' for='chk_cs'> C#
</label></div>
<div class="main">
<div class="maintext">
<h1>15.2. Generating a name</h1>
<div id="toc">
<ul>
<li><a href="#0">Generating a default name</a></li>
<li><a href="#1">Generating a custom name</a></li>
<li><a href="#2">Retrieving available set names</a></li>
</ul>
</div>
<a name="0"></a>
<h3>Generating a default name</h3>
<p>The following will output a random name generated using one of the generation rules specified in the syllable
set:<br /> Should you choose to allocate memory for the output, you need to remember to deallocate it once you
don't need the name anymore using the free() function. This applies to C++ as well (delete won't work - you have
to use free()).<br /> <br /> On the other hand, should you choose not to allocate memory, be aware that
subsequent calls will overwrite the previously returned pointer, so make sure to copy the output using strcpy(),
strdup() or other means of your choosing.<br /> <br /> The name you specify needs to be in one of the files the
generator has previously parsed (see Creating a generator). If such a name doesn't exist, a warning will be
displayed and NULL will be returned.<br /> </p>
<div class="code">
<p class="cpp"><span class="code-keyword">static</span><span class="code-keyword"> char</span><span
class="code-symbol"> *</span> TCODNamegen<span class="code-symbol">::</span>generate<span
class="code-symbol"> (</span><span class="code-keyword">char</span><span class="code-symbol"> *</span>
name<span class="code-symbol">,</span><span class="code-keyword"> bool</span> allocate<span
class="code-symbol"> =</span><span class="code-keyword"> false</span><span class="code-symbol">)</span></p>
<p class="c"><span class="code-keyword">char</span><span class="code-symbol"> *</span>
TCOD_namegen_generate<span class="code-symbol"> (</span><span class="code-keyword">char</span><span
class="code-symbol"> *</span> name<span class="code-symbol">,</span><span class="code-keyword"> bool</span>
allocate<span class="code-symbol">)</span></p>
<p class="py">namegen_generate<span class="code-symbol"> (</span>name<span class="code-symbol">,</span>
allocate<span class="code-symbol"> =</span><span class="code-value"> 0</span><span
class="code-symbol">)</span></p>
</div>
<table class="param">
<tbody>
<tr>
<th>Parameter</th>
<th>Description</th>
</tr>
<tr class="hilite">
<td>name</td>
<td>The structure name you wish to refer to, for instance, "celtic female".<br /> For more about how
structure names work, please refer to <a href="namegen_file.html">those</a> <a
href="parser_format.html">chapters</a>.<br /> </td>
</tr>
<tr>
<td>allocate</td>
<td>Whether memory should be allocated for the output or not.<br /> </td>
</tr>
</tbody>
</table>
<h6>Example:</h6>
<div class="code">
<p class="cpp">TCODNamegen<span class="code-symbol">::</span>parse<span class="code-symbol">(</span><span
class="code-string">"data/names.txt"</span><span class="code-symbol">,</span>TCODRandom<span
class="code-symbol">::</span>getInstance<span class="code-symbol">(</span><span
class="code-symbol">)</span><span class="code-symbol">)</span><span class="code-symbol">;</span><span
class="code-keyword"><br />char</span><span class="code-symbol"> *</span> myName<span class="code-symbol">
=</span> TCODNamegen<span class="code-symbol">::</span>generate<span class="code-symbol">(</span><span
class="code-string">"fantasy female"</span><span class="code-symbol">)</span><span
class="code-symbol">;</span></p>
<p class="c">TCOD_namegen_parse<span class="code-symbol">(</span><span
class="code-string">"data/names.txt"</span><span class="code-symbol">,</span>TCOD_random_get_instance<span
class="code-symbol">(</span><span class="code-symbol">)</span><span class="code-symbol">)</span><span
class="code-symbol">;</span><span class="code-keyword"><br />char</span><span class="code-symbol"> *</span>
my_name<span class="code-symbol"> =</span> TCOD_namegen_generate<span class="code-symbol">(</span><span
class="code-string">"Celtic male"</span><span class="code-symbol">,</span>false<span
class="code-symbol">)</span><span class="code-symbol">;</span></p>
<p class="py">libtcod<span class="code-symbol">.</span>namegen_parse<span class="code-symbol">(</span><span
class="code-string">'data/names.txt'</span><span class="code-symbol">)</span><br />name<span
class="code-symbol"> =</span> libtcod<span class="code-symbol">.</span>namegen_generate<span
class="code-symbol">(</span><span class="code-string">'Nordic female'</span><span
class="code-symbol">)</span></p>
</div>
<hr>
<a name="1"></a>
<h3>Generating a custom name</h3>
<p>It is also possible to generate a name using custom generation rules. This overrides the random choice of a
generation rule from the syllable set. Please refer to chapter 16.5 to learn about the name generation rules
syntax.<br /> </p>
<div class="code">
<p class="cpp"><span class="code-keyword">static</span><span class="code-keyword"> char</span><span
class="code-symbol"> *</span> TCODNamegen<span class="code-symbol">::</span>generateCustom<span
class="code-symbol"> (</span><span class="code-keyword">char</span><span class="code-symbol"> *</span>
name<span class="code-symbol">,</span><span class="code-keyword"> char</span><span class="code-symbol">
*</span> rule<span class="code-symbol">,</span><span class="code-keyword"> bool</span> allocate<span
class="code-symbol"> =</span><span class="code-keyword"> false</span><span class="code-symbol">)</span></p>
<p class="c"><span class="code-keyword">char</span><span class="code-symbol"> *</span>
TCOD_namegen_generate_custom<span class="code-symbol"> (</span><span class="code-keyword">char</span><span
class="code-symbol"> *</span> name<span class="code-symbol">,</span><span class="code-keyword">
char</span><span class="code-symbol"> *</span> rule<span class="code-symbol">,</span><span
class="code-keyword"> bool</span> allocate<span class="code-symbol">)</span></p>
<p class="py">namegen_generate_custom<span class="code-symbol"> (</span>name<span class="code-symbol">,</span>
rule<span class="code-symbol">,</span> allocate<span class="code-symbol"> =</span><span class="code-value">
0</span><span class="code-symbol">)</span></p>
</div>
<table class="param">
<tbody>
<tr>
<th>Parameter</th>
<th>Description</th>
</tr>
<tr class="hilite">
<td>name</td>
<td>The structure name you wish to refer to, for instance, "celtic female".<br /> For more about how
structure names work, please refer to <a href="namegen_file.html">those</a> <a
href="parser_format.html">chapters</a>.<br /> </td>
</tr>
<tr>
<td>rule</td>
<td>The name generation rule. See <a href="namegen_file.html">this chapter</a> for more details.<br /> </td>
</tr>
<tr class="hilite">
<td>allocate</td>
<td>Whether memory should be allocated for the output or not.<br /> </td>
</tr>
</tbody>
</table>
<h6>Example:</h6>
<div class="code">
<p class="cpp">TCODNamegen<span class="code-symbol">::</span>parse<span class="code-symbol">(</span><span
class="code-string">"data/names.txt"</span><span class="code-symbol">,</span>TCODRandom<span
class="code-symbol">::</span>getInstance<span class="code-symbol">(</span><span
class="code-symbol">)</span><span class="code-symbol">)</span><span class="code-symbol">;</span><span
class="code-keyword"><br />char</span><span class="code-symbol"> *</span> myName<span class="code-symbol">
=</span> TCODNamegen<span class="code-symbol">::</span>generateCustom<span class="code-symbol">(</span><span
class="code-string">"Nordic male"</span><span class="code-symbol">,</span><span
class="code-string">"$s$e"</span><span class="code-symbol">)</span><span class="code-symbol">;</span></p>
<p class="c">TCOD_namegen_parse<span class="code-symbol">(</span><span
class="code-string">"data/names.txt"</span><span class="code-symbol">,</span>TCOD_random_get_instance<span
class="code-symbol">(</span><span class="code-symbol">)</span><span class="code-symbol">)</span><span
class="code-symbol">;</span><span class="code-keyword"><br />char</span><span class="code-symbol"> *</span>
my_name<span class="code-symbol"> =</span> TCOD_namegen_generate_custom<span class="code-symbol">(</span><span
class="code-string">"Mesopotamian female"</span><span class="code-symbol">,</span><span
class="code-string">"$s$e"</span><span class="code-symbol">,</span>false<span
class="code-symbol">)</span><span class="code-symbol">;</span></p>
<p class="py">libtcod<span class="code-symbol">.</span>namegen_parse<span class="code-symbol">(</span><span
class="code-string">'data/names.txt'</span><span class="code-symbol">)</span><br />name<span
class="code-symbol"> =</span> libtcod<span class="code-symbol">.</span>namegen_generate_custom<span
class="code-symbol">(</span><span class="code-string">'Nordic female'</span><span
class="code-symbol">,</span><span class="code-string">'$s$e'</span><span class="code-symbol">)</span></p>
</div>
<hr>
<a name="2"></a>
<h3>Retrieving available set names</h3>
<p>If you wish to check the sylable set names that are currently available, you may call:<br /> This will create a
list with all the available syllable set names. Remember to delete that list after you don't need it
anymore!<br /> </p>
<div class="code">
<p class="cpp"><span class="code-keyword">static</span> TCODList TCODNamegen<span
class="code-symbol">::</span>getSets<span class="code-symbol"> (</span><span class="code-symbol">)</span>
</p>
<p class="c"><span class="code-tcod">TCOD_list_t</span> TCOD_namegen_get_sets<span class="code-symbol">
(</span><span class="code-symbol">)</span></p>
<p class="py">namegen_get_sets<span class="code-symbol"> (</span><span class="code-symbol">)</span></p>
</div>
</div>
</div>
<div class="footer">
<div class="footertext">
<p>libtcod 1.6.4, © 2008, 2009, 2010, 2012, 2017 Jice, Mingos & rmtew<br>
This file has been generated by doctcod.</p>
<p>
<table width='100%'>
<tr>
<td width="33%"><a href="https://github.com/libtcod/libtcod">libtcod website</a></td>
<td width="33%"><a href="https://www.reddit.com/r/roguelikedev">libtcod on /r/roguelikedev</a></td>
<td width="33%">libtcod tutorials [ <a
href="http://www.roguebasin.com/index.php?title=Complete_Roguelike_Tutorial,_using_python%2Blibtcod">Python</a> | <a
href="http://www.roguebasin.com/index.php?title=Complete_roguelike_tutorial_using_C%2B%2B_and_libtcod_-_part_1:_setting_up">C++</a> ]
</td>
</tr>
</table>
</p>
</div>
</div>
</body>
<script>
initFilter();
SyntaxHighlighter.all();
</script>
</html>