-
Notifications
You must be signed in to change notification settings - Fork 0
/
api__scenario_8cc.html
320 lines (300 loc) · 14.7 KB
/
api__scenario_8cc.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
<!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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Simutrans-Squirrel-API: api_scenario.cc File 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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Simutrans-Squirrel-API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">api_scenario.cc File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a href="api__scenario_8cc_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classdebug.html">debug</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classrules.html">rules</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a64314ec307b98519c815a0df097d3c36"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="api__scenario_8cc.html#a64314ec307b98519c815a0df097d3c36">coord3d_to_string</a> (<a class="el" href="classcoord3d.html">coord3d</a> c)</td></tr>
<tr class="separator:a64314ec307b98519c815a0df097d3c36"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a97216b980ac0adf622444cf6fcb19380"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="api__scenario_8cc.html#a97216b980ac0adf622444cf6fcb19380">coord_to_string</a> (<a class="el" href="classcoord.html">coord</a> c)</td></tr>
<tr class="separator:a97216b980ac0adf622444cf6fcb19380"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a47bf10ce6d1291c7e00717967f250a18"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="api__scenario_8cc.html#a47bf10ce6d1291c7e00717967f250a18">difftick_to_string</a> (integer)</td></tr>
<tr class="separator:a47bf10ce6d1291c7e00717967f250a18"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a682b94227013fcd47e232a483c39a958"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="api__scenario_8cc.html#a682b94227013fcd47e232a483c39a958">double_to_string</a> (float value, integer decimals)</td></tr>
<tr class="separator:a682b94227013fcd47e232a483c39a958"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa8fb48789107e181c947b8683fa555fa"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="api__scenario_8cc.html#aa8fb48789107e181c947b8683fa555fa">get_month_name</a> (integer month)</td></tr>
<tr class="separator:aa8fb48789107e181c947b8683fa555fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a99f50d79f9f644496aaf4867fd6fe5bf"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="api__scenario_8cc.html#a99f50d79f9f644496aaf4867fd6fe5bf">integer_to_string</a> (integer value)</td></tr>
<tr class="separator:a99f50d79f9f644496aaf4867fd6fe5bf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac2f8ad18303a3f540f1cdc6a51ce4c68"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__scen__only.html#gac2f8ad18303a3f540f1cdc6a51ce4c68">load_language_file</a> (string <a class="el" href="api__skeleton_8h.html#ab2c5ab3c7a17f0969cdd40146339903a">file</a>)</td></tr>
<tr class="separator:gac2f8ad18303a3f540f1cdc6a51ce4c68"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6007d17017da115f0c18188253860228"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="api__scenario_8cc.html#a6007d17017da115f0c18188253860228">money_to_string</a> (integer value)</td></tr>
<tr class="separator:a6007d17017da115f0c18188253860228"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8a329231a844917d360f8ce84d24d636"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="api__scenario_8cc.html#a8a329231a844917d360f8ce84d24d636">translate</a> (string text)</td></tr>
<tr class="separator:a8a329231a844917d360f8ce84d24d636"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>exports scenario related functions. </p>
<p class="definition">Definition in file <a class="el" href="api__scenario_8cc_source.html">api_scenario.cc</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a64314ec307b98519c815a0df097d3c36"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a64314ec307b98519c815a0df097d3c36">◆ </a></span>coord3d_to_string()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string coord3d_to_string </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcoord3d.html">coord3d</a> </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Print coordinates, does automatic rotation. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">c</td><td>coordinate </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a nice string </dd></dl>
</div>
</div>
<a id="a97216b980ac0adf622444cf6fcb19380"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a97216b980ac0adf622444cf6fcb19380">◆ </a></span>coord_to_string()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string coord_to_string </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcoord.html">coord</a> </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Print coordinates, does automatic rotation. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">c</td><td>coordinate </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a nice string </dd></dl>
</div>
</div>
<a id="a47bf10ce6d1291c7e00717967f250a18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47bf10ce6d1291c7e00717967f250a18">◆ </a></span>difftick_to_string()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string difftick_to_string </td>
<td>(</td>
<td class="paramtype">integer </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Translates difference of ticks to string. </p>
</div>
</div>
<a id="a682b94227013fcd47e232a483c39a958"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a682b94227013fcd47e232a483c39a958">◆ </a></span>double_to_string()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string double_to_string </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer </td>
<td class="paramname"><em>decimals</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Pretty-print floating point numbers, use language specific separator for powers of thousands. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>number to print </td></tr>
<tr><td class="paramname">decimals</td><td>how many decimals should be printed </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a nice string </dd></dl>
</div>
</div>
<a id="aa8fb48789107e181c947b8683fa555fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8fb48789107e181c947b8683fa555fa">◆ </a></span>get_month_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string get_month_name </td>
<td>(</td>
<td class="paramtype">integer </td>
<td class="paramname"><em>month</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get name of given month. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">month</td><td>number between 0 (january) and 11 (december) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>month name in language of server </dd></dl>
</div>
</div>
<a id="a99f50d79f9f644496aaf4867fd6fe5bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99f50d79f9f644496aaf4867fd6fe5bf">◆ </a></span>integer_to_string()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string integer_to_string </td>
<td>(</td>
<td class="paramtype">integer </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Pretty-print integers, use language specific separator for powers of thousands. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>number to print </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a nice string </dd></dl>
</div>
</div>
<a id="a6007d17017da115f0c18188253860228"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6007d17017da115f0c18188253860228">◆ </a></span>money_to_string()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string money_to_string </td>
<td>(</td>
<td class="paramtype">integer </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Pretty-print money values, use language specific separator for powers of thousands. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>number to print </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a nice string with trailing dollar-sign </dd></dl>
</div>
</div>
<a id="a8a329231a844917d360f8ce84d24d636"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a329231a844917d360f8ce84d24d636">◆ </a></span>translate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string translate </td>
<td>(</td>
<td class="paramtype">string </td>
<td class="paramname"><em>text</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Helper method to translate strings. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">text</td><td>string to translate </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>translation of given string </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>