Techwizz/Gobligine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Whitespace fixes in doc/

Browse source
This commit is contained in:
Pali Rohár 2012-07-24 13:54:25 +02:00
parent 373440382b
commit ecbc8bb6f8
25 changed files with 288 additions and 310 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/Doxyfile-header.html
View file

@ -56,7 +56,7 @@ $mathjax
\/ \/ \//_____/ \/
______________________ ______________________
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
Stratagus - A free fantasy real time strategy game engine
</pre>
<hr />
<!-- End of Stratagus header -->

7
doc/changelog.html
View file

@ -29,12 +29,12 @@
_________ __ __
/ _____// |_____________ _/ |______ ____ __ __ ______
\_____ \\ __\_ __ \__ \\ __\__ \ / ___\| | \/ ___/
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/_______ /|__| |__| (____ /__| (____ /\___ /|____//____ >
\/ \/ \//_____/ \/
______________________ ______________________
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
Stratagus - A free fantasy real time strategy game engine
</pre>
<hr>
@ -1445,8 +1445,7 @@ g the callback. (from Francois Beerten)
</ul>
<hr>
(C) Copyright 1998-2012 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project
under the <a href="gpl.html">GNU General Public License</a>.<br>
(C) Copyright 1998-2012 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project under the <a href="gpl.html">GNU General Public License</a>.<br>
All trademarks and copyrights on this page are owned by their respective owners.<br>
</body>
</html>

45
doc/development.html
View file

@ -26,15 +26,15 @@
<body>
<pre width=80>
_________ __ __
_________ __ __
/ _____// |_____________ _/ |______ ____ __ __ ______
\_____ \\ __\_ __ \__ \\ __\__ \ / ___\| | \/ ___/
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/_______ /|__| |__| (____ /__| (____ /\___ /|____//____ >
\/ \/ \//_____/ \/
\/ \/ \//_____/ \/
______________________ ______________________
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
</pre>
<hr>
@ -57,8 +57,8 @@ for Stratagus</a>.<p>
<h4>How do I get the latest source code of Stratagus?</h4>
The instructions for accessing the source code are on the
<a href="https://code.launchpad.net/stratagus">launchpad project</a> page.<br>
The instructions for accessing the source code are on the
<a href="https://code.launchpad.net/stratagus">launchpad project</a> page.<br>
<p>
For example:<p>
@ -66,28 +66,28 @@ For example:<p>
<pre>bzr branch lp:stratagus</pre>
<p>
This is done only once. To update your working copy, go into
This is done only once. To update your working copy, go into
the directory and type 'bzr pull'.<p>
<h3>Getting Stratagus without Bazaar</h3>
<h3>Compiling Stratagus</h3>
You can find instructions for compiling Stratagus at
You can find instructions for compiling Stratagus at
<a href="install.html">install.html</a>.<br>
Since you already have a copy of the source, you may skip
Since you already have a copy of the source, you may skip
ahead to Installation Step 2.
<h2>Source code documentation</h2>
Valery Shchedrin has introduced tagged source
Valery Shchedrin has introduced tagged source
documentation for Stratagus.<p>
You need
You need
<a href="http://www.doxygen.org">DoxyGen</a>
to generate source code documentation.<p>
Having DoxyGen installed, compile Stratagus with option ENABLE_DOC=ON<br>
Having DoxyGen installed, compile Stratagus with option ENABLE_DOC=ON<br>
(e.g, inside build directory, run 'cmake -DENABLE_DOC=ON .. &amp;&amp; make').<p>
Source documents are initially generated inside the build directory, as done for binaries.<p>
@ -133,12 +133,12 @@ Please read the doxygen/doc++ documentation.
<h2>Empty C++ prototype file</h2>
<pre>
// _________ __ __
// _________ __ __
// / _____// |_____________ _/ |______ ____ __ __ ______
// \_____ \\ __\_ __ \__ \\ __\__ \ / ___\| | \/ ___/
// / \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
// / \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
// /_______ /|__| |__| (____ /__| (____ /\___ /|____//____ >
// \/ \/ \//_____/ \/
// \/ \/ \//_____/ \/
// ______________________ ______________________
// T H E W A R B E G I N S
// Stratagus - A free fantasy real time strategy game engine
@ -158,7 +158,7 @@ Please read the doxygen/doc++ documentation.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor,
// Foundation, Inc., 51 Franklin St, Fifth Floor,
// Boston, MA 02110-1301 USA
//
@ -181,8 +181,8 @@ Please read the doxygen/doc++ documentation.
You can use your own coding style in your own modules.
If you fix in other modules, please imitate the coding style of the original coder.
<p>We suggest the
<a href="/usr/src/linux/Documentation/CodingStyle">Linux kernel coding style</a> (also
<p>We suggest the
<a href="/usr/src/linux/Documentation/CodingStyle">Linux kernel coding style</a> (also
found online <a href="http://lwn.net/2001/1115/a/CodingStyle.php3">here</a>).
<ul>
<li>Write ANSI C++.
@ -215,7 +215,7 @@ found online <a href="http://lwn.net/2001/1115/a/CodingStyle.php3">here</a>).
return 0;
}
// Example of a function
static int CclLoadPud(lua_State* l)
{
@ -236,7 +236,7 @@ found online <a href="http://lwn.net/2001/1115/a/CodingStyle.php3">here</a>).
}
</pre>
NOTE: If you make big changes please always extend the copyright with your name,
NOTE: If you make big changes please always extend the copyright with your name,
and always update the copyright year if required.<p>
<h2>Sending a patch</h2>
@ -244,8 +244,7 @@ and always update the copyright year if required.<p>
Use Stratagus launchpad <a href="https://bugs.launchpad.net/stratagus">bug tracker</a>
<hr>
(C) Copyright 1998-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project
under the <a href="gpl.html">GNU General Public License</a>.<br>
(C) Copyright 1998-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project under the <a href="gpl.html">GNU General Public License</a>.<br>
All trademarks and copyrights on this page are owned by their respective owners.<br>
</body>
</html>

19
doc/faq.html
View file

@ -25,15 +25,15 @@
<body>
<pre width=80>
_________ __ __
_________ __ __
/ _____// |_____________ _/ |______ ____ __ __ ______
\_____ \\ __\_ __ \__ \\ __\__ \ / ___\| | \/ ___/
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/_______ /|__| |__| (____ /__| (____ /\___ /|____//____ >
\/ \/ \//_____/ \/
\/ \/ \//_____/ \/
______________________ ______________________
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
</pre>
<hr>
@ -49,16 +49,16 @@
A: Yes, if you compiled SDL with ALSA support.<p>
<b>Q: What ports does the Stratagus network protocol use?</b><br>
A: Stratagus uses UDP with port 6660 by default, you may start stratagus
A: Stratagus uses UDP with port 6660 by default, you may start stratagus
with '-Pxxxx' flag to use port xxxx instead.<p>
<b>Q: Does stratagus support internet/metaserver play?</b><br>
A: Not yet, but this is a planned feature.<p>
<b>Q: Stratagus runs really slow in large resolutions, what can I do?</b><br>
A: Versions of Stratagus from 2.1 update the screen every frame.
A: Versions of Stratagus from 2.1 update the screen every frame.
Use OpenGL or play with a smaller screen resolution.<p>
<b>Q: Can I use Stratagus to play Age of Empires, StarCraft, or any
other commercial game?</b><br>
A: No.<p>
@ -67,8 +67,7 @@
A: Submit a <a href="https://answers.launchpad.net/stratagus">question</a>.<p>
<hr>
(C) Copyright 1998-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project
under the <a href="gpl.html">GNU General Public License</a>.<br>
(C) Copyright 1998-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project under the <a href="gpl.html">GNU General Public License</a>.<br>
All trademarks and copyrights on this page are owned by their respective owners.<br>
</body>
</html>

6
doc/gpl.html
View file

@ -32,7 +32,7 @@ Version 2, June 1991
</p>
<pre>
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
Everyone is permitted to copy and distribute verbatim copies
@ -455,7 +455,7 @@ when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) <var>year</var> <var>name of author</var>
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
type `show w'. This is free software, and you are welcome
to redistribute it under certain conditions; type `show c'
to redistribute it under certain conditions; type `show c'
for details.
</pre>
@ -477,7 +477,7 @@ necessary. Here is a sample; alter the names:
<pre>
Yoyodyne, Inc., hereby disclaims all copyright
interest in the program `Gnomovision'
(which makes passes at compilers) written
(which makes passes at compilers) written
by James Hacker.
<var>signature of Ty Coon</var>, 1 April 1989

15
doc/graphics/palette.html
View file

@ -25,15 +25,15 @@
<body>
<pre width=80>
_________ __ __
_________ __ __
/ _____// |_____________ _/ |______ ____ __ __ ______
\_____ \\ __\_ __ \__ \\ __\__ \ / ___\| | \/ ___/
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/_______ /|__| |__| (____ /__| (____ /\___ /|____//____ >
\/ \/ \//_____/ \/
\/ \/ \//_____/ \/
______________________ ______________________
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
</pre>
<hr>
@ -68,8 +68,7 @@ A sample palette, <a href="stratagus.gimp">stratagus.gimp</a>,
is included.<p>
<hr>
(C) Copyright 1998-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project
under the <a href="../gpl.html">GNU General Public License</a>.<br>
All trademarks and copyrights on this page are owned by their respective owners.<br>
(C) Copyright 1998-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project under the <a href="../gpl.html">GNU General Public License</a>.<br/>
All trademarks and copyrights on this page are owned by their respective owners.<br/>
</body>
</html>

15
doc/graphics/tileset.html
View file

@ -25,15 +25,15 @@
<body>
<pre width=80>
_________ __ __
_________ __ __
/ _____// |_____________ _/ |______ ____ __ __ ______
\_____ \\ __\_ __ \__ \\ __\__ \ / ___\| | \/ ___/
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/_______ /|__| |__| (____ /__| (____ /\___ /|____//____ >
\/ \/ \//_____/ \/
\/ \/ \//_____/ \/
______________________ ______________________
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
</pre>
<hr>
@ -207,8 +207,7 @@ This will I change later.
</table>
<hr>
(C) Copyright 1998-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project
under the <a href="../gpl.html">GNU General Public License</a>.<br>
All trademarks and copyrights on this page are owned by their respective owners.<br>
(C) Copyright 1998-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project under the <a href="../gpl.html">GNU General Public License</a>.<br/>
All trademarks and copyrights on this page are owned by their respective owners.<br/>
</body>
</html>

25
doc/index.html
View file

@ -25,15 +25,15 @@
<body>
<pre width=80>
_________ __ __
_________ __ __
/ _____// |_____________ _/ |______ ____ __ __ ______
\_____ \\ __\_ __ \__ \\ __\__ \ / ___\| | \/ ___/
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/_______ /|__| |__| (____ /__| (____ /\___ /|____//____ >
\/ \/ \//_____/ \/
\/ \/ \//_____/ \/
______________________ ______________________
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
</pre>
<hr>
@ -43,7 +43,7 @@
<h2>What is Stratagus?</h2>
<p>
Stratagus is a free cross-platform real-time strategy gaming engine.
It includes support for playing over Internet/LAN, or playing vs.
It includes support for playing over Internet/LAN, or playing vs.
computer opponents. The engine is configurable and can be used to
create games with a wide-range of features specific to your needs.
<p>
@ -62,7 +62,7 @@
</ul>
<p>
The newest version of Stratagus can always be found here:
The newest version of Stratagus can always be found here:
<a href="https://launchpad.net/stratagus">https://launchpad.net/stratagus</a>
<h2>Installation</h2>
@ -72,9 +72,9 @@
<h2>Development</h2>
Read <a href="development.html">development.html</a> if you want to help
Read <a href="development.html">development.html</a> if you want to help
out with Stratagus development<p>
Documentation on the Stratagus scripting language (Lua)
Documentation on the Stratagus scripting language (Lua)
can be found at <a href="http://www.lua.org/manual/">http://www.lua.org/manual/</a><p>
<h2>Documentation</h2>
@ -82,7 +82,7 @@
Source code DoxyGen documentation is generated when Stratagus is compiling.
See <a href="development.html">development.html</a> for further details.<p>
Information about creating sounds and graphics can be found in the
Information about creating sounds and graphics can be found in the
<a href="media.html">media documentation</a>.<p>
Information about Stratagus Lua scripting can be found in the
@ -103,7 +103,7 @@
<h2>Problems</h2>
If you have problems compiling, installing or playing Stratagus, read
If you have problems compiling, installing or playing Stratagus, read
<a href="faq.html">faq.html</a>
<h2>Copyrights</h2>
@ -116,8 +116,7 @@
Guichan see <a href="guichan-copyright.txt">guichan-copyright.txt</a>.<p>
<hr>
(C) Copyright 1998-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project
under the <a href="gpl.html">GNU General Public License</a>.<br>
(C) Copyright 1998-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project under the <a href="gpl.html">GNU General Public License</a>.<br>
All trademarks and copyrights on this page are owned by their respective owners.<br>
</body>
</html>

35
doc/install.html
View file

@ -25,15 +25,15 @@
<body>
<pre width=80>
_________ __ __
_________ __ __
/ _____// |_____________ _/ |______ ____ __ __ ______
\_____ \\ __\_ __ \__ \\ __\__ \ / ___\| | \/ ___/
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/_______ /|__| |__| (____ /__| (____ /\___ /|____//____ >
\/ \/ \//_____/ \/
\/ \/ \//_____/ \/
______________________ ______________________
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
</pre>
<hr>
@ -42,14 +42,14 @@
<h2>Software Requirements</h2>
<ul>
<li><b>A supported operating system:</b> Linux, Linux Maemo based devices, Mac OS X, BSD,
<li><b>A supported operating system:</b> Linux, Linux Maemo based devices, Mac OS X, BSD,
Possibly any other Unix/POSIX OS.<br>
Microsoft Windows 98 SE, or higher.
<font color=red>NOTE: some features of Winsock2 (WS2_32.DLL) are used. So even
if you plan to play single player only,
WinNT4.0 users will need
<a href="http://www.microsoft.com/ntserver/nts/downloads/recommended/SP6/allSP6.asp">Service Pack 3 or higher</a>
and Windows 95 users will need the
<font color=red>NOTE: some features of Winsock2 (WS2_32.DLL) are used. So even
if you plan to play single player only,
WinNT4.0 users will need
<a href="http://www.microsoft.com/ntserver/nts/downloads/recommended/SP6/allSP6.asp">Service Pack 3 or higher</a>
and Windows 95 users will need the
<a href="http://www.microsoft.com/windows95/downloads/contents/WUAdminTools/S_WUNetworkingTools/W95Sockets2/Default.asp">winsock 2 update</a>.</font><p>
<li><a href="http://www.cmake.org/">CMake</a> (required).<p>
@ -81,7 +81,7 @@
<li><b>Memory:</b> 32 MB of RAM (64 MB for ogg support).<br><p>
<li><b>Video Card:</b> Any graphics card that can handle 16 bpp
<li><b>Video Card:</b> Any graphics card that can handle 16 bpp
and 640x480 is supported. (OpenGL is supported, and requires a 32MB Card)<p>
<li><b>Sound Card:</b> Recommended. SDL compatible sound cards are supported.<p>
@ -115,16 +115,15 @@
<li><b>Step 4, Run:</b><p>
You may now go into the toplevel stratagus directory and run the binary.
Remember, you have to obtain the
<a href="https://launchpad.net/stratagus">game data</a>
to start the engine. By default, stratagus looks in './data',
if your data is in a different location you
Remember, you have to obtain the
<a href="https://launchpad.net/stratagus">game data</a>
to start the engine. By default, stratagus looks in './data',
if your data is in a different location you
will need to run stratagus with '-d /path_to_data'.<p>
</ul>
<hr>
(C) Copyright 1998-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project
under the <a href="gpl.html">GNU General Public License</a>.<br>
(C) Copyright 1998-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project under the <a href="gpl.html">GNU General Public License</a>.<br>
All trademarks and copyrights on this page are owned by their respective owners.<br>
</body>
</html>

39
doc/media.html
View file

@ -25,15 +25,15 @@
<body>
<pre width=80>
_________ __ __
_________ __ __
/ _____// |_____________ _/ |______ ____ __ __ ______
\_____ \\ __\_ __ \__ \\ __\__ \ / ___\| | \/ ___/
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/_______ /|__| |__| (____ /__| (____ /\___ /|____//____ >
\/ \/ \//_____/ \/
\/ \/ \//_____/ \/
______________________ ______________________
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
</pre>
<hr>
@ -42,50 +42,49 @@
<h2>Graphics</h2>
Please take a look at <a href="graphics/palette.html">graphics/palette.html</a>
Please take a look at <a href="graphics/palette.html">graphics/palette.html</a>
before working on graphics to get an idea of the palette.<p>
See also informations about <a href="graphics/tileset.html">tileset graphics format</a>.
<h4>Buildings</h4>
Buildings are simple to do. Each graphic consists of a .png file using
the palette format specified in the link above. The top half of the graphic
is used for the main image, and the bottom half is for the construction.
Buildings are simple to do. Each graphic consists of a .png file using
the palette format specified in the link above. The top half of the graphic
is used for the main image, and the bottom half is for the construction.
Here is an example of 'farm.png'. Please also see the ccl files.<p>
<img src="graphics/farm.png" alt=farm><br>
<h4>Units</h4>
Units are a little more complex as there are more sections per graphic.
The 5 columns represent the directions. The rows are varied among
different type of graphics, see the ccl files for more info. Here is
an example of 'peasant.png'. First 5 rows are used for movement,
next 5 for chopping, and the next 3 for dieing. Note that the peasant
Units are a little more complex as there are more sections per graphic.
The 5 columns represent the directions. The rows are varied among
different type of graphics, see the ccl files for more info. Here is
an example of 'peasant.png'. First 5 rows are used for movement,
next 5 for chopping, and the next 3 for dieing. Note that the peasant
has 2 other graphics, one for carrying gold, another for carrying wood.<p>
<img src="graphics/peasant.png" alt=peasant><br>
<h2>Sounds</h2>
Any format of sound will work with Stratagus, although to save space it is
recommended that you use 16 bit, 22050 kHz, mono format. To save more
Any format of sound will work with Stratagus, although to save space it is
recommended that you use 16 bit, 22050 kHz, mono format. To save more
space, it is recommended that you gzip the file too.<p>
All the sound entry data is in data/scripts/sound.lua,
All the sound entry data is in data/scripts/sound.lua,
Here is an example lua entry for: data/sounds/human/buildings/farm.wav.gz<p>
<pre>MakeSound("farm-selected", "human/buildings/farm.wav")</pre><p>
Note how the '.gz' suffix isn't needed in the lua entry,
Note how the '.gz' suffix isn't needed in the lua entry,
the Stratagus engine detects this automatically.<p>
You may look through the script files for existing media for more examples.<p>
<hr>
(C) Copyright 1998-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project
under the <a href="gpl.html">GNU General Public License</a>.<br>
(C) Copyright 1998-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project under the <a href="gpl.html">GNU General Public License</a>.<br>
All trademarks and copyrights on this page are owned by their respective owners.<br>
</body>
</html>

43
doc/scripts/ai.html
View file

@ -24,23 +24,23 @@
</head>
<body>
<pre width=80>
_________ __ __
_________ __ __
/ _____// |_____________ _/ |______ ____ __ __ ______
\_____ \\ __\_ __ \__ \\ __\__ \ / ___\| | \/ ___/
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/_______ /|__| |__| (____ /__| (____ /\___ /|____//____ >
\/ \/ \//_____/ \/
\/ \/ \//_____/ \/
______________________ ______________________
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
</pre>
<hr>
<h1>Stratagus Configuration Language Description: Artificial Intelligence (AI)</h1>
<hr>
<a href="../index.html">Stratagus</a>
<a href="../faq.html">FAQ</a>
<a href="unittype.html">PREV</a>
<a href="config.html">NEXT</a>
<a href="../index.html">Stratagus</a>
<a href="../faq.html">FAQ</a>
<a href="unittype.html">PREV</a>
<a href="config.html">NEXT</a>
<a href="index.html">LUA Index</a>
<hr>
<a href="#DefineAi">DefineAi</a>
@ -73,27 +73,27 @@
Everything around the control of the Stratagus AI.
<p>
Warning: The AI documentation is slightly outdated. This documentation hasn't
Warning: The AI documentation is slightly outdated. This documentation hasn't
been fully converted to the lua API yet.
<p>
<h2>How does it work</h2>
AI in Stratagus is script based. Each AI player keeps executing scripts.
There are two kinds of scripts :
There are two kinds of scripts :
<ul>
<li>The main script. It starts buildings, upgrades, ...</li>
<li>The action/reaction scripts. They are started by the AI engine, under certain condition.<br>
</li>
</ul>
Scripts can arrange and control units using forces : <br>
A script can ask for some type of unit in a force (using <a href="#AiForce">AiForce</a>),
A script can ask for some type of unit in a force (using <a href="#AiForce">AiForce</a>),
and then wait for them to be ready (using <a href="#AiWaitForce">AiWaitForce</a>).<br>
<br>
<br>
The force 0 is a special case : it holds all the unassigned units, and is used to fill other forces.
The force 0 is a special case : it holds all the unassigned units, and is used to fill other forces.
( when needed, units are transfered from force 0 to others ). Attacker units in force 0 won't be used for attacks<br>
Forces from 1 to 3 are also special : They are used as the attack reserve.
Forces from 1 to 3 are also special : They are used as the attack reserve.
Attack forces will only be created using units available in those forces.<br>
<br>
The main script is responsible for setting minimums for the forces 0 and 1. This will influence the balance
@ -270,18 +270,18 @@ FIXME:
<a name="AiAttackWithForce"></a>
<h3>AiAttackWithForce(force)</h3>
Attack the opponent with the given force. The place is choosen by the AI. If there
are flyers, ships and land units in the force they could attack different
Attack the opponent with the given force. The place is choosen by the AI. If there
are flyers, ships and land units in the force they could attack different
goals.
<dl>
<dl>
<dt>force</dt>
<dd>ID of the force to which the attacking units belong. The force ids 0 to 9
are currently supported.
</dd>
</dl>
<i>The force isn't moved as a single unit: faster units attacks first, than later the
slower units will attack.</i>
@ -463,7 +463,7 @@ Get the number of cycles to sleep.
Tells the AI that it should have a unit of this unit-type. The AI builds or
trains units in this order of the AiSet/AiNeed commands. If the unit or an
equivalent unit already exists, the AI does nothing. If the unit is lost, it is
automatically rebuilt. If the units are requested in wrong order, the AI could
automatically rebuilt. If the units are requested in wrong order, the AI could
hang up. Resources are collected automatic and farms are automatic build, but
additional could be requested.
@ -709,8 +709,7 @@ Now wait unit we have a worker to build the next things.
FIXME: need some complex examples.
<hr>
(C) Copyright 2002-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project
under the <a href="../gpl.html">GNU General Public License</a>.<br>
(C) Copyright 2002-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project under the <a href="../gpl.html">GNU General Public License</a>.<br>
All trademarks and copyrights on this page are owned by their respective owners.<br>
</body>
</html>

11
doc/scripts/config.html
View file

@ -32,7 +32,7 @@
\/ \/ \//_____/ \/
______________________ ______________________
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
Stratagus - A free fantasy real time strategy game engine
</pre>
<hr>
<h1>Stratagus Configuration Language Description: Config</h1>
@ -375,7 +375,7 @@ Use <a href="#DefineSprites">DefineSprites</a> instead with Name="sprite-mana".
<a name="DefineDecorations"></a>
<h3>DefineDecorations({tag = value, ...}, ...)</h3>
Define how to show variables.
Define how to show variables.
<dl>
<dt>Index = variable</dt>
@ -882,7 +882,7 @@ SetMaxSelectable(18)
<a name="SetMetaServer"></a>
<h3>SetMetaServer("host", port)</h3>
Set the default server for internet play.
Set the default server for internet play.
If you leave this blank, The Multiplay button will default to LAN game.
<h4>Example</h4>
@ -926,7 +926,7 @@ Sets the speed of the mouse scrolling while control is pressed.
<h4>Example</h4>
<pre>
-- Set Mouse speed to
-- Set Mouse speed to
SetMouseScrollSpeedControl(4)
</pre>
@ -1296,8 +1296,7 @@ For french azerty, use :
</pre>
<hr>
(C) Copyright 2002-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project
under the <a href="../gpl.html">GNU General Public License</a>.<br>
(C) Copyright 2002-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project under the <a href="../gpl.html">GNU General Public License</a>.<br>
All trademarks and copyrights on this page are owned by their respective owners.<br>
</body>
</html>

2
doc/scripts/findlua.py
View file

@ -37,7 +37,7 @@ def visitfile(file):
command = part.split('"')[0]
commands.append(command)
reffiles[command] = file
if __name__ == '__main__':
walktree(sys.argv[1], visitfile)

47
doc/scripts/game.html
View file

@ -24,23 +24,23 @@
</head>
<body>
<pre width=80>
_________ __ __
_________ __ __
/ _____// |_____________ _/ |______ ____ __ __ ______
\_____ \\ __\_ __ \__ \\ __\__ \ / ___\| | \/ ___/
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/_______ /|__| |__| (____ /__| (____ /\___ /|____//____ >
\/ \/ \//_____/ \/
\/ \/ \//_____/ \/
______________________ ______________________
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
</pre>
<hr>
<h1>Stratagus Configuration Language Description: Game</h1>
<hr>
<a href="../index.html">Stratagus</a>
<a href="../faq.html">FAQ</a>
<a href="config.html">PREV</a>
<a href="magic.html">NEXT</a>
<a href="../index.html">Stratagus</a>
<a href="../faq.html">FAQ</a>
<a href="config.html">PREV</a>
<a href="magic.html">NEXT</a>
<a href="index.html">LUA Index</a>
<hr>
<a href="#AddKeystrokeHelp">AddKeystrokeHelp</a>
@ -359,7 +359,7 @@ Define the campaign.
<h3>DefineConstruction(ident ...)</h3>
Defines a construction.<br>
<br>
Constructions can specify multiple files and shadow files. Shadows are
Constructions can specify multiple files and shadow files. Shadows are
optional.<br>
<br>
The construction frames should be ordered by increasing percentages and the
@ -433,7 +433,7 @@ DefineConstruction( ident
<a name="DefineEditorUnitTypes"></a>
<h3>DefineEditorUnitTypes({unit1, unit2, ...})</h3>
Creates a sorted list of unit-types for the editor.
Creates a sorted list of unit-types for the editor.
This is only a temporary hack for better sorted units.
<dl>
@ -844,7 +844,7 @@ Returns the Stratagus library path. The Stratagus library path points to the gam
<a name="ListDirectory"></a>
<h3>ListDirectory(path)</h3>
Returns a list with all files and subdirectories found in the directory pointed by path.
Returns a list with all files and subdirectories found in the directory pointed by path.
If the given path starts with '~', then the path is relative to the
user stratagus preferences directory.
The path cannot include any special character.
@ -858,8 +858,8 @@ The path cannot include any special character.
<a name="ListFilesInDirectory"></a>
<h3>ListFilesInDirectory(path)</h3>
Returns a list with all files found in the directory pointed by path.
The path is relative to the game directory.
Returns a list with all files found in the directory pointed by path.
The path is relative to the game directory.
If the given path starts with '~', then the path is relative to the
stratagus' user preferences directory.
The path cannot include any special character.
@ -873,7 +873,7 @@ The path cannot include any special character.
<a name="ListDirsInDirectory"></a>
<h3>ListDirsInDirectory(path)</h3>
Returns a list with all subdirectories found in the directory pointed by path.
Returns a list with all subdirectories found in the directory pointed by path.
The path is relative to the game directory.
If the given path starts with '~', then the path is relative to the
user stratagus preferences directory.
@ -912,7 +912,7 @@ Parse a log entry. Used in replay games.
<h4>Example</h4>
<pre>
Log({ GameCycle = 10420, UnitNumber = 252, UnitIdent = "unit-assault",
Log({ GameCycle = 10420, UnitNumber = 252, UnitIdent = "unit-assault",
Action = "move", Flush = 1, PosX = 113, PosY = 104, SyncRandSeed = 614148735 })
</pre>
@ -952,7 +952,7 @@ Change players colors.
<a name="MoveUnit"></a>
<h3>MoveUnit(unit-slot, {x, y})</h3>
Place a unit on map. If the location is occupied,
Place a unit on map. If the location is occupied,
the unit will be placed in the closest available spot.
@ -986,7 +986,7 @@ Used when loading games.
Player(0,
"name", "feb",
"type", "person", "race", "elites", "ai", 0,
"team", 2, "enemy", "_X______________", "allied", "________________",
"team", 2, "enemy", "_X______________", "allied", "________________",
"shared-vision", "________________",
"start", {0, 0},
"resources", {"time", 0, "titanium", 2100, "crystal", 1000,
@ -1473,7 +1473,7 @@ Show an area on the map for the given player.
<h3>SyncRand(number)</h3>
Get a value from the Stratagus syncronized random number generator.
Used to allow the AI to make syncronized choices with multiplayer, and
Used to allow the AI to make syncronized choices with multiplayer, and
during replays.
<dl>
@ -1496,7 +1496,7 @@ during replays.
<a name="Unit"></a>
<h3>Unit()</h3>
Needed to save/load games.
Needed to save/load games.
<h4>Example</h4>
@ -1529,16 +1529,15 @@ Unit(0, "type", "unit-vault", "player", 0,
{"action-none", "flags", 0, "range", 0, "width", 0, "height", 0, "min-range", 0, "tile", {0, 0},},
{"action-none", "flags", 0, "range", 0, "width", 0, "height", 0, "min-range", 0, "tile", {0, 0},},
{"action-none", "flags", 0, "range", 0, "width", 0, "height", 0, "min-range", 0, "tile", {0, 0},},},
"saved-order",
"saved-order",
{"action-still", "flags", 0, "range", 0, "width", 0, "height", 0, "min-range", 0, "tile", {-1, -1},},
"new-order",
"new-order",
{"action-still", "flags", 0, "range", 0, "width", 0, "height", 0, "min-range", 0, "tile", {-1, -1},}
)
</pre>
<hr>
(C) Copyright 2002-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project
under the <a href="../gpl.html">GNU General Public License</a>.<br>
(C) Copyright 2002-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project under the <a href="../gpl.html">GNU General Public License</a>.<br>
All trademarks and copyrights on this page are owned by their respective owners.<br>
</body>
</html>

21
doc/scripts/index.html
View file

@ -24,23 +24,23 @@
</head>
<body>
<pre width=80>
_________ __ __
_________ __ __
/ _____// |_____________ _/ |______ ____ __ __ ______
\_____ \\ __\_ __ \__ \\ __\__ \ / ___\| | \/ ___/
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/_______ /|__| |__| (____ /__| (____ /\___ /|____//____ >
\/ \/ \//_____/ \/
\/ \/ \//_____/ \/
______________________ ______________________
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
</pre>
<hr>
<h1>Stratagus Configuration Language Description: Index</h1>
<hr>
<a href="../index.html">Stratagus</a>
<a href="../faq.html">FAQ</a>
<a href="unittype.html">PREV</a>
<a href="ai.html">NEXT</a>
<a href="../index.html">Stratagus</a>
<a href="../faq.html">FAQ</a>
<a href="unittype.html">PREV</a>
<a href="ai.html">NEXT</a>
<a href="index.html">LUA Index</a>
<hr>
<a href="ai.html">AI</a>
@ -539,8 +539,7 @@
</dl>
<hr>
(C) Copyright 2002-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project
under the <a href="../gpl.html">GNU General Public License</a>.<br>
(C) Copyright 2002-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project under the <a href="../gpl.html">GNU General Public License</a>.<br>
All trademarks and copyrights on this page are owned by their respective owners.<br>
</body>
</html>

31
doc/scripts/magic.html
View file

@ -24,22 +24,22 @@
</head>
<body>
<pre width=80>
_________ __ __
_________ __ __
/ _____// |_____________ _/ |______ ____ __ __ ______
\_____ \\ __\_ __ \__ \\ __\__ \ / ___\| | \/ ___/
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/_______ /|__| |__| (____ /__| (____ /\___ /|____//____ >
\/ \/ \//_____/ \/
\/ \/ \//_____/ \/
______________________ ______________________
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
</pre>
<hr>
<h1>Stratagus Configuration Language Description: Magic</h1>
<hr>
<a href="../index.html">Stratagus</a>
<a href="../faq.html">FAQ</a>
<a href="game.html">PREV</a>
<a href="../index.html">Stratagus</a>
<a href="../faq.html">FAQ</a>
<a href="game.html">PREV</a>
<a href="mappresentation.html">NEXT</a>
<a href="index.html">LUA Index</a>
<hr>
@ -90,7 +90,7 @@ value to determine the draw order.
<dd>Name of the sound played when the missile hits it's target.
</dd>
<dt>Class = "class-type"</dt>
<dd>Various missiles can have wierd behaviours. This tag is followed by an
<dd>Various missiles can have wierd behaviours. This tag is followed by an
identifier that specifies some of that behaviour. Here is a list of currently
supported missile classes:
<dl>
@ -231,14 +231,14 @@ let the spell be casted on the entire map.
<ul>
<li>"self": The spell will only affect the caster or the area around him, no targetting at all.
<li>"position": The unit will target a position.
<li>"unit": The unit will target an unit. The spell will be aborted if the target dies.
<li>"unit": The unit will target an unit. The spell will be aborted if the target dies.
</ul>
You can still use position spells on units, it will target the unit's position.
If the unit dies however the caster will stop. (Some spells get casted until
there is no more mana left).
</dd>
<dt>"conditions", {flag, value, ...}</dt>
<dd>This is the condition for being able to cast the spell. Think of it as a
<dd>This is the condition for being able to cast the spell. Think of it as a
function that takes an unit as a parameter and return either yes or no depending
on the unit properties. Here is how a condition looks like:
<pre>"condition", {
@ -253,7 +253,7 @@ Here are the supported parameters:
it's the default.), "false" parameter passes when the answer is NO, and "only"
passes only when the answer is yes.<br>
It doesn't really makes sense to ever say true, since you might just as well
ommit it. "alliance false" means the spell won't work on allied units. "alliance
ommit it. "alliance false" means the spell won't work on allied units. "alliance
only" will make a spell that works only on allied units (can't think of any though).
Your own units are considered allied too.
</dd>
@ -469,7 +469,7 @@ Here are the supported operations, their paramenters, and what they do.
</dl></dd>
</dl></dd>
<dt>"capture", tag, ...</dt>
<dd>This will convert the target unit to the casters side.
<dd>This will convert the target unit to the casters side.
Very useful for capturing enemy buildings and controling enemy units.
None of these tags need to be specified.
<dl><dt>"damage", number</dt>
@ -539,7 +539,7 @@ is used for instance for cursor marks on the map. Either local or global must be
local or global must be specified.
</dd>
<dt>frame</dt>
<dd>Current sprite frame of the missile. The range is from 0 to the
<dd>Current sprite frame of the missile. The range is from 0 to the
<a href="#FRAMES-Define-missile-type">type:frames</a>-1
The topmost bit (128) is used as flag to mirror the sprites in the X direction.
</dd>
@ -589,8 +589,7 @@ controlling function. No parameters.
-->
<hr>
(C) Copyright 2002-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project
under the <a href="../gpl.html">GNU General Public License</a>.<br>
(C) Copyright 2002-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project under the <a href="../gpl.html">GNU General Public License</a>.<br>
All trademarks and copyrights on this page are owned by their respective owners.<br>
</body>
</html>

17
doc/scripts/mappresentation.html
View file

@ -21,15 +21,15 @@
</head>
<body>
<pre width=80>
_________ __ __
_________ __ __
/ _____// |_____________ _/ |______ ____ __ __ ______
\_____ \\ __\_ __ \__ \\ __\__ \ / ___\| | \/ ___/
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/_______ /|__| |__| (____ /__| (____ /\___ /|____//____ >
\/ \/ \//_____/ \/
\/ \/ \//_____/ \/
______________________ ______________________
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
</pre>
<hr>
<h1>Stratagus Configuration Language Description: Map Presentation</h1>
@ -74,7 +74,7 @@ This page documents map presentation functions.
<dt>mapwidth and mapheight</dt>
<dd>The sizes of the map.</dd>
<dt>mapuid</dt>
<dd>Random number to distinguish maps with the same file name. Be sure to change
<dd>Random number to distinguish maps with the same file name. Be sure to change
this number when changing the map.</dd>
</dl>
@ -163,7 +163,7 @@ Note: This is for the new map format. Not implemented yet.
</dl>
<p>
Note: This is for the new map format. Not implemented yet.
Note: This is for the new map format. Not implemented yet.
<h4>Example</h4>
@ -176,8 +176,7 @@ Note: This is for the new map format. Not implemented yet.
<p>
<hr>
(C) Copyright 2002-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project
under the <a href="../gpl.html">GNU General Public License</a>.<br>
(C) Copyright 2002-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project under the <a href="../gpl.html">GNU General Public License</a>.<br>
All trademarks and copyrights on this page are owned by their respective owners.<br>
</body>
</html>

43
doc/scripts/mapsetup.html
View file

@ -21,24 +21,24 @@
</head>
<body>
<pre width=80>
_________ __ __
_________ __ __
/ _____// |_____________ _/ |______ ____ __ __ ______
\_____ \\ __\_ __ \__ \\ __\__ \ / ___\| | \/ ___/
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/_______ /|__| |__| (____ /__| (____ /\___ /|____//____ >
\/ \/ \//_____/ \/
\/ \/ \//_____/ \/
______________________ ______________________
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
</pre>
<hr>
<h1>Stratagus Configuration Language Description: Map Setup</h1>
<hr>
<a href="../index.html">Stratagus</a>
<a href="../faq.html">FAQ</a>
<a href="mappresentation.html">PREV</a>
<a href="research.html">NEXT</a>
<a href="index.html">LUA Index</a>
<a href="../index.html">Stratagus</a>
<a href="../faq.html">FAQ</a>
<a href="mappresentation.html">PREV</a>
<a href="research.html">NEXT</a>
<a href="index.html">LUA Index</a>
<hr>
<a href="#SetStartView">SetStartView</a>
<a href="#SetAiType">SetAiType</a>
@ -48,26 +48,26 @@
<hr>
<h2>Intro - Introduction to functions to setup maps</h2>
A map is defined in 2 steps. This page documents map setup functions
used in the second step.
A map is defined in 2 steps. This page documents map setup functions
used in the second step.
<p>
The map setup functions load the actual map into the engine. This
includes functions to load the tileset which
includes functions to load the tileset which
are defined in the <a href="tileset.html">Tileset page</a>.
<p>
Other functions defined elsewhere are usefull in the map setup step:
<a href="game.html#CreateUnit">CreateUnit</a> and
<a href="game.html#CreateUnit">CreateUnit</a> and
SetPlayerData, SetSharedVision, SetDiplomacy.
<p>
Note: This is for the new map format. Not implemented yet.
Note: This is for the new map format. Not implemented yet.
<h2>Functions</h2>
<a name="SetStartView"></a>
<h3>SetStartView(player, x, y)</h3>
Set the location of the map stratagus will show to the given
player when starting. This works a little bit like a special
player when starting. This works a little bit like a special
CenterMap for each player.
<dl>
<dt>player</dt>
@ -88,7 +88,7 @@ CenterMap for each player.
<h3>SetAiType(player, ai-type)</h3>
Set what kind of ai algorithm should be used. For example: an air based
ai for a map with a lot of obstacles. Call this function only when creating
ai for a map with a lot of obstacles. Call this function only when creating
a game, not during the game.
<p>
@ -115,12 +115,12 @@ function is optional. If the game doesn't need a height map, default
values will be used.<p>
<dl>
<dt>imagepath</dt>
<dd>Filename of the grayscale image for the heightmap.
<dd>Filename of the grayscale image for the heightmap.
Black(0) is lowest level. White(255) is highest level.</dd>
</dl>
<p>
Note: This is for the new map format. Not implemented yet.
Note: This is for the new map format. Not implemented yet.
<h4>Example</h4>
@ -159,7 +159,7 @@ Apply a tilemap from a compact tilemap file to our tilemap.
</dl>
<p>
Note: This is for the new map format. Not implemented yet.
Note: This is for the new map format. Not implemented yet.
<h4>Example</h4>
@ -173,8 +173,7 @@ Note: This is for the new map format. Not implemented yet.
<p>
<hr>
(C) Copyright 2002-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project
under the <a href="../gpl.html">GNU General Public License</a>.<br>
(C) Copyright 2002-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project under the <a href="../gpl.html">GNU General Public License</a>.<br>
All trademarks and copyrights on this page are owned by their respective owners.<br>
</body>
</html>

23
doc/scripts/research.html
View file

@ -24,24 +24,24 @@
</head>
<body>
<pre width=80>
_________ __ __
_________ __ __
/ _____// |_____________ _/ |______ ____ __ __ ______
\_____ \\ __\_ __ \__ \\ __\__ \ / ___\| | \/ ___/
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/_______ /|__| |__| (____ /__| (____ /\___ /|____//____ >
\/ \/ \//_____/ \/
\/ \/ \//_____/ \/
______________________ ______________________
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
</pre>
<hr>
<h1>Stratagus Configuration Language Description: Research</h1>
<hr>
<a href="../index.html">Stratagus</a>
<a href="../faq.html">FAQ</a>
<a href="mapsetup.html">PREV</a>
<a href="savegame.html">NEXT</a>
<a href="index.html">LUA Index</a>
<a href="../index.html">Stratagus</a>
<a href="../faq.html">FAQ</a>
<a href="mapsetup.html">PREV</a>
<a href="savegame.html">NEXT</a>
<a href="index.html">LUA Index</a>
<hr>
<a href="#CheckDependency">CheckDependency</a>
<a href="#DefineAllow">DefineAllow</a>
@ -277,8 +277,7 @@ NOT WRITTEN YET.
</pre>
<hr>
(C) Copyright 2002-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project
under the <a href="../gpl.html">GNU General Public License</a>.<br>
(C) Copyright 2002-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project under the <a href="../gpl.html">GNU General Public License</a>.<br>
All trademarks and copyrights on this page are owned by their respective owners.<br>
</body>
</html>

21
doc/scripts/savegame.html
View file

@ -24,23 +24,23 @@
</head>
<body>
<pre width=80>
_________ __ __
_________ __ __
/ _____// |_____________ _/ |______ ____ __ __ ______
\_____ \\ __\_ __ \__ \\ __\__ \ / ___\| | \/ ___/
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/_______ /|__| |__| (____ /__| (____ /\___ /|____//____ >
\/ \/ \//_____/ \/
\/ \/ \//_____/ \/
______________________ ______________________
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
</pre>
<hr>
<h1>Stratagus Configuration Language Description: Triggers</h1>
<hr>
<a href="../index.html">Stratagus</a>
<a href="../faq.html">FAQ</a>
<a href="research.html">PREV</a>
<a href="sound.html">NEXT</a>
<a href="../index.html">Stratagus</a>
<a href="../faq.html">FAQ</a>
<a href="research.html">PREV</a>
<a href="sound.html">NEXT</a>
<a href="index.html">LUA Index</a>
<hr>
<a href="#SaveGame">SaveGame</a>
@ -106,8 +106,7 @@ units back into the queue they were in when a game was saved.
</pre>
<hr>
(C) Copyright 2002-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project
under the <a href="../gpl.html">GNU General Public License</a>.<br>
(C) Copyright 2002-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project under the <a href="../gpl.html">GNU General Public License</a>.<br>
All trademarks and copyrights on this page are owned by their respective owners.<br>
</body>
</html>

23
doc/scripts/sound.html
View file

@ -24,23 +24,23 @@
</head>
<body>
<pre width=80>
_________ __ __
_________ __ __
/ _____// |_____________ _/ |______ ____ __ __ ______
\_____ \\ __\_ __ \__ \\ __\__ \ / ___\| | \/ ___/
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/_______ /|__| |__| (____ /__| (____ /\___ /|____//____ >
\/ \/ \//_____/ \/
\/ \/ \//_____/ \/
______________________ ______________________
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
</pre>
<hr>
<h1>Stratagus Configuration Language Description: Sound</h1>
<hr>
<a href="../index.html">Stratagus</a>
<a href="../faq.html">FAQ</a>
<a href="savegame.html">PREV</a>
<a href="tileset.html">NEXT</a>
<a href="../index.html">Stratagus</a>
<a href="../faq.html">FAQ</a>
<a href="savegame.html">PREV</a>
<a href="tileset.html">NEXT</a>
<a href="index.html">LUA Index</a>
<hr>
<a href="#DefineGameSounds">DefineGameSounds</a>
@ -109,7 +109,7 @@ DefineGameSounds(
<a name="MakeSound"></a>
<h3>MakeSound("name", "file" or {"file1", "file2", ...})</h3>
Asks the sound system to register a sound under a given name, with an
Asks the sound system to register a sound under a given name, with an
associated list of files (the list can be replaced by only one file).
<dl>
@ -372,8 +372,7 @@ StopMusic()
</pre>
<hr>
(C) Copyright 2002-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project
under the <a href="../gpl.html">GNU General Public License</a>.<br>
(C) Copyright 2002-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project under the <a href="../gpl.html">GNU General Public License</a>.<br>
All trademarks and copyrights on this page are owned by their respective owners.<br>
</body>
</html>

41
doc/scripts/tileset.html
View file

@ -24,23 +24,23 @@
</head>
<body>
<pre width=80>
_________ __ __
_________ __ __
/ _____// |_____________ _/ |______ ____ __ __ ______
\_____ \\ __\_ __ \__ \\ __\__ \ / ___\| | \/ ___/
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/_______ /|__| |__| (____ /__| (____ /\___ /|____//____ >
\/ \/ \//_____/ \/
\/ \/ \//_____/ \/
______________________ ______________________
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
</pre>
<hr>
<h1>Stratagus Configuration Language Description: Tileset</h1>
<hr>
<a href="../index.html">Stratagus</a>
<a href="../faq.html">FAQ</a>
<a href="sound.html">PREV</a>
<a href="triggers.html">NEXT</a>
<a href="../index.html">Stratagus</a>
<a href="../faq.html">FAQ</a>
<a href="sound.html">PREV</a>
<a href="triggers.html">NEXT</a>
<a href="index.html">LUA Index</a>
<hr>
<a href="#DefineTileset">DefineTileset</a>
@ -49,7 +49,7 @@
<hr>
<h2>Intro - Introduction to tileset functions and variables</h2>
A Tileset defines a set of tilemodels that can be used in a tiled map.
A Tileset defines a set of tilemodels that can be used in a tiled map.
The map is thus devided in tiles.
<p>
@ -65,18 +65,18 @@ Properties of tilemodels:
</ul>
<p>
Note: This is the for the new map format. Not implented yet.
Note: This is the for the new map format. Not implented yet.
<h2>Functions</h2>
<a name="DefineTileset"></a>
<h3>DefineTileSet(name, width, height)</h3>
Define a tileset to which tilemodels can be added.
Define a tileset to which tilemodels can be added.
The width and height define the size of each tile.
<p>
This could also be defined in own levels. <p>
Note: This is the for the new map format. Not implented yet.
<dl>
<dt>name</dt>
@ -102,7 +102,7 @@ Note: This is the for the new map format. Not implented yet.
Define a tile model which is used in the tilemap.
<p>
<p>
Note: This is the for the new map format. Not implented yet.
<dl>
@ -113,7 +113,7 @@ Note: This is the for the new map format. Not implented yet.
<dt>imagepath<br>
</dt>
<dd>Filename of the image with graphics of tiles.</dd>
<dt>imageposition</dt>
<dd>Position of the tile graphic in the graphic file.<br>
</dd>
@ -157,8 +157,8 @@ Note: This is the for the new map format. Not implented yet.
<h4>Example</h4>
<pre>
DefineTileModel("oily-sand", "desert",
"graphics/tilesets/desert.png", 12,
DefineTileModel("oily-sand", "desert",
"graphics/tilesets/desert.png", 12,
categories = {"land", "buildable"},
neighbours = {{"sand","beach-N"},{"sand","beach-E"},{"sand","beach-S"},{"sand","beach-W"}}
accessmodier = {groundtroups=50, ships=0, camels=200},
@ -172,9 +172,9 @@ Note: This is the for the new map format. Not implented yet.
Load the configuration scripts for the tilemodels.
<p>
Note: This function is used in the map files.
Note: This function is used in the map files.
<p>
<dl>
<dt>luafile</dt>
<dd>The path to the lua file to load which will define the tilemodels.
@ -182,8 +182,7 @@ Note: This is the for the new map format. Not implented yet.
</dl>
<hr>
(C) Copyright 2002-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project
under the <a href="../gpl.html">GNU General Public License</a>.<br>
(C) Copyright 2002-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project under the <a href="../gpl.html">GNU General Public License</a>.<br>
All trademarks and copyrights on this page are owned by their respective owners.<br>
</body>
</html>

39
doc/scripts/triggers.html
View file

@ -23,23 +23,23 @@
</head>
<body>
<pre width=80>
_________ __ __
_________ __ __
/ _____// |_____________ _/ |______ ____ __ __ ______
\_____ \\ __\_ __ \__ \\ __\__ \ / ___\| | \/ ___/
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/_______ /|__| |__| (____ /__| (____ /\___ /|____//____ >
\/ \/ \//_____/ \/
\/ \/ \//_____/ \/
______________________ ______________________
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
</pre>
<hr>
<h1>Stratagus Configuration Language Description: Triggers</h1>
<hr>
<a href="../index.html">Stratagus</a>
<a href="../faq.html">FAQ</a>
<a href="tileset.html">PREV</a>
<a href="ui.html">NEXT</a>
<a href="../index.html">Stratagus</a>
<a href="../faq.html">FAQ</a>
<a href="tileset.html">PREV</a>
<a href="ui.html">NEXT</a>
<a href="index.html">LUA Index</a>
<hr>
<a href="#ActionDefeat">ActionDefeat</a>
@ -243,7 +243,7 @@ The condition player is set to victory.
<h4>Example</h4>
<pre>
-- Adds a trigger. If the player on the console has killed all his
-- Adds a trigger. If the player on the console has killed all his
-- opponents he won.
AddTrigger(
function() return IfOpponents("this", "==", 0) end,
@ -252,7 +252,7 @@ AddTrigger(
<a name="ActionWait"></a>
<h3>ActionWait(time-ms)</h3>
Causes the trigger to wait a number of milliseconds before reexamine this trigger.
@ -264,7 +264,7 @@ Causes the trigger to wait a number of milliseconds before reexamine this trigge
<!-- IT IS A BAD EXAMPLE NOW.
<h4>Example</h4>
<pre>
-- Adds a trigger. If the player on the console has killed all his
-- Adds a trigger. If the player on the console has killed all his
-- opponents the message "Hello" appears then two seconds later the message
-- "World" appears.
AddTrigger(
@ -296,7 +296,7 @@ Creates a new trigger.
<h4>Example</h4>
<pre>
-- Adds a trigger. If the player on the console has killed all his
-- Adds a trigger. If the player on the console has killed all his
-- opponents he won.
AddTrigger(
function() return IfOpponents("this", "==", 0) end,
@ -305,7 +305,7 @@ AddTrigger(
<a name="IfNearUnit"></a>
<h3>IfNearUnit(player, op, quantity, unit1, unit2)</h3>
Return true if the number of unit1 near of unit2 "op" quantity is true for the player.
@ -365,7 +365,7 @@ if (GetNumOpponents(GetThisPlayer()) == 0) then
<a name="IfRescuedNearUnit"></a>
<h3>IfRescuedNearUnit(player, op, quantity, unit1, unit2)</h3>
Return true if the number of rescued-units of type unit1 which are currently near of unit2
of the player "op" quantity is true.
@ -407,9 +407,9 @@ IfRescuedNearUnit("this", "==", 1, "unit-archer", "unit-circle-of-power")
<a name="GetTimer"></a>
<h3>GetTimer()</h3>
Return the number of cycles the timer ran.
<h4>Example</h4>
<pre>
-- True when the timer is at 17 cycles.
@ -418,7 +418,7 @@ time = GetTimer() == 17
<a name="GetNumUnitsAt"></a>
<h3>GetNumUnitsAt(player, unit-type, {x1, y1}, {x2, y2})</h3>
Return the number of units of type unit-type which are in the rectangle defined with (x1, y1, x2, y2)
of the player.
@ -449,8 +449,7 @@ GetNumUnitsAt(GetThisPlayer(), "unit-archer", {10, 10}, {12, 14}) >= 8
</pre>
<hr>
(C) Copyright 2002-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project
under the <a href="../gpl.html">GNU General Public License</a>.<br>
(C) Copyright 2002-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project under the <a href="../gpl.html">GNU General Public License</a>.<br>
All trademarks and copyrights on this page are owned by their respective owners.<br>
</body>
</html>

7
doc/scripts/ui.html
View file

@ -31,8 +31,8 @@
/_______ /|__| |__| (____ /__| (____ /\___ /|____//____ >
\/ \/ \//_____/ \/
______________________ ______________________
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
</pre>
<hr>
<h1>Stratagus Configuration Language Description: User Interface (UI)</h1>
@ -1262,8 +1262,7 @@ SetGameCursor("cursor-point")
</pre>
<hr>
(C) Copyright 2002-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project
under the <a href="../gpl.html">GNU General Public License</a>.<br>
(C) Copyright 2002-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project under the <a href="../gpl.html">GNU General Public License</a>.<br>
All trademarks and copyrights on this page are owned by their respective owners.<br>
</body>
</html>

21
doc/scripts/unittype.html
View file

@ -24,23 +24,23 @@
</head>
<body>
<pre width=80>
_________ __ __
_________ __ __
/ _____// |_____________ _/ |______ ____ __ __ ______
\_____ \\ __\_ __ \__ \\ __\__ \ / ___\| | \/ ___/
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/ \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \
/_______ /|__| |__| (____ /__| (____ /\___ /|____//____ >
\/ \/ \//_____/ \/
\/ \/ \//_____/ \/
______________________ ______________________
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
T H E W A R B E G I N S
Stratagus - A free fantasy real time strategy game engine
</pre>
<hr>
<h1>Stratagus Configuration Language Description: UnitType</h1>
<hr>
<a href="../index.html">Stratagus</a>
<a href="../faq.html">FAQ</a>
<a href="ui.html">PREV</a>
<a href="ai.html">NEXT</a>
<a href="../index.html">Stratagus</a>
<a href="../faq.html">FAQ</a>
<a href="ui.html">PREV</a>
<a href="ai.html">NEXT</a>
<a href="index.html">LUA Index</a>
<hr>
<a href="#DefineAnimations">DefineAnimations</a>
@ -866,8 +866,7 @@ Get all unit-type structures.
</pre>
<hr>
(C) Copyright 2002-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project
under the <a href="../gpl.html">GNU General Public License</a>.<br>
(C) Copyright 2002-2011 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project under the <a href="../gpl.html">GNU General Public License</a>.<br>
All trademarks and copyrights on this page are owned by their respective owners.<br>
</body>
</html>