-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi__command_8cc_source.html
More file actions
105 lines (103 loc) · 19.3 KB
/
api__command_8cc_source.html
File metadata and controls
105 lines (103 loc) · 19.3 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
<!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_command.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_command.cc</div> </div>
</div><!--header-->
<div class="contents">
<a href="api__command_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="l00008"></a><span class="lineno"><a class="line" href="classcommand__x.html"> 8</a></span> <span class="keyword">class </span><a class="code" href="classcommand__x.html">command_x</a> {</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  <a class="code" href="classcommand__x.html#ae707632331eff471b23c48f02577e120">command_x</a>(<a class="code" href="api__const_8cc.html#af4bb3e2d05b95af700484370ad057fe2">tool_ids</a> <span class="keywordtype">id</span>);</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  integer <a class="code" href="classcommand__x.html#a8287e1772a24f32c9c51497b5a43d25f">get_flags</a>();</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="keywordtype">void</span> <a class="code" href="classcommand__x.html#a042abdd9b22844f54503654c3cf3f982">set_flags</a>(integer flags);</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordtype">string</span> <a class="code" href="classcommand__x.html#a1caeb312c1f26e254831ed90e375fb97">work</a>(<a class="code" href="classplayer__x.html">player_x</a> pl, <a class="code" href="classcoord3d.html">coord3d</a> pos);</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordtype">string</span> <a class="code" href="classcommand__x.html#a1caeb312c1f26e254831ed90e375fb97">work</a>(<a class="code" href="classplayer__x.html">player_x</a> pl, <a class="code" href="classcoord3d.html">coord3d</a> pos, <span class="keywordtype">string</span> param);</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">string</span> <a class="code" href="classcommand__x.html#a1caeb312c1f26e254831ed90e375fb97">work</a>(<a class="code" href="classplayer__x.html">player_x</a> pl, <a class="code" href="classcoord3d.html">coord3d</a> <a class="code" href="group__scen__skel.html#ga60de64d75454385b23995437f1d72669">start</a>, <a class="code" href="classcoord3d.html">coord3d</a> end, <span class="keywordtype">string</span> param);</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">static</span> <span class="keywordtype">string</span> <a class="code" href="classcommand__x.html#a1881d81fa6116af1227429b1c7f7699c">build_way</a>(<a class="code" href="classplayer__x.html">player_x</a> pl, <a class="code" href="classcoord3d.html">coord3d</a> <a class="code" href="group__scen__skel.html#ga60de64d75454385b23995437f1d72669">start</a>, <a class="code" href="classcoord3d.html">coord3d</a> end, <a class="code" href="classway__desc__x.html">way_desc_x</a> way, <span class="keywordtype">bool</span> straight);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">static</span> <span class="keywordtype">string</span> <a class="code" href="classcommand__x.html#a1778b97ba2d87733756db783d2d5711e">build_road</a>(<a class="code" href="classplayer__x.html">player_x</a> pl, <a class="code" href="classcoord3d.html">coord3d</a> <a class="code" href="group__scen__skel.html#ga60de64d75454385b23995437f1d72669">start</a>, <a class="code" href="classcoord3d.html">coord3d</a> end, <a class="code" href="classway__desc__x.html">way_desc_x</a> way, <span class="keywordtype">bool</span> straight, <span class="keywordtype">bool</span> keep_city_roads);</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">static</span> <span class="keywordtype">string</span> <a class="code" href="classcommand__x.html#ad073cf9de860e5a6b1d122d211847fe2">build_depot</a>(<a class="code" href="classplayer__x.html">player_x</a> pl, <a class="code" href="classcoord3d.html">coord3d</a> pos, <a class="code" href="classbuilding__desc__x.html">building_desc_x</a> depot);</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keyword">static</span> <span class="keywordtype">string</span> <a class="code" href="classcommand__x.html#a8b909f422e0f078fe980b41fb62ac388">build_station</a>(<a class="code" href="classplayer__x.html">player_x</a> pl, <a class="code" href="classcoord3d.html">coord3d</a> pos, <a class="code" href="classbuilding__desc__x.html">building_desc_x</a> station, <a class="code" href="classdir.html">dir</a> rotaton);</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keyword">static</span> <span class="keywordtype">string</span> <a class="code" href="classcommand__x.html#a36da06662ec437f617a95812752a5324">build_bridge</a>(<a class="code" href="classplayer__x.html">player_x</a> pl, <a class="code" href="classcoord3d.html">coord3d</a> <a class="code" href="group__scen__skel.html#ga60de64d75454385b23995437f1d72669">start</a>, <a class="code" href="classcoord3d.html">coord3d</a> end, <a class="code" href="classbridge__desc__x.html">bridge_desc_x</a> bridge);</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keyword">static</span> <span class="keywordtype">string</span> <a class="code" href="classcommand__x.html#a74043c2a6801a099ba185fc6d5365471">build_bridge_at</a>(<a class="code" href="classplayer__x.html">player_x</a> pl, <a class="code" href="classcoord3d.html">coord3d</a> <a class="code" href="group__scen__skel.html#ga60de64d75454385b23995437f1d72669">start</a>, <a class="code" href="classbridge__desc__x.html">bridge_desc_x</a> bridge);</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keyword">static</span> <span class="keywordtype">string</span> <a class="code" href="classcommand__x.html#af1e09f3baadc144d7b8b40033a19ee41">set_slope</a>(<a class="code" href="classplayer__x.html">player_x</a> pl, <a class="code" href="classcoord3d.html">coord3d</a> pos, <a class="code" href="classslope.html">slope</a> <a class="code" href="classslope.html">slope</a>);</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keyword">static</span> <span class="keywordtype">string</span> <a class="code" href="classcommand__x.html#a496bdf05e9831fa3267248b9a2108f94">restore_slope</a>(<a class="code" href="classplayer__x.html">player_x</a> pl, <a class="code" href="classcoord3d.html">coord3d</a> pos);</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keyword">static</span> <span class="keywordtype">string</span> <a class="code" href="classcommand__x.html#a79eee2412e7e61cf48527abac7242f0c">can_set_slope</a>(<a class="code" href="classplayer__x.html">player_x</a> pl, <a class="code" href="classcoord3d.html">coord3d</a> pos, <a class="code" href="classslope.html">slope</a> <a class="code" href="classslope.html">slope</a>);</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keyword">static</span> integer <a class="code" href="classcommand__x.html#a15bf2f169f54040b540ec0cbf85dea74">slope_get_price</a>(<a class="code" href="classslope.html">slope</a>);</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keyword">static</span> <span class="keywordtype">string</span> <a class="code" href="classcommand__x.html#a571b3665d2f32d5f83fd8621d260fd64">build_sign_at</a>(<a class="code" href="classplayer__x.html">player_x</a> pl, <a class="code" href="classcoord3d.html">coord3d</a> pos, <a class="code" href="classsign__desc__x.html">sign_desc_x</a> sign);</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="keyword">static</span> <span class="keywordtype">string</span> <a class="code" href="classcommand__x.html#a96e7f0c5bcbc8f7ba3fc9754a2a3cf1b">build_wayobj</a>(<a class="code" href="classplayer__x.html">player_x</a> pl, <a class="code" href="classcoord3d.html">coord3d</a> <a class="code" href="group__scen__skel.html#ga60de64d75454385b23995437f1d72669">start</a>, <a class="code" href="classcoord3d.html">coord3d</a> end, <a class="code" href="classwayobj__desc__x.html">wayobj_desc_x</a> wayobj);</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="keyword">static</span> <span class="keywordtype">string</span> <a class="code" href="classcommand__x.html#abe1edc67dfe85bc0392e9e895195cc4e">change_climate_at</a>(<a class="code" href="classplayer__x.html">player_x</a> pl, <a class="code" href="classcoord3d.html">coord3d</a> pos, integer climate);</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> };</div><div class="ttc" id="classcommand__x_html_a496bdf05e9831fa3267248b9a2108f94"><div class="ttname"><a href="classcommand__x.html#a496bdf05e9831fa3267248b9a2108f94">command_x::restore_slope</a></div><div class="ttdeci">static string restore_slope(player_x pl, coord3d pos)</div></div>
<div class="ttc" id="api__const_8cc_html_af4bb3e2d05b95af700484370ad057fe2"><div class="ttname"><a href="api__const_8cc.html#af4bb3e2d05b95af700484370ad057fe2">tool_ids</a></div><div class="ttdeci">tool_ids</div><div class="ttdef"><b>Definition:</b> <a href="api__const_8cc_source.html#l00006">api_const.cc:6</a></div></div>
<div class="ttc" id="classcommand__x_html_a74043c2a6801a099ba185fc6d5365471"><div class="ttname"><a href="classcommand__x.html#a74043c2a6801a099ba185fc6d5365471">command_x::build_bridge_at</a></div><div class="ttdeci">static string build_bridge_at(player_x pl, coord3d start, bridge_desc_x bridge)</div></div>
<div class="ttc" id="classwayobj__desc__x_html"><div class="ttname"><a href="classwayobj__desc__x.html">wayobj_desc_x</a></div><div class="ttdef"><b>Definition:</b> <a href="api__obj__desc_8cc_source.html#l00479">api_obj_desc.cc:479</a></div></div>
<div class="ttc" id="classsign__desc__x_html"><div class="ttname"><a href="classsign__desc__x.html">sign_desc_x</a></div><div class="ttdef"><b>Definition:</b> <a href="api__obj__desc_8cc_source.html#l00432">api_obj_desc.cc:432</a></div></div>
<div class="ttc" id="classcommand__x_html_a8b909f422e0f078fe980b41fb62ac388"><div class="ttname"><a href="classcommand__x.html#a8b909f422e0f078fe980b41fb62ac388">command_x::build_station</a></div><div class="ttdeci">static string build_station(player_x pl, coord3d pos, building_desc_x station, dir rotaton)</div></div>
<div class="ttc" id="classcommand__x_html_a042abdd9b22844f54503654c3cf3f982"><div class="ttname"><a href="classcommand__x.html#a042abdd9b22844f54503654c3cf3f982">command_x::set_flags</a></div><div class="ttdeci">void set_flags(integer flags)</div></div>
<div class="ttc" id="classcommand__x_html"><div class="ttname"><a href="classcommand__x.html">command_x</a></div><div class="ttdef"><b>Definition:</b> <a href="api__command_8cc_source.html#l00008">api_command.cc:8</a></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="classbuilding__desc__x_html"><div class="ttname"><a href="classbuilding__desc__x.html">building_desc_x</a></div><div class="ttdef"><b>Definition:</b> <a href="api__obj__desc_8cc_source.html#l00163">api_obj_desc.cc:163</a></div></div>
<div class="ttc" id="classcommand__x_html_a96e7f0c5bcbc8f7ba3fc9754a2a3cf1b"><div class="ttname"><a href="classcommand__x.html#a96e7f0c5bcbc8f7ba3fc9754a2a3cf1b">command_x::build_wayobj</a></div><div class="ttdeci">static string build_wayobj(player_x pl, coord3d start, coord3d end, wayobj_desc_x wayobj)</div></div>
<div class="ttc" id="classslope_html"><div class="ttname"><a href="classslope.html">slope</a></div><div class="ttdef"><b>Definition:</b> <a href="api__simple_8cc_source.html#l00180">api_simple.cc:180</a></div></div>
<div class="ttc" id="classcommand__x_html_a8287e1772a24f32c9c51497b5a43d25f"><div class="ttname"><a href="classcommand__x.html#a8287e1772a24f32c9c51497b5a43d25f">command_x::get_flags</a></div><div class="ttdeci">integer get_flags()</div></div>
<div class="ttc" id="classcommand__x_html_a1881d81fa6116af1227429b1c7f7699c"><div class="ttname"><a href="classcommand__x.html#a1881d81fa6116af1227429b1c7f7699c">command_x::build_way</a></div><div class="ttdeci">static string build_way(player_x pl, coord3d start, coord3d end, way_desc_x way, bool straight)</div></div>
<div class="ttc" id="classcommand__x_html_ae707632331eff471b23c48f02577e120"><div class="ttname"><a href="classcommand__x.html#ae707632331eff471b23c48f02577e120">command_x::command_x</a></div><div class="ttdeci">command_x(tool_ids id)</div></div>
<div class="ttc" id="classdir_html"><div class="ttname"><a href="classdir.html">dir</a></div><div class="ttdef"><b>Definition:</b> <a href="api__simple_8cc_source.html#l00110">api_simple.cc:110</a></div></div>
<div class="ttc" id="classcommand__x_html_a571b3665d2f32d5f83fd8621d260fd64"><div class="ttname"><a href="classcommand__x.html#a571b3665d2f32d5f83fd8621d260fd64">command_x::build_sign_at</a></div><div class="ttdeci">static string build_sign_at(player_x pl, coord3d pos, sign_desc_x sign)</div></div>
<div class="ttc" id="classcommand__x_html_a79eee2412e7e61cf48527abac7242f0c"><div class="ttname"><a href="classcommand__x.html#a79eee2412e7e61cf48527abac7242f0c">command_x::can_set_slope</a></div><div class="ttdeci">static string can_set_slope(player_x pl, coord3d pos, slope slope)</div></div>
<div class="ttc" id="classcommand__x_html_a36da06662ec437f617a95812752a5324"><div class="ttname"><a href="classcommand__x.html#a36da06662ec437f617a95812752a5324">command_x::build_bridge</a></div><div class="ttdeci">static string build_bridge(player_x pl, coord3d start, coord3d end, bridge_desc_x bridge)</div></div>
<div class="ttc" id="classcommand__x_html_ad073cf9de860e5a6b1d122d211847fe2"><div class="ttname"><a href="classcommand__x.html#ad073cf9de860e5a6b1d122d211847fe2">command_x::build_depot</a></div><div class="ttdeci">static string build_depot(player_x pl, coord3d pos, building_desc_x depot)</div></div>
<div class="ttc" id="classcommand__x_html_a1caeb312c1f26e254831ed90e375fb97"><div class="ttname"><a href="classcommand__x.html#a1caeb312c1f26e254831ed90e375fb97">command_x::work</a></div><div class="ttdeci">string work(player_x pl, coord3d pos)</div></div>
<div class="ttc" id="group__scen__skel_html_ga60de64d75454385b23995437f1d72669"><div class="ttname"><a href="group__scen__skel.html#ga60de64d75454385b23995437f1d72669">start</a></div><div class="ttdeci">void start()</div></div>
<div class="ttc" id="classbridge__desc__x_html"><div class="ttname"><a href="classbridge__desc__x.html">bridge_desc_x</a></div><div class="ttdef"><b>Definition:</b> <a href="api__obj__desc_8cc_source.html#l00344">api_obj_desc.cc:344</a></div></div>
<div class="ttc" id="classplayer__x_html"><div class="ttname"><a href="classplayer__x.html">player_x</a></div><div class="ttdef"><b>Definition:</b> <a href="api__player_8cc_source.html#l00006">api_player.cc:6</a></div></div>
<div class="ttc" id="classcommand__x_html_abe1edc67dfe85bc0392e9e895195cc4e"><div class="ttname"><a href="classcommand__x.html#abe1edc67dfe85bc0392e9e895195cc4e">command_x::change_climate_at</a></div><div class="ttdeci">static string change_climate_at(player_x pl, coord3d pos, integer climate)</div></div>
<div class="ttc" id="classcommand__x_html_af1e09f3baadc144d7b8b40033a19ee41"><div class="ttname"><a href="classcommand__x.html#af1e09f3baadc144d7b8b40033a19ee41">command_x::set_slope</a></div><div class="ttdeci">static string set_slope(player_x pl, coord3d pos, slope slope)</div></div>
<div class="ttc" id="classcommand__x_html_a1778b97ba2d87733756db783d2d5711e"><div class="ttname"><a href="classcommand__x.html#a1778b97ba2d87733756db783d2d5711e">command_x::build_road</a></div><div class="ttdeci">static string build_road(player_x pl, coord3d start, coord3d end, way_desc_x way, bool straight, bool keep_city_roads)</div></div>
<div class="ttc" id="classcommand__x_html_a15bf2f169f54040b540ec0cbf85dea74"><div class="ttname"><a href="classcommand__x.html#a15bf2f169f54040b540ec0cbf85dea74">command_x::slope_get_price</a></div><div class="ttdeci">static integer slope_get_price(slope)</div></div>
<div class="ttc" id="classway__desc__x_html"><div class="ttname"><a href="classway__desc__x.html">way_desc_x</a></div><div class="ttdef"><b>Definition:</b> <a href="api__obj__desc_8cc_source.html#l00313">api_obj_desc.cc:313</a></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>