[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Stratagus-CVS] stratagus data/ccl/anim.ccl data/ccl/stratagus....
|
From: |
Martin Renold |
|
Subject: |
[Stratagus-CVS] stratagus data/ccl/anim.ccl data/ccl/stratagus.... |
|
Date: |
Tue, 02 Sep 2003 15:23:09 -0400 |
CVSROOT: /cvsroot/stratagus
Module name: stratagus
Branch:
Changes by: Martin Renold <address@hidden> 03/09/02 15:23:08
Modified files:
data/ccl : anim.ccl stratagus.ccl
doc/ccl : ai.html config.html game.html icon.html
research.html sound.html tileset.html
triggers.html unittype.html
Log message:
unified ccl docu layout; moved some of the comments out of data/
Patches:
Index: stratagus/data/ccl/anim.ccl
diff -u stratagus/data/ccl/anim.ccl:1.19 stratagus/data/ccl/anim.ccl:1.20
--- stratagus/data/ccl/anim.ccl:1.19 Fri Aug 1 15:26:23 2003
+++ stratagus/data/ccl/anim.ccl Tue Sep 2 15:23:08 2003
@@ -26,27 +26,7 @@
;; along with this program; if not, write to the Free Software
;; Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
USA
;;
-;; $Id: anim.ccl,v 1.19 2003/08/01 19:26:23 grumbel Exp $
-
-;;=============================================================================
-;; Define animations.
-;;
-;; (define-animations ident 'still script 'move script 'die script
-;; 'attack script)
-;;
-;; A script is a list of quad numbers.
-;; (#(Flags Pixel Sleep Frame) (#Flags Pixel Sleep Frame) ...)
-;; * Format of quad numbers:
-;; #(Flags Pixel Sleep Frame)
-;; o Flags are the sum of the following:
-;; 1 Restart - restart animation
-;; 2 Reset - animation could here be aborted (switch to another)
-;; 4 Sound - play a sound with the animation
-;; 8 Missile - fire a missile at this point
-;; o Pixel is the number of pixels to move (if this is a moving animation)
-;; o Sleep is the number of frames to wait for the next animation
-;; o Frame is increment to the frame of the image
-;;
+;; $Id: anim.ccl,v 1.20 2003/09/02 19:23:08 martinxyz Exp $
;;------
;; Footman, Grunt, Grom Hellscream, Danath, Korgath Bladefist
Index: stratagus/data/ccl/stratagus.ccl
diff -u stratagus/data/ccl/stratagus.ccl:1.9
stratagus/data/ccl/stratagus.ccl:1.10
--- stratagus/data/ccl/stratagus.ccl:1.9 Sun Aug 31 04:01:21 2003
+++ stratagus/data/ccl/stratagus.ccl Tue Sep 2 15:23:08 2003
@@ -26,7 +26,9 @@
;; along with this program; if not, write to the Free Software
;; Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
USA
;;
-;; $Id: stratagus.ccl,v 1.9 2003/08/31 08:01:21 mr-russ Exp $
+;; $Id: stratagus.ccl,v 1.10 2003/09/02 19:23:08 martinxyz Exp $
+
+;; For documentation see stratagus/doc/ccl/ccl.html
(cond ((equal? *scheme* 'guile)
(load "guile.ccl"))
@@ -113,36 +115,11 @@
;; Comment this, if you use above
;(define play-list (list "music/default.mod"))
-;;-----------------------------------------------------------------------------
-
-;; Set selection style, show what units the user had selected.
-;; #f None
-;; 'rectangle Rectangle around unit
-;; 'circle Circle around unit
-;; 'alpha-rectangle Rectangle with alpha around unit
-;; 'alpha-circle Circle with alpha around unit
-;; 'corners Draw corners of rectangle
-;;
(set-selection-style! 'corners)
-
-;; How the sight range of the selected unit is shown on map.
-;; #f None
-;; 'rectangle Alpha rectangle around unit
-;; 'circle Alpha circle around unit
-;; #t Rectangle around unit
-;;
(set-show-sight-range! #f)
-;(set-show-sight-range! #t)
-;(set-show-sight-range! 'circle)
-;; Enable/disable display of attack range of the selected unit on map.
(set-show-attack-range! #f)
-;(set-show-attack-range! #t)
-
-;; Enable/disable display of reaction range of the selected unit on map.
(set-show-reaction-range! #f)
-;; Enable/disable display of the orders of the selected unit on map.
-;(set-show-orders! #t)
(set-show-orders! 2)
;; Enable/disable the short display of the orders after command.
@@ -176,49 +153,25 @@
;; 'background-long
;; )
-;; Define mana-sprite.
-;;
-;; (mana-sprite file hotx hoty width height)
-;;
-;(mana-sprite "graphics/ui/mana.png" -7 -7 7 7)
-(mana-sprite "graphics/ui/mana2.png" 0 -1 31 4)
-
-;; Define health-sprite.
-;;
-;; (mana-sprite file hotx hoty width height)
-;;
-;(health-sprite "graphics/ui/health.png" 1 -7 7 7)
-(health-sprite "graphics/ui/health2.png" 0 -4 31 4)
+;; file hotx hoty width height
+;(mana-sprite "graphics/ui/mana.png" -7 -7 7 7)
+(mana-sprite "graphics/ui/mana2.png" 0 -1 31 4)
+;(health-sprite "graphics/ui/health.png" 1 -7 7 7)
+(health-sprite "graphics/ui/health2.png" 0 -4 31 4)
-;; Uncomment next, to get a health bar to the left of the unit
;(show-health-bar)
-
-;; Uncomment next, to get a health dot to the left of the unit
+;(show-health-vertical)
+;(show-health-horizontal)
(show-health-dot)
-;; Uncomment next, to get a mana bar to the right of the unit
;(show-mana-bar)
-
-;; Uncomment next, to get a mana dot to the right of the unit
+;(show-mana-vertical)
+;(show-mana-horizontal)
(show-mana-dot)
-;; Uncomment next, to get no full bars or dots.
(show-no-full)
-
-;; Uncomment next, to show always bars or dots.
;(show-full)
-;; Uncomment next, to show health bars vertical.
-;(show-health-vertical)
-
-;; Uncomment next, to show health bars horizontal.
-;(show-health-horizontal)
-
-;; Uncomment next, to show mana bars vertical.
-;(show-mana-vertical)
-
-;; Uncomment next, to show mana bars horizontal.
-;(show-mana-horizontal)
;; Uncomment next, to show energy bars and dots only for selected units
;(show-energy-selected-only)
@@ -232,11 +185,6 @@
;; (shadow-sprite file hotx hoty width height)
;;
(shadow-sprite "graphics/missiles/unit_shadow.png" 3 42 32 32)
-
-;; Define spell-sprite.
-;;
-;; (shadow-sprite file hotx hoty width height)
-;;
(spell-sprite "graphics/ui/bloodlust,haste,slow,invisible,shield.png"
1 1 16 16)
Index: stratagus/doc/ccl/ai.html
diff -u stratagus/doc/ccl/ai.html:1.12 stratagus/doc/ccl/ai.html:1.13
--- stratagus/doc/ccl/ai.html:1.12 Thu Jul 3 13:40:05 2003
+++ stratagus/doc/ccl/ai.html Tue Sep 2 15:23:08 2003
@@ -79,15 +79,10 @@
<h2>Functions</h2>
<a name="define-ai"></a>
-<h3>define-ai</h3>
-
-<h4>Description</h4>
+<h3>(define-ai name race class script)</h3>
This defines how a special AI works. Each level can use his own AI definition.
-<h4>Syntax</h4>
-
-<code>(define-ai name race class script)</code>
<dl>
<dt>name</dt>
@@ -127,17 +122,12 @@
<a href="../../data/ccl/ai.ccl"> $LIBARYPATH/ccl/ai.ccl </a>
<a name="define-ai-helper"></a>
-<h3>define-ai-helper</h3>
-
-<h4>Description</h4>
+<h3>(define-ai-helper (list))</h3>
The AI is complete configurable, nothing is hardcoded. The AI knows nothing
about any units without this table. This table defines F.E. what unit can build
and what they can build and many other things that the AI must know.
-<h4>Syntax</h4>
-
-<code>(define-ai-helper (list))</code>
<dl>
<dt>list</dt>
@@ -274,15 +264,10 @@
<a href="../../data/ccl/ai.ccl"> $LIBARYPATH/ccl/ai.ccl </a>
<a name="define-ai-player"></a>
-<h3>define-ai-player</h3>
-
-<h4>Description</h4>
+<h3>(define-ai-player (list ...))</h3>
Define an AI player. (NOT SUPPORTED)
-<h4>Syntax</h4>
-
-<code>(define-ai-player (list ...))</code>
<dl>
<dt></dt>
@@ -302,15 +287,10 @@
<h4>Not Used</h4>
<a name="define-ai-wc-names"></a>
-<h3>define-ai-wc-names</h3>
-
-<h4>Description</h4>
+<h3>(define-ai-wc-names (list ...))</h3>
Define AI mapping from original number to internal symbol.
-<h4>Syntax</h4>
-
-<code>(define-ai-wc-names (list ...))</code>
<dl>
<dt></dt>
@@ -330,17 +310,12 @@
<h4>Not Used</h4>
<a name="ai:attack-with-force"></a>
-<h3>ai:attack-with-force</h3>
-
-<h4>Description</h4>
+<h3>(ai:attack-with-force force)</h3>
Attack the opponent with a force. The place is choosen by the AI. If there
are flyers, ships and land units in the force they could attack different
goals.
-<h4>Syntax</h4>
-
-<code>(ai:attack-with-force force)</code>
<dl>
<dt>force</dt>
@@ -368,15 +343,10 @@
<a href="../../data/ccl/ai.ccl"> $LIBARYPATH/ccl/ai.ccl </a>
<a name="ai:check-force"></a>
-<h3>ai:check-force</h3>
-
-<h4>Description</h4>
+<h3>(ai:check-force force)</h3>
Check if a force is ready.
-<h4>Syntax</h4>
-
-<code>(ai:check-force force)</code>
<dl>
<dt>force</dt>
@@ -398,15 +368,10 @@
<h4>Not Used</h4>
<a name="ai:debug"></a>
-<h3>ai:debug</h3>
-
-<h4>Description</h4>
+<h3>(ai:debug flag)</h3>
Enable or disable the debug output of the AI script execution.
-<h4>Syntax</h4>
-
-<code>(ai:debug flag)</code>
<dl>
<dt>flag</dt>
@@ -427,15 +392,10 @@
<a href="../../data/ccl/ai.ccl"> $LIBARYPATH/ccl/ai.ccl </a>
<a name="ai:dump"></a>
-<h3>ai:dump</h3>
-
-<h4>Description</h4>
+<h3>(ai:dump)</h3>
Dump some AI debug information.
-<h4>Syntax</h4>
-
-<code>(ai:dump)</code>
<h4>Example</h4>
@@ -448,9 +408,7 @@
<h4>Not Used</h4>
<a name="ai:force"></a>
-<h3>ai:force</h3>
-
-<h4>Description</h4>
+<h3>(ai:force force unit-type-1 count-1 ... unit-type-N count-N)</h3>
Define a force, what and how many units should belong to a force. Up to 10
forces are currently supported.
@@ -463,9 +421,6 @@
<br>
Note: The low-level didn't support the reduce of a force.
-<h4>Syntax</h4>
-
-<code>(ai:force force unit-type-1 count-1 ... unit-type-N count-N)</code>
<dl>
<dt>force</dt>
@@ -502,15 +457,10 @@
<a href="../../data/ccl/ai.ccl"> $LIBARYPATH/ccl/ai.ccl </a>
<a name="ai:force-role"></a>
-<h3>ai:force-role</h3>
-
-<h4>Description</h4>
+<h3>(ai:force-role force role)</h3>
Define the role of a force.
-<h4>Syntax</h4>
-
-<code>(ai:force-role force role)</code>
<dl>
<dt>force</dt>
@@ -535,15 +485,10 @@
<a href="../../data/ccl/ai.ccl"> $LIBARYPATH/ccl/ai.ccl </a>
<a name="ai:get-race"></a>
-<h3>ai:get-race</h3>
-
-<h4>Description</h4>
+<h3>(ai:get-race)</h3>
Get the race of the current AI player.
-<h4>Syntax</h4>
-
-<code>(ai:get-race)</code>
<h4>Example</h4>
@@ -558,15 +503,10 @@
<a href="../../data/ccl/ai.ccl"> $LIBARYPATH/ccl/ai.ccl </a>
<a name="ai:get-sleep-cycles"></a>
-<h3>ai:get-sleep-cycles</h3>
-
-<h4>Description</h4>
+<h3>(ai:get-sleep-cycles)</h3>
Get the number of cycles to sleep.
-<h4>Syntax</h4>
-
-<code>(ai:get-sleep-cycles)</code>
<h4>Example</h4>
@@ -579,9 +519,7 @@
<h4>Not Used</h4>
<a name="ai:need"></a>
-<h3>ai:need</h3>
-
-<h4>Description</h4>
+<h3>(ai:need unit-type)</h3>
Tells the AI that it should have an unit of this unit-type. The AI builds or
trains units in this order of the ai:set/ai:need commands. If the unit or an
@@ -590,9 +528,6 @@
hang up. Resources are collected automatic and farms are automatic build, but
additional could be requested.
-<h4>Syntax</h4>
-
-<code>(ai:need unit-type)</code>
<dl>
<dt>unit-type</dt>
@@ -614,15 +549,10 @@
<a href="../../data/ccl/ai.ccl"> $LIBARYPATH/ccl/ai.ccl </a>
<a name="ai:player"></a>
-<h3>ai:player</h3>
-
-<h4>Description</h4>
+<h3>(ai:player)</h3>
Return the player of the running AI.
-<h4>Syntax</h4>
-
-<code>(ai:player)</code>
<h4>Example</h4>
@@ -635,18 +565,13 @@
<h4>Not Used</h4>
<a name="ai:research"></a>
-<h3>ai:research</h3>
-
-<h4>Description</h4>
+<h3>(ai:research upgrade)</h3>
Let the AI research an upgrade, upgrades are reseached in command order.
And automatic researched if lost. Building orders have a higher priority.
The script writer is responsible for the correct order. If wrong the
AI could hang up.
-<h4>Syntax</h4>
-
-<code>(ai:research upgrade)</code>
<dl>
<dt>upgrade</dt>
@@ -667,16 +592,11 @@
<a href="../../data/ccl/ai.ccl"> $LIBARYPATH/ccl/ai.ccl </a>
<a name="ai:restart"></a>
-<h3>ai:restart</h3>
-
-<h4>Description</h4>
+<h3>(ai:restart)</h3>
Restart with the main AI script. Could be used as longjmp for the AI
scripts.
-<h4>Syntax</h4>
-
-<code>(ai:restart)</code>
<h4>Example</h4>
@@ -693,16 +613,11 @@
<a href="../../data/ccl/ai.ccl"> $LIBARYPATH/ccl/ai.ccl </a>
<a name="ai:script"></a>
-<h3>ai:script</h3>
-
-<h4>Description</h4>
+<h3>(ai:script script)</h3>
Execute a new script, can be used for loops, subroutines. But this must be
handled by the user.
-<h4>Syntax</h4>
-
-<code>(ai:script script)</code>
<dl>
<dt>script</dt>
@@ -727,9 +642,7 @@
<a href="../../data/ccl/ai.ccl"> $LIBARYPATH/ccl/ai.ccl </a>
<a name="ai:set"></a>
-<h3>ai:set</h3>
-
-<h4>Description</h4>
+<h3>(ai:set unit-type count)</h3>
This ai:need with a number. Tells the AI that it should have a specified number
of an unit of this unit-type. The AI builds or trains units in this order of
@@ -740,9 +653,6 @@
requested. In the opposite to ai:need, which always inserts a request, ai:set
modifies the last request to the new number.
-<h4>Syntax</h4>
-
-<code>(ai:set unit-type count)</code>
<dl>
<dt>unit-type</dt>
@@ -766,15 +676,10 @@
<a href="../../data/ccl/ai.ccl"> $LIBARYPATH/ccl/ai.ccl </a>
<a name="ai:set-collect!"></a>
-<h3>ai:set-collect!</h3>
-
-<h4>Description</h4>
+<h3>(ai:set-collect! #(time gold wood oil ore stone coal))</h3>
Set AI player resource collect percent.
-<h4>Syntax</h4>
-
-<code>(ai:set-collect! #(time gold wood oil ore stone coal))</code>
<dl>
<dt>time</dt>
@@ -811,15 +716,10 @@
<h4>Not Used</h4>
<a name="ai:set-reserve!"></a>
-<h3>ai:set-reserve!</h3>
-
-<h4>Description</h4>
+<h3>(ai:set-reserve! #( time gold wood oil ore stone coal))</h3>
Set AI player resource reserve.
-<h4>Syntax</h4>
-
-<code>(ai:set-reserve! #( time gold wood oil ore stone coal))</code>
<dl>
<dt>time</dt>
@@ -856,15 +756,10 @@
<h4>Not Used</h4>
<a name="ai:sleep"></a>
-<h3>ai:sleep</h3>
-
-<h4>Description</h4>
+<h3>(ai:sleep frames)</h3>
Wait some frames, to let the opponent (you) recover.
-<h4>Syntax</h4>
-
-<code>(ai:sleep frames)</code>
<dl>
<dt>frames</dt>
@@ -885,17 +780,12 @@
<a href="../../data/ccl/ai.ccl"> $LIBARYPATH/ccl/ai.ccl </a>
<a name="ai:upgrade-to"></a>
-<h3>ai:upgrade-to</h3>
-
-<h4>Description</h4>
+<h3>(ai:upgrade-to unit-type)</h3>
Upgrade units to an improved type. You must give for each unit you want to
upgrade an upgrade command. The computer automatic searches which unit it
upgrades.
-<h4>Syntax</h4>
-
-<code>(ai:upgrade-to unit-type)</code>
<dl>
<dt>unit-type</dt>
@@ -916,16 +806,11 @@
<a href="../../data/ccl/ai.ccl"> $LIBARYPATH/ccl/ai.ccl </a>
<a name="ai:wait"></a>
-<h3>ai:wait</h3>
-
-<h4>Description</h4>
+<h3>(ai:wait type)</h3>
Waits until the *first* request of this unit-type is completed.
Don't forget to request an unit-type, before you wait on it.
-<h4>Syntax</h4>
-
-<code>(ai:wait type)</code>
<dl>
<dt>type</dt>
@@ -947,16 +832,11 @@
<a href="../../data/ccl/ai.ccl"> $LIBARYPATH/ccl/ai.ccl </a>
<a name="ai:wait-force"></a>
-<h3>ai:wait-force</h3>
-
-<h4>Description</h4>
+<h3>(ai:wait-force force)</h3>
Wait until a force is complete, the forces are build in force number order.
First 0, than 1, last 9.
-<h4>Syntax</h4>
-
-<code>(ai:wait-force force)</code>
<dl>
<dt>force</dt>
@@ -1012,7 +892,7 @@
FIXME: need some complex examples.
<hr>
-Last changed: $Id: ai.html,v 1.12 2003/07/03 17:40:05 ingo Exp $<br>
+Last changed: $Id: ai.html,v 1.13 2003/09/02 19:23:08 martinxyz Exp $<br>
All trademarks and copyrights on this page are owned by their respective
owners.
<address>(c) 2002-2003 by <a href="http://stratagus.org";>
The Stratagus Project</a></address></body></html>
Index: stratagus/doc/ccl/config.html
diff -u stratagus/doc/ccl/config.html:1.20 stratagus/doc/ccl/config.html:1.21
--- stratagus/doc/ccl/config.html:1.20 Thu Jul 3 13:40:05 2003
+++ stratagus/doc/ccl/config.html Tue Sep 2 15:23:08 2003
@@ -128,9 +128,7 @@
<h2>Functions</h2>
<a name="a-star"></a>
-<h3>a-star</h3>
-
-<h4>Description</h4>
+<h3>(a-star on fixed_unit_cost moving_unit_cost unseen_terrain
unseen_terrain_cost)</h3>
Configures the A-star pathfinder to be on or off. Also sets variables about
the pathfinder.
What the movement cost for unseen terrian is and whether units are aware of
what's under unseen terrain.
@@ -139,9 +137,6 @@
the performance, turn it off.
The Cost of a move it 1 if moving straight, or 2 if moving diagonal.
-<h4>Syntax</h4>
-
-<code>(a-star on fixed_unit_cost moving_unit_cost unseen_terrain
unseen_terrain_cost)</code>
<dl>
<dt>on</dt>
@@ -168,15 +163,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="alpha-fog-of-war"></a>
-<h3>alpha-fog-of-war</h3>
-
-<h4>Description</h4>
+<h3>(alpha-fog-of-war)</h3>
Use alpha style fog of war.
-<h4>Syntax</h4>
-
-<code>(alpha-fog-of-war)</code>
<h4>Example</h4>
@@ -191,15 +181,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="decoration-on-top"></a>
-<h3>decoration-on-top</h3>
-
-<h4>Description</h4>
+<h3>(decoration-on-top)</h3>
Show bars and dots always on top. (Planned feature)
-<h4>Syntax</h4>
-
-<code>(decoration-on-top)</code>
<h4>Example</h4>
@@ -214,15 +199,9 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="health-sprite"></a>
-<h3>health-sprite</h3>
-
-<h4>Description</h4>
-
-.
-
-<h4>Syntax</h4>
+<h3>(health-sprite file hotx hoty width height)</h3>
-<code>(health-sprite file hotx hoty width height)</code>
+Define health-sprite.
<dl>
<dt>file</dt>
@@ -252,16 +231,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="mana-sprite"></a>
-<h3>mana-sprite</h3>
-
-<h4>Description</h4>
+<h3>(mana-sprite file hotx hoty width height))</h3>
.
-<h4>Syntax</h4>
-
-<code>(mana-sprite file hotx hoty width height))</code>
-
<dl>
<dt>file</dt>
<dd>.
@@ -279,25 +252,14 @@
<h4>Example</h4>
<pre>
- (mana-sprite graphics/ui/mana2.png" 0 -1 31 4)
+ (mana-sprite "graphics/ui/mana2.png" 0 -1 31 4)
</pre>
-<p>.
-
-<h4>Used</h4>
-
-<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
-
<a name="original-fog-of-war"></a>
-<h3>original-fog-of-war</h3>
-
-<h4>Description</h4>
+<h3>(original-fog-of-war)</h3>
Use original style fog of war.
-<h4>Syntax</h4>
-
-<code>(original-fog-of-war)</code>
<h4>Example</h4>
@@ -312,15 +274,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="reveal-map"></a>
-<h3>reveal-map</h3>
-
-<h4>Description</h4>
+<h3>(reveal-map)</h3>
Reveal the entire map.
-<h4>Syntax</h4>
-
-<code>(reveal-map)</code>
<h4>Example</h4>
@@ -335,15 +292,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="right-button-attacks"></a>
-<h3>right-button-attacks</h3>
-
-<h4>Description</h4>
+<h3>(right-button-attacks)</h3>
.
-<h4>Syntax</h4>
-
-<code>(right-button-attacks)</code>
<h4>Example</h4>
@@ -358,15 +310,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="right-button-moves"></a>
-<h3>right-button-moves</h3>
-
-<h4>Description</h4>
+<h3>(right-button-moves)</h3>
.
-<h4>Syntax</h4>
-
-<code>(right-button-moves)</code>
<h4>Example</h4>
@@ -381,15 +328,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-all-players-building-limit!"></a>
-<h3>set-all-players-building-limit!</h3>
-
-<h4>Description</h4>
+<h3>(set-all-players-building-limit! limit)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-all-players-building-limit! limit)</code>
<dl>
<dt>limit</dt>
@@ -410,15 +352,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-all-players-food-unit-limit!"></a>
-<h3>set-all-players-food-unit-limit!</h3>
-
-<h4>Description</h4>
+<h3>(set-all-players-food-unit-limit! limit)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-all-players-food-unit-limit! limit)</code>
<dl>
<dt>limit</dt>
@@ -439,15 +376,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-all-players-total-unit-limit!"></a>
-<h3>set-all-players-total-unit-limit!</h3>
-
-<h4>Description</h4>
+<h3>(set-all-players-total-unit-limit! limit)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-all-players-total-unit-limit! limit)</code>
<dl>
<dt>limit</dt>
@@ -468,16 +400,11 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-brightness!"></a>
-<h3>set-brightness!</h3>
-
-<h4>Description</h4>
+<h3>(set-brightness! brightness)</h3>
Change the global game brightness. Use this to adapt Stratagus to your monitor
settings.
-<h4>Syntax</h4>
-
-<code>(set-brightness! brightness)</code>
<dl>
<dt>brightness</dt>
@@ -498,15 +425,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-building-capture!"></a>
-<h3>set-building-capture!</h3>
-
-<h4>Description</h4>
+<h3>(set-building-capture! capture)</h3>
Enable or disable building capture.
-<h4>Syntax</h4>
-
-<code>(set-building-capture! capture)</code>
<dl>
<dt>capture</dt>
@@ -527,15 +449,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-burn-buildings!"></a>
-<h3>set-burn-buildings!</h3>
-
-<h4>Description</h4>
+<h3>(set-burn-buildings! percent rate)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-burn-buildings! percent rate)</code>
<dl>
<dt>percent</dt>
@@ -558,16 +475,11 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-color-cycle-all!"></a>
-<h3>set-color-cycle-all!</h3>
-
-<h4>Description</h4>
+<h3>(set-color-cycle-all! flag)</h3>
Change how the color cycling is working. This is used to make the water moving
or the circle in the dark portal rotating.
-<h4>Syntax</h4>
-
-<code>(set-color-cycle-all! flag)</code>
<dl>
<dt>flag</dt>
@@ -588,16 +500,11 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-contrast!"></a>
-<h3>set-contrast!</h3>
-
-<h4>Description</h4>
+<h3>(set-contrast! contrast)</h3>
Change the global game contrast. Use this to adapt Stratagus to your monitor
settings.
-<h4>Syntax</h4>
-
-<code>(set-contrast! contrast)</code>
<dl>
<dt>contrast</dt>
@@ -618,15 +525,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-double-click-delay!"></a>
-<h3>set-double-click-delay!</h3>
-
-<h4>Description</h4>
+<h3>(set-double-click-delay! delay)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-double-click-delay! delay)</code>
<dl>
<dt>delay</dt>
@@ -647,15 +549,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-editor-select-icon!"></a>
-<h3>set-editor-select-icon!</h3>
-
-<h4>Description</h4>
+<h3>(set-editor-select-icon! icon)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-editor-select-icon! icon)</code>
<dl>
<dt>icon</dt>
@@ -676,15 +573,10 @@
<a href="../../data/ccl/editor.ccl"> $LIBARYPATH/ccl/editor.ccl </a>
<a name="set-editor-units-icon!"></a>
-<h3>set-editor-units-icon!</h3>
-
-<h4>Description</h4>
+<h3>(set-editor-units-icon! icon)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-editor-units-icon! icon)</code>
<dl>
<dt>icon</dt>
@@ -705,15 +597,10 @@
<a href="../../data/ccl/editor.ccl"> $LIBARYPATH/ccl/editor.ccl </a>
<a name="set-fancy-buildings!"></a>
-<h3>set-fancy-buildings!</h3>
-
-<h4>Description</h4>
+<h3>(set-fancy-buildings! fancy)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-fancy-buildings! fancy)</code>
<dl>
<dt>fancy</dt>
@@ -734,15 +621,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-fog-of-war!"></a>
-<h3>set-fog-of-war!</h3>
-
-<h4>Description</h4>
+<h3>(set-fog-of-war! fow)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-fog-of-war! fow)</code>
<dl>
<dt>fow</dt>
@@ -763,15 +645,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-fog-of-war-brightness!"></a>
-<h3>set-fog-of-war-brightness!</h3>
-
-<h4>Description</h4>
+<h3>(set-fog-of-war-brightness! brightness)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-fog-of-war-brightness! brightness)</code>
<dl>
<dt>brightness</dt>
@@ -792,15 +669,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-fog-of-war-contrast!"></a>
-<h3>set-fog-of-war-contrast!</h3>
-
-<h4>Description</h4>
+<h3>(set-fog-of-war-contrast! contrast)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-fog-of-war-contrast! contrast)</code>
<dl>
<dt>contrast</dt>
@@ -821,15 +693,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-fog-of-war-saturation!"></a>
-<h3>set-fog-of-war-saturation!</h3>
-
-<h4>Description</h4>
+<h3>(set-fog-of-war-saturation! saturation)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-fog-of-war-saturation! saturation)</code>
<dl>
<dt>saturation</dt>
@@ -850,15 +717,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-forest-regeneration!"></a>
-<h3>set-forest-regeneration!</h3>
-
-<h4>Description</h4>
+<h3>(set-forest-regeneration! speed)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-forest-regeneration! speed)</code>
<dl>
<dt>speed</dt>
@@ -879,15 +741,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-goldmine-depleted!"></a>
-<h3>set-goldmine-depleted!</h3>
-
-<h4>Description</h4>
+<h3>(set-goldmine-depleted! percent)</h3>
Set the option to use depleted goldmines.
-<h4>Syntax</h4>
-
-<code>(set-goldmine-depleted! percent)</code>
<dl>
<dt>percent</dt>
@@ -909,15 +766,10 @@
<h4>Not Used</h4>
<a name="set-grab-mouse!"></a>
-<h3>set-grab-mouse!</h3>
-
-<h4>Description</h4>
+<h3>(set-grab-mouse! grab)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-grab-mouse! grab)</code>
<dl>
<dt>grab</dt>
@@ -938,15 +790,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-hitpoint-regeneration!"></a>
-<h3>set-hitpoint-regeneration!</h3>
-
-<h4>Description</h4>
+<h3>(set-hitpoint-regeneration! regen)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-hitpoint-regeneration! regen)</code>
<dl>
<dt>regen</dt>
@@ -967,15 +814,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-hold-click-delay!"></a>
-<h3>set-hold-click-delay!</h3>
-
-<h4>Description</h4>
+<h3>(set-hold-click-delay! delay)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-hold-click-delay! delay)</code>
<dl>
<dt>delay</dt>
@@ -996,15 +838,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-key-scroll!"></a>
-<h3>set-key-scroll!</h3>
-
-<h4>Description</h4>
+<h3>(set-key-scroll! scroll)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-key-scroll! scroll)</code>
<dl>
<dt>scroll</dt>
@@ -1025,15 +862,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-key-scroll-speed!"></a>
-<h3>set-key-scroll-speed!</h3>
-
-<h4>Description</h4>
+<h3>(set-key-scroll-speed! speed)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-key-scroll-speed! speed)</code>
<dl>
<dt>speed</dt>
@@ -1054,15 +886,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-leave-stops!"></a>
-<h3>set-leave-stops!</h3>
-
-<h4>Description</h4>
+<h3>(set-leave-stops! leave)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-leave-stops! leave)</code>
<dl>
<dt>leave</dt>
@@ -1083,15 +910,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-menu-background!"></a>
-<h3>set-menu-background!</h3>
-
-<h4>Description</h4>
+<h3>(set-menu-background! image)</h3>
Set the default menu background.
-<h4>Syntax</h4>
-
-<code>(set-menu-background! image)</code>
<dl>
<dt>image</dt>
@@ -1113,15 +935,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-menu-background-with-title!"></a>
-<h3>set-menu-background-with-title!</h3>
-
-<h4>Description</h4>
+<h3>(set-menu-background-with-title! image)</h3>
Set the default menu background with title.
-<h4>Syntax</h4>
-
-<code>(set-menu-background-with-title! image)</code>
<dl>
<dt>image</dt>
@@ -1143,15 +960,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-minimap-terrain!"></a>
-<h3>set-minimap-terrain!</h3>
-
-<h4>Description</h4>
+<h3>(set-minimap-terrain! terrain)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-minimap-terrain! terrain)</code>
<dl>
<dt>terrain</dt>
@@ -1172,15 +984,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-mouse-adjust!"></a>
-<h3>set-mouse-adjust!</h3>
-
-<h4>Description</h4>
+<h3>(set-mouse-adjust! speed)</h3>
(Only with SVGALIB).
-<h4>Syntax</h4>
-
-<code>(set-mouse-adjust! speed)</code>
<dl>
<dt>speed</dt>
@@ -1201,15 +1008,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-mouse-scale!"></a>
-<h3>set-mouse-scale!</h3>
-
-<h4>Description</h4>
+<h3>(set-mouse-scale! scale)</h3>
(Only with SVGALIB).
-<h4>Syntax</h4>
-
-<code>(set-mouse-scale! scale)</code>
<dl>
<dt>scale</dt>
@@ -1230,15 +1032,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-mouse-scroll!"></a>
-<h3>set-mouse-scroll!</h3>
-
-<h4>Description</h4>
+<h3>(set-mouse-scroll! scroll)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-mouse-scroll! scroll)</code>
<dl>
<dt>scroll</dt>
@@ -1259,15 +1056,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-mouse-scroll-speed!"></a>
-<h3>set-mouse-scroll-speed!</h3>
-
-<h4>Description</h4>
+<h3>(set-mouse-scroll-speed! speed)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-mouse-scroll-speed! speed)</code>
<dl>
<dt>speed</dt>
@@ -1288,15 +1080,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-original-resources!"></a>
-<h3>set-original-resources!</h3>
-
-<h4>Description</h4>
+<h3>(set-original-resources! resources)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-original-resources! resources)</code>
<dl>
<dt>resources</dt>
@@ -1317,15 +1104,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-reveal-attacker!"></a>
-<h3>set-reveal-attacker!</h3>
-
-<h4>Description</h4>
+<h3>(set-reveal-attacker! reveal)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-reveal-attacker! reveal)</code>
<dl>
<dt>reveal</dt>
@@ -1346,15 +1128,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-reverse-map-move!"></a>
-<h3>set-reverse-map-move!</h3>
-
-<h4>Description</h4>
+<h3>(set-reverse-map-move! reverse)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-reverse-map-move! reverse)</code>
<dl>
<dt>reverse</dt>
@@ -1375,15 +1152,11 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-saturation!"></a>
-<h3>set-saturation!</h3>
-<h4>Description</h4>
+<h3>(set-saturation! saturation)</h3>
Change the global game saturation. Use this to adapt Stratagus to your monitor
settings.
-<h4>Syntax</h4>
-
-<code>(set-saturation! saturation)</code>
<dl>
<dt>saturation</dt>
@@ -1404,19 +1177,19 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-selection-style!"></a>
-<h3>set-selection-style!</h3>
-
-<h4>Description</h4>
-
-.
-
-<h4>Syntax</h4>
-
-<code>(set-selection-style! style)</code>
+<h3>(set-selection-style! style)</h3>
+Set selection style, show what units the user had selected.
<dl>
<dt>style</dt>
-<dd>#f,'rectangle,'circle,'alpha-rectangle,'alpha-circle,'corners.
+<dd>Possible values:<pre>
+#f None
+'rectangle Rectangle around unit
+'circle Circle around unit
+'alpha-rectangle Rectangle with alpha around unit
+'alpha-circle Circle with alpha around unit
+'corners Draw corners of rectangle
+</pre>
</dd>
</dl>
@@ -1426,26 +1199,18 @@
(set-selection-style! 'corners)
</pre>
-<p>.
-
<h4>Used</h4>
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-show-attack-range!"></a>
-<h3>set-show-attack-range!</h3>
+<h3>(set-show-attack-range! show)</h3>
-<h4>Description</h4>
-
-.
-
-<h4>Syntax</h4>
-
-<code>(set-show-attack-range! show)</code>
+Enable/disable display of attack range of the selected unit on map.
<dl>
<dt>show</dt>
-<dd>.
+<dd>#f or #t
</dd>
</dl>
@@ -1455,22 +1220,15 @@
(set-show-attack-range! #f)
</pre>
-<p>.
-
<h4>Used</h4>
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-show-command-key!"></a>
-<h3>set-show-command-key!</h3>
-
-<h4>Description</h4>
+<h3>(set-show-command-key! show)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-show-command-key! show)</code>
<dl>
<dt>show</dt>
@@ -1491,15 +1249,9 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-show-orders!"></a>
-<h3>set-show-orders!</h3>
-
-<h4>Description</h4>
+<h3>(set-show-orders! show)</h3>
-Show unit orders.
-
-<h4>Syntax</h4>
-
-<code>(set-show-orders! show)</code>
+Enable/disable display of the orders of the selected unit on map.
<dl>
<dt>show</dt>
@@ -1511,27 +1263,16 @@
<h4>Example</h4>
<pre>
+ ;; never show unit orders
(set-show-orders! #f)
+ ;; show orders for 2 seconds
(set-show-orders! 2)
</pre>
-<p>The first example never shows unit orders. The second example only shows
-orders for 2 seconds.
-
-<h4>Used</h4>
-
-<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
-
<a name="set-show-reaction-range!"></a>
-<h3>set-show-reaction-range!</h3>
-
-<h4>Description</h4>
-
-.
+<h3>(set-show-reaction-range! show)</h3>
-<h4>Syntax</h4>
-
-<code>(set-show-reaction-range! show)</code>
+Enable/disable display of reaction range of the selected unit on map.
<dl>
<dt>show</dt>
@@ -1552,19 +1293,18 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-show-sight-range!"></a>
-<h3>set-show-sight-range!</h3>
-
-<h4>Description</h4>
-
-.
-
-<h4>Syntax</h4>
+<h3>(set-show-sight-range! range)</h3>
-<code>(set-show-sight-range! range)</code>
+How the sight range of the selected unit is shown on map.
<dl>
<dt>range</dt>
-<dd>#f,'rectangle,'circle,'#t.
+<dd>Possible values:
+<pre>
+#f None
+'rectangle Alpha rectangle around unit
+'circle Alpha circle around unit
+#t Rectangle around unit
</dd>
</dl>
@@ -1581,15 +1321,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-show-tips!"></a>
-<h3>set-show-tips!</h3>
-
-<h4>Description</h4>
+<h3>(set-show-tips! tips)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-show-tips! tips)</code>
<dl>
<dt>tips</dt>
@@ -1610,15 +1345,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-speed-build!"></a>
-<h3>set-speed-build!</h3>
-
-<h4>Description</h4>
+<h3>(set-speed-build! speed)</h3>
Set build speed.
-<h4>Syntax</h4>
-
-<code>(set-speed-build! speed)</code>
<dl>
<dt>speed</dt>
@@ -1639,15 +1369,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-speed-research!"></a>
-<h3>set-speed-research!</h3>
-
-<h4>Description</h4>
+<h3>(set-speed-research! speed)</h3>
Set research speed.
-<h4>Syntax</h4>
-
-<code>(set-speed-research! speed)</code>
<dl>
<dt>speed</dt>
@@ -1668,15 +1393,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-speed-resources-harvest!"></a>
-<h3>set-speed-resources-harvest!</h3>
-
-<h4>Description</h4>
+<h3>(set-speed-resources-harvest! resource speed)</h3>
Set the harvesting speed of a resource.
-<h4>Syntax</h4>
-
-<code>(set-speed-resources-harvest! resource speed)</code>
<dl>
<dt>resource</dt>
@@ -1700,15 +1420,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-speed-resources-return!"></a>
-<h3>set-speed-resources-return!</h3>
-
-<h4>Description</h4>
+<h3>(set-speed-resources-return! resource speed)</h3>
Set the returning speed of a resource.
-<h4>Syntax</h4>
-
-<code>(set-speed-resources-return! resource speed)</code>
<dl>
<dt>resource</dt>
@@ -1732,15 +1447,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-speed-train!"></a>
-<h3>set-speed-train!</h3>
-
-<h4>Description</h4>
+<h3>(set-speed-train! speed)</h3>
Set train speed.
-<h4>Syntax</h4>
-
-<code>(set-speed-train! speed)</code>
<dl>
<dt>speed</dt>
@@ -1761,15 +1471,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-speed-upgrade!"></a>
-<h3>set-speed-upgrade!</h3>
-
-<h4>Description</h4>
+<h3>(set-speed-upgrade! speed)</h3>
Set upgrade speed.
-<h4>Syntax</h4>
-
-<code>(set-speed-upgrade! speed)</code>
<dl>
<dt>speed</dt>
@@ -1790,15 +1495,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-speeds!"></a>
-<h3>set-speeds!</h3>
-
-<h4>Description</h4>
+<h3>(set-speeds! speed)</h3>
Set all speeds.
-<h4>Syntax</h4>
-
-<code>(set-speeds! speed)</code>
<dl>
<dt>speed</dt>
@@ -1819,15 +1519,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-title-screen!"></a>
-<h3>set-title-screen!</h3>
-
-<h4>Description</h4>
+<h3>(set-title-screen! image)</h3>
Change the default title screen.
-<h4>Syntax</h4>
-
-<code>(set-title-screen! image)</code>
<dl>
<dt>image</dt>
@@ -1849,15 +1544,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-training-queue!"></a>
-<h3>set-training-queue!</h3>
-
-<h4>Description</h4>
+<h3>(set-training-queue! queue)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-training-queue! queue)</code>
<dl>
<dt>queue</dt>
@@ -1878,15 +1568,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-xp-damage!"></a>
-<h3>set-xp-damage!</h3>
-
-<h4>Description</h4>
+<h3>(set-xp-damage! damage)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-xp-damage! damage)</code>
<dl>
<dt>damage</dt>
@@ -1907,15 +1592,9 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="shadow-sprite"></a>
-<h3>shadow-sprite</h3>
+<h3>(shadow-sprite file hotx hoty width height)</h3>
-<h4>Description</h4>
-
-.
-
-<h4>Syntax</h4>
-
-<code>(shadow-sprite file hotx hoty width height)</code>
+Define shadow-sprite.
<dl>
<dt>file</dt>
@@ -1937,22 +1616,15 @@
(shadow-sprite "graphics/missiles/unit shadow.png" 3 42 32 32)
</pre>
-<p>.
-
<h4>Used</h4>
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="show-energy-selected-only"></a>
-<h3>show-energy-selected-only</h3>
-
-<h4>Description</h4>
+<h3>(show-energy-selected-only)</h3>
.
-<h4>Syntax</h4>
-
-<code>(show-energy-selected-only)</code>
<h4>Example</h4>
@@ -1967,245 +1639,59 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="show-full"></a>
-<h3>show-full</h3>
-
-<h4>Description</h4>
-
-.
-
-<h4>Syntax</h4>
-
-<code>(show-full)</code>
-
-<h4>Example</h4>
-
-<pre>
- (show-full)
-</pre>
-
-<p>.
-
-<h4>Used</h4>
+<h3>(show-full)</h3>
-<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
+Use to show always bars or dots. No parameters.
<a name="show-health-bar"></a>
-<h3>show-health-bar</h3>
-
-<h4>Description</h4>
-
-.
+<h3>(show-health-bar)</h3>
-<h4>Syntax</h4>
-
-<code>(show-health-bar)</code>
-
-<h4>Example</h4>
-
-<pre>
- (show-health-bar)
-</pre>
-
-<p>.
-
-<h4>Used</h4>
-
-<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
+Adds a health bar to the left of the unit. No parameters.
<a name="show-health-dot"></a>
-<h3>show-health-dot</h3>
-
-<h4>Description</h4>
-
-.
+<h3>(show-health-dot)</h3>
-<h4>Syntax</h4>
-
-<code>(show-health-dot)</code>
-
-<h4>Example</h4>
-
-<pre>
- (show-health-dot)
-</pre>
-
-<p>.
-
-<h4>Used</h4>
-
-<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
+Adds a health dot to the left of the unit. No parameters.
<a name="show-health-horizontal"></a>
-<h3>show-health-horizontal</h3>
-
-<h4>Description</h4>
-
-.
+<h3>(show-health-horizontal)</h3>
-<h4>Syntax</h4>
-
-<code>(show-health-horizontal)</code>
-
-<h4>Example</h4>
-
-<pre>
- (show-health-horizontal)
-</pre>
-
-<p>.
-
-<h4>Used</h4>
-
-<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
+Show health bars horizontal. No parameters.
<a name="show-health-vertical"></a>
-<h3>show-health-vertical</h3>
-
-<h4>Description</h4>
-
-.
+<h3>(show-health-vertical)</h3>
-<h4>Syntax</h4>
-
-<code>(show-health-vertical)</code>
-
-<h4>Example</h4>
-
-<pre>
- (show-health-vertical)
-</pre>
-
-<p>.
-
-<h4>Used</h4>
-
-<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
+Show health bars vertical. No parameters.
<a name="show-mana-bar"></a>
-<h3>show-mana-bar</h3>
-
-<h4>Description</h4>
-
-.
-
-<h4>Syntax</h4>
-
-<code>(show-mana-bar)</code>
-
-<h4>Example</h4>
-
-<pre>
- (show-mana-bar)
-</pre>
-
-<p>.
+<h3>(show-mana-bar)</h3>
-<h4>Used</h4>
-
-<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
+Show a mana bar to the right of the unit. No parameters.
<a name="show-mana-dot"></a>
-<h3>show-mana-dot</h3>
-
-<h4>Description</h4>
-
-.
-
-<h4>Syntax</h4>
-
-<code>(show-mana-dot)</code>
-
-<h4>Example</h4>
+<h3>(show-mana-dot)</h3>
-<pre>
- (show-mana-dot)
-</pre>
-
-<p>.
-
-<h4>Used</h4>
-
-<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
+Show a mana dot to the right of the unit. No parameters.
<a name="show-mana-horizontal"></a>
-<h3>show-mana-horizontal</h3>
-
-<h4>Description</h4>
-
-.
-
-<h4>Syntax</h4>
-
-<code>(show-mana-horizontal)</code>
-
-<h4>Example</h4>
+<h3>(show-mana-horizontal)</h3>
-<pre>
- (show-mana-horizontal)
-</pre>
-
-<p>.
-
-<h4>Used</h4>
-
-<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
+Show mana bars horizontal. No parameters.
<a name="show-mana-vertical"></a>
-<h3>show-mana-vertical</h3>
-
-<h4>Description</h4>
-
-.
-
-<h4>Syntax</h4>
-
-<code>(show-mana-vertical)</code>
-
-<h4>Example</h4>
+<h3>(show-mana-vertical)</h3>
-<pre>
- (show-mana-vertical)
-</pre>
-
-<p>.
-
-<h4>Used</h4>
-
-<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
+Show mana bars vertical. No parameters.
<a name="show-no-full"></a>
-<h3>show-no-full</h3>
+<h3>(show-no-full)</h3>
-<h4>Description</h4>
-
-.
-
-<h4>Syntax</h4>
-
-<code>(show-no-full)</code>
-
-<h4>Example</h4>
-
-<pre>
- (show-no-full)
-</pre>
-
-<p>.
-
-<h4>Used</h4>
-
-<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
+Use to get no full bars or dots. No parameters.
<a name="spell-sprite"></a>
-<h3>spell-sprite</h3>
+<h3>(spell-sprite file hotx hoty width height)</h3>
-<h4>Description</h4>
-
-.
-
-<h4>Syntax</h4>
-
-<code>(spell-sprite file hotx hoty width height)</code>
+Define spell-sprite.
<dl>
<dt>file</dt>
@@ -2227,14 +1713,12 @@
(spell-sprite "graphics/ui/bloodlust,haste,slow,invisible,shield.png" 1 1
16 16)
</pre>
-<p>.
-
<h4>Used</h4>
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<hr>
-Last changed: $Id: config.html,v 1.20 2003/07/03 17:40:05 ingo Exp $<br>
+Last changed: $Id: config.html,v 1.21 2003/09/02 19:23:08 martinxyz Exp $<br>
All trademarks and copyrights on this page are owned by their respective
owners.
<address>(c) 2002-2003 by <a href="http://stratagus.org";>
The Stratagus Project</a></address></body></html>
Index: stratagus/doc/ccl/game.html
diff -u stratagus/doc/ccl/game.html:1.28 stratagus/doc/ccl/game.html:1.29
--- stratagus/doc/ccl/game.html:1.28 Thu Jul 3 13:40:05 2003
+++ stratagus/doc/ccl/game.html Tue Sep 2 15:23:08 2003
@@ -112,15 +112,10 @@
Everything around the game.
<h2>Functions</h2>
<a name="add-keystroke-help"></a>
-<h3>add-keystroke-help</h3>
-
-<h4>Description</h4>
+<h3>(add-keystroke-help)</h3>
.
-<h4>Syntax</h4>
-
-<code>(add-keystroke-help)</code>
<dl>
<dt></dt>
@@ -141,15 +136,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="add-message"></a>
-<h3>add-message</h3>
-
-<h4>Description</h4>
+<h3>(add-message message)</h3>
Add a message to be displayed.
-<h4>Syntax</h4>
-
-<code>(add-message message)</code>
<dl>
<dt>message</dt>
@@ -168,15 +158,10 @@
<h4>Not Used</h4>
<a name="add-objective"></a>
-<h3>add-objective</h3>
-
-<h4>Description</h4>
+<h3>(add-objective objective position)</h3>
Add an objective to the scenario objectives text list.
-<h4>Syntax</h4>
-
-<code>(add-objective objective position)</code>
<dl>
<dt>objective</dt>
@@ -199,15 +184,10 @@
<h4>Not Used</h4>
<a name="add-tip"></a>
-<h3>add-tip</h3>
-
-<h4>Description</h4>
+<h3>(add-tip tip)</h3>
Adds a tip. Tips are shown at the start of a level.
-<h4>Syntax</h4>
-
-<code>(add-tip tip)</code>
<dl>
<dt>tip</dt>
@@ -228,15 +208,10 @@
<a href="../../data/ccl/tips.ccl"> $LIBARYPATH/ccl/tips.ccl </a>
<a name="briefing"></a>
-<h3>briefing</h3>
-
-<h4>Description</h4>
+<h3>(briefing)</h3>
.
-<h4>Syntax</h4>
-
-<code>(briefing)</code>
<dl>
<dt></dt>
@@ -257,15 +232,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="center-map"></a>
-<h3>center-map</h3>
-
-<h4>Description</h4>
+<h3>(center-map x y)</h3>
Center the current viewport at a certain location.
-<h4>Syntax</h4>
-
-<code>(center-map x y)</code>
<dl>
<dt>x</dt>
@@ -287,16 +257,10 @@
<h4>Not Used</h4>
<a name="change-units-owner"></a>
-
-<h3>change-units-owner</h3>
-
-<h4>Description</h4>
+<h3>(change-units-owner '(x1 y1) '(x2 y2) oldplayer newplayer)</h3>
Changes the owner of a group of units from 1 player to another.
-<h4>Syntax</h4>
-
-<code>(change-units-owner '(x1 y1) '(x2 y2) oldplayer newplayer)</code>
<dl>
<dt>'(x1 y1)</dt>
@@ -325,16 +289,11 @@
<h4>Not Used</h4>
<a name="create-unit"></a>
-<h3>create-unit</h3>
-
-<h4>Description</h4>
+<h3>(create-unit type player x y)</h3>
Create a unit at a location. If the location is occupied the unit will be
placed in the closest available spot.
-<h4>Syntax</h4>
-
-<code>(create-unit type player x y)</code>
<dl>
<dt>type</dt>
@@ -362,15 +321,10 @@
<h4>Not Used</h4>
<a name="credits"></a>
-<h3>credits</h3>
-
-<h4>Description</h4>
+<h3>(credits)</h3>
.
-<h4>Syntax</h4>
-
-<code>(credits)</code>
<dl>
<dt></dt>
@@ -391,15 +345,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="define-campaign"></a>
-<h3>define-campaign</h3>
-
-<h4>Description</h4>
+<h3>(define-campaign)</h3>
.
-<h4>Syntax</h4>
-
-<code>(define-campaign)</code>
<dl>
<dt></dt>
@@ -420,9 +369,7 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="define-construction"></a>
-<h3>define-construction</h3>
-
-<h4>Description</h4>
+<h3><pre</h3>
Defines a construction.<br>
<br>
@@ -432,9 +379,6 @@
The construction frames should be ordered by increasing percentages and the
first frame should be 0.
-<h4>Syntax</h4>
-
-<code><pre>
(define-construction ident
'file '(
tileset tileset
@@ -507,15 +451,10 @@
<a href="../../data/ccl/orc/constructions.ccl">
$LIBARYPATH/ccl/orc/constructions.ccl </a>
<a name="define-construction-wc-names"></a>
-<h3>define-construction-wc-names</h3>
-
-<h4>Description</h4>
+<h3>(define-construction-wc-names)</h3>
.
-<h4>Syntax</h4>
-
-<code>(define-construction-wc-names)</code>
<dl>
<dt></dt>
@@ -536,15 +475,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="define-editor-unittypes"></a>
-<h3>define-editor-unittypes</h3>
-
-<h4>Description</h4>
+<h3>(define-editor-unittypes)</h3>
.
-<h4>Syntax</h4>
-
-<code>(define-editor-unittypes)</code>
<dl>
<dt></dt>
@@ -565,15 +499,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="define-map"></a>
-<h3>define-map</h3>
-
-<h4>Description</h4>
+<h3>(define-map)</h3>
.
-<h4>Syntax</h4>
-
-<code>(define-map)</code>
<dl>
<dt></dt>
@@ -594,15 +523,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="define-missile-type"></a>
-<h3>define-missile-type</h3>
-
-<h4>Description</h4>
+<h3>(define-missile-type)</h3>
.
-<h4>Syntax</h4>
-
-<code>(define-missile-type)</code>
<dl>
<dt></dt>
@@ -623,15 +547,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="define-missiletype-wc-names"></a>
-<h3>define-missiletype-wc-names</h3>
-
-<h4>Description</h4>
+<h3>(define-missiletype-wc-names)</h3>
.
-<h4>Syntax</h4>
-
-<code>(define-missiletype-wc-names)</code>
<dl>
<dt></dt>
@@ -652,15 +571,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="define-race-names"></a>
-<h3>define-race-names</h3>
-
-<h4>Description</h4>
+<h3><pre</h3>
Define the race names.
-<h4>Syntax</h4>
-
-<code><pre>
(define-race-names
'race '(
race race-number
@@ -713,15 +627,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="define-ranks"></a>
-<h3>define-ranks</h3>
-
-<h4>Description</h4>
+<h3>(define-ranks race '(score rank [score rank] ...))</h3>
Define ranks for a race.
-<h4>Syntax</h4>
-
-<code>(define-ranks race '(score rank [score rank] ...))</code>
<dl>
<dt>race</dt>
@@ -753,15 +662,10 @@
<a href="../../data/ccl/ranks.ccl"> $LIBARYPATH/ccl/ranks.ccl </a>
<a name="diplomacy"></a>
-<h3>diplomacy</h3>
-
-<h4>Description</h4>
+<h3>(diplomacy)</h3>
.
-<h4>Syntax</h4>
-
-<code>(diplomacy)</code>
<dl>
<dt></dt>
@@ -782,15 +686,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="stratagus-map"></a>
-<h3>stratagus-map</h3>
-
-<h4>Description</h4>
+<h3>(stratagus-map)</h3>
.
-<h4>Syntax</h4>
-
-<code>(stratagus-map)</code>
<dl>
<dt></dt>
@@ -811,15 +710,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="game-cycle"></a>
-<h3>game-cycle</h3>
-
-<h4>Description</h4>
+<h3>(game-cycle)</h3>
Returns the current game cycle.
-<h4>Syntax</h4>
-
-<code>(game-cycle)</code>
<dl>
<dt></dt>
@@ -838,15 +732,10 @@
<h4>Not Used</h4>
<a name="get-stratagus-home-path"></a>
-<h3>get-stratagus-home-path</h3>
-
-<h4>Description</h4>
+<h3>(get-stratagus-home-path)</h3>
.
-<h4>Syntax</h4>
-
-<code>(get-stratagus-home-path)</code>
<dl>
<dt></dt>
@@ -867,15 +756,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="get-stratagus-library-path"></a>
-<h3>get-stratagus-library-path</h3>
-
-<h4>Description</h4>
+<h3>(get-stratagus-library-path)</h3>
.
-<h4>Syntax</h4>
-
-<code>(get-stratagus-library-path)</code>
<dl>
<dt></dt>
@@ -896,15 +780,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="get-player-resource"></a>
-<h3>get-player-resource</h3>
-
-<h4>Description</h4>
+<h3>(get-player-resource player resource)</h3>
Get the amount of a resource for a certain player.
-<h4>Syntax</h4>
-
-<code>(get-player-resource player resource)</code>
<dl>
<dt>player</dt>
@@ -926,15 +805,10 @@
<h4>Not Used</h4>
<a name="get-this-player"></a>
-<h3>get-this-player</h3>
-
-<h4>Description</h4>
+<h3>(get-this-player)</h3>
.
-<h4>Syntax</h4>
-
-<code>(get-this-player)</code>
<dl>
<dt></dt>
@@ -955,15 +829,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="get-unit-unholy-armor"></a>
-<h3>get-unit-unholy-armor</h3>
-
-<h4>Description</h4>
+<h3>(get-unit-unholy-armor)</h3>
.
-<h4>Syntax</h4>
-
-<code>(get-unit-unholy-armor)</code>
<dl>
<dt></dt>
@@ -984,15 +853,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="group"></a>
-<h3>group</h3>
-
-<h4>Description</h4>
+<h3>(group)</h3>
.
-<h4>Syntax</h4>
-
-<code>(group)</code>
<dl>
<dt></dt>
@@ -1013,15 +877,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="kill-unit"></a>
-<h3>kill-unit</h3>
-
-<h4>Description</h4>
+<h3>(kill-unit unit player)</h3>
Kill a unit.
-<h4>Syntax</h4>
-
-<code>(kill-unit unit player)</code>
<dl>
<dt>unit</dt>
@@ -1052,15 +911,10 @@
<h4>Not Used</h4>
<a name="kill-unit-at"></a>
-<h3>kill-unit-at</h3>
-
-<h4>Description</h4>
+<h3>(kill-unit-at unit player quantity location1 location2)</h3>
Kills units at a specific location.
-<h4>Syntax</h4>
-
-<code>(kill-unit-at unit player quantity location1 location2)</code>
<dl>
<dt>unit</dt>
@@ -1103,15 +957,10 @@
<h4>Not Used</h4>
<a name="library-path"></a>
-<h3>library-path</h3>
-
-<h4>Description</h4>
+<h3>(library-path)</h3>
.
-<h4>Syntax</h4>
-
-<code>(library-path)</code>
<dl>
<dt></dt>
@@ -1132,15 +981,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="load-map"></a>
-<h3>load-map</h3>
-
-<h4>Description</h4>
+<h3>(load-map map)</h3>
Load a map using any of the supported formats.
-<h4>Syntax</h4>
-
-<code>(load-map map)</code>
<dl>
<dt>map</dt>
@@ -1159,15 +1003,10 @@
<h4>Not Used</h4>
<a name="load-pud"></a>
-<h3>load-pud</h3>
-
-<h4>Description</h4>
+<h3>(load-pud map)</h3>
Load a map using the pud format.
-<h4>Syntax</h4>
-
-<code>(load-pud map)</code>
<dl>
<dt>map</dt>
@@ -1186,15 +1025,10 @@
<h4>Not Used</h4>
<a name="log"></a>
-<h3>log</h3>
-
-<h4>Description</h4>
+<h3>(log)</h3>
.
-<h4>Syntax</h4>
-
-<code>(log)</code>
<dl>
<dt></dt>
@@ -1215,15 +1049,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="make-unit"></a>
-<h3>make-unit</h3>
-
-<h4>Description</h4>
+<h3>(make-unit)</h3>
.
-<h4>Syntax</h4>
-
-<code>(make-unit)</code>
<dl>
<dt></dt>
@@ -1244,15 +1073,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="missile"></a>
-<h3>missile</h3>
-
-<h4>Description</h4>
+<h3>(missile)</h3>
.
-<h4>Syntax</h4>
-
-<code>(missile)</code>
<dl>
<dt></dt>
@@ -1273,15 +1097,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="new-colors"></a>
-<h3>new-colors</h3>
-
-<h4>Description</h4>
+<h3>(new-colors)</h3>
.
-<h4>Syntax</h4>
-
-<code>(new-colors)</code>
<dl>
<dt></dt>
@@ -1302,15 +1121,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="pf-show-groupids!"></a>
-<h3>pf-show-groupids!</h3>
-
-<h4>Description</h4>
+<h3>(pf-show-groupids!)</h3>
.
-<h4>Syntax</h4>
-
-<code>(pf-show-groupids!)</code>
<dl>
<dt></dt>
@@ -1331,15 +1145,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="pf-show-regids!"></a>
-<h3>pf-show-regids!</h3>
-
-<h4>Description</h4>
+<h3>(pf-show-regids!)</h3>
.
-<h4>Syntax</h4>
-
-<code>(pf-show-regids!)</code>
<dl>
<dt></dt>
@@ -1360,15 +1169,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="place-unit"></a>
-<h3>place-unit</h3>
-
-<h4>Description</h4>
+<h3>(place-unit)</h3>
.
-<h4>Syntax</h4>
-
-<code>(place-unit)</code>
<dl>
<dt></dt>
@@ -1389,15 +1193,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="player"></a>
-<h3>player</h3>
-
-<h4>Description</h4>
+<h3>(player)</h3>
.
-<h4>Syntax</h4>
-
-<code>(player)</code>
<dl>
<dt></dt>
@@ -1418,15 +1217,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="remove-objective"></a>
-<h3>remove-objective</h3>
-
-<h4>Description</h4>
+<h3>(remove-objective position)</h3>
Remove an objective from the scenario objectives text list.
-<h4>Syntax</h4>
-
-<code>(remove-objective position)</code>
<dl>
<dt>position</dt>
@@ -1444,15 +1238,10 @@
<h4>Not Used</h4>
<a name="replay-log"></a>
-<h3>replay-log</h3>
-
-<h4>Description</h4>
+<h3>(replay-log)</h3>
.
-<h4>Syntax</h4>
-
-<code>(replay-log)</code>
<dl>
<dt></dt>
@@ -1473,15 +1262,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="reset-keystroke-help"></a>
-<h3>reset-keystroke-help</h3>
-
-<h4>Description</h4>
+<h3>(reset-keystroke-help)</h3>
.
-<h4>Syntax</h4>
-
-<code>(reset-keystroke-help)</code>
<dl>
<dt></dt>
@@ -1502,15 +1286,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="selection"></a>
-<h3>selection</h3>
-
-<h4>Description</h4>
+<h3>(selection)</h3>
.
-<h4>Syntax</h4>
-
-<code>(selection)</code>
<dl>
<dt></dt>
@@ -1531,15 +1310,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="set-default-map!"></a>
-<h3>set-default-map!</h3>
-
-<h4>Description</h4>
+<h3>(set-default-map! path)</h3>
Set the default map path.
-<h4>Syntax</h4>
-
-<code>(set-default-map! path)</code>
<dl>
<dt>path</dt>
@@ -1558,15 +1332,10 @@
<h4>Not Used</h4>
<a name="set-diplomacy!"></a>
-<h3>set-diplomacy!</h3>
-
-<h4>Description</h4>
+<h3>(set-diplomacy! player state enemy)</h3>
Alters the diplomacy setting between two players. eg Enemy,Allied
-<h4>Syntax</h4>
-
-<code>(set-diplomacy! player state enemy)</code>
<dl>
<dt>player</dt>
@@ -1596,15 +1365,10 @@
<h4>Not Used</h4>
<a name="set-game-cycle!"></a>
-<h3>set-game-cycle!</h3>
-
-<h4>Description</h4>
+<h3>(set-game-cycle! cycle)</h3>
Set the current game cycle number.
-<h4>Syntax</h4>
-
-<code>(set-game-cycle! cycle)</code>
<dl>
<dt>cycle</dt>
@@ -1623,15 +1387,10 @@
<h4>Not Used</h4>
<a name="set-game-paused!"></a>
-<h3>set-game-cycle!</h3>
-
-<h4>Description</h4>
+<h3>(set-game-paused! paused)</h3>
Pause or unpause the game.
-<h4>Syntax</h4>
-
-<code>(set-game-paused! paused)</code>
<dl>
<dt>paused</dt>
@@ -1650,15 +1409,10 @@
<h4>Not Used</h4>
<a name="set-group-id!"></a>
-<h3>set-group-id!</h3>
-
-<h4>Description</h4>
+<h3>(set-group-id!)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-group-id!)</code>
<dl>
<dt></dt>
@@ -1679,15 +1433,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="set-objectives!"></a>
-<h3>set-objectives!</h3>
-
-<h4>Description</h4>
+<h3>(set-objectives! objective [objective ...])</h3>
Set the mission objectives. This will overwrite any previous objectives.
-<h4>Syntax</h4>
-
-<code>(set-objectives! objective [objective ...])</code>
<dl>
<dt>objective</dt>
@@ -1706,15 +1455,10 @@
<h4>Not Used</h4>
<a name="set-player-resource!"></a>
-<h3>set-player-resource!</h3>
-
-<h4>Description</h4>
+<h3>(set-player-resource! player resource amount [[resource amount] ...])</h3>
Set the amount of resources for a certain player.
-<h4>Syntax</h4>
-
-<code>(set-player-resource! player resource amount [[resource amount]
...])</code>
<dl>
<dt>player</dt>
@@ -1740,15 +1484,10 @@
<h4>Not Used</h4>
<a name="set-shared-vision!"></a>
-<h3>set-shared-vision!</h3>
-
-<h4>Description</h4>
+<h3>(set-shared-vision! player state opponent)</h3>
Sets shared vision.
-<h4>Syntax</h4>
-
-<code>(set-shared-vision! player state opponent)</code>
<dl>
<dt>player</dt>
@@ -1773,15 +1512,10 @@
<h4>Not Used</h4>
<a name="set-this-player!"></a>
-<h3>set-this-player!</h3>
-
-<h4>Description</h4>
+<h3>(set-this-player!)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-this-player!)</code>
<dl>
<dt></dt>
@@ -1802,15 +1536,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="set-unit-unholy-armor!"></a>
-<h3>set-unit-unholy-armor!</h3>
-
-<h4>Description</h4>
+<h3>(set-unit-unholy-armor!)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-unit-unholy-armor!)</code>
<dl>
<dt></dt>
@@ -1831,15 +1560,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="shared-vision"></a>
-<h3>shared-vision</h3>
-
-<h4>Description</h4>
+<h3>(shared-vision state opponent)</h3>
Sets shared vision for the player at the computer.
-<h4>Syntax</h4>
-
-<code>(shared-vision state opponent)</code>
<dl>
<dt>state</dt>
@@ -1861,15 +1585,10 @@
<h4>Not Used</h4>
<a name="show-map-location"></a>
-<h3>show-map-location</h3>
-
-<h4>Description</h4>
+<h3>(show-map-location x y radius cycles)</h3>
Show an area on the map for the given player.
-<h4>Syntax</h4>
-
-<code>(show-map-location x y radius cycles)</code>
<dl>
<dt></dt>
@@ -1888,15 +1607,10 @@
<h4>Not Used</h4>
<a name="slot-usage"></a>
-<h3>slot-usage</h3>
-
-<h4>Description</h4>
+<h3>(slot-usage)</h3>
.
-<h4>Syntax</h4>
-
-<code>(slot-usage)</code>
<dl>
<dt></dt>
@@ -1917,15 +1631,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="unit"></a>
-<h3>unit</h3>
-
-<h4>Description</h4>
+<h3>(unit)</h3>
.
-<h4>Syntax</h4>
-
-<code>(unit)</code>
<dl>
<dt></dt>
@@ -1946,15 +1655,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="units"></a>
-<h3>units</h3>
-
-<h4>Description</h4>
+<h3>(units)</h3>
.
-<h4>Syntax</h4>
-
-<code>(units)</code>
<dl>
<dt></dt>
@@ -1975,7 +1679,7 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<hr>
-Last changed: $Id: game.html,v 1.28 2003/07/03 17:40:05 ingo Exp $<br>
+Last changed: $Id: game.html,v 1.29 2003/09/02 19:23:08 martinxyz Exp $<br>
All trademarks and copyrights on this page are owned by their respective
owners.
<address>(c) 2002-2003 by <a href="http://stratagus.org";>
The Stratagus Project</a></address></body></html>
Index: stratagus/doc/ccl/icon.html
diff -u stratagus/doc/ccl/icon.html:1.15 stratagus/doc/ccl/icon.html:1.16
--- stratagus/doc/ccl/icon.html:1.15 Thu Jul 3 13:40:05 2003
+++ stratagus/doc/ccl/icon.html Tue Sep 2 15:23:08 2003
@@ -58,17 +58,12 @@
Everything around the C icon structure.
<h2>Functions</h2>
<a name="define-icon"></a>
-<h3>define-icon</h3>
-
-<h4>Description</h4>
+<h3>(define-icon ident 'tileset tileset 'size '(x y) type '(index file))</h3>
Define an icon for the engine.<p>
This could also be defined in own levels. <p>
-<h4>Syntax</h4>
-
-<code>(define-icon ident 'tileset tileset 'size '(x y) type '(index
file))</code>
<dl>
<dt>ident</dt>
@@ -114,16 +109,11 @@
"tilesets/summer/icons.png" and is the first icon in this file.
<a name="define-icon-alias"></a>
-<h3>define-icon-alias</h3>
-
-<h4>Description</h4>
+<h3>(define-icon-alias alias icon)</h3>
Define an icon alias for an icon.<p>
This is an alternative name for the icon.
-<h4>Syntax</h4>
-
-<code>(define-icon-alias alias icon)</code>
<dl>
<dt>alias</dt>
@@ -144,15 +134,10 @@
"icon-raise-dead".
<a name="define-icon-wc-names"></a>
-<h3>define-icon-wc-names</h3>
-
-<h4>Description</h4>
+<h3>(define-icon-wc-names icon-0 icon-1 ... icon-195)</h3>
Define the mapping of the icon numbers in puds, to the icon names.
-<h4>Syntax</h4>
-
-<code>(define-icon-wc-names icon-0 icon-1 ... icon-195)</code>
<dl>
<dt>icon-0</dt>
@@ -181,15 +166,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="set-icon-size!"></a>
-<h3>set-icon-size!</h3>
-
-<h4>Description</h4>
+<h3>(set-icon-size! width height)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-icon-size! width height)</code>
<dl>
<dt>width</dt>
@@ -213,15 +193,10 @@
<a href="../../data/ccl/icons.ccl"> $LIBARYPATH/ccl/icons.ccl </a>
<a name="set-icons-per-row!"></a>
-<h3>set-icons-per-row!</h3>
-
-<h4>Description</h4>
+<h3>(set-icons-per-row! icons)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-icons-per-row! icons)</code>
<dl>
<dt>icons</dt>
@@ -242,7 +217,7 @@
<a href="../../data/ccl/icons.ccl"> $LIBARYPATH/ccl/icons.ccl </a>
<hr>
-Last changed: $Id: icon.html,v 1.15 2003/07/03 17:40:05 ingo Exp $<br>
+Last changed: $Id: icon.html,v 1.16 2003/09/02 19:23:08 martinxyz Exp $<br>
All trademarks and copyrights on this page are owned by their respective
owners.
<address>(c) 2002-2003 by <a href="http://stratagus.org";>
The Stratagus Project</a></address></body></html>
Index: stratagus/doc/ccl/research.html
diff -u stratagus/doc/ccl/research.html:1.11
stratagus/doc/ccl/research.html:1.12
--- stratagus/doc/ccl/research.html:1.11 Thu Jul 3 13:40:05 2003
+++ stratagus/doc/ccl/research.html Tue Sep 2 15:23:08 2003
@@ -61,15 +61,10 @@
<h2>Functions</h2>
<a name="check-dependency"></a>
-<h3>check-dependency</h3>
-
-<h4>Description</h4>
+<h3>(check-dependency)</h3>
NOT WRITTEN YET.
-<h4>Syntax</h4>
-
-<code>(check-dependency)</code>
<dl>
<dt>.</dt>
@@ -92,16 +87,11 @@
<a href="../../data/ccl/orc/upgrade.ccl"> $LIBARYPATH/ccl/orc/upgrade.ccl</a>
<a name="define-allow"></a>
-<h3>define-allow</h3>
-
-<h4>Description</h4>
+<h3>(define-allow name str16)</h3>
Define what unit-types and upgrades are enabled for each player during
a level.
-<h4>Syntax</h4>
-
-<code>(define-allow name str16)</code>
<dl>
<dt>name</dt>
@@ -137,18 +127,11 @@
<a href="../../data/ccl/orc/upgrade.ccl"> $LIBARYPATH/ccl/orc/upgrade.ccl</a>
<a name="define-dependency"></a>
-<h3>define-dependency</h3>
-
-<h4>Description</h4>
+<h3>(define-dependency unit-type/upgrade ...)</h3>
Define the dependencies for an unit-type or an upgrade. The dependency
must be full filled before an unit or research can be used.
-
-<h4>Syntax</h4>
-
-<code>(define-dependency unit-type/upgrade '( unit-type/upgrade count ... )
- ['or '( unit-type/upgrade count ... ) ...] )
-</code><p>
+<p>
<code>(define-dependency unit-type/upgrade '( required-part )
['or '( optional-or-part ) ...] )
</code>
@@ -200,17 +183,12 @@
<a href="../../data/ccl/orc/upgrade.ccl"> $LIBARYPATH/ccl/orc/upgrade.ccl</a>
<a name="define-modifier"></a>
-<h3>define-modifier</h3>
-
-<h4>Description</h4>
+<h3>(define-modifier name '(effect1 effect1-arg) ...)</h3>
Define the effects (modifier) of an upgrade. An upgrade can have multiple
modifiers. It can activate, enable or disable other upgrades and allows
complex reactions.
-<h4>Syntax</h4>
-
-<code>(define-modifier name '(effect1 effect1-arg) ...)</code>
<dl>
<dt>name</dt>
@@ -322,15 +300,10 @@
<a href="../../data/ccl/orc/upgrade.ccl"> $LIBARYPATH/ccl/orc/upgrade.ccl</a>
<a name="define-upgrade"></a>
-<h3>define-upgrade</h3>
-
-<h4>Description</h4>
+<h3>(define-upgrade name 'icon icon-id 'costs #( costs ... ))</h3>
Define an upgrade, how it is shown and how much it costs.
-<h4>Syntax</h4>
-
-<code>(define-upgrade name 'icon icon-id 'costs #( costs ... ))</code>
<dl>
<dt>name</dt>
@@ -366,15 +339,10 @@
<a href="../../data/ccl/orc/upgrade.ccl"> $LIBARYPATH/ccl/orc/upgrade.ccl</a>
<a name="define-upgrade-wc-names"></a>
-<h3>define-upgrade-wc-names</h3>
-
-<h4>Description</h4>
+<h3>(define-upgrade-wc-names sword1 sword2 ...)</h3>
.
-<h4>Syntax</h4>
-
-<code>(define-upgrade-wc-names sword1 sword2 ...)</code>
<dl>
<dt>.</dt>
@@ -397,15 +365,10 @@
<a href="../../data/ccl/orc/upgrade.ccl"> $LIBARYPATH/ccl/orc/upgrade.ccl</a>
<a name="get-dependency"></a>
-<h3>get-dependency</h3>
-
-<h4>Description</h4>
+<h3>(get-dependency)</h3>
NOT WRITTEN YET.
-<h4>Syntax</h4>
-
-<code>(get-dependency)</code>
<dl>
<dt>.</dt>
@@ -428,7 +391,7 @@
<a href="../../data/ccl/orc/upgrade.ccl"> $LIBARYPATH/ccl/orc/upgrade.ccl</a>
<hr>
-Last changed: $Id: research.html,v 1.11 2003/07/03 17:40:05 ingo Exp $<br>
+Last changed: $Id: research.html,v 1.12 2003/09/02 19:23:08 martinxyz Exp $<br>
All trademarks and copyrights on this page are owned by their respective
owners.
<address>(c) 2002-2003 by<a href="http://stratagus.org";>
The Stratagus Project</a></address></body></html>
Index: stratagus/doc/ccl/sound.html
diff -u stratagus/doc/ccl/sound.html:1.8 stratagus/doc/ccl/sound.html:1.9
--- stratagus/doc/ccl/sound.html:1.8 Thu Jul 3 13:40:05 2003
+++ stratagus/doc/ccl/sound.html Tue Sep 2 15:23:08 2003
@@ -74,15 +74,10 @@
Everything around sound.
<h2>Functions</h2>
<a name="define-game-sounds"></a>
-<h3>define-game-sounds</h3>
-
-<h4>Description</h4>
+<h3>(define-game-sounds name sound [[name sound] ...])</h3>
Specify some global sounds.
-<h4>Syntax</h4>
-
-<code>(define-game-sounds name sound [[name sound] ...])</code>
<dl>
<dt>name</dt>
@@ -112,16 +107,11 @@
<a href="../../data/ccl/sound.ccl"> $LIBARYPATH/ccl/sound.ccl </a>
<a name="display-sounds"></a>
-<h3>display-sounds</h3>
-
-<h4>Description</h4>
+<h3>(display-sounds)</h3>
Ask the sound system to dump on the standard output the mapping
between sound names and sound id.
-<h4>Syntax</h4>
-
-<code>(display-sounds)</code>
<h4>Example</h4>
@@ -134,16 +124,11 @@
<h4>Not Used</h4>
<a name="make-sound"></a>
-<h3>make-sound</h3>
-
-<h4>Description</h4>
+<h3>(make-sound name file)</h3>
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).
-<h4>Syntax</h4>
-
-<code>(make-sound name file)</code>
<dl>
<dt>name</dt>
@@ -172,15 +157,10 @@
<a href="../../data/ccl/sound.ccl"> $LIBARYPATH/ccl/sound.ccl </a>
<a name="make-sound-group"></a>
-<h3>make-sound-group</h3>
-
-<h4>Description</h4>
+<h3>(make-sound-group name group group)</h3>
Asks the sound system to build a special sound group.
-<h4>Syntax</h4>
-
-<code>(make-sound-group name group group)</code>
<dl>
<dt>name</dt>
@@ -205,15 +185,10 @@
<a href="../../data/ccl/sound.ccl"> $LIBARYPATH/ccl/sound.ccl </a>
<a name="map-sound"></a>
-<h3>map-sound</h3>
-
-<h4>Description</h4>
+<h3>(map-sound name sound)</h3>
Ask the sound system to remap a sound id to a given name.
-<h4>Syntax</h4>
-
-<code>(map-sound name sound)</code>
<dl>
<dt>name</dt>
@@ -237,15 +212,10 @@
<a href="../../data/ccl/sound.ccl"> $LIBARYPATH/ccl/sound.ccl </a>
<a name="play-file"></a>
-<h3>play-file</h3>
-
-<h4>Description</h4>
+<h3>(play-file name)</h3>
Play a sound file.
-<h4>Syntax</h4>
-
-<code>(play-file name)</code>
<dl>
<dt>name</dt>
@@ -266,15 +236,10 @@
<a href="../../data/ccl/sound.ccl"> $LIBARYPATH/ccl/sound.ccl </a>
<a name="play-music"></a>
-<h3>play-music</h3>
-
-<h4>Description</h4>
+<h3>(play-music name)</h3>
Name of the music file to play.
-<h4>Syntax</h4>
-
-<code>(play-music name)</code>
<dl>
<dt>name</dt>
@@ -295,15 +260,10 @@
<a href="../../data/ccl/sound.ccl"> $LIBARYPATH/ccl/sound.ccl </a>
<a name="play-sound"></a>
-<h3>play-sound</h3>
-
-<h4>Description</h4>
+<h3>(play-sound name)</h3>
Ask the sound system to play the specified sound.
-<h4>Syntax</h4>
-
-<code>(play-sound name)</code>
<dl>
<dt>name</dt>
@@ -324,15 +284,10 @@
<a href="../../data/ccl/sound.ccl"> $LIBARYPATH/ccl/sound.ccl </a>
<a name="set-cd-mode!"></a>
-<h3>set-cd-mode!</h3>
-
-<h4>Description</h4>
+<h3>(set-cd-mode! mode)</h3>
Set the cd mode.
-<h4>Syntax</h4>
-
-<code>(set-cd-mode! mode)</code>
<dl>
<dt>mode</dt>
@@ -353,15 +308,10 @@
<a href="../../data/ccl/sound.ccl"> $LIBARYPATH/ccl/sound.ccl </a>
<a name="set-global-sound-range!"></a>
-<h3>set-global-sound-range!</h3>
-
-<h4>Description</h4>
+<h3>(set-global-sound-range! distance)</h3>
Set the cut off distance.
-<h4>Syntax</h4>
-
-<code>(set-global-sound-range! distance)</code>
<dl>
<dt>distance</dt>
@@ -380,15 +330,10 @@
<h4>Not Used</h4>
<a name="set-menu-music!"></a>
-<h3>set-menu-music!</h3>
-
-<h4>Description</h4>
+<h3>(set-menu-music! song)</h3>
Set the default menu music.
-<h4>Syntax</h4>
-
-<code>(set-menu-music! song)</code>
<dl>
<dt>song</dt>
@@ -409,15 +354,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-music-volume!"></a>
-<h3>set-music-volume!</h3>
-
-<h4>Description</h4>
+<h3>(set-music-volume! volume)</h3>
.
-<h4>Syntax</h4>
-
-<code>(set-music-volume! volume)</code>
<dl>
<dt>volume</dt>
@@ -438,15 +378,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-sound-range!"></a>
-<h3>set-sound-range!</h3>
-
-<h4>Description</h4>
+<h3>(set-sound-range! name distance)</h3>
Set the range of a given sound.
-<h4>Syntax</h4>
-
-<code>(set-sound-range! name distance)</code>
<dl>
<dt>name</dt>
@@ -468,15 +403,10 @@
<h4>Not Used</h4>
<a name="set-sound-volume!"></a>
-<h3>set-sound-volume!</h3>
-
-<h4>Description</h4>
+<h3>(set-sound-volume! volume)</h3>
Global volume support.
-<h4>Syntax</h4>
-
-<code>(set-sound-volume! volume)</code>
<dl>
<dt>volume</dt>
@@ -497,15 +427,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-title-music!"></a>
-<h3>set-title-music!</h3>
-
-<h4>Description</h4>
+<h3>(set-title-music! song)</h3>
Change the default title music.
-<h4>Syntax</h4>
-
-<code>(set-title-music! song)</code>
<dl>
<dt>song</dt>
@@ -526,15 +451,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="sound-for-name"></a>
-<h3>sound-for-name</h3>
-
-<h4>Description</h4>
+<h3>(sound-for-name name)</h3>
Ask the sound system to associate a sound id to a sound name.
-<h4>Syntax</h4>
-
-<code>(sound-for-name name)</code>
<dl>
<dt>name</dt>
@@ -553,15 +473,10 @@
<h4>Not Used</h4>
<a name="sound-off"></a>
-<h3>sound-off</h3>
-
-<h4>Description</h4>
+<h3>(sound-off)</h3>
Turn off sound.
-<h4>Syntax</h4>
-
-<code>(sound-off)</code>
<h4>Example</h4>
@@ -574,15 +489,10 @@
<h4>Not Used</h4>
<a name="sound-on"></a>
-<h3>sound-on</h3>
-
-<h4>Description</h4>
+<h3>(sound-on)</h3>
Turn on sound.
-<h4>Syntax</h4>
-
-<code>(sound-on)</code>
<h4>Example</h4>
@@ -595,15 +505,10 @@
<h4>Not Used</h4>
<a name="sound-thread"></a>
-<h3>sound-thread</h3>
-
-<h4>Description</h4>
+<h3>(sound-thread)</h3>
Ask clone to use a sound thread.
-<h4>Syntax</h4>
-
-<code>(sound-thread)</code>
<h4>Example</h4>
@@ -616,15 +521,10 @@
<h4>Not Used</h4>
<a name="stop-music"></a>
-<h3>stop-music</h3>
-
-<h4>Description</h4>
+<h3>(stop-music)</h3>
Stop playing music.
-<h4>Syntax</h4>
-
-<code>(stop-music)</code>
<h4>Example</h4>
@@ -637,15 +537,10 @@
<h4>Not Used</h4>
<a name="with-sound"></a>
-<h3>with-sound</h3>
-
-<h4>Description</h4>
+<h3>(with-sound)</h3>
Returns true if compiled with sound, false otherwise.
-<h4>Syntax</h4>
-
-<code>(with-sound)</code>
<h4>Example</h4>
@@ -660,7 +555,7 @@
<a href="../../data/ccl/sound.ccl"> $LIBARYPATH/ccl/sound.ccl </a>
<hr>
-Last changed: $Id: sound.html,v 1.8 2003/07/03 17:40:05 ingo Exp $<br>
+Last changed: $Id: sound.html,v 1.9 2003/09/02 19:23:08 martinxyz Exp $<br>
All trademarks and copyrights on this page are owned by their respective
owners.
<address>(c) 2002-2003 by <a href="http://stratagus.org";>
The Stratagus Project</a></address></body></html>
Index: stratagus/doc/ccl/tileset.html
diff -u stratagus/doc/ccl/tileset.html:1.17 stratagus/doc/ccl/tileset.html:1.18
--- stratagus/doc/ccl/tileset.html:1.17 Thu Jul 3 13:40:05 2003
+++ stratagus/doc/ccl/tileset.html Tue Sep 2 15:23:08 2003
@@ -55,17 +55,12 @@
Everything around the C Tileset structure.
<h2>Functions</h2>
<a name="define-tileset"></a>
-<h3>define-tileset</h3>
-
-<h4>Description</h4>
+<h3>(define-tileset ident class name image palette slots animations)</h3>
Define a tileset for the engine.<p>
This could also be defined in own levels. <p>
-<h4>Syntax</h4>
-
-<code>(define-tileset ident class name image palette slots animations)</code>
FIXME:
@@ -100,15 +95,10 @@
</pre>
<a name="define-tileset-wc-names"></a>
-<h3>define-tileset-wc-names</h3>
-
-<h4>Description</h4>
+<h3>(define-tileset-wc-names tileset0 tileset1 tileset2 tileset3)</h3>
Define the mapping of the tileset numbers in puds, to the tileset names.
-<h4>Syntax</h4>
-
-<code>(define-tileset-wc-names tileset0 tileset1 tileset2 tileset3)</code>
<dl>
<dt>tileset0</dt>
@@ -139,7 +129,7 @@
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<hr>
-Last changed: $Id: tileset.html,v 1.17 2003/07/03 17:40:05 ingo Exp $<br>
+Last changed: $Id: tileset.html,v 1.18 2003/09/02 19:23:08 martinxyz Exp $<br>
All trademarks and copyrights on this page are owned by their respective
owners.
<address>(c) 2002-2003 by <a href="http://stratagus.org";>
The Stratagus Project</a></address></body></html>
Index: stratagus/doc/ccl/triggers.html
diff -u stratagus/doc/ccl/triggers.html:1.16
stratagus/doc/ccl/triggers.html:1.17
--- stratagus/doc/ccl/triggers.html:1.16 Thu Jul 3 13:40:05 2003
+++ stratagus/doc/ccl/triggers.html Tue Sep 2 15:23:08 2003
@@ -75,15 +75,10 @@
<h2>Functions</h2>
<a name="action-defeat"></a>
-<h3>action-defeat</h3>
-
-<h4>Description</h4>
+<h3>(action-defeat)</h3>
The condition player is set to defeat.
-<h4>Syntax</h4>
-
-<code>(action-defeat)</code>
<h4>Example</h4>
@@ -102,15 +97,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="action-draw"></a>
-<h3>action-draw</h3>
-
-<h4>Description</h4>
+<h3>(action-draw)</h3>
The condition player is set to draw. (NOT SUPPORTED)
-<h4>Syntax</h4>
-
-<code>(action-draw)</code>
<h4>Example</h4>
@@ -123,15 +113,10 @@
<h4>Not Used</h4>
<a name="action-set-switch"></a>
-<h3>action-set-switch</h3>
-
-<h4>Description</h4>
+<h3>(action-set-switch number set)</h3>
Set a switch.
-<h4>Syntax</h4>
-
-<code>(action-set-switch number set)</code>
<dl>
<dt>number</dt>
@@ -153,15 +138,10 @@
<h4>Not Used</h4>
<a name="action-set-timer"></a>
-<h3>action-set-timer</h3>
-
-<h4>Description</h4>
+<h3>(action-set-timer cycles increasing)</h3>
Set the timer.
-<h4>Syntax</h4>
-
-<code>(action-set-timer cycles increasing)</code>
<dl>
<dt>cycles</dt>
@@ -183,15 +163,10 @@
<h4>Not Used</h4>
<a name="action-start-timer"></a>
-<h3>action-start-timer</h3>
-
-<h4>Description</h4>
+<h3>(action-start-timer)</h3>
Start the timer.
-<h4>Syntax</h4>
-
-<code>(action-start-timer)</code>
<h4>Example</h4>
@@ -204,15 +179,10 @@
<h4>Not Used</h4>
<a name="action-stop-timer"></a>
-<h3>action-stop-timer</h3>
-
-<h4>Description</h4>
+<h3>(action-stop-timer)</h3>
Stop the timer.
-<h4>Syntax</h4>
-
-<code>(action-stop-timer)</code>
<h4>Example</h4>
@@ -225,15 +195,10 @@
<h4>Not Used</h4>
<a name="action-victory"></a>
-<h3>action-victory</h3>
-
-<h4>Description</h4>
+<h3>(action-victory)</h3>
The condition player is set to victory.
-<h4>Syntax</h4>
-
-<code>(action-victory)</code>
<h4>Example</h4>
@@ -253,15 +218,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="action-wait"></a>
-<h3>action-wait</h3>
-
-<h4>Description</h4>
+<h3>(action-wait ms)</h3>
Causes the trigger to wait a minimum number of milliseconds.
-<h4>Syntax</h4>
-
-<code>(action-wait ms)</code>
<dl>
<dt>ms</dt>
@@ -289,15 +249,10 @@
<h4>Not Used</h4>
<a name="add-trigger"></a>
-<h3>add-trigger</h3>
-
-<h4>Description</h4>
+<h3>(add-trigger condition action)</h3>
Creates a new trigger.
-<h4>Syntax</h4>
-
-<code>(add-trigger condition action)</code>
<dl>
<dt>condition</dt>
@@ -337,15 +292,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="if-elapsed"></a>
-<h3>if-elapsed</h3>
-
-<h4>Description</h4>
+<h3>(if-elapsed op quantity)</h3>
Game run for duration. If the game run for the duration game cycles the
action is executed.
-<h4>Syntax</h4>
-
-<code>(if-elapsed op quantity)</code>
<dl>
<dt>op</dt>
@@ -373,16 +323,11 @@
<h4>Not Used</h4>
<a name="if-kills"></a>
-<h3>if-kills</h3>
-
-<h4>Description</h4>
+<h3>(if-kills player op quantity)</h3>
Player has quantity of kills. Which quantity must be killed by the
player for the action.
-<h4>Syntax</h4>
-
-<code>(if-kills player op quantity)</code>
<dl>
<dt>player</dt>
@@ -417,17 +362,12 @@
<h4>Not Used</h4>
<a name="if-near-unit"></a>
-<h3>if-near-unit</h3>
-
-<h4>Description</h4>
+<h3>(if-near-unit player op quantity unit unit)</h3>
Player has the quantity of unit-type near to unit-type. Which unit
and how many units must the player have near to an other unit for
the action.
-<h4>Syntax</h4>
-
-<code>(if-near-unit player op quantity unit unit)</code>
<dl>
<dt>player</dt>
@@ -470,15 +410,10 @@
<h4>Not Used</h4>
<a name="if-opponents"></a>
-<h3>if-opponents</h3>
-
-<h4>Description</h4>
+<h3>(if-opponents player op quantity)</h3>
Player has the quantity of opponents.
-<h4>Syntax</h4>
-
-<code>(if-opponents player op quantity)</code>
<dl>
<dt>player</dt>
@@ -515,17 +450,12 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="if-rescued-near-unit"></a>
-<h3>if-rescued-near-unit</h3>
-
-<h4>Description</h4>
+<h3>(if-rescued-near-unit player op quantity unit unit)</h3>
Player has the quantity of rescued unit-type near to unit-type. Which
rescued unit and how many units must the player have near to a unit
for the action.
-<h4>Syntax</h4>
-
-<code>(if-rescued-near-unit player op quantity unit unit)</code>
<dl>
<dt>player</dt>
@@ -568,17 +498,12 @@
<h4>Not Used</h4>
<a name="if-resource"></a>
-<h3>if-resource</h3>
-
-<h4>Description</h4>
+<h3>(if-resource player op quantity resource)</h3>
Player has the quantity of resources. This condition is used to
specify how many or how little resources (gold, oil, lumber) a
player must have for the action.
-<h4>Syntax</h4>
-
-<code>(if-resource player op quantity resource)</code>
<dl>
<dt>player</dt>
@@ -619,16 +544,11 @@
<h4>Not Used</h4>
<a name="if-score"></a>
-<h3>if-score</h3>
-
-<h4>Description</h4>
+<h3>(if-score player op quantity)</h3>
Player has the quantity of score. If the player reaches the
quantity of score the action is executed.
-<h4>Syntax</h4>
-
-<code>(if-score player op quantity)</code>
<dl>
<dt>player</dt>
@@ -664,15 +584,10 @@
<h4>Not Used</h4>
<a name="if-switch"></a>
-<h3>if-switch</h3>
-
-<h4>Description</h4>
+<h3>(if-switch number set)</h3>
Checks the value of a switch.
-<h4>Syntax</h4>
-
-<code>(if-switch number set)</code>
<dl>
<dt>number</dt>
@@ -694,15 +609,10 @@
<h4>Not Used</h4>
<a name="if-timer"></a>
-<h3>if-timer</h3>
-
-<h4>Description</h4>
+<h3>(if-timer op cycles)</h3>
Timer reaches quantity. If the timer reaches quantity the action is executed.
-<h4>Syntax</h4>
-
-<code>(if-timer op cycles)</code>
<dl>
<dt>op</dt>
@@ -730,16 +640,11 @@
<h4>Not Used</h4>
<a name="if-unit"></a>
-<h3>if-unit</h3>
-
-<h4>Description</h4>
+<h3>(if-unit player op quantity unit)</h3>
Player has the quantity of unit-type. Which unit and how many
units must control the player for the action.
-<h4>Syntax</h4>
-
-<code>(if-unit player op quantity unit)</code>
<dl>
<dt>player</dt>
@@ -784,15 +689,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="if-unit-at"></a>
-<h3>if-unit-at</h3>
-
-<h4>Description</h4>
+<h3>(if-unit-at player op quantity unit location1 location2)</h3>
Player has the quantity of unit-type at a location.
-<h4>Syntax</h4>
-
-<code>(if-unit-at player op quantity unit location1 location2)</code>
<dl>
<dt>player</dt>
@@ -846,15 +746,10 @@
<a href="../../data/ccl/stratagus.ccl"> $LIBARYPATH/ccl/stratagus.ccl </a>
<a name="set-trigger-number!"></a>
-<h3>set-trigger-number!</h3>
-
-<h4>Description</h4>
+<h3>(set-trigger-number! number)</h3>
Set the current trigger number.
-<h4>Syntax</h4>
-
-<code>(set-trigger-number! number)</code>
<dl>
<dt>number</dt>
@@ -872,7 +767,7 @@
<h4>Not Used</h4>
<hr>
-Last changed: $Id: triggers.html,v 1.16 2003/07/03 17:40:05 ingo Exp $<br>
+Last changed: $Id: triggers.html,v 1.17 2003/09/02 19:23:08 martinxyz Exp $<br>
All trademarks and copyrights on this page are owned by their respective
owners.
<address>(c) 2002-2003 by <a href="http://stratagus.org";>
The Stratagus Project</a></address></body></html>
Index: stratagus/doc/ccl/unittype.html
diff -u stratagus/doc/ccl/unittype.html:1.22
stratagus/doc/ccl/unittype.html:1.23
--- stratagus/doc/ccl/unittype.html:1.22 Mon Sep 1 08:32:16 2003
+++ stratagus/doc/ccl/unittype.html Tue Sep 2 15:23:08 2003
@@ -65,15 +65,10 @@
<h2>Functions</h2>
<a name="define-animations"></a>
-<h3>define-animations</h3>
-
-<h4>Description</h4>
+<h3>(define-animations ident 'still script 'move script 'die script 'attack
script)</h3>
Define animations.
-<h4>Syntax</h4>
-
-<code>(define-animations ident 'still script 'move script 'die script 'attack
script)</code>
<dl>
<dt>ident</dt>
@@ -81,18 +76,22 @@
</dd>
<dt>script</dt>
<dd><pre>
- A script is a list of quad numbers.
- (#(Flags Pixel Sleep Frame) (#Flags Pixel Sleep Frame) ...)
- * Format of quad numbers:
- #(Flags Pixel Sleep Frame)
- o Flags are the sum of the following:
- 1 Restart - restart animation
- 2 Reset - animation could here be aborted (switch to another)
- 4 Sound - play a sound with the animation
- 8 Missile - fire a missile at this point
- o Pixel is the number of pixels to move (if this is a moving animation)
- o Sleep is the number of frames to wait for the next animation
- o Frame is increment to the frame of the image
+ A script has this format:
+ (#(Flags Pixel Sleep Frame)
+ #(Flags Pixel Sleep Frame)
+ ...)
+ o Flags are the sum of the following:
+ 1 Restart - restart animation
+ 2 Reset - animation could here be aborted (switch to another)
+ 4 Sound - play a sound with the animation
+ 8 Missile - fire a missile at this point
+ o Pixel is the number of pixels to move (if this is a moving animation)
+ the sum of a walking animation should be 16 (the tile size in pixels)
+ o Sleep is the number of frames to wait for the next animation
+ (this seems to be a way to control the unit speed)
+ FIXME: what is the speed tag from the unittype definition used for
then?
+ o Frame is the tile position on the image. Usually 5*tilerows.
+ The engine will add something between 0 and 4 for the heading.
</pre></dd>
</dl>
@@ -111,28 +110,13 @@
#( 0 0 10 0) #( 3 0 1 0))
'die '( ; #107
#( 0 0 3 45) #( 0 0 3 50) #( 0 0 100 55) #( 3 0 1 55)))
-
</pre>
-<p>Defines the animations for the footman.
-
-<h4>Used</h4>
-
-<a href="../../data/ccl/anim.ccl"> $LIBRARYPATH/ccl/anim.ccl </a>
-
<a name="define-unit-stats"></a>
-<h3>define-unit-stats</h3>
-
-<h4>Description</h4>
+<h3>(define-unit-stats ident player 'tag1 value1 'tag2 value2 ...)</h3>
Define unit stats.
-<h4>Syntax</h4>
-
-<code>(define-unit-stats ident player 'level level 'speed speed 'attack-range
arange
-'sight-range srange 'armor armor 'basic-damage bdamage 'piercing-damage
pdamage
-'hit-points hp 'costs costs)</code>
-
<dl>
<dt>ident</dt>
<dd>Ident of the unit.
@@ -140,6 +124,9 @@
<dt>player</dt>
<dd>Player number.
</dd>
+</dl>
+Possible tags:
+<dl>
<dt>level</dt>
<dd>.
</dd>
@@ -172,7 +159,11 @@
<h4>Example</h4>
<pre>
- (define-unit-stats)
+ ;; seems to be used only in savegames
+ (define-unit-stats 'unit-archer 14
+ 'level 1 'speed 10 'attack-range 4 'sight-range 5
+ 'armor 0 'basic-damage 3 'piercing-damage 6 'hit-points 40
+ 'costs '(time 70 gold 500 wood 50 oil 0 ore 0 stone 0 coal 0) )
</pre>
<p>.
@@ -180,34 +171,19 @@
<h4>Not Used</h4>
<a name="define-unit-type"></a>
-<h3>define-unit-type</h3>
+<h3>(define-unit-type ident 'tag1 value1 'tag2 value2 ...)</h3>
-<h4>Description</h4>
-
- Define the unit types in game it is based on the UDTA.<p>
-
- The default unit types are defined in <a href="../../data/ccl/units.ccl">
- $STRATAGUS_LIBRARY/data/units.ccl</a> and
- <a href="../../data/ccl/human/units.ccl">
- $STRATAGUS_LIBRARY/data/human/units.ccl</a> and
- <a href="../../data/ccl/orc/units.ccl">
- $STRATAGUS_LIBRARY/data/orc/units.ccl</a>. This could also be defined in
- own levels. <p>
-
-<h4>Syntax</h4>
-
-<code>(define-unit-type ident name graphics pixel_size animations icon
- speed overlay sight_range hitpoints magic costs improve_production
tile_size
- box_size attack_range computer_reaction_range human_reaction_range armor
- priorty damage piercing_damge weapon_upgradable armor_upgradeable
- decay annoy_factor points missle corpse type right_mouse can_target
- repair_range flags sounds attack_sound)</code>
+ Define the unit types in game it is based on the UDTA (FIXME:
+ what is UDTA?)<p>
<dl>
<dt>ident</dt>
<dd>The unit-type unique identifier. It is used to reference unit-types in
game. F.E: "unit-knight", "unit-gold-mine".
</dd>
+</dl>
+Possible tags:
+<dl>
<dt>name</dt>
<dd>The unit-type name shown in the game. F.E: "Knight", "Gold Mine".
If the name is too long, it is split at space.
@@ -373,7 +349,6 @@
"footman-dead" )
"footman-attack" )
</pre>
- Define the unit-type "unit-footman" as footman.<p>
<!--
@@ -408,15 +383,10 @@
-->
<a name="define-unittype-wc-names"></a>
-<h3>define-unittype-wc-names</h3>
-
-<h4>Description</h4>
+<h3>(define-unittype-wc-names footman grunt ...)</h3>
Define unit-type mapping from original number to internal symbol.
-<h4>Syntax</h4>
-
-<code>(define-unittype-wc-names footman grunt ...)</code>
<h4>Example</h4>
@@ -431,15 +401,10 @@
<a href="../../data/ccl/wc2.ccl"> $LIBRARYPATH/ccl/wc2.ccl </a>
<a name="get-unit-type-ident"></a>
-<h3>get-unit-type-ident</h3>
-
-<h4>Description</h4>
+<h3>(get-unit-type-ident unit-type)</h3>
Get the ident of the unit-type structure.
-<h4>Syntax</h4>
-
-<code>(get-unit-type-ident unit-type)</code>
<dl>
<dt>unit-type</dt>
@@ -458,15 +423,10 @@
<h4>Not Used</h4>
<a name="get-unit-type-property"></a>
-<h3>get-unit-type-property</h3>
-
-<h4>Description</h4>
+<h3>(get-unit-type-property unit-type)</h3>
Get the property of the unit-type structure.
-<h4>Syntax</h4>
-
-<code>(get-unit-type-property unit-type)</code>
<dl>
<dt>unit-type</dt>
@@ -485,15 +445,10 @@
<h4>Not Used</h4>
<a name="get-unit-type-name"></a>
-<h3>get-unit-type-name</h3>
-
-<h4>Description</h4>
+<h3>(get-unit-type-name unit-type)</h3>
Get the name of the unit-type structure.
-<h4>Syntax</h4>
-
-<code>(get-unit-type-name unit-type)</code>
<dl>
<dt>unit-type</dt>
@@ -512,15 +467,10 @@
<h4>Not Used</h4>
<a name="set-unit-type-name!"></a>
-<h3>set-unit-type-name!</h3>
-
-<h4>Description</h4>
+<h3>(set-unit-type-name! unit-type name)</h3>
Set the name of the unit-type structure.
-<h4>Syntax</h4>
-
-<code>(set-unit-type-name! unit-type name)</code>
<dl>
<dt>unit-type</dt>
@@ -542,15 +492,10 @@
<h4>Not Used</h4>
<a name="set-unit-type-property"></a>
-<h3>set-unit-type-property</h3>
-
-<h4>Description</h4>
+<h3>(set-unit-type-property unit-type property)</h3>
Set the property of the unit-type structure.
-<h4>Syntax</h4>
-
-<code>(set-unit-type-property unit-type property)</code>
<dl>
<dt>unit-type</dt>
@@ -572,15 +517,10 @@
<h4>Not Used</h4>
<a name="unit-type"></a>
-<h3>unit-type</h3>
-
-<h4>Description</h4>
+<h3>(unit-type ident)</h3>
Get unit-type structure.
-<h4>Syntax</h4>
-
-<code>(unit-type ident)</code>
<dl>
<dt>ident</dt>
@@ -601,15 +541,10 @@
<a href="../../data/ccl/ai.ccl"> $LIBRARYPATH/ccl/ai.ccl </a>
<a name="unit-type-array"></a>
-<h3>unit-type-array</h3>
-
-<h4>Description</h4>
+<h3>(unit-type-array)</h3>
Get all unit-type structures.
-<h4>Syntax</h4>
-
-<code>(unit-type-array)</code>
<h4>Example</h4>
@@ -622,7 +557,7 @@
<h4>Not Used</h4>
<hr>
-Last changed: $Id: unittype.html,v 1.22 2003/09/01 12:32:16 mr-russ Exp $<br>
+Last changed: $Id: unittype.html,v 1.23 2003/09/02 19:23:08 martinxyz Exp $<br>
All trademarks and copyrights on this page are owned by their respective
owners.
<address>(c) 2002-2003 by <a href="http://stratagus.org";>
The Stratagus Project</a></address></body></html>
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Stratagus-CVS] stratagus data/ccl/anim.ccl data/ccl/stratagus....,
Martin Renold <=