Sophie

Sophie

distrib > Mageia > 5 > i586 > by-pkgid > 66e751bba49631252134d86e2a7e0697 > files > 21

boswars-2.7-8.mga5.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head>
<!--
----	(c) Copyright 2002-2007 by Lutz Sammer, Russell Smith

----    This program is free software; you can redistribute it and/or modify
----    it under the terms of the GNU General Public License as published by
----    the Free Software Foundation; only version 2 of the License.
----
----    This program is distributed in the hope that it will be useful,
----    but WITHOUT ANY WARRANTY; without even the implied warranty of
----    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
----    GNU General Public License for more details.
----
----    You should have received a copy of the GNU General Public License
----    along with this program; if not, write to the Free Software
----    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
----    02111-1307, USA.
-->
    <title>Bos Wars Scripting API: Index</title>
    <meta http-equiv="Content-Type" content="text/html; CHARSET=iso-8859-1">
    <link rel="stylesheet" type="text/css" href="scripts.css">
</head>
<body>
    <h1>Bos Wars Scripting API: Index</h1>
<hr>
<a href="../index.html">Bos Wars</a> 
<a href="../faq.html">FAQ</a> 
<a href="unittype.html">PREV</a> 
<a href="ai.html">NEXT</a> 
<a href="index.html">LUA Index</a>
<hr>
<a href="ai.html">AI</a>
<a href="config.html">Config</a>
<a href="editor.html">Editor</a>
<a href="game.html">Game</a>
<a href="magic.html">Magic</a>
<a href="mappresentation.html">Map Presentation</a>
<a href="mapsetup.html">Map Setup</a>
<a href="limits.html">Limits</a>
<a href="savegame.html">SaveGame</a>
<a href="sound.html">Sound</a>
<a href="triggers.html">Triggers</a>
<a href="ui.html">UI</a>
<a href="unittype.html">UnitType</a>
<hr>

