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

Update the scripts documentation.

Browse source
This commit is contained in:
feber 2006-11-17 21:58:44 +00:00
parent fb567ee8f1
commit 59744295a8
2 changed files with 4 additions and 86 deletions

78
doc/scripts/config.html
View file

@ -52,10 +52,6 @@
<a href="#DefineDefaultIncomes">DefineDefaultIncomes</a>
<a href="#DefineDefaultResourceAmounts">DefineDefaultResourceAmounts</a>
<a href="#DefineDefaultResourceNames">DefineDefaultResourceNames</a>
<a href="#DefineDefaultResources">DefineDefaultResources</a>
<a href="#DefineDefaultResourcesHigh">DefineDefaultResourcesHigh</a>
<a href="#DefineDefaultResourcesLow">DefineDefaultResourcesLow</a>
<a href="#DefineDefaultResourcesMedium">DefineDefaultResourcesMedium</a>
<a href="#DefineSprites">DefinesSprites</a>
<a href="#GetVideoFullScreen">GetVideoFullScreen</a>
<a href="#GetVideoResolution">GetVideoResolution</a>
@ -267,80 +263,6 @@ Names the resources in a given order.
"time", "gold", "wood", "oil", "ore", "stone", "coal")
</pre>
<a name="DefineDefaultResources"></a>
<h3>DefineDefaultResources(amount, ...)</h3>
Defines the default amount of starting resources when you begin a game. the Map can redefine this,
or it can be chosen from the menu.
<dl>
<dt>amount</dt>
<dd>The amount of a resource to start with</dd>
<dt><i>RETURNS</i></dt>
<dd>Nothing</dd>
</dl>
<h4>Example</h4>
<pre>
-- Defines starting resources
DefineDefaultResources(0, 2000, 1000, 1000, 1000, 1000, 1000)
</pre>
<a name="DefineDefaultResourcesHigh"></a>
<h3>DefineDefaultResourcesHigh(amount, ...)</h3>
Defines the default amount of starting resources when you begin a game by selecting "High Resources".
<dl>
<dt>amount</dt>
<dd>The amount of a resource to start with</dd>
<dt><i>RETURNS</i></dt>
<dd>Nothing</dd>
</dl>
<h4>Example</h4>
<pre>
DefineDefaultResourcesHigh(0, 10000, 5000, 5000, 5000, 5000, 5000)
</pre>
<a name="DefineDefaultResourcesLow"></a>
<h3>DefineDefaultResourcesLow(amount, ...)</h3>
Defines the default amount of starting resources when you begin a game by selecting "Low Resources".
<dl>
<dt>amount</dt>
<dd>The amount of a resource to start with</dd>
<dt><i>RETURNS</i></dt>
<dd>Nothing</dd>
</dl>
<h4>Example</h4>
<pre>
DefineDefaultResourcesLow(0, 2000, 1000, 1000, 1000, 1000, 1000)
</pre>
<a name="DefineDefaultResourcesMedium"></a>
<h3>DefineDefaultResourcesMedium(amount, ...)</h3>
Defines the default amount of starting resources when you begin a game by selecting "Medium Resources".
<dl>
<dt>amount</dt>
<dd>The amount of a resource to start with</dd>
<dt><i>RETURNS</i></dt>
<dd>Nothing</dd>
</dl>
<h4>Example</h4>
<pre>
DefineDefaultResourcesMedium(0, 5000, 2000, 2000, 2000, 2000, 2000)
</pre>
<a name="DefineSprites"></a>
<h3>DefineSprite({tag = value}, ...)</h3>

12
doc/scripts/index.html
View file

@ -173,14 +173,6 @@
<dd></dd>
<dt><a href="config.html#DefineDefaultResourceNames">DefineDefaultResourceNames</a></dt>
<dd></dd>
<dt><a href="config.html#DefineDefaultResources">DefineDefaultResources</a></dt>
<dd></dd>
<dt><a href="config.html#DefineDefaultResourcesHigh">DefineDefaultResourcesHigh</a></dt>
<dd></dd>
<dt><a href="config.html#DefineDefaultResourcesLow">DefineDefaultResourcesLow</a></dt>
<dd></dd>
<dt><a href="config.html#DefineDefaultResourcesMedium">DefineDefaultResourcesMedium</a></dt>
<dd></dd>
<dt><a href="research.html#DefineDependency">DefineDependency</a></dt>
<dd></dd>
<dt><a href="game.html#DefineEditorUnitTypes">DefineEditorUnitTypes</a></dt>
@ -279,6 +271,10 @@
<dd></dd>
<dt><a href="game.html#ListDirectory">ListDirectory</a></dt>
<dd></dd>
<dt><a href="game.html#ListDirsInDirectory">ListDirsInDirectory</a></dt>
<dd></dd>
<dt><a href="game.html#ListFilesInDirectory">ListFilesInDirectory</a></dt>
<dd></dd>
<dt><a href="game.html#LoadMap">LoadMap</a></dt>
<dd></dd>
<dt><a href="tileset.html#LoadTileModels">LoadTileModels</a></dt>