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

Major works on changing function names to lua names.

Browse source
This commit is contained in:
mr-russ 2004-05-19 09:59:48 +00:00
parent f7e44b4cca
commit 306507e550
6 changed files with 569 additions and 635 deletions

379
doc/scripts/config.html
View file

@ -47,72 +47,70 @@
<a href="game.html">NEXT</a>
<a href="ccl-index.html">Index</a>
<hr>
<a href="#a-star">AStar()</a>
<a href="#alpha-fog-of-war">AlphaFogOfWar()</a>
<a href="#decoration-on-top">DecorationOnTop()</a>
<a href="#health-sprite">HealthSprite()</a>
<a href="#mana-sprite">ManaSprite()</a>
<a href="#original-fog-of-war">OriginalFogOfWar()</a>
<a href="#reveal-map">RevealMap()</a>
<a href="#right-button-attacks">RightButtonAttacks()</a>
<a href="#right-button-moves">RightButtonMoves()</a>
<a href="#set-all-players-building-limit!">SetAllPlayersBuildingLimit()</a>
<a href="#set-all-players-unit-limit!">SetAllPlayersUnitLimit()</a>
<a href="#set-all-players-total-unit-limit!">SetAllPlayersTotalUnitLimit()</a>
<a href="#set-building-capture!">SetBuildingCapture()</a>
<a href="#set-click-missile!">SetClickMissile()</a>
<a href="#set-color-cycle-all!">SetColorCycleAll()</a>
<a href="#set-damage-missile!">SetDamageMissile()</a>
<a href="#set-double-click-delay!">SetDoubleClickDelay()</a>
<a href="#set-editor-select-icon!">SetEditorSelectIcon()</a>
<a href="#set-editor-units-icon!">SetEditorUnitsIcon()</a>
<a href="#set-fancy-buildings!">SetFancyBuildings()</a>
<a href="#set-fog-of-war!">SetFogOfWar()</a>
<a href="#set-fog-of-war-opacity">SetFogOfWarOpacity()</a>
<a href="#set-forest-regeneration!">SetForestRegeneration()</a>
<a href="#set-grab-mouse!">SetGrabMouse()</a>
<a href="#set-hold-click-delay!">SetHoldClickDelay()</a>
<a href="#set-key-scroll!">SetKeyScroll()</a>
<a href="#set-key-scroll-speed!">SetKeyScrollSpeed()</a>
<a href="#set-leave-stops!">SetLeaveStops()</a>
<a href="#set-max-selectable!">SetMaxSelectable()</a>
<a href="#set-menu-background!">SetMenuBackground()</a>
<a href="#set-minimap-terrain!">SetMinimapTerrain()</a>
<a href="#set-mouse-scroll!">SetMouseScroll()</a>
<a href="#set-mouse-scroll-speed!">SetMouseScrollSpeed()</a>
<a href="#set-reveal-attacker!">SetRevealAttacker()</a>
<a href="#set-selection-style!">SetSelectionStyle()</a>
<a href="#set-show-attack-range!">SetShowAttackRange()</a>
<a href="#set-show-command-key!">SetShowCommandKey()</a>
<a href="#set-show-orders!">SetShowOrders()</a>
<a href="#set-show-reaction-range!">SetShowReactionRange()</a>
<a href="#set-show-sight-range!">SetShowSightRange()</a>
<a href="#set-show-tips!">SetShowTips()</a>
<a href="#set-speed-build!">SetSpeedBuild()</a>
<a href="#set-speed-research!">SetSpeedResearch()</a>
<a href="#set-speed-resources-harvest!">SetSpeedResourcesHarvest()</a>
<a href="#set-speed-resources-return!">SetSpeedResourcesReturn()</a>
<a href="#set-speed-train!">SetSpeedTrain()</a>
<a href="#set-speed-upgrade!">SetSpeedUpgrade()</a>
<a href="#set-speeds!">SetSpeeds()</a>
<a href="#set-title-screens!">SetTitleScreens()</a>
<a href="#set-training-queue!">SetTrainingQueue()</a>
<a href="#set-xp-damage!">SetXpDamage()</a>
<a href="#set-use-hp-for-xp">SetUseHPForXp()</a>
<a href="#shadow-sprite">ShadowSprite()</a>
<a href="#show-energy-selected-only">ShowEnergySelectedOnly()</a>
<a href="#show-full">ShowFull()</a>
<a href="#show-health-bar">ShowHealthBar()</a>
<a href="#show-health-dot">ShowHealthDot()</a>
<a href="#show-health-horizontal">ShowHealthHorizontal()</a>
<a href="#show-health-vertical">ShowHealthVertical()</a>
<a href="#show-mana-bar">ShowManaBar()</a>
<a href="#show-mana-dot">ShowManaDot()</a>
<a href="#show-mana-horizontal">ShowManaHorizontal()</a>
<a href="#show-mana-vertical">ShowManaVertical()</a>
<a href="#show-no-full">ShowNoFull()</a>
<a href="#spell-sprite">SpellSprite()</a>
<a href="#set-group-keys">SetGroupKeys()</a>
<a href="#AStar">AStar</a>
<a href="#DecorationOnTop">DecorationOnTop</a>
<a href="#HealthSprite">HealthSprite</a>
<a href="#ManaSprite">ManaSprite</a>
<a href="#RevealMap">RevealMap</a>
<a href="#RightButtonAttacks">RightButtonAttacks</a>
<a href="#RightButtonMoves">RightButtonMoves</a>
<a href="#SetAllPlayersBuildingLimit">SetAllPlayersBuildingLimit</a>
<a href="#SetAllPlayersUnitLimit">SetAllPlayersUnitLimit</a>
<a href="#SetAllPlayersTotalUnitLimit">SetAllPlayersTotalUnitLimit</a>
<a href="#SetBuildingCapture">SetBuildingCapture</a>
<a href="#SetClickMissile">SetClickMissile</a>
<a href="#SetColorCycleAll">SetColorCycleAll</a>
<a href="#SetDamageMissile">SetDamageMissile</a>
<a href="#SetDoubleClickDelay">SetDoubleClickDelay</a>
<a href="#SetEditorSelectIcon">SetEditorSelectIcon</a>
<a href="#SetEditorUnitsIcon">SetEditorUnitsIcon</a>
<a href="#SetFancyBuildings">SetFancyBuildings</a>
<a href="#SetFogOfWar">SetFogOfWar</a>
<a href="#SetFogOfWarOpacity">SetFogOfWarOpacity</a>
<a href="#SetForestRegeneration">SetForestRegeneration</a>
<a href="#SetGrabMouse">SetGrabMouse</a>
<a href="#SetHoldClickDelay">SetHoldClickDelay</a>
<a href="#SetKeyScroll">SetKeyScroll</a>
<a href="#SetKeyScrollSpeed">SetKeyScrollSpeed</a>
<a href="#SetLeaveStops">SetLeaveStops</a>
<a href="#SetMaxSelectable">SetMaxSelectable</a>
<a href="#SetMenuBackground">SetMenuBackground</a>
<a href="#SetMinimapTerrain">SetMinimapTerrain</a>
<a href="#SetMouseScroll">SetMouseScroll</a>
<a href="#SetMouseScrollSpeed">SetMouseScrollSpeed</a>
<a href="#SetRevealAttacker">SetRevealAttacker</a>
<a href="#SetSelectionStyle">SetSelectionStyle</a>
<a href="#SetShowAttackRange">SetShowAttackRange</a>
<a href="#SetShowCommandKey">SetShowCommandKey</a>
<a href="#SetShowOrders">SetShowOrders</a>
<a href="#SetShowReactionRange">SetShowReactionRange</a>
<a href="#SetShowSightRange">SetShowSightRange</a>
<a href="#SetShowTips">SetShowTips</a>
<a href="#SetSpeedBuild">SetSpeedBuild</a>
<a href="#SetSpeedResearch">SetSpeedResearch</a>
<a href="#SetSpeedResourcesHarvest">SetSpeedResourcesHarvest</a>
<a href="#SetSpeedResourcesReturn">SetSpeedResourcesReturn</a>
<a href="#SetSpeedTrain">SetSpeedTrain</a>
<a href="#SetSpeedUpgrade">SetSpeedUpgrade</a>
<a href="#SetSpeeds">SetSpeeds</a>
<a href="#SetTitleScreens">SetTitleScreens</a>
<a href="#SetTrainingQueue">SetTrainingQueue</a>
<a href="#SetXpDamage">SetXpDamage</a>
<a href="#SetUseHPForXp">SetUseHPForXp</a>
<a href="#ShadowSprite">ShadowSprite</a>
<a href="#ShowEnergySelectedOnly">ShowEnergySelectedOnly</a>
<a href="#ShowFull">ShowFull</a>
<a href="#ShowHealthBar">ShowHealthBar</a>
<a href="#ShowHealthDot">ShowHealthDot</a>
<a href="#ShowHealthHorizontal">ShowHealthHorizontal</a>
<a href="#ShowHealthVertical">ShowHealthVertical</a>
<a href="#ShowManaBar">ShowManaBar</a>
<a href="#ShowManaDot">ShowManaDot</a>
<a href="#ShowManaHorizontal">ShowManaHorizontal</a>
<a href="#ShowManaVertical">ShowManaVertical</a>
<a href="#ShowNoFull">ShowNoFull</a>
<a href="#SpellSprite">SpellSprite</a>
<a href="#SetGroupKeys">SetGroupKeys</a>
<hr>
<h2>Intro - Introduction to config functions and variables</h2>
@ -120,7 +118,7 @@
General configurations.
<h2>Functions</h2>
<a name="a-star"></a>
<a name="AStar"></a>
<h3>AStar(tag, value, ...)</h3>
Sets variables about the pathfinder.
@ -154,17 +152,12 @@ The Cost of a move it 1 if moving straight, or 2 if moving diagonal.
AStar("fixed-unit-cost", 1000, "moving-unit-cost", 20, "know-unseen-terrain", "unseen-terrain-cost", 2)
</pre>
<a name="alpha-fog-of-war"></a>
<h3>AlphaFogOfWar()</h3>
Use alpha style fog of war.
<a name="decoration-on-top"></a>
<a name="DecorationOnTop"></a>
<h3>DecorationOnTop()</h3>
Show bars and dots always on top. (Planned feature)
<a name="health-sprite"></a>
<a name="HealthSprite"></a>
<h3>HealthSprite(file, hotx, hoty, width, height)</h3>
Define health-sprite.
@ -187,7 +180,7 @@ Define health-sprite.
HealthSprite("graphics/ui/health2.png", 0, -4, 31, 4)
</pre>
<a name="mana-sprite"></a>
<a name="ManaSprite"></a>
<h3>ManaSprite(file, hotx, hoty, width, height)</h3>
define mana-sprite.
@ -210,39 +203,33 @@ define mana-sprite.
ManaSprite("graphics/ui/mana2.png", 0, -1, 31, 4)
</pre>
<a name="original-fog-of-war"></a>
<h3>OriginalFogOfWar()</h3>
Use original style fog of war.
<a name="reveal-map"></a>
<a name="RevealMap"></a>
<h3>RevealMap()</h3>
Reveal the entire map.
<a name="right-button-attacks"></a>
<a name="RightButtonAttacks"></a>
<h3>RightButtonAttacks()</h3>
If you prefer fighters are attacking by right clicking empty space.
FIXME: this option will be renamed
<a name="right-button-moves"></a>
<a name="RightButtonMoves"></a>
<h3>RightButtonMoves()</h3>
If you prefer fighters are moving by right clicking empty space.
FIXME: this option will be renamed
<a name="set-all-players-building-limit!"></a>
<a name="SetAllPlayersBuildingLimit"></a>
<h3>SetAllPlayersBuildingLimit(limit)</h3>
.
<dl>
<dt>limit</dt>
<dd>.</dd>
<dd>The maximum number of buildings a player can have.</dd>
</dl>
<h4>Example</h4>
@ -250,14 +237,14 @@ FIXME: this option will be renamed
SetAllPlayersBuildingLimit(200)
</pre>
<a name="set-all-players-unit-limit!"></a>
<a name="SetAllPlayersUnitLimit"></a>
<h3>SetAllPlayersUnitLimit(limit)</h3>
Sets the number of non-building type units a player can have.
<dl>
<dt>limit</dt>
<dd>.</dd>
<dd>Number of non-building unit the player can have</dd>
</dl>
<h4>Example</h4>
@ -265,15 +252,15 @@ Sets the number of non-building type units a player can have.
SetAllPlayersUnitLimit(200)
</pre>
<a name="set-all-players-total-unit-limit!"></a>
<a name="SetAllPlayersTotalUnitLimit"></a>
<h3>SetAllPlayersTotalUnitLimit(limit)</h3>
.
Sets the total number of units a player may have, building or non-building.
<dl>
<dt>limit</dt>
<dd>.</dd>
<dd>The number of units to set the limit to.</dd>
</dl>
<h4>Example</h4>
@ -281,12 +268,22 @@ SetAllPlayersUnitLimit(200)
SetAllPlayersTotalUnitLimit(400)
</pre>
<a name="set-building-capture!"></a>
<a name="SetBuildingCapture"></a>
<h3>SetBuildingCapture(boolean)</h3>
Enable or disable building capture.
<a name="set-click-missile!"></a>
<dl>
<dt>boolean</dt>
<dd>true or false, depending on if you want building capture enabled.</dd>
</dl>
<h4>Example</h4>
<pre>
SetBuildingCapture(true)
</pre>
<a name="SetClickMissile"></a>
<h3>SetClickMissile("missile-type")</h3>
Sets the missile to use for displaying when a player clicks on a location on the map.
@ -298,15 +295,13 @@ Sets the missile to use for displaying when a player clicks on a location on the
<h4>Example</h4>
<pre>
SetClickMissile("missile-green-cross")
SetClickMissile("missile-green-cross")
</pre>
<a name="set-color-cycle-all!"></a>
<a name="SetColorCycleAll"></a>
<h3>SetColorCycleAll(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.
Change how the color cycling is working. This is used to make the water moving.
<dl>
<dt>flag</dt>
@ -321,7 +316,7 @@ or the circle in the dark portal rotating.
SetColorCycleAll(true)
</pre>
<a name="set-damage-missile!"></a>
<a name="SetDamageMissile"></a>
<h3>SetDamageMissile("missile-type")</h3>
Sets the missile to use for displaying the damage done to units.
@ -333,13 +328,13 @@ Sets the missile to use for displaying the damage done to units.
<h4>Example</h4>
<pre>
SetDamageMissile("missile-hit")
SetDamageMissile("missile-hit")
</pre>
<a name="set-double-click-delay!"></a>
<a name="SetDoubleClickDelay"></a>
<h3>SetDoubleClickDelay(delay)</h3>
.
Set the delay of double clicking the mouse.
<dl>
<dt>delay</dt>
@ -351,11 +346,10 @@ SetDamageMissile("missile-hit")
SetDoubleClickDelay(300)
</pre>
<a name="set-editor-select-icon!"></a>
<a name="SetEditorSelectIcon"></a>
<h3>SetEditorSelectIcon("icon-name")</h3>
.
FIXME
Set the icon that is used in the editor to indicate selection.
<dl>
<dt>"icon-name"</dt>
@ -364,15 +358,14 @@ FIXME
<h4>Example</h4>
<pre>
-- Use "icon-human-patrol-land" for the editor's select icon.
SetEditorSelectIcon("icon-human-patrol-land")
-- Use "icon-human-patrol-land" for the editor's select icon.
SetEditorSelectIcon("icon-human-patrol-land")
</pre>
<a name="set-editor-units-icon!"></a>
<a name="SetEditorUnitsIcon"></a>
<h3>SetEditorUnitsIcon("icon-name")</h3>
.
FIXME
Set the icon that is used in the editory for unit selection.
<dl>
<dt>icon</dt>
@ -381,66 +374,66 @@ FIXME
<h4>Example</h4>
<pre>
-- Use "icon-footman" for the editor's units icon.
SetEditorUnitsIcon("unit-footman")
-- Use "icon-footman" for the editor's units icon.
SetEditorUnitsIcon("unit-footman")
</pre>
<a name="set-fancy-buildings!"></a>
<a name="SetFancyBuildings"></a>
<h3>SetFancyBuildings(boolean)</h3>
if true, enable fancy building (random mirroring buildings).
<a name="set-fog-of-war!"></a>
<a name="SetFogOfWar"></a>
<h3>SetFogOfWar(boolean)</h3>
If true, enable fog of war.
<a name="set-fog-of-war-opacity"></a>
<a name="SetFogOfWarOpacity"></a>
<h3>SetFogOfWarOpacity(number)</h3>
FIXME.
Set the level of Opaqueness/transparency of the fog of war (0-255),
128 is optimized, all other values will be much slower to render.
<h4>Example</h4>
<pre>
SetFogOfWarOpacity(128)
SetFogOfWarOpacity(128)
</pre>
<a name="set-forest-regeneration!"></a>
<a name="SetForestRegeneration"></a>
<h3>SetForestRegeneration(number)</h3>
Set forest regeneration speed. (n * seconds, 0 = disabled)
-- (Auf allgemeinen Wunsch eines einzelnen Herrn :)
<a name="set-grab-mouse!"></a>
<a name="SetGrabMouse"></a>
<h3>SetGrabMouse(boolean)</h3>
Enable/disable grabbing the mouse.
<a name="set-hold-click-delay!"></a>
<a name="SetHoldClickDelay"></a>
<h3>SetHoldClickDelay(delay)</h3>
for the wanted hold-click delay (in ms)..
<h4>Example</h4>
<pre>
SetHoldClickDelay(1000)
SetHoldClickDelay(1000)
</pre>
<a name="set-key-scroll!"></a>
<a name="SetKeyScroll"></a>
<h3>SetKeyScroll(boolean)</h3>
enable/disable keyboard scrolling.
<a name="set-key-scroll-speed!"></a>
<a name="SetKeyScrollSpeed"></a>
<h3>SetKeyScrollSpeed(number)</h3>
Set keyboard scroll speed in frames (1 = each frame,2 each second,...)
<h4>Example</h4>
<pre>
SetKeyScrollSpeed(1)
SetKeyScrollSpeed(1)
</pre>
<a name="set-leave-stops!"></a>
<a name="SetLeaveStops"></a>
<h3>SetLeaveStops(boolean)</h3>
Enable/disable stopping scrolling on mouse leave.
@ -450,7 +443,7 @@ Enable/disable stopping scrolling on mouse leave.
SetLeaveStops(true)
</pre>
<a name="set-max-selectable!"></a>
<a name="SetMaxSelectable"></a>
<h3>SetMaxSelectable(number)</h3>
Set the maximum number of selectable units. (must be positive value)
@ -460,7 +453,7 @@ Set the maximum number of selectable units. (must be positive value)
SetMaxSelectable(18)
</pre>
<a name="set-menu-background!"></a>
<a name="SetMenuBackground"></a>
<h3>SetMenuBackground("image-file")</h3>
Set the default menu background.
@ -468,26 +461,26 @@ Set the default menu background.
<dl>
<dt>"image-file"</dt>
<dd>Image to be displayed as menu background, this is the second screen
displayed. The image should be a png file with 640x480 8-bit indexed colormap.
displayed. The image will be scaled to the screen size.
</dd>
</dl>
<h4>Example</h4>
<pre>
SetMenuBackground("graphics/ui/Menu_background_without_title.png")
SetMenuBackground("graphics/ui/Menu_background_without_title.png")
</pre>
<a name="set-minimap-terrain!"></a>
<a name="SetMinimapTerrain"></a>
<h3>SetMinimapTerrain(boolean)</h3>
for minimap with/without terrain.
<a name="set-mouse-scroll!"></a>
<a name="SetMouseScroll"></a>
<h3>SetMouseScroll(boolean)</h3>
enable/disable mouse scrolling.
<a name="set-mouse-scroll-speed!"></a>
<a name="SetMouseScrollSpeed"></a>
<h3>SetMouseScrollSpeed(number)</h3>
Set mouse scroll speed in frames (1=each frame,2 each second,...)
@ -495,18 +488,19 @@ This is when the mouse cursor hits the border.
<h4>Example</h4>
<pre>
SetMouseScrollSpeed(1)
SetMouseScrollSpeed(1)
</pre>
<a name="set-reveal-attacker!"></a>
<a name="SetRevealAttacker"></a>
<h3>SetRevealAttacker(boolean)</h3>
Sets where unit will respond the the attacking unit or not. If set to true,
Sets if a unit will respond to the attacking unit or not. If set to true,
they will respond whether they can see the unit or not. If set to false,
they will only response if the attacker is within their reaction range.
<a name="set-selection-style!"></a>
<a name="SetSelectionStyle"></a>
<h3>SetSelectionStyle(tag)</h3>
Set selection style, show what units the user had selected.
<dl>
@ -524,20 +518,20 @@ Set selection style, show what units the user had selected.
<h4>Example</h4>
<pre>
SetSelectionStyle("corners")
SetSelectionStyle("corners")
</pre>
<a name="set-show-attack-range!"></a>
<a name="SetShowAttackRange"></a>
<h3>SetShowAttackRange(boolean)</h3>
Enable/disable display of attack range of the selected unit on map.
<a name="set-show-command-key!"></a>
<a name="SetShowCommandKey"></a>
<h3>SetShowCommandKey(boolean)</h3>
enable/disable the display of the command keys in buttons.
<a name="set-show-orders!"></a>
<a name="SetShowOrders"></a>
<h3>SetShowOrders(boolean or number)</h3>
Enable/disable display of the orders of the selected unit on map.
@ -554,95 +548,94 @@ Enable/disable display of the orders of the selected unit on map.
<h4>Example</h4>
<pre>
-- show orders for 2 seconds
SetShowOrders(2)
-- show orders for 2 seconds
SetShowOrders(2)
</pre>
<a name="set-show-reaction-range!"></a>
<a name="SetShowReactionRange"></a>
<h3>SetShowReactionRange(boolean)</h3>
Enable/disable display of reaction range of the selected unit on map.
<a name="set-show-sight-range!"></a>
<a name="SetShowSightRange"></a>
<h3>SetShowSightRange(tag)</h3>
How the sight range of the selected unit is shown on map.
<dl>
<dt>tag</dt>
<dd>Possible values:
<pre>
false None
"rectangle" Alpha rectangle around unit
"circle" Alpha circle around unit
true Rectangle around unit
</pre>
</dd>
<dt>false</dt>
<dd>None</dd>
<dt>"rectangle"</dt>
<dd>Alpha rectangle around unit</dd>
<dt>"circle"</dt>
<dd>Alpha circle around unit</dd>
<dt>true</dt>
<dd>Rectangle around unit</dd>
</dl>
<a name="set-show-tips!"></a>
<a name="SetShowTips"></a>
<h3>SetShowTips(boolean)</h3>
enable/disable show tips at the start of a level
<a name="set-speed-build!"></a>
<a name="SetSpeedBuild"></a>
<h3>SetSpeedBuild(number)</h3>
Decrease the time to build a unit by this factor.
<a name="set-speed-research!"></a>
<a name="SetSpeedResearch"></a>
<h3>SetSpeedResearch(number)</h3>
Decrease the time to research by this factor.
<a name="set-speed-resources-harvest!"></a>
<a name="SetSpeedResourcesHarvest"></a>
<h3>SetSpeedResourcesHarvest("resource-name", number)</h3>
Set the harvesting speed of the resource.
<h4>Example</h4>
<pre>
-- Speeds up gold mining time by a factor of 10.
SetSpeedResourcesHarvest("gold", 10)
-- Speeds up gold mining time by a factor of 10.
SetSpeedResourcesHarvest("gold", 10)
</pre>
<a name="set-speed-resources-return!"></a>
<a name="SetSpeedResourcesReturn"></a>
<h3>SetSpeedResourcesReturn("resource-name", number)</h3>
Set the returning speed of the resource.
<h4>Example</h4>
<pre>
-- Speeds up the time spent returning gold by a factor of 10.
SetSpeedResourcesReturn("gold", 10)
-- Speeds up the time spent returning gold by a factor of 10.
SetSpeedResourcesReturn("gold", 10)
</pre>
<a name="set-speed-train!"></a>
<a name="SetSpeedTrain"></a>
<h3>SetSpeedTrain(number)</h3>
Decrease the time to train a unit by this factor.
<a name="set-speed-upgrade!"></a>
<a name="SetSpeedUpgrade"></a>
<h3>SetSpeedUpgrade(number)</h3>
Decrease the time to upgrade a unit by this factor.
<a name="set-speeds!"></a>
<a name="SetSpeeds"></a>
<h3>SetSpeeds(number)</h3>
Set all speeds.
This is equivalent to
<pre>
SetSpeedResourcesHarvest("all-resource", number)
SetSpeedResourcesReturn("all-resource", number)
SetSpeedBuild(number)
SetSpeedTrain(number)
SetSpeedUpgrade(number)
SetSpeedResearch(number)
SetSpeedResourcesHarvest("all-resource", number)
SetSpeedResourcesReturn("all-resource", number)
SetSpeedBuild(number)
SetSpeedTrain(number)
SetSpeedUpgrade(number)
SetSpeedResearch(number)
</pre>
<a name="set-title-screens!"></a>
<a name="SetTitleScreens"></a>
<h3>SetTitleScreens({tag = value, ...}, ...)</h3>
Change the default title screens.<br>
@ -680,34 +673,34 @@ previously playing music.
<h4>Example</h4>
<pre>
-- This is the default title displayed.
SetTitleScreens(
-- This is the default title displayed.
SetTitleScreens(
{Image = "video/int_logo_stratagus.avi", Music = "video/int_logo_stratagus.ogg",
Label = {{Text = "~white~Copyright © 1998-2003 The Stratagus Project. All rights reserved.",
Pos = {0, 45}, Flags = {"center"}}} },
{Image = "video/int_logo_bos.avi", Music = "video/int_logo_bos.ogg"})
</pre>
<a name="set-training-queue!"></a>
<a name="SetTrainingQueue"></a>
<h3>SetTrainingQueue(boolean)</h3>
enable/disable the training queues.
(ability to train several units in a row)
<a name="set-xp-damage!"></a>
<a name="SetXPDamage"></a>
<h3>SetXPDamage(boolean)</h3>
enable/disable XP to add more damage to attacks.
FIXME : damage calculation.
<a name="set-use-hp-for-xp!"></a>
<a name="SetUseHPForXP"></a>
<h3>SetUseHPForXp(boolean)</h3>
How the Xp is compute :
if it is set to true then unit gains Xp equal to damage dealt to enemy unit
else unit gains the max HP of the killed enemy unit.
<a name="shadow-sprite"></a>
<a name="ShadowSprite"></a>
<h3>ShadowSprite("file", hotx, hoty, width, height)</h3>
Define shadow-sprite.
@ -731,62 +724,62 @@ Define shadow-sprite.
ShadowSprite("graphics/missiles/unit_shadow.png",3, 42, 32, 32)
</pre>
<a name="show-energy-selected-only"></a>
<a name="ShowEnergySelectedOnly"></a>
<h3>ShowEnergySelectedOnly()</h3>
FIXME.
<a name="show-full"></a>
<a name="ShowFull"></a>
<h3>ShowFull()</h3>
Use to show always bars or dots. No parameters.
<a name="show-health-bar"></a>
<a name="ShowHealthBar"></a>
<h3>ShowHealthBar()</h3>
Adds a health bar to the left of the unit. No parameters.
<a name="show-health-dot"></a>
<a name="ShowHealthDot"></a>
<h3>ShowHealthDot()</h3>
Adds a health dot to the left of the unit. No parameters.
<a name="show-health-horizontal"></a>
<a name="ShowHealthHorizontal"></a>
<h3>ShowHealthHorizontal()</h3>
Show health bars horizontal. No parameters.
<a name="show-health-vertical"></a>
<a name="ShowHealthVertical"></a>
<h3>ShowHealthVertical()</h3>
Show health bars vertical. No parameters.
<a name="show-mana-bar"></a>
<a name="ShowManaBar"></a>
<h3>ShowManaBar()</h3>
Show a mana bar to the right of the unit. No parameters.
<a name="show-mana-dot"></a>
<a name="ShowManaDot"></a>
<h3>ShowManaDot()</h3>
Show a mana dot to the right of the unit. No parameters.
<a name="show-mana-horizontal"></a>
<a name="ShowManaHorizontal"></a>
<h3>ShowManaHorizontal()</h3>
Show mana bars horizontal. No parameters.
<a name="show-mana-vertical"></a>
<a name="ShowManaVertical"></a>
<h3>ShowManaVertical()</h3>
Show mana bars vertical. No parameters.
<a name="show-no-full"></a>
<a name="ShowNoFull"></a>
<h3>ShowNoFull()</h3>
Use to get no full bars or dots. No parameters.
<a name="spell-sprite"></a>
<a name="SpellSprite"></a>
<h3>SpellSprite("file", hotx, hoty, width, height)</h3>
Define spell-sprite.
@ -812,11 +805,11 @@ SpellSprite("graphics/ui/bloodlust,haste,slow,invisible,shield.png",
1, 1, 16, 16)
</pre>
<a name="set-group-keys"></a>
<a name="SetGroupKeys"></a>
<h3>SetGroupKeys("0123456789~")</h3>
Define the key to use for group on non-us keyborads. It should be placed in
preferences1.ccl, with the key to use for group 0, 1, 2, ... 9, and the key
preferences1.lua, with the key to use for group 0, 1, 2, ... 9, and the key
to unselect all groups ( on the left of the 1 key )
<dl>

10
doc/scripts/icon.html
View file

@ -47,15 +47,15 @@
<a href="magic.html">NEXT</a>
<a href="ccl-index.html">Index</a>
<hr>
<a href="#define-icon">DefineIcon</a>
<a href="#define-icon-alias">DefineIconAlias</a>
<a href="pud.html#define-icon-wc-names">DefineIconWcNames</a>
<a href="#DefineIcon">DefineIcon</a>
<a href="#DefineIconAlias">DefineIconAlias</a>
<a href="pud.html#DefineIconWcNames">DefineIconWcNames</a>
<hr>
<h2>Intro - Introduction to icon functions and variables</h2>
Everything around the C icon structure.
<h2>Functions</h2>
<a name="define-icon"></a>
<a name="DefineIcon"></a>
<h3>DefineIcon({flag = value, ...})</h3>
Define an icon for the engine.<p>
@ -90,7 +90,7 @@ Define the peasant icon referenced with icon-peasant for the summer tileset.
It is a normal static icon with a sizeof 46x38 pixel. The graphic is loaded
from the file "tilesets/summer/icons.png" and is the first icon in this file.
<a name="define-icon-alias"></a>
<a name="DefineIconAlias"></a>
<h3>DefineIconAlias("alias", icon-name)</h3>
Define an icon alias for an icon.<p>

616
doc/scripts/index.html
View file

@ -62,33 +62,219 @@
<dl>
<!-- This part is autogenerated. Run ./makeindex.py to regenerate. -->
<!-- START SCRIPT -->
<dt><a href="config.html#a-star">Astar</a></dt>
<dt><a href="config.html#AStar">AStar</a></dt>
<dd></dd>
<dt><a href="triggers.html#action-defeat">ActionDefeat</a></dt>
<dt><a href="config.html#DecorationOnTop">DecorationOnTop</a></dt>
<dd></dd>
<dt><a href="pud.html#DefineAiWcNames">DefineAiWcNames</a></dt>
<dd></dd>
<dt><a href="pud.html#DefineConstructionWcNames">DefineConstructionWcNames</a></dt>
<dd></dd>
<dt><a href="sound.html#DefineGameSounds">DefineGameSounds</a></dt>
<dd></dd>
<dt><a href="icon.html#DefineIcon">DefineIcon</a></dt>
<dd></dd>
<dt><a href="icon.html#DefineIconAlias">DefineIconAlias</a></dt>
<dd></dd>
<dt><a href="pud.html#DefineIconWcNames">DefineIconWcNames</a></dt>
<dd></dd>
<dt><a href="magic.html#DefineMissileType">DefineMissileType</a></dt>
<dd></dd>
<dt><a href="pud.html#DefineMissileTypeWcNames">DefineMissileTypeWcNames</a></dt>
<dd></dd>
<dt><a href="magic.html#DefineSpell">DefineSpell</a></dt>
<dd></dd>
<dt><a href="pud.html#DefineTilesetWcNames">DefineTilesetWcNames</a></dt>
<dd></dd>
<dt><a href="pud.html#DefineUnitTypeWcNames">DefineUnitTypeWcNames</a></dt>
<dd></dd>
<dt><a href="pud.html#DefineUpgradeWcNames">DefineUpgradeWcNames</a></dt>
<dd></dd>
<dt><a href="sound.html#DisplaySounds">DisplaySounds</a></dt>
<dd></dd>
<dt><a href="config.html#HealthSprite">HealthSprite</a></dt>
<dd></dd>
<dt><a href="sound.html#MakeSound">MakeSound</a></dt>
<dd></dd>
<dt><a href="sound.html#MakeSoundGroup">MakeSoundGroup</a></dt>
<dd></dd>
<dt><a href="config.html#ManaSprite">ManaSprite</a></dt>
<dd></dd>
<dt><a href="sound.html#MapSound">MapSound</a></dt>
<dd></dd>
<dt><a href="sound.html#PlayFile">PlayFile</a></dt>
<dd></dd>
<dt><a href="sound.html#PlayMusic">PlayMusic</a></dt>
<dd></dd>
<dt><a href="sound.html#PlaySound">PlaySound</a></dt>
<dd></dd>
<dt><a href="config.html#RevealMap">RevealMap</a></dt>
<dd></dd>
<dt><a href="config.html#RightButtonAttacks">RightButtonAttacks</a></dt>
<dd></dd>
<dt><a href="config.html#RightButtonMoves">RightButtonMoves</a></dt>
<dd></dd>
<dt><a href="config.html#SetAllPlayersBuildingLimit">SetAllPlayersBuildingLimit</a></dt>
<dd></dd>
<dt><a href="config.html#SetAllPlayersTotalUnitLimit">SetAllPlayersTotalUnitLimit</a></dt>
<dd></dd>
<dt><a href="config.html#SetAllPlayersUnitLimit">SetAllPlayersUnitLimit</a></dt>
<dd></dd>
<dt><a href="config.html#SetBuildingCapture">SetBuildingCapture</a></dt>
<dd></dd>
<dt><a href="sound.html#SetCdMode">SetCdMode</a></dt>
<dd></dd>
<dt><a href="config.html#SetClickMissile">SetClickMissile</a></dt>
<dd></dd>
<dt><a href="config.html#SetColorCycleAll">SetColorCycleAll</a></dt>
<dd></dd>
<dt><a href="config.html#SetDamageMissile">SetDamageMissile</a></dt>
<dd></dd>
<dt><a href="config.html#SetDoubleClickDelay">SetDoubleClickDelay</a></dt>
<dd></dd>
<dt><a href="config.html#SetEditorSelectIcon">SetEditorSelectIcon</a></dt>
<dd></dd>
<dt><a href="config.html#SetEditorUnitsIcon">SetEditorUnitsIcon</a></dt>
<dd></dd>
<dt><a href="config.html#SetFancyBuildings">SetFancyBuildings</a></dt>
<dd></dd>
<dt><a href="config.html#SetFogOfWar">SetFogOfWar</a></dt>
<dd></dd>
<dt><a href="config.html#SetFogOfWarOpacity">SetFogOfWarOpacity</a></dt>
<dd></dd>
<dt><a href="config.html#SetForestRegeneration">SetForestRegeneration</a></dt>
<dd></dd>
<dt><a href="sound.html#SetGlobalSoundRange">SetGlobalSoundRange</a></dt>
<dd></dd>
<dt><a href="config.html#SetGrabMouse">SetGrabMouse</a></dt>
<dd></dd>
<dt><a href="config.html#SetGroupKeys">SetGroupKeys</a></dt>
<dd></dd>
<dt><a href="config.html#SetHoldClickDelay">SetHoldClickDelay</a></dt>
<dd></dd>
<dt><a href="config.html#SetKeyScroll">SetKeyScroll</a></dt>
<dd></dd>
<dt><a href="config.html#SetKeyScrollSpeed">SetKeyScrollSpeed</a></dt>
<dd></dd>
<dt><a href="config.html#SetLeaveStops">SetLeaveStops</a></dt>
<dd></dd>
<dt><a href="config.html#SetMaxSelectable">SetMaxSelectable</a></dt>
<dd></dd>
<dt><a href="config.html#SetMenuBackground">SetMenuBackground</a></dt>
<dd></dd>
<dt><a href="sound.html#SetMenuMusic">SetMenuMusic</a></dt>
<dd></dd>
<dt><a href="config.html#SetMinimapTerrain">SetMinimapTerrain</a></dt>
<dd></dd>
<dt><a href="config.html#SetMouseScroll">SetMouseScroll</a></dt>
<dd></dd>
<dt><a href="config.html#SetMouseScrollSpeed">SetMouseScrollSpeed</a></dt>
<dd></dd>
<dt><a href="sound.html#SetMusicVolume">SetMusicVolume</a></dt>
<dd></dd>
<dt><a href="config.html#SetRevealAttacker">SetRevealAttacker</a></dt>
<dd></dd>
<dt><a href="config.html#SetSelectionStyle">SetSelectionStyle</a></dt>
<dd></dd>
<dt><a href="config.html#SetShowAttackRange">SetShowAttackRange</a></dt>
<dd></dd>
<dt><a href="config.html#SetShowCommandKey">SetShowCommandKey</a></dt>
<dd></dd>
<dt><a href="config.html#SetShowOrders">SetShowOrders</a></dt>
<dd></dd>
<dt><a href="config.html#SetShowReactionRange">SetShowReactionRange</a></dt>
<dd></dd>
<dt><a href="config.html#SetShowSightRange">SetShowSightRange</a></dt>
<dd></dd>
<dt><a href="config.html#SetShowTips">SetShowTips</a></dt>
<dd></dd>
<dt><a href="sound.html#SetSoundRange">SetSoundRange</a></dt>
<dd></dd>
<dt><a href="sound.html#SetSoundVolume">SetSoundVolume</a></dt>
<dd></dd>
<dt><a href="config.html#SetSpeedBuild">SetSpeedBuild</a></dt>
<dd></dd>
<dt><a href="config.html#SetSpeedResearch">SetSpeedResearch</a></dt>
<dd></dd>
<dt><a href="config.html#SetSpeedResourcesHarvest">SetSpeedResourcesHarvest</a></dt>
<dd></dd>
<dt><a href="config.html#SetSpeedResourcesReturn">SetSpeedResourcesReturn</a></dt>
<dd></dd>
<dt><a href="config.html#SetSpeedTrain">SetSpeedTrain</a></dt>
<dd></dd>
<dt><a href="config.html#SetSpeedUpgrade">SetSpeedUpgrade</a></dt>
<dd></dd>
<dt><a href="config.html#SetSpeeds">SetSpeeds</a></dt>
<dd></dd>
<dt><a href="config.html#SetTitleScreens">SetTitleScreens</a></dt>
<dd></dd>
<dt><a href="config.html#SetTrainingQueue">SetTrainingQueue</a></dt>
<dd></dd>
<dt><a href="config.html#SetUseHPForXP">SetUseHPForXP</a></dt>
<dd></dd>
<dt><a href="config.html#SetXPDamage">SetXPDamage</a></dt>
<dd></dd>
<dt><a href="config.html#ShadowSprite">ShadowSprite</a></dt>
<dd></dd>
<dt><a href="config.html#ShowEnergySelectedOnly">ShowEnergySelectedOnly</a></dt>
<dd></dd>
<dt><a href="config.html#ShowFull">ShowFull</a></dt>
<dd></dd>
<dt><a href="config.html#ShowHealthBar">ShowHealthBar</a></dt>
<dd></dd>
<dt><a href="config.html#ShowHealthDot">ShowHealthDot</a></dt>
<dd></dd>
<dt><a href="config.html#ShowHealthHorizontal">ShowHealthHorizontal</a></dt>
<dd></dd>
<dt><a href="config.html#ShowHealthVertical">ShowHealthVertical</a></dt>
<dd></dd>
<dt><a href="config.html#ShowManaBar">ShowManaBar</a></dt>
<dd></dd>
<dt><a href="config.html#ShowManaDot">ShowManaDot</a></dt>
<dd></dd>
<dt><a href="config.html#ShowManaHorizontal">ShowManaHorizontal</a></dt>
<dd></dd>
<dt><a href="config.html#ShowManaVertical">ShowManaVertical</a></dt>
<dd></dd>
<dt><a href="config.html#ShowNoFull">ShowNoFull</a></dt>
<dd></dd>
<dt><a href="sound.html#SoundForName">SoundForName</a></dt>
<dd></dd>
<dt><a href="sound.html#SoundOff">SoundOff</a></dt>
<dd></dd>
<dt><a href="sound.html#SoundOn">SoundOn</a></dt>
<dd></dd>
<dt><a href="sound.html#SoundThread">SoundThread</a></dt>
<dd></dd>
<dt><a href="config.html#SpellSprite">SpellSprite</a></dt>
<dd></dd>
<dt><a href="sound.html#StopMusic">StopMusic</a></dt>
<dd></dd>
<dt><a href="triggers.html#action-defeat">action-defeat</a></dt>
<dd></dd>
<dt><a href="triggers.html#action-draw">action-draw</a></dt>
<dd></dd>
<dt><a href="triggers.html#action-set-switch">ActionSetSwitch</a></dt>
<dt><a href="triggers.html#action-set-switch">action-set-switch</a></dt>
<dd></dd>
<dt><a href="triggers.html#action-set-timer">ActionSetTimer</a></dt>
<dt><a href="triggers.html#action-set-timer">action-set-timer</a></dt>
<dd></dd>
<dt><a href="triggers.html#action-start-timer">ActionStartTimer</a></dt>
<dt><a href="triggers.html#action-start-timer">action-start-timer</a></dt>
<dd></dd>
<dt><a href="triggers.html#action-stop-timer">ActionStopTimer</a></dt>
<dt><a href="triggers.html#action-stop-timer">action-stop-timer</a></dt>
<dd></dd>
<dt><a href="triggers.html#action-victory">ActionVictory</a></dt>
<dt><a href="triggers.html#action-victory">action-victory</a></dt>
<dd></dd>
<dt><a href="triggers.html#action-wait">ActionWait</a></dt>
<dt><a href="triggers.html#action-wait">action-wait</a></dt>
<dd></dd>
<dt><a href="game.html#add-keystroke-help">AddKeystrokeHelp</a></dt>
<dt><a href="game.html#add-keystroke-help">add-keystroke-help</a></dt>
<dd></dd>
<dt><a href="game.html#add-message">AddMessage</a></dt>
<dt><a href="game.html#add-message">add-message</a></dt>
<dd></dd>
<dt><a href="game.html#add-objective">AddObjective</a></dt>
<dt><a href="game.html#add-objective">add-objective</a></dt>
<dd></dd>
<dt><a href="game.html#add-tip">AddTip</a></dt>
<dt><a href="game.html#add-tip">add-tip</a></dt>
<dd></dd>
<dt><a href="triggers.html#add-trigger">AddTrigger</a></dt>
<dt><a href="triggers.html#add-trigger">add-trigger</a></dt>
<dd></dd>
<dt><a href="ai.html#ai:adhoc-force">ai:adhoc-force</a></dt>
<dd></dd>
@ -166,411 +352,203 @@
<dd></dd>
<dt><a href="ai.html#ai:wait-force">ai:wait-force</a></dt>
<dd></dd>
<dt><a href="game.html#briefing">Briefing</a></dt>
<dt><a href="game.html#briefing">briefing</a></dt>
<dd></dd>
<dt><a href="game.html#center-map">CenterMap</a></dt>
<dt><a href="game.html#center-map">center-map</a></dt>
<dd></dd>
<dt><a href="game.html#change-units-owner">ChangeUnitsOwner</a></dt>
<dt><a href="game.html#change-units-owner">change-units-owner</a></dt>
<dd></dd>
<dt><a href="research.html#check-dependency">CheckDependency</a></dt>
<dt><a href="research.html#check-dependency">check-dependency</a></dt>
<dd></dd>
<dt><a href="game.html#create-unit">CreateUnit</a></dt>
<dt><a href="game.html#create-unit">create-unit</a></dt>
<dd></dd>
<dt><a href="game.html#credits">Credits</a></dt>
<dt><a href="game.html#credits">credits</a></dt>
<dd></dd>
<dt><a href="config.html#decoration-on-top">DecorationOnTop</a></dt>
<dt><a href="ai.html#define-ai">define-ai</a></dt>
<dd></dd>
<dt><a href="ai.html#define-ai">DefineAi</a></dt>
<dt><a href="ai.html#define-ai-action">define-ai-action</a></dt>
<dd></dd>
<dt><a href="ai.html#define-ai-action">DefineAiAction</a></dt>
<dt><a href="ai.html#define-ai-helper">define-ai-helper</a></dt>
<dd></dd>
<dt><a href="ai.html#define-ai-helper">DefineAiHelper</a></dt>
<dt><a href="ai.html#define-ai-player">define-ai-player</a></dt>
<dd></dd>
<dt><a href="ai.html#define-ai-player">DefineAiPlayer</a></dt>
<dt><a href="research.html#define-allow">define-allow</a></dt>
<dd></dd>
<dt><a href="pud.html#define-ai-wc-names">DefineAiWcNames</a></dt>
<dt><a href="unittype.html#define-animations">define-animations</a></dt>
<dd></dd>
<dt><a href="research.html#define-allow">DefineAllow</a></dt>
<dt><a href="unittype.html#define-bool-flags">define-bool-flags</a></dt>
<dd></dd>
<dt><a href="unittype.html#define-animations">DefineAnimations</a></dt>
<dt><a href="game.html#define-burning-building">define-burning-building</a></dt>
<dd></dd>
<dt><a href="unittype.html#define-bool-flags">DefineBoolFlags</a></dt>
<dt><a href="ui.html#define-button">define-button</a></dt>
<dd></dd>
<dt><a href="game.html#define-burning-building">DefineBurningBuilding</a></dt>
<dt><a href="game.html#define-campaign">define-campaign</a></dt>
<dd></dd>
<dt><a href="ui.html#define-button">DefineButton</a></dt>
<dt><a href="game.html#define-construction">define-construction</a></dt>
<dd></dd>
<dt><a href="game.html#define-campaign">DefineCampaign</a></dt>
<dt><a href="ui.html#define-cursor">define-cursor</a></dt>
<dd></dd>
<dt><a href="game.html#define-construction">DefineConstruction</a></dt>
<dt><a href="research.html#define-dependency">define-dependency</a></dt>
<dd></dd>
<dt><a href="pud.html#define-construction-wc-names">DefineConstructionWcNames</a></dt>
<dt><a href="game.html#define-editor-unittypes">define-editor-unittypes</a></dt>
<dd></dd>
<dt><a href="ui.html#define-cursor">DefineCursor</a></dt>
<dt><a href="ui.html#define-font">define-font</a></dt>
<dd></dd>
<dt><a href="research.html#define-dependency">DefineDependency</a></dt>
<dt><a href="ui.html#define-font-color">define-font-color</a></dt>
<dd></dd>
<dt><a href="game.html#define-editor-unittypes">DefineEditorUnittypes</a></dt>
<dt><a href="ui.html#define-menu">define-menu</a></dt>
<dd></dd>
<dt><a href="ui.html#define-font">DefineFont</a></dt>
<dt><a href="ui.html#define-menu-graphics">define-menu-graphics</a></dt>
<dd></dd>
<dt><a href="ui.html#define-font-color">DefineFontColor</a></dt>
<dt><a href="ui.html#define-menu-item">define-menu-item</a></dt>
<dd></dd>
<dt><a href="sound.html#define-game-sounds">DefineGameSounds</a></dt>
<dt><a href="research.html#define-modifier">define-modifier</a></dt>
<dd></dd>
<dt><a href="icon.html#define-icon">DefineIcon</a></dt>
<dt><a href="game.html#define-race-names">define-race-names</a></dt>
<dd></dd>
<dt><a href="icon.html#define-icon-alias">DefineIconAlias</a></dt>
<dt><a href="game.html#define-ranks">define-ranks</a></dt>
<dd></dd>
<dt><a href="pud.html#define-icon-wc-names">DefineIconWcNames</a></dt>
<dt><a href="tileset.html#define-tileset">define-tileset</a></dt>
<dd></dd>
<dt><a href="ui.html#define-menu">DefineMenu</a></dt>
<dt><a href="ui.html#define-ui">define-ui</a></dt>
<dd></dd>
<dt><a href="ui.html#define-menu-graphics">DefineMenuGraphics</a></dt>
<dt><a href="research.html#define-unit-allow">define-unit-allow</a></dt>
<dd></dd>
<dt><a href="ui.html#define-menu-item">DefineMenuItem</a></dt>
<dt><a href="unittype.html#define-unit-stats">define-unit-stats</a></dt>
<dd></dd>
<dt><a href="magic.html#define-missile-type">DefineMissileType</a></dt>
<dt><a href="unittype.html#define-unit-type">define-unit-type</a></dt>
<dd></dd>
<dt><a href="pud.html#define-missiletype-wc-names">DefineMissiletypeWcNames</a></dt>
<dt><a href="research.html#define-upgrade">define-upgrade</a></dt>
<dd></dd>
<dt><a href="research.html#define-modifier">DefineModifier</a></dt>
<dt><a href="ui.html#define-viewports">define-viewports</a></dt>
<dd></dd>
<dt><a href="game.html#define-race-names">DefineRaceNames</a></dt>
<dt><a href="game.html#diplomacy">diplomacy</a></dt>
<dd></dd>
<dt><a href="game.html#define-ranks">DefineRanks</a></dt>
<dt><a href="ui.html#display-picture">display-picture</a></dt>
<dd></dd>
<dt><a href="magic.html#define-spell">DefineSpell</a></dt>
<dt><a href="game.html#game-cycle">game-cycle</a></dt>
<dd></dd>
<dt><a href="tileset.html#define-tileset">DefineTileset</a></dt>
<dt><a href="research.html#get-dependency">get-dependency</a></dt>
<dd></dd>
<dt><a href="pud.html#define-tileset-wc-names">DefineTilesetWcNames</a></dt>
<dt><a href="game.html#get-player-resource">get-player-resource</a></dt>
<dd></dd>
<dt><a href="ui.html#define-ui">DefineUI</a></dt>
<dt><a href="game.html#get-stratagus-home-path">get-stratagus-home-path</a></dt>
<dd></dd>
<dt><a href="research.html#define-unit-allow">DefineUnitAllow</a></dt>
<dt><a href="game.html#get-stratagus-library-path">get-stratagus-library-path</a></dt>
<dd></dd>
<dt><a href="unittype.html#define-unit-stats">DefineUnitStats</a></dt>
<dt><a href="game.html#get-this-player">get-this-player</a></dt>
<dd></dd>
<dt><a href="unittype.html#define-unit-type">DefineUnitType</a></dt>
<dt><a href="game.html#get-unit-mana">get-unit-mana</a></dt>
<dd></dd>
<dt><a href="pud.html#define-unittype-wc-names">DefineUnittypeWcNames</a></dt>
<dt><a href="unittype.html#get-unit-type-ident">get-unit-type-ident</a></dt>
<dd></dd>
<dt><a href="research.html#define-upgrade">DefineUpgrade</a></dt>
<dt><a href="unittype.html#get-unit-type-name">get-unit-type-name</a></dt>
<dd></dd>
<dt><a href="pud.html#define-upgrade-wc-names">DefineUpgradeWcNames</a></dt>
<dt><a href="game.html#get-unit-unholy-armor">get-unit-unholy-armor</a></dt>
<dd></dd>
<dt><a href="ui.html#define-viewports">DefineViewports</a></dt>
<dt><a href="game.html#group">group</a></dt>
<dd></dd>
<dt><a href="magic.html#delay-define-missile-type">DelayDefineMissileType</a></dt>
<dt><a href="triggers.html#if-elapsed">if-elapsed</a></dt>
<dd></dd>
<dt><a href="game.html#diplomacy">Diplomacy</a></dt>
<dt><a href="triggers.html#if-kills">if-kills</a></dt>
<dd></dd>
<dt><a href="ui.html#display-picture">DisplayPicture</a></dt>
<dt><a href="triggers.html#if-near-unit">if-near-unit</a></dt>
<dd></dd>
<dt><a href="sound.html#display-sounds">DisplaySounds</a></dt>
<dt><a href="triggers.html#if-opponents">if-opponents</a></dt>
<dd></dd>
<dt><a href="magic.html#frames-define-missile-type">FramesDefineMissileType</a></dt>
<dt><a href="triggers.html#if-rescued-near-unit">if-rescued-near-unit</a></dt>
<dd></dd>
<dt><a href="game.html#game-cycle">GameCycle</a></dt>
<dt><a href="triggers.html#if-resource">if-resource</a></dt>
<dd></dd>
<dt><a href="research.html#get-dependency">GetDependency</a></dt>
<dt><a href="triggers.html#if-score">if-score</a></dt>
<dd></dd>
<dt><a href="game.html#get-player-resource">GetPlayerResource</a></dt>
<dt><a href="triggers.html#if-switch">if-switch</a></dt>
<dd></dd>
<dt><a href="game.html#get-stratagus-home-path">GetStratagusHomePath</a></dt>
<dt><a href="triggers.html#if-timer">if-timer</a></dt>
<dd></dd>
<dt><a href="game.html#get-stratagus-library-path">GetStratagusLibraryPath</a></dt>
<dt><a href="triggers.html#if-unit">if-unit</a></dt>
<dd></dd>
<dt><a href="game.html#get-this-player">GetThisPlayer</a></dt>
<dt><a href="triggers.html#if-unit-at">if-unit-at</a></dt>
<dd></dd>
<dt><a href="game.html#get-unit-mana">GetUnitMana</a></dt>
<dt><a href="game.html#kill-unit">kill-unit</a></dt>
<dd></dd>
<dt><a href="unittype.html#get-unit-type-ident">GetUnitTypeIdent</a></dt>
<dt><a href="game.html#kill-unit-at">kill-unit-at</a></dt>
<dd></dd>
<dt><a href="unittype.html#get-unit-type-name">GetUnitTypeName</a></dt>
<dt><a href="game.html#library-path">library-path</a></dt>
<dd></dd>
<dt><a href="game.html#get-unit-unholy-armor">GetUnitUnholyArmor</a></dt>
<dt><a href="game.html#load-map">load-map</a></dt>
<dd></dd>
<dt><a href="game.html#group">Group</a></dt>
<dt><a href="game.html#load-pud">load-pud</a></dt>
<dd></dd>
<dt><a href="config.html#health-sprite">HealthSprite</a></dt>
<dt><a href="game.html#log">log</a></dt>
<dd></dd>
<dt><a href="triggers.html#if-elapsed">IfElapsed</a></dt>
<dt><a href="game.html#make-unit">make-unit</a></dt>
<dd></dd>
<dt><a href="triggers.html#if-kills">IfKills</a></dt>
<dt><a href="magic.html#missile">missile</a></dt>
<dd></dd>
<dt><a href="triggers.html#if-near-unit">IfNearUnit</a></dt>
<dt><a href="game.html#new-colors">new-colors</a></dt>
<dd></dd>
<dt><a href="triggers.html#if-opponents">IfOpponents</a></dt>
<dd></dd>
<dt><a href="triggers.html#if-rescued-near-unit">IfRescuedNearUnit</a></dt>
<dd></dd>
<dt><a href="triggers.html#if-resource">IfResource</a></dt>
<dd></dd>
<dt><a href="triggers.html#if-score">IfScore</a></dt>
<dd></dd>
<dt><a href="triggers.html#if-switch">IfSwitch</a></dt>
<dd></dd>
<dt><a href="triggers.html#if-timer">IfTimer</a></dt>
<dd></dd>
<dt><a href="triggers.html#if-unit">IfUnit</a></dt>
<dd></dd>
<dt><a href="triggers.html#if-unit-at">IfUnitAt</a></dt>
<dd></dd>
<dt><a href="game.html#kill-unit">KillUnit</a></dt>
<dd></dd>
<dt><a href="game.html#kill-unit-at">KillUnitAt</a></dt>
<dd></dd>
<dt><a href="game.html#library-path">LibraryPath</a></dt>
<dd></dd>
<dt><a href="game.html#load-map">LoadMap</a></dt>
<dd></dd>
<dt><a href="game.html#load-pud">LoadPud</a></dt>
<dd></dd>
<dt><a href="game.html#log">Log</a></dt>
<dd></dd>
<dt><a href="sound.html#make-sound">MakeSound</a></dt>
<dd></dd>
<dt><a href="sound.html#make-sound-group">MakeSoundGroup</a></dt>
<dd></dd>
<dt><a href="game.html#make-unit">MakeUnit</a></dt>
<dd></dd>
<dt><a href="config.html#mana-sprite">ManaSprite</a></dt>
<dd></dd>
<dt><a href="sound.html#map-sound">MapSound</a></dt>
<dd></dd>
<dt><a href="magic.html#missile">Missile</a></dt>
<dd></dd>
<dt><a href="game.html#new-colors">NewColors</a></dt>
<dd></dd>
<dt><a href="game.html#pf-show-groupids!">PfShowGroupids!</a></dt>
<dt><a href="game.html#pf-show-groupids!">pf-show-groupids!</a></dt>
<dd></dd>
<dt><a href="game.html#pf-show-regids!">pf-show-regids!</a></dt>
<dd></dd>
<dt><a href="game.html#place-unit">PlaceUnit</a></dt>
<dt><a href="game.html#place-unit">place-unit</a></dt>
<dd></dd>
<dt><a href="sound.html#play-file">PlayFile</a></dt>
<dt><a href="game.html#player">player</a></dt>
<dd></dd>
<dt><a href="sound.html#play-music">PlayMusic</a></dt>
<dt><a href="ui.html#process-menu">process-menu</a></dt>
<dd></dd>
<dt><a href="sound.html#play-sound">PlaySound</a></dt>
<dt><a href="game.html#remove-objective">remove-objective</a></dt>
<dd></dd>
<dt><a href="game.html#player">Player</a></dt>
<dt><a href="game.html#replay-log">replay-log</a></dt>
<dd></dd>
<dt><a href="ui.html#process-menu">ProcessMenu</a></dt>
<dt><a href="game.html#reset-keystroke-help">reset-keystroke-help</a></dt>
<dd></dd>
<dt><a href="game.html#remove-objective">RemoveObjective</a></dt>
<dt><a href="game.html#selection">selection</a></dt>
<dd></dd>
<dt><a href="game.html#replay-log">ReplayLog</a></dt>
<dt><a href="game.html#set-default-map!">set-default-map!</a></dt>
<dd></dd>
<dt><a href="game.html#reset-keystroke-help">ResetKeystrokeHelp</a></dt>
<dt><a href="game.html#set-diplomacy!">set-diplomacy!</a></dt>
<dd></dd>
<dt><a href="config.html#reveal-map">RevealMap</a></dt>
<dt><a href="ui.html#set-game-cursor!">set-game-cursor!</a></dt>
<dd></dd>
<dt><a href="config.html#right-button-attacks">RightButtonAttacks</a></dt>
<dt><a href="game.html#set-game-cycle!">set-game-cycle!</a></dt>
<dd></dd>
<dt><a href="config.html#right-button-moves">RightButtonMoves</a></dt>
<dt><a href="game.html#set-game-paused!">set-game-paused!</a></dt>
<dd></dd>
<dt><a href="game.html#selection">Selection</a></dt>
<dt><a href="game.html#set-group-id!">set-group-id!</a></dt>
<dd></dd>
<dt><a href="config.html#set-all-players-building-limit!">SetAllPlayersBuildingLimit</a></dt>
<dt><a href="game.html#set-objectives!">set-objectives!</a></dt>
<dd></dd>
<dt><a href="config.html#set-all-players-total-unit-limit!">SetAllPlayersTotalUnitLimit</a></dt>
<dt><a href="game.html#set-player-resource!">set-player-resource!</a></dt>
<dd></dd>
<dt><a href="config.html#set-all-players-unit-limit!">SetAllPlayersUnitLimit</a></dt>
<dt><a href="game.html#set-shared-vision!">set-shared-vision!</a></dt>
<dd></dd>
<dt><a href="config.html#set-brightness!">SetBrightness</a></dt>
<dt><a href="game.html#set-this-player!">set-this-player!</a></dt>
<dd></dd>
<dt><a href="config.html#set-building-capture!">SetBuildingCapture</a></dt>
<dt><a href="triggers.html#set-trigger-number!">set-trigger-number!</a></dt>
<dd></dd>
<dt><a href="sound.html#set-cd-mode!">SetCdMode!</a></dt>
<dt><a href="game.html#set-unit-mana!">set-unit-mana!</a></dt>
<dd></dd>
<dt><a href="config.html#set-click-missile!">SetClickMissile</a></dt>
<dt><a href="unittype.html#set-unit-type-name!">set-unit-type-name!</a></dt>
<dd></dd>
<dt><a href="config.html#set-color-cycle-all!">SetColorCycleAll</a></dt>
<dt><a href="game.html#set-unit-unholy-armor!">set-unit-unholy-armor!</a></dt>
<dd></dd>
<dt><a href="config.html#set-contrast!">SetContrast</a></dt>
<dt><a href="game.html#shared-vision">shared-vision</a></dt>
<dd></dd>
<dt><a href="config.html#set-damage-missile!">SetDamageMissile</a></dt>
<dt><a href="game.html#show-map-location">show-map-location</a></dt>
<dd></dd>
<dt><a href="game.html#set-default-map!">SetDefaultMap</a></dt>
<dt><a href="game.html#slot-usage">slot-usage</a></dt>
<dd></dd>
<dt><a href="game.html#set-diplomacy!">SetDiplomacy</a></dt>
<dt><a href="game.html#stratagus-map">stratagus-map</a></dt>
<dd></dd>
<dt><a href="config.html#set-double-click-delay!">SetDoubleClickDelay</a></dt>
<dt><a href="game.html#unit">unit</a></dt>
<dd></dd>
<dt><a href="config.html#set-editor-select-icon!">SetEditorSelectIcon</a></dt>
<dt><a href="unittype.html#unit-type">unit-type</a></dt>
<dd></dd>
<dt><a href="config.html#set-editor-units-icon!">SetEditorUnitsIcon</a></dt>
<dt><a href="unittype.html#unit-type-array">unit-type-array</a></dt>
<dd></dd>
<dt><a href="config.html#set-fancy-buildings!">SetFancyBuildings</a></dt>
<dd></dd>
<dt><a href="config.html#set-fog-of-war!">SetFogOfWar</a></dt>
<dd></dd>
<dt><a href="config.html#set-fog-of-war-brightness!">SetFogOfWarBrightness</a></dt>
<dd></dd>
<dt><a href="config.html#set-fog-of-war-contrast!">SetFogOfWarContrast</a></dt>
<dd></dd>
<dt><a href="config.html#set-fog-of-war-saturation!">SetFogOfWarSaturation</a></dt>
<dd></dd>
<dt><a href="config.html#set-forest-regeneration!">SetForestRegeneration</a></dt>
<dd></dd>
<dt><a href="ui.html#set-game-cursor!">SetGameCursor</a></dt>
<dd></dd>
<dt><a href="game.html#set-game-cycle!">SetGameCycle</a></dt>
<dd></dd>
<dt><a href="game.html#set-game-paused!">SetGamePaused</a></dt>
<dd></dd>
<dt><a href="sound.html#set-global-sound-range!">SetGlobalSoundRange</a></dt>
<dd></dd>
<dt><a href="config.html#set-grab-mouse!">SetGrabMouse</a></dt>
<dd></dd>
<dt><a href="game.html#set-group-id!">SetGroupId</a></dt>
<dd></dd>
<dt><a href="config.html#set-group-keys">SetGroupKeys</a></dt>
<dd></dd>
<dt><a href="config.html#set-hold-click-delay!">SetHoldClickDelay</a></dt>
<dd></dd>
<dt><a href="icon.html#set-icon-size!">SetIconSize</a></dt>
<dd></dd>
<dt><a href="config.html#set-key-scroll!">SetKeyScroll</a></dt>
<dd></dd>
<dt><a href="config.html#set-key-scroll-speed!">SetKeyScrollSpeed</a></dt>
<dd></dd>
<dt><a href="config.html#set-leave-stops!">SetLeaveStops</a></dt>
<dd></dd>
<dt><a href="config.html#set-max-selectable!">SetMaxSelectable</a></dt>
<dd></dd>
<dt><a href="config.html#set-menu-background!">SetMenuBackground</a></dt>
<dd></dd>
<dt><a href="config.html#set-menu-background-with-title!">SetMenuBackgroundWithTitle</a></dt>
<dd></dd>
<dt><a href="sound.html#set-menu-music!">SetMenuMusic</a></dt>
<dd></dd>
<dt><a href="config.html#set-minimap-terrain!">SetMinimapTerrain</a></dt>
<dd></dd>
<dt><a href="config.html#set-mouse-scroll!">SetMouseScroll</a></dt>
<dd></dd>
<dt><a href="config.html#set-mouse-scroll-speed!">SetMouseScrollSpeed</a></dt>
<dd></dd>
<dt><a href="sound.html#set-music-volume!">SetMusicVolume</a></dt>
<dd></dd>
<dt><a href="game.html#set-objectives!">SetObjectives</a></dt>
<dd></dd>
<dt><a href="config.html#set-original-resources!">SetOriginalResources</a></dt>
<dd></dd>
<dt><a href="game.html#set-player-resource!">SetPlayerResource</a></dt>
<dd></dd>
<dt><a href="config.html#set-reveal-attacker!">SetRevealAttacker</a></dt>
<dd></dd>
<dt><a href="config.html#set-reverse-map-move!">SetReverseMapMove</a></dt>
<dd></dd>
<dt><a href="config.html#set-saturation!">SetSaturation</a></dt>
<dd></dd>
<dt><a href="config.html#set-selection-style!">SetSelectionStyle</a></dt>
<dd></dd>
<dt><a href="game.html#set-shared-vision!">SetSharedVision</a></dt>
<dd></dd>
<dt><a href="config.html#set-show-attack-range!">SetShowAttackRange</a></dt>
<dd></dd>
<dt><a href="config.html#set-show-command-key!">SetShowCommandKey</a></dt>
<dd></dd>
<dt><a href="config.html#set-show-orders!">SetShowOrders</a></dt>
<dd></dd>
<dt><a href="config.html#set-show-reaction-range!">SetShowReactionRange</a></dt>
<dd></dd>
<dt><a href="config.html#set-show-sight-range!">SetShowSightRange</a></dt>
<dd></dd>
<dt><a href="config.html#set-show-tips!">SetShowTips</a></dt>
<dd></dd>
<dt><a href="sound.html#set-sound-range!">SetSoundRange</a></dt>
<dd></dd>
<dt><a href="sound.html#set-sound-volume!">SetSoundVolume</a></dt>
<dd></dd>
<dt><a href="config.html#set-speed-build!">SetSpeedBuild</a></dt>
<dd></dd>
<dt><a href="config.html#set-speed-research!">SetSpeedResearch</a></dt>
<dd></dd>
<dt><a href="config.html#set-speed-resources-harvest!">SetSpeedSesourcesHarvest</a></dt>
<dd></dd>
<dt><a href="config.html#set-speed-resources-return!">SetSpeedResourcesReturn</a></dt>
<dd></dd>
<dt><a href="config.html#set-speed-train!">SetSpeedTrain</a></dt>
<dd></dd>
<dt><a href="config.html#set-speed-upgrade!">SetSpeedUpgrade</a></dt>
<dd></dd>
<dt><a href="config.html#set-speeds!">SetSpeeds</a></dt>
<dd></dd>
<dt><a href="game.html#set-this-player!">SetThisPlayer</a></dt>
<dd></dd>
<dt><a href="config.html#set-title-screens!">SetTitleScreens</a></dt>
<dd></dd>
<dt><a href="config.html#set-training-queue!">SetTrainingQueue</a></dt>
<dd></dd>
<dt><a href="triggers.html#set-trigger-number!">SetTriggerNumber</a></dt>
<dd></dd>
<dt><a href="game.html#set-unit-mana!">SetUnitMana</a></dt>
<dd></dd>
<dt><a href="unittype.html#set-unit-type-name!">SetUnitTypeName</a></dt>
<dd></dd>
<dt><a href="game.html#set-unit-unholy-armor!">SetUnitUnholyArmor</a></dt>
<dd></dd>
<dt><a href="config.html#set-xp-damage!">SetXpDamage</a></dt>
<dd></dd>
<dt><a href="config.html#shadow-sprite">ShadowSprite</a></dt>
<dd></dd>
<dt><a href="game.html#shared-vision">SharedVision</a></dt>
<dd></dd>
<dt><a href="config.html#show-energy-selected-only">ShowEnergySelectedOnly</a></dt>
<dd></dd>
<dt><a href="config.html#show-full">ShowFull</a></dt>
<dd></dd>
<dt><a href="config.html#show-health-bar">ShowHealthBar</a></dt>
<dd></dd>
<dt><a href="config.html#show-health-dot">ShowHealthDot</a></dt>
<dd></dd>
<dt><a href="config.html#show-health-horizontal">ShowHealthHorizontal</a></dt>
<dd></dd>
<dt><a href="config.html#show-health-vertical">ShowHealthVertical</a></dt>
<dd></dd>
<dt><a href="config.html#show-mana-bar">ShowManaBar</a></dt>
<dd></dd>
<dt><a href="config.html#show-mana-dot">ShowManaDot</a></dt>
<dd></dd>
<dt><a href="config.html#show-mana-horizontal">ShowManaHorizontal</a></dt>
<dd></dd>
<dt><a href="config.html#show-mana-vertical">ShowManaVertical</a></dt>
<dd></dd>
<dt><a href="game.html#show-map-location">ShowMapLocation</a></dt>
<dd></dd>
<dt><a href="config.html#show-no-full">ShowNoFull</a></dt>
<dd></dd>
<dt><a href="game.html#slot-usage">SlotUsage</a></dt>
<dd></dd>
<dt><a href="sound.html#sound-for-name">SoundForName</a></dt>
<dd></dd>
<dt><a href="sound.html#sound-off">SoundOff</a></dt>
<dd></dd>
<dt><a href="sound.html#sound-on">SoundOn</a></dt>
<dd></dd>
<dt><a href="sound.html#sound-thread">SoundThread</a></dt>
<dd></dd>
<dt><a href="config.html#spell-sprite">SpellSprite</a></dt>
<dd></dd>
<dt><a href="sound.html#stop-music">StopMusic</a></dt>
<dd></dd>
<dt><a href="game.html#stratagus-map">StratagusMap</a></dt>
<dd></dd>
<dt><a href="game.html#unit">Unit</a></dt>
<dd></dd>
<dt><a href="unittype.html#unit-type">UnitType</a></dt>
<dd></dd>
<dt><a href="unittype.html#unit-type-array">UnitTypeArray</a></dt>
<dd></dd>
<dt><a href="game.html#units">Units</a></dt>
<dd></dd>
<dt><a href="sound.html#with-sound">WithSound</a></dt>
<dt><a href="game.html#units">units</a></dt>
<dd></dd>
<!-- SCRIPT END -->
</dl>

23
doc/scripts/magic.html
View file

@ -47,9 +47,9 @@
<a href="pud.html">NEXT</a>
<a href="ccl-index.html">Index</a>
<hr>
<a href="#define-missile-type">define-missile-type</a>
<a href="#define-spell">define-spell</a>
<a href="pud.html#define-missiletype-wc-names">define-missiletype-wc-names</a>
<a href="#DefineMissileType">DefineMissileType</a>
<a href="#DefineSpell">DefineSpell</a>
<a href="pud.html#DefineMissileTypeWcNames">DefineMissileTypeWcNames</a>
<!-- <a href="#missile">missile</a> -->
<hr>
<h2>Intro - Introduction to spells and missiles.</h2>
@ -57,7 +57,7 @@ This containts everything around spells and missiles. Though it might not be
obvious at start missiles are also suited for complex behaviour and included here.
<h2>Functions</h2>
<a name="define-missile-type"></a>
<a name="DefineMissileType"></a>
<h3>DefineMissileType( "missile-name", { tag = value, ...} )</h3>
@ -77,7 +77,6 @@ Possible tags:
<dd>This if followed by a list of X and Y sizes of the missile sprite.
F.E. 'size '(32 32)
</dd>
<a name="frames-define-missile-type"></a>
<dt>Frames = number</dt>
<dd>This is the number of frames in the file. Missiles lack complicated
animation scripts and just have a bunch of frames with equal duration.
@ -152,7 +151,6 @@ supported missile classes:<p>
</dd>
</dl>
</dd>
<a name="delay-define-missile-type"></a>
<dt>Delay = number</dt>
<dd>Delay in game cycles after the missile generation, until the missile
animation and effects starts. Delay denotes the number of display cycles to
@ -209,10 +207,8 @@ DefineMissileType("missile-fireball",
Sleep = 1, Speed = 16, Range = 1,
ImpactMissile = "missile-explosion" } )
</pre>
<h4>Used</h4>
<a href="../../data/scripts/missiles.lua"> $LIBARYPATH/scripts/missiles.lua </a>
<a name="define-spell"></a>
<a name="DefineSpell"></a>
<h3>DefineSpell( "spell-ident", tag, value, ... )</h3>
This is the function to define a spell, including it's effects and targetting
conditions. Be very carefull, defining random flags will probably make the game crash.
@ -281,7 +277,7 @@ Here are the supported parameters:<p>
</dd>
<dt>bool-flags, "true" or "false" or "only"</dt>
<dd>There is no parameter called bool-flags. You can however use flags defined
by <a href="unittype.html#define-bool-flags">DefineBoolFlags()</a> just like a
by <a href="unittype.html#DefineBoolFlags">DefineBoolFlags()</a> just like a
bool parameter. For instance "organic", "only" will make a spell work only on
units marked with the "organic" flag.
</dd>
@ -447,7 +443,7 @@ Here are the supported operations, their paramenters, and what they do.</dd><p>
</dd>
How to do a reveal-map spell: define a special unit, give it the
revealer flag, and set the spell's range to "infinite". Please see
<a href="unittype.html#define-unit-type">DefineUnitType()</a>
<a href="unittype.html#DefineUnitType">DefineUnitType()</a>
</dd>
</dl>
<dt>"polymorph", tag, ...</dt>
@ -519,8 +515,6 @@ DefineSpell("spell-healing",
"autocast", {"range", 6, "condition", {"alliance", "only", "max-hp-percent", 100}}
)
</pre>
<h4>Used</h4>
<a href="../../data/scripts/spells.lua"> $LIBARYPATH/scripts/spells.lua </a>
<!-- Useful to explain save format ?
@ -599,9 +593,6 @@ controlling function. No parameters.
(missile 'type-fireball 'pos '(10 10) 'goal '(10 50)
'global 'state 0 'wait 5 'damage 5000 'source 45 'ttl -1)
</pre>
<h4>Used</h4>
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
-->

100
doc/scripts/pud.html
View file

@ -47,20 +47,20 @@
<a href="research.html">NEXT</a>
<a href="ccl-index.html">Index</a>
<hr>
<a href="#define-ai-wc-names">define-ai-wc-names</a>
<a href="#define-construction-wc-names">define-construction-wc-names</a>
<a href="#define-icon-wc-names">define-icon-wc-names</a>
<a href="#define-missiletype-wc-names">define-missiletype-wc-names</a>
<a href="#define-tileset-wc-names">define-tileset-wc-names</a>
<a href="#define-upgrade-wc-names">define-upgrade-wc-names</a>
<a href="#define-unittype-wc-names">define-unittype-wc-names</a>
<a href="#DefineAiWcNames">DefineAiWcNames</a>
<a href="#DefineConstructionWcNames">DefineConstructionWcNames</a>
<a href="#DefineIconWcNames">DefineIconWcNames</a>
<a href="#DefineMissileTypeWcNames">DefineMissileTypeWcNames</a>
<a href="#DefineTilesetWcNames">DefineTilesetWcNames</a>
<a href="#DefineUpgradeWcNames">DefineUpgradeWcNames</a>
<a href="#DefineUnittypeWcNames">DefineUnittypeWcNames</a>
<hr>
<h2>Intro - Introduction to function for pud converting</h2>
This contains everything about converting from wc2.
<h2>Functions</h2>
<a name="define-ai-wc-names"></a>
<h3>(define-ai-wc-names 'ai-0 'ai-1 ... )</h3>
<a name="DefineAiWcNames"></a>
<h3>DefineAiWcNames( "ai-0", "ai-1", ... )</h3>
Define AI mapping from original number to internal symbol.
The parameters are simply a list of ai names. The first name coresponds to pud ai number
@ -69,21 +69,18 @@ The parameters are simply a list of ai names. The first name coresponds to pud a
<h4>Example</h4>
<pre>
(define-ai-wc-names
'land-attack 'passive 'orc-03 'hum-04 'orc-04 'hum-05 'orc-05
'hum-06 'orc-06 'hum-07 'orc-07 'hum-08 'orc-08 'hum-09 'orc-09
'hum-10 'orc-10 'hum-11 'orc-11 'hum-12 'orc-12 'hum-13 'orc-13
'hum-14-orange 'orc-14-blue 'sea-attack 'air-attack 'hum-14-red
'hum-14-white 'hum-14-black 'orc-14-green 'orc-14-white 'orc-exp-04
'orc-exp-05 'orc-exp-07a 'orc-exp-09 'orc-exp-10 'orc-exp-12 'orc-exp-06a
'orc-exp-06b 'orc-exp-11a 'orc-exp-11b 'hum-exp-02a-red 'hum-exp-02b-black
...
DefineAiWcNames(
"land-attack", "passive", "orc-03", "hum-04", "orc-04", "hum-05", "orc-05",
"hum-06", "orc-06", "hum-07", "orc-07", "hum-08", "orc-08", "hum-09", "orc-09",
"hum-10", "orc-10", "hum-11", "orc-11", "hum-12", "orc-12", "hum-13", "orc-13",
"hum-14-orange", "orc-14-blue", "sea-attack", "air-attack", "hum-14-red",
"hum-14-white", "hum-14-black", "orc-14-green", "orc-14-white", "orc-exp-04",
"orc-exp-05", "orc-exp-07a", "orc-exp-09", "orc-exp-10", "orc-exp-12", "orc-exp-06a",
"orc-exp-06b", "orc-exp-11a", "orc-exp-11b", "hum-exp-02a-red", "hum-exp-02b-black")
</pre>
<h4>Not Used</h4>
<a name="define-construction-wc-names"></a>
<h3>(define-construction-wc-names 'construction-0 'construction-1 ... )</h3>
<a name="DefineConstructionWcNames"></a>
<h3>DefineConstructionWcNames( "construction-0", "construction-1", ... )</h3>
Define construction mapping from original number to internal symbol.
The parameters are simply a list of construction names. The first name coresponds
@ -92,12 +89,11 @@ to wc2 construction 0, the second name coresponds to construction 1, and so on.
<h4>Example</h4>
<pre>
(define-construction-wc-names human-shipyard orc-shipyard ... )
DefineConstructionWcNames("human-shipyard", "orc-shipyard")
</pre>
<h4>Used</h4>
<a name="define-icon-wc-names"></a>
<h3>(define-icon-wc-names icon-0 icon-1 ... )</h3>
<a name="DefineIconWcNames"></a>
<h3>DefineIconWcNames("icon-0", "icon-1", ... )</h3>
Define icon mapping from original number to internal symbol.
The parameters are simply a list of icon names. The first name coresponds
@ -108,19 +104,11 @@ to wc2 icon 0, the second name coresponds to icon 1, and so on.<p>
<pre>
;; This is the default icon mapping.
(define-icon-wc-names
'icon-peasant 'icon-peon 'icon-footman ... )
DefineIconWcNames("icon-peasant", "icon-peon", "icon-footman")
</pre>
<h4>Used</h4>
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="define-missiletype-wc-names"></a>
<h3>(define-missiletype-wc-names)</h3>
<a name="DefineMissileTypeWcNames"></a>
<h3>DefineMissileTypeWcNames("missile1", "missile2", ... )</h3>
Define missiletype mapping from original number to internal symbol.
The parameters are simply a list of missile names. The first name coresponds
@ -129,14 +117,11 @@ to wc2 missile 0, the second name coresponds to missile 1, and so on.
<h4>Example</h4>
<pre>
(define-missiletype-wc-names lightning griffon-hammer ... )
DefineMissileTypeWcNames("missile-lightning", "missile-griffon-hammer")
</pre>
<h4>Used</h4>
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="define-tileset-wc-names"></a>
<h3>(define-tileset-wc-names tileset-0 tileset-1 ... )</h3>
<a name="DefineTilesetWcNames"></a>
<h3>DefineTilesetWcNames("tileset-0", "tileset-1", ... )</h3>
Define tileset mapping from original number to internal symbol.
This is FIXED to 4 tileset, bad.
@ -159,17 +144,12 @@ to wc2 missile 0, the second name coresponds to missile 1, and so on.
<h4>Example</h4>
<pre>
;; This is the default tileset mapping.
(define-tileset-wc-names
'tileset-summer 'tileset-winter 'tileset-wasteland 'tileset-swamp )
-- This is the default tileset mapping.
DefineTilesetWcNames("tileset-summer", "tileset-winter", "tileset-wasteland", "tileset-swamp")
</pre>
<h4>Used</h4>
<a href="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </a>
<a name="define-upgrade-wc-names"></a>
<h3>(define-upgrade-wc-names upgrade-0 upgrade-1 ... )</h3>
<a name="DefineUpgradeWcNames"></a>
<h3>DefineUpgradeWcNames("upgrade-0", "upgrade-1", ... )</h3>
Define upgrade mapping from original number to internal symbol.
The parameters are simply a list of upgrade names. The first name coresponds
@ -178,16 +158,11 @@ to wc2 upgrade 0, the second name coresponds to upgrade 1, and so on.
<h4>Example</h4>
<pre>
(define-upgrade-wc-names 'upgrade-sword1 'upgrade-sword2 ...)
DefineUpgradeWcNames("upgrade-sword1", "upgrade-sword2")
</pre>
<h4>Used</h4>
<a href="../../data/ccl/upgrade.ccl"> $LIBARYPATH/ccl/upgrade.ccl</a> ,
<a href="../../data/ccl/human/upgrade.ccl"> $LIBARYPATH/ccl/human/upgrade.ccl</a> ,
<a href="../../data/ccl/orc/upgrade.ccl"> $LIBARYPATH/ccl/orc/upgrade.ccl</a>
<a name="define-unittype-wc-names"></a>
<h3>(define-unittype-wc-names unit-0 unit-1 ... )</h3>
<a name="DefineUnitTypeWcNames"></a>
<h3>DefineUnitTypeWcNames("unit-0", "unit-1", ... )</h3>
Define unit-type mapping from original number to internal symbol.
The parameters are simply a list of upgrade names. The first name coresponds
@ -196,11 +171,8 @@ to wc2 unit 0, the second name coresponds to wc2 unit 1, and so on.
<h4>Example</h4>
<pre>
(define-unittype-wc-names unit-footman unit-grunt ... )
DefineUnitTypeWcNames("unit-footman", "unit-grunt")
</pre>
<h4>Used</h4>
<a href="../../data/ccl/wc2.ccl"> $LIBRARYPATH/ccl/wc2.ccl </a>
<hr>
Last changed: $Id$<br>

76
doc/scripts/sound.html
View file

@ -47,31 +47,31 @@
<a href="tileset.html">NEXT</a>
<a href="ccl-index.html">Index</a>
<hr>
<a href="#define-game-sounds">DefineGameSounds()</a>
<a href="#display-sounds">DisplaySounds()</a>
<a href="#make-sound">MakeSound()</a>
<a href="#make-sound-group">MakeSoundGroup()</a>
<a href="#map-sound">MapSound()</a>
<a href="#play-file">PlayFile()</a>
<a href="#play-music">PlayMusic()</a>
<a href="#play-sound">PlaySound()</a>
<a href="#set-cd-mode!">SetCdMode()</a>
<a href="#set-global-sound-range!">SetGlobalSoundRange()</a>
<a href="#set-menu-music!">SetMenuMusic()</a>
<a href="#set-music-volume!">SetMusicVolume()</a>
<a href="#set-sound-range!">SetSoundRange()</a>
<a href="#set-sound-volume!">SetSoundVolume()</a>
<a href="#sound-for-name">SoundForName()</a>
<a href="#sound-off">SoundOff()</a>
<a href="#sound-on">SoundOn()</a>
<a href="#sound-thread">SoundThread()</a>
<a href="#stop-music">StopMusic()</a>
<a href="#DefineGameSounds">DefineGameSounds</a>
<a href="#DisplaySounds">DisplaySounds</a>
<a href="#MakeSound">MakeSound</a>
<a href="#MakeSoundGroup">MakeSoundGroup</a>
<a href="#MapSound">MapSound</a>
<a href="#PlayFile">PlayFile</a>
<a href="#PlayMusic">PlayMusic</a>
<a href="#PlaySound">PlaySound</a>
<a href="#SetCdMode">SetCdMode</a>
<a href="#SetGlobalSoundRange">SetGlobalSoundRange</a>
<a href="#SetMenuMusic">SetMenuMusic</a>
<a href="#SetMusicVolume">SetMusicVolume</a>
<a href="#SetSoundRange">SetSoundRange</a>
<a href="#SetSoundVolume">SetSoundVolume</a>
<a href="#SoundForName">SoundForName</a>
<a href="#SoundOff">SoundOff</a>
<a href="#SoundOn">SoundOn</a>
<a href="#SoundThread">SoundThread</a>
<a href="#StopMusic">StopMusic</a>
<hr>
<h2>Intro - Introduction to sound functions and variables</h2>
Everything around sound.
<h2>Functions</h2>
<a name="define-game-sounds"></a>
<a name="DefineGameSounds"></a>
<h3>DefineGameSounds("name", arg, [[name2, arg] ...])</h3>
Specify some global sounds.
@ -113,7 +113,7 @@ DefineGameSounds(
"rescue", {"orc", MakeSound("orc rescue", "orc/rescue.wav")} )
</pre>
<a name="display-sounds"></a>
<a name="DisplaySounds"></a>
<h3>DisplaySounds()</h3>
Ask the sound system to dump on the standard output the mapping
@ -126,7 +126,7 @@ between sound names and sound id.
DisplaySounds()
</pre>
<a name="make-sound"></a>
<a name="MakeSound"></a>
<h3>MakeSound("name", "file" or {"file1", "file2", ...})</h3>
Asks the sound system to register a sound under a given name, with an
@ -154,7 +154,7 @@ MakeSound("basic human voices acknowledge",
"human/basic_voices/acknowledgement/4.wav"})
</pre>
<a name="make-sound-group"></a>
<a name="MakeSoundGroup"></a>
<h3>MakeSoundGroup("name", "groupname1" or SoundId, "groupname2" or SoundId)</h3>
Asks the sound system to build a special sound group.
@ -177,7 +177,7 @@ MakeSoundGroup("footman-selected",
"basic human voices selected", "basic human voices annoyed")
</pre>
<a name="map-sound"></a>
<a name="MapSound"></a>
<h3>MapSound("name", "sound")</h3>
Ask the sound system to remap a sound id to a given name.
@ -198,7 +198,7 @@ Ask the sound system to remap a sound id to a given name.
MapSound("footman-acknowledge", "basic human voices acknowledge")
</pre>
<a name="play-file"></a>
<a name="PlayFile"></a>
<h3>PlayFile("name")</h3>
Play a sound file.
<dl>
@ -213,7 +213,7 @@ Play a sound file.
PlayFile("spells/lightning.wav")
</pre>
<a name="play-music"></a>
<a name="PlayMusic"></a>
<h3>PlayMusic("name")</h3>
Name of the music file to play.
@ -230,7 +230,7 @@ Name of the music file to play.
PlayMusic("music/default.mod")
</pre>
<a name="play-sound"></a>
<a name="PlaySound"></a>
<h3>PlaySound("name")</h3>
Ask the sound system to play the specified sound.
@ -247,7 +247,7 @@ Ask the sound system to play the specified sound.
PlaySound("basic human voices ready")
</pre>
<a name="set-cd-mode!"></a>
<a name="SetCdMode"></a>
<h3>SetCdMode("mode")</h3>
Set the cd mode.
@ -269,7 +269,7 @@ Set the cd mode.
SetCdMode("random")
</pre>
<a name="set-global-sound-range!"></a>
<a name="SetGlobalSoundRange"></a>
<h3>SetGlobalSoundRange(distance)</h3>
Set the cut off distance.
@ -285,7 +285,7 @@ Set the cut off distance.
SetGlobalSoundRange(40)
</pre>
<a name="set-menu-music!"></a>
<a name="SetMenuMusic"></a>
<h3>SetMenuMusic("song")</h3>
Set the default menu music.
@ -301,7 +301,7 @@ Set the default menu music.
SetMenuMusic("music/default.mod")
</pre>
<a name="set-music-volume!"></a>
<a name="SetMusicVolume"></a>
<h3>SetMusicVolume(volume)</h3>
Set the music volume.
@ -319,7 +319,7 @@ Set the music volume.
SetMusicVolume(128)
</pre>
<a name="set-sound-range!"></a>
<a name="SetSoundRange"></a>
<h3>SetSoundRange("name", distance)</h3>
Set the range of a given sound.
@ -339,7 +339,7 @@ Set the range of a given sound.
SetSoundRange("basic human voices ready", 20)
</pre>
<a name="set-sound-volume!"></a>
<a name="SetSoundVolume"></a>
<h3>SetSoundVolume(volume)</h3>
Global volume support.
@ -356,7 +356,7 @@ Global volume support.
SetSoundVolume(128)
</pre>
<a name="sound-for-name"></a>
<a name="SoundForName"></a>
<h3>SoundForName("name")</h3>
Ask the sound system to associate a sound id to a sound name.
@ -372,7 +372,7 @@ Ask the sound system to associate a sound id to a sound name.
<pre>
SoundForName("peasant attack")
</pre>
<a name="sound-off"></a>
<a name="SoundOff"></a>
<h3>SoundOff()</h3>
Turn off sound.
@ -384,7 +384,7 @@ Turn off sound.
SoundOff()
</pre>
<a name="sound-on"></a>
<a name="SoundOn"></a>
<h3>SoundOn()</h3>
Turn on sound.
@ -396,7 +396,7 @@ Turn on sound.
SoundOn()
</pre>
<a name="sound-thread"></a>
<a name="SoundThread"></a>
<h3>SoundThread()</h3>
Ask stratagus to use a sound thread.
@ -406,7 +406,7 @@ Ask stratagus to use a sound thread.
<pre>
SoundThread()
</pre>
<a name="stop-music"></a>
<a name="StopMusic"></a>
<h3>StopMusic()</h3>
Stop playing music.