-
Notifications
You must be signed in to change notification settings - Fork 0
/
api__scenario_8cc_source.html
102 lines (100 loc) · 17.2 KB
/
api__scenario_8cc_source.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
<!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 Source File</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>
</div><!-- top -->
<!-- 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 class="header">
<div class="headertitle">
<div class="title">api_scenario.cc</div> </div>
</div><!--header-->
<div class="contents">
<a href="api__scenario_8cc.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="keywordtype">string</span> <a class="code" href="api__scenario_8cc.html#a8a329231a844917d360f8ce84d24d636">translate</a>(<span class="keywordtype">string</span> text);</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="keywordtype">string</span> <a class="code" href="api__scenario_8cc.html#a682b94227013fcd47e232a483c39a958">double_to_string</a>(<span class="keywordtype">float</span> value, integer decimals);</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keywordtype">string</span> <a class="code" href="api__scenario_8cc.html#a99f50d79f9f644496aaf4867fd6fe5bf">integer_to_string</a>(integer value);</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keywordtype">string</span> <a class="code" href="api__scenario_8cc.html#a6007d17017da115f0c18188253860228">money_to_string</a>(integer value);</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keywordtype">string</span> <a class="code" href="api__scenario_8cc.html#a97216b980ac0adf622444cf6fcb19380">coord_to_string</a>(<a class="code" href="classcoord.html">coord</a> c);</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keywordtype">string</span> <a class="code" href="api__scenario_8cc.html#a64314ec307b98519c815a0df097d3c36">coord3d_to_string</a>(<a class="code" href="classcoord3d.html">coord3d</a> c);</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keywordtype">string</span> <a class="code" href="api__scenario_8cc.html#aa8fb48789107e181c947b8683fa555fa">get_month_name</a>(integer month);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keywordtype">string</span> <a class="code" href="api__scenario_8cc.html#a47bf10ce6d1291c7e00717967f250a18">difftick_to_string</a>(integer);</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="keywordtype">string</span> <a class="code" href="group__scen__only.html#gac2f8ad18303a3f540f1cdc6a51ce4c68">load_language_file</a>(<span class="keywordtype">string</span> <a class="code" href="api__skeleton_8h.html#ab2c5ab3c7a17f0969cdd40146339903a">file</a>);</div><div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="classrules.html"> 74</a></span> <span class="keyword">class </span><a class="code" href="classrules.html">rules</a> {</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classrules.html#ab8b99f0eac12865936351997c1a2f4a0">forbid_tool</a>(integer player_nr, integer tool_id);</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classrules.html#ae713f8ad39f4cbc1b54b4a19ecd48017">allow_tool</a>(integer player_nr, integer tool_id);</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classrules.html#a32635665b3561aa32c534bf848b51d30">forbid_way_tool</a>(integer player_nr, integer tool_id, <a class="code" href="api__const_8cc.html#a54cfd1fb3beb4607096d5c42809655af">way_types</a> wt);</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classrules.html#aa1b2a8e1779a4837c3cfad4ef6b469ac">allow_way_tool</a>(integer player_nr, integer tool_id, <a class="code" href="api__const_8cc.html#a54cfd1fb3beb4607096d5c42809655af">way_types</a> wt);</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classrules.html#abf8f8c6b1c0064f648e5e0fff83cecf4">forbid_way_tool_rect</a>(integer player_nr, integer tool_id, <a class="code" href="api__const_8cc.html#a54cfd1fb3beb4607096d5c42809655af">way_types</a> wt, <a class="code" href="classcoord.html">coord</a> pos_nw, <a class="code" href="classcoord.html">coord</a> pos_se, <span class="keywordtype">string</span> err);</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classrules.html#a46cb20c5fec1bb1ce521dabcb62d523b">allow_way_tool_rect</a>(integer player_nr, integer tool_id, <a class="code" href="api__const_8cc.html#a54cfd1fb3beb4607096d5c42809655af">way_types</a> wt, <a class="code" href="classcoord.html">coord</a> pos_nw, <a class="code" href="classcoord.html">coord</a> pos_se);</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classrules.html#a2cc677466356d39162991318718023a9">forbid_way_tool_cube</a>(integer player_nr, integer tool_id, <a class="code" href="api__const_8cc.html#a54cfd1fb3beb4607096d5c42809655af">way_types</a> wt, <a class="code" href="classcoord3d.html">coord3d</a> pos_nw, <a class="code" href="classcoord3d.html">coord3d</a> pos_se, <span class="keywordtype">string</span> err);</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classrules.html#a873e22cec4c9364bb72997c130113d03">allow_way_tool_cube</a>(integer player_nr, integer tool_id, <a class="code" href="api__const_8cc.html#a54cfd1fb3beb4607096d5c42809655af">way_types</a> wt, <a class="code" href="classcoord3d.html">coord3d</a> pos_nw, <a class="code" href="classcoord3d.html">coord3d</a> pos_se);</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classrules.html#af3283dba16a9bda9435430300b4d5a16">clear</a>();</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classrules.html#a15a1e5e594612ff19ee45068c6a1a008">gui_needs_update</a>();</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> };</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="keyword">class </span><a class="code" href="classdebug.html">debug</a> {</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <span class="keyword">static</span> <span class="keywordtype">string</span> <a class="code" href="classdebug.html#a367be2337f31efa4ccb38058412930d7">get_forbidden_text</a>();</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> };</div><div class="ttc" id="classrules_html"><div class="ttname"><a href="classrules.html">rules</a></div><div class="ttdef"><b>Definition:</b> <a href="api__scenario_8cc_source.html#l00074">api_scenario.cc:74</a></div></div>
<div class="ttc" id="classrules_html_abf8f8c6b1c0064f648e5e0fff83cecf4"><div class="ttname"><a href="classrules.html#abf8f8c6b1c0064f648e5e0fff83cecf4">rules::forbid_way_tool_rect</a></div><div class="ttdeci">static void forbid_way_tool_rect(integer player_nr, integer tool_id, way_types wt, coord pos_nw, coord pos_se, string err)</div></div>
<div class="ttc" id="api__const_8cc_html_a54cfd1fb3beb4607096d5c42809655af"><div class="ttname"><a href="api__const_8cc.html#a54cfd1fb3beb4607096d5c42809655af">way_types</a></div><div class="ttdeci">way_types</div><div class="ttdef"><b>Definition:</b> <a href="api__const_8cc_source.html#l00118">api_const.cc:118</a></div></div>
<div class="ttc" id="classrules_html_a46cb20c5fec1bb1ce521dabcb62d523b"><div class="ttname"><a href="classrules.html#a46cb20c5fec1bb1ce521dabcb62d523b">rules::allow_way_tool_rect</a></div><div class="ttdeci">static void allow_way_tool_rect(integer player_nr, integer tool_id, way_types wt, coord pos_nw, coord pos_se)</div></div>
<div class="ttc" id="api__scenario_8cc_html_a99f50d79f9f644496aaf4867fd6fe5bf"><div class="ttname"><a href="api__scenario_8cc.html#a99f50d79f9f644496aaf4867fd6fe5bf">integer_to_string</a></div><div class="ttdeci">string integer_to_string(integer value)</div></div>
<div class="ttc" id="classdebug_html_a367be2337f31efa4ccb38058412930d7"><div class="ttname"><a href="classdebug.html#a367be2337f31efa4ccb38058412930d7">debug::get_forbidden_text</a></div><div class="ttdeci">static string get_forbidden_text()</div></div>
<div class="ttc" id="classcoord3d_html"><div class="ttname"><a href="classcoord3d.html">coord3d</a></div><div class="ttdef"><b>Definition:</b> <a href="api__simple_8cc_source.html#l00070">api_simple.cc:70</a></div></div>
<div class="ttc" id="classdebug_html"><div class="ttname"><a href="classdebug.html">debug</a></div><div class="ttdef"><b>Definition:</b> <a href="api__control_8cc_source.html#l00016">api_control.cc:16</a></div></div>
<div class="ttc" id="api__skeleton_8h_html_ab2c5ab3c7a17f0969cdd40146339903a"><div class="ttname"><a href="api__skeleton_8h.html#ab2c5ab3c7a17f0969cdd40146339903a">file</a></div><div class="ttdeci">string file</div><div class="ttdef"><b>Definition:</b> <a href="api__skeleton_8h_source.html#l00034">api_skeleton.h:34</a></div></div>
<div class="ttc" id="api__scenario_8cc_html_aa8fb48789107e181c947b8683fa555fa"><div class="ttname"><a href="api__scenario_8cc.html#aa8fb48789107e181c947b8683fa555fa">get_month_name</a></div><div class="ttdeci">string get_month_name(integer month)</div></div>
<div class="ttc" id="classcoord_html"><div class="ttname"><a href="classcoord.html">coord</a></div><div class="ttdef"><b>Definition:</b> <a href="api__simple_8cc_source.html#l00032">api_simple.cc:32</a></div></div>
<div class="ttc" id="group__scen__only_html_gac2f8ad18303a3f540f1cdc6a51ce4c68"><div class="ttname"><a href="group__scen__only.html#gac2f8ad18303a3f540f1cdc6a51ce4c68">load_language_file</a></div><div class="ttdeci">string load_language_file(string file)</div></div>
<div class="ttc" id="classrules_html_af3283dba16a9bda9435430300b4d5a16"><div class="ttname"><a href="classrules.html#af3283dba16a9bda9435430300b4d5a16">rules::clear</a></div><div class="ttdeci">static void clear()</div></div>
<div class="ttc" id="classrules_html_ae713f8ad39f4cbc1b54b4a19ecd48017"><div class="ttname"><a href="classrules.html#ae713f8ad39f4cbc1b54b4a19ecd48017">rules::allow_tool</a></div><div class="ttdeci">static void allow_tool(integer player_nr, integer tool_id)</div></div>
<div class="ttc" id="api__scenario_8cc_html_a6007d17017da115f0c18188253860228"><div class="ttname"><a href="api__scenario_8cc.html#a6007d17017da115f0c18188253860228">money_to_string</a></div><div class="ttdeci">string money_to_string(integer value)</div></div>
<div class="ttc" id="classrules_html_a15a1e5e594612ff19ee45068c6a1a008"><div class="ttname"><a href="classrules.html#a15a1e5e594612ff19ee45068c6a1a008">rules::gui_needs_update</a></div><div class="ttdeci">static void gui_needs_update()</div></div>
<div class="ttc" id="api__scenario_8cc_html_a47bf10ce6d1291c7e00717967f250a18"><div class="ttname"><a href="api__scenario_8cc.html#a47bf10ce6d1291c7e00717967f250a18">difftick_to_string</a></div><div class="ttdeci">string difftick_to_string(integer)</div></div>
<div class="ttc" id="api__scenario_8cc_html_a64314ec307b98519c815a0df097d3c36"><div class="ttname"><a href="api__scenario_8cc.html#a64314ec307b98519c815a0df097d3c36">coord3d_to_string</a></div><div class="ttdeci">string coord3d_to_string(coord3d c)</div></div>
<div class="ttc" id="classrules_html_ab8b99f0eac12865936351997c1a2f4a0"><div class="ttname"><a href="classrules.html#ab8b99f0eac12865936351997c1a2f4a0">rules::forbid_tool</a></div><div class="ttdeci">static void forbid_tool(integer player_nr, integer tool_id)</div></div>
<div class="ttc" id="api__scenario_8cc_html_a682b94227013fcd47e232a483c39a958"><div class="ttname"><a href="api__scenario_8cc.html#a682b94227013fcd47e232a483c39a958">double_to_string</a></div><div class="ttdeci">string double_to_string(float value, integer decimals)</div></div>
<div class="ttc" id="classrules_html_a2cc677466356d39162991318718023a9"><div class="ttname"><a href="classrules.html#a2cc677466356d39162991318718023a9">rules::forbid_way_tool_cube</a></div><div class="ttdeci">static void forbid_way_tool_cube(integer player_nr, integer tool_id, way_types wt, coord3d pos_nw, coord3d pos_se, string err)</div></div>
<div class="ttc" id="classrules_html_a32635665b3561aa32c534bf848b51d30"><div class="ttname"><a href="classrules.html#a32635665b3561aa32c534bf848b51d30">rules::forbid_way_tool</a></div><div class="ttdeci">static void forbid_way_tool(integer player_nr, integer tool_id, way_types wt)</div></div>
<div class="ttc" id="classrules_html_a873e22cec4c9364bb72997c130113d03"><div class="ttname"><a href="classrules.html#a873e22cec4c9364bb72997c130113d03">rules::allow_way_tool_cube</a></div><div class="ttdeci">static void allow_way_tool_cube(integer player_nr, integer tool_id, way_types wt, coord3d pos_nw, coord3d pos_se)</div></div>
<div class="ttc" id="api__scenario_8cc_html_a97216b980ac0adf622444cf6fcb19380"><div class="ttname"><a href="api__scenario_8cc.html#a97216b980ac0adf622444cf6fcb19380">coord_to_string</a></div><div class="ttdeci">string coord_to_string(coord c)</div></div>
<div class="ttc" id="api__scenario_8cc_html_a8a329231a844917d360f8ce84d24d636"><div class="ttname"><a href="api__scenario_8cc.html#a8a329231a844917d360f8ce84d24d636">translate</a></div><div class="ttdeci">string translate(string text)</div></div>
<div class="ttc" id="classrules_html_aa1b2a8e1779a4837c3cfad4ef6b469ac"><div class="ttname"><a href="classrules.html#aa1b2a8e1779a4837c3cfad4ef6b469ac">rules::allow_way_tool</a></div><div class="ttdeci">static void allow_way_tool(integer player_nr, integer tool_id, way_types wt)</div></div>
</div><!-- fragment --></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>