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
|
/*
* This file is part of the Simutrans project under the Artistic License.
* (see LICENSE.txt)
*/
/** @file simutrans_doc.h Just contains pages of exciting documentation */
/**
* @mainpage
*
* Simutrans
*
* @tableofcontents
*
* Simutrans Code Documentation
*
* License
* =======
*
* Simutrans is licensed under the Artistic License version 1.0. The Artistic License 1.0 is an OSI-approved license which allows for use, distribution, modification, and distribution of modified versions, under the terms of the Artistic License 1.0. For the complete license text see LICENSE.txt.
*
* Simutrans paksets (which are necessary to run the game) have their own license, but no one is included alongside this code.
*
*
*
*
* @section s_squirrel squirrel Scripting language
* ------------------
*
* The scripts have to be written in squirrel. The manual can be found at <a href="http://squirrel-lang.org/">Squirrel main page</a>.
* As squirrels like to crack nuts, understandably the script files get the extension '.nut'.
*
* @subsection sec_scenarios Scripted scenarios
*
* ....
*
* ### How to create a scenario.
*
* You first need an @e idea - a vision what a scenario may look like. Then you have
* to cast this idea into a @e savegame. That is, create the world in which your scenario will live.
* You are the ruler of this toy universe, you are in charge of the rules, which go into the @e script.
*
* ### Recommended directory structure
*
* The scenario plays in a savegame. This savegame is tied to the pak-set you are using (e.g. pak64, pak128.Britain).
* Hence, the scenario files have to go into a sub-folder of the pak-set.
* The pak-set is found in a directory named pak-something, which is in the same directory, where the program
* itself is located or under user-directory/addons/.
*
* Your scenario file goes into the folder
*
* <tt>
* pak-something/scenario/myscenario/
* </tt>
*
* Scenarios can also be put into the addons folder:
*
* <tt>
* addons/pak-something/scenario/myscenario/
* </tt>
*
*
* @subsection sec_ai_player Scripted AI players
*
* ....
*
* ### Recommended directory structure
*
* Your script file goes into the folder
*
* <tt>
* ai/myai/
* </tt>
*
* The main script file must be
*
* <tt>
* ai/myai/ai.nut
* </tt>
*
* The ai scripts can also be put into
*
* <tt>
* addons/ai/myai/
* </tt>
*
* @subsection sec_scripted_tools Scripted tools
*
* ....
*
* ### Recommended directory structure
*
* The script file (tool.nut) as well as the configuration file (description.tab) go into
*
* <tt>
* pak-something/tool/mytool/
* </tt>
*
* Related pak-files have to be placed in
*
* <tt>
* pak-something/
* </tt>
*
*
* Check out the sections on the <a href="modules.html">Modules</a> page.
*/
/**
* @defgroup squirrel-scen-api Squirrel scenario interface
*
* The following methods are vital for the functioning of a scripted scenarios.
* They will be called from simutrans to interact with the script. You should consider
* implementing them.
*
*/
/**
* @defgroup squirrel-ai-api Squirrel ai interface
*
* The following methods are vital for the functioning of a scripted AI.
* They will be called from simutrans to interact with the script. You should consider
* implementing them.
*
*/
/**
* @defgroup squirrel-tool-api Squirrel tool interface
*
* The following methods are vital for the functioning of scripted tools.
* They will be called from simutrans to interact with the script. You should consider
* implementing them.
*
*/
/**
* @defgroup squirrel-toolkit-api Squirrel toolkit interface
*
* The following methods create macro scripted tools.
*
*
*
*/
|
