-
Notifications
You must be signed in to change notification settings - Fork 0
/
api__skeleton_8cc.html
144 lines (140 loc) · 15.5 KB
/
api__skeleton_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
<!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 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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">api_skeleton.cc File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a href="api__skeleton_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="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga328be69376a1fa772b50a231678e59f6"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tool__skel.html#ga328be69376a1fa772b50a231678e59f6">do_work</a> (<a class="el" href="classplayer__x.html">player_x</a> pl, <a class="el" href="classcoord3d.html">coord3d</a> <a class="el" href="group__ai__skel.html#ga3e366a4f9cad71fb85b134e444690559">start</a>, <a class="el" href="classcoord3d.html">coord3d</a> end, int keys)</td></tr>
<tr class="separator:ga328be69376a1fa772b50a231678e59f6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga272768f088c52bcf7c5006e3c91cf38a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__quick__return__func.html#ga272768f088c52bcf7c5006e3c91cf38a">exit</a> (<a class="el" href="classplayer__x.html">player_x</a> pl)</td></tr>
<tr class="separator:ga272768f088c52bcf7c5006e3c91cf38a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6922ff4b1be417e1d2ca655018a67306"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__scen__skel.html#ga6922ff4b1be417e1d2ca655018a67306">get_about_text</a> (integer pl)</td></tr>
<tr class="separator:ga6922ff4b1be417e1d2ca655018a67306"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab3933c2368305e7b98f2ee83b2131e1c"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__quick__return__func.html#gab3933c2368305e7b98f2ee83b2131e1c">get_api_version</a> ()</td></tr>
<tr class="separator:gab3933c2368305e7b98f2ee83b2131e1c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaad826685a2a6868b5d3413739c3c353c"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__scen__skel.html#gaad826685a2a6868b5d3413739c3c353c">get_debug_text</a> (integer pl)</td></tr>
<tr class="separator:gaad826685a2a6868b5d3413739c3c353c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga441ddb63d00df531a03dc1811415ed02"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__scen__skel.html#ga441ddb63d00df531a03dc1811415ed02">get_goal_text</a> (integer pl)</td></tr>
<tr class="separator:ga441ddb63d00df531a03dc1811415ed02"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga40fae968e0f6382017f2632fb86ef873"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__scen__skel.html#ga40fae968e0f6382017f2632fb86ef873">get_info_text</a> (integer pl)</td></tr>
<tr class="separator:ga40fae968e0f6382017f2632fb86ef873"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0bb5d8a37cb2a83f89384a10fd7f1306"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__quick__return__func.html#ga0bb5d8a37cb2a83f89384a10fd7f1306">get_map_file</a> ()</td></tr>
<tr class="separator:ga0bb5d8a37cb2a83f89384a10fd7f1306"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7dd5ed6cedddd109004c47b3dd240f31"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__scen__skel.html#ga7dd5ed6cedddd109004c47b3dd240f31">get_result_text</a> (integer pl)</td></tr>
<tr class="separator:ga7dd5ed6cedddd109004c47b3dd240f31"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga706b5bd21f80fc116a158dc964a5cfed"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__scen__skel.html#ga706b5bd21f80fc116a158dc964a5cfed">get_rule_text</a> (integer pl)</td></tr>
<tr class="separator:ga706b5bd21f80fc116a158dc964a5cfed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga467877e90945e121fda79cc1fbb99333"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__quick__return__func.html#ga467877e90945e121fda79cc1fbb99333">init</a> (<a class="el" href="classplayer__x.html">player_x</a> pl)</td></tr>
<tr class="separator:ga467877e90945e121fda79cc1fbb99333"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac19c629dee5fbff4680ffe0ffde000fd"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__quick__return__func.html#gac19c629dee5fbff4680ffe0ffde000fd">is_convoy_allowed</a> (integer pl, <a class="el" href="classconvoy__x.html">convoy_x</a> convoy, <a class="el" href="classdepot__x.html">depot_x</a> depot)</td></tr>
<tr class="separator:gac19c629dee5fbff4680ffe0ffde000fd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacbd2bb976240e0bf782a2eb82acd4f4d"><td class="memItemLeft" align="right" valign="top">integer </td><td class="memItemRight" valign="bottom"><a class="el" href="group__scen__skel.html#gacbd2bb976240e0bf782a2eb82acd4f4d">is_scenario_completed</a> (integer pl)</td></tr>
<tr class="separator:gacbd2bb976240e0bf782a2eb82acd4f4d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0d5799fd17e9149551cf884dba8bc2f8"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__quick__return__func.html#ga0d5799fd17e9149551cf884dba8bc2f8">is_schedule_allowed</a> (integer pl, <a class="el" href="classschedule__x.html">schedule_x</a> schedule)</td></tr>
<tr class="separator:ga0d5799fd17e9149551cf884dba8bc2f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2585a55a65cf14fb3d0a222552ffc063"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__quick__return__func.html#ga2585a55a65cf14fb3d0a222552ffc063">is_tool_allowed</a> (integer pl, integer tool_id, <a class="el" href="api__const_8cc.html#a54cfd1fb3beb4607096d5c42809655af">way_types</a> wt)</td></tr>
<tr class="separator:ga2585a55a65cf14fb3d0a222552ffc063"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab439c7cd0533a77204c49910ec50851d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__quick__return__func.html#gab439c7cd0533a77204c49910ec50851d">is_valid_pos</a> (<a class="el" href="classplayer__x.html">player_x</a> pl, <a class="el" href="classcoord3d.html">coord3d</a> pos, <a class="el" href="classcoord3d.html">coord3d</a> <a class="el" href="group__ai__skel.html#ga3e366a4f9cad71fb85b134e444690559">start</a>)</td></tr>
<tr class="separator:gab439c7cd0533a77204c49910ec50851d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga67f167f50ac44e2affeec9b47fd76093"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__quick__return__func.html#ga67f167f50ac44e2affeec9b47fd76093">is_work_allowed_here</a> (integer pl, integer tool_id, <a class="el" href="classcoord3d.html">coord3d</a> pos)</td></tr>
<tr class="separator:ga67f167f50ac44e2affeec9b47fd76093"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadb4b9bcd6c3f84d74ea4190f7eee0f55"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__quick__return__func.html#gadb4b9bcd6c3f84d74ea4190f7eee0f55">jump_to_link_executed</a> (<a class="el" href="classcoord3d.html">coord3d</a> pos)</td></tr>
<tr class="separator:gadb4b9bcd6c3f84d74ea4190f7eee0f55"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8cfe6ac7a7470ad1ffb2baea843945e1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tool__only.html#ga8cfe6ac7a7470ad1ffb2baea843945e1">mark_tile</a> (<a class="el" href="classcoord3d.html">coord3d</a> pos)</td></tr>
<tr class="separator:ga8cfe6ac7a7470ad1ffb2baea843945e1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga18d44591da38d8de61cee51c724f9bb1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tool__skel.html#ga18d44591da38d8de61cee51c724f9bb1">mark_tiles</a> (<a class="el" href="classplayer__x.html">player_x</a> pl, <a class="el" href="classcoord3d.html">coord3d</a> <a class="el" href="group__ai__skel.html#ga3e366a4f9cad71fb85b134e444690559">start</a>, <a class="el" href="classcoord3d.html">coord3d</a> end, int keys)</td></tr>
<tr class="separator:ga18d44591da38d8de61cee51c724f9bb1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac954558374aa1d041896a8d6ad7fb617"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ai__skel.html#gac954558374aa1d041896a8d6ad7fb617">new_month</a> ()</td></tr>
<tr class="separator:gac954558374aa1d041896a8d6ad7fb617"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae84442cfdd65196b1ddafe3125638913"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ai__skel.html#gae84442cfdd65196b1ddafe3125638913">new_year</a> ()</td></tr>
<tr class="separator:gae84442cfdd65196b1ddafe3125638913"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8f7187d43d6ca08f59ce949f9c4938f8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__quick__return__func.html#ga8f7187d43d6ca08f59ce949f9c4938f8">resume_game</a> ()</td></tr>
<tr class="separator:ga8f7187d43d6ca08f59ce949f9c4938f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7e82c4a303ffc379d846b26ef07b9c81"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ai__skel.html#ga7e82c4a303ffc379d846b26ef07b9c81">resume_game</a> (int pl_num)</td></tr>
<tr class="separator:ga7e82c4a303ffc379d846b26ef07b9c81"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga60de64d75454385b23995437f1d72669"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__scen__skel.html#ga60de64d75454385b23995437f1d72669">start</a> ()</td></tr>
<tr class="separator:ga60de64d75454385b23995437f1d72669"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3e366a4f9cad71fb85b134e444690559"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ai__skel.html#ga3e366a4f9cad71fb85b134e444690559">start</a> (int pl_num)</td></tr>
<tr class="separator:ga3e366a4f9cad71fb85b134e444690559"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac6bf1a12c5c98ddec5b65e07fe74cabe"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ai__skel.html#gac6bf1a12c5c98ddec5b65e07fe74cabe">step</a> ()</td></tr>
<tr class="separator:gac6bf1a12c5c98ddec5b65e07fe74cabe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga648f9270b5286861b453d4994601bc33"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tool__skel.html#ga648f9270b5286861b453d4994601bc33">work</a> (<a class="el" href="classplayer__x.html">player_x</a> pl, <a class="el" href="classcoord3d.html">coord3d</a> pos, int keys)</td></tr>
<tr class="separator:ga648f9270b5286861b453d4994601bc33"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Documents the necessary functions to be implemented by a script </p>
<p class="definition">Definition in file <a class="el" href="api__skeleton_8cc_source.html">api_skeleton.cc</a>.</p>
</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>