<dl>
<!-- This part is autogenerated. Run ./makeindex.py to regenerate. -->
<!-- START SCRIPT -->
<dt><a href="config.html#AStarFixedUnitCrossingCost">AStarFixedUnitCrossingCost</a></dt>
<dd></dd>
<dt><a href="config.html#AStarKnowUnseenTerrain">AStarKnowUnseenTerrain</a></dt>
<dd></dd>
<dt><a href="config.html#AStarMovingUnitCrossingCost">AStarMovingUnitCrossingCost</a></dt>
<dd></dd>
<dt><a href="config.html#AStarUnknownTerrainCost">AStarUnknownTerrainCost</a></dt>
<dd></dd>
<dt><a href="triggers.html#ActionDefeat">ActionDefeat</a></dt>
<dd></dd>
<dt><a href="triggers.html#ActionDraw">ActionDraw</a></dt>
<dd></dd>
<dt><a href="triggers.html#ActionSetTimer">ActionSetTimer</a></dt>
<dd></dd>
<dt><a href="triggers.html#ActionStartTimer">ActionStartTimer</a></dt>
<dd></dd>
<dt><a href="triggers.html#ActionStopTimer">ActionStopTimer</a></dt>
<dd></dd>
<dt><a href="triggers.html#ActionVictory">ActionVictory</a></dt>
<dd></dd>
<dt><a href="game.html#AddMessage">AddMessage</a></dt>
<dd></dd>
<dt><a href="game.html#AddObjective">AddObjective</a></dt>
<dd></dd>
<dt><a href="triggers.html#AddTrigger">AddTrigger</a></dt>
<dd></dd>
<dt><a href="ai.html#AiAttackWithForce">AiAttackWithForce</a></dt>
<dd></dd>
<dt><a href="ai.html#AiCheckForce">AiCheckForce</a></dt>
<dd></dd>
<dt><a href="ai.html#AiDebug">AiDebug</a></dt>
<dd></dd>
<dt><a href="ai.html#AiDebugPlayer">AiDebugPlayer</a></dt>
<dd></dd>
<dt><a href="ai.html#AiForce">AiForce</a></dt>
<dd></dd>
<dt><a href="ai.html#AiForceRole">AiForceRole</a></dt>
<dd></dd>
<dt><a href="ai.html#AiNeed">AiNeed</a></dt>
<dd></dd>
<dt><a href="ai.html#AiPlayer">AiPlayer</a></dt>
<dd></dd>
<dt><a href="ai.html#AiSet">AiSet</a></dt>
<dd></dd>
<dt><a href="ai.html#AiSleep">AiSleep</a></dt>
<dd></dd>
<dt><a href="ai.html#AiState">AiState</a></dt>
<dd></dd>
<dt><a href="ai.html#AiTypes">AiTypes</a></dt>
<dd></dd>
<dt><a href="ai.html#AiWait">AiWait</a></dt>
<dd></dd>
<dt><a href="ai.html#AiWaitForce">AiWaitForce</a></dt>
<dd></dd>
<dt><a href="config.html#AlliedUnitRecyclingEfficiency">AlliedUnitRecyclingEfficiency</a></dt>
<dd></dd>
<dt><a href="ui.html#CColor">CColor</a></dt>
<dd></dd>
<dt><a href="ui.html#CFontColor">CFontColor</a></dt>
<dd></dd>
<dt><a href="ui.html#CFontColor.Colors">CFontColor.Colors</a></dt>
<dd></dd>
<dt><a href="ui.html#CFontColor.Get">CFontColor.Get</a></dt>
<dd></dd>
<dt><a href="ui.html#CFontColor.New">CFontColor.New</a></dt>
<dd></dd>
<dt><a href="ui.html#CGraphic">CGraphic</a></dt>
<dd></dd>
<dt><a href="ui.html#CGraphic.Free">CGraphic.Free</a></dt>
<dd></dd>
<dt><a href="ui.html#CGraphic.Load">CGraphic.Load</a></dt>
<dd></dd>
<dt><a href="ui.html#CGraphic.New">CGraphic.New</a></dt>
<dd></dd>
<dt><a href="ui.html#CGraphic.Resize">CGraphic.Resize</a></dt>
<dd></dd>
<dt><a href="ui.html#CResourceInfo">CResourceInfo</a></dt>
<dd></dd>
<dt><a href="ui.html#CResourceInfo.G">CResourceInfo.G</a></dt>
<dd></dd>
<dt><a href="ui.html#CResourceInfo.IconFrame">CResourceInfo.IconFrame</a></dt>
<dd></dd>
<dt><a href="ui.html#CResourceInfo.IconX">CResourceInfo.IconX</a></dt>
<dd></dd>
<dt><a href="ui.html#CResourceInfo.IconY">CResourceInfo.IconY</a></dt>
<dd></dd>
<dt><a href="ui.html#CResourceInfo.TextX">CResourceInfo.TextX</a></dt>
<dd></dd>
<dt><a href="ui.html#CResourceInfo.TextY">CResourceInfo.TextY</a></dt>
<dd></dd>
<dt><a href="game.html#CenterMap">CenterMap</a></dt>
<dd></dd>
<dt><a href="game.html#ChangeUnitsOwner">ChangeUnitsOwner</a></dt>
<dd></dd>
<dt><a href="game.html#CreateUnit">CreateUnit</a></dt>
<dd></dd>
<dt><a href="ai.html#DefineAiHelper">DefineAiHelper</a></dt>
<dd></dd>
<dt><a href="savegame.html#DefineAiPlayer">DefineAiPlayer</a></dt>
<dd></dd>
<dt><a href="ai.html#DefineAiType">DefineAiType</a></dt>
<dd></dd>
<dt><a href="limits.html#DefineAllow">DefineAllow</a></dt>
<dd></dd>
<dt><a href="unittype.html#DefineAnimations">DefineAnimations</a></dt>
<dd></dd>
<dt><a href="game.html#DefineBurningBuilding">DefineBurningBuilding</a></dt>
<dd></dd>
<dt><a href="ui.html#DefineButton">DefineButton</a></dt>
<dd></dd>
<dt><a href="ui.html#DefineButtonStyle">DefineButtonStyle</a></dt>
<dd></dd>
<dt><a href="game.html#DefineConstruction">DefineConstruction</a></dt>
<dd></dd>
<dt><a href="ui.html#DefineCursor">DefineCursor</a></dt>
<dd></dd>
<dt><a href="config.html#DefineDecorations">DefineDecorations</a></dt>
<dd></dd>
<dt><a href="config.html#DefineDefaultResourceNames">DefineDefaultResourceNames</a></dt>
<dd></dd>
<dt><a href="sound.html#DefineGameSounds">DefineGameSounds</a></dt>
<dd></dd>
<dt><a href="mappresentation.html#DefineMapOption">DefineMapOption</a></dt>
<dd></dd>
<dt><a href="mappresentation.html#DefineMapSetup">DefineMapSetup</a></dt>
<dd></dd>
<dt><a href="magic.html#DefineMissileType">DefineMissileType</a></dt>
<dd></dd>
<dt><a href="game.html#DefinePlayerColorIndex">DefinePlayerColorIndex</a></dt>
<dd></dd>
<dt><a href="game.html#DefinePlayerColors">DefinePlayerColors</a></dt>
<dd></dd>
<dt><a href="mappresentation.html#DefinePlayerTypes">DefinePlayerTypes</a></dt>
<dd></dd>
<dt><a href="magic.html#DefineSpell">DefineSpell</a></dt>
<dd></dd>
<dt><a href="config.html#DefineSprites">DefineSprites</a></dt>
<dd></dd>
<dt><a href="limits.html#DefineUnitAllow">DefineUnitAllow</a></dt>
<dd></dd>
<dt><a href="unittype.html#DefineUnitType">DefineUnitType</a></dt>
<dd></dd>
<dt><a href="unittype.html#DefineVariables">DefineVariables</a></dt>
<dd></dd>
<dt><a href="ui.html#DefineViewports">DefineViewports</a></dt>
<dd></dd>
<dt><a href="game.html#Diplomacy">Diplomacy</a></dt>
<dd></dd>
<dt><a href="editor.html#Editor">Editor</a></dt>
<dd></dd>
<dt><a href="editor.html#Editor.Running">Editor.Running</a></dt>
<dd></dd>
<dt><a href="editor.html#Editor.ShowTerrainFlags">Editor.ShowTerrainFlags</a></dt>
<dd></dd>
<dt><a href="editor.html#Editor.StartUnit">Editor.StartUnit</a></dt>
<dd></dd>
<dt><a href="editor.html#Editor.TileSelectedPatch">Editor.TileSelectedPatch</a></dt>
<dd></dd>
<dt><a href="editor.html#Editor.UnitTypes">Editor.UnitTypes</a></dt>
<dd></dd>
<dt><a href="editor.html#EditorCommandLine">EditorCommandLine</a></dt>
<dd></dd>
<dt><a href="editor.html#EditorEditing">EditorEditing</a></dt>
<dd></dd>
<dt><a href="editor.html#EditorNotRunning">EditorNotRunning</a></dt>
<dd></dd>
<dt><a href="editor.html#EditorSaveMap">EditorSaveMap</a></dt>
<dd></dd>
<dt><a href="editor.html#EditorStarted">EditorStarted</a></dt>
<dd></dd>
<dt><a href="config.html#EnemyUnitRecyclingEfficiency">EnemyUnitRecyclingEfficiency</a></dt>
<dd></dd>
<dt><a href="config.html#EnergyCost">EnergyCost</a></dt>
<dd></dd>
<dt><a href="game.html#GetCurrentLuaPath">GetCurrentLuaPath</a></dt>
<dd></dd>
<dt><a href="sound.html#GetEffectsVolume">GetEffectsVolume</a></dt>
<dd></dd>
<dt><a href="game.html#GetLocalPlayerName">GetLocalPlayerName</a></dt>
<dd></dd>
<dt><a href="mappresentation.html#GetMapOption">GetMapOption</a></dt>
<dd></dd>
<dt><a href="sound.html#GetMusicVolume">GetMusicVolume</a></dt>
<dd></dd>
<dt><a href="triggers.html#GetNumOpponents">GetNumOpponents</a></dt>
<dd></dd>
<dt><a href="triggers.html#GetNumUnitsAt">GetNumUnitsAt</a></dt>
<dd></dd>
<dt><a href="triggers.html#GetTimer">GetTimer</a></dt>
<dd></dd>
<dt><a href="game.html#GetUnitVariable">GetUnitVariable</a></dt>
<dd></dd>
<dt><a href="config.html#GetVideoFullScreen">GetVideoFullScreen</a></dt>
<dd></dd>
<dt><a href="config.html#GetVideoResolution">GetVideoResolution</a></dt>
<dd></dd>
<dt><a href="game.html#Group">Group</a></dt>
<dd></dd>
<dt><a href="ui.html#HandleCommandKey">HandleCommandKey</a></dt>
<dd></dd>
<dt><a href="triggers.html#IfNearUnit">IfNearUnit</a></dt>
<dd></dd>
<dt><a href="triggers.html#IfRescuedNearUnit">IfRescuedNearUnit</a></dt>
<dd></dd>
<dt><a href="sound.html#IsEffectsEnabled">IsEffectsEnabled</a></dt>
<dd></dd>
<dt><a href="sound.html#IsMusicEnabled">IsMusicEnabled</a></dt>
<dd></dd>
<dt><a href="game.html#KillUnit">KillUnit</a></dt>
<dd></dd>
<dt><a href="game.html#KillUnitAt">KillUnitAt</a></dt>
<dd></dd>
<dt><a href="game.html#LibraryPath">LibraryPath</a></dt>
<dd></dd>
<dt><a href="game.html#ListDirectory">ListDirectory</a></dt>
<dd></dd>
<dt><a href="game.html#ListDirsInDirectory">ListDirsInDirectory</a></dt>
<dd></dd>
<dt><a href="game.html#ListFilesInDirectory">ListFilesInDirectory</a></dt>
<dd></dd>
<dt><a href="savegame.html#Log">Log</a></dt>
<dd></dd>
<dt><a href="config.html#MagmaCost">MagmaCost</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="sound.html#MapSound">MapSound</a></dt>
<dd></dd>
<dt><a href="config.html#MaxCosts">MaxCosts</a></dt>
<dd></dd>
<dt><a href="ui.html#MaxFontColors">MaxFontColors</a></dt>
<dd></dd>
<dt><a href="savegame.html#Missile">Missile</a></dt>
<dd></dd>
<dt><a href="game.html#MoveUnit">MoveUnit</a></dt>
<dd></dd>
<dt><a href="game.html#NewColors">NewColors</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="sound.html#PlaySoundFile">PlaySoundFile</a></dt>
<dd></dd>
<dt><a href="savegame.html#Player">Player</a></dt>
<dd></dd>
<dt><a href="config.html#Preference">Preference</a></dt>
<dd></dd>
<dt><a href="config.html#Preference.ShowAttackRange">Preference.ShowAttackRange</a></dt>
<dd></dd>
<dt><a href="config.html#Preference.ShowOrders">Preference.ShowOrders</a></dt>
<dd></dd>
<dt><a href="config.html#Preference.ShowReactionRange">Preference.ShowReactionRange</a></dt>
<dd></dd>
<dt><a href="config.html#Preference.ShowSightRange">Preference.ShowSightRange</a></dt>
<dd></dd>
<dt><a href="mappresentation.html#PresentMap">PresentMap</a></dt>
<dd></dd>
<dt><a href="savegame.html#ReplayLog">ReplayLog</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="savegame.html#SaveGame">SaveGame</a></dt>
<dd></dd>
<dt><a href="config.html#SavePreferences">SavePreferences</a></dt>
<dd></dd>
<dt><a href="savegame.html#Selection">Selection</a></dt>
<dd></dd>
<dt><a href="mapsetup.html#SetAiType">SetAiType</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#SetChannelStereo">SetChannelStereo</a></dt>
<dd></dd>
<dt><a href="sound.html#SetChannelVolume">SetChannelVolume</a></dt>
<dd></dd>
<dt><a href="config.html#SetClickMissile">SetClickMissile</a></dt>
<dd></dd>
<dt><a href="config.html#SetDamageMissile">SetDamageMissile</a></dt>
<dd></dd>
<dt><a href="game.html#SetDiplomacy">SetDiplomacy</a></dt>
<dd></dd>
<dt><a href="config.html#SetDoubleClickDelay">SetDoubleClickDelay</a></dt>
<dd></dd>
<dt><a href="editor.html#SetEditorPatchIcon">SetEditorPatchIcon</a></dt>
<dd></dd>
<dt><a href="editor.html#SetEditorSelectIcon">SetEditorSelectIcon</a></dt>
<dd></dd>
<dt><a href="editor.html#SetEditorStartUnit">SetEditorStartUnit</a></dt>
<dd></dd>
<dt><a href="editor.html#SetEditorUnitsIcon">SetEditorUnitsIcon</a></dt>
<dd></dd>
<dt><a href="sound.html#SetEffectsEnabled">SetEffectsEnabled</a></dt>
<dd></dd>
<dt><a href="sound.html#SetEffectsVolume">SetEffectsVolume</a></dt>
<dd></dd>
<dt><a href="config.html#SetFogOfWar">SetFogOfWar</a></dt>
<dd></dd>
<dt><a href="config.html#SetFogOfWarGraphics">SetFogOfWarGraphics</a></dt>
<dd></dd>
<dt><a href="ui.html#SetGameCursor">SetGameCursor</a></dt>
<dd></dd>
<dt><a href="game.html#SetGamePaused">SetGamePaused</a></dt>
<dd></dd>
<dt><a href="sound.html#SetGlobalSoundRange">SetGlobalSoundRange</a></dt>
<dd></dd>
<dt><a href="config.html#SetGodMode">SetGodMode</a></dt>
<dd></dd>
<dt><a href="config.html#SetGrabMouse">SetGrabMouse</a></dt>
<dd></dd>
<dt><a href="savegame.html#SetGroupId">SetGroupId</a></dt>
<dd></dd>
<dt><a href="config.html#SetGroupKeys">SetGroupKeys</a></dt>
<dd></dd>
<dt><a href="mapsetup.html#SetHeightMap">SetHeightMap</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#SetLeaveStops">SetLeaveStops</a></dt>
<dd></dd>
<dt><a href="game.html#SetLocalPlayerName">SetLocalPlayerName</a></dt>
<dd></dd>
<dt><a href="mappresentation.html#SetMapMiniImage">SetMapMiniImage</a></dt>
<dd></dd>
<dt><a href="config.html#SetMaxOpenGLTexture">SetMaxOpenGLTexture</a></dt>
<dd></dd>
<dt><a href="config.html#SetMaxSelectable">SetMaxSelectable</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#SetMouseScrollSpeedControl">SetMouseScrollSpeedControl</a></dt>
<dd></dd>
<dt><a href="config.html#SetMouseScrollSpeedDefault">SetMouseScrollSpeedDefault</a></dt>
<dd></dd>
<dt><a href="sound.html#SetMusicEnabled">SetMusicEnabled</a></dt>
<dd></dd>
<dt><a href="sound.html#SetMusicVolume">SetMusicVolume</a></dt>
<dd></dd>
<dt><a href="game.html#SetObjectives">SetObjectives</a></dt>
<dd></dd>
<dt><a href="game.html#SetResourcesHeld">SetResourcesHeld</a></dt>
<dd></dd>
<dt><a href="game.html#SetSharedVision">SetSharedVision</a></dt>
<dd></dd>
<dt><a href="sound.html#SetSoundRange">SetSoundRange</a></dt>
<dd></dd>
<dt><a href="config.html#SetSpeedBuild">SetSpeedBuild</a></dt>
<dd></dd>
<dt><a href="config.html#SetSpeedTrain">SetSpeedTrain</a></dt>
<dd></dd>
<dt><a href="config.html#SetSpeeds">SetSpeeds</a></dt>
<dd></dd>
<dt><a href="mapsetup.html#SetStartView">SetStartView</a></dt>
<dd></dd>
<dt><a href="mapsetup.html#SetTile">SetTile</a></dt>
<dd></dd>
<dt><a href="mapsetup.html#SetTileMap">SetTileMap</a></dt>
<dd></dd>
<dt><a href="config.html#SetTitleScreens">SetTitleScreens</a></dt>
<dd></dd>
<dt><a href="game.html#SetUnitVariable">SetUnitVariable</a></dt>
<dd></dd>
<dt><a href="config.html#SetVideoFullScreen">SetVideoFullScreen</a></dt>
<dd></dd>
<dt><a href="config.html#SetVideoResolution">SetVideoResolution</a></dt>
<dd></dd>
<dt><a href="game.html#SharedVision">SharedVision</a></dt>
<dd></dd>
<dt><a href="savegame.html#SlotUsage">SlotUsage</a></dt>
<dd></dd>
<dt><a href="sound.html#SoundForName">SoundForName</a></dt>
<dd></dd>
<dt><a href="editor.html#StartEditor">StartEditor</a></dt>
<dd></dd>
<dt><a href="editor.html#StartPatchEditor">StartPatchEditor</a></dt>
<dd></dd>
<dt><a href="sound.html#StopAllChannels">StopAllChannels</a></dt>
<dd></dd>
<dt><a href="sound.html#StopChannel">StopChannel</a></dt>
<dd></dd>
<dt><a href="sound.html#StopMusic">StopMusic</a></dt>
<dd></dd>
<dt><a href="savegame.html#StratagusMap">StratagusMap</a></dt>
<dd></dd>
<dt><a href="game.html#SyncRand">SyncRand</a></dt>
<dd></dd>
<dt><a href="ui.html#UI">UI</a></dt>
<dd></dd>
<dt><a href="ui.html#UI.ButtonPanel.ShowCommandKey">UI.ButtonPanel.ShowCommandKey</a></dt>
<dd></dd>
<dt><a href="ui.html#UI.Resources">UI.Resources</a></dt>
<dd></dd>
<dt><a href="ui.html#UI.ReverseFontColor">UI.ReverseFontColor</a></dt>
<dd></dd>
<dt><a href="savegame.html#Unit">Unit</a></dt>
<dd></dd>
<dt><a href="unittype.html#frame_numbers">frame_numbers</a></dt>
<dd></dd>
<dt><a href="config.html#preferences">preferences</a></dt>
<dd></dd>
<dt><a href="ui.html#text_formatting">text_formatting</a></dt>
<dd></dd>
<!-- SCRIPT END -->
</dl>

All trademarks and copyrights on this page are owned by their respective owners.
<address>(c) 2002-2007 by <a href="http://boswars.org">
The Bos Wars Project</a></address></body></html>