-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi__skeleton_8cc_source.html
More file actions
108 lines (106 loc) · 19.2 KB
/
api__skeleton_8cc_source.html
File metadata and controls
108 lines (106 loc) · 19.2 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
<!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_skeleton.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_skeleton.cc</div> </div>
</div><!--header-->
<div class="contents">
<a href="api__skeleton_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">void</span> <a class="code" href="group__scen__skel.html#ga60de64d75454385b23995437f1d72669">start</a>();</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keywordtype">void</span> <a class="code" href="group__scen__skel.html#ga60de64d75454385b23995437f1d72669">start</a>(<span class="keywordtype">int</span> pl_num);</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keywordtype">void</span> <a class="code" href="group__quick__return__func.html#ga8f7187d43d6ca08f59ce949f9c4938f8">resume_game</a>();</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keywordtype">void</span> <a class="code" href="group__quick__return__func.html#ga8f7187d43d6ca08f59ce949f9c4938f8">resume_game</a>(<span class="keywordtype">int</span> pl_num);</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keywordtype">void</span> <a class="code" href="group__ai__skel.html#gac6bf1a12c5c98ddec5b65e07fe74cabe">step</a>();</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keywordtype">void</span> <a class="code" href="group__ai__skel.html#gac954558374aa1d041896a8d6ad7fb617">new_month</a>();</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="keywordtype">void</span> <a class="code" href="group__ai__skel.html#gae84442cfdd65196b1ddafe3125638913">new_year</a>();</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="keywordtype">string</span> <a class="code" href="group__quick__return__func.html#ga0bb5d8a37cb2a83f89384a10fd7f1306">get_map_file</a>();</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="keywordtype">string</span> <a class="code" href="group__scen__skel.html#ga6922ff4b1be417e1d2ca655018a67306">get_about_text</a>(integer pl);</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="keywordtype">string</span> <a class="code" href="group__scen__skel.html#ga706b5bd21f80fc116a158dc964a5cfed">get_rule_text</a>(integer pl);</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="keywordtype">string</span> <a class="code" href="group__scen__skel.html#ga441ddb63d00df531a03dc1811415ed02">get_goal_text</a>(integer pl);</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="keywordtype">string</span> <a class="code" href="group__scen__skel.html#ga40fae968e0f6382017f2632fb86ef873">get_info_text</a>(integer pl);</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="keywordtype">string</span> <a class="code" href="group__scen__skel.html#ga7dd5ed6cedddd109004c47b3dd240f31">get_result_text</a>(integer pl);</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="keywordtype">string</span> <a class="code" href="group__scen__skel.html#gaad826685a2a6868b5d3413739c3c353c">get_debug_text</a>(integer pl);</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="keywordtype">string</span> <a class="code" href="group__quick__return__func.html#gab3933c2368305e7b98f2ee83b2131e1c">get_api_version</a>();</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> integer <a class="code" href="group__scen__skel.html#gacbd2bb976240e0bf782a2eb82acd4f4d">is_scenario_completed</a>(integer pl);</div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="keywordtype">bool</span> <a class="code" href="group__quick__return__func.html#ga2585a55a65cf14fb3d0a222552ffc063">is_tool_allowed</a>(integer pl, integer tool_id, <a class="code" href="api__const_8cc.html#a54cfd1fb3beb4607096d5c42809655af">way_types</a> wt);</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="keywordtype">string</span> <a class="code" href="group__quick__return__func.html#ga67f167f50ac44e2affeec9b47fd76093">is_work_allowed_here</a>(integer pl, integer tool_id, <a class="code" href="classcoord3d.html">coord3d</a> pos);</div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="keywordtype">string</span> <a class="code" href="group__quick__return__func.html#ga0d5799fd17e9149551cf884dba8bc2f8">is_schedule_allowed</a>(integer pl, <a class="code" href="classschedule__x.html">schedule_x</a> schedule);</div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="keywordtype">string</span> <a class="code" href="group__quick__return__func.html#gac19c629dee5fbff4680ffe0ffde000fd">is_convoy_allowed</a>(integer pl, <a class="code" href="classconvoy__x.html">convoy_x</a> convoy, <a class="code" href="classdepot__x.html">depot_x</a> depot);</div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="keywordtype">string</span> <a class="code" href="group__quick__return__func.html#gadb4b9bcd6c3f84d74ea4190f7eee0f55">jump_to_link_executed</a>(<a class="code" href="classcoord3d.html">coord3d</a> pos);</div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="keywordtype">bool</span> <a class="code" href="group__quick__return__func.html#ga467877e90945e121fda79cc1fbb99333">init</a>(<a class="code" href="classplayer__x.html">player_x</a> pl);</div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="keywordtype">bool</span> <a class="code" href="group__quick__return__func.html#ga272768f088c52bcf7c5006e3c91cf38a">exit</a>(<a class="code" href="classplayer__x.html">player_x</a> pl);</div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="keywordtype">string</span> <a class="code" href="group__tool__skel.html#ga648f9270b5286861b453d4994601bc33">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">int</span> keys);</div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="keywordtype">string</span> <a class="code" href="group__tool__skel.html#ga328be69376a1fa772b50a231678e59f6">do_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">int</span> keys);</div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="keywordtype">void</span> <a class="code" href="group__tool__skel.html#ga18d44591da38d8de61cee51c724f9bb1">mark_tiles</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">int</span> keys);</div><div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <span class="keywordtype">bool</span> <a class="code" href="group__tool__only.html#ga8cfe6ac7a7470ad1ffb2baea843945e1">mark_tile</a>(<a class="code" href="classcoord3d.html">coord3d</a> pos);</div><div class="line"><a name="l00312"></a><span class="lineno"> 312</span> <span class="keywordtype">void</span> <a class="code" href="group__quick__return__func.html#gab439c7cd0533a77204c49910ec50851d">is_valid_pos</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="classcoord3d.html">coord3d</a> <a class="code" href="group__scen__skel.html#ga60de64d75454385b23995437f1d72669">start</a>);</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="group__quick__return__func_html_gab3933c2368305e7b98f2ee83b2131e1c"><div class="ttname"><a href="group__quick__return__func.html#gab3933c2368305e7b98f2ee83b2131e1c">get_api_version</a></div><div class="ttdeci">string get_api_version()</div></div>
<div class="ttc" id="group__tool__skel_html_ga648f9270b5286861b453d4994601bc33"><div class="ttname"><a href="group__tool__skel.html#ga648f9270b5286861b453d4994601bc33">work</a></div><div class="ttdeci">string work(player_x pl, coord3d pos, int keys)</div></div>
<div class="ttc" id="group__scen__skel_html_ga7dd5ed6cedddd109004c47b3dd240f31"><div class="ttname"><a href="group__scen__skel.html#ga7dd5ed6cedddd109004c47b3dd240f31">get_result_text</a></div><div class="ttdeci">string get_result_text(integer pl)</div></div>
<div class="ttc" id="group__scen__skel_html_ga40fae968e0f6382017f2632fb86ef873"><div class="ttname"><a href="group__scen__skel.html#ga40fae968e0f6382017f2632fb86ef873">get_info_text</a></div><div class="ttdeci">string get_info_text(integer pl)</div></div>
<div class="ttc" id="group__ai__skel_html_gae84442cfdd65196b1ddafe3125638913"><div class="ttname"><a href="group__ai__skel.html#gae84442cfdd65196b1ddafe3125638913">new_year</a></div><div class="ttdeci">void new_year()</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="group__quick__return__func_html_ga8f7187d43d6ca08f59ce949f9c4938f8"><div class="ttname"><a href="group__quick__return__func.html#ga8f7187d43d6ca08f59ce949f9c4938f8">resume_game</a></div><div class="ttdeci">void resume_game()</div></div>
<div class="ttc" id="group__quick__return__func_html_gab439c7cd0533a77204c49910ec50851d"><div class="ttname"><a href="group__quick__return__func.html#gab439c7cd0533a77204c49910ec50851d">is_valid_pos</a></div><div class="ttdeci">void is_valid_pos(player_x pl, coord3d pos, coord3d start)</div></div>
<div class="ttc" id="group__ai__skel_html_gac954558374aa1d041896a8d6ad7fb617"><div class="ttname"><a href="group__ai__skel.html#gac954558374aa1d041896a8d6ad7fb617">new_month</a></div><div class="ttdeci">void new_month()</div></div>
<div class="ttc" id="group__quick__return__func_html_ga67f167f50ac44e2affeec9b47fd76093"><div class="ttname"><a href="group__quick__return__func.html#ga67f167f50ac44e2affeec9b47fd76093">is_work_allowed_here</a></div><div class="ttdeci">string is_work_allowed_here(integer pl, integer tool_id, coord3d pos)</div></div>
<div class="ttc" id="group__quick__return__func_html_ga272768f088c52bcf7c5006e3c91cf38a"><div class="ttname"><a href="group__quick__return__func.html#ga272768f088c52bcf7c5006e3c91cf38a">exit</a></div><div class="ttdeci">bool exit(player_x pl)</div></div>
<div class="ttc" id="group__scen__skel_html_ga6922ff4b1be417e1d2ca655018a67306"><div class="ttname"><a href="group__scen__skel.html#ga6922ff4b1be417e1d2ca655018a67306">get_about_text</a></div><div class="ttdeci">string get_about_text(integer pl)</div></div>
<div class="ttc" id="group__tool__skel_html_ga328be69376a1fa772b50a231678e59f6"><div class="ttname"><a href="group__tool__skel.html#ga328be69376a1fa772b50a231678e59f6">do_work</a></div><div class="ttdeci">string do_work(player_x pl, coord3d start, coord3d end, int keys)</div></div>
<div class="ttc" id="group__scen__skel_html_ga441ddb63d00df531a03dc1811415ed02"><div class="ttname"><a href="group__scen__skel.html#ga441ddb63d00df531a03dc1811415ed02">get_goal_text</a></div><div class="ttdeci">string get_goal_text(integer pl)</div></div>
<div class="ttc" id="group__tool__skel_html_ga18d44591da38d8de61cee51c724f9bb1"><div class="ttname"><a href="group__tool__skel.html#ga18d44591da38d8de61cee51c724f9bb1">mark_tiles</a></div><div class="ttdeci">void mark_tiles(player_x pl, coord3d start, coord3d end, int keys)</div></div>
<div class="ttc" id="group__scen__skel_html_gaad826685a2a6868b5d3413739c3c353c"><div class="ttname"><a href="group__scen__skel.html#gaad826685a2a6868b5d3413739c3c353c">get_debug_text</a></div><div class="ttdeci">string get_debug_text(integer pl)</div></div>
<div class="ttc" id="group__quick__return__func_html_gadb4b9bcd6c3f84d74ea4190f7eee0f55"><div class="ttname"><a href="group__quick__return__func.html#gadb4b9bcd6c3f84d74ea4190f7eee0f55">jump_to_link_executed</a></div><div class="ttdeci">string jump_to_link_executed(coord3d pos)</div></div>
<div class="ttc" id="classconvoy__x_html"><div class="ttname"><a href="classconvoy__x.html">convoy_x</a></div><div class="ttdef"><b>Definition:</b> <a href="api__convoy_8cc_source.html#l00038">api_convoy.cc:38</a></div></div>
<div class="ttc" id="classschedule__x_html"><div class="ttname"><a href="classschedule__x.html">schedule_x</a></div><div class="ttdef"><b>Definition:</b> <a href="api__schedule_8cc_source.html#l00036">api_schedule.cc:36</a></div></div>
<div class="ttc" id="group__quick__return__func_html_gac19c629dee5fbff4680ffe0ffde000fd"><div class="ttname"><a href="group__quick__return__func.html#gac19c629dee5fbff4680ffe0ffde000fd">is_convoy_allowed</a></div><div class="ttdeci">string is_convoy_allowed(integer pl, convoy_x convoy, depot_x depot)</div></div>
<div class="ttc" id="classdepot__x_html"><div class="ttname"><a href="classdepot__x.html">depot_x</a></div><div class="ttdef"><b>Definition:</b> <a href="api__map__objects_8cc_source.html#l00127">api_map_objects.cc:127</a></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="group__ai__skel_html_gac6bf1a12c5c98ddec5b65e07fe74cabe"><div class="ttname"><a href="group__ai__skel.html#gac6bf1a12c5c98ddec5b65e07fe74cabe">step</a></div><div class="ttdeci">void step()</div></div>
<div class="ttc" id="group__scen__skel_html_ga706b5bd21f80fc116a158dc964a5cfed"><div class="ttname"><a href="group__scen__skel.html#ga706b5bd21f80fc116a158dc964a5cfed">get_rule_text</a></div><div class="ttdeci">string get_rule_text(integer pl)</div></div>
<div class="ttc" id="group__quick__return__func_html_ga0bb5d8a37cb2a83f89384a10fd7f1306"><div class="ttname"><a href="group__quick__return__func.html#ga0bb5d8a37cb2a83f89384a10fd7f1306">get_map_file</a></div><div class="ttdeci">string get_map_file()</div></div>
<div class="ttc" id="group__quick__return__func_html_ga0d5799fd17e9149551cf884dba8bc2f8"><div class="ttname"><a href="group__quick__return__func.html#ga0d5799fd17e9149551cf884dba8bc2f8">is_schedule_allowed</a></div><div class="ttdeci">string is_schedule_allowed(integer pl, schedule_x schedule)</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="group__tool__only_html_ga8cfe6ac7a7470ad1ffb2baea843945e1"><div class="ttname"><a href="group__tool__only.html#ga8cfe6ac7a7470ad1ffb2baea843945e1">mark_tile</a></div><div class="ttdeci">bool mark_tile(coord3d pos)</div></div>
<div class="ttc" id="group__scen__skel_html_gacbd2bb976240e0bf782a2eb82acd4f4d"><div class="ttname"><a href="group__scen__skel.html#gacbd2bb976240e0bf782a2eb82acd4f4d">is_scenario_completed</a></div><div class="ttdeci">integer is_scenario_completed(integer pl)</div></div>
<div class="ttc" id="group__quick__return__func_html_ga2585a55a65cf14fb3d0a222552ffc063"><div class="ttname"><a href="group__quick__return__func.html#ga2585a55a65cf14fb3d0a222552ffc063">is_tool_allowed</a></div><div class="ttdeci">bool is_tool_allowed(integer pl, integer tool_id, way_types wt)</div></div>
<div class="ttc" id="group__quick__return__func_html_ga467877e90945e121fda79cc1fbb99333"><div class="ttname"><a href="group__quick__return__func.html#ga467877e90945e121fda79cc1fbb99333">init</a></div><div class="ttdeci">bool init(player_x pl)</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>