Spring - User contributions [en]

Lua SyncedRead

2008-09-07T13:28:20Z

JK:

== Game ==
=== Special TeamID Variables ===
(those special TeamIDs are not supported by all functions) 
'''Spring.ALL_UNITS''' 
'''Spring.MY_UNITS''' 
'''Spring.ALLY_UNITS''' 
'''Spring.ENEMY_UNITS'''

'''Spring.GetGaiaTeamID'''
( ) -> number teamID

=== GameStates ===
'''Spring.IsGodModeEnabled'''
( ) -> boolean
'''Spring.IsCheatingEnabled'''
( ) -> boolean
'''Spring.IsDevLuaEnabled'''
( ) -> boolean
'''Spring.IsEditDefsEnabled'''
( ) -> boolean
'''Spring.AreHelperAIsEnabled'''
( ) -> boolean

'''Spring.IsGameOver'''
( ) -> boolean

=== Rules ===
'''Spring.GetRulesInfoMap'''
( ) -> { [key1] = string value1, [key2] = string value2, ... }
( string "key" ) -> string

'''Spring.GetGameRulesParam'''
( number index | string ruleName ) -> number value
'''Spring.GetGameRulesParams'''
( ) -> { [rule1] = number value1, [rule2] = number value2, ... }

'''Spring.GetTeamRulesParam'''
( number teamID, number index | string ruleName ) -> nil | number value
'''Spring.GetTeamRulesParams'''
( number teamID ) -> nil | { [rule1] = number value1, [rule2] = number value2, ... }

'''Spring.GetUnitRulesParam'''
( number unitID, number index | string ruleName ) -> nil | number value
'''Spring.GetUnitRulesParams'''
( number unitID ) -> nil | { [rule1] = number value1, [rule2] = number value2, ... }

=== Mod-/Map-Options ===
'''Spring.GetModOptions'''
( ) -> {} | { "keyName1" = string "value", "keyName2" = string "value", ... }
'''Spring.GetMapOptions'''
( ) -> {} | { "keyName1" = string "value", "keyName2" = string "value", ... }

=== Speed/Time ===
'''Spring.GetGameSpeed'''
( ) -> number userSpeedFactor, number speedFactor, boolean paused
'''Spring.GetGameFrame'''
( ) -> number frameNum%dayFrames, number frameNum/dayFrames
'''Spring.GetGameSeconds'''
( ) -> number seconds

=== Vectors ===
'''Spring.GetWind'''
( ) -> number dirX, number dirY, number dirZ,
number strength, number normDirX, number normDirY, number normDirZ

'''Spring.GetHeadingFromVector'''
( number x, number z ) -> number heading
'''Spring.GetVectorFromHeading'''
( number heading ) -> number x, number z

== Teams ==
=== StartBoxes/StartPositions ===
'''Spring.GetAllyTeamStartBox'''
( number allyID ) -> nil | number xmin, number zmin, number xmax, number zmax
'''Spring.GetTeamStartPosition'''
( number teamID ) -> nil | number x, number y, number z

=== Player,Team,Ally Lists/Info ===
'''Spring.GetPlayerList'''
( [number teamID, boolean onlyActive] ) -> nil | { [1] = number playerID, etc... }
'''Spring.GetTeamList'''
( [number allyTeamID] ) -> nil | { [1] = number teamID, etc... }
'''Spring.GetAllyTeamList'''
( ) -> { [1] = number allyTeamID, etc... }

'''Spring.GetPlayerInfo'''
( number playerID ) ->
nil | string "name", (in synced code this is "SYNCED_NONAME"!)
boolean active,
boolean spectator,
number teamID,
number allyTeamID,
number pingTime,
number cpuUsage,
string country,
number rank
'''Spring.GetPlayerControlledUnit'''
( number playerID ) -> nil | number unitID

'''Spring.GetTeamInfo'''
( number teamID ) ->
nil | number teamNum,
number leader,
boolean isDead,
boolean isAiTeam,
string "side",
number allyTeam
'''Spring.GetTeamResources'''
( number teamID, string "metal" | "energy" ) ->
nil | number currentLevel,
number storage,
number pull,
number income,
number expense,
number share,
number sent,
number received
'''Spring.GetTeamUnitStats'''
( number teamID ) ->
nil | number killed,
number died,
number capturedBy,
number capturedFrom,
number received,
number sent
'''Spring.GetTeamStatsHistory'''
( number teamID, number startTime, number endTime ) ->
{
[1] = {
"frame" = number,
"metalUsed" = number,
"metalProduced" = number,
"metalExcess" = number,
"metalReceived" = number,
"metalSent" = number,
"energyUsed" = number,
"energyProduced" = number,
"energyExcess" = number,
"energyReceived" = number,
"energySent" = number,
"damageDealt" = number,
"damageReceived" = number,
"unitsProduced" = number,
"unitsDied" = number,
"unitsReceived" = number,
"unitsSent" = number,
"unitsCaptured" = number,
"unitsOutCaptured" = number,
"unitsKilled" = number
}, ...
}
'''Spring.GetTeamLuaAI'''
( number teamID ) -> string "luaAI"

=== Teams/PlayersAllied ===
'''Spring.AreTeamsAllied'''
( number teamID1, number teamID2 ) -> nil | boolean
'''Spring.ArePlayersAllied'''
( number playerID1, number playerID2 ) -> nil | boolean

== Units ==
=== GetUnits ===
'''Spring.GetAllUnits'''
( ) -> nil | unitTable = { [1] = number unitID, ... }
'''Spring.GetTeamUnits'''
( number teamID ) -> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetTeamUnitsSorted'''
( number teamID ) -> nil |
unitDefTable = {
[number unitDefID] = { [1] = [number unitID], etc... },
etc...
}
'''Spring.GetTeamUnitsCounts'''
( number teamID ) -> nil | countTable = { [number unitDefID] = count, etc... }
'''Spring.GetTeamUnitsByDefs'''
( number teamID, number unitDefID | { number unitDefID1, ... } )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetTeamUnitDefCount'''
( number teamID, number unitDefID ) -> nil | number count
'''Spring.GetTeamUnitCount'''
( number teamID ) -> nil | number count

'''Spring.GetUnitsInRectangle'''
( number xmin, number zmin, number xmax, number zmax [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInBox'''
( number xmin, number ymin, number zmin,
number xmax, number ymax, number zmax [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInSphere'''
( number x, number y, number z, number radius [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInCylinder'''
( number x, number z, number radius [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInPlanes'''
( planes = { [1] = { number nx, number ny, number nz, number d }, etc... } )
-> nil | unitTable = { [1] = number unitID, etc... }

plane normals point towards accepted space,
so the acceptance criteria for each plane is:
radius = unit radius
px, py, pz = unit position
[(nx * px) + (ny * py) + (nz * pz) + (d - radius)] <= 0


'''Spring.GetUnitNearestAlly'''
( number unitID [, number range ] ) -> nil | number unitID
'''Spring.GetUnitNearestEnemy'''
( number unitID [, number range ] ) -> nil | number unitID

=== Unit Informations ===
'''Spring.GetUnitTooltip'''
( number unitID ) -> nil | string tooltip
'''Spring.GetUnitDefID'''
( number unitID ) -> nil | number unitDefID
'''Spring.GetUnitTeam'''
( number unitID ) -> nil | number teamID
'''Spring.GetUnitAllyTeam'''
( number unitID ) -> nil | number allyID
'''Spring.GetUnitLineage'''
( number unitID ) -> nil | number lineage, boolean lineageRoot
'''Spring.GetUnitNeutral'''
( number unitID ) -> nil | boolean neutral
'''Spring.GetUnitHealth'''
( number unitID ) -> nil | number health, number maxHealth, number paralyzeDamage,
number captureProgress, number buildProgress
'''Spring.GetUnitIsDead'''
( number unitID ) -> nil | boolean dead
'''Spring.GetUnitIsStunned'''
( number unitID ) -> nil | boolean stunned_or_inbuild, boolean stunned, boolean inbuild
'''Spring.GetUnitResources'''
( number unitID ) -> nil | number metalMake, number metalUse,
number energyMake, number energyUse
'''Spring.GetUnitExperience'''
( number unitID ) -> nil | number experience
'''Spring.GetUnitStates'''
( number unitID ) -> nil | {
"firestate" = number,
"movestate" = number,
"repeat" = boolean,
"cloak" = boolean,
"active" = boolean,
"trajectory" = boolean,
["autoland" = boolean,]
["autorepairlevel" = number,]
["loopbackattack" = boolean]
}
'''Spring.GetUnitIsActive'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitIsCloaked'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitSelfDTime'''
( number unitID ) -> nil | number
'''Spring.GetUnitStockpile'''
( number unitID ) -> nil | number numStockpiled, number numStockpileQued,
number buildPercent
'''Spring.GetUnitHeight'''
( number unitID ) -> nil | number
'''Spring.GetUnitRadius'''
( number unitID ) -> nil | number
'''Spring.GetUnitPosition'''
( number unitID ) -> nil | number x, number y, number z
'''Spring.GetUnitBasePosition'''
( number unitID ) -> nil | number x, number y, number z
'''Spring.GetUnitDirection'''
( number unitID ) -> nil | number dx, number dy, number dz
'''Spring.GetUnitHeading'''
( number unitID ) -> nil | number heading
'''Spring.GetUnitVelocity'''
( number unitID ) -> nil | number velx, number vely, number velz
'''Spring.GetUnitBuildFacing'''
( number unitID ) -> nil | number
'''Spring.GetUnitIsBuilding'''
( number unitID ) -> nil | number unitID
'''Spring.GetUnitTransporter'''
( number unitID ) -> nil | number unitID
'''Spring.GetUnitIsTransporting'''
( number unitID ) -> nil | { [1] = number unitID, etc... }
'''Spring.GetUnitShieldState'''
( number unitID ) -> nil | number isEnabled, number curPower
'''Spring.GetUnitWeaponState'''
( number unitID [, number weaponNum] ) -> nil |
boolean angleGood, boolean loaded, number reloadFrame, number salvoLeft, number numStockpiled
'''Spring.GetUnitTravel'''
( number unitID ) -> nil | number travel, number travelPeriod
'''Spring.GetUnitLosState'''
( number unitID [, number allyTeamID ] ) -> nil |
{ ["los" = true] [, "radar" = true] [, "typed" = true] }
'''Spring.GetUnitSeparation''' (returns the distance of 2 units)
( number unitID1, number unitID2 [, boolean 2D ] ) -> nil | number distance
'''Spring.GetUnitDefDimensions'''
( number unitDefID ) -> nil |
{
"height" = number,
"radius" = number,
"midx" = number,
"minx" = number,
"maxx" = number,
"midy" = number,
"miny" = number,
"maxy" = number,
"midz" = number,
"minz" = number,
"maxz" = number
}

=== CommandQueues ===

'''Spring.GetUnitCommands'''
( number unitID [, number count] ) -> nil | commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean
}
}, ...
}

'''Spring.GetCommandQueue''' (same as Spring.GetUnitCommands)
( number unitID [, number count] ) -> nil | commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean
}
}, ...
}
'''Spring.GetFullBuildQueue'''
( number unitID ) ->
nil | buildOrders = {
[1] = { [number unitDefID] = number count }, etc...
}
'''Spring.GetRealBuildQueue''' (cleans the buildqueue of things the unit can't build itself)
( number unitID ) ->
nil | buildOrders = {
[1] = { [number unitDefID] = number count }, etc...
}
'''Spring.GetFactoryCommands'''
( number unitID [, number count] ) -> nil | commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean
}
}, ...
}
'''Spring.GetFactoryCounts''' (used to get the buildqueue of a factory, seems screwed o_O)
( number unitID [, number count [, boolean addCMDs ] ] ) -> nil | commandQueueTable = {
[2] = { [number unitDefID | number -cmdID] = number count }, ...
}

=== Command Descriptions/Buttons ===
'''Spring.GetUnitCmdDescs'''
( number unitID [, number startIndex [, number endIndex ] ] ) -> nil | {
[1] = {
"id" = number,
"type" = number,
"name" = string,
"action" = string,
"tooltip" = string,
"texture" = string,
"cursor" = string,
"hidden" = boolean,
"disabled" = boolean,
"showUnique" = boolean,
"onlyTexture" = boolean,

"params" = { [1] = string, ... }
}, ...
}
'''Spring.FindUnitCmdDesc'''
( number unitID, number cmdID ) -> nil | number index

=== Unit Pieces ===
'''Spring.GetUnitPiecePosition'''
( number unitID, number piece ) -> number posx, number posy, number posz
'''Spring.GetUnitPieceDirection'''
( number unitID, number piece ) -> number dirx, number diry, number dirz
'''Spring.GetUnitPieceMatrix'''
( number unitID, number piece ) -> { [1] = number, ... , [16] = number }
'''Spring.GetUnitPieceList'''
( number unitID ) -> { [1] = string "piecename", ... , [pieceNumN] = string "piecename" }
'''Spring.GetUnitPieceMap'''
( number unitID ) -> { "piecename1" = pieceNum1, ... , "piecenameN" = pieceNumN }
'''Spring.GetUnitPieceInfo'''
( number unitID, number piece ) -> {
"name" = string "piecename",
"isEmpty" = boolean,
"children" = { [1] = string "piecename", ... },
"min" = { [1] = number x, [2] = number y, [3] = number z },
"max" = { [1] = number x, [2] = number y, [3] = number z },
"offset" = { [1] = number x, [2] = number y, [3] = number z },
}
'''Spring.GetUnitScriptPiece'''
( number unitID [, number scriptPiece ] )
-> nil | { scriptPieceNum = number modelPieceNum } | number modelPieceNum

This functions translate the COB ScriptPiece numbers into the ModelPiece numbers (the set of
ScriptPieces is a subset of the ModelPieces, means #ScriptPieces <= #ModelPieces), which
is used in all other functions (the "number piece" means always the modelpiece).
So if you get via Cob2Lua a pieceID you have to translate it with this function.
Btw the COB ScriptPiece number is equal with the piece position in the piece definition
in your cob/bos.
'''Spring.GetUnitScriptNames'''
( number unitID )
-> { "cobpiecename1" = ScriptPieceNum1, ... , "cobpiecenameN" = ScriptPieceNumN }

== Features ==
=== GetFeatures ===
'''Spring.GetFeaturesInRectangle'''
( number xmin, number zmin, number xmax, number zmax [,number teamID] )
-> nil | featureTable = { [1] = number featureID, etc... }
'''Spring.GetAllFeatures'''
( ) -> nil | { [1] = number featureID, ... }
'''Spring.GetFeatureList''' // NOTE: this is not really required, now all FeatureDefs are pre-loaded

=== Feature Informations ===
'''Spring.GetFeatureDefID'''
( number featureID ) -> nil | number featureDefID
'''Spring.GetFeatureTeam'''
( number featureID ) -> nil | number teamID
'''Spring.GetFeatureAllyTeam'''
( number featureID ) -> nil | number allyID
'''Spring.GetFeatureHealth'''
( number featureID ) -> nil | number health, number maxHealth, number resurrectProgress
'''Spring.GetFeatureHeight'''
( number featureID ) -> nil | number
'''Spring.GetFeatureRadius'''
( number featureID ) -> nil | number
'''Spring.GetFeaturePosition'''
( number featureID ) -> nil | number x, number y, number z
'''Spring.GetFeatureDirection'''
( number featureID ) -> nil | number dirx, number diry, number dirz
'''Spring.GetFeatureHeading'''
( number featureID ) -> nil | number heading
'''Spring.GetFeatureResources'''
( number featureID ) -> nil | number RemainingMetal, number maxMetal,
number RemainingEnergy, number maxEnergy, number reclaimLeft
'''Spring.GetFeatureNoSelect'''
( number featureID ) -> nil | boolean noSelect
'''Spring.GetFeatureResurrect'''
( number featureID ) -> nil | string UnitDefName, number buildFacing

== COB ==
'''Spring.GetCOBUnitVar'''
( number unitID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBTeamVar'''
( number teamID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBAllyTeamVar'''
( number allyID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBGlobalVar'''
( integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY

== Ground ==
=== Ground Informations ===
'''Spring.GetGroundHeight'''
( number x, number y ) -> number z
'''Spring.GetGroundOrigHeight'''
( number x, number y ) -> number z
'''Spring.GetGroundNormal'''
( number x, number y ) -> number x, number y, number z
'''Spring.GetGroundInfo'''
( number x, number y ) -> string "Type", number metal, number hardness,
number tankSpeed, number kbotSpeed, number hoverSpeed,
number shipSpeed, boolean receiveTracks
'''Spring.GetGroundBlocked'''
( number x, number y |
number x1, number y1, number x2, number y2 )
-> nil | string "feature", number featureID | string "unit", number unitID
'''Spring.GetGroundExtremes'''
( ) -> nil | number minHeight, number maxHeight

=== Test Building ===
'''Spring.TestBuildOrder'''
( number unitDefID, number x, number y, number z, number facing)
-> number blocking [,number featureID]

blocking can be:
0 - blocked
1 - mobile unit in the way
2 - free (or if featureID is != 0 then with a blocking feature that can be reclaimed)
'''Spring.Pos2BuildPos'''
( number unitDefID, number x, number y, number z ) -> nil | number x, number y, number z

=== PathFinding ===
'''Spring.GetUnitEstimatedPath'''
( number unitID ) -> nil | {
[1] = { x,y,z }, ...
},{
[1] = startIdxOfDetailedPath,
[2] = startIdxOfDetailedEstimatedPath1,
[3] = startIdxOfDetailedEstimatedPath2,
}
GetUnitEstimatedPath() returns 2 tables:
1 table the waypoints and 1 table with indices (in the waypoint table)
when a new (more lazy) pathfinding algorithm begins.
So the waypoint table contains 3 different levels of details.

=== LOS ===
'''Spring.GetPositionLosState'''
( number x, number y, number z [, number allyID] )
-> boolean visible, boolean inLos, boolean inAirLos, boolean inRadar
'''Spring.GetClosestValidPosition''' //NOT FINISHED YET
( number unitDefID, number x, number z, number r ) -> nil

Lua SyncedRead

2008-09-07T13:27:57Z

JK:

== Game ==
=== Special TeamID Variables ===
(except those special TeamIDs are not supported by all functions) 
'''Spring.ALL_UNITS''' 
'''Spring.MY_UNITS''' 
'''Spring.ALLY_UNITS''' 
'''Spring.ENEMY_UNITS'''

'''Spring.GetGaiaTeamID'''
( ) -> number teamID

=== GameStates ===
'''Spring.IsGodModeEnabled'''
( ) -> boolean
'''Spring.IsCheatingEnabled'''
( ) -> boolean
'''Spring.IsDevLuaEnabled'''
( ) -> boolean
'''Spring.IsEditDefsEnabled'''
( ) -> boolean
'''Spring.AreHelperAIsEnabled'''
( ) -> boolean

'''Spring.IsGameOver'''
( ) -> boolean

=== Rules ===
'''Spring.GetRulesInfoMap'''
( ) -> { [key1] = string value1, [key2] = string value2, ... }
( string "key" ) -> string

'''Spring.GetGameRulesParam'''
( number index | string ruleName ) -> number value
'''Spring.GetGameRulesParams'''
( ) -> { [rule1] = number value1, [rule2] = number value2, ... }

'''Spring.GetTeamRulesParam'''
( number teamID, number index | string ruleName ) -> nil | number value
'''Spring.GetTeamRulesParams'''
( number teamID ) -> nil | { [rule1] = number value1, [rule2] = number value2, ... }

'''Spring.GetUnitRulesParam'''
( number unitID, number index | string ruleName ) -> nil | number value
'''Spring.GetUnitRulesParams'''
( number unitID ) -> nil | { [rule1] = number value1, [rule2] = number value2, ... }

=== Mod-/Map-Options ===
'''Spring.GetModOptions'''
( ) -> {} | { "keyName1" = string "value", "keyName2" = string "value", ... }
'''Spring.GetMapOptions'''
( ) -> {} | { "keyName1" = string "value", "keyName2" = string "value", ... }

=== Speed/Time ===
'''Spring.GetGameSpeed'''
( ) -> number userSpeedFactor, number speedFactor, boolean paused
'''Spring.GetGameFrame'''
( ) -> number frameNum%dayFrames, number frameNum/dayFrames
'''Spring.GetGameSeconds'''
( ) -> number seconds

=== Vectors ===
'''Spring.GetWind'''
( ) -> number dirX, number dirY, number dirZ,
number strength, number normDirX, number normDirY, number normDirZ

'''Spring.GetHeadingFromVector'''
( number x, number z ) -> number heading
'''Spring.GetVectorFromHeading'''
( number heading ) -> number x, number z

== Teams ==
=== StartBoxes/StartPositions ===
'''Spring.GetAllyTeamStartBox'''
( number allyID ) -> nil | number xmin, number zmin, number xmax, number zmax
'''Spring.GetTeamStartPosition'''
( number teamID ) -> nil | number x, number y, number z

=== Player,Team,Ally Lists/Info ===
'''Spring.GetPlayerList'''
( [number teamID, boolean onlyActive] ) -> nil | { [1] = number playerID, etc... }
'''Spring.GetTeamList'''
( [number allyTeamID] ) -> nil | { [1] = number teamID, etc... }
'''Spring.GetAllyTeamList'''
( ) -> { [1] = number allyTeamID, etc... }

'''Spring.GetPlayerInfo'''
( number playerID ) ->
nil | string "name", (in synced code this is "SYNCED_NONAME"!)
boolean active,
boolean spectator,
number teamID,
number allyTeamID,
number pingTime,
number cpuUsage,
string country,
number rank
'''Spring.GetPlayerControlledUnit'''
( number playerID ) -> nil | number unitID

'''Spring.GetTeamInfo'''
( number teamID ) ->
nil | number teamNum,
number leader,
boolean isDead,
boolean isAiTeam,
string "side",
number allyTeam
'''Spring.GetTeamResources'''
( number teamID, string "metal" | "energy" ) ->
nil | number currentLevel,
number storage,
number pull,
number income,
number expense,
number share,
number sent,
number received
'''Spring.GetTeamUnitStats'''
( number teamID ) ->
nil | number killed,
number died,
number capturedBy,
number capturedFrom,
number received,
number sent
'''Spring.GetTeamStatsHistory'''
( number teamID, number startTime, number endTime ) ->
{
[1] = {
"frame" = number,
"metalUsed" = number,
"metalProduced" = number,
"metalExcess" = number,
"metalReceived" = number,
"metalSent" = number,
"energyUsed" = number,
"energyProduced" = number,
"energyExcess" = number,
"energyReceived" = number,
"energySent" = number,
"damageDealt" = number,
"damageReceived" = number,
"unitsProduced" = number,
"unitsDied" = number,
"unitsReceived" = number,
"unitsSent" = number,
"unitsCaptured" = number,
"unitsOutCaptured" = number,
"unitsKilled" = number
}, ...
}
'''Spring.GetTeamLuaAI'''
( number teamID ) -> string "luaAI"

=== Teams/PlayersAllied ===
'''Spring.AreTeamsAllied'''
( number teamID1, number teamID2 ) -> nil | boolean
'''Spring.ArePlayersAllied'''
( number playerID1, number playerID2 ) -> nil | boolean

== Units ==
=== GetUnits ===
'''Spring.GetAllUnits'''
( ) -> nil | unitTable = { [1] = number unitID, ... }
'''Spring.GetTeamUnits'''
( number teamID ) -> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetTeamUnitsSorted'''
( number teamID ) -> nil |
unitDefTable = {
[number unitDefID] = { [1] = [number unitID], etc... },
etc...
}
'''Spring.GetTeamUnitsCounts'''
( number teamID ) -> nil | countTable = { [number unitDefID] = count, etc... }
'''Spring.GetTeamUnitsByDefs'''
( number teamID, number unitDefID | { number unitDefID1, ... } )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetTeamUnitDefCount'''
( number teamID, number unitDefID ) -> nil | number count
'''Spring.GetTeamUnitCount'''
( number teamID ) -> nil | number count

'''Spring.GetUnitsInRectangle'''
( number xmin, number zmin, number xmax, number zmax [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInBox'''
( number xmin, number ymin, number zmin,
number xmax, number ymax, number zmax [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInSphere'''
( number x, number y, number z, number radius [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInCylinder'''
( number x, number z, number radius [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInPlanes'''
( planes = { [1] = { number nx, number ny, number nz, number d }, etc... } )
-> nil | unitTable = { [1] = number unitID, etc... }

plane normals point towards accepted space,
so the acceptance criteria for each plane is:
radius = unit radius
px, py, pz = unit position
[(nx * px) + (ny * py) + (nz * pz) + (d - radius)] <= 0


'''Spring.GetUnitNearestAlly'''
( number unitID [, number range ] ) -> nil | number unitID
'''Spring.GetUnitNearestEnemy'''
( number unitID [, number range ] ) -> nil | number unitID

=== Unit Informations ===
'''Spring.GetUnitTooltip'''
( number unitID ) -> nil | string tooltip
'''Spring.GetUnitDefID'''
( number unitID ) -> nil | number unitDefID
'''Spring.GetUnitTeam'''
( number unitID ) -> nil | number teamID
'''Spring.GetUnitAllyTeam'''
( number unitID ) -> nil | number allyID
'''Spring.GetUnitLineage'''
( number unitID ) -> nil | number lineage, boolean lineageRoot
'''Spring.GetUnitNeutral'''
( number unitID ) -> nil | boolean neutral
'''Spring.GetUnitHealth'''
( number unitID ) -> nil | number health, number maxHealth, number paralyzeDamage,
number captureProgress, number buildProgress
'''Spring.GetUnitIsDead'''
( number unitID ) -> nil | boolean dead
'''Spring.GetUnitIsStunned'''
( number unitID ) -> nil | boolean stunned_or_inbuild, boolean stunned, boolean inbuild
'''Spring.GetUnitResources'''
( number unitID ) -> nil | number metalMake, number metalUse,
number energyMake, number energyUse
'''Spring.GetUnitExperience'''
( number unitID ) -> nil | number experience
'''Spring.GetUnitStates'''
( number unitID ) -> nil | {
"firestate" = number,
"movestate" = number,
"repeat" = boolean,
"cloak" = boolean,
"active" = boolean,
"trajectory" = boolean,
["autoland" = boolean,]
["autorepairlevel" = number,]
["loopbackattack" = boolean]
}
'''Spring.GetUnitIsActive'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitIsCloaked'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitSelfDTime'''
( number unitID ) -> nil | number
'''Spring.GetUnitStockpile'''
( number unitID ) -> nil | number numStockpiled, number numStockpileQued,
number buildPercent
'''Spring.GetUnitHeight'''
( number unitID ) -> nil | number
'''Spring.GetUnitRadius'''
( number unitID ) -> nil | number
'''Spring.GetUnitPosition'''
( number unitID ) -> nil | number x, number y, number z
'''Spring.GetUnitBasePosition'''
( number unitID ) -> nil | number x, number y, number z
'''Spring.GetUnitDirection'''
( number unitID ) -> nil | number dx, number dy, number dz
'''Spring.GetUnitHeading'''
( number unitID ) -> nil | number heading
'''Spring.GetUnitVelocity'''
( number unitID ) -> nil | number velx, number vely, number velz
'''Spring.GetUnitBuildFacing'''
( number unitID ) -> nil | number
'''Spring.GetUnitIsBuilding'''
( number unitID ) -> nil | number unitID
'''Spring.GetUnitTransporter'''
( number unitID ) -> nil | number unitID
'''Spring.GetUnitIsTransporting'''
( number unitID ) -> nil | { [1] = number unitID, etc... }
'''Spring.GetUnitShieldState'''
( number unitID ) -> nil | number isEnabled, number curPower
'''Spring.GetUnitWeaponState'''
( number unitID [, number weaponNum] ) -> nil |
boolean angleGood, boolean loaded, number reloadFrame, number salvoLeft, number numStockpiled
'''Spring.GetUnitTravel'''
( number unitID ) -> nil | number travel, number travelPeriod
'''Spring.GetUnitLosState'''
( number unitID [, number allyTeamID ] ) -> nil |
{ ["los" = true] [, "radar" = true] [, "typed" = true] }
'''Spring.GetUnitSeparation''' (returns the distance of 2 units)
( number unitID1, number unitID2 [, boolean 2D ] ) -> nil | number distance
'''Spring.GetUnitDefDimensions'''
( number unitDefID ) -> nil |
{
"height" = number,
"radius" = number,
"midx" = number,
"minx" = number,
"maxx" = number,
"midy" = number,
"miny" = number,
"maxy" = number,
"midz" = number,
"minz" = number,
"maxz" = number
}

=== CommandQueues ===

'''Spring.GetUnitCommands'''
( number unitID [, number count] ) -> nil | commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean
}
}, ...
}

'''Spring.GetCommandQueue''' (same as Spring.GetUnitCommands)
( number unitID [, number count] ) -> nil | commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean
}
}, ...
}
'''Spring.GetFullBuildQueue'''
( number unitID ) ->
nil | buildOrders = {
[1] = { [number unitDefID] = number count }, etc...
}
'''Spring.GetRealBuildQueue''' (cleans the buildqueue of things the unit can't build itself)
( number unitID ) ->
nil | buildOrders = {
[1] = { [number unitDefID] = number count }, etc...
}
'''Spring.GetFactoryCommands'''
( number unitID [, number count] ) -> nil | commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean
}
}, ...
}
'''Spring.GetFactoryCounts''' (used to get the buildqueue of a factory, seems screwed o_O)
( number unitID [, number count [, boolean addCMDs ] ] ) -> nil | commandQueueTable = {
[2] = { [number unitDefID | number -cmdID] = number count }, ...
}

=== Command Descriptions/Buttons ===
'''Spring.GetUnitCmdDescs'''
( number unitID [, number startIndex [, number endIndex ] ] ) -> nil | {
[1] = {
"id" = number,
"type" = number,
"name" = string,
"action" = string,
"tooltip" = string,
"texture" = string,
"cursor" = string,
"hidden" = boolean,
"disabled" = boolean,
"showUnique" = boolean,
"onlyTexture" = boolean,

"params" = { [1] = string, ... }
}, ...
}
'''Spring.FindUnitCmdDesc'''
( number unitID, number cmdID ) -> nil | number index

=== Unit Pieces ===
'''Spring.GetUnitPiecePosition'''
( number unitID, number piece ) -> number posx, number posy, number posz
'''Spring.GetUnitPieceDirection'''
( number unitID, number piece ) -> number dirx, number diry, number dirz
'''Spring.GetUnitPieceMatrix'''
( number unitID, number piece ) -> { [1] = number, ... , [16] = number }
'''Spring.GetUnitPieceList'''
( number unitID ) -> { [1] = string "piecename", ... , [pieceNumN] = string "piecename" }
'''Spring.GetUnitPieceMap'''
( number unitID ) -> { "piecename1" = pieceNum1, ... , "piecenameN" = pieceNumN }
'''Spring.GetUnitPieceInfo'''
( number unitID, number piece ) -> {
"name" = string "piecename",
"isEmpty" = boolean,
"children" = { [1] = string "piecename", ... },
"min" = { [1] = number x, [2] = number y, [3] = number z },
"max" = { [1] = number x, [2] = number y, [3] = number z },
"offset" = { [1] = number x, [2] = number y, [3] = number z },
}
'''Spring.GetUnitScriptPiece'''
( number unitID [, number scriptPiece ] )
-> nil | { scriptPieceNum = number modelPieceNum } | number modelPieceNum

This functions translate the COB ScriptPiece numbers into the ModelPiece numbers (the set of
ScriptPieces is a subset of the ModelPieces, means #ScriptPieces <= #ModelPieces), which
is used in all other functions (the "number piece" means always the modelpiece).
So if you get via Cob2Lua a pieceID you have to translate it with this function.
Btw the COB ScriptPiece number is equal with the piece position in the piece definition
in your cob/bos.
'''Spring.GetUnitScriptNames'''
( number unitID )
-> { "cobpiecename1" = ScriptPieceNum1, ... , "cobpiecenameN" = ScriptPieceNumN }

== Features ==
=== GetFeatures ===
'''Spring.GetFeaturesInRectangle'''
( number xmin, number zmin, number xmax, number zmax [,number teamID] )
-> nil | featureTable = { [1] = number featureID, etc... }
'''Spring.GetAllFeatures'''
( ) -> nil | { [1] = number featureID, ... }
'''Spring.GetFeatureList''' // NOTE: this is not really required, now all FeatureDefs are pre-loaded

=== Feature Informations ===
'''Spring.GetFeatureDefID'''
( number featureID ) -> nil | number featureDefID
'''Spring.GetFeatureTeam'''
( number featureID ) -> nil | number teamID
'''Spring.GetFeatureAllyTeam'''
( number featureID ) -> nil | number allyID
'''Spring.GetFeatureHealth'''
( number featureID ) -> nil | number health, number maxHealth, number resurrectProgress
'''Spring.GetFeatureHeight'''
( number featureID ) -> nil | number
'''Spring.GetFeatureRadius'''
( number featureID ) -> nil | number
'''Spring.GetFeaturePosition'''
( number featureID ) -> nil | number x, number y, number z
'''Spring.GetFeatureDirection'''
( number featureID ) -> nil | number dirx, number diry, number dirz
'''Spring.GetFeatureHeading'''
( number featureID ) -> nil | number heading
'''Spring.GetFeatureResources'''
( number featureID ) -> nil | number RemainingMetal, number maxMetal,
number RemainingEnergy, number maxEnergy, number reclaimLeft
'''Spring.GetFeatureNoSelect'''
( number featureID ) -> nil | boolean noSelect
'''Spring.GetFeatureResurrect'''
( number featureID ) -> nil | string UnitDefName, number buildFacing

== COB ==
'''Spring.GetCOBUnitVar'''
( number unitID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBTeamVar'''
( number teamID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBAllyTeamVar'''
( number allyID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBGlobalVar'''
( integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY

== Ground ==
=== Ground Informations ===
'''Spring.GetGroundHeight'''
( number x, number y ) -> number z
'''Spring.GetGroundOrigHeight'''
( number x, number y ) -> number z
'''Spring.GetGroundNormal'''
( number x, number y ) -> number x, number y, number z
'''Spring.GetGroundInfo'''
( number x, number y ) -> string "Type", number metal, number hardness,
number tankSpeed, number kbotSpeed, number hoverSpeed,
number shipSpeed, boolean receiveTracks
'''Spring.GetGroundBlocked'''
( number x, number y |
number x1, number y1, number x2, number y2 )
-> nil | string "feature", number featureID | string "unit", number unitID
'''Spring.GetGroundExtremes'''
( ) -> nil | number minHeight, number maxHeight

=== Test Building ===
'''Spring.TestBuildOrder'''
( number unitDefID, number x, number y, number z, number facing)
-> number blocking [,number featureID]

blocking can be:
0 - blocked
1 - mobile unit in the way
2 - free (or if featureID is != 0 then with a blocking feature that can be reclaimed)
'''Spring.Pos2BuildPos'''
( number unitDefID, number x, number y, number z ) -> nil | number x, number y, number z

=== PathFinding ===
'''Spring.GetUnitEstimatedPath'''
( number unitID ) -> nil | {
[1] = { x,y,z }, ...
},{
[1] = startIdxOfDetailedPath,
[2] = startIdxOfDetailedEstimatedPath1,
[3] = startIdxOfDetailedEstimatedPath2,
}
GetUnitEstimatedPath() returns 2 tables:
1 table the waypoints and 1 table with indices (in the waypoint table)
when a new (more lazy) pathfinding algorithm begins.
So the waypoint table contains 3 different levels of details.

=== LOS ===
'''Spring.GetPositionLosState'''
( number x, number y, number z [, number allyID] )
-> boolean visible, boolean inLos, boolean inAirLos, boolean inRadar
'''Spring.GetClosestValidPosition''' //NOT FINISHED YET
( number unitDefID, number x, number z, number r ) -> nil

Lua UnitRendering

2008-08-28T10:28:42Z

JK: /* Unit Rendering */

==Unit Rendering==
'''Spring.UnitRendering.SetLODCount'''
( number unitID, int lodCount ) -> nil

'''Spring.UnitRendering.SetLODLength''' (`lod` is 1-indexed)
( number unitID, int lod, number lodLength ) -> nil

'''Spring.UnitRendering.SetLODDistance''' (same as SetLODLength(), but adjusted for 45deg FOV + 1024x768)
(number unitID, int lod, number lodDistance ) -> nil

'''Spring.UnitRendering.SetPieceList''' (displayList=nil reset to default)
( number unitID, int lod, int piece [, number displayList = nil ] ) -> nil

'''Spring.UnitRendering.GetMaterial''' (creates a material userdata)
( [[Lua_UnitRendering#MaterialType|string MaterialType]], [[Lua_UnitRendering#Material_Table|table Material]] ) -> [[Lua_UnitRendering#Material_UserData|userdata Material]]

'''Spring.UnitRendering.SetMaterial'''
( number unitID, int lod, [[Lua_UnitRendering#MaterialType|string MaterialType]], [[Lua_UnitRendering#Material_UserData|userdata Material]] | [[Lua_UnitRendering#Material_Table|table Material]] ) -> nil

'''Spring.UnitRendering.SetMaterialLastLOD'''
( number unitID, s[[Lua_UnitRendering#MaterialType|string MaterialType]], int lastLOD ) -> nil

'''Spring.UnitRendering.SetMaterialDisplayLists'''
( number unitID, int lod, [[Lua_UnitRendering#MaterialType|string MaterialType]], [[Lua_OpenGL_Api#Display_Lists|preDisplayList]], [[Lua_OpenGL_Api#Display_Lists|postDisplayList]] ) -> nil

'''Spring.UnitRendering.SetUnitUniform''' (unfinished)
( number unitID, [[Lua_UnitRendering#MaterialType|string MaterialType]], int lod, arg1, arg2, ... ) -> nil

'''Spring.UnitRendering.SetUnitLuaDraw''' (enables the DrawUnit callin)
( number unitID, boolean enabled ) -> nil

'''Spring.UnitRendering.Debug''' (prints some usefull debug informations)
( [ number unitID ] ) -> nil

==MaterialTypes==
"alpha"
"opaque"
"alpha_reflect"
"opaque_reflect"
"shadow"

==Material UserData==
none user accessible methods (yet)

==Material Table==
material = {
["order" = number ,]
["shader" = [[Lua_GLSL_Api|lua_shader]] | string "3do" | string "s3o" ,]

["texunits" = {
[ [0] = { ["tex" = [[Lua_OpenGL_Api#Textures|see gl.Texture]] ,]
["enable" = boolean true ] }, ]
[ [3] = [[Lua_OpenGL_Api#Textures|see gl.Texture]], ]
(upto [15] and supports holes in it)
} ,]

["texunit0" = [[Lua_OpenGL_Api#Textures|see gl.Texture]] ,]
...
["texunit7" = [[Lua_OpenGL_Api#Textures|see gl.Texture]] ,]

["prelist" = [[Lua_OpenGL_Api#Display_Lists|lua_displaylist]] ,]
["postlist" = [[Lua_OpenGL_Api#Display_Lists|lua_displaylist]] ,]
["usecamera" = boolean ,]
["cameraloc" = number ,]
}

Lua UnitRendering

2008-08-28T08:07:30Z

JK: /* MaterialTypes */

==Unit Rendering==
'''Spring.UnitRendering.SetLODCount'''
( number unitID, int lodCount ) -> nil

'''Spring.UnitRendering.SetLODLength''' (`lod` is 1-indexed)
( number unitID, int lod, number lodLength ) -> nil

'''Spring.UnitRendering.SetLODDistance''' (same as SetLODLength(), but adjusted for 45deg FOV + 1024x768)
(number unitID, int lod, number lodDistance ) -> nil

'''Spring.UnitRendering.SetPieceList''' (displayList=nil reset to default)
( number unitID, int lod, int piece [, number displayList = nil ] ) -> nil

'''Spring.UnitRendering.GetMaterial''' (creates a material userdata)
( [[Lua_UnitRendering#MaterialType|string MaterialType]], [[Lua_UnitRendering#Material_Table|table Material]] ) -> [[Lua_UnitRendering#Material_UserData|userdata Material]]

'''Spring.UnitRendering.SetMaterial'''
( number unitID, int lod, [[Lua_UnitRendering#MaterialType|string MaterialType]], [[Lua_UnitRendering#Material_UserData|userdata Material]] | [[Lua_UnitRendering#Material_Table|table Material]] ) -> nil

'''Spring.UnitRendering.SetMaterialLastLOD'''
( number unitID, s[[Lua_UnitRendering#MaterialType|string MaterialType]], int lastLOD ) -> nil

'''Spring.UnitRendering.SetMaterialDisplayLists'''
( number unitID, [[Lua_UnitRendering#MaterialType|string MaterialType]], [[Lua_OpenGL_Api#Display_Lists|preDisplayList]], [[Lua_OpenGL_Api#Display_Lists|postDisplayList]] ) -> nil

'''Spring.UnitRendering.SetUnitUniform''' (unfinished)
( number unitID, [[Lua_UnitRendering#MaterialType|string MaterialType]], int lod, arg1, arg2, ... ) -> nil

'''Spring.UnitRendering.SetUnitLuaDraw''' (enables the DrawUnit callin)
( number unitID, boolean enabled ) -> nil

'''Spring.UnitRendering.Debug''' (prints some usefull debug informations)
( [ number unitID ] ) -> nil

==MaterialTypes==
"alpha"
"opaque"
"alpha_reflect"
"opaque_reflect"
"shadow"

==Material UserData==
none user accessible methods (yet)

==Material Table==
material = {
["order" = number ,]
["shader" = [[Lua_GLSL_Api|lua_shader]] | string "3do" | string "s3o" ,]

["texunits" = {
[ [0] = { ["tex" = [[Lua_OpenGL_Api#Textures|see gl.Texture]] ,]
["enable" = boolean true ] }, ]
[ [3] = [[Lua_OpenGL_Api#Textures|see gl.Texture]], ]
(upto [15] and supports holes in it)
} ,]

["texunit0" = [[Lua_OpenGL_Api#Textures|see gl.Texture]] ,]
...
["texunit7" = [[Lua_OpenGL_Api#Textures|see gl.Texture]] ,]

["prelist" = [[Lua_OpenGL_Api#Display_Lists|lua_displaylist]] ,]
["postlist" = [[Lua_OpenGL_Api#Display_Lists|lua_displaylist]] ,]
["usecamera" = boolean ,]
["cameraloc" = number ,]
}

Lua UnitRendering

2008-08-28T08:07:00Z

JK: /* Unit Rendering */

==Unit Rendering==
'''Spring.UnitRendering.SetLODCount'''
( number unitID, int lodCount ) -> nil

'''Spring.UnitRendering.SetLODLength''' (`lod` is 1-indexed)
( number unitID, int lod, number lodLength ) -> nil

'''Spring.UnitRendering.SetLODDistance''' (same as SetLODLength(), but adjusted for 45deg FOV + 1024x768)
(number unitID, int lod, number lodDistance ) -> nil

'''Spring.UnitRendering.SetPieceList''' (displayList=nil reset to default)
( number unitID, int lod, int piece [, number displayList = nil ] ) -> nil

'''Spring.UnitRendering.GetMaterial''' (creates a material userdata)
( [[Lua_UnitRendering#MaterialType|string MaterialType]], [[Lua_UnitRendering#Material_Table|table Material]] ) -> [[Lua_UnitRendering#Material_UserData|userdata Material]]

'''Spring.UnitRendering.SetMaterial'''
( number unitID, int lod, [[Lua_UnitRendering#MaterialType|string MaterialType]], [[Lua_UnitRendering#Material_UserData|userdata Material]] | [[Lua_UnitRendering#Material_Table|table Material]] ) -> nil

'''Spring.UnitRendering.SetMaterialLastLOD'''
( number unitID, s[[Lua_UnitRendering#MaterialType|string MaterialType]], int lastLOD ) -> nil

'''Spring.UnitRendering.SetMaterialDisplayLists'''
( number unitID, [[Lua_UnitRendering#MaterialType|string MaterialType]], [[Lua_OpenGL_Api#Display_Lists|preDisplayList]], [[Lua_OpenGL_Api#Display_Lists|postDisplayList]] ) -> nil

'''Spring.UnitRendering.SetUnitUniform''' (unfinished)
( number unitID, [[Lua_UnitRendering#MaterialType|string MaterialType]], int lod, arg1, arg2, ... ) -> nil

'''Spring.UnitRendering.SetUnitLuaDraw''' (enables the DrawUnit callin)
( number unitID, boolean enabled ) -> nil

'''Spring.UnitRendering.Debug''' (prints some usefull debug informations)
( [ number unitID ] ) -> nil

===MaterialTypes===
"alpha"
"opaque"
"alpha_reflect"
"opaque_reflect"
"shadow"

==Material UserData==
none user accessible methods (yet)

==Material Table==
material = {
["order" = number ,]
["shader" = [[Lua_GLSL_Api|lua_shader]] | string "3do" | string "s3o" ,]

["texunits" = {
[ [0] = { ["tex" = [[Lua_OpenGL_Api#Textures|see gl.Texture]] ,]
["enable" = boolean true ] }, ]
[ [3] = [[Lua_OpenGL_Api#Textures|see gl.Texture]], ]
(upto [15] and supports holes in it)
} ,]

["texunit0" = [[Lua_OpenGL_Api#Textures|see gl.Texture]] ,]
...
["texunit7" = [[Lua_OpenGL_Api#Textures|see gl.Texture]] ,]

["prelist" = [[Lua_OpenGL_Api#Display_Lists|lua_displaylist]] ,]
["postlist" = [[Lua_OpenGL_Api#Display_Lists|lua_displaylist]] ,]
["usecamera" = boolean ,]
["cameraloc" = number ,]
}

Lua OpenGL Api

2008-08-20T22:03:10Z

JK: /* Textures */

== Spring ==
'''gl.GetSun'''
() -> number sunPosX, number sunPosY, number sunPosZ
( "pos" ) -> number sunPosX, number sunPosY, number sunPosZ
( "shadowDensity" [, "unit"] ) -> number shadowDensity
( "diffuse" [, "unit"] ) -> nil | number r, number g, number b
( "ambient" [, "unit"] ) -> nil | number r, number g, number b
( "specular" ) -> nil | number r, number g, number b

'''gl.ConfigScreen'''
( number screenWidth, number screenDistance ) -> nil

'''gl.DrawMiniMap'''
() -> nil

'''gl.SlaveMiniMap'''
( boolean mode ) -> nil

'''gl.ConfigMiniMap'''
( int px, int py, int sx, int sy ) -> nil

'''gl.GetViewSizes'''
( ) -> number x, number y

== Basics ==

'''gl.PushMatrix'''
() -> nil

'''gl.PopMatrix'''
() -> nil

'''gl.Translate'''
(number x, number y, number z) -> nil

'''gl.Scale'''
(number x, number y, number z) -> nil

'''gl.Rotate'''
(number angle, number x, number y, number z) -> nil

'''gl.Color'''
( { number r, number g, number b[, number a] } |
number r, number g, number b[, number a] ) -> nil

'''gl.LineWidth'''
( number width ) -> nil

'''gl.PointSize'''
( number size ) -> nil

'''gl.Billboard''' use this to draw 2d primitives in DrawWorld
() -> nil

'''gl.ResetState'''
() -> nil

ShadeModel = GL_SMOOTH
Scissor = false
Texture = false
ColorMask = true, true, true, true
DepthMask = false
DepthTest = false (GL_LEQUAL)
Culling = false (GL_BACK)
LogicOp = false (GL_INVERT)
AlphaTest = false (GL_GREATER, 0.5f)
Blending = GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA


'''gl.ResetMatrices'''
() -> nil

Resets GL_TEXTURE matrix stack
Resets GL_MODELVIEW matrix stack
Resets GL_PROJECTION matrix stack


'''gl.Clear'''
( GL.DEPTH_BUFFER_BIT, number cleardepth ) -> nil
( GL.STENCIL_BUFFER_BIT, int clearstencil ) -> nil
( GL.COLOR_BUFFER_BIT | GL.ACCUM_BUFFER_BIT, number r, number g, number b, number a ) -> nil

== Draw Basics ==

'''gl.BeginEnd'''
( number [[Lua_ConstGL#Drawing_Primitives|GLType]], function [, arg1,... ] ) -> nil

'''gl.Vertex'''
( { number x, number y [, number z [, number w ]] } |
number x, number y |
number x, number y, number z |
number x, number y, number z, number w ) -> nil

'''gl.Normal'''
( number x, number y, number z |
{ number x, number y, number z } ) -> nil

'''gl.Rect'''
( number x1, number y1, number x2, number y2 ) -> nil

'''gl.TexRect''' texture rect
( number x1, number y1, number x2, number y2,
[ boolean flip_s, boolean flip_t | number s1, number t1, number s2, number t2 ] ) -> nil

'''gl.Shape'''
( number [[Lua_ConstGL#Drawing_Primitives|GLtype]],
elements = {
[1] = { v | vertex = { number x, number y, number z }, required
n | normal = { number x, number y, number z }, optional
t | texcoord = { number x, number y }, optional
c | color = { number r, number g, number b, number a } optional
},
etc ...
}
) -> nil

== Text ==

'''gl.Text'''
(string "text", number x, number y, number size [, string "options"] )

options:
'c' = center
'r' = right
'n' = deactives colorCodes (so you can use gl.Color() to write transparent text etc.)
'o' = black outline
'O' = white outline


'''gl.GetTextWidth'''
(string "text") -> number width -- in pixels, with a font size of 1.0

== Unit/Feature Draw Functions ==

'''gl.Unit''' (draws an unit; on default it uses LOD, with lod<0 it is turned off, else it defines a specific level)
( number unitID, [ boolean rawdraw, int lod ] ) -> nil

'''gl.UnitRaw''' (redundant -> use gl.Unit instead!)
( number unitID, [ boolean rawdraw, int lod ] ) -> nil

'''gl.UnitShape'''
( number unitDefID, number teamID ) -> nil

'''gl.Feature'''
( number featureID ) -> nil

'''gl.FeatureShape'''
( number featureDefID, number teamID ) -> nil

'''gl.UnitMultMatrix''' (world space -> unit space)
( number unitID ) -> nil

'''gl.UnitPieceMultMatrix''' (unit space -> piece space)
( number unitID, int piece ) -> nil

'''gl.UnitPiece''' (draws the unit piece)
( number unitID, int piece ) -> nil

'''gl.UnitPieceMatrix''' (use gl.UnitPieceMultMatrix instead!)
( number unitID, int piece ) -> nil

'''gl.DrawListAtUnit'''
( number unitID, number listID, [ boolean midPos,
number scaleX, number scaleY, number scaleZ,
number degrees, number rotX, number rotX, number rotZ ] ) -> nil

'''gl.DrawFuncAtUnit'''
( number unitID, boolean midPos, function [, arg1,... ]) -> nil

== Switches ==

'''gl.Blending'''
( boolean enable | number [[Lua_ConstGL#BlendingFactorSrc|srcmode]], number [[Lua_ConstGL#BlendingFactorDest|dstmode]] ) -> nil

'''gl.AlphaTest'''
( boolean enable | number [[Lua_ConstGL#AlphaFunction and DepthFunction|func]], number threshold ) -> nil

'''gl.DepthTest'''
( boolean enable | number [[Lua_ConstGL#AlphaFunction and DepthFunction|func]] ) -> nil

'''gl.Culling'''
( boolean enable | number [[Lua_ConstGL#Culling|face]] ) -> nil

'''gl.DepthMask'''
( boolean enable ) -> nil

'''gl.ColorMask'''
( boolean ) -> nil
( boolean r, boolean g, boolean b, boolean a ) -> nil

'''gl.LogicOp'''
( boolean enable | number [[Lua_ConstGL#LogicOp|func]] ) -> nil

'''gl.Fog'''
( boolean enable ) -> nil

'''gl.Smoothing'''
( (boolean enable | number POINT),
(boolean enable | number LINE),
(boolean enable | number POLYGON) ) -> nil

'''gl.EdgeFlag'''
( boolean enable ) -> nil

'''gl.Scissor'''
( boolean ) -> nil
( int x, int y, int w, int h ) -> nil

'''gl.LineStipple'''
( string any ) -> nil (use springs default line stipple)
( boolean enable ) -> nil
( int factor, number pattern ) -> nil

'''gl.PolygonMode'''
( number [[Lua_ConstGL#Culling|face]], number [[Lua_ConstGL#PolygonMode|mode]] ) -> nil

'''gl.PolygonOffset'''
( boolean enable | number factor, number units ) -> nil

== Textures ==

'''gl.Texture'''
( [ number texNum, ] boolean enable | string name ) -> nil | boolean loaded

current formats:
:${opt}:/LuaUI/images/image.png = filename
#12 = unitDef 12 buildpic
%34:1 = unitDef 34 s3o tex2 (:0->tex1,:1->tex2)
!56 = lua generated texture 56
$units = 3do textureatlas
$shadow = shadowmap
$specular = specular cube map
$reflection = reflection cube map

possible ${opt}'s are:
'n' = nearest
'l' = linear
'a' = aniso
'i' = invert
'g' = greyed
'c' = clamped
'b' = border
't%r,%g,%b' = tint

example: ":iac:/LuaUI/images/image.png"
example2: ":t1.0,0.5,0:/LuaUI/images/image.png" (orange tint)


'''gl.CreateTexture'''
( int xsize, int ysize,
[ {
[target = number,] (like GL_TEXTURE_1D,GL_TEXTURE_2D,...)
[format = number,]
[min_filter = [[Lua_ConstGL#Texture_Filtering|number]],]
[mag_filter = [[Lua_ConstGL#Texture_Filtering|number]],]
[wrap_s = [[Lua_ConstGL#Texture_Clamping|number]],]
[wrap_t = [[Lua_ConstGL#Texture_Clamping|number]],]
[wrap_r = [[Lua_ConstGL#Texture_Clamping|number]],]
[aniso = number,]
[border = boolean,]
[fbo = boolean,] (needs GLEW_EXT_framebuffer_object!)
[fboDepth = boolean] (needs GLEW_EXT_framebuffer_object!)
} ]
) -> string

'''gl.DeleteTexture'''
( string texture ) -> boolean

'''gl.DeleteTextureFBO''' (needs GLEW_EXT_framebuffer_object!)
( string texture ) -> boolean

'''gl.TextureInfo'''
( string texture ) -> nil | {
xsize = number,
ysize = number,
alpha = boolean, //not used yet
type = number, //not used yet
}

the format of the texture string is the same as in gl.Texture()


'''gl.TexCoord'''
( number x |
number x, number y |
number x, number y, number z |
number x, number y, number z, number w |
{ number x [, number y [, number z [, number w ]]] } ) -> nil

'''gl.MultiTexCoord'''
( int texNum,
number x |
number x, number y |
number x, number y, number z |
number x, number y, number z, number w |
{ number x [, number y [, number z [, number w ]]] } ) -> nil

'''gl.TexEnv'''
( number [[Lua_ConstGL#Texture_Environment|target]], number [[Lua_ConstGL#Texture_Environment|pname]],
number [[Lua_ConstGL#Texture_Environment|value]] |
number var1, number var2, number var3 ) -> nil

'''gl.MultiTexEnv'''
( int texNum, number [[Lua_ConstGL#Texture_Environment|target]], number [[Lua_ConstGL#Texture_Environment|pname]],
number [[Lua_ConstGL#Texture_Environment|value]] |
number var1, number var2, number var3 ) -> nil

'''gl.TexGen'''
( number [[Lua_ConstGL#Texture_Generation|target]],
boolean state |
number [[Lua_ConstGL#Texture_Generation|pname]], number value |
number [[Lua_ConstGL#Texture_Generation|pname]], number var1, number var2, number var3 ) -> nil

'''gl.MultiTexGen'''
( int texNum, number [[Lua_ConstGL#Texture_Generation|target]],
boolean state |
number [[Lua_ConstGL#Texture_Generation|pname]], number value |
number [[Lua_ConstGL#Texture_Generation|pname]], number var1, number var2, number var3 ) -> nil

'''gl.CopyToTexture'''
(string texture, int xoff, int yoff, int x, int y, int w, int h
[,number target,number level])->nil

'''gl.RenderToTexture''' (needs GLEW_EXT_framebuffer_object!)
( string fbotexture, lua_func ) -> nil

'''gl.GenerateMipmap''' (needs glGenerateMipmapEXT!)
( string texture ) -> boolean

== Lights ==

'''gl.Lighting'''
( boolean enable ) -> nil

'''gl.ShadeModel'''
( number [[Lua_ConstGL#ShadeModel|mode]] ) -> nil

'''gl.Light'''
( int light,
boolean enable |
number [[Lua_ConstGL#Light_Specification|pname]], number param |
number [[Lua_ConstGL#Light_Specification|pname]], number param1, number param2, number param3 ) -> nil

'''gl.Material'''
({
ambient = {number r, number g, number b[, number a]},
diffuse = {number r, number g, number b[, number a]},
ambidiff = {number r, number g, number b[, number a]},
emission = {number r, number g, number b[, number a]},
specular = {number r, number g, number b[, number a]},
shininess = number specularExponent
}) -> nil

== Display Lists ==
Display Lists save given vertex attributes in a static buffer, so the GPU can directly read them (without the CPU). Display Lists are a lot faster (10-60x) than standard drawing with glShape/glBeginEnd, so try to use them when ever you can. If you want to learn more about them, g00gle is your friend ;)

'''gl.CreateList'''
( function [,arg1 [,arg2...]] ) -> nil

'''gl.CallList'''
( number listID ) -> nil

'''gl.DeleteList'''
( number listID ) -> nil

== Hardware relevant ==

'''gl.HasExtension'''
( string extname ) -> boolean

'''gl.GetNumber'''
( number ext, int count ) -> number [, number, number, ... #count ]

'''gl.GetString'''
( number ext ) -> string

== DrawGroundPrimitives ==

'''gl.DrawGroundCircle'''
( number x, number y, number z, number radius, number divs [, number slope ] ) -> nil

'''gl.DrawGroundQuad''' Note: x1,z1,x2 & z2 are rounded, so don't use it for very small or moving objects
( number x1, number z1, number x2, number z2,
[ boolean useNorm,
[ number tu1, number tv1, number tu2, number tv2 |
boolean useTextureCoord ] ] ) -> nil

== Extended ==

'''gl.ActiveTexture'''
( int texNum, function [, arg1,... ] ) -> nil

'''gl.GetGlobalTexNames'''
() -> { [1] = string texture, etc ... }

'''gl.GetGlobalTexCoords'''
( string tatexture ) -> number xstart, number ystart, number xend, number yend

'''gl.GetShadowMapParams'''
() -> number xmid, number ymid, number p17, number p18

'''gl.GetMatrixData'''
( GL.PROJECTION [, int i] ) -> nil | number, etc.. | number Matrix[i]
( GL.MODELVIEW [, int i] ) -> nil | number, etc.. | number Matrix[i]
( GL.TEXTURE [, int i] ) -> nil | number, etc.. | number Matrix[i]
( "shadow" ) -> nil | number, etc..
( "camera" ) -> nil | number, etc..
( "caminv" ) -> nil | number, etc..
( "camprj" ) -> nil | number, etc..
( "billboard" ) -> nil | number, etc..

'''gl.PointSprite''' (needs openGL2.0!)
( boolean enable, [boolean coord_replace, boolean coord_origin_upper] ) -> nil

'''gl.PointParameter''' (needs openGL2.0!)
( number v1, number v2, number v3,
[ number sizeMin, number sizeMax, number sizeFade ] ) -> nil

'''gl.SecondaryColor'''
( { number r, number g, number b } |
number r, number g, number b ) -> nil

'''gl.FogCoord'''
( number value ) -> nil

'''gl.ClipPlane'''
( int plane, note: $plane can only be 1 or 2
boolean enable |
number A, number B, number C, number D ) -> nil

'''gl.MatrixMode'''
( number [[Lua_ConstGL#MatrixMode|mode]] ) -> nil

'''gl.LoadIdentity'''
() -> nil

'''gl.LoadMatrix'''
() -> nil

'''gl.MultMatrix'''

'''gl.Ortho'''
( number left, number right, number bottom, number top, number near, number far ) -> nil

'''gl.Frustum'''
( number left, number right, number bottom, number top, number near, number far ) -> nil

'''gl.PushPopMatrix'''

'''gl.PushAttrib'''
( [ number [[Lua_ConstGL#glPushAttrib.28.29_bits|attrib]] ] ) -> nil

'''gl.PopAttrib'''
() -> nil

'''gl.Flush'''
() -> nil

'''gl.Finish'''
() -> nil

== Shaders (GLSL) ==
[[Lua_GLSL_Api]]

Lua CMDs

2008-08-15T01:39:38Z

JK: added local links

== Options ==
CMD.OPT_ALT 
CMD.OPT_CTRL 
CMD.OPT_SHIFT 
CMD.OPT_RIGHT 
CMD.OPT_INTERNAL

== Waitcodes ==
CMD.WAITCODE_TIME 
CMD.WAITCODE_DEATH 
CMD.WAITCODE_SQUAD 
CMD.WAITCODE_GATHER

== Insert/Remove Commands ==
First, said "tags" are unique command identifiers, so each command that gets inserted into a unit's command
queue gets its unique "tag" number. (It is used to ''sync'' command queue operations, also it makes things much easier.) 
To receive those "tags" you can do the following:
local cmdQueue = Spring.GetUnitCommands(unitID);
if (#cmdQueue>0) then
local cmdTag = cmdQueue[1].tag
..
end

CMD.INSERT
options.ALT -> treat param0 as a position instead of a tag
options.CONTROL -> use the build queue for factories
params[0] = command tag or position (negative numbers to reference the back of the queue)
params[1] = insertCmd id
params[2] = insertCmd options (shift,alt,right click,etc.)
params[3 ... N+2] = insertCmd params[0 ... N-1]

example:
Spring.GiveOrderToUnit(unitID,
CMD.INSERT,
{-1,CMD.ATTACK,''CMD.OPT_SHIFT'',''unitID2''},
{"alt"}
);

Note: If you didn't already notice, the command params and
the command options are twisted in the array (compared to GiverOrder)!

Note2: The command options in the array/table is a number value!
You have to use CMD.OPT_* in this case.

CMD.REMOVE
options.ALT -> use the parameters as commandIDs
options.CONTROL -> use the build queue for factories
params[0 ... N-1] = tags or commandIDs to remove

== Commands ==
Note, the CMD[] table is bidirectional. That means: CMD[CMD.STOP] := "CMD_STOP"

CMD.STOP
type [[Lua_CMDs#CMDTYPE.ICON|CMDTYPE.ICON]]
CMD.WAIT
type [[Lua_CMDs#CMDTYPE.ICON|CMDTYPE.ICON]]
CMD.TIMEWAIT
type [[Lua_CMDs#CMDTYPE.NUMBER|CMDTYPE.NUMBER]]
CMD.DEATHWAIT
type [[Lua_CMDs#CMDTYPE.ICON_UNIT_OR_RECTANGLE|CMDTYPE.ICON_UNIT_OR_RECTANGLE]]
CMD.SQUADWAIT
type [[Lua_CMDs#CMDTYPE.NUMBER|CMDTYPE.NUMBER]]
CMD.GATHERWAIT
type [[Lua_CMDs#CMDTYPE.ICON|CMDTYPE.ICON]]
CMD.MOVE
type [[Lua_CMDs#CMDTYPE.ICON_MAP|CMDTYPE.ICON_MAP]]
CMD.PATROL
type [[Lua_CMDs#CMDTYPE.ICON_MAP|CMDTYPE.ICON_MAP]]
CMD.FIGHT
type [[Lua_CMDs#CMDTYPE.ICON_MAP|CMDTYPE.ICON_MAP]]
CMD.ATTACK
type [[Lua_CMDs#CMDTYPE.ICON_UNIT_OR_MAP|CMDTYPE.ICON_UNIT_OR_MAP]]
CMD.AREA_ATTACK
type [[Lua_CMDs#CMDTYPE.ICON_AREA|CMDTYPE.ICON_AREA]]
CMD.GUARD
type [[Lua_CMDs#CMDTYPE.ICON_UNIT|CMDTYPE.ICON_UNIT]]
CMD.AISELECT
type [[Lua_CMDs#CMDTYPE.COMBO_BOX|CMDTYPE.COMBO_BOX]]
CMD.GROUPSELECT
type [[Lua_CMDs#CMDTYPE.ICON|CMDTYPE.ICON]]
CMD.GROUPADD
type [[Lua_CMDs#CMDTYPE.ICON|CMDTYPE.ICON]]
CMD.GROUPCLEAR
type [[Lua_CMDs#CMDTYPE.ICON|CMDTYPE.ICON]]
CMD.REPAIR
type [[Lua_CMDs#CMDTYPE.ICON_UNIT_OR_AREA|CMDTYPE.ICON_UNIT_OR_AREA]]
CMD.FIRE_STATE
type [[Lua_CMDs#CMDTYPE.ICON_MODE|CMDTYPE.ICON_MODE]]
CMD.MOVE_STATE
type [[Lua_CMDs#CMDTYPE.ICON_MODE|CMDTYPE.ICON_MODE]]
CMD.SELFD
type [[Lua_CMDs#CMDTYPE.ICON|CMDTYPE.ICON]]
CMD.LOAD_UNITS
type [[Lua_CMDs#CMDTYPE.ICON_UNIT_OR_AREA|CMDTYPE.ICON_UNIT_OR_AREA]]
CMD.LOAD_ONTO
type [[Lua_CMDs#CMDTYPE.ICON_UNIT|CMDTYPE.ICON_UNIT]]
CMD.UNLOAD_UNITS
type [[Lua_CMDs#CMDTYPE.ICON_UNIT_OR_AREA|CMDTYPE.ICON_UNIT_OR_AREA]]
CMD.UNLOAD_UNIT
type [[Lua_CMDs#CMDTYPE.ICON_MAP|CMDTYPE.ICON_MAP]]
CMD.ONOFF
type [[Lua_CMDs#CMDTYPE.ICON_MODE|CMDTYPE.ICON_MODE]]
CMD.RECLAIM
type [[Lua_CMDs#CMDTYPE.ICON_UNIT_FEATURE_OR_AREA|CMDTYPE.ICON_UNIT_FEATURE_OR_AREA]]
CMD.CLOAK
type [[Lua_CMDs#CMDTYPE.ICON_MODE|CMDTYPE.ICON_MODE]]
CMD.STOCKPILE
type [[Lua_CMDs#CMDTYPE.ICON|CMDTYPE.ICON]]
CMD.DGUN
type [[Lua_CMDs#CMDTYPE.ICON_MAP|CMDTYPE.ICON_MAP]]
CMD.RESTORE
type [[Lua_CMDs#CMDTYPE.ICON_AREA|CMDTYPE.ICON_AREA]]
CMD.REPEAT
type [[Lua_CMDs#CMDTYPE.ICON_MODE|CMDTYPE.ICON_MODE]]
CMD.TRAJECTORY
type [[Lua_CMDs#CMDTYPE.ICON_MODE|CMDTYPE.ICON_MODE]]
CMD.RESURRECT
type [[Lua_CMDs#CMDTYPE.ICON_UNIT_FEATURE_OR_AREA|CMDTYPE.ICON_UNIT_FEATURE_OR_AREA]]
CMD.CAPTURE
type [[Lua_CMDs#CMDTYPE.ICON_UNIT_OR_AREA|CMDTYPE.ICON_UNIT_OR_AREA]]
CMD.AUTOREPAIRLEVEL
type [[Lua_CMDs#CMDTYPE.ICON_MODE|CMDTYPE.ICON_MODE]]
CMD.LOOPBACKATTACK
type [[Lua_CMDs#CMDTYPE.ICON_MODE|CMDTYPE.ICON_MODE]]
CMD.IDLEMODE
type [[Lua_CMDs#CMDTYPE.ICON_MODE|CMDTYPE.ICON_MODE]]
CMD.SET_WANTED_MAX_SPEED
type [[Lua_CMDs#CMDTYPE.NUMBER|CMDTYPE.NUMBER]]
CMD.SETBASE

CMD.INTERNAL
used in different ways

== CommandTypes ==
Note, the CMDTYPE[] table is bidirectional. That means: CMDTYPE[CMDTYPE.ICON] := "CMDTYPE_ICON"

CMDTYPE.ICON
expect 0 parameters in return
CMDTYPE.ICON_MODE
expect 1 parameter in return (number selected mode)
CMDTYPE.ICON_MAP
expect 3 parameters in return (mappos)
CMDTYPE.ICON_AREA
expect 4 parameters in return (mappos+radius)
CMDTYPE.ICON_UNIT
expect 1 parameters in return (unitid)
CMDTYPE.ICON_UNIT_OR_MAP
expect 1 parameters in return (unitid) or 3 parameters in return (mappos)
CMDTYPE.ICON_FRONT
expect 3 or 6 parameters in return (middle and right side of front if a front was defined)
CMDTYPE.COMBO_BOX
expect 1 parameter in return (number selected option)
CMDTYPE.ICON_UNIT_OR_AREA
expect 1 parameter in return (unitid) or 4 parameters in return (mappos+radius)
CMDTYPE.ICON_UNIT_FEATURE_OR_AREA
expect 1 parameter in return (unitid or [[Lua_ConstGame#Engine|Game.maxUnits]]+featureid)
or 4 parameters in return (mappos+radius)
CMDTYPE.ICON_BUILDING
expect 3 parameters in return (mappos)
CMDTYPE.ICON_UNIT_OR_RECTANGLE
expect 1 parameter in return (unitid)
or 3 parameters in return (mappos)
or 6 parameters in return (startpos+endpos)
CMDTYPE.NUMBER
expect 1 parameter in return (number)

CMDTYPE.CUSTOM
used with CMD_INTERNAL
CMDTYPE.NEXT next command page
used with CMD_INTERNAL
CMDTYPE.PREV previous command page
used with CMD_INTERNAL

Lua CMDs

2008-08-15T01:21:58Z

JK: test

== Options ==
'''CMD.OPT_ALT''' 
'''CMD.OPT_CTRL''' 
'''CMD.OPT_SHIFT''' 
'''CMD.OPT_RIGHT''' 
'''CMD.OPT_INTERNAL'''

== Waitcodes ==
'''CMD.WAITCODE_TIME''' 
'''CMD.WAITCODE_DEATH''' 
'''CMD.WAITCODE_SQUAD''' 
'''CMD.WAITCODE_GATHER'''

== Insert/Remove Commands ==
First, said "tags" are unique command identifiers, so each command that gets inserted into a unit's command
queue gets its unique "tag" number. (It is used to ''sync'' command queue operations, also it makes things much easier.) 
To receive those "tags" you can do the following:
local cmdQueue = Spring.GetUnitCommands(unitID);
if (#cmdQueue>0) then
local cmdTag = cmdQueue[1].tag
..
end

'''CMD.INSERT'''
options.ALT -> treat param0 as a position instead of a tag
options.CONTROL -> use the build queue for factories
params[0] = command tag or position (negative numbers to reference the back of the queue)
params[1] = insertCmd id
params[2] = insertCmd options (shift,alt,right click,etc.)
params[3 ... N+2] = insertCmd params[0 ... N-1]

example:
Spring.GiveOrderToUnit(unitID,
CMD.INSERT,
{-1,CMD.ATTACK,''CMD.OPT_SHIFT'',''unitID2''},
{"alt"}
);

Note: If you didn't already notice, the command params and
the command options are twisted in the array (compared to GiverOrder)!

Note2: The command options in the array/table is a number value!
You have to use CMD.OPT_* in this case.

'''CMD.REMOVE'''
options.ALT -> use the parameters as commandIDs
options.CONTROL -> use the build queue for factories
params[0 ... N-1] = tags or commandIDs to remove

== Commands ==
Note, the CMD[] table is bidirectional. That means: CMD[CMD.STOP] := "CMD_STOP"

'''CMD.STOP'''
type CMDTYPE.ICON
'''CMD.WAIT'''
type CMDTYPE.ICON
'''CMD.TIMEWAIT'''
type CMDTYPE.NUMBER
'''CMD.DEATHWAIT'''
type CMDTYPE.ICON_UNIT_OR_RECTANGLE
'''CMD.SQUADWAIT'''
type CMDTYPE.NUMBER
'''CMD.GATHERWAIT'''
type CMDTYPE.ICON
'''CMD.MOVE'''
type CMDTYPE.ICON_MAP
'''CMD.PATROL'''
type CMDTYPE.ICON_MAP
'''CMD.FIGHT'''
type CMDTYPE.ICON_MAP
'''CMD.ATTACK'''
type CMDTYPE.ICON_UNIT_OR_MAP
'''CMD.AREA_ATTACK'''
type CMDTYPE.ICON_AREA
'''CMD.GUARD'''
type CMDTYPE.ICON_UNIT
'''CMD.AISELECT'''
type CMDTYPE.COMBO_BOX
'''CMD.GROUPSELECT'''
type CMDTYPE.ICON
'''CMD.GROUPADD'''
type CMDTYPE.ICON
'''CMD.GROUPCLEAR'''
type CMDTYPE.ICON
'''CMD.REPAIR'''
type CMDTYPE.ICON_UNIT_OR_AREA
'''CMD.FIRE_STATE'''
type CMDTYPE.ICON_MODE
'''CMD.MOVE_STATE'''
type CMDTYPE.ICON_MODE
'''CMD.SELFD'''
type CMDTYPE.ICON
'''CMD.LOAD_UNITS'''
type CMDTYPE.ICON_UNIT_OR_AREA
'''CMD.LOAD_ONTO'''
type CMDTYPE.ICON_UNIT
'''CMD.UNLOAD_UNITS'''
type CMDTYPE.ICON_UNIT_OR_AREA
'''CMD.UNLOAD_UNIT'''
type CMDTYPE.ICON_MAP
'''CMD.ONOFF'''
type CMDTYPE.ICON_MODE
'''CMD.RECLAIM'''
type [[Lua_CMDs#CMDTYPE.ICON_UNIT_FEATURE_OR_AREA|CMDTYPE.ICON_UNIT_FEATURE_OR_AREA]]
'''CMD.CLOAK'''
type CMDTYPE.ICON_MODE
'''CMD.STOCKPILE'''
type CMDTYPE.ICON
'''CMD.DGUN'''
type CMDTYPE.ICON_MAP
'''CMD.RESTORE'''
type CMDTYPE.ICON_AREA
'''CMD.REPEAT'''
type CMDTYPE.ICON_MODE
'''CMD.TRAJECTORY'''
type CMDTYPE.ICON_MODE
'''CMD.RESURRECT'''
type CMDTYPE.ICON_UNIT_FEATURE_OR_AREA
'''CMD.CAPTURE'''
type CMDTYPE.ICON_UNIT_OR_AREA
'''CMD.AUTOREPAIRLEVEL'''
type CMDTYPE.ICON_MODE
'''CMD.LOOPBACKATTACK'''
type CMDTYPE.ICON_MODE
'''CMD.IDLEMODE'''
type CMDTYPE.ICON_MODE
'''CMD.SET_WANTED_MAX_SPEED'''
type CMDTYPE.NUMBER
'''CMD.SETBASE'''

'''CMD.INTERNAL'''
used in different ways

== CommandTypes ==
Note, the CMDTYPE[] table is bidirectional. That means: CMDTYPE[CMDTYPE.ICON] := "CMDTYPE_ICON"

'''CMDTYPE.ICON'''
expect 0 parameters in return
'''CMDTYPE.ICON_MODE'''
expect 1 parameter in return (number selected mode)
'''CMDTYPE.ICON_MAP'''
expect 3 parameters in return (mappos)
'''CMDTYPE.ICON_AREA'''
expect 4 parameters in return (mappos+radius)
'''CMDTYPE.ICON_UNIT'''
expect 1 parameters in return (unitid)
'''CMDTYPE.ICON_UNIT_OR_MAP'''
expect 1 parameters in return (unitid) or 3 parameters in return (mappos)
'''CMDTYPE.ICON_FRONT'''
expect 3 or 6 parameters in return (middle and right side of front if a front was defined)
'''CMDTYPE.COMBO_BOX'''
expect 1 parameter in return (number selected option)
'''CMDTYPE.ICON_UNIT_OR_AREA'''
expect 1 parameter in return (unitid) or 4 parameters in return (mappos+radius)
CMDTYPE.ICON_UNIT_FEATURE_OR_AREA
expect 1 parameter in return (unitid or [[Lua_ConstGame#Engine|Game.maxUnits]]+featureid)
or 4 parameters in return (mappos+radius)
'''CMDTYPE.ICON_BUILDING'''
expect 3 parameters in return (mappos)
'''CMDTYPE.ICON_UNIT_OR_RECTANGLE'''
expect 1 parameter in return (unitid)
or 3 parameters in return (mappos)
or 6 parameters in return (startpos+endpos)
'''CMDTYPE.NUMBER'''
expect 1 parameter in return (number)

'''CMDTYPE.CUSTOM'''
used with CMD_INTERNAL
'''CMDTYPE.NEXT''' next command page
used with CMD_INTERNAL
'''CMDTYPE.PREV''' previous command page
used with CMD_INTERNAL

Lua CMDs

2008-08-15T01:07:01Z

JK:

== Options ==
'''CMD.OPT_ALT''' 
'''CMD.OPT_CTRL''' 
'''CMD.OPT_SHIFT''' 
'''CMD.OPT_RIGHT''' 
'''CMD.OPT_INTERNAL'''

== Waitcodes ==
'''CMD.WAITCODE_TIME''' 
'''CMD.WAITCODE_DEATH''' 
'''CMD.WAITCODE_SQUAD''' 
'''CMD.WAITCODE_GATHER'''

== Insert/Remove Commands ==
First, said "tags" are unique command identifiers, so each command that gets inserted into a unit's command
queue gets its unique "tag" number. (It is used to ''sync'' command queue operations, also it makes things much easier.) 
To receive those "tags" you can do the following:
local cmdQueue = Spring.GetUnitCommands(unitID);
if (#cmdQueue>0) then
local cmdTag = cmdQueue[1].tag
..
end

'''CMD.INSERT'''
options.ALT -> treat param0 as a position instead of a tag
options.CONTROL -> use the build queue for factories
params[0] = command tag or position (negative numbers to reference the back of the queue)
params[1] = insertCmd id
params[2] = insertCmd options (shift,alt,right click,etc.)
params[3 ... N+2] = insertCmd params[0 ... N-1]

example:
Spring.GiveOrderToUnit(unitID,
CMD.INSERT,
{-1,CMD.ATTACK,''CMD.OPT_SHIFT'',''unitID2''},
{"alt"}
);

Note: If you didn't already notice, the command params and
the command options are twisted in the array (compared to GiverOrder)!

Note2: The command options in the array/table is a number value!
You have to use CMD.OPT_* in this case.

'''CMD.REMOVE'''
options.ALT -> use the parameters as commandIDs
options.CONTROL -> use the build queue for factories
params[0 ... N-1] = tags or commandIDs to remove

== Commands ==
Note, the CMD[] table is bidirectional. That means: CMD[CMD.STOP] := "CMD_STOP"

'''CMD.STOP'''
type CMDTYPE.ICON
'''CMD.WAIT'''
type CMDTYPE.ICON
'''CMD.TIMEWAIT'''
type CMDTYPE.NUMBER
'''CMD.DEATHWAIT'''
type CMDTYPE.ICON_UNIT_OR_RECTANGLE
'''CMD.SQUADWAIT'''
type CMDTYPE.NUMBER
'''CMD.GATHERWAIT'''
type CMDTYPE.ICON
'''CMD.MOVE'''
type CMDTYPE.ICON_MAP
'''CMD.PATROL'''
type CMDTYPE.ICON_MAP
'''CMD.FIGHT'''
type CMDTYPE.ICON_MAP
'''CMD.ATTACK'''
type CMDTYPE.ICON_UNIT_OR_MAP
'''CMD.AREA_ATTACK'''
type CMDTYPE.ICON_AREA
'''CMD.GUARD'''
type CMDTYPE.ICON_UNIT
'''CMD.AISELECT'''
type CMDTYPE.COMBO_BOX
'''CMD.GROUPSELECT'''
type CMDTYPE.ICON
'''CMD.GROUPADD'''
type CMDTYPE.ICON
'''CMD.GROUPCLEAR'''
type CMDTYPE.ICON
'''CMD.REPAIR'''
type CMDTYPE.ICON_UNIT_OR_AREA
'''CMD.FIRE_STATE'''
type CMDTYPE.ICON_MODE
'''CMD.MOVE_STATE'''
type CMDTYPE.ICON_MODE
'''CMD.SELFD'''
type CMDTYPE.ICON
'''CMD.LOAD_UNITS'''
type CMDTYPE.ICON_UNIT_OR_AREA
'''CMD.LOAD_ONTO'''
type CMDTYPE.ICON_UNIT
'''CMD.UNLOAD_UNITS'''
type CMDTYPE.ICON_UNIT_OR_AREA
'''CMD.UNLOAD_UNIT'''
type CMDTYPE.ICON_MAP
'''CMD.ONOFF'''
type CMDTYPE.ICON_MODE
'''CMD.RECLAIM'''
type CMDTYPE.ICON_UNIT_FEATURE_OR_AREA
'''CMD.CLOAK'''
type CMDTYPE.ICON_MODE
'''CMD.STOCKPILE'''
type CMDTYPE.ICON
'''CMD.DGUN'''
type CMDTYPE.ICON_MAP
'''CMD.RESTORE'''
type CMDTYPE.ICON_AREA
'''CMD.REPEAT'''
type CMDTYPE.ICON_MODE
'''CMD.TRAJECTORY'''
type CMDTYPE.ICON_MODE
'''CMD.RESURRECT'''
type CMDTYPE.ICON_UNIT_FEATURE_OR_AREA
'''CMD.CAPTURE'''
type CMDTYPE.ICON_UNIT_OR_AREA
'''CMD.AUTOREPAIRLEVEL'''
type CMDTYPE.ICON_MODE
'''CMD.LOOPBACKATTACK'''
type CMDTYPE.ICON_MODE
'''CMD.IDLEMODE'''
type CMDTYPE.ICON_MODE
'''CMD.SET_WANTED_MAX_SPEED'''
type CMDTYPE.NUMBER
'''CMD.SETBASE'''

'''CMD.INTERNAL'''
used in different ways

== CommandTypes ==
Note, the CMDTYPE[] table is bidirectional. That means: CMDTYPE[CMDTYPE.ICON] := "CMDTYPE_ICON"

'''CMDTYPE.ICON'''
expect 0 parameters in return
'''CMDTYPE.ICON_MODE'''
expect 1 parameter in return (number selected mode)
'''CMDTYPE.ICON_MAP'''
expect 3 parameters in return (mappos)
'''CMDTYPE.ICON_AREA'''
expect 4 parameters in return (mappos+radius)
'''CMDTYPE.ICON_UNIT'''
expect 1 parameters in return (unitid)
'''CMDTYPE.ICON_UNIT_OR_MAP'''
expect 1 parameters in return (unitid) or 3 parameters in return (mappos)
'''CMDTYPE.ICON_FRONT'''
expect 3 or 6 parameters in return (middle and right side of front if a front was defined)
'''CMDTYPE.COMBO_BOX'''
expect 1 parameter in return (number selected option)
'''CMDTYPE.ICON_UNIT_OR_AREA'''
expect 1 parameter in return (unitid) or 4 parameters in return (mappos+radius)
'''CMDTYPE.ICON_UNIT_FEATURE_OR_AREA'''
expect 1 parameter in return (unitid or [[Lua_ConstGame#Engine|Game.maxUnits]]+featureid)
or 4 parameters in return (mappos+radius)
'''CMDTYPE.ICON_BUILDING'''
expect 3 parameters in return (mappos)
'''CMDTYPE.ICON_UNIT_OR_RECTANGLE'''
expect 1 parameter in return (unitid)
or 3 parameters in return (mappos)
or 6 parameters in return (startpos+endpos)
'''CMDTYPE.NUMBER'''
expect 1 parameter in return (number)

'''CMDTYPE.CUSTOM'''
used with CMD_INTERNAL
'''CMDTYPE.NEXT''' next command page
used with CMD_INTERNAL
'''CMDTYPE.PREV''' previous command page
used with CMD_INTERNAL

Lua SyncedRead

2008-08-15T00:56:11Z

JK: wrong place

== Game ==
=== Special TeamID Variables ===
'''Spring.ALL_UNITS''' 
'''Spring.MY_UNITS''' 
'''Spring.ALLY_UNITS''' 
'''Spring.ENEMY_UNITS'''

'''Spring.GetGaiaTeamID'''
( ) -> number teamID

=== GameStates ===
'''Spring.IsGodModeEnabled'''
( ) -> boolean
'''Spring.IsCheatingEnabled'''
( ) -> boolean
'''Spring.IsDevLuaEnabled'''
( ) -> boolean
'''Spring.IsEditDefsEnabled'''
( ) -> boolean
'''Spring.AreHelperAIsEnabled'''
( ) -> boolean

'''Spring.IsGameOver'''
( ) -> boolean

=== Rules ===
'''Spring.GetRulesInfoMap'''
( ) -> { [key1] = string value1, [key2] = string value2, ... }
( string "key" ) -> string

'''Spring.GetGameRulesParam'''
( number index | string ruleName ) -> number value
'''Spring.GetGameRulesParams'''
( ) -> { [rule1] = number value1, [rule2] = number value2, ... }

'''Spring.GetTeamRulesParam'''
( number teamID, number index | string ruleName ) -> nil | number value
'''Spring.GetTeamRulesParams'''
( number teamID ) -> nil | { [rule1] = number value1, [rule2] = number value2, ... }

'''Spring.GetUnitRulesParam'''
( number unitID, number index | string ruleName ) -> nil | number value
'''Spring.GetUnitRulesParams'''
( number unitID ) -> nil | { [rule1] = number value1, [rule2] = number value2, ... }

=== Mod-/Map-Options ===
'''Spring.GetModOptions'''
( ) -> {} | { "keyName1" = string "value", "keyName2" = string "value", ... }
'''Spring.GetMapOptions'''
( ) -> {} | { "keyName1" = string "value", "keyName2" = string "value", ... }

=== Speed/Time ===
'''Spring.GetGameSpeed'''
( ) -> number userSpeedFactor, number speedFactor, boolean paused
'''Spring.GetGameFrame'''
( ) -> number frameNum%dayFrames, number frameNum/dayFrames
'''Spring.GetGameSeconds'''
( ) -> number seconds

=== Vectors ===
'''Spring.GetWind'''
( ) -> number dirX, number dirY, number dirZ,
number strength, number normDirX, number normDirY, number normDirZ

'''Spring.GetHeadingFromVector'''
( number x, number z ) -> number heading
'''Spring.GetVectorFromHeading'''
( number heading ) -> number x, number z

== Teams ==
=== StartBoxes/StartPositions ===
'''Spring.GetAllyTeamStartBox'''
( number allyID ) -> nil | number xmin, number zmin, number xmax, number zmax
'''Spring.GetTeamStartPosition'''
( number teamID ) -> nil | number x, number y, number z

=== Player,Team,Ally Lists/Info ===
'''Spring.GetPlayerList'''
( [number teamID, boolean onlyActive] ) -> nil | { [1] = number playerID, etc... }
'''Spring.GetTeamList'''
( [number allyTeamID] ) -> nil | { [1] = number teamID, etc... }
'''Spring.GetAllyTeamList'''
( ) -> { [1] = number allyTeamID, etc... }

'''Spring.GetPlayerInfo'''
( number playerID ) ->
nil | string "name", (in synced code this is "SYNCED_NONAME"!)
boolean active,
boolean spectator,
number teamID,
number allyTeamID,
number pingTime,
number cpuUsage,
string country,
number rank
'''Spring.GetPlayerControlledUnit'''
( number playerID ) -> nil | number unitID

'''Spring.GetTeamInfo'''
( number teamID ) ->
nil | number teamNum,
number leader,
boolean isDead,
boolean isAiTeam,
string "side",
number allyTeam
'''Spring.GetTeamResources'''
( number teamID, string "metal" | "energy" ) ->
nil | number currentLevel,
number storage,
number pull,
number income,
number expense,
number share,
number sent,
number received
'''Spring.GetTeamUnitStats'''
( number teamID ) ->
nil | number killed,
number died,
number capturedBy,
number capturedFrom,
number received,
number sent
'''Spring.GetTeamStatsHistory'''
( number teamID, number startTime, number endTime ) ->
{
[1] = {
"frame" = number,
"metalUsed" = number,
"metalProduced" = number,
"metalExcess" = number,
"metalReceived" = number,
"metalSent" = number,
"energyUsed" = number,
"energyProduced" = number,
"energyExcess" = number,
"energyReceived" = number,
"energySent" = number,
"damageDealt" = number,
"damageReceived" = number,
"unitsProduced" = number,
"unitsDied" = number,
"unitsReceived" = number,
"unitsSent" = number,
"unitsCaptured" = number,
"unitsOutCaptured" = number,
"unitsKilled" = number
}, ...
}
'''Spring.GetTeamLuaAI'''
( number teamID ) -> string "luaAI"

=== Teams/PlayersAllied ===
'''Spring.AreTeamsAllied'''
( number teamID1, number teamID2 ) -> nil | boolean
'''Spring.ArePlayersAllied'''
( number playerID1, number playerID2 ) -> nil | boolean

== Units ==
=== GetUnits ===
'''Spring.GetAllUnits'''
( ) -> nil | unitTable = { [1] = number unitID, ... }
'''Spring.GetTeamUnits'''
( number teamID ) -> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetTeamUnitsSorted'''
( number teamID ) -> nil |
unitDefTable = {
[number unitDefID] = { [1] = [number unitID], etc... },
etc...
}
'''Spring.GetTeamUnitsCounts'''
( number teamID ) -> nil | countTable = { [number unitDefID] = count, etc... }
'''Spring.GetTeamUnitsByDefs'''
( number teamID, number unitDefID | { number unitDefID1, ... } )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetTeamUnitDefCount'''
( number teamID, number unitDefID ) -> nil | number count
'''Spring.GetTeamUnitCount'''
( number teamID ) -> nil | number count

'''Spring.GetUnitsInRectangle'''
( number xmin, number zmin, number xmax, number zmax [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInBox'''
( number xmin, number ymin, number zmin,
number xmax, number ymax, number zmax [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInSphere'''
( number x, number y, number z, number radius [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInCylinder'''
( number x, number z, number radius [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInPlanes'''
( planes = { [1] = { number nx, number ny, number nz, number d }, etc... } )
-> nil | unitTable = { [1] = number unitID, etc... }

plane normals point towards accepted space,
so the acceptance criteria for each plane is:
radius = unit radius
px, py, pz = unit position
[(nx * px) + (ny * py) + (nz * pz) + (d - radius)] <= 0


'''Spring.GetUnitNearestAlly'''
( number unitID [, number range ] ) -> nil | number unitID
'''Spring.GetUnitNearestEnemy'''
( number unitID [, number range ] ) -> nil | number unitID

=== Unit Informations ===
'''Spring.GetUnitTooltip'''
( number unitID ) -> nil | string tooltip
'''Spring.GetUnitDefID'''
( number unitID ) -> nil | number unitDefID
'''Spring.GetUnitTeam'''
( number unitID ) -> nil | number teamID
'''Spring.GetUnitAllyTeam'''
( number unitID ) -> nil | number allyID
'''Spring.GetUnitLineage'''
( number unitID ) -> nil | number lineage, boolean lineageRoot
'''Spring.GetUnitNeutral'''
( number unitID ) -> nil | boolean neutral
'''Spring.GetUnitHealth'''
( number unitID ) -> nil | number health, number maxHealth, number paralyzeDamage,
number captureProgress, number buildProgress
'''Spring.GetUnitIsDead'''
( number unitID ) -> nil | boolean dead
'''Spring.GetUnitIsStunned'''
( number unitID ) -> nil | boolean stunned_or_inbuild, boolean stunned, boolean inbuild
'''Spring.GetUnitResources'''
( number unitID ) -> nil | number metalMake, number metalUse,
number energyMake, number energyUse
'''Spring.GetUnitExperience'''
( number unitID ) -> nil | number experience
'''Spring.GetUnitStates'''
( number unitID ) -> nil | {
"firestate" = number,
"movestate" = number,
"repeat" = boolean,
"cloak" = boolean,
"active" = boolean,
"trajectory" = boolean,
["autoland" = boolean,]
["autorepairlevel" = number,]
["loopbackattack" = boolean]
}
'''Spring.GetUnitIsActive'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitIsCloaked'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitSelfDTime'''
( number unitID ) -> nil | number
'''Spring.GetUnitStockpile'''
( number unitID ) -> nil | number numStockpiled, number numStockpileQued,
number buildPercent
'''Spring.GetUnitHeight'''
( number unitID ) -> nil | number
'''Spring.GetUnitRadius'''
( number unitID ) -> nil | number
'''Spring.GetUnitPosition'''
( number unitID ) -> nil | number x, number y, number z
'''Spring.GetUnitBasePosition'''
( number unitID ) -> nil | number x, number y, number z
'''Spring.GetUnitDirection'''
( number unitID ) -> nil | number dx, number dy, number dz
'''Spring.GetUnitHeading'''
( number unitID ) -> nil | number heading
'''Spring.GetUnitVelocity'''
( number unitID ) -> nil | number velx, number vely, number velz
'''Spring.GetUnitBuildFacing'''
( number unitID ) -> nil | number
'''Spring.GetUnitIsBuilding'''
( number unitID ) -> nil | number unitID
'''Spring.GetUnitTransporter'''
( number unitID ) -> nil | number unitID
'''Spring.GetUnitIsTransporting'''
( number unitID ) -> nil | { [1] = number unitID, etc... }
'''Spring.GetUnitShieldState'''
( number unitID ) -> nil | number isEnabled, number curPower
'''Spring.GetUnitWeaponState'''
( number unitID [, number weaponNum] ) -> nil |
boolean angleGood, boolean loaded, number reloadFrame, number salvoLeft, number numStockpiled
'''Spring.GetUnitTravel'''
( number unitID ) -> nil | number travel, number travelPeriod
'''Spring.GetUnitLosState'''
( number unitID [, number allyTeamID ] ) -> nil |
{ ["los" = true] [, "radar" = true] [, "typed" = true] }
'''Spring.GetUnitSeparation''' (returns the distance of 2 units)
( number unitID1, number unitID2 [, boolean 2D ] ) -> nil | number distance
'''Spring.GetUnitDefDimensions'''
( number unitDefID ) -> nil |
{
"height" = number,
"radius" = number,
"midx" = number,
"minx" = number,
"maxx" = number,
"midy" = number,
"miny" = number,
"maxy" = number,
"midz" = number,
"minz" = number,
"maxz" = number
}

=== CommandQueues ===

'''Spring.GetUnitCommands'''
( number unitID [, number count] ) -> nil | commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean
}
}, ...
}

'''Spring.GetCommandQueue''' (same as Spring.GetUnitCommands)
( number unitID [, number count] ) -> nil | commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean
}
}, ...
}
'''Spring.GetFullBuildQueue'''
( number unitID ) ->
nil | buildOrders = {
[1] = { [number unitDefID] = number count }, etc...
}
'''Spring.GetRealBuildQueue''' (cleans the buildqueue of things the unit can't build itself)
( number unitID ) ->
nil | buildOrders = {
[1] = { [number unitDefID] = number count }, etc...
}
'''Spring.GetFactoryCommands'''
( number unitID [, number count] ) -> nil | commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean
}
}, ...
}
'''Spring.GetFactoryCounts''' (used to get the buildqueue of a factory, seems screwed o_O)
( number unitID [, number count [, boolean addCMDs ] ] ) -> nil | commandQueueTable = {
[2] = { [number unitDefID | number -cmdID] = number count }, ...
}

=== Command Descriptions/Buttons ===
'''Spring.GetUnitCmdDescs'''
( number unitID [, number startIndex [, number endIndex ] ] ) -> nil | {
[1] = {
"id" = number,
"type" = number,
"name" = string,
"action" = string,
"tooltip" = string,
"texture" = string,
"cursor" = string,
"hidden" = boolean,
"disabled" = boolean,
"showUnique" = boolean,
"onlyTexture" = boolean,

"params" = { [1] = string, ... }
}, ...
}
'''Spring.FindUnitCmdDesc'''
( number unitID, number cmdID ) -> nil | number index

=== Unit Pieces ===
'''Spring.GetUnitPiecePosition'''
( number unitID, number piece ) -> number posx, number posy, number posz
'''Spring.GetUnitPieceDirection'''
( number unitID, number piece ) -> number dirx, number diry, number dirz
'''Spring.GetUnitPieceMatrix'''
( number unitID, number piece ) -> { [1] = number, ... , [16] = number }
'''Spring.GetUnitPieceList'''
( number unitID ) -> { [1] = string "piecename", ... , [pieceNumN] = string "piecename" }
'''Spring.GetUnitPieceMap'''
( number unitID ) -> { "piecename1" = pieceNum1, ... , "piecenameN" = pieceNumN }
'''Spring.GetUnitPieceInfo'''
( number unitID, number piece ) -> {
"name" = string "piecename",
"isEmpty" = boolean,
"children" = { [1] = string "piecename", ... },
"min" = { [1] = number x, [2] = number y, [3] = number z },
"max" = { [1] = number x, [2] = number y, [3] = number z },
"offset" = { [1] = number x, [2] = number y, [3] = number z },
}
'''Spring.GetUnitScriptPiece'''
( number unitID [, number scriptPiece ] )
-> nil | { scriptPieceNum = number modelPieceNum } | number modelPieceNum

This functions translate the COB ScriptPiece numbers into the ModelPiece numbers (the set of
ScriptPieces is a subset of the ModelPieces, means #ScriptPieces <= #ModelPieces), which
is used in all other functions (the "number piece" means always the modelpiece).
So if you get via Cob2Lua a pieceID you have to translate it with this function.
Btw the COB ScriptPiece number is equal with the piece position in the piece definition
in your cob/bos.
'''Spring.GetUnitScriptNames'''
( number unitID )
-> { "cobpiecename1" = ScriptPieceNum1, ... , "cobpiecenameN" = ScriptPieceNumN }

== Features ==
=== GetFeatures ===
'''Spring.GetFeaturesInRectangle'''
( number xmin, number zmin, number xmax, number zmax [,number teamID] )
-> nil | featureTable = { [1] = number featureID, etc... }
'''Spring.GetAllFeatures'''
( ) -> nil | { [1] = number featureID, ... }
'''Spring.GetFeatureList''' // NOTE: this is not really required, now all FeatureDefs are pre-loaded

=== Feature Informations ===
'''Spring.GetFeatureDefID'''
( number featureID ) -> nil | number featureDefID
'''Spring.GetFeatureTeam'''
( number featureID ) -> nil | number teamID
'''Spring.GetFeatureAllyTeam'''
( number featureID ) -> nil | number allyID
'''Spring.GetFeatureHealth'''
( number featureID ) -> nil | number health, number maxHealth, number resurrectProgress
'''Spring.GetFeatureHeight'''
( number featureID ) -> nil | number
'''Spring.GetFeatureRadius'''
( number featureID ) -> nil | number
'''Spring.GetFeaturePosition'''
( number featureID ) -> nil | number x, number y, number z
'''Spring.GetFeatureDirection'''
( number featureID ) -> nil | number dirx, number diry, number dirz
'''Spring.GetFeatureHeading'''
( number featureID ) -> nil | number heading
'''Spring.GetFeatureResources'''
( number featureID ) -> nil | number RemainingMetal, number maxMetal,
number RemainingEnergy, number maxEnergy, number reclaimLeft
'''Spring.GetFeatureNoSelect'''
( number featureID ) -> nil | boolean noSelect
'''Spring.GetFeatureResurrect'''
( number featureID ) -> nil | string UnitDefName, number buildFacing

== COB ==
'''Spring.GetCOBUnitVar'''
( number unitID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBTeamVar'''
( number teamID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBAllyTeamVar'''
( number allyID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBGlobalVar'''
( integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY

== Ground ==
=== Ground Informations ===
'''Spring.GetGroundHeight'''
( number x, number y ) -> number z
'''Spring.GetGroundOrigHeight'''
( number x, number y ) -> number z
'''Spring.GetGroundNormal'''
( number x, number y ) -> number x, number y, number z
'''Spring.GetGroundInfo'''
( number x, number y ) -> string "Type", number metal, number hardness,
number tankSpeed, number kbotSpeed, number hoverSpeed,
number shipSpeed, boolean receiveTracks
'''Spring.GetGroundBlocked'''
( number x, number y |
number x1, number y1, number x2, number y2 )
-> nil | string "feature", number featureID | string "unit", number unitID
'''Spring.GetGroundExtremes'''
( ) -> nil | number minHeight, number maxHeight

=== Test Building ===
'''Spring.TestBuildOrder'''
( number unitDefID, number x, number y, number z, number facing)
-> number blocking [,number featureID]

blocking can be:
0 - blocked
1 - mobile unit in the way
2 - free (or if featureID is != 0 then with a blocking feature that can be reclaimed)
'''Spring.Pos2BuildPos'''
( number unitDefID, number x, number y, number z ) -> nil | number x, number y, number z

=== PathFinding ===
'''Spring.GetUnitEstimatedPath'''
( number unitID ) -> nil | {
[1] = { x,y,z }, ...
},{
[1] = startIdxOfDetailedPath,
[2] = startIdxOfDetailedEstimatedPath1,
[3] = startIdxOfDetailedEstimatedPath2,
}
GetUnitEstimatedPath() returns 2 tables:
1 table the waypoints and 1 table with indices (in the waypoint table)
when a new (more lazy) pathfinding algorithm begins.
So the waypoint table contains 3 different levels of details.

=== LOS ===
'''Spring.GetPositionLosState'''
( number x, number y, number z [, number allyID] )
-> boolean visible, boolean inLos, boolean inAirLos, boolean inRadar
'''Spring.GetClosestValidPosition''' //NOT FINISHED YET
( number unitDefID, number x, number z, number r ) -> nil

Lua UnsyncedCtrl

2008-07-28T07:17:53Z

JK: /* Pipes */

== Pipes ==
'''Spring.Echo'''
( arg1 [, arg2 [, ... ] ] ) -> nil

Usefull for debugging. Prints values in the spring chat console (hint: the default print() writes to STDOUT).

'''Spring.PlaySoundFile'''
( string "soundfile" [, number volume
[, number x, number y, number z ] ] ) -> nil | boolean

Plays WAV sounds. By default, the soundfile is expected to be in the "Sounds" folder.

'''Spring.PlaySoundStream'''
( string "oggfile" [, number volume = 1.0
[, number x, number y, number z ]] ) -> nil | boolean true
Allow you to play an Ogg Vorbis (.OGG) compressed sound file. Note: you may only play _ONE_ stream at a time. If another stream is playing and you try to start a second one the call will fail, and silence will result. Note2: the file has to be on the local filesystem, so you can't playback ogg's in your mod with this command, to do so you have to extract it before and save it on the local filesystem.

'''Spring.StopSoundStream'''
( ) -> nil
Terminates any SoundStream is running. Since only one may play at any time (see above), this can be used as an interrupt.

== SendMessage ==
'''Spring.SendMessage'''
( string "message" ) -> nil

'''Spring.SendMessageToPlayer'''
( number playerID, string "message" ) -> nil

'''Spring.SendMessageToTeam'''
( number teamID, string "message" ) -> nil

'''Spring.SendMessageToAllyTeam'''
( number allyID, string "message" ) -> nil

'''Spring.SendMessageToSpectators'''
( string "message" ) -> nil

== Unit Selection ==
'''Spring.SelectUnitMap'''
( { [unitID] = anything, ...} [,boolean append] ) -> nil
'''Spring.SelectUnitArray'''
( { [1] = unitID1 , [2] = unitID2 , ...} [,boolean append] ) -> nil

== Unit Control ==
'''Spring.SetUnitNoDraw''' LuaGadgets only!
( number unitID, boolean noDraw ) -> nil
'''Spring.SetUnitNoSelect''' LuaGadgets only!
( number unitID, boolean noSelect ) -> nil
'''Spring.SetUnitNoMinimap''' LuaGadgets only!
( number unitID, boolean noMinimap ) -> nil

== GUI ==
'''Spring.SetDrawSky'''
( boolean drawSky ) -> nil
'''Spring.SetDrawWater'''
( boolean drawWater ) -> nil
'''Spring.SetDrawGround'''
( boolean drawGround ) -> nil

'''Spring.DrawUnitCommands'''
( number unitID ) -> nil
( { [1] = unitID, ... } [, false ] ) -> nil
( { [unitID] = anything, ... }, true ) -> nil

'''Spring.SetTeamColor'''
( number teamID, number r, number g, number b ) -> nil
'''Spring.AssignMouseCursor''' default hotspot is center!
( string "cmdName", string "iconFileName"
[, boolean overwrite [, boolean hotSpotTopLeft] ] ) -> nil | boolean
'''Spring.ReplaceMouseCursor''' default hotspot is center!
( string "oldFileName", string "newFileName" [, boolean hotSpotTopLeft] ) -> nil | boolean

'''Spring.SetCustomCommandDrawData''' register your custom cmd so it gets visible in the unit's cmd queue
( number cmdID,
number cmdIconID | string iconname | nil,
{ number r, number g, number b, number a } [, boolean showArea ] ) -> nil | true

== Camera ==
'''Spring.SetCameraState'''
( table camState, number camTime) -> nil | boolean
camState = {
mode = cameraID,
1 = cameraID,
2 = posX,
3 = posY,
4 = posZ,
5 = dirX,
6 = dirY,
7 = dirZ,
... and more (depending on the camera ...
}

'''Spring.SetCameraTarget'''
( number x, number y, number z [,number transTime] ) -> nil

== World Primitives ==
outdated! use opengl api instead!

'''Spring.AddWorldIcon'''
( number cmdID, number x, number y, number z ) -> nil
'''Spring.AddWorldText'''
( string "text", number x, number y, number z ) -> nil
'''Spring.AddWorldUnit'''
( number unitDefID,
number x, number y, number z,
number team, number facing) -> nil

Lua UnsyncedCtrl

2008-07-28T07:16:23Z

JK: /* Pipes */

== Pipes ==
'''Spring.Echo'''
( arg1 [, arg2 [, ... ] ] ) -> nil

Usefull for debugging. Prints values in the spring chat console (hint: the default print() writes to STDIN).

'''Spring.PlaySoundFile'''
( string "soundfile" [, number volume
[, number x, number y, number z ] ] ) -> nil | boolean

Plays WAV sounds. By default, the soundfile is expected to be in the "Sounds" folder.

'''Spring.PlaySoundStream'''
( string "oggfile" [, number volume = 1.0
[, number x, number y, number z ]] ) -> nil | boolean true
Allow you to play an Ogg Vorbis (.OGG) compressed sound file. Note: you may only play _ONE_ stream at a time. If another stream is playing and you try to start a second one the call will fail, and silence will result. Note2: the file has to be on the local filesystem, so you can't playback ogg's in your mod with this command, to do so you have to extract it before and save it on the local filesystem.

'''Spring.StopSoundStream'''
( ) -> nil
Terminates any SoundStream is running. Since only one may play at any time (see above), this can be used as an interrupt.

== SendMessage ==
'''Spring.SendMessage'''
( string "message" ) -> nil

'''Spring.SendMessageToPlayer'''
( number playerID, string "message" ) -> nil

'''Spring.SendMessageToTeam'''
( number teamID, string "message" ) -> nil

'''Spring.SendMessageToAllyTeam'''
( number allyID, string "message" ) -> nil

'''Spring.SendMessageToSpectators'''
( string "message" ) -> nil

== Unit Selection ==
'''Spring.SelectUnitMap'''
( { [unitID] = anything, ...} [,boolean append] ) -> nil
'''Spring.SelectUnitArray'''
( { [1] = unitID1 , [2] = unitID2 , ...} [,boolean append] ) -> nil

== Unit Control ==
'''Spring.SetUnitNoDraw''' LuaGadgets only!
( number unitID, boolean noDraw ) -> nil
'''Spring.SetUnitNoSelect''' LuaGadgets only!
( number unitID, boolean noSelect ) -> nil
'''Spring.SetUnitNoMinimap''' LuaGadgets only!
( number unitID, boolean noMinimap ) -> nil

== GUI ==
'''Spring.SetDrawSky'''
( boolean drawSky ) -> nil
'''Spring.SetDrawWater'''
( boolean drawWater ) -> nil
'''Spring.SetDrawGround'''
( boolean drawGround ) -> nil

'''Spring.DrawUnitCommands'''
( number unitID ) -> nil
( { [1] = unitID, ... } [, false ] ) -> nil
( { [unitID] = anything, ... }, true ) -> nil

'''Spring.SetTeamColor'''
( number teamID, number r, number g, number b ) -> nil
'''Spring.AssignMouseCursor''' default hotspot is center!
( string "cmdName", string "iconFileName"
[, boolean overwrite [, boolean hotSpotTopLeft] ] ) -> nil | boolean
'''Spring.ReplaceMouseCursor''' default hotspot is center!
( string "oldFileName", string "newFileName" [, boolean hotSpotTopLeft] ) -> nil | boolean

'''Spring.SetCustomCommandDrawData''' register your custom cmd so it gets visible in the unit's cmd queue
( number cmdID,
number cmdIconID | string iconname | nil,
{ number r, number g, number b, number a } [, boolean showArea ] ) -> nil | true

== Camera ==
'''Spring.SetCameraState'''
( table camState, number camTime) -> nil | boolean
camState = {
mode = cameraID,
1 = cameraID,
2 = posX,
3 = posY,
4 = posZ,
5 = dirX,
6 = dirY,
7 = dirZ,
... and more (depending on the camera ...
}

'''Spring.SetCameraTarget'''
( number x, number y, number z [,number transTime] ) -> nil

== World Primitives ==
outdated! use opengl api instead!

'''Spring.AddWorldIcon'''
( number cmdID, number x, number y, number z ) -> nil
'''Spring.AddWorldText'''
( string "text", number x, number y, number z ) -> nil
'''Spring.AddWorldUnit'''
( number unitDefID,
number x, number y, number z,
number team, number facing) -> nil

Weapon Variables

2008-07-25T22:48:05Z

JK: /* Descriptions */

=WeaponType=
This is a weapon tag! It allows you to bypass the engine's auto detection and force the weapontype. (example weaponType="StarburstLauncher")
<table width=730 border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;">
<TR><th>WeaponType</th><th> Description </th> </tr>
<TR>
<TD>AircraftBomb (dropped=1)</TD>
<TD>Drops a ballistic projectile (aka Plasma) at the same movement vector as the unit itself. It's only meant for planes. A plane that has a CBombDropper as its weapon1 is a bomber. The CBombDropper automatically calculates its burst and burstrate tags from its reload time and uses 5 as its reload time instead. It will fire if the first bomb would drop within a circle roughly unitspeed*burst*burstrate so the longer the burst and the faster the unit the larger the circle in which it will drop instead of not firing and hoping the next attack run will pass that circle.</TD>
</TR>
<TR>
<TD>StarburstLauncher(vlaunch=1)</TD>
<TD>Fires a projectile that rises vertically (starts with no velocity) for <weapontimer> seconds, then turns at a fixed rate towards its target. The projectile's lifetime depends on its range divided by its max speed (ignores acceleration) and the weapontimer somehow so the weapon can fall short depending on how these values are set. This is the only weapon that can properly perform intercepts and be interceptable. Emits a smoketrail.</TD>
</TR>
<TR>
<TD>BeamLaser (beamlaser=1)</TD>
<TD>Should be well known, this thing spawns a beam and does a portion of its total damage each frame. It can't have a burst or burstrate, it can't have collidefriendly=0, it can't be emit-sfxed if it has a beamtime longer than one frame and its damage decreases over range if the minIntensity=1 tag isn't used. The largebeamlaser tag allows changing the visual effect of the laser, doesn't affect the behaviour of the weapon itself in any way though. Beamlasers can be really annoying... BTW, their beam doesn't collide with water so if they're set to waterweapon=1 they can shoot normally even when underwater (won't shoot at underwater targets though).</TD>
</TR>
<TR>
<TD>Shield (isShield=1)</TD>
<TD>The shield. Really not much to say about this, the tags are all documented in the changelog.</TD>
</TR>
<TR>
<TD>TorpedoLauncher (waterweapon=1)</TD>
<TD>Fires a projectile that will behave ballistically out of water and like a missile in water. Since waterweapon=1 is usually set for them they can fire underwater and they will target underwater units. The torpedo is the only projectile that doesn't explode on the water surface. An aircraft carrying a TorpedoLauncher is a special case, the thing turns into a bomb dropepr that will spawn a torpedo projectile, probably to get the whole bomber flight behaviour. Note that the waterweapon tag is also used to make a weapon fire underwater, independent of its type.</TD>
</TR>
<TR>
<TD>DGun (weaponname contains the word "disintegrator")</TD>
<TD>This shoots a fireball that travels in a straight line. The fireball has no range limitation by itself so if it misses or is fired in FPS mode it will travel across the whole map and further. DGuns don't properly check their line of fire, if terrain is in the way they fire anyway. These things are meant to be used with noexplode=1 but of course you CAN use them without that, too. If ballistic=1 is set the fireball will be affected by gravity, the weapon won't compensate for it though so it will hit the ground before reaching the target. Might be useful for a Scorched Earth mod or something since you'd have to aim it manually to hit anything.</TD>
</TR>
<TR>
<TD>LightingCannon (sic) (lineofsight=1 and rendertype=7)</TD>
<TD>An instant hit weapon like the Beamlaser except with a lightning graphic and even more annoying. It won't damage shields and it has a hardcoded inaccuracy (comparable to targetMoveError, the code comment is "should make it weaker against air"...). Shares some of the weirdnesses with the beamlaser, e.g. being able to penetrate water.</TD>
</TR>
<TR>
<TD>LaserCannon (lineofsight=1 and either beamweapon=1 or weaponname contains "laser" (marked as "workaround for SWTA))</TD>
<TD>The OTA-style laser. Probably one of the least annoying weapons in the engine. Its length is defined by the duration tag (together with the speed), BTW.</TD>
</TR>
<TR>
<TD>MissileLauncher (lineofsight=1 and smoketrail=1)</TD>
<TD>Shoots a smoke-emitting projectile. It can use guidance, acceleration, etc. The projectile's lifetime depends on range/maxspeed so a slowly accelerating missile will fall short. It can also use trajectoryheight to have the shot arc but that has trouble with aiming at targets higher or lower than the shooter (see bug report, this REALLY could use some fixing). Pretty versatile weapon overall, if the laser rendering code was ported into this we could pretty much axe the LaserCannon completely.</TD>
</TR>
<TR>
<TD>EmgCannon (lineofsight=1 and rendertype=4 and color=2)</TD>
<TD>Few know about this, it's a line of sight (i.e. not ballistic) weapon that can use billboard rendering (looks like a sprite). No idea what drawbacks this has, noone ever uses it.</TD>
</TR>
<TR>
<TD>Flame (lineofsight=1 and rendertype=5)</TD>
<TD>The flamethrower. A really annoying weapon. AFAIK it won't even aim ahead of moving targets. Can't say much else about it since I haven't tried using it much but overall I'd avoid the weapontype and fake the effect somehow, it's not pretty when fast and won't hit jack when slow.</TD>
</TR>
<TR>
<TD>Cannon (anything that didn't trigger another weapon)</TD>
<TD>Aka plasma. Shoots a ballistic projectile. Unlike the DGun it aims properly. Can't be emit-sfxed properly, maybe a ballistic DGun can fill that role.</TD>
</TR>
<TR>
<TD>Melee (only reachable through WeaponType)</TD>
<TD>When it fires it simply damages the target, no ifs or buts. It doesn't use a projectile and doesn't care about the line of fire. It won't even report a proper heading and pitch to AimWeapon so if you plan on using it in 75b2 you have to slave it to another weapon to handle the aiming. May be useful to be the damage dealer for a cosmetic weapon, i.e. you slave the Melee to a weapon that does no damage but looks pretty and the Melee does the damage. Kinda like the weapons in Warcraft and so.</TD>
</TR>
<TR>
<TD>Rifle (only reachable through WeaponType)</TD>
<TD>An instant hit weapon but an apparently unmaintained one. It has a hardcoded firing and explosion effect. I wouldn't use it.</TD>
</TR>
<TR>
<TD>CNoWeapon (weaponname is NOWEAPON, not reachable by any tag)</TD>
<TD>Apparently a placeholder used when a weapon isn't present. It's not really a weapondef but generated when the unit demands a NOWEAPON.</TD></TR>
</table>

=Descriptions=
<table width=730 border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;">
<TR><th>Variable </th><th> Description </th><th> Examples</Th> </tr>
<TR>
<TD>Accuracy</TD>
<TD>How accurate a weapon is. A larger number is less accurate. If this tag is missing entirely, it has perfect accuracy unless its target moves unexpectedly. Accuracy is relative to the distance to the target; for instance, if the target is very close, even a very high accuracy value will probably still hit. If a target is very far away, even a very low accuracy value will likely cause the weapon to miss. Can be any numeric value.</TD>
<TD>accuracy=400;</TD>
</TR>
<TR>
<TD>AlwaysVisible</TD>
<TD>Ignore LOS handling and always draw the weapon effect? Can be 1 or 0.</TD>
<TD>alwaysVisible=0;</TD>
</TR>
<TR>
<TD>AreaOfEffect</TD>
<TD>How large the weapon's impact explosion is. This affects how powerful the weapon's default impulse strength will be. Currently, BeamLasers with an AreaOfEffect of 16 or above will deform the ground at their point of impact regardless of whether it has been told not to. Can be any numeric value, but should generally be at least 8, regardless of the type of weapon.</TD>
<TD>areaofeffect=192;</TD>
</TR>
<TR>
<TD>AvoidFeature</TD>
<TD>This makes the weapon avoid features while targetting (the shoot will still collide with features). Can be 1 or 0.</TD>
<TD>avoidFeature=0;</TD>
</TR>
<TR>
<TD>AvoidFriendly</TD>
<TD>If set to 0 units will not try to avoid friendly units in their line of fire. Can be 1 or 0.</TD>
<TD>avoidFriendly=1;</TD>
</TR>
<TR>
<TD>Ballistic</TD>
<TD>Set to 1 for the weapon to be subjected to gravity, travelling in an arc through the air, such as cannons. Ballistic is mutually exclusive to LineOfSight and Dropped. Can be 1 or 0.</TD>
<TD>ballistic=1;</TD>
</TR>
<TR>
<TD>BeamDecay</TD>
<TD>For BeamLasers, defines the speed of the fadeout (each frame the beam's intensity is multiplied with that value). Can be between 0 and 1.</TD>
<TD>beamDecay=0.9;</TD>
</TR>
<TR>
<TD>BeamLaser</TD>
<TD>Whether this weapon is a beam laser or not. Beam lasers instantly hit their targets. Rendertype must be 0. Mutually exclusive to BeamWeapon. Can be 1 or 0.</TD>
<TD>beamlaser=1;</TD>
</TR>
<TR>
<TD>BeamTime</TD>
<TD>How long to fire the laser before waiting for ReloadTime to start. Can be any numeric value. Defaults to 1.</TD>
<TD>beamtime=0.5;</TD>
</TR>
<TR>
<TD>BeamTTL</TD>
<TD>For BeamLasers, defines the time (in frames) the beam will stay after being fired. Can be any numeric value.</TD>
<TD>beamTtl=10;</TD>
</TR>
<TR>
<TD>BeamWeapon</TD>
<TD>Whether this weapon is a regular laser or not. BeamWeapons (lasers) do not instantly hit their targets, and are affected by the weaponvelocity tag. Mutually exclusive to BeamLaser. Can be 1 or 0.</TD>
<TD>beamweapon=1;</TD>
</TR>
<TR>
<TD>BounceRebound</TD>
<TD>The amount of vertical velocity a projectile keeps when it bounces. Generally .3-1, but 0 for a sticky bomb, or 2 for a flubber bomb. Defaults to 1</TD>
<TD>bouncerebound=.8;</TD>
</TR>
<TR>
<TD>BounceSlip</TD>
<TD>The amount of horizontal velocity a projectile keeps when it bounces. Generally .3-1, but 0 for a sticky bomb, or 2 for a flubber bomb. Defaults to 1</TD>
<TD>bounceslip=.8;</TD>
</TR>
<TR>
<TD>BurnBlow</TD>
<TD>The weapon blows up when it reaches range the target was at when the weapon fired. Only works on plasma (rendertype=4) weapons and possibly missiles? Can be 1 or 0. A common usage is on flak guns.</TD>
<TD>burnblow=1;</TD>
</TR>
<TR>
<TD>Burst</TD>
<TD>How many shots are in a burst. Must be accompanied by burstrate. Can be any numeric value.</TD>
<TD>burst=3;</TD>
</TR>
<TR>
<TD>BurstRate</TD>
<TD>How fast the Burst fires. If set much below 0.1, it stops having any discernable effect.</TD>
<TD>burstrate=0.1</TD>
</TR>
<TR>
<TD>CameraShake</TD>
<TD>How much the camera shakes on impact. (needs the cameraShake widget to work). Can be any numeric value.</TD>
<TD>cameraShake=5;</TD>
</TR>
<TR>
<TD>CanAttackGround</TD>
<TD>Can be set to 1 or 0.</TD>
<TD>canAttackGround=0</TD>
</TR>
<TR>
<TD>CegTag</TD>
<TD>CegTag is the tag that emits a custom explosion every frame for a projectile. Can be used on any weapon to imitate dynamic lighting, smoke, fire, ball lightning, magic and many other things. Enter the name of your effect to make it emit once per frame.</TD>
<TD>cegtag=MISSILE_SMOKE_FX;</TD>
</TR>
<TR>
<TD>Color</TD>
<TD>An obsolete tag only recognized for compatibility purposes. While this still works for lasers, using rgbcolor=X X X; is a much, much better route. Plus, the RGBColor tag will override any color=x; tags in the tdf. </TD>
<TD>color=1;</TD>
</TR>
<TR>
<TD>Color2</TD>
<TD>An obsolete tag only recognized for compatibility purposes.</TD>
<TD>color=2;</TD>
</TR>
<TR>
<TD>ColorMap</TD>
<TD>Only used by flamethrower. Must be a CColorMap type.</TD>
<TD>colorMap=1 0 0 1  0 1 0 1; (red to green fade)</TD>
</TR>
<TR>
<TD>CollideFriendly</TD>
<TD>If set to 0 this weapon will not hit friendly units. Can be set to 1 or 0.</TD>
<TD>collisionFriendly=1;</TD>
</TR>
<TR>
<TD>CollisionSize</TD>
<TD>Defines the physical size of projectiles, percentage of size for flamethrower and absolute value emg, plasma and laser. Can be any numeric value.</TD>
<TD>collisionSize=30;</TD>
</TR>
<TR>
<TD>CommandFire</TD>
<TD>When ordered to attack ground this weapon will only fire once, rather than continuously. This does not work when ordered to attack units (It will continue to fire until the target is dead). If the unit has CanDgun=1 in its FBI, commandfire will identify that weapon with the dgun button. The weapon wont fire unless the dgun button is pressed. Can be set to 1 or 0.</TD>
<TD>commandfire=1;</TD>
</TR>
<TR>
<TD>CoreThickness</TD>
<TD>Thickness of the core of a laser (the part which use rgbcolor2). Can be any numeric value.</TD>
<TD>coreThickness=0.25;</TD>
</TR>
<TR>
<TD>Coverage</TD>
<TD>The range for anti-weapon weapons, like antinukes. This will be shown on the minimap as a guide. Can be any numeric value.</TD>
<TD>coverage=1280;</TD>
</TR>
<TR>
<TD>CraterBoost</TD>
<TD>Adds a constant factor to the terraform the explosion does. Can be any numeric value. (default 0)</TD>
<TD>craterMult=0.1;</TD>
</TR>
<TR>
<TD>CraterMult</TD>
<TD>Multiplies with the terraform the explosion does. Can be any numeric value. (default :=impulsFactor)</TD>
<TD>craterMult=1.2;</TD>
</TR>
<TR>
<TD>CylinderTargetting</TD>
<TD>If greater than 0, range will be checked in a cylinder instead of a sphere:
half height=unitradius*cylinderTargetting
Defaults to 1 for Melee type weapons, 0 otherwise. In 0.76b1, does not work with BeamLaser weapons.([http://spring.clan-sy.com/phpbb/viewtopic.php?p=219659#p219659 image])</TD>
<TD>cylinderTargetting=0;</TD>
</TR>
<TR>
<TD>Dance</TD>
<TD>For missles, unlike wobble it doesn't rotate the missile and it prevents the missile from going too far off course so a dancing swarm will remain coherent. Can be any numeric value.</TD>
<TD>dance=97;</TD>
</TR>
<TR>
<TD>Dropped</TD>
<TD>Sets the weapon to be dropped, like from a bomber. Must be RenderType=6 and needs the Model tag to be specified. Mutually exclusive to Ballistic and LineOfSight. Can be set to 1 or 0.</TD>
<TD>dropped=1;</TD>
</TR>
<TR>
<TD>Duration</TD>
<TD>For how many seconds a beam weapon will be fired before waiting for reload time. Also controls the length of the beam in BeamWeapon projectiles. Can be any numeric value. Used for rendertype 0 and 7 weapons.</TD>
<TD>duration=.5;</TD>
</TR>
<TR>
<TD>DynDamageExp</TD>
<TD>Exponent of the range damage formula, 0 (the default) disables dynamic damage. 1 means linear scaling. Only used by BeamLasers and LightingCannons. Can be any numeric value. ([http://spring.clan-sy.com/phpbb/viewtopic.php?p=263438#p263438 image])</TD>
<TD>dynDamageExp=0;</TD>
</TR>
<TR>
<TD>DynDamageInverted</TD>
<TD>Inverts the damage curve (more damage at far range). Only used by BeamLasers and LightingCannons. Can be 0 or 1.</TD>
<TD>dynDamageInverted=0;</TD>
</TR>
<TR>
<TD>DynDamageMin</TD>
<TD>Minimum dynamic range damage value. Only used by BeamLasers and LightingCannons. Can be any numeric value.</TD>
<TD>dynDamageMin=0;</TD>
</TR>
<TR>
<TD>DynDamageRange</TD>
<TD>If set it will use this value in the dynamic range damage formula instead of the range value from the weapon in the calculation. Only used by BeamLasers and LightingCannons. Can be any numeric value.</TD>
<TD>DynDamageRange=400;</TD>
</TR>
<TR>
<TD>EdgeEffectiveness</TD>
<TD>Determines what percent of a weapon's maximum damage value will be applied to units as they are closer to the outer edge of the weapon's AreaOfEffect. Must have a decimal value between 0 and 1. Default in OTA was 0, probably the same in Spring. ([http://spring.clan-sy.com/phpbb/viewtopic.php?p=251180#p251180 image])</TD>
<TD>edgeEffectiveness=0.25;</TD>
</TR>
<TR>
<TD>EnergyPerShot</TD>
<TD>Energy used per shot. If the specified amount of energy is not available, the weapon will not be able to shoot. Can also be used to specify how much a Stockpile weapon wll cost to build. Can be any numeric value.</TD>
<TD>energypershot=5;</TD>
</TR>
<TR>
<TD>ExplosionSpeed</TD>
<TD>Explosion animation speed/time. (only used by BeamLaser and LightingCannon?) default:
gd=max(30, DefaultDamage/20); 
expSpeed=(8+(gd*2.5))/(9+(sqrt(gd)*.7))/2; 
Can be any numeric value.
</TD>
<TD>explosionSpeed=5;</TD>
</TR>
<TR>
<TD>FallOffRate</TD>
<TD>Rate at which the beamweapon fades out after it goes past its maximum range. 0 is never fade out, 1 is finish fading out exactly at max range, the default 0.5 is the previous behaviour.
<TD>FallOffRate=0.5;</TD>
</TR>
<TR>
<TD>FireStarter</TD>
<TD>How likely the weapon will set trees on fire. High values make trees likey to be set on fire, low values make trees likely to just explode or tip over. Can be any numeric value between 0 and 100.</TD>
<TD>fireStarter=75;</TD>
</TR>
<TR>
<TD>FireSubmersed</TD>
<TD>If set the weapon can fire underwater, if not then not. Use it for weapons that cannot fire underwater but can hit underwater targets. Works even for torpedoes. Can be 0 or 1.</TD>
<TD>fireSubmersed=1;</TD>
</TR>
<TR>
<TD>FixedLauncher</TD>
<TD>For missiles, starburst missiles and torpedoes, this makes the projectile spawn with the orientation of the shooting piece instead of their normal orientation. The weapon will not properly check if allies are in the way so make sure you align the launchers in a way that won't hammer right into your own forces and perhaps use collideFriendly=0. FixedLauncher conflicts with trajectoryHeight and IMO combining them is pointless anyway so don't use both on a weapon. Can be 0 or 1.</TD>
<TD>fixedLauncher=0;</TD>
</TR>
<TR>
<TD>FlameGFXTime</TD>
<TD>Makes the flamethrower projectile stay alive as a graphical effect (doesnt do any damage) after it has reached maxrange. It is defined in percent, so 1.2 makes it remain 20% beyond maxrange. Can be any numeric value.
<TD>flamegfxtime=1.2;</TD>
</TR>
<TR>
<TD>FlightTime</TD>
<TD>Can be any numeric value.</TD>
<TD>flightTime=10;</TD>
</TR>
<TR>
<TD>GroundBounce</TD>
<TD>Weather the weapon projectile will bounce on the ground (on land or the ocean floor). Can be 0 or 1, defaults to 0 (off)</TD>
<TD>groundbounce=1;</TD>
</TR>
<TR>
<TD>Guidance</TD>
<TD>Specifies whether or not the weapon is capable of correcting its trajectory mid-flight. Will not track a moving target. Works only on missile and torpedo weapons. Can be set to 1 or 0. See TurnRate for information on specifying how well a weapon can track a target. Requires rendertype=1, lineofsight=1, and selfprop=1;</TD>
<TD>guidance=1;</TD>
</TR>
<TR>
<TD>HardStop</TD>
<TD>For LaserCannon, defined if the laser effect hard stops or fade out. Can be 0 or 1.</TD>
<TD>hardStop=0;</TD>
</TR>
<TR>
<TD>HeightBoostFactor</TD>
<TD>Gives control of cannon height range boost (more than 1 means increased range, 0 means the cannon has fixed range regardless of height difference to target. default is a magic value calculated on weapon init, based on range tag and theoretical max range.). Can be any numeric value, including negative ones (<0 := automatically calculated).</TD>
<TD>heightBoostFactor=-1;</TD>
</TR>
<TR>
<TD>HeightMod</TD>
<TD>Changes the sphere weapon range into an ellipsis. If it is larger 1.0 the weapon can't shoot as height as far, i.e. 0.5 means it can shoot twice as height as far ([http://spring.clan-sy.com/phpbb/viewtopic.php?p=219659#p219659 image]). Note that this may not work well with beam weapons, use minIntensity (0..1) tag to fix that.</TD>
<TD>heightMod=1;</TD>
</TR>
<TR>
<TD>ImpulseBoost</TD>
<TD>A constant factor added on the weapon's impulsefactor. Can be any numeric value, including negative ones.</TD>
<TD>impulseBoost=0.5;</TD>
</TR>
<TR>
<TD>ImpulseFactor</TD>
<TD>The multiplier on the weapon's default impulsefactor, which is determined based on a weapon's default damage and AreaOfEffect. The impulse of a weapon is how strong of a kinetic force will be applied to its target or anything near the point of impact. Can be any numeric value, including negative ones.</TD>
<TD>impulsefactor=2.5;</TD>
</TR>
<TR>
<TD>Intensity</TD>
<TD>Alpha (brighness and washout effect) of the weapon. Can be used on any rendertype 0, 3, or 4 weapon. Can be any numeric value.</TD>
<TD>intensity=1.5;</TD>
</TR>
<TR>
<TD>InterceptedByShieldType</TD>
<TD>Bitfield representing the types of shields that can intercept this weapon. The best way to think about this is to think of it as the resulting binary. Every digit of binary that is set to one means that a shield with that digit set to one will intercept this weapon, for instance, the example will result in the weapons being blocked by shields with types 1 and/or 3. Maxium of 32 unique types. See [[Shield Interception Tag Use]].</TD>
<TD>InterceptedByShieldType=5;</TD>
</TR>
<TR>
<TD>Interceptor</TD>
<TD>Can intercept missiles with the Cruise tag.</TD>
<TD>interceptor=1;</TD>
</TR>
<TR>
<TD>LargeBeamLaser</TD>
<TD>If set to 1 a beamlaser uses an alternate graphics effect. Can be 0 or 1.</TD>
<TD>largeBeamLaser=0;</TD>
</TR>
<TR>
<TD>LaserFlareSize</TD>
<TD>Size of the flare for laser weapons, multiplier for thickness. Can be set to any numeric value. (default: 15)</TD>
<TD>laserFlareSize=15;</TD>
</TR>
<TR>
<TD>Leadbonus</TD>
<TD>Is multiplied with the unit's experience and added to the lead limit.</TD>
<TD>leadbonus=1;</TD>
</TR>
<TR>
<TD>LeadLimit</TD>
<TD>Limits the maximum distance a unit will lead a target (default is -1 which means infinite).</TD>
<TD>leadLimit=1;</TD>
</TR>
<TR>
<TD>LineOfSight</TD>
<TD>NOT SUPPORTED BY SPRING! 
It is only used to detect the weapontype of ota weapon configs.</TD>
<TD></TD>
</TR>
<TR>
<TD>LodDistance</TD>
<TD>Minimum camera distance at which the default beamweapon projectile is simplified to rectangle. Can be set to any numeric value. (default: 1000)</TD>
<TD>lodDistance=1000;</TD>
</TR>
<TR>
<TD>ManualBombSettings</TD>
<TD>For Bombers, use burst and burstrate tags instead of hardcoded values. Can be set to 1 or 0.</TD>
<TD>manualBombSettings=1;</TD>
</TR>
<TR>
<TD>MetalPerShot</TD>
<TD>Metal used per shot. If the specified amount is not available, the weapon cannot be fired. Can also be used to specify how much a Stockpile weapon wll cost to build. Can be set to any numeric value.</TD>
<TD>metalpershot=500;</TD>
</TR>
<TR>
<TD>MinIntensity</TD>
<TD>For beamlasers - always hit with some minimum intensity (a damage coeffcient normally dependent on distance - range 0 to 1). Can be set to any numeric value.</TD>
<TD>minIntensity=0.1;</TD>
</TR>
<TR>
<TD>Model</TD>
<TD>The 3DO or S3O model to be used as this weapon's physical representation. 3DO modesl do not need a .3do extension, but S3O weapon do.</TD>
<TD>model=missile;</TD>
</TR>
<TR>
<TD>MovingAccuracy</TD>
<TD>A weapon's accuracy while moving. See Accuracy. Can be any numeric value.</TD>
<TD>movingaccuracy=1000;</TD>
</TR>
<TR>
<TD>MyGravity</TD>
<TD>For ballistic weapons (Cannon and Bomb), it overrides the map gravity if used. Regular map gravity is around 0.2.</TD>
<TD>myGravity=0.2;</TD>
</TR>
<TR>
<TD>NoExplode</TD>
<TD>Whether or not the weapon will explode on impact or continue on its path. An example is the d-gun. Can be set to 1 or 0.</TD>
<TD>noexplode=1;</TD>
</TR>
<TR>
<TD>NoSelfDamage</TD>
<TD>This weapon will not damage the unit that fired it. For instance, a nuke silo could shoot itself and not take any damage if this was active. Can be set to 1 or 0.</TD>
<TD>noselfdamage=1;</TD>
</TR>
<TR>
<TD>NumBounce</TD>
<TD>The maximum number of times a weapon will bounce. -1 for infinite. Defaults to -1</TD>
<TD>numbounce=5;</TD>
</TR>
<TR>
<TD>Paralyzer</TD>
<TD>If active, this weapon will not cause any damage to its target, but will instead paralyze (aka EMP). The default damage value of a weapon with this active will be applied to the target's HP; once the HP is overwhelmed, it will be paralyzed. Can be set to 1 or 0.</TD>
<TD>paralyzer=1;</TD>
</TR>
<TR>
<TD>ParalyzerTime</TD>
<TD>On Paralyzer weapons, determines the maximum length of time the target will be paralyzed (In seconds?). The timer is refreshed every time the target is hit by the weapon. Can be set to any numerical value.</TD>
<TD>paralyzetime=10;</TD>
</TR>
<TR>
<TD>PredictBoost</TD>
<TD>How much should the weapon predict unit speeds (similar to targetMoveError). Default 0 for non-burnblow, 0.5 for burnblow weapons. Can be set to any numerical value (0.0-1.0).</TD>
<TD>predictBoost=1;</TD>
</TR>
<TR>
<TD>Projectiles</TD>
<TD>The weapon fires this many projectiles at once (shotgun style). Make sure you put them on different trajectories somehow (sprayangle or different firepoints) because otherwise they'll all be clumped in one shot. Works well combined with bursts. Can be set to any integer value.</TD>
<TD>projectiles=1;</TD>
</TR>
<TR>
<TD>ProximityPriority</TD>
<TD>Acts as a multiplier for the distance to the target in the priority calculation. Note that negative values make weapons prefer distant targets. Can be set to any numerical value.</TD>
<TD>proximityPriority=1;</TD>
</TR>
<TR>
<TD>PulseSpeed</TD>
<TD>On LargeBeamLaser, how fast the pulsating effect at the beam start is. Can be set to any numerical value.</TD>
<TD>pulseSpeed=15;</TD>
</TR>
<TR>
<TD>Range</TD>
<TD>The maximum range of the weapon. If set to noexplode, the weapon will disappear after this range has been met. If set to burnblow, the weapon will explode after this range has been met. Can be set to any numerical value.</TD>
<TD>range=750;</TD>
</TR>
<TR>
<TD>ReloadTime</TD>
<TD>The amount of time between shots. If a unit is paralyzed, this stops counting down. Can be set to any numerical value.</TD>
<TD>reloadtime=3.5;</TD>
</TR>
<TR>
<TD>Rendertype</TD>
<TD>The way the weapon will be displayed. Certain rendertypes are incompatibile with other tags, but it's generally for a logical reason. The rendertypes are as follows: 0 - Laser, 1 - Model, 3 - Plasma, 4 - Unit explosion (usally), 5 - Flamethrower, 6 - Dropped, 7 - Lightning. There's no documented use of rendertype=2 in OTA, and it probably doesn't do anything in Spring. 3 and 4 are usually interchangeable, both can be used to render a plasma/EMG/whatever shot; this is probably for compatibility.</TD>
<TD>rendertype=1;</TD>
</TR>
<TR>
<TD>RGBColor</TD>
<TD>The color of the rendertype 0, 3, 4, 7 weapon, specified in RED_GREEN_BLUE format.</TD>
<TD>rgbcolor=1 0.3 1; - this would make evul-purple</TD>
</TR>
<TR>
<TR>
<TD>RGBColor2</TD>
<TD>The color at the core of a rendertype 0 (laser) weapon. Specified the same as above. Defaults to white.</TD>
<TD>RGBColor2=0 1 0; - this would make a weird green middle for the evul-purple laser</TD>
</TR>
<TR>
<TD>ScrollSeed</TD>
<TD>Only used by LargeBeamLaser. How fast the beam apears to be moving towards it target. Can be set to any numerical value.</TD>
<TD>scrollSeed=1;</TD>
</TR>
<TR>
<TD>Selfprop</TD>
<TD>Required for Guidance tag. This weapon can propel itself and can have things like acceleration, rather than always travelling at one speed. See Guidance, StartVelocity, WeaponAcceleration, WeaponVelocity. Can be set to 1 or 0.</TD>
<TD>selfprop=1;</TD>
</TR>
<TR>
<TD>Size</TD>
<TD>Defines the visible size of projectiles. Can be set to any numerical value. Default size is 2 + min(damage / 400, areaOfEffect / 10).</TD>
<TD>size=10;</TD>
</TR>
<TR>
<TD>SizeGrowth</TD>
<TD>Defines how fast flame projectiles will grow in size. Can be set to any numerical value.</TD>
<TD>sizegrowth=0.6;</TD>
</TR>
<TR>
<TD>SmokeTrail</TD>
<TD>Does the projectile leave a smoke trail or not. Can be set to 1 or 0.</TD>
<TD>smoketrail=1;</TD>
</TR>
<TR>
<TD>SoundHit</TD>
<TD>The sound made whe the weapon hits. Must reference a .wav file in the .\Sounds directory.</TD>
<TD>soundhit=emghit;</TD>
</TR>
<TR>
<TD>SoundHitVolume</TD>
<TD>Can be any numerical value between 0 and 1.</TD>
<TD>soundhitvolume=0.5;</TD>
</TR>
<TR>
<TD>SoundStart</TD>
<TD>The sound made when the weapon begins to fire. Will fire only once if the weapon is shot in a burst. Must reference a .wav file in the .\Sounds directory.</TD>
<TD>soundstart=emgfire;</TD>
</TR>
<TR>
<TD>SoundStartVolume</TD>
<TD>Can be any numerical value between 0 and 1.</TD>
<TD>soundstartvolume=0.5;</TD>
</TR>
<TR>
<TD>SoundTrigger</TD>
<TD>If active, the weapon will sound every time a shot is fired in a burst sequence. Can be set to 1 or 0.</TD>
<TD>soundtrigger=1;</TD>
</TR>
<TR>
<TD>SprayAngle</TD>
<TD>How wide the the angle of a burst from a burst weapon can be. Very similar to Accuracy, except that if a weapon has no sprayangle, all the shots will be fired at the same spot, even if the weapon's aim is off.</TD>
<TD>sprayangle=1024;</TD>
</TR>
<TR>
<TD>StartVelocity</TD>
<TD>The starting speed of the weapon as it is first fired. Only applicable to weapons that can accelerate.</TD>
<TD>startvelocity=200;</TD>
</TR>
<TR>
<TD>Stockpile</TD>
<TD>Can this weapon be stockpiled, for instance like a nuke launcher. Can be set to 1 or 0.</TD>
<TD>stockpile=1;</TD>
</TR>
<TR>
<TD>SubMissile</TD>
<TD>For TorpedoLaunchers, if set to 1 the torpedo will travel like a missile outside of water. It will not emit a smoketrail, though. When fired from a plane it will behave the same way but the plane will probably be considered a fighter, not a bomber. Can be set to 1 or 0.</TD>
<TD>subMissile=0;</TD>
</TR>
<TR>
<TD>SweepFire</TD>
<TD>If 1 (default 0) it will make the weapon continue firing while it aims for a new target. Only works on continous beam lasers currently. Can be set to 1 or 0.</TD>
<TD>SweepFire=1;</TD>
</TR>
<TR>
<TD>TargeBorder</TD>
<TD>If nonzero, targetting units will TryTarget at the edge of collision sphere (radius*tag_value, [-1;1]) instead of its centre. Can be set between 0 and 1. Defaults to 1 for Melee type weapons, 0 otherwise. ([http://spring.clan-sy.com/phpbb/viewtopic.php?p=219659#p219659 image])</TD>
<TD>targetBorder=1;</TD>
</TR>
<TR>
<TD>Targetable</TD>
<TD>If active, the weapon will be automatically targeted by any Interceptor weapons.</TD>
<TD>targetable=1;</TD>
</TR>
<TR>
<TD>TargetMoveError</TD>
<TD>The degree to which a weapon's aiming will fail to keep up with its target's movement. If set very low or not set at all, a weapon will lead its target and almost always hit unless there's a lot of micromanagement on the part of the person controlling the target. If set too high (about 0.3 or above), the weapon will have a lot of difficulty even tracking its target enough to get a shot off. Can probably only be set between 0 and 1. Beyond 1, the weapon would be virtually useless.</TD>
<TD>targetmoveerror=0.15;</TD>
</TR>
<TR>
<TD>Thickness</TD>
<TD>Thickness of a beamweapon or beamlaser, default is 2. Can be set to any numerical value.</TD>
<TD>thickness=4;</TD>
</TR>
<TR>
<TD>TileLength</TD>
<TD>Only used by LargeBeamLaser. Defines the length before the texture used is repeated (tiled).</TD>
<TD>tileLength=4;</TD>
</TR>
<TR>
<TD>ToAirWeapon</TD>
<TD>If active, the weapon will only be capable of targetting units which are flying, or are capable of flying. Can be set to 0 or 1.</TD>
<TD>toairweapon=1;</TD>
</TR>
<TR>
<TD>Tolerance</TD>
<TD>The amount to which the weapon's "real" aim can be off while the weapon will still be able to fire accurately at the target. This worked in OTA, but I'm not 100% sure if it works in Spring. Can be set to any numerical value.</TD>
<TD>tolerance=1500;</TD>
</TR>
<TR>
<TD>Tracks</TD>
<TD>If the missile tracks a moving target. Can be set to 1 or 0.</TD>
<TD>tracks=1;</TD>
</TR>
<TR>
<TD>TrajectoryHeight</TD>
<TD>The height of the arc of a missile weapon. It is useful for compensating for mountains or debris. Is relative to the weapons speed (Higher speed, higher arc) and the range the weapon is firing at (Lower range lower arc). Requires Guidance and Turnrate to hit its target when over 1. </TD>
<TD>trajectoryheight=0.8;</TD>
</TR>
<TR>
<TD>Turnrate</TD>
<TD>How fast a guided weapon can turn. Can be any numerical value between 0 and 64000. If set to 0, the weapon can't turn at all, if set to 64000, the weapon can literally defy all known physics and turn 180 degrees in a fraction of a second. This is relative to a weapon's velocity; a weapon with a very low velocity (~200) wouldn't need a very high turnrate to keep up with a fighter, although it would probably never catch it because of its slow speed. A weapon with a very high velocity (~1000) would need a very high value in order to be able to hit targets that turn suddenly.
<TD>turnrate=32000;</TD>
</TR>
<TR>
<TD>Turret</TD>
<TD>Set to 1 if weapon is used by a turret that rotates. Set to 0 if weapon is forward firing, ie, has no rotating turret piece.</TD>
<TD>turret=1;</TD>
</TR>
<TR>
<TD>TwoPhase</TD>
<TD>Weapon operates in two phases. Unused in 76b1 and 77b1! Can be set to 1 or 0.</TD>
<TD>twophase=1;</TD>
</TR>
<TR>
<TD>VLaunch</TD>
<TD>Set to 1 to launch the weapon vertically. Can only be used with missile-type weapons with a TurnRate. Cannot be used at the same time as Turret. Set to 1 or 0.</TD>
<TD>vlaunch=1;</TD>
</TR>
<TR>
<TD>WaterBounce</TD>
<TD>Weather the weapon projectile will bounce on the surface of the water. Can be 0 or 1, defaults to 0 (off)</TD>
<TD>waterbounce=1;</TD>
</TR>
<TR>
<TD>WaterWeapon</TD>
<TD>Water weapons behave somewhat like Dropped weapons out of water, and like missiles underwater. Is the only type of weapon that can fire under water. Can be set to 1 or 0.</TD>
<TD>waterweapon=1;</TD>
</TR>
<TR>
<TD>WeaponAcceleration</TD>
<TD>Tells the weapon how fast it should accelerate from its StartVelocity to its actual WeaponVelocity. Increases the weapon's velocity every second by the amount specified. Can be any numerical value.</TD>
<TD>weaponacceleration=50;</TD>
</TR>
<TR>
<TD>WeaponTimer</TD>
<TD>How long until the weapon will go into its second phase. For use with missile weapons. For VLaunch weapons, the weapon will turn to actually go towards its target after the specified number of seconds has expired. For non-VLaunch missiles with a TurnRate, the weapon will go randomly off-course after this period of time. Can be set to any numerical value.</TD>
<TD>weapontimer=5;</TD>
</TR>
<TR>
<TD>WeaponVelocity</TD>
<TD>The speed the weapon moves after being fired. If StartVelocity is lower than this number, the weapon will increase speed to its WeaponVelocity at the rate specified by its WeaponAcceleration.</TD>
<TD>weaponvelocity=800;</TD>
</TR>
<TR>
<TD>Wobble</TD>
<TD>The amount that a missile will wobble off-course. Requires TurnRate. Turnrate will wrestle with wobble to keep the weapon on course, so wobble must be high enough to compensate to have any effect. Can be set to any numerical value between 0 and 64000.</TD>
<TD>wobble=15000;</TD>
</TR>
</table>
NOTE: Variables that are defined by either a 1 or a 0 are BOOLEAN, where 1 means TRUE and 0 means FALSE.

NOTE 2: "Any numerical value" for things that relate to angles really means any value between 0 and 64,000 since that's between 0 and 360 degrees in spring measurement. Setting it higher than 64,000 will bring it 'full circle' so to speak.
 

=Texture Tags=
<center>
<table width=500 border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 1em; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;">
<TR><th> Weapon </th><th> Used Texture Tags </th> </tr>
<TR>
<TD>AircraftBomb</TD>
<TD>texture1 = projectile</TD>
</TR>
<TR>
<TD>BeamLaser</TD>
<TD>texture1 = beam texture2 = beamend texture3 = flare </TD>
</TR>
<TR>
<TD>PlasmaCannon</TD>
<TD>texture1 = projectile</TD>
</TR>
<TR>
<TD>EmgCannon</TD>
<TD>texture1 = projectile</TD>
</TR>
<TR>
<TD>FlameThrower</TD>
<TD>texture1 = flame</TD>
</TR>
<TR>
<TD>LargeBeamLaser</TD>
<TD>texture1 = beam texture2 = beamend texture3 = muzzle texture4 = flare </TD>
</TR>
<TR>
<TD>LaserCannon</TD>
<TD>texture1 = beam texture2 = beamend </TD>
</TR>
<TR>
<TD>LightingCannon</TD>
<TD>texture1 = beam </TD>
</TR>
<TR>
<TD>MissileLauncher</TD>
<TD>texture1 = flare texture2 = smoketrail </TD>
</TR>
<TR>
<TD>Shield</TD>
<TD>texture1 = shield</TD>
</TR>
<TR>
<TD>StarburstLauncher</TD>
<TD>texture1 = flare texture2 = smoketrail texture3 = flame </TD>
</TR>
<TR>
<TD>TorpedoLauncher</TD>
<TD>texture1 = projectile </TD>
</TR>
</TABLE>
</center>
NOTE: All textures need to be `atlased`. So you have to define them in the '''resources.tdf''' and use the reference name in the texture tags.
 

=Plasma Visuals=
<table width=730 border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;">
<TR><th>Variable </th><th> Description </th><th> Examples</Th> </tr>
<TR>
<TD>AlphaDecay</TD>
<TD>How much a plasma particle is more transparent than the previous particle. Can be set to any numerical value. (default: 1)</TD>
<TD>AlphaDecay=0.95;</TD>
</TR>
<TR>
<TD>NoGap</TD>
<TD>If set to 1, the distance between plasma particles is proportional to the size of the two particles. If set to 0, the distance between plasma particles will be proportional to the size of the first particle.
Can be set to 1 or 0. (default: 1)</TD>
<TD>NoGap=0;</TD>
</TR>
<TR>
<TD>Separation</TD>
<TD>Distance between each plasma particle. Can be set to any number value. (default: 1)</TD>
<TD>Separation=5;</TD>
</TR>
<TR>
<TD>SizeDecay</TD>
<TD>How much a plasma particle is smaller than the previous within the same plasma shot. Can be set to any numerical value. (default: 0)</TD>
<TD>SizeDecay=0.2;</TD>
</TR>
<TR>
<TD>Stages</TD>
<TD>Number of particles used in one plasma shot. Can be set to any number value. (default: 5)</TD>
<TD>Stages=20;</TD>
</TR>
</table>
 

=Shield/Repulsor Descriptions=
<table width=730 border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;">
<TR><th>Variable </th><th> Description </th><th> Examples</Th> </tr>
<TR>
<TD>ExteriorShield</TD>
<TD>If set to 1, the shield/repulsor will not have any effect on weapons fired from within its field. Can be 1 or 0.</TD>
<TD>exteriorshield=1;</TD>
</TR>
<TR>
<TD>IsShield</TD>
<TD>If set to 1, this "weapon" is no longer a weapon, is now a repulsor or a shield, based on the other properties given to it. Can be 1 or 0.</TD>
<TD>isshield=1;</TD>
</TR>
<TR>
<TD>ShieldAlpha</TD>
<TD>How clearly visible the shield is, if you have VisibleShield turned on. Value is between 0 and 1.</TD>
<TD>shieldalpha=0.4;</TD>
</TR>
<TR>
<TD>ShieldEnergyUse</TD>
<TD>The amount of energy used to repulse or destroy weapons. Will be used constantly while the weapon is in its area of effect if it is a repulsor, will be used only once on impact if it is a shield.</TD>
<TD>shieldenergyuse=1500;</TD>
</TR>
<TR>
<TD>ShieldForce</TD>
<TD>The force applied to weapons, an arbitrary number. Set to 1, it will not deflect very well. Only for use on repulsor-type. Can be set to any numerical value.</TD>
<TD>shieldforce=1.75;</TD>
</TR>
<TR>
<TD>ShieldBadColor</TD>
<TD>The color the shield is when it is at 0% strength, if you have VisibleShield turned on. Defined in R G B format.</TD>
<TD>shieldbadcolor=0 1 0;</TD>
</TR>
<TR>
<TD>ShieldGoodColor</TD>
<TD>The color the shield is when it is at 100% strength, if you have VisibleShield turned on.</TD>
<TD>shieldgoodcolor=1 0 0;</TD>
</TR>
<TR>
<TD>ShieldInterceptType</TD>
<TD>Bitfield representing the types of weapons that this shield can intercept. The best way to think about this is to think of it as the resulting binary. Every digit of binary that is set to one means that a weapon with that digit set to one will be intercepted by this shield, for instance, the example will result in the shield blocking weapons with types 2 and/or 3. Maxium of 32 unique types. See [[Shield Interception Tag Use]].</TD>
<TD>ShieldInterceptType=6;</TD>
</TR>
<TR>
<TD>ShieldMaxSpeed</TD>
<TD>The maximum speed the repulsor will push weapons away at. Only for use on repulsor-type. Can be set to any numerical value.</TD>
<TD>shieldmaxspeed=400;</TD>
</TR>
<TR>
<TD>ShieldPower</TD>
<TD>How much "power" a shield can store. "Power" is not the same as energy; think of it as the shield/repulsor's private battery source. It can be drained completely by defending against weapons, even if you have lots of energy. ''Power is drained by the affected weapons damage.'' Can be set to any numerical value.</TD>
<TD>shieldpower=1000;</TD>
</TR>
<TR>
<TD>ShieldPowerRegen</TD>
<TD>How quickly the shield regenerates its "power", even when under attack. Regenerates the amount specified every second. Can be set to any numerical value.</TD>
<TD>shieldpowerregen=25;</TD>
</TR>
<TR>
<TD>ShieldPowerRegenEnergy</TD>
<TD>How much energy is required to keep the shield regenerating its "power". For instance, you might have it set so that 100 units of energy are necessary for every 25 units of "power".</TD>
<TD>shieldpowerregenenergy=100;</TD>
</TR>
<TR>
<TD>ShieldRadius</TD>
<TD>Defines the size of the area the shield/repulsor protects. Can be set to any numerical value.</TD>
<TD>shieldradius=500;</TD>
</TR>
<TR>
<TD>ShieldRepulsor</TD>
<TD>If set to 1, the "shield"-type weapon will repulse projectiles. If set to 0, it will destroy them. Can be set to 1 or 0.</TD>
<TD>shieldrepulsor=1;</TD>
</TR>
<TR>
<TD>ShieldStartingPower</TD>
<TD>If set the shield starts with this much power instead of 0. Can be set to any numerical value.</TD>
<TD>shieldStartingPower=100;</TD>
</TR>
<TR>
<TD>SmartShield</TD>
<TD>If set to 1, the shield/repulsor will not affect owned/allied weapons. Can be set to 1 or 0.</TD>
<TD>smartshield=1;</TD>
</TR>
<TR>
<TD>VisibleShield</TD>
<TD>If set to 1, the shield will be visible. Only for use on shield-type. Can be set to 1 or 0.</TD>
<TD>visibleshield=1;</TD>
</TR>
<TR>
<TD>VisibleShieldHitFrames</TD>
<TD>Numbers of frames how long the shield should be visible after it got hit (the alpha value fades after the hit). Can be set to any numerical value. (default: 0 frames)</TD>
<TD>visibleShieldHitFrames=5;</TD>
</TR>
<TR>
<TD>VisibleShieldRepulse</TD>
<TD>If set to 1, the repulsing effect will be visible. Only for use on repulsor-type. Can be set to 1 or 0.</TD>
<TD>visibleshieldrepulse=1;</TD>
</TR>
</table>


[[category:Weapons]]

[[category:Shields]]

Weapon Variables

2008-07-11T00:45:44Z

JK: /* WeaponType */

=WeaponType=
This is a weapon tag! It allows you to bypass the engine's auto detection and force the weapontype. (example weaponType="StarburstLauncher")
<table width=730 border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;">
<TR><th>WeaponType</th><th> Description </th> </tr>
<TR>
<TD>AircraftBomb (dropped=1)</TD>
<TD>Drops a ballistic projectile (aka Plasma) at the same movement vector as the unit itself. It's only meant for planes. A plane that has a CBombDropper as its weapon1 is a bomber. The CBombDropper automatically calculates its burst and burstrate tags from its reload time and uses 5 as its reload time instead. It will fire if the first bomb would drop within a circle roughly unitspeed*burst*burstrate so the longer the burst and the faster the unit the larger the circle in which it will drop instead of not firing and hoping the next attack run will pass that circle.</TD>
</TR>
<TR>
<TD>StarburstLauncher(vlaunch=1)</TD>
<TD>Fires a projectile that rises vertically (starts with no velocity) for <weapontimer> seconds, then turns at a fixed rate towards its target. The projectile's lifetime depends on its range divided by its max speed (ignores acceleration) and the weapontimer somehow so the weapon can fall short depending on how these values are set. This is the only weapon that can properly perform intercepts and be interceptable. Emits a smoketrail.</TD>
</TR>
<TR>
<TD>BeamLaser (beamlaser=1)</TD>
<TD>Should be well known, this thing spawns a beam and does a portion of its total damage each frame. It can't have a burst or burstrate, it can't have collidefriendly=0, it can't be emit-sfxed if it has a beamtime longer than one frame and its damage decreases over range if the minIntensity=1 tag isn't used. The largebeamlaser tag allows changing the visual effect of the laser, doesn't affect the behaviour of the weapon itself in any way though. Beamlasers can be really annoying... BTW, their beam doesn't collide with water so if they're set to waterweapon=1 they can shoot normally even when underwater (won't shoot at underwater targets though).</TD>
</TR>
<TR>
<TD>Shield (isShield=1)</TD>
<TD>The shield. Really not much to say about this, the tags are all documented in the changelog.</TD>
</TR>
<TR>
<TD>TorpedoLauncher (waterweapon=1)</TD>
<TD>Fires a projectile that will behave ballistically out of water and like a missile in water. Since waterweapon=1 is usually set for them they can fire underwater and they will target underwater units. The torpedo is the only projectile that doesn't explode on the water surface. An aircraft carrying a TorpedoLauncher is a special case, the thing turns into a bomb dropepr that will spawn a torpedo projectile, probably to get the whole bomber flight behaviour. Note that the waterweapon tag is also used to make a weapon fire underwater, independent of its type.</TD>
</TR>
<TR>
<TD>DGun (weaponname contains the word "disintegrator")</TD>
<TD>This shoots a fireball that travels in a straight line. The fireball has no range limitation by itself so if it misses or is fired in FPS mode it will travel across the whole map and further. DGuns don't properly check their line of fire, if terrain is in the way they fire anyway. These things are meant to be used with noexplode=1 but of course you CAN use them without that, too. If ballistic=1 is set the fireball will be affected by gravity, the weapon won't compensate for it though so it will hit the ground before reaching the target. Might be useful for a Scorched Earth mod or something since you'd have to aim it manually to hit anything.</TD>
</TR>
<TR>
<TD>LightingCannon (sic) (lineofsight=1 and rendertype=7)</TD>
<TD>An instant hit weapon like the Beamlaser except with a lightning graphic and even more annoying. It won't damage shields and it has a hardcoded inaccuracy (comparable to targetMoveError, the code comment is "should make it weaker against air"...). Shares some of the weirdnesses with the beamlaser, e.g. being able to penetrate water.</TD>
</TR>
<TR>
<TD>LaserCannon (lineofsight=1 and either beamweapon=1 or weaponname contains "laser" (marked as "workaround for SWTA))</TD>
<TD>The OTA-style laser. Probably one of the least annoying weapons in the engine. Its length is defined by the duration tag (together with the speed), BTW.</TD>
</TR>
<TR>
<TD>MissileLauncher (lineofsight=1 and smoketrail=1)</TD>
<TD>Shoots a smoke-emitting projectile. It can use guidance, acceleration, etc. The projectile's lifetime depends on range/maxspeed so a slowly accelerating missile will fall short. It can also use trajectoryheight to have the shot arc but that has trouble with aiming at targets higher or lower than the shooter (see bug report, this REALLY could use some fixing). Pretty versatile weapon overall, if the laser rendering code was ported into this we could pretty much axe the LaserCannon completely.</TD>
</TR>
<TR>
<TD>EmgCannon (lineofsight=1 and rendertype=4 and color=2)</TD>
<TD>Few know about this, it's a line of sight (i.e. not ballistic) weapon that can use billboard rendering (looks like a sprite). No idea what drawbacks this has, noone ever uses it.</TD>
</TR>
<TR>
<TD>Flame (lineofsight=1 and rendertype=5)</TD>
<TD>The flamethrower. A really annoying weapon. AFAIK it won't even aim ahead of moving targets. Can't say much else about it since I haven't tried using it much but overall I'd avoid the weapontype and fake the effect somehow, it's not pretty when fast and won't hit jack when slow.</TD>
</TR>
<TR>
<TD>Cannon (anything that didn't trigger another weapon)</TD>
<TD>Aka plasma. Shoots a ballistic projectile. Unlike the DGun it aims properly. Can't be emit-sfxed properly, maybe a ballistic DGun can fill that role.</TD>
</TR>
<TR>
<TD>Melee (only reachable through WeaponType)</TD>
<TD>When it fires it simply damages the target, no ifs or buts. It doesn't use a projectile and doesn't care about the line of fire. It won't even report a proper heading and pitch to AimWeapon so if you plan on using it in 75b2 you have to slave it to another weapon to handle the aiming. May be useful to be the damage dealer for a cosmetic weapon, i.e. you slave the Melee to a weapon that does no damage but looks pretty and the Melee does the damage. Kinda like the weapons in Warcraft and so.</TD>
</TR>
<TR>
<TD>Rifle (only reachable through WeaponType)</TD>
<TD>An instant hit weapon but an apparently unmaintained one. It has a hardcoded firing and explosion effect. I wouldn't use it.</TD>
</TR>
<TR>
<TD>CNoWeapon (weaponname is NOWEAPON, not reachable by any tag)</TD>
<TD>Apparently a placeholder used when a weapon isn't present. It's not really a weapondef but generated when the unit demands a NOWEAPON.</TD></TR>
</table>

=Descriptions=
<table width=730 border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;">
<TR><th>Variable </th><th> Description </th><th> Examples</Th> </tr>
<TR>
<TD>Accuracy</TD>
<TD>How accurate a weapon is. A larger number is less accurate. If this tag is missing entirely, it has perfect accuracy unless its target moves unexpectedly. Accuracy is relative to the distance to the target; for instance, if the target is very close, even a very high accuracy value will probably still hit. If a target is very far away, even a very low accuracy value will likely cause the weapon to miss. Can be any numeric value.</TD>
<TD>accuracy=400;</TD>
</TR>
<TR>
<TD>AlwaysVisible</TD>
<TD>Ignore LOS handling and always draw the weapon effect? Can be 1 or 0.</TD>
<TD>alwaysVisible=0;</TD>
</TR>
<TR>
<TD>AreaOfEffect</TD>
<TD>How large the weapon's impact explosion is. This affects how powerful the weapon's default impulse strength will be. Currently, BeamLasers with an AreaOfEffect of 16 or above will deform the ground at their point of impact regardless of whether it has been told not to. Can be any numeric value, but should generally be at least 8, regardless of the type of weapon.</TD>
<TD>areaofeffect=192;</TD>
</TR>
<TR>
<TD>AvoidFeature</TD>
<TD>This makes the weapon avoid features while targetting (the shoot will still collide with features). Can be 1 or 0.</TD>
<TD>avoidFeature=0;</TD>
</TR>
<TR>
<TD>AvoidFriendly</TD>
<TD>If set to 0 units will not try to avoid friendly units in their line of fire. Can be 1 or 0.</TD>
<TD>avoidFriendly=1;</TD>
</TR>
<TR>
<TD>Ballistic</TD>
<TD>Set to 1 for the weapon to be subjected to gravity, travelling in an arc through the air, such as cannons. Ballistic is mutually exclusive to LineOfSight and Dropped. Can be 1 or 0.</TD>
<TD>ballistic=1;</TD>
</TR>
<TR>
<TD>BeamDecay</TD>
<TD>For BeamLasers, defines the speed of the fadeout (each frame the beam's intensity is multiplied with that value). Can be between 0 and 1.</TD>
<TD>beamDecay=0.9;</TD>
</TR>
<TR>
<TD>BeamLaser</TD>
<TD>Whether this weapon is a beam laser or not. Beam lasers instantly hit their targets. Rendertype must be 0. Mutually exclusive to BeamWeapon. Can be 1 or 0.</TD>
<TD>beamlaser=1;</TD>
</TR>
<TR>
<TD>BeamTime</TD>
<TD>How long to fire the laser before waiting for ReloadTime to start. Can be any numeric value. Defaults to 1.</TD>
<TD>beamtime=0.5;</TD>
</TR>
<TR>
<TD>BeamTTL</TD>
<TD>For BeamLasers, defines the time (in frames) the beam will stay after being fired. Can be any numeric value.</TD>
<TD>beamTtl=10;</TD>
</TR>
<TR>
<TD>BeamWeapon</TD>
<TD>Whether this weapon is a regular laser or not. BeamWeapons (lasers) do not instantly hit their targets, and are affected by the weaponvelocity tag. Mutually exclusive to BeamLaser. Can be 1 or 0.</TD>
<TD>beamweapon=1;</TD>
</TR>
<TR>
<TD>BounceRebound</TD>
<TD>The amount of vertical velocity a projectile keeps when it bounces. Generally .3-1, but 0 for a sticky bomb, or 2 for a flubber bomb. Defaults to 1</TD>
<TD>bouncerebound=.8;</TD>
</TR>
<TR>
<TD>BounceSlip</TD>
<TD>The amount of horizontal velocity a projectile keeps when it bounces. Generally .3-1, but 0 for a sticky bomb, or 2 for a flubber bomb. Defaults to 1</TD>
<TD>bounceslip=.8;</TD>
</TR>
<TR>
<TD>BurnBlow</TD>
<TD>The weapon blows up when it reaches range the target was at when the weapon fired. Only works on plasma (rendertype=4) weapons and possibly missiles? Can be 1 or 0. A common usage is on flak guns.</TD>
<TD>burnblow=1;</TD>
</TR>
<TR>
<TD>Burst</TD>
<TD>How many shots are in a burst. Must be accompanied by burstrate. Can be any numeric value.</TD>
<TD>burst=3;</TD>
</TR>
<TR>
<TD>BurstRate</TD>
<TD>How fast the Burst fires. If set much below 0.1, it stops having any discernable effect.</TD>
<TD>burstrate=0.1</TD>
</TR>
<TR>
<TD>CameraShake</TD>
<TD>How much the camera shakes on impact. (needs the cameraShake widget to work). Can be any numeric value.</TD>
<TD>cameraShake=5;</TD>
</TR>
<TR>
<TD>CanAttackGround</TD>
<TD>Can be set to 1 or 0.</TD>
<TD>canAttackGround=0</TD>
</TR>
<TR>
<TD>CegTag</TD>
<TD>CegTag is the tag that emits a custom explosion every frame for a projectile. Can be used on any weapon to imitate dynamic lighting, smoke, fire, ball lightning, magic and many other things. Enter the name of your effect to make it emit once per frame.</TD>
<TD>cegtag=MISSILE_SMOKE_FX;</TD>
</TR>
<TR>
<TD>Color</TD>
<TD>An obsolete tag only recognized for compatibility purposes. While this still works for lasers, using rgbcolor=X X X; is a much, much better route. Plus, the RGBColor tag will override any color=x; tags in the tdf. </TD>
<TD>color=1;</TD>
</TR>
<TR>
<TD>Color2</TD>
<TD>An obsolete tag only recognized for compatibility purposes.</TD>
<TD>color=2;</TD>
</TR>
<TR>
<TD>ColorMap</TD>
<TD>Only used by flamethrower. Must be a CColorMap type.</TD>
<TD>colorMap=1 0 0 1  0 1 0 1; (red to green fade)</TD>
</TR>
<TR>
<TD>CollideFriendly</TD>
<TD>If set to 0 this weapon will not hit friendly units. Can be set to 1 or 0.</TD>
<TD>collisionFriendly=1;</TD>
</TR>
<TR>
<TD>CollisionSize</TD>
<TD>Defines the physical size of projectiles, percentage of size for flamethrower and absolute value emg, plasma and laser. Can be any numeric value.</TD>
<TD>collisionSize=30;</TD>
</TR>
<TR>
<TD>CommandFire</TD>
<TD>When ordered to attack ground this weapon will only fire once, rather than continuously. This does not work when ordered to attack units (It will continue to fire until the target is dead). If the unit has CanDgun=1 in its FBI, commandfire will identify that weapon with the dgun button. The weapon wont fire unless the dgun button is pressed. Can be set to 1 or 0.</TD>
<TD>commandfire=1;</TD>
</TR>
<TR>
<TD>CoreThickness</TD>
<TD>Thickness of the core of a laser (the part which use rgbcolor2). Can be any numeric value.</TD>
<TD>coreThickness=0.25;</TD>
</TR>
<TR>
<TD>Coverage</TD>
<TD>The range for anti-weapon weapons, like antinukes. This will be shown on the minimap as a guide. Can be any numeric value.</TD>
<TD>coverage=1280;</TD>
</TR>
<TR>
<TD>CraterBoost</TD>
<TD>Adds a constant factor to the terraform the explosion does. Can be any numeric value. (default 0)</TD>
<TD>craterMult=0.1;</TD>
</TR>
<TR>
<TD>CraterMult</TD>
<TD>Multiplies with the terraform the explosion does. Can be any numeric value. (default :=impulsFactor)</TD>
<TD>craterMult=1.2;</TD>
</TR>
<TR>
<TD>CylinderTargetting</TD>
<TD>If greater than 0, range will be checked in a cylinder instead of a sphere:
half height=unitradius*cylinderTargetting
Defaults to 1 for Melee type weapons, 0 otherwise. In 0.76b1, does not work with BeamLaser weapons.([http://spring.clan-sy.com/phpbb/viewtopic.php?p=219659#p219659 image])</TD>
<TD>cylinderTargetting=0;</TD>
</TR>
<TR>
<TD>Dance</TD>
<TD>For missles, unlike wobble it doesn't rotate the missile and it prevents the missile from going too far off course so a dancing swarm will remain coherent. Can be any numeric value.</TD>
<TD>dance=97;</TD>
</TR>
<TR>
<TD>Dropped</TD>
<TD>Sets the weapon to be dropped, like from a bomber. Must be RenderType=6 and needs the Model tag to be specified. Mutually exclusive to Ballistic and LineOfSight. Can be set to 1 or 0.</TD>
<TD>dropped=1;</TD>
</TR>
<TR>
<TD>Duration</TD>
<TD>For how many seconds a beam weapon will be fired before waiting for reload time. Also controls the length of the beam in BeamWeapon projectiles. Can be any numeric value. Used for rendertype 0 and 7 weapons.</TD>
<TD>duration=.5;</TD>
</TR>
<TR>
<TD>DynDamageExp</TD>
<TD>Exponent of the range damage formula, 0 (the default) disables dynamic damage. 1 means linear scaling. Only used by BeamLasers and LightingCannons. Can be any numeric value. ([http://spring.clan-sy.com/phpbb/viewtopic.php?p=263438#p263438 image])</TD>
<TD>dynDamageExp=0;</TD>
</TR>
<TR>
<TD>DynDamageInverted</TD>
<TD>Inverts the damage curve (more damage at far range). Only used by BeamLasers and LightingCannons. Can be 0 or 1.</TD>
<TD>dynDamageInverted=0;</TD>
</TR>
<TR>
<TD>DynDamageMin</TD>
<TD>Minimum dynamic range damage value. Only used by BeamLasers and LightingCannons. Can be any numeric value.</TD>
<TD>dynDamageMin=0;</TD>
</TR>
<TR>
<TD>DynDamageRange</TD>
<TD>If set it will use this value in the dynamic range damage formula instead of the range value from the weapon in the calculation. Only used by BeamLasers and LightingCannons. Can be any numeric value.</TD>
<TD>DynDamageRange=400;</TD>
</TR>
<TR>
<TD>EdgeEffectiveness</TD>
<TD>Determines what percent of a weapon's maximum damage value will be applied to units as they are closer to the outer edge of the weapon's AreaOfEffect. Must have a decimal value between 0 and 1. Default in OTA was 0, probably the same in Spring. ([http://spring.clan-sy.com/phpbb/viewtopic.php?p=251180#p251180 image])</TD>
<TD>edgeEffectiveness=0.25;</TD>
</TR>
<TR>
<TD>EnergyPerShot</TD>
<TD>Energy used per shot. If the specified amount of energy is not available, the weapon will not be able to shoot. Can also be used to specify how much a Stockpile weapon wll cost to build. Can be any numeric value.</TD>
<TD>energypershot=5;</TD>
</TR>
<TR>
<TD>ExplosionSpeed</TD>
<TD>Explosion animation speed/time. (only used by BeamLaser and LightingCannon?) default:
gd=max(30, DefaultDamage/20); 
expSpeed=(8+(gd*2.5))/(9+(sqrt(gd)*.7))/2; 
Can be any numeric value.
</TD>
<TD>explosionSpeed=5;</TD>
</TR>
<TR>
<TD>FallOffRate</TD>
<TD>Rate at which the beamweapon fades out after it goes past its maximum range. 0 is never fade out, 1 is finish fading out exactly at max range, the default 0.5 is the previous behaviour.
<TD>FallOffRate=0.5;</TD>
</TR>
<TR>
<TD>FireStarter</TD>
<TD>How likely the weapon will set trees on fire. High values make trees likey to be set on fire, low values make trees likely to just explode or tip over. Can be any numeric value between 0 and 100.</TD>
<TD>fireStarter=75;</TD>
</TR>
<TR>
<TD>FireSubmersed</TD>
<TD>If set the weapon can fire underwater, if not then not. Use it for weapons that cannot fire underwater but can hit underwater targets. Works even for torpedoes. Can be 0 or 1.</TD>
<TD>fireSubmersed=1;</TD>
</TR>
<TR>
<TD>FixedLauncher</TD>
<TD>For missiles, starburst missiles and torpedoes, this makes the projectile spawn with the orientation of the shooting piece instead of their normal orientation. The weapon will not properly check if allies are in the way so make sure you align the launchers in a way that won't hammer right into your own forces and perhaps use collideFriendly=0. FixedLauncher conflicts with trajectoryHeight and IMO combining them is pointless anyway so don't use both on a weapon. Can be 0 or 1.</TD>
<TD>fixedLauncher=0;</TD>
</TR>
<TR>
<TD>FlameGFXTime</TD>
<TD>Makes the flamethrower projectile stay alive as a graphical effect (doesnt do any damage) after it has reached maxrange. It is defined in percent, so 1.2 makes it remain 20% beyond maxrange. Can be any numeric value.
<TD>flamegfxtime=1.2;</TD>
</TR>
<TR>
<TD>FlightTime</TD>
<TD>Can be any numeric value.</TD>
<TD>flightTime=10;</TD>
</TR>
<TR>
<TD>GroundBounce</TD>
<TD>Weather the weapon projectile will bounce on the ground (on land or the ocean floor). Can be 0 or 1, defaults to 0 (off)</TD>
<TD>groundbounce=1;</TD>
</TR>
<TR>
<TD>Guidance</TD>
<TD>Specifies whether or not the weapon is capable of correcting its trajectory mid-flight. Will not track a moving target. Works only on missile and torpedo weapons. Can be set to 1 or 0. See TurnRate for information on specifying how well a weapon can track a target. Requires rendertype=1, lineofsight=1, and selfprop=1;</TD>
<TD>guidance=1;</TD>
</TR>
<TR>
<TD>HardStop</TD>
<TD>For LaserCannon, defined if the laser effect hard stops or fade out. Can be 0 or 1.</TD>
<TD>hardStop=0;</TD>
</TR>
<TR>
<TD>HeightBoostFactor</TD>
<TD>Gives control of cannon height range boost (more than 1 means increased range, 0 means the cannon has fixed range regardless of height difference to target. default is a magic value calculated on weapon init, based on range tag and theoretical max range.). Can be any numeric value, including negative ones (<0 := automatically calculated).</TD>
<TD>heightBoostFactor=-1;</TD>
</TR>
<TR>
<TD>HeightMod</TD>
<TD>Changes the sphere weapon range into an ellipsis. If it is larger 1.0 the weapon can't shoot as height as far, i.e. 0.5 means it can shoot twice as height as far ([http://spring.clan-sy.com/phpbb/viewtopic.php?p=219659#p219659 image]). Note that this may not work well with beam weapons, use minIntensity (0..1) tag to fix that.</TD>
<TD>heightMod=1;</TD>
</TR>
<TR>
<TD>ImpulseBoost</TD>
<TD>A constant factor added on the weapon's impulsefactor. Can be any numeric value, including negative ones.</TD>
<TD>impulseBoost=0.5;</TD>
</TR>
<TR>
<TD>ImpulseFactor</TD>
<TD>The multiplier on the weapon's default impulsefactor, which is determined based on a weapon's default damage and AreaOfEffect. The impulse of a weapon is how strong of a kinetic force will be applied to its target or anything near the point of impact. Can be any numeric value, including negative ones.</TD>
<TD>impulsefactor=2.5;</TD>
</TR>
<TR>
<TD>Intensity</TD>
<TD>Alpha (brighness and washout effect) of the weapon. Can be used on any rendertype 0, 3, or 4 weapon. Can be any numeric value.</TD>
<TD>intensity=1.5;</TD>
</TR>
<TR>
<TD>InterceptedByShieldType</TD>
<TD>Bitfield representing the types of shields that can intercept this weapon. The best way to think about this is to think of it as the resulting binary. Every digit of binary that is set to one means that a shield with that digit set to one will intercept this weapon, for instance, the example will result in the weapons being blocked by shields with types 1 and/or 3. Maxium of 32 unique types. See [[Shield Interception Tag Use]].</TD>
<TD>InterceptedByShieldType=5;</TD>
</TR>
<TR>
<TD>Interceptor</TD>
<TD>Can intercept missiles with the Cruise tag.</TD>
<TD>interceptor=1;</TD>
</TR>
<TR>
<TD>LargeBeamLaser</TD>
<TD>If set to 1 a beamlaser uses an alternate graphics effect. Can be 0 or 1.</TD>
<TD>largeBeamLaser=0;</TD>
</TR>
<TR>
<TD>LaserFlareSize</TD>
<TD>Size of the flare for laser weapons, multiplier for thickness. Can be set to any numeric value. (default: 15)</TD>
<TD>laserFlareSize=15;</TD>
</TR>
<TR>
<TD>Leadbonus</TD>
<TD>Is multiplied with the unit's experience and added to the lead limit.</TD>
<TD>leadbonus=1;</TD>
</TR>
<TR>
<TD>LeadLimit</TD>
<TD>Limits the maximum distance a unit will lead a target (default is -1 which means infinite).</TD>
<TD>leadLimit=1;</TD>
</TR>
<TR>
<TD>LineOfSight</TD>
<TD>NOT SUPPORTED BY SPRING! 
It is only used to detect the weapontype of ota weapon configs.</TD>
<TD></TD>
</TR>
<TR>
<TD>LodDistance</TD>
<TD>Minimum camera distance at which the default beamweapon projectile is simplified to rectangle. Can be set to any numeric value. (default: 1000)</TD>
<TD>lodDistance=1000;</TD>
</TR>
<TR>
<TD>ManualBombSettings</TD>
<TD>For Bombers, use burst and burstrate tags instead of hardcoded values. Can be set to 1 or 0.</TD>
<TD>manualBombSettings=1;</TD>
</TR>
<TR>
<TD>MetalPerShot</TD>
<TD>Metal used per shot. If the specified amount is not available, the weapon cannot be fired. Can also be used to specify how much a Stockpile weapon wll cost to build. Can be set to any numeric value.</TD>
<TD>metalpershot=500;</TD>
</TR>
<TR>
<TD>MinIntensity</TD>
<TD>For beamlasers - always hit with some minimum intensity (a damage coeffcient normally dependent on distance - range 0 to 1). Can be set to any numeric value.</TD>
<TD>minIntensity=0.1;</TD>
</TR>
<TR>
<TD>Model</TD>
<TD>The 3DO or S3O model to be used as this weapon's physical representation. 3DO modesl do not need a .3do extension, but S3O weapon do.</TD>
<TD>model=missile;</TD>
</TR>
<TR>
<TD>MovingAccuracy</TD>
<TD>A weapon's accuracy while moving. See Accuracy. Can be any numeric value.</TD>
<TD>movingaccuracy=1000;</TD>
</TR>
<TR>
<TD>MyGravity</TD>
<TD>For ballistic weapons (Cannon and Bomb), it overrides the map gravity if used. Regular map gravity is around 0.2.</TD>
<TD>myGravity=0.2;</TD>
</TR>
<TR>
<TD>NoExplode</TD>
<TD>Whether or not the weapon will explode on impact or continue on its path. An example is the d-gun. Can be set to 1 or 0.</TD>
<TD>noexplode=1;</TD>
</TR>
<TR>
<TD>NoSelfDamage</TD>
<TD>This weapon will not damage the unit that fired it. For instance, a nuke silo could shoot itself and not take any damage if this was active. Can be set to 1 or 0.</TD>
<TD>noselfdamage=1;</TD>
</TR>
<TR>
<TD>NumBounce</TD>
<TD>The maximum number of times a weapon will bounce. -1 for infinite. Defaults to -1</TD>
<TD>numbounce=5;</TD>
</TR>
<TR>
<TD>Paralyzer</TD>
<TD>If active, this weapon will not cause any damage to its target, but will instead paralyze (aka EMP). The default damage value of a weapon with this active will be applied to the target's HP; once the HP is overwhelmed, it will be paralyzed. Can be set to 1 or 0.</TD>
<TD>paralyzer=1;</TD>
</TR>
<TR>
<TD>ParalyzerTime</TD>
<TD>On Paralyzer weapons, determines the maximum length of time the target will be paralyzed (In seconds?). The timer is refreshed every time the target is hit by the weapon. Can be set to any numerical value.</TD>
<TD>paralyzetime=10;</TD>
</TR>
<TR>
<TD>PredictBoost</TD>
<TD>No idea what it does. Default 0 for non-burnblow, 0.5 for burnblow weapons. Can be set to any numerical value.</TD>
<TD>predictBoost=15;</TD>
</TR>
<TR>
<TD>Projectiles</TD>
<TD>The weapon fires this many projectiles at once (shotgun style). Make sure you put them on different trajectories somehow (sprayangle or different firepoints) because otherwise they'll all be clumped in one shot. Works well combined with bursts. Can be set to any integer value.</TD>
<TD>projectiles=1o;</TD>
</TR>
<TR>
<TD>ProximityPriority</TD>
<TD>Acts as a multiplier for the distance to the target in the priority calculation. Note that negative values make weapons prefer distant targets. Can be set to any numerical value.</TD>
<TD>proximityPriority=1;</TD>
</TR>
<TR>
<TD>PulseSpeed</TD>
<TD>On LargeBeamLaser, how fast the pulsating effect at the beam start is. Can be set to any numerical value.</TD>
<TD>pulseSpeed=15;</TD>
</TR>
<TR>
<TD>Range</TD>
<TD>The maximum range of the weapon. If set to noexplode, the weapon will disappear after this range has been met. If set to burnblow, the weapon will explode after this range has been met. Can be set to any numerical value.</TD>
<TD>range=750;</TD>
</TR>
<TR>
<TD>ReloadTime</TD>
<TD>The amount of time between shots. If a unit is paralyzed, this stops counting down. Can be set to any numerical value.</TD>
<TD>reloadtime=3.5;</TD>
</TR>
<TR>
<TD>Rendertype</TD>
<TD>The way the weapon will be displayed. Certain rendertypes are incompatibile with other tags, but it's generally for a logical reason. The rendertypes are as follows: 0 - Laser, 1 - Model, 3 - Plasma, 4 - Unit explosion (usally), 5 - Flamethrower, 6 - Dropped, 7 - Lightning. There's no documented use of rendertype=2 in OTA, and it probably doesn't do anything in Spring. 3 and 4 are usually interchangeable, both can be used to render a plasma/EMG/whatever shot; this is probably for compatibility.</TD>
<TD>rendertype=1;</TD>
</TR>
<TR>
<TD>RGBColor</TD>
<TD>The color of the rendertype 0, 3, 4, 7 weapon, specified in RED_GREEN_BLUE format.</TD>
<TD>rgbcolor=1 0.3 1; - this would make evul-purple</TD>
</TR>
<TR>
<TR>
<TD>RGBColor2</TD>
<TD>The color at the core of a rendertype 0 (laser) weapon. Specified the same as above. Defaults to white.</TD>
<TD>RGBColor2=0 1 0; - this would make a weird green middle for the evul-purple laser</TD>
</TR>
<TR>
<TD>ScrollSeed</TD>
<TD>Only used by LargeBeamLaser. How fast the beam apears to be moving towards it target. Can be set to any numerical value.</TD>
<TD>scrollSeed=1;</TD>
</TR>
<TR>
<TD>Selfprop</TD>
<TD>Required for Guidance tag. This weapon can propel itself and can have things like acceleration, rather than always travelling at one speed. See Guidance, StartVelocity, WeaponAcceleration, WeaponVelocity. Can be set to 1 or 0.</TD>
<TD>selfprop=1;</TD>
</TR>
<TR>
<TD>Size</TD>
<TD>Defines the visible size of projectiles. Can be set to any numerical value.</TD>
<TD>size=10;</TD>
</TR>
<TR>
<TD>SizeGrowth</TD>
<TD>Defines how fast flame projectiles will grow in size. Can be set to any numerical value.</TD>
<TD>sizegrowth=0.6;</TD>
</TR>
<TR>
<TD>SmokeTrail</TD>
<TD>Does the projectile leave a smoke trail or not. Can be set to 1 or 0.</TD>
<TD>smoketrail=1;</TD>
</TR>
<TR>
<TD>SoundHit</TD>
<TD>The sound made whe the weapon hits. Must reference a .wav file in the .\Sounds directory.</TD>
<TD>soundhit=emghit;</TD>
</TR>
<TR>
<TD>SoundHitVolume</TD>
<TD>Can be any numerical value between 0 and 1.</TD>
<TD>soundhitvolume=0.5;</TD>
</TR>
<TR>
<TD>SoundStart</TD>
<TD>The sound made when the weapon begins to fire. Will fire only once if the weapon is shot in a burst. Must reference a .wav file in the .\Sounds directory.</TD>
<TD>soundstart=emgfire;</TD>
</TR>
<TR>
<TD>SoundStartVolume</TD>
<TD>Can be any numerical value between 0 and 1.</TD>
<TD>soundstartvolume=0.5;</TD>
</TR>
<TR>
<TD>SoundTrigger</TD>
<TD>If active, the weapon will sound every time a shot is fired in a burst sequence. Can be set to 1 or 0.</TD>
<TD>soundtrigger=1;</TD>
</TR>
<TR>
<TD>SprayAngle</TD>
<TD>How wide the the angle of a burst from a burst weapon can be. Very similar to Accuracy, except that if a weapon has no sprayangle, all the shots will be fired at the same spot, even if the weapon's aim is off.</TD>
<TD>sprayangle=1024;</TD>
</TR>
<TR>
<TD>StartVelocity</TD>
<TD>The starting speed of the weapon as it is first fired. Only applicable to weapons that can accelerate.</TD>
<TD>startvelocity=200;</TD>
</TR>
<TR>
<TD>Stockpile</TD>
<TD>Can this weapon be stockpiled, for instance like a nuke launcher. Can be set to 1 or 0.</TD>
<TD>stockpile=1;</TD>
</TR>
<TR>
<TD>SubMissile</TD>
<TD>For TorpedoLaunchers, if set to 1 the torpedo will travel like a missile outside of water. It will not emit a smoketrail, though. When fired from a plane it will behave the same way but the plane will probably be considered a fighter, not a bomber. Can be set to 1 or 0.</TD>
<TD>subMissile=0;</TD>
</TR>
<TR>
<TD>SweepFire</TD>
<TD>If 1 (default 0) it will make the weapon continue firing while it aims for a new target. Only works on continous beam lasers currently. Can be set to 1 or 0.</TD>
<TD>SweepFire=1;</TD>
</TR>
<TR>
<TD>TargeBorder</TD>
<TD>If nonzero, targetting units will TryTarget at the edge of collision sphere (radius*tag_value, [-1;1]) instead of its centre. Can be set between 0 and 1. Defaults to 1 for Melee type weapons, 0 otherwise. ([http://spring.clan-sy.com/phpbb/viewtopic.php?p=219659#p219659 image])</TD>
<TD>targetBorder=1;</TD>
</TR>
<TR>
<TD>Targetable</TD>
<TD>If active, the weapon will be automatically targeted by any Interceptor weapons.</TD>
<TD>targetable=1;</TD>
</TR>
<TR>
<TD>TargetMoveError</TD>
<TD>The degree to which a weapon's aiming will fail to keep up with its target's movement. If set very low or not set at all, a weapon will lead its target and almost always hit unless there's a lot of micromanagement on the part of the person controlling the target. If set too high (about 0.3 or above), the weapon will have a lot of difficulty even tracking its target enough to get a shot off. Can probably only be set between 0 and 1. Beyond 1, the weapon would be virtually useless.</TD>
<TD>targetmoveerror=0.15;</TD>
</TR>
<TR>
<TD>Thickness</TD>
<TD>Thickness of a beamweapon or beamlaser, default is 2. Can be set to any numerical value.</TD>
<TD>thickness=4;</TD>
</TR>
<TR>
<TD>TileLength</TD>
<TD>Only used by LargeBeamLaser. Defines the length before the texture used is repeated (tiled).</TD>
<TD>tileLength=4;</TD>
</TR>
<TR>
<TD>ToAirWeapon</TD>
<TD>If active, the weapon will only be capable of targetting units which are flying, or are capable of flying. Can be set to 0 or 1.</TD>
<TD>toairweapon=1;</TD>
</TR>
<TR>
<TD>Tolerance</TD>
<TD>The amount to which the weapon's "real" aim can be off while the weapon will still be able to fire accurately at the target. This worked in OTA, but I'm not 100% sure if it works in Spring. Can be set to any numerical value.</TD>
<TD>tolerance=1500;</TD>
</TR>
<TR>
<TD>Tracks</TD>
<TD>If the missile tracks a moving target. Can be set to 1 or 0.</TD>
<TD>tracks=1;</TD>
</TR>
<TR>
<TD>TrajectoryHeight</TD>
<TD>The height of the arc of a missile weapon. It is useful for compensating for mountains or debris. Is relative to the weapons speed (Higher speed, higher arc) and the range the weapon is firing at (Lower range lower arc). Requires Guidance and Turnrate to hit its target when over 1. </TD>
<TD>trajectoryheight=0.8;</TD>
</TR>
<TR>
<TD>Turnrate</TD>
<TD>How fast a guided weapon can turn. Can be any numerical value between 0 and 64000. If set to 0, the weapon can't turn at all, if set to 64000, the weapon can literally defy all known physics and turn 180 degrees in a fraction of a second. This is relative to a weapon's velocity; a weapon with a very low velocity (~200) wouldn't need a very high turnrate to keep up with a fighter, although it would probably never catch it because of its slow speed. A weapon with a very high velocity (~1000) would need a very high value in order to be able to hit targets that turn suddenly.
<TD>turnrate=32000;</TD>
</TR>
<TR>
<TD>Turret</TD>
<TD>Set to 1 if weapon is used by a turret that rotates. Set to 0 if weapon is forward firing, ie, has no rotating turret piece.</TD>
<TD>turret=1;</TD>
</TR>
<TR>
<TD>TwoPhase</TD>
<TD>Weapon operates in two phases... eh... yeah, I honestly have no idea what the difference between this and VLaunch is. Generally use it with VLaunch as well. Can be set to 1 or 0.</TD>
<TD>twophase=1;</TD>
</TR>
<TR>
<TD>VLaunch</TD>
<TD>Set to 1 to launch the weapon vertically. Can only be used with missile-type weapons with a TurnRate. Cannot be used at the same time as Turret. Set to 1 or 0.</TD>
<TD>vlaunch=1;</TD>
</TR>
<TR>
<TD>WaterBounce</TD>
<TD>Weather the weapon projectile will bounce on the surface of the water. Can be 0 or 1, defaults to 0 (off)</TD>
<TD>waterbounce=1;</TD>
</TR>
<TR>
<TD>WaterWeapon</TD>
<TD>Water weapons behave somewhat like Dropped weapons out of water, and like missiles underwater. Is the only type of weapon that can fire under water. Can be set to 1 or 0.</TD>
<TD>waterweapon=1;</TD>
</TR>
<TR>
<TD>WeaponAcceleration</TD>
<TD>Tells the weapon how fast it should accelerate from its StartVelocity to its actual WeaponVelocity. Increases the weapon's velocity every second by the amount specified. Can be any numerical value.</TD>
<TD>weaponacceleration=50;</TD>
</TR>
<TR>
<TD>WeaponTimer</TD>
<TD>;How long until the weapon will go into its second phase. For use with missile weapons. For VLaunch weapons, the weapon will turn to actually go towards its target after the specified number of seconds has expired. For non-VLaunch missiles with a TurnRate, the weapon will go randomly off-course after this period of time. Can be set to any numerical value.</TD>
<TD>weapontimer=5;</TD>
</TR>
<TR>
<TD>WeaponVelocity</TD>
<TD>The speed the weapon moves after being fired. If StartVelocity is lower than this number, the weapon will increase speed to its WeaponVelocity at the rate specified by its WeaponAcceleration.</TD>
<TD>weaponvelocity=800;</TD>
</TR>
<TR>
<TD>Wobble</TD>
<TD>The amount that a missile will wobble off-course. Requires TurnRate. Turnrate will wrestle with wobble to keep the weapon on course, so wobble must be high enough to compensate to have any effect. Can be set to any numerical value between 0 and 64000.</TD>
<TD>wobble=15000;</TD>
</TR>
</table>
NOTE: Variables that are defined by either a 1 or a 0 are BOOLEAN, where 1 means TRUE and 0 means FALSE.

NOTE 2: "Any numerical value" for things that relate to angles really means any value between 0 and 64,000 since that's between 0 and 360 degrees in spring measurement. Setting it higher than 64,000 will bring it 'full circle' so to speak.
 

=Texture Tags=
<center>
<table width=500 border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 1em; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;">
<TR><th> Weapon </th><th> Used Texture Tags </th> </tr>
<TR>
<TD>AircraftBomb</TD>
<TD>texture1 = projectile</TD>
</TR>
<TR>
<TD>BeamLaser</TD>
<TD>texture1 = beam texture2 = beamend texture3 = flare </TD>
</TR>
<TR>
<TD>PlasmaCannon</TD>
<TD>texture1 = projectile</TD>
</TR>
<TR>
<TD>EmgCannon</TD>
<TD>texture1 = projectile</TD>
</TR>
<TR>
<TD>FlameThrower</TD>
<TD>texture1 = flame</TD>
</TR>
<TR>
<TD>LargeBeamLaser</TD>
<TD>texture1 = beam texture2 = beamend texture3 = muzzle texture4 = flare </TD>
</TR>
<TR>
<TD>LaserCannon</TD>
<TD>texture1 = beam texture2 = beamend </TD>
</TR>
<TR>
<TD>LightingCannon</TD>
<TD>texture1 = beam </TD>
</TR>
<TR>
<TD>MissileLauncher</TD>
<TD>texture1 = flare texture2 = smoketrail </TD>
</TR>
<TR>
<TD>Shield</TD>
<TD>texture1 = shield</TD>
</TR>
<TR>
<TD>StarburstLauncher</TD>
<TD>texture1 = flare texture2 = smoketrail texture3 = flame </TD>
</TR>
<TR>
<TD>TorpedoLauncher</TD>
<TD>texture1 = projectile </TD>
</TR>
</TABLE>
</center>
NOTE: All textures need to be `atlased`. So you have to define them in the '''resources.tdf''' and use the reference name in the texture tags.
 

=Plasma Visuals=
<table width=730 border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;">
<TR><th>Variable </th><th> Description </th><th> Examples</Th> </tr>
<TR>
<TD>AlphaDecay</TD>
<TD>How much a plasma particle is more transparent than the previous particle. Can be set to any numerical value. (default: 1)</TD>
<TD>AlphaDecay=0.95;</TD>
</TR>
<TR>
<TD>NoGap</TD>
<TD>If set to 1, the distance between plasma particles is proportional to the size of the two particles. If set to 0, the distance between plasma particles will be proportional to the size of the first particle.
Can be set to 1 or 0. (default: 1)</TD>
<TD>NoGap=0;</TD>
</TR>
<TR>
<TD>Separation</TD>
<TD>Distance between each plasma particle. Can be set to any number value. (default: 1)</TD>
<TD>Separation=5;</TD>
</TR>
<TR>
<TD>SizeDecay</TD>
<TD>How much a plasma particle is smaller than the previous within the same plasma shot. Can be set to any numerical value. (default: 0)</TD>
<TD>SizeDecay=0.2;</TD>
</TR>
<TR>
<TD>Stages</TD>
<TD>Number of particles used in one plasma shot. Can be set to any number value. (default: 5)</TD>
<TD>Stages=20;</TD>
</TR>
</table>
 

=Shield/Repulsor Descriptions=
<table width=730 border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;">
<TR><th>Variable </th><th> Description </th><th> Examples</Th> </tr>
<TR>
<TD>ExteriorShield</TD>
<TD>If set to 1, the shield/repulsor will not have any effect on weapons fired from within its field. Can be 1 or 0.</TD>
<TD>exteriorshield=1;</TD>
</TR>
<TR>
<TD>IsShield</TD>
<TD>If set to 1, this "weapon" is no longer a weapon, is now a repulsor or a shield, based on the other properties given to it. Can be 1 or 0.</TD>
<TD>isshield=1;</TD>
</TR>
<TR>
<TD>ShieldAlpha</TD>
<TD>How clearly visible the shield is, if you have VisibleShield turned on. Value is between 0 and 1.</TD>
<TD>shieldalpha=0.4;</TD>
</TR>
<TR>
<TD>ShieldEnergyUse</TD>
<TD>The amount of energy used to repulse or destroy weapons. Will be used constantly while the weapon is in its area of effect if it is a repulsor, will be used only once on impact if it is a shield.</TD>
<TD>shieldenergyuse=1500;</TD>
</TR>
<TR>
<TD>ShieldForce</TD>
<TD>The force applied to weapons, an arbitrary number. Set to 1, it will not deflect very well. Only for use on repulsor-type. Can be set to any numerical value.</TD>
<TD>shieldforce=1.75;</TD>
</TR>
<TR>
<TD>ShieldBadColor</TD>
<TD>The color the shield is when it is at 0% strength, if you have VisibleShield turned on. Defined in R G B format.</TD>
<TD>shieldbadcolor=0 1 0;</TD>
</TR>
<TR>
<TD>ShieldGoodColor</TD>
<TD>The color the shield is when it is at 100% strength, if you have VisibleShield turned on.</TD>
<TD>shieldgoodcolor=1 0 0;</TD>
</TR>
<TR>
<TD>ShieldInterceptType</TD>
<TD>Bitfield representing the types of weapons that this shield can intercept. The best way to think about this is to think of it as the resulting binary. Every digit of binary that is set to one means that a weapon with that digit set to one will be intercepted by this shield, for instance, the example will result in the shield blocking weapons with types 2 and/or 3. Maxium of 32 unique types. See [[Shield Interception Tag Use]].</TD>
<TD>ShieldInterceptType=6;</TD>
</TR>
<TR>
<TD>ShieldMaxSpeed</TD>
<TD>The maximum speed the repulsor will push weapons away at. Only for use on repulsor-type. Can be set to any numerical value.</TD>
<TD>shieldmaxspeed=400;</TD>
</TR>
<TR>
<TD>ShieldPower</TD>
<TD>How much "power" a shield can store. "Power" is not the same as energy; think of it as the shield/repulsor's private battery source. It can be drained completely by defending against weapons, even if you have lots of energy. ''Power is drained by the affected weapons damage.'' Can be set to any numerical value.</TD>
<TD>shieldpower=1000;</TD>
</TR>
<TR>
<TD>ShieldPowerRegen</TD>
<TD>How quickly the shield regenerates its "power", even when under attack. Regenerates the amount specified every second. Can be set to any numerical value.</TD>
<TD>shieldpowerregen=25;</TD>
</TR>
<TR>
<TD>ShieldPowerRegenEnergy</TD>
<TD>How much energy is required to keep the shield regenerating its "power". For instance, you might have it set so that 100 units of energy are necessary for every 25 units of "power".</TD>
<TD>shieldpowerregenenergy=100;</TD>
</TR>
<TR>
<TD>ShieldRadius</TD>
<TD>Defines the size of the area the shield/repulsor protects. Can be set to any numerical value.</TD>
<TD>shieldradius=500;</TD>
</TR>
<TR>
<TD>ShieldRepulsor</TD>
<TD>If set to 1, the "shield"-type weapon will repulse projectiles. If set to 0, it will destroy them. Can be set to 1 or 0.</TD>
<TD>shieldrepulsor=1;</TD>
</TR>
<TR>
<TD>ShieldStartingPower</TD>
<TD>If set the shield starts with this much power instead of 0. Can be set to any numerical value.</TD>
<TD>shieldStartingPower=100;</TD>
</TR>
<TR>
<TD>SmartShield</TD>
<TD>If set to 1, the shield/repulsor will not affect owned/allied weapons. Can be set to 1 or 0.</TD>
<TD>smartshield=1;</TD>
</TR>
<TR>
<TD>VisibleShield</TD>
<TD>If set to 1, the shield will be visible. Only for use on shield-type. Can be set to 1 or 0.</TD>
<TD>visibleshield=1;</TD>
</TR>
<TR>
<TD>VisibleShieldHitFrames</TD>
<TD>Numbers of frames how long the shield should be visible after it got hit (the alpha value fades after the hit). Can be set to any numerical value. (default: 0 frames)</TD>
<TD>visibleShieldHitFrames=5;</TD>
</TR>
<TR>
<TD>VisibleShieldRepulse</TD>
<TD>If set to 1, the repulsing effect will be visible. Only for use on repulsor-type. Can be set to 1 or 0.</TD>
<TD>visibleshieldrepulse=1;</TD>
</TR>
</table>


[[category:Weapons]]

[[category:Shields]]

Lua VFS

2008-07-09T13:36:24Z

JK: /* Files */

== Modes ==
'''VFS.RAW''' 
'''VFS.MOD''' (unimplemented, acts like VFS.ZIP) 
'''VFS.MAP''' (unimplemented, acts like VFS.ZIP) 
'''VFS.BASE''' (unimplemented, acts like VFS.ZIP) 
'''VFS.ZIP''' 
'''VFS.RAW_FIRST''' 
'''VFS.ZIP_FIRST''' 
'''VFS.RAW_ONLY''' (same as VFS.RAW) 
'''VFS.ZIP_ONLY''' (same as VFS.ZIP) 

== Files ==
'''VFS.Include''' (if enviroment=nil then use current one)
( string "filename" [, table enviroment [, number mode ] ] ) ->
'''VFS.LoadFile'''
( string "filename" [, number mode ] ) -> nil | lstring data
'''VFS.FileExists'''
( string "filename" [, number mode ] ) -> boolean
'''VFS.DirList'''
( string "directory" [, string "pattern" [, number mode [, string "optstr" ] ] ] )
-> { [1] = string filename, ... }
 optstr can contain:
"r" = recursive
"d" = include dirs

== Packing ==
The Pack- and Unpack-functions are used to convert numbers->strings and strings->numbers.
So you can read a binary file and then convert the received strings back to numbers and the other way around. Also you can use it in combination with the SendLuaXYZMsg-functions.

'''VFS.PackU8'''

'''VFS.PackU16'''

'''VFS.PackU32'''

'''VFS.PackS8'''

'''VFS.PackS16'''

'''VFS.PackS32'''

'''VFS.PackF32'''

arguments are:

'''VFS.PackX( number arg1, number arg2, number arg3, ... )''' -> string

'''VFS.PackX( {[1]=number,[2]=number,..} )''' -> string

'''VFS.UnpackU8'''

'''VFS.UnpackU16'''

'''VFS.UnpackU32'''

'''VFS.UnpackS8'''

'''VFS.UnpackS16'''

'''VFS.UnpackS32'''

'''VFS.UnpackF32'''

arguments are:

'''VFS.UnpackX( string "binary" [, number offset ] [, number count] )'''
-> number | table { [1]=number,[2]=number,.. }

Lua VFS

2008-07-09T13:35:55Z

JK: /* Files */

== Modes ==
'''VFS.RAW''' 
'''VFS.MOD''' (unimplemented, acts like VFS.ZIP) 
'''VFS.MAP''' (unimplemented, acts like VFS.ZIP) 
'''VFS.BASE''' (unimplemented, acts like VFS.ZIP) 
'''VFS.ZIP''' 
'''VFS.RAW_FIRST''' 
'''VFS.ZIP_FIRST''' 
'''VFS.RAW_ONLY''' (same as VFS.RAW) 
'''VFS.ZIP_ONLY''' (same as VFS.ZIP) 

== Files ==
'''VFS.Include''' (if enviroment=nil then use current one)
( string "filename" [, table enviroment [, number mode ] ] ) ->
'''VFS.LoadFile'''
( string "filename" [, number mode ] ) -> nil | lstring data
'''VFS.FileExists'''
( string "filename" [, number mode ] ) -> boolean
'''VFS.DirList'''
( string "directory" [, string "pattern" [, number mode [, string "optstr" ] ] ] )
-> { [1] = string filename, ... }
 optstr can contain:
"r" = recursive
"d" = include dirs

== Packing ==
The Pack- and Unpack-functions are used to convert numbers->strings and strings->numbers.
So you can read a binary file and then convert the received strings back to numbers and the other way around. Also you can use it in combination with the SendLuaXYZMsg-functions.

'''VFS.PackU8'''

'''VFS.PackU16'''

'''VFS.PackU32'''

'''VFS.PackS8'''

'''VFS.PackS16'''

'''VFS.PackS32'''

'''VFS.PackF32'''

arguments are:

'''VFS.PackX( number arg1, number arg2, number arg3, ... )''' -> string

'''VFS.PackX( {[1]=number,[2]=number,..} )''' -> string

'''VFS.UnpackU8'''

'''VFS.UnpackU16'''

'''VFS.UnpackU32'''

'''VFS.UnpackS8'''

'''VFS.UnpackS16'''

'''VFS.UnpackS32'''

'''VFS.UnpackF32'''

arguments are:

'''VFS.UnpackX( string "binary" [, number offset ] [, number count] )'''
-> number | table { [1]=number,[2]=number,.. }

Lua Beginners FAQ

2008-07-05T01:37:21Z

JK:

'''Q: I'm interested in learning to use Lua with Spring. Where should I start?'''

A: You can start by reading the tutorial [http://lua-users.org/wiki/TutorialDirectory here]. The "Introductory topics" and "Programming in Lua" sections should suffice, in the beginning. After that, you can try editing simple LuaUI widgets, like snd_chatterbox.

'''Q: Why should I learn Lua?'''

A: If you are a player, it can allow you to write widgets that automate tedious and mindless tasks, help you organize the information available to you in a a more effective way, or even let you overhaul the user interface. If you are a modder, it gives you the power to manipulate every aspect of the simluation except projectiles. Here are some of the things you can do:

*Create or destroy units.
*Transform units into other units.
*Change game rules.
*Give orders to units.
*Add new buttons to the unit orders panel.
*Manipulate unit physics.
*Upgrade units.
*Create a research system.
*Write a new user interface.
*Directly access OpenGL calls.
*Use your own shaders written in GLSL.
*Write your own custom model format.
*Use bump mapping, relief mapping, normal mapping, and more advanced graphic techniques.
*Use different levels of detail.
*Create single player missions.
*Implement a new resource system.
*Add fauna to a map.
*Create weather effects.
*Communicate with cob scripts.
*Respond to explosions.
*playback ogg's.

The possibilites are mostly limited by your creativity.

'''Q: What Lua cannot do (yet)?'''

A: You cannot ...
*changing projectiles, nor detect their positions.
*writting to the metal/texture map.
*control the LOS.
*create a random map generator.

'''Q: How do I open ".lua" files?'''

A: Notepad or any text editor are enough.

'''Q: Where can I find documentation?'''

A: There is incomplete documentation for LuaUI in "Spring/LuaUI/API.txt". "Spring/LuaUI/widgets.lua" and "<modname>/LuaRules/gadgets.lua" contain the call-ins and their arguments. You will have to read the Spring source to find the list of call-outs and their arguments. The source of the Lua API can be found [https://taspring.clan-sy.com/svn/spring/trunk/rts/Lua/ here]. LuaSyncedCtrl.cpp, LuaSyncedRead.cpp, LuaUnsyncedCtrl.cpp, LuaUnsyncedRead.cpp, LuaOpenGL.cpp and LuaSyncedMoveCtrl.cpp contain most call-outs. (L, 1) usually refers to the first argument, (L, 2) to the second, etc. If you don't know C++, understanding those files will require a little bit of guesswork, but it should'nt be hard. Note that not all calls are available to both LuaUI and LuaRules/LuaCob/LuaGaia. 
'''And there are following wiki articles:''' 
{{LuaInterfaces}}

'''Q: What is a call-in? And a call-out?'''

Call-ins are functions defined in your script that Spring calls when a determined event takes place. For example, the gadget:Initialize() call-in is run by Spring when the widget is loaded.
Call-outs are functions defined in Spring you can run at whichever moment you desire. For example, when you call Spring.GetUnitTeam(unitID), the engine returns the teamID of the unit identified by "unitID".

'''Q: What is the difference between a widget and a gadget?'''

A: A widget is a Lua script that works with LuaUI. A gadget works with LuaRules, LuaCob or LuaGaia. Widgets allow you to customize your interface, and must be unsynced. They can be bundled with the mod or you can save them in your "Spring/LuaUI/Wigets" directory. Gadgets can be synced or unsynced. LuaRules and LuaCob gadgets are usually part of a mod. LuaGaia gadgets should be part of a map. Gadgets can contain both synced and unsynced code.

'''Q: Where can I find examples?'''

A: The "Spring/LuaUI/Widgets" directory contains many examples. More can be found at [http://spring.unknown-files.net/category/19/Lua_Scripts/ Unknow Files] or in the [http://www.caspring.org/ Complete Annihilation] mod.

'''Q: Can I reload a script without restarting Spring?'''

Yes, you can type "/luaui reload" or ".luarules reload". If you just need to check for syntax error, you can do it without having to load Spring by compiling the code. You can find a Lua compiler [http://luaforge.net/frs/?group_id=110&release_id=694 here]. [http://luaforge.net/frs/download.php/2218/lua5_1_2_Win32_bin.zip This] is the download for Windows users..

'''Q: Why does the print function seem to do nothing?'''

A: Its output is displayed in stdout. If you are a windows user, to see it, you need to first unzip [http://lcc-clan.com/quant/winpipe.zip this archive] in your Spring directory, then open the command promt, navigate to your Spring directory, and run spring by typing "spring.exe | winpipe.exe". The stdout will appear in the command prompt window.
You might want to run Spring in windowed mode so the command prompt is visible at all times. 
(for the lazy ones: there is also a Spring.Echo(var1,var2,...) that prints into the ingame chatbox)

'''Q: How do I print the "UnitDefs[unitDefID]" or "WeaponDefs[weaponDefID]" tables? "for k, v in ipairs(t) do print(k, v) end" does not behave as expected.'''

A: Use "for k,v in UnitDefs[unitDefID]:pairs() do print(k, v) end" instead.

'''Q: Where can I find help?'''

A: There is a [http://spring.clan-sy.com/phpbb/viewforum.php?f=23 Lua section] in the Spring forums. Probably the most effective way, though, is to join #lua on the lobby.

'''Q: Who implemented LuaUI, LuaRules, LuaCob and LuaGaia?'''

A: They were written by trepan.

Lua Beginners FAQ

2008-07-05T01:36:49Z

JK:

'''Q: I'm interested in learning to use Lua with Spring. Where should I start?'''

A: You can start by reading the tutorial [http://lua-users.org/wiki/TutorialDirectory here]. The "Introductory topics" and "Programming in Lua" sections should suffice, in the beginning. After that, you can try editing simple LuaUI widgets, like snd_chatterbox.

'''Q: Why should I learn Lua?'''

A: If you are a player, it can allow you to write widgets that automate tedious and mindless tasks, help you organize the information available to you in a a more effective way, or even let you overhaul the user interface. If you are a modder, it gives you the power to manipulate every aspect of the simluation except projectiles. Here are some of the things you can do:

*Create or destroy units.
*Transform units into other units.
*Change game rules.
*Give orders to units.
*Add new buttons to the unit orders panel.
*Manipulate unit physics.
*Upgrade units.
*Create a research system.
*Write a new user interface.
*Directly access OpenGL calls.
*Use your own shaders written in GLSL.
*Write your own custom model format.
*Use 3d textures, bump mapping, relief mapping, normal mapping, and more advanced graphic techniques.
*Use different levels of detail.
*Create single player missions.
*Implement a new resource system.
*Add fauna to a map.
*Create weather effects.
*Communicate with cob scripts.
*Respond to explosions.
*playback ogg's.

The possibilites are mostly limited by your creativity.

'''Q: What Lua cannot do (yet)?'''

A: You cannot ...
*changing projectiles, nor detect their positions.
*writting to the metal/texture map.
*control the LOS.
*create a random map generator.

'''Q: How do I open ".lua" files?'''

A: Notepad or any text editor are enough.

'''Q: Where can I find documentation?'''

A: There is incomplete documentation for LuaUI in "Spring/LuaUI/API.txt". "Spring/LuaUI/widgets.lua" and "<modname>/LuaRules/gadgets.lua" contain the call-ins and their arguments. You will have to read the Spring source to find the list of call-outs and their arguments. The source of the Lua API can be found [https://taspring.clan-sy.com/svn/spring/trunk/rts/Lua/ here]. LuaSyncedCtrl.cpp, LuaSyncedRead.cpp, LuaUnsyncedCtrl.cpp, LuaUnsyncedRead.cpp, LuaOpenGL.cpp and LuaSyncedMoveCtrl.cpp contain most call-outs. (L, 1) usually refers to the first argument, (L, 2) to the second, etc. If you don't know C++, understanding those files will require a little bit of guesswork, but it should'nt be hard. Note that not all calls are available to both LuaUI and LuaRules/LuaCob/LuaGaia. 
'''And there are following wiki articles:''' 
{{LuaInterfaces}}

'''Q: What is a call-in? And a call-out?'''

Call-ins are functions defined in your script that Spring calls when a determined event takes place. For example, the gadget:Initialize() call-in is run by Spring when the widget is loaded.
Call-outs are functions defined in Spring you can run at whichever moment you desire. For example, when you call Spring.GetUnitTeam(unitID), the engine returns the teamID of the unit identified by "unitID".

'''Q: What is the difference between a widget and a gadget?'''

A: A widget is a Lua script that works with LuaUI. A gadget works with LuaRules, LuaCob or LuaGaia. Widgets allow you to customize your interface, and must be unsynced. They can be bundled with the mod or you can save them in your "Spring/LuaUI/Wigets" directory. Gadgets can be synced or unsynced. LuaRules and LuaCob gadgets are usually part of a mod. LuaGaia gadgets should be part of a map. Gadgets can contain both synced and unsynced code.

'''Q: Where can I find examples?'''

A: The "Spring/LuaUI/Widgets" directory contains many examples. More can be found at [http://spring.unknown-files.net/category/19/Lua_Scripts/ Unknow Files] or in the [http://www.caspring.org/ Complete Annihilation] mod.

'''Q: Can I reload a script without restarting Spring?'''

Yes, you can type "/luaui reload" or ".luarules reload". If you just need to check for syntax error, you can do it without having to load Spring by compiling the code. You can find a Lua compiler [http://luaforge.net/frs/?group_id=110&release_id=694 here]. [http://luaforge.net/frs/download.php/2218/lua5_1_2_Win32_bin.zip This] is the download for Windows users..

'''Q: Why does the print function seem to do nothing?'''

A: Its output is displayed in stdout. If you are a windows user, to see it, you need to first unzip [http://lcc-clan.com/quant/winpipe.zip this archive] in your Spring directory, then open the command promt, navigate to your Spring directory, and run spring by typing "spring.exe | winpipe.exe". The stdout will appear in the command prompt window.
You might want to run Spring in windowed mode so the command prompt is visible at all times. 
(for the lazy ones: there is also a Spring.Echo(var1,var2,...) that prints into the ingame chatbox)

'''Q: How do I print the "UnitDefs[unitDefID]" or "WeaponDefs[weaponDefID]" tables? "for k, v in ipairs(t) do print(k, v) end" does not behave as expected.'''

A: Use "for k,v in UnitDefs[unitDefID]:pairs() do print(k, v) end" instead.

'''Q: Where can I find help?'''

A: There is a [http://spring.clan-sy.com/phpbb/viewforum.php?f=23 Lua section] in the Spring forums. Probably the most effective way, though, is to join #lua on the lobby.

'''Q: Who implemented LuaUI, LuaRules, LuaCob and LuaGaia?'''

A: They were written by trepan.

Weapon Variables

2008-07-01T18:41:38Z

JK: /* Descriptions */

=WeaponType=
<table width=730 border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;">
<TR><th>WeaponType</th><th> Description </th> </tr>
<TR>
<TD>AircraftBomb (dropped=1)</TD>
<TD>Drops a ballistic projectile (aka Plasma) at the same movement vector as the unit itself. It's only meant for planes. A plane that has a CBombDropper as its weapon1 is a bomber. The CBombDropper automatically calculates its burst and burstrate tags from its reload time and uses 5 as its reload time instead. It will fire if the first bomb would drop within a circle roughly unitspeed*burst*burstrate so the longer the burst and the faster the unit the larger the circle in which it will drop instead of not firing and hoping the next attack run will pass that circle.</TD>
</TR>
<TR>
<TD>StarburstLauncher(vlaunch=1)</TD>
<TD>Fires a projectile that rises vertically (starts with no velocity) for <weapontimer> seconds, then turns at a fixed rate towards its target. The projectile's lifetime depends on its range divided by its max speed (ignores acceleration) and the weapontimer somehow so the weapon can fall short depending on how these values are set. This is the only weapon that can properly perform intercepts and be interceptable. Emits a smoketrail.</TD>
</TR>
<TR>
<TD>BeamLaser (beamlaser=1)</TD>
<TD>Should be well known, this thing spawns a beam and does a portion of its total damage each frame. It can't have a burst or burstrate, it can't have collidefriendly=0, it can't be emit-sfxed if it has a beamtime longer than one frame and its damage decreases over range if the minIntensity=1 tag isn't used. The largebeamlaser tag allows changing the visual effect of the laser, doesn't affect the behaviour of the weapon itself in any way though. Beamlasers can be really annoying... BTW, their beam doesn't collide with water so if they're set to waterweapon=1 they can shoot normally even when underwater (won't shoot at underwater targets though).</TD>
</TR>
<TR>
<TD>Shield (isShield=1)</TD>
<TD>The shield. Really not much to say about this, the tags are all documented in the changelog.</TD>
</TR>
<TR>
<TD>TorpedoLauncher (waterweapon=1)</TD>
<TD>Fires a projectile that will behave ballistically out of water and like a missile in water. Since waterweapon=1 is usually set for them they can fire underwater and they will target underwater units. The torpedo is the only projectile that doesn't explode on the water surface. An aircraft carrying a TorpedoLauncher is a special case, the thing turns into a bomb dropepr that will spawn a torpedo projectile, probably to get the whole bomber flight behaviour. Note that the waterweapon tag is also used to make a weapon fire underwater, independent of its type.</TD>
</TR>
<TR>
<TD>DGun (weaponname contains the word "disintegrator")</TD>
<TD>This shoots a fireball that travels in a straight line. The fireball has no range limitation by itself so if it misses or is fired in FPS mode it will travel across the whole map and further. DGuns don't properly check their line of fire, if terrain is in the way they fire anyway. These things are meant to be used with noexplode=1 but of course you CAN use them without that, too. If ballistic=1 is set the fireball will be affected by gravity, the weapon won't compensate for it though so it will hit the ground before reaching the target. Might be useful for a Scorched Earth mod or something since you'd have to aim it manually to hit anything.</TD>
</TR>
<TR>
<TD>LightingCannon (sic) (lineofsight=1 and rendertype=7)</TD>
<TD>An instant hit weapon like the Beamlaser except with a lightning graphic and even more annoying. It won't damage shields and it has a hardcoded inaccuracy (comparable to targetMoveError, the code comment is "should make it weaker against air"...). Shares some of the weirdnesses with the beamlaser, e.g. being able to penetrate water.</TD>
</TR>
<TR>
<TD>LaserCannon (lineofsight=1 and either beamweapon=1 or weaponname contains "laser" (marked as "workaround for SWTA))</TD>
<TD>The OTA-style laser. Probably one of the least annoying weapons in the engine. Its length is defined by the duration tag (together with the speed), BTW.</TD>
</TR>
<TR>
<TD>MissileLauncher (lineofsight=1 and smoketrail=1)</TD>
<TD>Shoots a smoke-emitting projectile. It can use guidance, acceleration, etc. The projectile's lifetime depends on range/maxspeed so a slowly accelerating missile will fall short. It can also use trajectoryheight to have the shot arc but that has trouble with aiming at targets higher or lower than the shooter (see bug report, this REALLY could use some fixing). Pretty versatile weapon overall, if the laser rendering code was ported into this we could pretty much axe the LaserCannon completely.</TD>
</TR>
<TR>
<TD>EmgCannon (lineofsight=1 and rendertype=4 and color=2)</TD>
<TD>Few know about this, it's a line of sight (i.e. not ballistic) weapon that can use billboard rendering (looks like a sprite). No idea what drawbacks this has, noone ever uses it.</TD>
</TR>
<TR>
<TD>Flame (lineofsight=1 and rendertype=5)</TD>
<TD>The flamethrower. A really annoying weapon. AFAIK it won't even aim ahead of moving targets. Can't say much else about it since I haven't tried using it much but overall I'd avoid the weapontype and fake the effect somehow, it's not pretty when fast and won't hit jack when slow.</TD>
</TR>
<TR>
<TD>Cannon (anything that didn't trigger another weapon)</TD>
<TD>Aka plasma. Shoots a ballistic projectile. Unlike the DGun it aims properly. Can't be emit-sfxed properly, maybe a ballistic DGun can fill that role.</TD>
</TR>
<TR>
<TD>Melee (only reachable through WeaponType)</TD>
<TD>When it fires it simply damages the target, no ifs or buts. It doesn't use a projectile and doesn't care about the line of fire. It won't even report a proper heading and pitch to AimWeapon so if you plan on using it in 75b2 you have to slave it to another weapon to handle the aiming. May be useful to be the damage dealer for a cosmetic weapon, i.e. you slave the Melee to a weapon that does no damage but looks pretty and the Melee does the damage. Kinda like the weapons in Warcraft and so.</TD>
</TR>
<TR>
<TD>Rifle (only reachable through WeaponType)</TD>
<TD>An instant hit weapon but an apparently unmaintained one. It has a hardcoded firing and explosion effect. I wouldn't use it.</TD>
</TR>
<TR>
<TD>CNoWeapon (weaponname is NOWEAPON, not reachable by any tag)</TD>
<TD>Apparently a placeholder used when a weapon isn't present. It's not really a weapondef but generated when the unit demands a NOWEAPON.</TD></TR>
</table>
=Descriptions=
<table width=730 border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;">
<TR><th>Variable </th><th> Description </th><th> Examples</Th> </tr>
<TR>
<TD>Accuracy</TD>
<TD>How accurate a weapon is. A larger number is less accurate. If this tag is missing entirely, it has perfect accuracy unless its target moves unexpectedly. Accuracy is relative to the distance to the target; for instance, if the target is very close, even a very high accuracy value will probably still hit. If a target is very far away, even a very low accuracy value will likely cause the weapon to miss. Can be any numeric value.</TD>
<TD>accuracy=400;</TD>
</TR>
<TR>
<TD>AlwaysVisible</TD>
<TD>Ignore LOS handling and always draw the weapon effect? Can be 1 or 0.</TD>
<TD>alwaysVisible=0;</TD>
</TR>
<TR>
<TD>AreaOfEffect</TD>
<TD>How large the weapon's impact explosion is. This affects how powerful the weapon's default impulse strength will be. Currently, BeamLasers with an AreaOfEffect of 16 or above will deform the ground at their point of impact regardless of whether it has been told not to. Can be any numeric value, but should generally be at least 8, regardless of the type of weapon.</TD>
<TD>areaofeffect=192;</TD>
</TR>
<TR>
<TD>AvoidFeature</TD>
<TD>This makes the weapon avoid features while targetting (the shoot will still collide with features). Can be 1 or 0.</TD>
<TD>avoidFeature=0;</TD>
</TR>
<TR>
<TD>AvoidFriendly</TD>
<TD>If set to 0 units will not try to avoid friendly units in their line of fire. Can be 1 or 0.</TD>
<TD>avoidFriendly=1;</TD>
</TR>
<TR>
<TD>Ballistic</TD>
<TD>Set to 1 for the weapon to be subjected to gravity, travelling in an arc through the air, such as cannons. Ballistic is mutually exclusive to LineOfSight and Dropped. Can be 1 or 0.</TD>
<TD>ballistic=1;</TD>
</TR>
<TR>
<TD>BeamDecay</TD>
<TD>For BeamLasers, defines the speed of the fadeout (each frame the beam's intensity is multiplied with that value). Can be between 0 and 1.</TD>
<TD>beamDecay=0.9;</TD>
</TR>
<TR>
<TD>BeamLaser</TD>
<TD>Whether this weapon is a beam laser or not. Beam lasers instantly hit their targets. Rendertype must be 0. Mutually exclusive to BeamWeapon. Can be 1 or 0.</TD>
<TD>beamlaser=1;</TD>
</TR>
<TR>
<TD>BeamTime</TD>
<TD>How long to fire the laser before waiting for ReloadTime to start. Can be any numeric value. Defaults to 1.</TD>
<TD>beamtime=0.5;</TD>
</TR>
<TR>
<TD>BeamTTL</TD>
<TD>For BeamLasers, defines the time (in frames) the beam will stay after being fired. Can be any numeric value.</TD>
<TD>beamTtl=10;</TD>
</TR>
<TR>
<TD>BeamWeapon</TD>
<TD>Whether this weapon is a regular laser or not. BeamWeapons (lasers) do not instantly hit their targets, and are affected by the weaponvelocity tag. Mutually exclusive to BeamLaser. Can be 1 or 0.</TD>
<TD>beamweapon=1;</TD>
</TR>
<TR>
<TD>BounceRebound</TD>
<TD>The amount of vertical velocity a projectile keeps when it bounces. Generally .3-1, but 0 for a sticky bomb, or 2 for a flubber bomb. Defaults to 1</TD>
<TD>bouncerebound=.8;</TD>
</TR>
<TR>
<TD>BounceSlip</TD>
<TD>The amount of horizontal velocity a projectile keeps when it bounces. Generally .3-1, but 0 for a sticky bomb, or 2 for a flubber bomb. Defaults to 1</TD>
<TD>bounceslip=.8;</TD>
</TR>
<TR>
<TD>BurnBlow</TD>
<TD>The weapon blows up when it reaches range the target was at when the weapon fired. Only works on plasma (rendertype=4) weapons and possibly missiles? Can be 1 or 0. A common usage is on flak guns.</TD>
<TD>burnblow=1;</TD>
</TR>
<TR>
<TD>Burst</TD>
<TD>How many shots are in a burst. Must be accompanied by burstrate. Can be any numeric value.</TD>
<TD>burst=3;</TD>
</TR>
<TR>
<TD>BurstRate</TD>
<TD>How fast the Burst fires. If set much below 0.1, it stops having any discernable effect.</TD>
<TD>burstrate=0.1</TD>
</TR>
<TR>
<TD>CameraShake</TD>
<TD>How much the camera shakes on impact. (needs the cameraShake widget to work). Can be any numeric value.</TD>
<TD>cameraShake=5;</TD>
</TR>
<TR>
<TD>CanAttackGround</TD>
<TD>Can be set to 1 or 0.</TD>
<TD>canAttackGround=0</TD>
</TR>
<TR>
<TD>CegTag</TD>
<TD>CegTag is the tag that emits a custom explosion every frame for a projectile. Can be used on any weapon to imitate dynamic lighting, smoke, fire, ball lightning, magic and many other things. Enter the name of your effect to make it emit once per frame.</TD>
<TD>cegtag=MISSILE_SMOKE_FX;</TD>
</TR>
<TR>
<TD>Color</TD>
<TD>An obsolete tag only recognized for compatibility purposes. While this still works for lasers, using rgbcolor=X X X; is a much, much better route. Plus, the RGBColor tag will override any color=x; tags in the tdf. </TD>
<TD>color=1;</TD>
</TR>
<TR>
<TD>Color2</TD>
<TD>An obsolete tag only recognized for compatibility purposes.</TD>
<TD>color=2;</TD>
</TR>
<TR>
<TD>ColorMap</TD>
<TD>Only used by flamethrower. Must be a CColorMap type.</TD>
<TD>colorMap=1 0 0 1  0 1 0 1; (red to green fade)</TD>
</TR>
<TR>
<TD>CollideFriendly</TD>
<TD>If set to 0 this weapon will not hit friendly units. Can be set to 1 or 0.</TD>
<TD>collisionFriendly=1;</TD>
</TR>
<TR>
<TD>CollisionSize</TD>
<TD>Defines the physical size of projectiles, percentage of size for flamethrower and absolute value emg, plasma and laser. Can be any numeric value.</TD>
<TD>collisionSize=30;</TD>
</TR>
<TR>
<TD>CommandFire</TD>
<TD>When ordered to attack ground this weapon will only fire once, rather than continuously. This does not work when ordered to attack units (It will continue to fire until the target is dead). If the unit has CanDgun=1 in its FBI, commandfire will identify that weapon with the dgun button. The weapon wont fire unless the dgun button is pressed. Can be set to 1 or 0.</TD>
<TD>commandfire=1;</TD>
</TR>
<TR>
<TD>CoreThickness</TD>
<TD>Thickness of the core of a laser (the part which use rgbcolor2). Can be any numeric value.</TD>
<TD>coreThickness=0.25;</TD>
</TR>
<TR>
<TD>Coverage</TD>
<TD>The range for anti-weapon weapons, like antinukes. This will be shown on the minimap as a guide. Can be any numeric value.</TD>
<TD>coverage=1280;</TD>
</TR>
<TR>
<TD>CraterBoost</TD>
<TD>Adds a constant factor to the terraform the explosion does. Can be any numeric value. (default 0)</TD>
<TD>craterMult=0.1;</TD>
</TR>
<TR>
<TD>CraterMult</TD>
<TD>Multiplies with the terraform the explosion does. Can be any numeric value. (default :=impulsFactor)</TD>
<TD>craterMult=1.2;</TD>
</TR>
<TR>
<TD>CylinderTargetting</TD>
<TD>If greater than 0, range will be checked in a cylinder instead of a sphere:
half height=unitradius*cylinderTargetting
Defaults to 1 for Melee type weapons, 0 otherwise. In 0.76b1, does not work with BeamLaser weapons.([http://spring.clan-sy.com/phpbb/viewtopic.php?p=219659#p219659 image])</TD>
<TD>cylinderTargetting=0;</TD>
</TR>
<TR>
<TD>Dance</TD>
<TD>For missles, unlike wobble it doesn't rotate the missile and it prevents the missile from going too far off course so a dancing swarm will remain coherent. Can be any numeric value.</TD>
<TD>dance=97;</TD>
</TR>
<TR>
<TD>Dropped</TD>
<TD>Sets the weapon to be dropped, like from a bomber. Must be RenderType=6 and needs the Model tag to be specified. Mutually exclusive to Ballistic and LineOfSight. Can be set to 1 or 0.</TD>
<TD>dropped=1;</TD>
</TR>
<TR>
<TD>Duration</TD>
<TD>For how many seconds a beam weapon will be fired before waiting for reload time. Also controls the length of the beam in BeamWeapon projectiles. Can be any numeric value. Used for rendertype 0 and 7 weapons.</TD>
<TD>duration=.5;</TD>
</TR>
<TR>
<TD>DynDamageExp</TD>
<TD>Exponent of the range damage formula, 0 (the default) disables dynamic damage. 1 means linear scaling. Only used by BeamLasers and LightingCannons. Can be any numeric value. ([http://spring.clan-sy.com/phpbb/viewtopic.php?p=263438#p263438 image])</TD>
<TD>dynDamageExp=0;</TD>
</TR>
<TR>
<TD>DynDamageInverted</TD>
<TD>Inverts the damage curve (more damage at far range). Only used by BeamLasers and LightingCannons. Can be 0 or 1.</TD>
<TD>dynDamageInverted=0;</TD>
</TR>
<TR>
<TD>DynDamageMin</TD>
<TD>Minimum dynamic range damage value. Only used by BeamLasers and LightingCannons. Can be any numeric value.</TD>
<TD>dynDamageMin=0;</TD>
</TR>
<TR>
<TD>DynDamageRange</TD>
<TD>If set it will use this value in the dynamic range damage formula instead of the range value from the weapon in the calculation. Only used by BeamLasers and LightingCannons. Can be any numeric value.</TD>
<TD>DynDamageRange=400;</TD>
</TR>
<TR>
<TD>EdgeEffectiveness</TD>
<TD>Determines what percent of a weapon's maximum damage value will be applied to units as they are closer to the outer edge of the weapon's AreaOfEffect. Must have a decimal value between 0 and 1. Default in OTA was 0, probably the same in Spring. ([http://spring.clan-sy.com/phpbb/viewtopic.php?p=251180#p251180 image])</TD>
<TD>edgeEffectiveness=0.25;</TD>
</TR>
<TR>
<TD>EnergyPerShot</TD>
<TD>Energy used per shot. If the specified amount of energy is not available, the weapon will not be able to shoot. Can also be used to specify how much a Stockpile weapon wll cost to build. Can be any numeric value.</TD>
<TD>energypershot=5;</TD>
</TR>
<TR>
<TD>ExplosionSpeed</TD>
<TD>Explosion animation speed/time. (only used by BeamLaser and LightingCannon?) default:
gd=max(30, DefaultDamage/20); 
expSpeed=(8+(gd*2.5))/(9+(sqrt(gd)*.7))/2; 
Can be any numeric value.
</TD>
<TD>explosionSpeed=5;</TD>
</TR>
<TR>
<TD>FallOffRate</TD>
<TD>Rate at which the beamweapon fades out after it goes past its maximum range. 0 is never fade out, 1 is finish fading out exactly at max range, the default 0.5 is the previous behaviour.
<TD>FallOffRate=0.5;</TD>
</TR>
<TR>
<TD>FireStarter</TD>
<TD>How likely the weapon will set trees on fire. High values make trees likey to be set on fire, low values make trees likely to just explode or tip over. Can be any numeric value between 0 and 100.</TD>
<TD>fireStarter=75;</TD>
</TR>
<TR>
<TD>FireSubmersed</TD>
<TD>If set the weapon can fire underwater, if not then not. Use it for weapons that cannot fire underwater but can hit underwater targets. Works even for torpedoes. Can be 0 or 1.</TD>
<TD>fireSubmersed=1;</TD>
</TR>
<TR>
<TD>FixedLauncher</TD>
<TD>For missiles, starburst missiles and torpedoes, this makes the projectile spawn with the orientation of the shooting piece instead of their normal orientation. The weapon will not properly check if allies are in the way so make sure you align the launchers in a way that won't hammer right into your own forces and perhaps use collideFriendly=0. FixedLauncher conflicts with trajectoryHeight and IMO combining them is pointless anyway so don't use both on a weapon. Can be 0 or 1.</TD>
<TD>fixedLauncher=0;</TD>
</TR>
<TR>
<TD>FlameGFXTime</TD>
<TD>Makes the flamethrower projectile stay alive as a graphical effect (doesnt do any damage) after it has reached maxrange. It is defined in percent, so 1.2 makes it remain 20% beyond maxrange. Can be any numeric value.
<TD>flamegfxtime=1.2;</TD>
</TR>
<TR>
<TD>FlightTime</TD>
<TD>Can be any numeric value.</TD>
<TD>flightTime=10;</TD>
</TR>
<TR>
<TD>GroundBounce</TD>
<TD>Weather the weapon projectile will bounce on the ground (on land or the ocean floor). Can be 0 or 1, defaults to 0 (off)</TD>
<TD>groundbounce=1;</TD>
</TR>
<TR>
<TD>Guidance</TD>
<TD>Specifies whether or not the weapon is capable of correcting its trajectory mid-flight. Will not track a moving target. Works only on missile and torpedo weapons. Can be set to 1 or 0. See TurnRate for information on specifying how well a weapon can track a target. Requires rendertype=1, lineofsight=1, and selfprop=1;</TD>
<TD>guidance=1;</TD>
</TR>
<TR>
<TD>HardStop</TD>
<TD>For LaserCannon, defined if the laser effect hard stops or fade out. Can be 0 or 1.</TD>
<TD>hardStop=0;</TD>
</TR>
<TR>
<TD>HeightBoostFactor</TD>
<TD>Gives control of cannon height range boost (more than 1 means increased range, 0 means the cannon has fixed range regardless of height difference to target. default is a magic value calculated on weapon init, based on range tag and theoretical max range.). Can be any numeric value, including negative ones (<0 := automatically calculated).</TD>
<TD>heightBoostFactor=-1;</TD>
</TR>
<TR>
<TD>HeightMod</TD>
<TD>Changes the sphere weapon range into an ellipsis. If it is larger 1.0 the weapon can't shoot as height as far, i.e. 0.5 means it can shoot twice as height as far ([http://spring.clan-sy.com/phpbb/viewtopic.php?p=219659#p219659 image]). Note that this may not work well with beam weapons, use minIntensity (0..1) tag to fix that.</TD>
<TD>heightMod=1;</TD>
</TR>
<TR>
<TD>ImpulseBoost</TD>
<TD>A constant factor added on the weapon's impulsefactor. Can be any numeric value, including negative ones.</TD>
<TD>impulseBoost=0.5;</TD>
</TR>
<TR>
<TD>ImpulseFactor</TD>
<TD>The multiplier on the weapon's default impulsefactor, which is determined based on a weapon's default damage and AreaOfEffect. The impulse of a weapon is how strong of a kinetic force will be applied to its target or anything near the point of impact. Can be any numeric value, including negative ones.</TD>
<TD>impulsefactor=2.5;</TD>
</TR>
<TR>
<TD>Intensity</TD>
<TD>Alpha (brighness and washout effect) of the weapon. Can be used on any rendertype 0, 3, or 4 weapon. Can be any numeric value.</TD>
<TD>intensity=1.5;</TD>
</TR>
<TR>
<TD>InterceptedByShieldType</TD>
<TD>Bitfield representing the types of shields that can intercept this weapon. The best way to think about this is to think of it as the resulting binary. Every digit of binary that is set to one means that a shield with that digit set to one will intercept this weapon, for instance, the example will result in the weapons being blocked by shields with types 1 and/or 3. Maxium of 32 unique types. See [[Shield Interception Tag Use]].</TD>
<TD>InterceptedByShieldType=5;</TD>
</TR>
<TR>
<TD>Interceptor</TD>
<TD>Can intercept missiles with the Cruise tag.</TD>
<TD>interceptor=1;</TD>
</TR>
<TR>
<TD>LargeBeamLaser</TD>
<TD>If set to 1 a beamlaser uses an alternate graphics effect. Can be 0 or 1.</TD>
<TD>largeBeamLaser=0;</TD>
</TR>
<TR>
<TD>LaserFlareSize</TD>
<TD>Size of the flare for laser weapons, multiplier for thickness. Can be set to any numeric value. (default: 15)</TD>
<TD>laserFlareSize=15;</TD>
</TR>
<TR>
<TD>Leadbonus</TD>
<TD>Is multiplied with the unit's experience and added to the lead limit.</TD>
<TD>leadbonus=1;</TD>
</TR>
<TR>
<TD>LeadLimit</TD>
<TD>Limits the maximum distance a unit will lead a target (default is -1 which means infinite).</TD>
<TD>leadLimit=1;</TD>
</TR>
<TR>
<TD>LineOfSight</TD>
<TD>NOT SUPPORTED BY SPRING! 
It is only used to detect the weapontype of ota weapon configs.</TD>
<TD></TD>
</TR>
<TR>
<TD>LodDistance</TD>
<TD>Minimum camera distance at which the default beamweapon projectile is simplified to rectangle. Can be set to any numeric value. (default: 1000)</TD>
<TD>lodDistance=1000;</TD>
</TR>
<TR>
<TD>ManualBombSettings</TD>
<TD>For Bombers, use burst and burstrate tags instead of hardcoded values. Can be set to 1 or 0.</TD>
<TD>manualBombSettings=1;</TD>
</TR>
<TR>
<TD>MetalPerShot</TD>
<TD>Metal used per shot. If the specified amount is not available, the weapon cannot be fired. Can also be used to specify how much a Stockpile weapon wll cost to build. Can be set to any numeric value.</TD>
<TD>metalpershot=500;</TD>
</TR>
<TR>
<TD>MinIntensity</TD>
<TD>For beamlasers - always hit with some minimum intensity (a damage coeffcient normally dependent on distance - range 0 to 1). Can be set to any numeric value.</TD>
<TD>minIntensity=0.1;</TD>
</TR>
<TR>
<TD>Model</TD>
<TD>The 3DO or S3O model to be used as this weapon's physical representation. 3DO modesl do not need a .3do extension, but S3O weapon do.</TD>
<TD>model=missile;</TD>
</TR>
<TR>
<TD>MovingAccuracy</TD>
<TD>A weapon's accuracy while moving. See Accuracy. Can be any numeric value.</TD>
<TD>movingaccuracy=1000;</TD>
</TR>
<TR>
<TD>MyGravity</TD>
<TD>For ballistic weapons (Cannon and Bomb), it overrides the map gravity if used. Regular map gravity is around 0.2.</TD>
<TD>myGravity=0.2;</TD>
</TR>
<TR>
<TD>NoExplode</TD>
<TD>Whether or not the weapon will explode on impact or continue on its path. An example is the d-gun. Can be set to 1 or 0.</TD>
<TD>noexplode=1;</TD>
</TR>
<TR>
<TD>NoSelfDamage</TD>
<TD>This weapon will not damage the unit that fired it. For instance, a nuke silo could shoot itself and not take any damage if this was active. Can be set to 1 or 0.</TD>
<TD>noselfdamage=1;</TD>
</TR>
<TR>
<TD>NumBounce</TD>
<TD>The maximum number of times a weapon will bounce. -1 for infinite. Defaults to -1</TD>
<TD>numbounce=5;</TD>
</TR>
<TR>
<TD>Paralyzer</TD>
<TD>If active, this weapon will not cause any damage to its target, but will instead paralyze (aka EMP). The default damage value of a weapon with this active will be applied to the target's HP; once the HP is overwhelmed, it will be paralyzed. Can be set to 1 or 0.</TD>
<TD>paralyzer=1;</TD>
</TR>
<TR>
<TD>ParalyzerTime</TD>
<TD>On Paralyzer weapons, determines the maximum length of time the target will be paralyzed (In seconds?). The timer is refreshed every time the target is hit by the weapon. Can be set to any numerical value.</TD>
<TD>paralyzetime=10;</TD>
</TR>
<TR>
<TD>PredictBoost</TD>
<TD>No idea what it does. Default 0 for non-burnblow, 0.5 for burnblow weapons. Can be set to any numerical value.</TD>
<TD>predictBoost=15;</TD>
</TR>
<TR>
<TD>Projectiles</TD>
<TD>The weapon fires this many projectiles at once (shotgun style). Make sure you put them on different trajectories somehow (sprayangle or different firepoints) because otherwise they'll all be clumped in one shot. Works well combined with bursts. Can be set to any integer value.</TD>
<TD>projectiles=1o;</TD>
</TR>
<TR>
<TD>ProximityPriority</TD>
<TD>Acts as a multiplier for the distance to the target in the priority calculation. Note that negative values make weapons prefer distant targets. Can be set to any numerical value.</TD>
<TD>proximityPriority=1;</TD>
</TR>
<TR>
<TD>PulseSpeed</TD>
<TD>On LargeBeamLaser, how fast the pulsating effect at the beam start is. Can be set to any numerical value.</TD>
<TD>pulseSpeed=15;</TD>
</TR>
<TR>
<TD>Range</TD>
<TD>The maximum range of the weapon. If set to noexplode, the weapon will disappear after this range has been met. If set to burnblow, the weapon will explode after this range has been met. Can be set to any numerical value.</TD>
<TD>range=750;</TD>
</TR>
<TR>
<TD>ReloadTime</TD>
<TD>The amount of time between shots. If a unit is paralyzed, this stops counting down. Can be set to any numerical value.</TD>
<TD>reloadtime=3.5;</TD>
</TR>
<TR>
<TD>Rendertype</TD>
<TD>The way the weapon will be displayed. Certain rendertypes are incompatibile with other tags, but it's generally for a logical reason. The rendertypes are as follows: 0 - Laser, 1 - Model, 3 - Plasma, 4 - Unit explosion (usally), 5 - Flamethrower, 6 - Dropped, 7 - Lightning. There's no documented use of rendertype=2 in OTA, and it probably doesn't do anything in Spring. 3 and 4 are usually interchangeable, both can be used to render a plasma/EMG/whatever shot; this is probably for compatibility.</TD>
<TD>rendertype=1;</TD>
</TR>
<TR>
<TD>RGBColor</TD>
<TD>The color of the rendertype 0, 3, 4, 7 weapon, specified in RED_GREEN_BLUE format.</TD>
<TD>rgbcolor=1 0.3 1; - this would make evul-purple</TD>
</TR>
<TR>
<TR>
<TD>RGBColor2</TD>
<TD>The color at the core of a rendertype 0 (laser) weapon. Specified the same as above. Defaults to white.</TD>
<TD>RGBColor2=0 1 0; - this would make a weird green middle for the evul-purple laser</TD>
</TR>
<TR>
<TD>ScrollSeed</TD>
<TD>Only used by LargeBeamLaser. How fast the beam apears to be moving towards it target. Can be set to any numerical value.</TD>
<TD>scrollSeed=1;</TD>
</TR>
<TR>
<TD>Selfprop</TD>
<TD>Required for Guidance tag. This weapon can propel itself and can have things like acceleration, rather than always travelling at one speed. See Guidance, StartVelocity, WeaponAcceleration, WeaponVelocity. Can be set to 1 or 0.</TD>
<TD>selfprop=1;</TD>
</TR>
<TR>
<TD>Size</TD>
<TD>Defines the visible size of projectiles. Can be set to any numerical value.</TD>
<TD>size=10;</TD>
</TR>
<TR>
<TD>SizeGrowth</TD>
<TD>Defines how fast flame projectiles will grow in size. Can be set to any numerical value.</TD>
<TD>sizegrowth=0.6;</TD>
</TR>
<TR>
<TD>SmokeTrail</TD>
<TD>Does the projectile leave a smoke trail or not. Can be set to 1 or 0.</TD>
<TD>smoketrail=1;</TD>
</TR>
<TR>
<TD>SoundHit</TD>
<TD>The sound made whe the weapon hits. Must reference a .wav file in the .\Sounds directory.</TD>
<TD>soundhit=emghit;</TD>
</TR>
<TR>
<TD>SoundHitVolume</TD>
<TD>Can be any numerical value between 0 and 1.</TD>
<TD>soundhitvolume=0.5;</TD>
</TR>
<TR>
<TD>SoundStart</TD>
<TD>The sound made when the weapon begins to fire. Will fire only once if the weapon is shot in a burst. Must reference a .wav file in the .\Sounds directory.</TD>
<TD>soundstart=emgfire;</TD>
</TR>
<TR>
<TD>SoundStartVolume</TD>
<TD>Can be any numerical value between 0 and 1.</TD>
<TD>soundstartvolume=0.5;</TD>
</TR>
<TR>
<TD>SoundTrigger</TD>
<TD>If active, the weapon will sound every time a shot is fired in a burst sequence. Can be set to 1 or 0.</TD>
<TD>soundtrigger=1;</TD>
</TR>
<TR>
<TD>SprayAngle</TD>
<TD>How wide the the angle of a burst from a burst weapon can be. Very similar to Accuracy, except that if a weapon has no sprayangle, all the shots will be fired at the same spot, even if the weapon's aim is off.</TD>
<TD>sprayangle=1024;</TD>
</TR>
<TR>
<TD>StartVelocity</TD>
<TD>The starting speed of the weapon as it is first fired. Only applicable to weapons that can accelerate.</TD>
<TD>startvelocity=200;</TD>
</TR>
<TR>
<TD>Stockpile</TD>
<TD>Can this weapon be stockpiled, for instance like a nuke launcher. Can be set to 1 or 0.</TD>
<TD>stockpile=1;</TD>
</TR>
<TR>
<TD>SubMissile</TD>
<TD>For TorpedoLaunchers, if set to 1 the torpedo will travel like a missile outside of water. It will not emit a smoketrail, though. When fired from a plane it will behave the same way but the plane will probably be considered a fighter, not a bomber. Can be set to 1 or 0.</TD>
<TD>subMissile=0;</TD>
</TR>
<TR>
<TD>SweepFire</TD>
<TD>If 1 (default 0) it will make the weapon continue firing while it aims for a new target. Only works on continous beam lasers currently. Can be set to 1 or 0.</TD>
<TD>SweepFire=1;</TD>
</TR>
<TR>
<TD>TargeBorder</TD>
<TD>If nonzero, targetting units will TryTarget at the edge of collision sphere (radius*tag_value, [-1;1]) instead of its centre. Can be set between 0 and 1. Defaults to 1 for Melee type weapons, 0 otherwise. ([http://spring.clan-sy.com/phpbb/viewtopic.php?p=219659#p219659 image])</TD>
<TD>targetBorder=1;</TD>
</TR>
<TR>
<TD>Targetable</TD>
<TD>If active, the weapon will be automatically targeted by any Interceptor weapons.</TD>
<TD>targetable=1;</TD>
</TR>
<TR>
<TD>TargetMoveError</TD>
<TD>The degree to which a weapon's aiming will fail to keep up with its target's movement. If set very low or not set at all, a weapon will lead its target and almost always hit unless there's a lot of micromanagement on the part of the person controlling the target. If set too high (about 0.3 or above), the weapon will have a lot of difficulty even tracking its target enough to get a shot off. Can probably only be set between 0 and 1. Beyond 1, the weapon would be virtually useless.</TD>
<TD>targetmoveerror=0.15;</TD>
</TR>
<TR>
<TD>Thickness</TD>
<TD>Thickness of a beamweapon or beamlaser, default is 2. Can be set to any numerical value.</TD>
<TD>thickness=4;</TD>
</TR>
<TR>
<TD>TileLength</TD>
<TD>Only used by LargeBeamLaser. Defines the length before the texture used is repeated (tiled).</TD>
<TD>tileLength=4;</TD>
</TR>
<TR>
<TD>ToAirWeapon</TD>
<TD>If active, the weapon will only be capable of targetting units which are flying, or are capable of flying. Can be set to 0 or 1.</TD>
<TD>toairweapon=1;</TD>
</TR>
<TR>
<TD>Tolerance</TD>
<TD>The amount to which the weapon's "real" aim can be off while the weapon will still be able to fire accurately at the target. This worked in OTA, but I'm not 100% sure if it works in Spring. Can be set to any numerical value.</TD>
<TD>tolerance=1500;</TD>
</TR>
<TR>
<TD>Tracks</TD>
<TD>If the missile tracks a moving target. Can be set to 1 or 0.</TD>
<TD>tracks=1;</TD>
</TR>
<TR>
<TD>TrajectoryHeight</TD>
<TD>The height of the arc of a missile weapon. It is useful for compensating for mountains or debris. Is relative to the weapons speed (Higher speed, higher arc) and the range the weapon is firing at (Lower range lower arc). Requires Guidance and Turnrate to hit its target when over 1. </TD>
<TD>trajectoryheight=0.8;</TD>
</TR>
<TR>
<TD>Turnrate</TD>
<TD>How fast a guided weapon can turn. Can be any numerical value between 0 and 64000. If set to 0, the weapon can't turn at all, if set to 64000, the weapon can literally defy all known physics and turn 180 degrees in a fraction of a second. This is relative to a weapon's velocity; a weapon with a very low velocity (~200) wouldn't need a very high turnrate to keep up with a fighter, although it would probably never catch it because of its slow speed. A weapon with a very high velocity (~1000) would need a very high value in order to be able to hit targets that turn suddenly.
<TD>turnrate=32000;</TD>
</TR>
<TR>
<TD>Turret</TD>
<TD>Set to 1 if weapon is used by a turret that rotates. Set to 0 if weapon is forward firing, ie, has no rotating turret piece.</TD>
<TD>turret=1;</TD>
</TR>
<TR>
<TD>TwoPhase</TD>
<TD>Weapon operates in two phases... eh... yeah, I honestly have no idea what the difference between this and VLaunch is. Generally use it with VLaunch as well. Can be set to 1 or 0.</TD>
<TD>twophase=1;</TD>
</TR>
<TR>
<TD>VLaunch</TD>
<TD>Set to 1 to launch the weapon vertically. Can only be used with missile-type weapons with a TurnRate. Cannot be used at the same time as Turret. Set to 1 or 0.</TD>
<TD>vlaunch=1;</TD>
</TR>
<TR>
<TD>WaterBounce</TD>
<TD>Weather the weapon projectile will bounce on the surface of the water. Can be 0 or 1, defaults to 0 (off)</TD>
<TD>waterbounce=1;</TD>
</TR>
<TR>
<TD>WaterWeapon</TD>
<TD>Water weapons behave somewhat like Dropped weapons out of water, and like missiles underwater. Is the only type of weapon that can fire under water. Can be set to 1 or 0.</TD>
<TD>waterweapon=1;</TD>
</TR>
<TR>
<TD>WeaponAcceleration</TD>
<TD>Tells the weapon how fast it should accelerate from its StartVelocity to its actual WeaponVelocity. Increases the weapon's velocity every second by the amount specified. Can be any numerical value.</TD>
<TD>weaponacceleration=50;</TD>
</TR>
<TR>
<TD>WeaponTimer</TD>
<TD>;How long until the weapon will go into its second phase. For use with missile weapons. For VLaunch weapons, the weapon will turn to actually go towards its target after the specified number of seconds has expired. For non-VLaunch missiles with a TurnRate, the weapon will go randomly off-course after this period of time. Can be set to any numerical value.</TD>
<TD>weapontimer=5;</TD>
</TR>
<TR>
<TD>WeaponVelocity</TD>
<TD>The speed the weapon moves after being fired. If StartVelocity is lower than this number, the weapon will increase speed to its WeaponVelocity at the rate specified by its WeaponAcceleration.</TD>
<TD>weaponvelocity=800;</TD>
</TR>
<TR>
<TD>Wobble</TD>
<TD>The amount that a missile will wobble off-course. Requires TurnRate. Turnrate will wrestle with wobble to keep the weapon on course, so wobble must be high enough to compensate to have any effect. Can be set to any numerical value between 0 and 64000.</TD>
<TD>wobble=15000;</TD>
</TR>
</table>
NOTE: Variables that are defined by either a 1 or a 0 are BOOLEAN, where 1 means TRUE and 0 means FALSE.

NOTE 2: "Any numerical value" for things that relate to angles really means any value between 0 and 64,000 since that's between 0 and 360 degrees in spring measurement. Setting it higher than 64,000 will bring it 'full circle' so to speak.
 

=Texture Tags=
<center>
<table width=500 border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 1em; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;">
<TR><th> Weapon </th><th> Used Texture Tags </th> </tr>
<TR>
<TD>AircraftBomb</TD>
<TD>texture1 = projectile</TD>
</TR>
<TR>
<TD>BeamLaser</TD>
<TD>texture1 = beam texture2 = beamend texture3 = flare </TD>
</TR>
<TR>
<TD>PlasmaCannon</TD>
<TD>texture1 = projectile</TD>
</TR>
<TR>
<TD>EmgCannon</TD>
<TD>texture1 = projectile</TD>
</TR>
<TR>
<TD>FlameThrower</TD>
<TD>texture1 = flame</TD>
</TR>
<TR>
<TD>LargeBeamLaser</TD>
<TD>texture1 = beam texture2 = beamend texture3 = muzzle texture4 = flare </TD>
</TR>
<TR>
<TD>LaserCannon</TD>
<TD>texture1 = beam texture2 = beamend </TD>
</TR>
<TR>
<TD>LightingCannon</TD>
<TD>texture1 = beam </TD>
</TR>
<TR>
<TD>MissileLauncher</TD>
<TD>texture1 = flare texture2 = smoketrail </TD>
</TR>
<TR>
<TD>Shield</TD>
<TD>texture1 = shield</TD>
</TR>
<TR>
<TD>StarburstLauncher</TD>
<TD>texture1 = flare texture2 = smoketrail texture3 = flame </TD>
</TR>
<TR>
<TD>TorpedoLauncher</TD>
<TD>texture1 = projectile </TD>
</TR>
</TABLE>
</center>
NOTE: All textures need to be `atlased`. So you have to define them in the '''resources.tdf''' and use the reference name in the texture tags.
 

=Plasma Visuals=
<table width=730 border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;">
<TR><th>Variable </th><th> Description </th><th> Examples</Th> </tr>
<TR>
<TD>AlphaDecay</TD>
<TD>How much a plasma particle is more transparent than the previous particle. Can be set to any numerical value. (default: 1)</TD>
<TD>AlphaDecay=0.95;</TD>
</TR>
<TR>
<TD>NoGap</TD>
<TD>If set to 1, the distance between plasma particles is proportional to the size of the two particles. If set to 0, the distance between plasma particles will be proportional to the size of the first particle.
Can be set to 1 or 0. (default: 1)</TD>
<TD>NoGap=0;</TD>
</TR>
<TR>
<TD>Separation</TD>
<TD>Distance between each plasma particle. Can be set to any number value. (default: 1)</TD>
<TD>Separation=5;</TD>
</TR>
<TR>
<TD>SizeDecay</TD>
<TD>How much a plasma particle is smaller than the previous within the same plasma shot. Can be set to any numerical value. (default: 0)</TD>
<TD>SizeDecay=0.2;</TD>
</TR>
<TR>
<TD>Stages</TD>
<TD>Number of particles used in one plasma shot. Can be set to any number value. (default: 5)</TD>
<TD>Stages=20;</TD>
</TR>
</table>
 

=Shield/Repulsor Descriptions=
<table width=730 border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;">
<TR><th>Variable </th><th> Description </th><th> Examples</Th> </tr>
<TR>
<TD>ExteriorShield</TD>
<TD>If set to 1, the shield/repulsor will not have any effect on weapons fired from within its field. Can be 1 or 0.</TD>
<TD>exteriorshield=1;</TD>
</TR>
<TR>
<TD>IsShield</TD>
<TD>If set to 1, this "weapon" is no longer a weapon, is now a repulsor or a shield, based on the other properties given to it. Can be 1 or 0.</TD>
<TD>isshield=1;</TD>
</TR>
<TR>
<TD>ShieldAlpha</TD>
<TD>How clearly visible the shield is, if you have VisibleShield turned on. Value is between 0 and 1.</TD>
<TD>shieldalpha=0.4;</TD>
</TR>
<TR>
<TD>ShieldEnergyUse</TD>
<TD>The amount of energy used to repulse or destroy weapons. Will be used constantly while the weapon is in its area of effect if it is a repulsor, will be used only once on impact if it is a shield.</TD>
<TD>shieldenergyuse=1500;</TD>
</TR>
<TR>
<TD>ShieldForce</TD>
<TD>The force applied to weapons, an arbitrary number. Set to 1, it will not deflect very well. Only for use on repulsor-type. Can be set to any numerical value.</TD>
<TD>shieldforce=1.75;</TD>
</TR>
<TR>
<TD>ShieldBadColor</TD>
<TD>The color the shield is when it is at 0% strength, if you have VisibleShield turned on. Defined in R G B format.</TD>
<TD>shieldbadcolor=0 1 0;</TD>
</TR>
<TR>
<TD>ShieldGoodColor</TD>
<TD>The color the shield is when it is at 100% strength, if you have VisibleShield turned on.</TD>
<TD>shieldgoodcolor=1 0 0;</TD>
</TR>
<TR>
<TD>ShieldInterceptType</TD>
<TD>Bitfield representing the types of weapons that this shield can intercept. The best way to think about this is to think of it as the resulting binary. Every digit of binary that is set to one means that a weapon with that digit set to one will be intercepted by this shield, for instance, the example will result in the shield blocking weapons with types 2 and/or 3. Maxium of 32 unique types. See [[Shield Interception Tag Use]].</TD>
<TD>ShieldInterceptType=6;</TD>
</TR>
<TR>
<TD>ShieldMaxSpeed</TD>
<TD>The maximum speed the repulsor will push weapons away at. Only for use on repulsor-type. Can be set to any numerical value.</TD>
<TD>shieldmaxspeed=400;</TD>
</TR>
<TR>
<TD>ShieldPower</TD>
<TD>How much "power" a shield can store. "Power" is not the same as energy; think of it as the shield/repulsor's private battery source. It can be drained completely by defending against weapons, even if you have lots of energy. ''Power is drained by the affected weapons damage.'' Can be set to any numerical value.</TD>
<TD>shieldpower=1000;</TD>
</TR>
<TR>
<TD>ShieldPowerRegen</TD>
<TD>How quickly the shield regenerates its "power", even when under attack. Regenerates the amount specified every second. Can be set to any numerical value.</TD>
<TD>shieldpowerregen=25;</TD>
</TR>
<TR>
<TD>ShieldPowerRegenEnergy</TD>
<TD>How much energy is required to keep the shield regenerating its "power". For instance, you might have it set so that 100 units of energy are necessary for every 25 units of "power".</TD>
<TD>shieldpowerregenenergy=100;</TD>
</TR>
<TR>
<TD>ShieldRadius</TD>
<TD>Defines the size of the area the shield/repulsor protects. Can be set to any numerical value.</TD>
<TD>shieldradius=500;</TD>
</TR>
<TR>
<TD>ShieldRepulsor</TD>
<TD>If set to 1, the "shield"-type weapon will repulse projectiles. If set to 0, it will destroy them. Can be set to 1 or 0.</TD>
<TD>shieldrepulsor=1;</TD>
</TR>
<TR>
<TD>ShieldStartingPower</TD>
<TD>If set the shield starts with this much power instead of 0. Can be set to any numerical value.</TD>
<TD>shieldStartingPower=100;</TD>
</TR>
<TR>
<TD>SmartShield</TD>
<TD>If set to 1, the shield/repulsor will not affect owned/allied weapons. Can be set to 1 or 0.</TD>
<TD>smartshield=1;</TD>
</TR>
<TR>
<TD>VisibleShield</TD>
<TD>If set to 1, the shield will be visible. Only for use on shield-type. Can be set to 1 or 0.</TD>
<TD>visibleshield=1;</TD>
</TR>
<TR>
<TD>VisibleShieldHitFrames</TD>
<TD>Numbers of frames how long the shield should be visible after it got hit (the alpha value fades after the hit). Can be set to any numerical value. (default: 0 frames)</TD>
<TD>visibleShieldHitFrames=5;</TD>
</TR>
<TR>
<TD>VisibleShieldRepulse</TD>
<TD>If set to 1, the repulsing effect will be visible. Only for use on repulsor-type. Can be set to 1 or 0.</TD>
<TD>visibleshieldrepulse=1;</TD>
</TR>
</table>


[[category:Weapons]]

[[category:Shields]]

Lua OpenGL Api

2008-06-29T14:17:32Z

JK: /* Unit/Feature Draw Functions */

== Spring ==
'''gl.GetSun'''
() -> number sunPosX, number sunPosY, number sunPosZ
( "pos" ) -> number sunPosX, number sunPosY, number sunPosZ
( "shadowDensity" [, "unit"] ) -> number shadowDensity
( "diffuse" [, "unit"] ) -> nil | number r, number g, number b
( "ambient" [, "unit"] ) -> nil | number r, number g, number b
( "specular" ) -> nil | number r, number g, number b

'''gl.ConfigScreen'''
( number screenWidth, number screenDistance ) -> nil

'''gl.DrawMiniMap'''
() -> nil

'''gl.SlaveMiniMap'''
( boolean mode ) -> nil

'''gl.ConfigMiniMap'''
( int px, int py, int sx, int sy ) -> nil

'''gl.GetViewSizes'''
( ) -> number x, number y

== Basics ==

'''gl.PushMatrix'''
() -> nil

'''gl.PopMatrix'''
() -> nil

'''gl.Translate'''
(number x, number y, number z) -> nil

'''gl.Scale'''
(number x, number y, number z) -> nil

'''gl.Rotate'''
(number angle, number x, number y, number z) -> nil

'''gl.Color'''
( { number r, number g, number b[, number a] } |
number r, number g, number b[, number a] ) -> nil

'''gl.LineWidth'''
( number width ) -> nil

'''gl.PointSize'''
( number size ) -> nil

'''gl.Billboard''' use this to draw 2d primitives in DrawWorld
() -> nil

'''gl.ResetState'''
() -> nil

ShadeModel = GL_SMOOTH
Scissor = false
Texture = false
ColorMask = true, true, true, true
DepthMask = false
DepthTest = false (GL_LEQUAL)
Culling = false (GL_BACK)
LogicOp = false (GL_INVERT)
AlphaTest = false (GL_GREATER, 0.5f)
Blending = GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA


'''gl.ResetMatrices'''
() -> nil

Resets GL_TEXTURE matrix stack
Resets GL_MODELVIEW matrix stack
Resets GL_PROJECTION matrix stack


'''gl.Clear'''
( GL.DEPTH_BUFFER_BIT, number cleardepth ) -> nil
( GL.STENCIL_BUFFER_BIT, int clearstencil ) -> nil
( GL.COLOR_BUFFER_BIT | GL.ACCUM_BUFFER_BIT, number r, number g, number b, number a ) -> nil

== Draw Basics ==

'''gl.BeginEnd'''
( number [[Lua_ConstGL#Drawing_Primitives|GLType]], function [, arg1,... ] ) -> nil

'''gl.Vertex'''
( { number x, number y [, number z [, number w ]] } |
number x, number y |
number x, number y, number z |
number x, number y, number z, number w ) -> nil

'''gl.Normal'''
( number x, number y, number z |
{ number x, number y, number z } ) -> nil

'''gl.Rect'''
( number x1, number y1, number x2, number y2 ) -> nil

'''gl.TexRect''' texture rect
( number x1, number y1, number x2, number y2,
[ boolean flip_s, boolean flip_t | number s1, number t1, number s2, number t2 ] ) -> nil

'''gl.Shape'''
( number [[Lua_ConstGL#Drawing_Primitives|GLtype]],
elements = {
[1] = { v | vertex = { number x, number y, number z }, required
n | normal = { number x, number y, number z }, optional
t | texcoord = { number x, number y }, optional
c | color = { number r, number g, number b, number a } optional
},
etc ...
}
) -> nil

== Text ==

'''gl.Text'''
(string "text", number x, number y, number size [, string "options"] )

options:
'c' = center
'r' = right
'n' = deactives colorCodes (so you can use gl.Color() to write transparent text etc.)
'o' = black outline
'O' = white outline


'''gl.GetTextWidth'''
(string "text") -> number width -- in pixels, with a font size of 1.0

== Unit/Feature Draw Functions ==

'''gl.Unit''' (draws an unit; on default it uses LOD, with lod<0 it is turned off, else it defines a specific level)
( number unitID, [ boolean rawdraw, int lod ] ) -> nil

'''gl.UnitRaw''' (redundant -> use gl.Unit instead!)
( number unitID, [ boolean rawdraw, int lod ] ) -> nil

'''gl.UnitShape'''
( number unitDefID, number teamID ) -> nil

'''gl.Feature'''
( number featureID ) -> nil

'''gl.FeatureShape'''
( number featureDefID, number teamID ) -> nil

'''gl.UnitMultMatrix''' (world space -> unit space)
( number unitID ) -> nil

'''gl.UnitPieceMultMatrix''' (unit space -> piece space)
( number unitID, int piece ) -> nil

'''gl.UnitPiece''' (draws the unit piece)
( number unitID, int piece ) -> nil

'''gl.UnitPieceMatrix''' (use gl.UnitPieceMultMatrix instead!)
( number unitID, int piece ) -> nil

'''gl.DrawListAtUnit'''
( number unitID, number listID, [ boolean midPos,
number scaleX, number scaleY, number scaleZ,
number degrees, number rotX, number rotX, number rotZ ] ) -> nil

'''gl.DrawFuncAtUnit'''
( number unitID, boolean midPos, function [, arg1,... ]) -> nil

== Switches ==

'''gl.Blending'''
( boolean enable | number [[Lua_ConstGL#BlendingFactorSrc|srcmode]], number [[Lua_ConstGL#BlendingFactorDest|dstmode]] ) -> nil

'''gl.AlphaTest'''
( boolean enable | number [[Lua_ConstGL#AlphaFunction and DepthFunction|func]], number threshold ) -> nil

'''gl.DepthTest'''
( boolean enable | number [[Lua_ConstGL#AlphaFunction and DepthFunction|func]] ) -> nil

'''gl.Culling'''
( boolean enable | number [[Lua_ConstGL#Culling|face]] ) -> nil

'''gl.DepthMask'''
( boolean enable ) -> nil

'''gl.ColorMask'''
( boolean ) -> nil
( boolean r, boolean g, boolean b, boolean a ) -> nil

'''gl.LogicOp'''
( boolean enable | number [[Lua_ConstGL#LogicOp|func]] ) -> nil

'''gl.Fog'''
( boolean enable ) -> nil

'''gl.Smoothing'''
( (boolean enable | number POINT),
(boolean enable | number LINE),
(boolean enable | number POLYGON) ) -> nil

'''gl.EdgeFlag'''
( boolean enable ) -> nil

'''gl.Scissor'''
( boolean ) -> nil
( int x, int y, int w, int h ) -> nil

'''gl.LineStipple'''
( string any ) -> nil (use springs default line stipple)
( boolean enable ) -> nil
( int factor, number pattern ) -> nil

'''gl.PolygonMode'''
( number [[Lua_ConstGL#Culling|face]], number [[Lua_ConstGL#PolygonMode|mode]] ) -> nil

'''gl.PolygonOffset'''
( boolean enable | number factor, number units ) -> nil

== Textures ==

'''gl.Texture'''
( [ number texNum, ] boolean enable | string name ) -> nil | boolean loaded

current formats:
:${opt}:/LuaUI/images/image.png = filename
#12 = unitDef 12 buildpic
%34:1 = unitDef 34 s3o tex2 (:0->tex1,:1->tex2)
!56 = lua generated texture 56
$units = 3do textureatlas
$shadow = shadowmap
$specular = specular cube map
$reflection = reflection cube map

possible ${opt}'s are:
'n' = nearest
'l' = linear
'a' = aniso
'i' = invert
'g' = greyed
'c' = clamped
'b' = border
't' = tint (don't know how to use it, sorry)

example: ":iac:/LuaUI/images/image.png"


'''gl.CreateTexture'''
( int xsize, int ysize,
[ {
[target = number,] (like GL_TEXTURE_1D,GL_TEXTURE_2D,...)
[format = number,]
[min_filter = [[Lua_ConstGL#Texture_Filtering|number]],]
[mag_filter = [[Lua_ConstGL#Texture_Filtering|number]],]
[wrap_s = [[Lua_ConstGL#Texture_Clamping|number]],]
[wrap_t = [[Lua_ConstGL#Texture_Clamping|number]],]
[wrap_r = [[Lua_ConstGL#Texture_Clamping|number]],]
[aniso = number,]
[border = boolean,]
[fbo = boolean,] (needs GLEW_EXT_framebuffer_object!)
[fboDepth = boolean] (needs GLEW_EXT_framebuffer_object!)
} ]
) -> string

'''gl.DeleteTexture'''
( string texture ) -> boolean

'''gl.DeleteTextureFBO''' (needs GLEW_EXT_framebuffer_object!)
( string texture ) -> boolean

'''gl.TextureInfo'''
( string texture ) -> nil | {
xsize = number,
ysize = number,
alpha = boolean, //not used yet
type = number, //not used yet
}

the format of the texture string is the same as in gl.Texture()


'''gl.TexCoord'''
( number x |
number x, number y |
number x, number y, number z |
number x, number y, number z, number w |
{ number x [, number y [, number z [, number w ]]] } ) -> nil

'''gl.MultiTexCoord'''
( int texNum,
number x |
number x, number y |
number x, number y, number z |
number x, number y, number z, number w |
{ number x [, number y [, number z [, number w ]]] } ) -> nil

'''gl.TexEnv'''
( number [[Lua_ConstGL#Texture_Environment|target]], number [[Lua_ConstGL#Texture_Environment|pname]],
number [[Lua_ConstGL#Texture_Environment|value]] |
number var1, number var2, number var3 ) -> nil

'''gl.MultiTexEnv'''
( int texNum, number [[Lua_ConstGL#Texture_Environment|target]], number [[Lua_ConstGL#Texture_Environment|pname]],
number [[Lua_ConstGL#Texture_Environment|value]] |
number var1, number var2, number var3 ) -> nil

'''gl.TexGen'''
( number [[Lua_ConstGL#Texture_Generation|target]],
boolean state |
number [[Lua_ConstGL#Texture_Generation|pname]], number value |
number [[Lua_ConstGL#Texture_Generation|pname]], number var1, number var2, number var3 ) -> nil

'''gl.MultiTexGen'''
( int texNum, number [[Lua_ConstGL#Texture_Generation|target]],
boolean state |
number [[Lua_ConstGL#Texture_Generation|pname]], number value |
number [[Lua_ConstGL#Texture_Generation|pname]], number var1, number var2, number var3 ) -> nil

'''gl.CopyToTexture'''
(string texture, int xoff, int yoff, int x, int y, int w, int h
[,number target,number level])->nil

'''gl.RenderToTexture''' (needs GLEW_EXT_framebuffer_object!)
( string fbotexture, lua_func ) -> nil

'''gl.GenerateMipmap''' (needs glGenerateMipmapEXT!)
( string texture ) -> boolean

== Lights ==

'''gl.Lighting'''
( boolean enable ) -> nil

'''gl.ShadeModel'''
( number [[Lua_ConstGL#ShadeModel|mode]] ) -> nil

'''gl.Light'''
( int light,
boolean enable |
number [[Lua_ConstGL#Light_Specification|pname]], number param |
number [[Lua_ConstGL#Light_Specification|pname]], number param1, number param2, number param3 ) -> nil

'''gl.Material'''
({
ambient = {number r, number g, number b[, number a]},
diffuse = {number r, number g, number b[, number a]},
ambidiff = {number r, number g, number b[, number a]},
emission = {number r, number g, number b[, number a]},
specular = {number r, number g, number b[, number a]},
shininess = number specularExponent
}) -> nil

== Display Lists ==
Display Lists save given vertex attributes in a static buffer, so the GPU can directly read them (without the CPU). Display Lists are a lot faster (10-60x) than standard drawing with glShape/glBeginEnd, so try to use them when ever you can. If you want to learn more about them, g00gle is your friend ;)

'''gl.CreateList'''
( function [,arg1 [,arg2...]] ) -> nil

'''gl.CallList'''
( number listID ) -> nil

'''gl.DeleteList'''
( number listID ) -> nil

== Hardware relevant ==

'''gl.HasExtension'''
( string extname ) -> boolean

'''gl.GetNumber'''
( number ext, int count ) -> number [, number, number, ... #count ]

'''gl.GetString'''
( number ext ) -> string

== DrawGroundPrimitives ==

'''gl.DrawGroundCircle'''
( number x, number y, number z, number radius, number divs [, number slope ] ) -> nil

'''gl.DrawGroundQuad''' Note: x1,z1,x2 & z2 are rounded, so don't use it for very small or moving objects
( number x1, number z1, number x2, number z2,
[ boolean useNorm,
[ number tu1, number tv1, number tu2, number tv2 |
boolean useTextureCoord ] ] ) -> nil

== Extended ==

'''gl.ActiveTexture'''
( int texNum, function [, arg1,... ] ) -> nil

'''gl.GetGlobalTexNames'''
() -> { [1] = string texture, etc ... }

'''gl.GetGlobalTexCoords'''
( string tatexture ) -> number xstart, number ystart, number xend, number yend

'''gl.GetShadowMapParams'''
() -> number xmid, number ymid, number p17, number p18

'''gl.GetMatrixData'''
( GL.PROJECTION [, int i] ) -> nil | number, etc.. | number Matrix[i]
( GL.MODELVIEW [, int i] ) -> nil | number, etc.. | number Matrix[i]
( GL.TEXTURE [, int i] ) -> nil | number, etc.. | number Matrix[i]
( "shadow" ) -> nil | number, etc..
( "camera" ) -> nil | number, etc..
( "caminv" ) -> nil | number, etc..
( "camprj" ) -> nil | number, etc..
( "billboard" ) -> nil | number, etc..

'''gl.PointSprite''' (needs openGL2.0!)
( boolean enable, [boolean coord_replace, boolean coord_origin_upper] ) -> nil

'''gl.PointParameter''' (needs openGL2.0!)
( number v1, number v2, number v3,
[ number sizeMin, number sizeMax, number sizeFade ] ) -> nil

'''gl.SecondaryColor'''
( { number r, number g, number b } |
number r, number g, number b ) -> nil

'''gl.FogCoord'''
( number value ) -> nil

'''gl.ClipPlane'''
( int plane, note: $plane can only be 1 or 2
boolean enable |
number A, number B, number C, number D ) -> nil

'''gl.MatrixMode'''
( number [[Lua_ConstGL#MatrixMode|mode]] ) -> nil

'''gl.LoadIdentity'''
() -> nil

'''gl.LoadMatrix'''
() -> nil

'''gl.MultMatrix'''

'''gl.Ortho'''
( number left, number right, number bottom, number top, number near, number far ) -> nil

'''gl.Frustum'''
( number left, number right, number bottom, number top, number near, number far ) -> nil

'''gl.PushPopMatrix'''

'''gl.PushAttrib'''
( [ number [[Lua_ConstGL#glPushAttrib.28.29_bits|attrib]] ] ) -> nil

'''gl.PopAttrib'''
() -> nil

'''gl.Flush'''
() -> nil

'''gl.Finish'''
() -> nil

== Shaders (GLSL) ==
[[Lua_GLSL_Api]]

Lua UnitRendering

2008-06-28T18:23:02Z

JK: /* Unit Rendering */

==Unit Rendering==
'''Spring.UnitRendering.SetLODCount'''
( number unitID, int lodCount ) -> nil

'''Spring.UnitRendering.SetLODLength''' (`lod` is 1-indexed)
( number unitID, int lod, number lodLength ) -> nil

'''Spring.UnitRendering.SetLODDistance''' (same as SetLODLength(), but adjusted for 45deg FOV + 1024x768)
(number unitID, int lod, number lodDistance ) -> nil

'''Spring.UnitRendering.SetPieceList''' (displayList=nil reset to default)
( number unitID, int lod, int piece [, number displayList = nil ] ) -> nil

'''Spring.UnitRendering.GetMaterial''' (creates a material userdata)
( string MaterialName, [[Lua_UnitRendering#Material_Table|table Material]] ) -> [[Lua_UnitRendering#Material_UserData|userdata Material]]

'''Spring.UnitRendering.SetMaterial'''
( number unitID, int lod, string MaterialName, [[Lua_UnitRendering#Material_UserData|userdata Material]] | [[Lua_UnitRendering#Material_Table|table Material]] ) -> nil

'''Spring.UnitRendering.SetMaterialLastLOD'''
( number unitID, string MaterialName, int lastLOD ) -> nil

'''Spring.UnitRendering.SetMaterialDisplayLists'''
( number unitID, string MaterialName, [[Lua_OpenGL_Api#Display_Lists|preDisplayList]], [[Lua_OpenGL_Api#Display_Lists|postDisplayList]] ) -> nil

'''Spring.UnitRendering.SetUnitUniform''' (unfinished)
( number unitID, string MaterialName, int lod, arg1, arg2, ... ) -> nil

'''Spring.UnitRendering.SetUnitLuaDraw''' (enables the DrawUnit callin)
( number unitID, boolean enabled ) -> nil

'''Spring.UnitRendering.Debug''' (prints some usefull debug informations)
( [ number unitID ] ) -> nil

==Material UserData==
none user accessible methods (yet)

==Material Table==
material = {
["order" = number ,]
["shader" = [[Lua_GLSL_Api|lua_shader]] | string "3do" | string "s3o" ,]

["texunits" = {
[ [0] = { ["tex" = [[Lua_OpenGL_Api#Textures|see gl.Texture]] ,]
["enable" = boolean true ] }, ]
[ [3] = [[Lua_OpenGL_Api#Textures|see gl.Texture]], ]
(upto [15] and supports holes in it)
} ,]

["texunit0" = [[Lua_OpenGL_Api#Textures|see gl.Texture]] ,]
...
["texunit7" = [[Lua_OpenGL_Api#Textures|see gl.Texture]] ,]

["prelist" = [[Lua_OpenGL_Api#Display_Lists|lua_displaylist]] ,]
["postlist" = [[Lua_OpenGL_Api#Display_Lists|lua_displaylist]] ,]
["usecamera" = boolean ,]
["cameraloc" = number ,]
}

Lua UnitRendering

2008-06-20T03:39:15Z

JK: /* Material UserData */

==Unit Rendering==
'''Spring.UnitRendering.SetLODCount'''
( int lodCount ) -> nil

'''Spring.UnitRendering.SetLODLength''' (`lod` is 1-indexed)
( int lod, number lodLength ) -> nil

'''Spring.UnitRendering.SetLODDistance''' (same as SetLODLength(), but adjusted for 45deg FOV + 1024x768)
( int lod, number lodDistance ) -> nil

'''Spring.UnitRendering.SetPieceList''' (displayList=nil reset to default)
( number unitID, int lod, int piece [, number displayList = nil ] ) -> nil

'''Spring.UnitRendering.GetMaterial''' (creates a material userdata)
( string MaterialName, [[Lua_UnitRendering#Material_Table|table Material]] ) -> [[Lua_UnitRendering#Material_UserData|userdata Material]]

'''Spring.UnitRendering.SetMaterial'''
( number unitID, int lod, string MaterialName, [[Lua_UnitRendering#Material_UserData|userdata Material]] | [[Lua_UnitRendering#Material_Table|table Material]] ) -> nil

'''Spring.UnitRendering.SetMaterialLastLOD'''
( number unitID, string MaterialName, int lastLOD ) -> nil

'''Spring.UnitRendering.SetMaterialDisplayLists'''
( number unitID, string MaterialName, [[Lua_OpenGL_Api#Display_Lists|preDisplayList]], [[Lua_OpenGL_Api#Display_Lists|postDisplayList]] ) -> nil

'''Spring.UnitRendering.SetUnitUniform''' (unfinished)
( number unitID, string MaterialName, int lod, arg1, arg2, ... ) -> nil

'''Spring.UnitRendering.SetUnitLuaDraw''' (enables the DrawUnit callin)
( number unitID, boolean enabled ) -> nil

'''Spring.UnitRendering.Debug''' (prints some usefull debug informations)
( [ number unitID ] ) -> nil

==Material UserData==
none user accessible methods (yet)

==Material Table==
material = {
["order" = number ,]
["shader" = [[Lua_GLSL_Api|lua_shader]] | string "3do" | string "s3o" ,]

["texunits" = {
[ [0] = { ["tex" = [[Lua_OpenGL_Api#Textures|see gl.Texture]] ,]
["enable" = boolean true ] }, ]
[ [3] = [[Lua_OpenGL_Api#Textures|see gl.Texture]], ]
(upto [15] and supports holes in it)
} ,]

["texunit0" = [[Lua_OpenGL_Api#Textures|see gl.Texture]] ,]
...
["texunit7" = [[Lua_OpenGL_Api#Textures|see gl.Texture]] ,]

["prelist" = [[Lua_OpenGL_Api#Display_Lists|lua_displaylist]] ,]
["postlist" = [[Lua_OpenGL_Api#Display_Lists|lua_displaylist]] ,]
["usecamera" = boolean ,]
["cameraloc" = number ,]
}

Lua OpenGL Api

2008-06-19T02:31:55Z

JK: /* Text */

== Spring ==
'''gl.GetSun'''
() -> number sunPosX, number sunPosY, number sunPosZ
( "pos" ) -> number sunPosX, number sunPosY, number sunPosZ
( "shadowDensity" [, "unit"] ) -> number shadowDensity
( "diffuse" [, "unit"] ) -> nil | number r, number g, number b
( "ambient" [, "unit"] ) -> nil | number r, number g, number b
( "specular" ) -> nil | number r, number g, number b

'''gl.ConfigScreen'''
( number screenWidth, number screenDistance ) -> nil

'''gl.DrawMiniMap'''
() -> nil

'''gl.SlaveMiniMap'''
( boolean mode ) -> nil

'''gl.ConfigMiniMap'''
( int px, int py, int sx, int sy ) -> nil

'''gl.GetViewSizes'''
( ) -> number x, number y

== Basics ==

'''gl.PushMatrix'''
() -> nil

'''gl.PopMatrix'''
() -> nil

'''gl.Translate'''
(number x, number y, number z) -> nil

'''gl.Scale'''
(number x, number y, number z) -> nil

'''gl.Rotate'''
(number angle, number x, number y, number z) -> nil

'''gl.Color'''
( { number r, number g, number b[, number a] } |
number r, number g, number b[, number a] ) -> nil

'''gl.LineWidth'''
( number width ) -> nil

'''gl.PointSize'''
( number size ) -> nil

'''gl.Billboard''' use this to draw 2d primitives in DrawWorld
() -> nil

'''gl.ResetState'''
() -> nil

ShadeModel = GL_SMOOTH
Scissor = false
Texture = false
ColorMask = true, true, true, true
DepthMask = false
DepthTest = false (GL_LEQUAL)
Culling = false (GL_BACK)
LogicOp = false (GL_INVERT)
AlphaTest = false (GL_GREATER, 0.5f)
Blending = GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA


'''gl.ResetMatrices'''
() -> nil

Resets GL_TEXTURE matrix stack
Resets GL_MODELVIEW matrix stack
Resets GL_PROJECTION matrix stack


'''gl.Clear'''
( GL.DEPTH_BUFFER_BIT, number cleardepth ) -> nil
( GL.STENCIL_BUFFER_BIT, int clearstencil ) -> nil
( GL.COLOR_BUFFER_BIT | GL.ACCUM_BUFFER_BIT, number r, number g, number b, number a ) -> nil

== Draw Basics ==

'''gl.BeginEnd'''
( number [[Lua_ConstGL#Drawing_Primitives|GLType]], function [, arg1,... ] ) -> nil

'''gl.Vertex'''
( { number x, number y [, number z [, number w ]] } |
number x, number y |
number x, number y, number z |
number x, number y, number z, number w ) -> nil

'''gl.Normal'''
( number x, number y, number z |
{ number x, number y, number z } ) -> nil

'''gl.Rect'''
( number x1, number y1, number x2, number y2 ) -> nil

'''gl.TexRect''' texture rect
( number x1, number y1, number x2, number y2,
[ boolean flip_s, boolean flip_t | number s1, number t1, number s2, number t2 ] ) -> nil

'''gl.Shape'''
( number [[Lua_ConstGL#Drawing_Primitives|GLtype]],
elements = {
[1] = { v | vertex = { number x, number y, number z }, required
n | normal = { number x, number y, number z }, optional
t | texcoord = { number x, number y }, optional
c | color = { number r, number g, number b, number a } optional
},
etc ...
}
) -> nil

== Text ==

'''gl.Text'''
(string "text", number x, number y, number size [, string "options"] )

options:
'c' = center
'r' = right
'n' = deactives colorCodes (so you can use gl.Color() to write transparent text etc.)
'o' = black outline
'O' = white outline


'''gl.GetTextWidth'''
(string "text") -> number width -- in pixels, with a font size of 1.0

== Unit/Feature Draw Functions ==

'''gl.Unit''' (draws the unit)
( number unitID, [ boolean rawdraw, int lod ] ) -> nil

'''gl.UnitRaw''' (redundant -> use gl.Unit instead!)
( number unitID, [ boolean rawdraw, int lod ] ) -> nil

'''gl.UnitShape'''
( number unitDefID, number teamID ) -> nil

'''gl.Feature'''
( number featureID ) -> nil

'''gl.FeatureShape'''
( number featureDefID, number teamID ) -> nil

'''gl.UnitMultMatrix''' (world space -> unit space)
( number unitID ) -> nil

'''gl.UnitPieceMultMatrix''' (unit space -> piece space)
( number unitID, int piece ) -> nil

'''gl.UnitPiece''' (draws the unit piece)
( number unitID, int piece ) -> nil

'''gl.UnitPieceMatrix''' (use gl.UnitPieceMultMatrix instead!)
( number unitID, int piece ) -> nil

'''gl.DrawListAtUnit'''
( number unitID, number listID, [ boolean midPos,
number scaleX, number scaleY, number scaleZ,
number degrees, number rotX, number rotX, number rotZ ] ) -> nil

'''gl.DrawFuncAtUnit'''
( number unitID, boolean midPos, function [, arg1,... ]) -> nil

== Switches ==

'''gl.Blending'''
( boolean enable | number [[Lua_ConstGL#BlendingFactorSrc|srcmode]], number [[Lua_ConstGL#BlendingFactorDest|dstmode]] ) -> nil

'''gl.AlphaTest'''
( boolean enable | number [[Lua_ConstGL#AlphaFunction and DepthFunction|func]], number threshold ) -> nil

'''gl.DepthTest'''
( boolean enable | number [[Lua_ConstGL#AlphaFunction and DepthFunction|func]] ) -> nil

'''gl.Culling'''
( boolean enable | number [[Lua_ConstGL#Culling|face]] ) -> nil

'''gl.DepthMask'''
( boolean enable ) -> nil

'''gl.ColorMask'''
( boolean ) -> nil
( boolean r, boolean g, boolean b, boolean a ) -> nil

'''gl.LogicOp'''
( boolean enable | number [[Lua_ConstGL#LogicOp|func]] ) -> nil

'''gl.Fog'''
( boolean enable ) -> nil

'''gl.Smoothing'''
( (boolean enable | number POINT),
(boolean enable | number LINE),
(boolean enable | number POLYGON) ) -> nil

'''gl.EdgeFlag'''
( boolean enable ) -> nil

'''gl.Scissor'''
( boolean ) -> nil
( int x, int y, int w, int h ) -> nil

'''gl.LineStipple'''
( string any ) -> nil (use springs default line stipple)
( boolean enable ) -> nil
( int factor, number pattern ) -> nil

'''gl.PolygonMode'''
( number [[Lua_ConstGL#Culling|face]], number [[Lua_ConstGL#PolygonMode|mode]] ) -> nil

'''gl.PolygonOffset'''
( boolean enable | number factor, number units ) -> nil

== Textures ==

'''gl.Texture'''
( [ number texNum, ] boolean enable | string name ) -> nil | boolean loaded

current formats:
:${opt}:/LuaUI/images/image.png = filename
#12 = unitDef 12 buildpic
%34:1 = unitDef 34 s3o tex2 (:0->tex1,:1->tex2)
!56 = lua generated texture 56
$units = 3do textureatlas
$shadow = shadowmap
$specular = specular cube map
$reflection = reflection cube map

possible ${opt}'s are:
'n' = nearest
'l' = linear
'a' = aniso
'i' = invert
'g' = greyed
'c' = clamped
'b' = border
't' = tint (don't know how to use it, sorry)

example: ":iac:/LuaUI/images/image.png"


'''gl.CreateTexture'''
( int xsize, int ysize,
[ {
[target = number,] (like GL_TEXTURE_1D,GL_TEXTURE_2D,...)
[format = number,]
[min_filter = [[Lua_ConstGL#Texture_Filtering|number]],]
[mag_filter = [[Lua_ConstGL#Texture_Filtering|number]],]
[wrap_s = [[Lua_ConstGL#Texture_Clamping|number]],]
[wrap_t = [[Lua_ConstGL#Texture_Clamping|number]],]
[wrap_r = [[Lua_ConstGL#Texture_Clamping|number]],]
[aniso = number,]
[border = boolean,]
[fbo = boolean,] (needs GLEW_EXT_framebuffer_object!)
[fboDepth = boolean] (needs GLEW_EXT_framebuffer_object!)
} ]
) -> string

'''gl.DeleteTexture'''
( string texture ) -> boolean

'''gl.DeleteTextureFBO''' (needs GLEW_EXT_framebuffer_object!)
( string texture ) -> boolean

'''gl.TextureInfo'''
( string texture ) -> nil | {
xsize = number,
ysize = number,
alpha = boolean, //not used yet
type = number, //not used yet
}

the format of the texture string is the same as in gl.Texture()


'''gl.TexCoord'''
( number x |
number x, number y |
number x, number y, number z |
number x, number y, number z, number w |
{ number x [, number y [, number z [, number w ]]] } ) -> nil

'''gl.MultiTexCoord'''
( int texNum,
number x |
number x, number y |
number x, number y, number z |
number x, number y, number z, number w |
{ number x [, number y [, number z [, number w ]]] } ) -> nil

'''gl.TexEnv'''
( number [[Lua_ConstGL#Texture_Environment|target]], number [[Lua_ConstGL#Texture_Environment|pname]],
number [[Lua_ConstGL#Texture_Environment|value]] |
number var1, number var2, number var3 ) -> nil

'''gl.MultiTexEnv'''
( int texNum, number [[Lua_ConstGL#Texture_Environment|target]], number [[Lua_ConstGL#Texture_Environment|pname]],
number [[Lua_ConstGL#Texture_Environment|value]] |
number var1, number var2, number var3 ) -> nil

'''gl.TexGen'''
( number [[Lua_ConstGL#Texture_Generation|target]],
boolean state |
number [[Lua_ConstGL#Texture_Generation|pname]], number value |
number [[Lua_ConstGL#Texture_Generation|pname]], number var1, number var2, number var3 ) -> nil

'''gl.MultiTexGen'''
( int texNum, number [[Lua_ConstGL#Texture_Generation|target]],
boolean state |
number [[Lua_ConstGL#Texture_Generation|pname]], number value |
number [[Lua_ConstGL#Texture_Generation|pname]], number var1, number var2, number var3 ) -> nil

'''gl.CopyToTexture'''
(string texture, int xoff, int yoff, int x, int y, int w, int h
[,number target,number level])->nil

'''gl.RenderToTexture''' (needs GLEW_EXT_framebuffer_object!)
( string fbotexture, lua_func ) -> nil

'''gl.GenerateMipmap''' (needs glGenerateMipmapEXT!)
( string texture ) -> boolean

== Lights ==

'''gl.Lighting'''
( boolean enable ) -> nil

'''gl.ShadeModel'''
( number [[Lua_ConstGL#ShadeModel|mode]] ) -> nil

'''gl.Light'''
( int light,
boolean enable |
number [[Lua_ConstGL#Light_Specification|pname]], number param |
number [[Lua_ConstGL#Light_Specification|pname]], number param1, number param2, number param3 ) -> nil

'''gl.Material'''
({
ambient = {number r, number g, number b[, number a]},
diffuse = {number r, number g, number b[, number a]},
ambidiff = {number r, number g, number b[, number a]},
emission = {number r, number g, number b[, number a]},
specular = {number r, number g, number b[, number a]},
shininess = number specularExponent
}) -> nil

== Display Lists ==
Display Lists save given vertex attributes in a static buffer, so the GPU can directly read them (without the CPU). Display Lists are a lot faster (10-60x) than standard drawing with glShape/glBeginEnd, so try to use them when ever you can. If you want to learn more about them, g00gle is your friend ;)

'''gl.CreateList'''
( function [,arg1 [,arg2...]] ) -> nil

'''gl.CallList'''
( number listID ) -> nil

'''gl.DeleteList'''
( number listID ) -> nil

== Hardware relevant ==

'''gl.HasExtension'''
( string extname ) -> boolean

'''gl.GetNumber'''
( number ext, int count ) -> number [, number, number, ... #count ]

'''gl.GetString'''
( number ext ) -> string

== DrawGroundPrimitives ==

'''gl.DrawGroundCircle'''
( number x, number y, number z, number radius, number divs [, number slope ] ) -> nil

'''gl.DrawGroundQuad''' Note: x1,z1,x2 & z2 are rounded, so don't use it for very small or moving objects
( number x1, number z1, number x2, number z2,
[ boolean useNorm,
[ number tu1, number tv1, number tu2, number tv2 |
boolean useTextureCoord ] ] ) -> nil

== Extended ==

'''gl.ActiveTexture'''
( int texNum, function [, arg1,... ] ) -> nil

'''gl.GetGlobalTexNames'''
() -> { [1] = string texture, etc ... }

'''gl.GetGlobalTexCoords'''
( string tatexture ) -> number xstart, number ystart, number xend, number yend

'''gl.GetShadowMapParams'''
() -> number xmid, number ymid, number p17, number p18

'''gl.GetMatrixData'''
( GL.PROJECTION [, int i] ) -> nil | number, etc.. | number Matrix[i]
( GL.MODELVIEW [, int i] ) -> nil | number, etc.. | number Matrix[i]
( GL.TEXTURE [, int i] ) -> nil | number, etc.. | number Matrix[i]
( "shadow" ) -> nil | number, etc..
( "camera" ) -> nil | number, etc..
( "caminv" ) -> nil | number, etc..
( "camprj" ) -> nil | number, etc..
( "billboard" ) -> nil | number, etc..

'''gl.PointSprite''' (needs openGL2.0!)
( boolean enable, [boolean coord_replace, boolean coord_origin_upper] ) -> nil

'''gl.PointParameter''' (needs openGL2.0!)
( number v1, number v2, number v3,
[ number sizeMin, number sizeMax, number sizeFade ] ) -> nil

'''gl.SecondaryColor'''
( { number r, number g, number b } |
number r, number g, number b ) -> nil

'''gl.FogCoord'''
( number value ) -> nil

'''gl.ClipPlane'''
( int plane, note: $plane can only be 1 or 2
boolean enable |
number A, number B, number C, number D ) -> nil

'''gl.MatrixMode'''
( number [[Lua_ConstGL#MatrixMode|mode]] ) -> nil

'''gl.LoadIdentity'''
() -> nil

'''gl.LoadMatrix'''
() -> nil

'''gl.MultMatrix'''

'''gl.Ortho'''
( number left, number right, number bottom, number top, number near, number far ) -> nil

'''gl.Frustum'''
( number left, number right, number bottom, number top, number near, number far ) -> nil

'''gl.PushPopMatrix'''

'''gl.PushAttrib'''
( [ number [[Lua_ConstGL#glPushAttrib.28.29_bits|attrib]] ] ) -> nil

'''gl.PopAttrib'''
() -> nil

'''gl.Flush'''
() -> nil

'''gl.Finish'''
() -> nil

== Shaders (GLSL) ==
[[Lua_GLSL_Api]]

Lua OpenGL Api

2008-06-17T12:08:41Z

JK: /* Spring */

== Spring ==
'''gl.GetSun'''
() -> number sunPosX, number sunPosY, number sunPosZ
( "pos" ) -> number sunPosX, number sunPosY, number sunPosZ
( "shadowDensity" [, "unit"] ) -> number shadowDensity
( "diffuse" [, "unit"] ) -> nil | number r, number g, number b
( "ambient" [, "unit"] ) -> nil | number r, number g, number b
( "specular" ) -> nil | number r, number g, number b

'''gl.ConfigScreen'''
( number screenWidth, number screenDistance ) -> nil

'''gl.DrawMiniMap'''
() -> nil

'''gl.SlaveMiniMap'''
( boolean mode ) -> nil

'''gl.ConfigMiniMap'''
( int px, int py, int sx, int sy ) -> nil

'''gl.GetViewSizes'''
( ) -> number x, number y

== Basics ==

'''gl.PushMatrix'''
() -> nil

'''gl.PopMatrix'''
() -> nil

'''gl.Translate'''
(number x, number y, number z) -> nil

'''gl.Scale'''
(number x, number y, number z) -> nil

'''gl.Rotate'''
(number angle, number x, number y, number z) -> nil

'''gl.Color'''
( { number r, number g, number b[, number a] } |
number r, number g, number b[, number a] ) -> nil

'''gl.LineWidth'''
( number width ) -> nil

'''gl.PointSize'''
( number size ) -> nil

'''gl.Billboard''' use this to draw 2d primitives in DrawWorld
() -> nil

'''gl.ResetState'''
() -> nil

ShadeModel = GL_SMOOTH
Scissor = false
Texture = false
ColorMask = true, true, true, true
DepthMask = false
DepthTest = false (GL_LEQUAL)
Culling = false (GL_BACK)
LogicOp = false (GL_INVERT)
AlphaTest = false (GL_GREATER, 0.5f)
Blending = GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA


'''gl.ResetMatrices'''
() -> nil

Resets GL_TEXTURE matrix stack
Resets GL_MODELVIEW matrix stack
Resets GL_PROJECTION matrix stack


'''gl.Clear'''
( GL.DEPTH_BUFFER_BIT, number cleardepth ) -> nil
( GL.STENCIL_BUFFER_BIT, int clearstencil ) -> nil
( GL.COLOR_BUFFER_BIT | GL.ACCUM_BUFFER_BIT, number r, number g, number b, number a ) -> nil

== Draw Basics ==

'''gl.BeginEnd'''
( number [[Lua_ConstGL#Drawing_Primitives|GLType]], function [, arg1,... ] ) -> nil

'''gl.Vertex'''
( { number x, number y [, number z [, number w ]] } |
number x, number y |
number x, number y, number z |
number x, number y, number z, number w ) -> nil

'''gl.Normal'''
( number x, number y, number z |
{ number x, number y, number z } ) -> nil

'''gl.Rect'''
( number x1, number y1, number x2, number y2 ) -> nil

'''gl.TexRect''' texture rect
( number x1, number y1, number x2, number y2,
[ boolean flip_s, boolean flip_t | number s1, number t1, number s2, number t2 ] ) -> nil

'''gl.Shape'''
( number [[Lua_ConstGL#Drawing_Primitives|GLtype]],
elements = {
[1] = { v | vertex = { number x, number y, number z }, required
n | normal = { number x, number y, number z }, optional
t | texcoord = { number x, number y }, optional
c | color = { number r, number g, number b, number a } optional
},
etc ...
}
) -> nil

== Text ==

'''gl.Text'''
(string "text", number x, number y, number size, string "options")

options:
'c' = center
'r' = right
'n' = deactives colorCodes (so you can use gl.Color() to write transparent text etc.)
'o' = black outline
'O' = white outline


'''gl.GetTextWidth'''
(string "text") -> number width -- in pixels, with a font size of 1.0

== Unit/Feature Draw Functions ==

'''gl.Unit''' (draws the unit)
( number unitID, [ boolean rawdraw, int lod ] ) -> nil

'''gl.UnitRaw''' (redundant -> use gl.Unit instead!)
( number unitID, [ boolean rawdraw, int lod ] ) -> nil

'''gl.UnitShape'''
( number unitDefID, number teamID ) -> nil

'''gl.Feature'''
( number featureID ) -> nil

'''gl.FeatureShape'''
( number featureDefID, number teamID ) -> nil

'''gl.UnitMultMatrix''' (world space -> unit space)
( number unitID ) -> nil

'''gl.UnitPieceMultMatrix''' (unit space -> piece space)
( number unitID, int piece ) -> nil

'''gl.UnitPiece''' (draws the unit piece)
( number unitID, int piece ) -> nil

'''gl.UnitPieceMatrix''' (use gl.UnitPieceMultMatrix instead!)
( number unitID, int piece ) -> nil

'''gl.DrawListAtUnit'''
( number unitID, number listID, [ boolean midPos,
number scaleX, number scaleY, number scaleZ,
number degrees, number rotX, number rotX, number rotZ ] ) -> nil

'''gl.DrawFuncAtUnit'''
( number unitID, boolean midPos, function [, arg1,... ]) -> nil

== Switches ==

'''gl.Blending'''
( boolean enable | number [[Lua_ConstGL#BlendingFactorSrc|srcmode]], number [[Lua_ConstGL#BlendingFactorDest|dstmode]] ) -> nil

'''gl.AlphaTest'''
( boolean enable | number [[Lua_ConstGL#AlphaFunction and DepthFunction|func]], number threshold ) -> nil

'''gl.DepthTest'''
( boolean enable | number [[Lua_ConstGL#AlphaFunction and DepthFunction|func]] ) -> nil

'''gl.Culling'''
( boolean enable | number [[Lua_ConstGL#Culling|face]] ) -> nil

'''gl.DepthMask'''
( boolean enable ) -> nil

'''gl.ColorMask'''
( boolean ) -> nil
( boolean r, boolean g, boolean b, boolean a ) -> nil

'''gl.LogicOp'''
( boolean enable | number [[Lua_ConstGL#LogicOp|func]] ) -> nil

'''gl.Fog'''
( boolean enable ) -> nil

'''gl.Smoothing'''
( (boolean enable | number POINT),
(boolean enable | number LINE),
(boolean enable | number POLYGON) ) -> nil

'''gl.EdgeFlag'''
( boolean enable ) -> nil

'''gl.Scissor'''
( boolean ) -> nil
( int x, int y, int w, int h ) -> nil

'''gl.LineStipple'''
( string any ) -> nil (use springs default line stipple)
( boolean enable ) -> nil
( int factor, number pattern ) -> nil

'''gl.PolygonMode'''
( number [[Lua_ConstGL#Culling|face]], number [[Lua_ConstGL#PolygonMode|mode]] ) -> nil

'''gl.PolygonOffset'''
( boolean enable | number factor, number units ) -> nil

== Textures ==

'''gl.Texture'''
( [ number texNum, ] boolean enable | string name ) -> nil | boolean loaded

current formats:
:${opt}:/LuaUI/images/image.png = filename
#12 = unitDef 12 buildpic
%34:1 = unitDef 34 s3o tex2 (:0->tex1,:1->tex2)
!56 = lua generated texture 56
$units = 3do textureatlas
$shadow = shadowmap
$specular = specular cube map
$reflection = reflection cube map

possible ${opt}'s are:
'n' = nearest
'l' = linear
'a' = aniso
'i' = invert
'g' = greyed
'c' = clamped
'b' = border
't' = tint (don't know how to use it, sorry)

example: ":iac:/LuaUI/images/image.png"


'''gl.CreateTexture'''
( int xsize, int ysize,
[ {
[target = number,] (like GL_TEXTURE_1D,GL_TEXTURE_2D,...)
[format = number,]
[min_filter = [[Lua_ConstGL#Texture_Filtering|number]],]
[mag_filter = [[Lua_ConstGL#Texture_Filtering|number]],]
[wrap_s = [[Lua_ConstGL#Texture_Clamping|number]],]
[wrap_t = [[Lua_ConstGL#Texture_Clamping|number]],]
[wrap_r = [[Lua_ConstGL#Texture_Clamping|number]],]
[aniso = number,]
[border = boolean,]
[fbo = boolean,] (needs GLEW_EXT_framebuffer_object!)
[fboDepth = boolean] (needs GLEW_EXT_framebuffer_object!)
} ]
) -> string

'''gl.DeleteTexture'''
( string texture ) -> boolean

'''gl.DeleteTextureFBO''' (needs GLEW_EXT_framebuffer_object!)
( string texture ) -> boolean

'''gl.TextureInfo'''
( string texture ) -> nil | {
xsize = number,
ysize = number,
alpha = boolean, //not used yet
type = number, //not used yet
}

the format of the texture string is the same as in gl.Texture()


'''gl.TexCoord'''
( number x |
number x, number y |
number x, number y, number z |
number x, number y, number z, number w |
{ number x [, number y [, number z [, number w ]]] } ) -> nil

'''gl.MultiTexCoord'''
( int texNum,
number x |
number x, number y |
number x, number y, number z |
number x, number y, number z, number w |
{ number x [, number y [, number z [, number w ]]] } ) -> nil

'''gl.TexEnv'''
( number [[Lua_ConstGL#Texture_Environment|target]], number [[Lua_ConstGL#Texture_Environment|pname]],
number [[Lua_ConstGL#Texture_Environment|value]] |
number var1, number var2, number var3 ) -> nil

'''gl.MultiTexEnv'''
( int texNum, number [[Lua_ConstGL#Texture_Environment|target]], number [[Lua_ConstGL#Texture_Environment|pname]],
number [[Lua_ConstGL#Texture_Environment|value]] |
number var1, number var2, number var3 ) -> nil

'''gl.TexGen'''
( number [[Lua_ConstGL#Texture_Generation|target]],
boolean state |
number [[Lua_ConstGL#Texture_Generation|pname]], number value |
number [[Lua_ConstGL#Texture_Generation|pname]], number var1, number var2, number var3 ) -> nil

'''gl.MultiTexGen'''
( int texNum, number [[Lua_ConstGL#Texture_Generation|target]],
boolean state |
number [[Lua_ConstGL#Texture_Generation|pname]], number value |
number [[Lua_ConstGL#Texture_Generation|pname]], number var1, number var2, number var3 ) -> nil

'''gl.CopyToTexture'''
(string texture, int xoff, int yoff, int x, int y, int w, int h
[,number target,number level])->nil

'''gl.RenderToTexture''' (needs GLEW_EXT_framebuffer_object!)
( string fbotexture, lua_func ) -> nil

'''gl.GenerateMipmap''' (needs glGenerateMipmapEXT!)
( string texture ) -> boolean

== Lights ==

'''gl.Lighting'''
( boolean enable ) -> nil

'''gl.ShadeModel'''
( number [[Lua_ConstGL#ShadeModel|mode]] ) -> nil

'''gl.Light'''
( int light,
boolean enable |
number [[Lua_ConstGL#Light_Specification|pname]], number param |
number [[Lua_ConstGL#Light_Specification|pname]], number param1, number param2, number param3 ) -> nil

'''gl.Material'''
({
ambient = {number r, number g, number b[, number a]},
diffuse = {number r, number g, number b[, number a]},
ambidiff = {number r, number g, number b[, number a]},
emission = {number r, number g, number b[, number a]},
specular = {number r, number g, number b[, number a]},
shininess = number specularExponent
}) -> nil

== Display Lists ==
Display Lists save given vertex attributes in a static buffer, so the GPU can directly read them (without the CPU). Display Lists are a lot faster (10-60x) than standard drawing with glShape/glBeginEnd, so try to use them when ever you can. If you want to learn more about them, g00gle is your friend ;)

'''gl.CreateList'''
( function [,arg1 [,arg2...]] ) -> nil

'''gl.CallList'''
( number listID ) -> nil

'''gl.DeleteList'''
( number listID ) -> nil

== Hardware relevant ==

'''gl.HasExtension'''
( string extname ) -> boolean

'''gl.GetNumber'''
( number ext, int count ) -> number [, number, number, ... #count ]

'''gl.GetString'''
( number ext ) -> string

== DrawGroundPrimitives ==

'''gl.DrawGroundCircle'''
( number x, number y, number z, number radius, number divs [, number slope ] ) -> nil

'''gl.DrawGroundQuad''' Note: x1,z1,x2 & z2 are rounded, so don't use it for very small or moving objects
( number x1, number z1, number x2, number z2,
[ boolean useNorm,
[ number tu1, number tv1, number tu2, number tv2 |
boolean useTextureCoord ] ] ) -> nil

== Extended ==

'''gl.ActiveTexture'''
( int texNum, function [, arg1,... ] ) -> nil

'''gl.GetGlobalTexNames'''
() -> { [1] = string texture, etc ... }

'''gl.GetGlobalTexCoords'''
( string tatexture ) -> number xstart, number ystart, number xend, number yend

'''gl.GetShadowMapParams'''
() -> number xmid, number ymid, number p17, number p18

'''gl.GetMatrixData'''
( GL.PROJECTION [, int i] ) -> nil | number, etc.. | number Matrix[i]
( GL.MODELVIEW [, int i] ) -> nil | number, etc.. | number Matrix[i]
( GL.TEXTURE [, int i] ) -> nil | number, etc.. | number Matrix[i]
( "shadow" ) -> nil | number, etc..
( "camera" ) -> nil | number, etc..
( "caminv" ) -> nil | number, etc..
( "camprj" ) -> nil | number, etc..
( "billboard" ) -> nil | number, etc..

'''gl.PointSprite''' (needs openGL2.0!)
( boolean enable, [boolean coord_replace, boolean coord_origin_upper] ) -> nil

'''gl.PointParameter''' (needs openGL2.0!)
( number v1, number v2, number v3,
[ number sizeMin, number sizeMax, number sizeFade ] ) -> nil

'''gl.SecondaryColor'''
( { number r, number g, number b } |
number r, number g, number b ) -> nil

'''gl.FogCoord'''
( number value ) -> nil

'''gl.ClipPlane'''
( int plane, note: $plane can only be 1 or 2
boolean enable |
number A, number B, number C, number D ) -> nil

'''gl.MatrixMode'''
( number [[Lua_ConstGL#MatrixMode|mode]] ) -> nil

'''gl.LoadIdentity'''
() -> nil

'''gl.LoadMatrix'''
() -> nil

'''gl.MultMatrix'''

'''gl.Ortho'''
( number left, number right, number bottom, number top, number near, number far ) -> nil

'''gl.Frustum'''
( number left, number right, number bottom, number top, number near, number far ) -> nil

'''gl.PushPopMatrix'''

'''gl.PushAttrib'''
( [ number [[Lua_ConstGL#glPushAttrib.28.29_bits|attrib]] ] ) -> nil

'''gl.PopAttrib'''
() -> nil

'''gl.Flush'''
() -> nil

'''gl.Finish'''
() -> nil

== Shaders (GLSL) ==
[[Lua_GLSL_Api]]

Lua UnitRendering

2008-06-15T03:13:14Z

JK: /* Unit Rendering */

==Unit Rendering==
'''Spring.UnitRendering.SetLODCount'''
( int lodCount ) -> nil

'''Spring.UnitRendering.SetLODLength''' (`lod` is 1-indexed)
( int lod, number lodLength ) -> nil

'''Spring.UnitRendering.SetLODDistance''' (same as SetLODLength(), but adjusted for 45deg FOV + 1024x768)
( int lod, number lodDistance ) -> nil

'''Spring.UnitRendering.SetPieceList''' (displayList=nil reset to default)
( number unitID, int lod, int piece [, number displayList = nil ] ) -> nil

'''Spring.UnitRendering.GetMaterial''' (creates a material userdata)
( string MaterialName, [[Lua_UnitRendering#Material_Table|table Material]] ) -> [[Lua_UnitRendering#Material_UserData|userdata Material]]

'''Spring.UnitRendering.SetMaterial'''
( number unitID, int lod, string MaterialName, [[Lua_UnitRendering#Material_UserData|userdata Material]] | [[Lua_UnitRendering#Material_Table|table Material]] ) -> nil

'''Spring.UnitRendering.SetMaterialLastLOD'''
( number unitID, string MaterialName, int lastLOD ) -> nil

'''Spring.UnitRendering.SetMaterialDisplayLists'''
( number unitID, string MaterialName, [[Lua_OpenGL_Api#Display_Lists|preDisplayList]], [[Lua_OpenGL_Api#Display_Lists|postDisplayList]] ) -> nil

'''Spring.UnitRendering.SetUnitUniform''' (unfinished)
( number unitID, string MaterialName, int lod, arg1, arg2, ... ) -> nil

'''Spring.UnitRendering.SetUnitLuaDraw''' (enables the DrawUnit callin)
( number unitID, boolean enabled ) -> nil

'''Spring.UnitRendering.Debug''' (prints some usefull debug informations)
( [ number unitID ] ) -> nil

==Material UserData==
fill me

==Material Table==
material = {
["order" = number ,]
["shader" = [[Lua_GLSL_Api|lua_shader]] | string "3do" | string "s3o" ,]

["texunits" = {
[ [0] = { ["tex" = [[Lua_OpenGL_Api#Textures|see gl.Texture]] ,]
["enable" = boolean true ] }, ]
[ [3] = [[Lua_OpenGL_Api#Textures|see gl.Texture]], ]
(upto [15] and supports holes in it)
} ,]

["texunit0" = [[Lua_OpenGL_Api#Textures|see gl.Texture]] ,]
...
["texunit7" = [[Lua_OpenGL_Api#Textures|see gl.Texture]] ,]

["prelist" = [[Lua_OpenGL_Api#Display_Lists|lua_displaylist]] ,]
["postlist" = [[Lua_OpenGL_Api#Display_Lists|lua_displaylist]] ,]
["usecamera" = boolean ,]
["cameraloc" = number ,]
}

Lua UnitRendering

2008-06-15T03:08:36Z

JK: /* Unit Rendering */

==Unit Rendering==
'''Spring.UnitRendering.SetLODCount'''
( int lodCount ) -> nil

'''Spring.UnitRendering.SetLODLength''' (`lod` is 1-indexed)
( int lod, number lodLength ) -> nil

'''Spring.UnitRendering.SetLODDistance''' (same as SetLODLength(), but adjusted for 45deg FOV + 1024x768)
( int lod, number lodDistance ) -> nil

'''Spring.UnitRendering.SetPieceList''' (displayList=nil reset to default)
( number unitID, int lod, int piece [, number displayList = nil ] ) -> nil

'''Spring.UnitRendering.GetMaterial''' (creates a material userdata)
( string MaterialName, [[Lua_UnitRendering#Material_Table|table Material]] ) -> userdata Material

'''Spring.UnitRendering.SetMaterial'''
( number unitID, int lod, string MaterialName, [[Lua_UnitRendering#Material_UserData|userdata Material]] | [[Lua_UnitRendering#Material_Table|table Material]] ) -> nil

'''Spring.UnitRendering.SetMaterialLastLOD'''
( number unitID, string MaterialName, int lastLOD ) -> nil

'''Spring.UnitRendering.SetMaterialDisplayLists'''
( number unitID, string MaterialName, preDisplayList, postDisplayList ) -> nil

'''Spring.UnitRendering.SetUnitUniform''' (unfinished)
( number unitID, string MaterialName, int lod, arg1, arg2, ... ) -> nil

'''Spring.UnitRendering.SetUnitLuaDraw''' (enables the DrawUnit callin)
( number unitID, boolean enabled ) -> nil

'''Spring.UnitRendering.Debug''' (prints some usefull debug informations)
( [ number unitID ] ) -> nil

==Material UserData==
fill me

==Material Table==
material = {
["order" = number ,]
["shader" = [[Lua_GLSL_Api|lua_shader]] | string "3do" | string "s3o" ,]

["texunits" = {
[ [0] = { ["tex" = [[Lua_OpenGL_Api#Textures|see gl.Texture]] ,]
["enable" = boolean true ] }, ]
[ [3] = [[Lua_OpenGL_Api#Textures|see gl.Texture]], ]
(upto [15] and supports holes in it)
} ,]

["texunit0" = [[Lua_OpenGL_Api#Textures|see gl.Texture]] ,]
...
["texunit7" = [[Lua_OpenGL_Api#Textures|see gl.Texture]] ,]

["prelist" = [[Lua_OpenGL_Api#Display_Lists|lua_displaylist]] ,]
["postlist" = [[Lua_OpenGL_Api#Display_Lists|lua_displaylist]] ,]
["usecamera" = boolean ,]
["cameraloc" = number ,]
}

Lua UnitRendering

2008-06-15T03:08:04Z

JK: /* Unit Rendering */

==Unit Rendering==
'''Spring.UnitRendering.SetLODCount'''
( int lodCount ) -> nil

'''Spring.UnitRendering.SetLODLength''' (`lod` is 1-indexed)
( int lod, number lodLength ) -> nil

'''Spring.UnitRendering.SetLODDistance''' (same as SetLODLength(), but adjusted for 45deg FOV + 1024x768)
( int lod, number lodDistance ) -> nil

'''Spring.UnitRendering.SetPieceList''' (displayList=nil reset to default)
( number unitID, int lod, int piece [, number displayList = nil ] ) -> nil

'''Spring.UnitRendering.GetMaterial''' (creates a material userdata)
( string MaterialName, [[Lua_UnitRendering#Material_Table|table Material]] ) -> ??

'''Spring.UnitRendering.SetMaterial'''
( number unitID, int lod, string MaterialName, [[Lua_UnitRendering#Material_UserData|userdata Material]] | [[Lua_UnitRendering#Material_Table|table Material]] ) -> nil

'''Spring.UnitRendering.SetMaterialLastLOD'''
( number unitID, string MaterialName, int lastLOD ) -> nil

'''Spring.UnitRendering.SetMaterialDisplayLists'''
( number unitID, string MaterialName, preDisplayList, postDisplayList ) -> nil

'''Spring.UnitRendering.SetUnitUniform''' (unfinished)
( number unitID, string MaterialName, int lod, arg1, arg2, ... ) -> nil

'''Spring.UnitRendering.SetUnitLuaDraw''' (enables the DrawUnit callin)
( number unitID, boolean enabled ) -> nil

'''Spring.UnitRendering.Debug''' (prints some usefull debug informations)
( [ number unitID ] ) -> nil

==Material UserData==
fill me

==Material Table==
material = {
["order" = number ,]
["shader" = [[Lua_GLSL_Api|lua_shader]] | string "3do" | string "s3o" ,]

["texunits" = {
[ [0] = { ["tex" = [[Lua_OpenGL_Api#Textures|see gl.Texture]] ,]
["enable" = boolean true ] }, ]
[ [3] = [[Lua_OpenGL_Api#Textures|see gl.Texture]], ]
(upto [15] and supports holes in it)
} ,]

["texunit0" = [[Lua_OpenGL_Api#Textures|see gl.Texture]] ,]
...
["texunit7" = [[Lua_OpenGL_Api#Textures|see gl.Texture]] ,]

["prelist" = [[Lua_OpenGL_Api#Display_Lists|lua_displaylist]] ,]
["postlist" = [[Lua_OpenGL_Api#Display_Lists|lua_displaylist]] ,]
["usecamera" = boolean ,]
["cameraloc" = number ,]
}

Lua UnitRendering

2008-06-15T03:05:20Z

JK: /* Material Table */

==Unit Rendering==
'''Spring.UnitRendering.SetLODCount'''
( int lodCount ) -> nil

'''Spring.UnitRendering.SetLODLength''' (`lod` is 1-indexed)
( int lod, number lodLength ) -> nil

'''Spring.UnitRendering.SetLODDistance''' (same as SetLODLength(), but adjusted for 45deg FOV + 1024x768)
( int lod, number lodDistance ) -> nil

'''Spring.UnitRendering.SetPieceList''' (displayList=nil reset to default)
( number unitID, int lod, int piece [, number displayList = nil ] ) -> nil

'''Spring.UnitRendering.GetMaterial''' (creates a material userdata)
( string MaterialName, table Material ) -> ??

'''Spring.UnitRendering.SetMaterial'''
( number unitID, int lod, string MaterialName, userdata Material | table Material ) -> nil

'''Spring.UnitRendering.SetMaterialLastLOD'''
( number unitID, string MaterialName, int lastLOD ) -> nil

'''Spring.UnitRendering.SetMaterialDisplayLists'''
( number unitID, string MaterialName, preDisplayList, postDisplayList ) -> nil

'''Spring.UnitRendering.SetUnitUniform''' (unfinished)
( number unitID, string MaterialName, int lod, arg1, arg2, ... ) -> nil

'''Spring.UnitRendering.SetUnitLuaDraw''' (enables the DrawUnit callin)
( number unitID, boolean enabled ) -> nil

'''Spring.UnitRendering.Debug''' (prints some usefull debug informations)
( [ number unitID ] ) -> nil

==Material UserData==
fill me

==Material Table==
material = {
["order" = number ,]
["shader" = [[Lua_GLSL_Api|lua_shader]] | string "3do" | string "s3o" ,]

["texunits" = {
[ [0] = { ["tex" = [[Lua_OpenGL_Api#Textures|see gl.Texture]] ,]
["enable" = boolean true ] }, ]
[ [3] = [[Lua_OpenGL_Api#Textures|see gl.Texture]], ]
(upto [15] and supports holes in it)
} ,]

["texunit0" = [[Lua_OpenGL_Api#Textures|see gl.Texture]] ,]
...
["texunit7" = [[Lua_OpenGL_Api#Textures|see gl.Texture]] ,]

["prelist" = [[Lua_OpenGL_Api#Display_Lists|lua_displaylist]] ,]
["postlist" = [[Lua_OpenGL_Api#Display_Lists|lua_displaylist]] ,]
["usecamera" = boolean ,]
["cameraloc" = number ,]
}

Lua UnitRendering

2008-06-15T02:50:53Z

JK:

==Unit Rendering==
'''Spring.UnitRendering.SetLODCount'''
( int lodCount ) -> nil

'''Spring.UnitRendering.SetLODLength''' (`lod` is 1-indexed)
( int lod, number lodLength ) -> nil

'''Spring.UnitRendering.SetLODDistance''' (same as SetLODLength(), but adjusted for 45deg FOV + 1024x768)
( int lod, number lodDistance ) -> nil

'''Spring.UnitRendering.SetPieceList''' (displayList=nil reset to default)
( number unitID, int lod, int piece [, number displayList = nil ] ) -> nil

'''Spring.UnitRendering.GetMaterial''' (creates a material userdata)
( string MaterialName, table Material ) -> ??

'''Spring.UnitRendering.SetMaterial'''
( number unitID, int lod, string MaterialName, userdata Material | table Material ) -> nil

'''Spring.UnitRendering.SetMaterialLastLOD'''
( number unitID, string MaterialName, int lastLOD ) -> nil

'''Spring.UnitRendering.SetMaterialDisplayLists'''
( number unitID, string MaterialName, preDisplayList, postDisplayList ) -> nil

'''Spring.UnitRendering.SetUnitUniform''' (unfinished)
( number unitID, string MaterialName, int lod, arg1, arg2, ... ) -> nil

'''Spring.UnitRendering.SetUnitLuaDraw''' (enables the DrawUnit callin)
( number unitID, boolean enabled ) -> nil

'''Spring.UnitRendering.Debug''' (prints some usefull debug informations)
( [ number unitID ] ) -> nil

==Material UserData==
fill me

==Material Table==
material = {
["order" = number ,]
["shader" = [[Lua_GLSL_Api|lua_shader]] | string "3do" | string "s3o" ,]

["texunits" = {
[ [0] = { ["tex" = [[Lua_OpenGL_Api#Textures|see gl.Texture]] ,]
["enable" = boolean true ] }, ]
[ [3] = [[Lua_OpenGL_Api#Textures|see gl.Texture]], ]
} ,]

["texunit0" = [[Lua_OpenGL_Api#Textures|see gl.Texture]] ,]
...
["texunit7" = [[Lua_OpenGL_Api#Textures|see gl.Texture]] ,]

["prelist" = [[Lua_OpenGL_Api#Display_Lists|lua_displaylist]] ,]
["postlist" = [[Lua_OpenGL_Api#Display_Lists|lua_displaylist]] ,]
["usecamera" = boolean ,]
["cameraloc" = number ,]
}

Lua UnitRendering

2008-06-15T02:31:46Z

JK: /* Unit Rendering */

Lua UnitRendering

2008-06-15T02:21:47Z

JK: /* Unit Rendering */

Weapon Variables

2008-06-13T11:07:55Z

JK: /* Descriptions */

=WeaponType=
<table width=730 border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;">
<TR><th>WeaponType</th><th> Description </th> </tr>
<TR>
<TD>AircraftBomb (dropped=1)</TD>
<TD>Drops a ballistic projectile (aka Plasma) at the same movement vector as the unit itself. It's only meant for planes. A plane that has a CBombDropper as its weapon1 is a bomber. The CBombDropper automatically calculates its burst and burstrate tags from its reload time and uses 5 as its reload time instead. It will fire if the first bomb would drop within a circle roughly unitspeed*burst*burstrate so the longer the burst and the faster the unit the larger the circle in which it will drop instead of not firing and hoping the next attack run will pass that circle.</TD>
</TR>
<TR>
<TD>StarburstLauncher(vlaunch=1)</TD>
<TD>Fires a projectile that rises vertically (starts with no velocity) for <weapontimer> seconds, then turns at a fixed rate towards its target. The projectile's lifetime depends on its range divided by its max speed (ignores acceleration) and the weapontimer somehow so the weapon can fall short depending on how these values are set. This is the only weapon that can properly perform intercepts and be interceptable. Emits a smoketrail.</TD>
</TR>
<TR>
<TD>BeamLaser (beamlaser=1)</TD>
<TD>Should be well known, this thing spawns a beam and does a portion of its total damage each frame. It can't have a burst or burstrate, it can't have collidefriendly=0, it can't be emit-sfxed if it has a beamtime longer than one frame and its damage decreases over range if the minIntensity=1 tag isn't used. The largebeamlaser tag allows changing the visual effect of the laser, doesn't affect the behaviour of the weapon itself in any way though. Beamlasers can be really annoying... BTW, their beam doesn't collide with water so if they're set to waterweapon=1 they can shoot normally even when underwater (won't shoot at underwater targets though).</TD>
</TR>
<TR>
<TD>Shield (isShield=1)</TD>
<TD>The shield. Really not much to say about this, the tags are all documented in the changelog.</TD>
</TR>
<TR>
<TD>TorpedoLauncher (waterweapon=1)</TD>
<TD>Fires a projectile that will behave ballistically out of water and like a missile in water. Since waterweapon=1 is usually set for them they can fire underwater and they will target underwater units. The torpedo is the only projectile that doesn't explode on the water surface. An aircraft carrying a TorpedoLauncher is a special case, the thing turns into a bomb dropepr that will spawn a torpedo projectile, probably to get the whole bomber flight behaviour. Note that the waterweapon tag is also used to make a weapon fire underwater, independent of its type.</TD>
</TR>
<TR>
<TD>DGun (weaponname contains the word "disintegrator")</TD>
<TD>This shoots a fireball that travels in a straight line. The fireball has no range limitation by itself so if it misses or is fired in FPS mode it will travel across the whole map and further. DGuns don't properly check their line of fire, if terrain is in the way they fire anyway. These things are meant to be used with noexplode=1 but of course you CAN use them without that, too. If ballistic=1 is set the fireball will be affected by gravity, the weapon won't compensate for it though so it will hit the ground before reaching the target. Might be useful for a Scorched Earth mod or something since you'd have to aim it manually to hit anything.</TD>
</TR>
<TR>
<TD>LightingCannon (sic) (lineofsight=1 and rendertype=7)</TD>
<TD>An instant hit weapon like the Beamlaser except with a lightning graphic and even more annoying. It won't damage shields and it has a hardcoded inaccuracy (comparable to targetMoveError, the code comment is "should make it weaker against air"...). Shares some of the weirdnesses with the beamlaser, e.g. being able to penetrate water.</TD>
</TR>
<TR>
<TD>LaserCannon (lineofsight=1 and either beamweapon=1 or weaponname contains "laser" (marked as "workaround for SWTA))</TD>
<TD>The OTA-style laser. Probably one of the least annoying weapons in the engine. Its length is defined by the duration tag (together with the speed), BTW.</TD>
</TR>
<TR>
<TD>MissileLauncher (lineofsight=1 and smoketrail=1)</TD>
<TD>Shoots a smoke-emitting projectile. It can use guidance, acceleration, etc. The projectile's lifetime depends on range/maxspeed so a slowly accelerating missile will fall short. It can also use trajectoryheight to have the shot arc but that has trouble with aiming at targets higher or lower than the shooter (see bug report, this REALLY could use some fixing). Pretty versatile weapon overall, if the laser rendering code was ported into this we could pretty much axe the LaserCannon completely.</TD>
</TR>
<TR>
<TD>EmgCannon (lineofsight=1 and rendertype=4 and color=2)</TD>
<TD>Few know about this, it's a line of sight (i.e. not ballistic) weapon that can use billboard rendering (looks like a sprite). No idea what drawbacks this has, noone ever uses it.</TD>
</TR>
<TR>
<TD>Flame (lineofsight=1 and rendertype=5)</TD>
<TD>The flamethrower. A really annoying weapon. AFAIK it won't even aim ahead of moving targets. Can't say much else about it since I haven't tried using it much but overall I'd avoid the weapontype and fake the effect somehow, it's not pretty when fast and won't hit jack when slow.</TD>
</TR>
<TR>
<TD>Cannon (anything that didn't trigger another weapon)</TD>
<TD>Aka plasma. Shoots a ballistic projectile. Unlike the DGun it aims properly. Can't be emit-sfxed properly, maybe a ballistic DGun can fill that role.</TD>
</TR>
<TR>
<TD>Melee (only reachable through WeaponType)</TD>
<TD>When it fires it simply damages the target, no ifs or buts. It doesn't use a projectile and doesn't care about the line of fire. It won't even report a proper heading and pitch to AimWeapon so if you plan on using it in 75b2 you have to slave it to another weapon to handle the aiming. May be useful to be the damage dealer for a cosmetic weapon, i.e. you slave the Melee to a weapon that does no damage but looks pretty and the Melee does the damage. Kinda like the weapons in Warcraft and so.</TD>
</TR>
<TR>
<TD>Rifle (only reachable through WeaponType)</TD>
<TD>An instant hit weapon but an apparently unmaintained one. It has a hardcoded firing and explosion effect. I wouldn't use it.</TD>
</TR>
<TR>
<TD>CNoWeapon (weaponname is NOWEAPON, not reachable by any tag)</TD>
<TD>Apparently a placeholder used when a weapon isn't present. It's not really a weapondef but generated when the unit demands a NOWEAPON.</TD></TR>
</table>
=Descriptions=
<table width=730 border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;">
<TR><th>Variable </th><th> Description </th><th> Examples</Th> </tr>
<TR>
<TD>Accuracy</TD>
<TD>How accurate a weapon is. A larger number is less accurate. If this tag is missing entirely, it has perfect accuracy unless its target moves unexpectedly. Accuracy is relative to the distance to the target; for instance, if the target is very close, even a very high accuracy value will probably still hit. If a target is very far away, even a very low accuracy value will likely cause the weapon to miss. Can be any numeric value.</TD>
<TD>accuracy=400;</TD>
</TR>
<TR>
<TD>AlwaysVisible</TD>
<TD>Ignore LOS handling and always draw the weapon effect? Can be 1 or 0.</TD>
<TD>alwaysVisible=0;</TD>
</TR>
<TR>
<TD>AreaOfEffect</TD>
<TD>How large the weapon's impact explosion is. This affects how powerful the weapon's default impulse strength will be. Currently, BeamLasers with an AreaOfEffect of 16 or above will deform the ground at their point of impact regardless of whether it has been told not to. Can be any numeric value, but should generally be at least 8, regardless of the type of weapon.</TD>
<TD>areaofeffect=192;</TD>
</TR>
<TR>
<TD>AvoidFeature</TD>
<TD>This makes the weapon avoid features while targetting (the shoot will still collide with features). Can be 1 or 0.</TD>
<TD>avoidFeature=0;</TD>
</TR>
<TR>
<TD>AvoidFriendly</TD>
<TD>If set to 0 units will not try to avoid friendly units in their line of fire. Can be 1 or 0.</TD>
<TD>avoidFriendly=1;</TD>
</TR>
<TR>
<TD>Ballistic</TD>
<TD>Set to 1 for the weapon to be subjected to gravity, travelling in an arc through the air, such as cannons. Ballistic is mutually exclusive to LineOfSight and Dropped. Can be 1 or 0.</TD>
<TD>ballistic=1;</TD>
</TR>
<TR>
<TD>BeamDecay</TD>
<TD>For BeamLasers, defines the speed of the fadeout (each frame the beam's intensity is multiplied with that value). Can be between 0 and 1.</TD>
<TD>beamDecay=0.9;</TD>
</TR>
<TR>
<TD>BeamLaser</TD>
<TD>Whether this weapon is a beam laser or not. Beam lasers instantly hit their targets. Rendertype must be 0. Mutually exclusive to BeamWeapon. Can be 1 or 0.</TD>
<TD>beamlaser=1;</TD>
</TR>
<TR>
<TD>BeamTime</TD>
<TD>How long to fire the laser before waiting for ReloadTime to start. Can be any numeric value. Defaults to 1.</TD>
<TD>beamtime=0.5;</TD>
</TR>
<TR>
<TD>BeamTTL</TD>
<TD>For BeamLasers, defines the time (in frames) the beam will stay after being fired. Can be any numeric value.</TD>
<TD>beamTtl=10;</TD>
</TR>
<TR>
<TD>BeamWeapon</TD>
<TD>Whether this weapon is a regular laser or not. BeamWeapons (lasers) do not instantly hit their targets, and are affected by the weaponvelocity tag. Mutually exclusive to BeamLaser. Can be 1 or 0.</TD>
<TD>beamweapon=1;</TD>
</TR>
<TR>
<TD>BounceRebound</TD>
<TD>The amount of vertical velocity a projectile keeps when it bounces. Generally .3-1, but 0 for a sticky bomb, or 2 for a flubber bomb. Defaults to 1</TD>
<TD>bouncerebound=.8;</TD>
</TR>
<TR>
<TD>BounceSlip</TD>
<TD>The amount of horizontal velocity a projectile keeps when it bounces. Generally .3-1, but 0 for a sticky bomb, or 2 for a flubber bomb. Defaults to 1</TD>
<TD>bounceslip=.8;</TD>
</TR>
<TR>
<TD>BurnBlow</TD>
<TD>The weapon blows up when it reaches range the target was at when the weapon fired. Only works on plasma (rendertype=4) weapons and possibly missiles? Can be 1 or 0. A common usage is on flak guns.</TD>
<TD>burnblow=1;</TD>
</TR>
<TR>
<TD>Burst</TD>
<TD>How many shots are in a burst. Must be accompanied by burstrate. Can be any numeric value.</TD>
<TD>burst=3;</TD>
</TR>
<TR>
<TD>BurstRate</TD>
<TD>How fast the Burst fires. If set much below 0.1, it stops having any discernable effect.</TD>
<TD>burstrate=0.1</TD>
</TR>
<TR>
<TD>CameraShake</TD>
<TD>How much the camera shakes on impact. (needs the cameraShake widget to work). Can be any numeric value.</TD>
<TD>cameraShake=5;</TD>
</TR>
<TR>
<TD>CanAttackGround</TD>
<TD>Can be set to 1 or 0.</TD>
<TD>canAttackGround=0</TD>
</TR>
<TR>
<TD>CegTag</TD>
<TD>CegTag is the tag that emits a custom explosion every frame for a projectile. Can be used on any weapon to imitate dynamic lighting, smoke, fire, ball lightning, magic and many other things. Enter the name of your effect to make it emit once per frame.</TD>
<TD>cegtag=MISSILE_SMOKE_FX;</TD>
</TR>
<TR>
<TD>Color</TD>
<TD>An obsolete tag only recognized for compatibility purposes. While this still works for lasers, using rgbcolor=X X X; is a much, much better route. Plus, the RGBColor tag will override any color=x; tags in the tdf. </TD>
<TD>color=1;</TD>
</TR>
<TR>
<TD>Color2</TD>
<TD>An obsolete tag only recognized for compatibility purposes.</TD>
<TD>color=2;</TD>
</TR>
<TR>
<TD>ColorMap</TD>
<TD>Only used by flamethrower. Must be a CColorMap type.</TD>
<TD>colorMap=1 0 0 1  0 1 0 1; (red to green fade)</TD>
</TR>
<TR>
<TD>CollideFriendly</TD>
<TD>If set to 0 this weapon will not hit friendly units. Can be set to 1 or 0.</TD>
<TD>collisionFriendly=1;</TD>
</TR>
<TR>
<TD>CollisionSize</TD>
<TD>Defines the physical size of projectiles, percentage of size for flamethrower and absolute value emg, plasma and laser. Can be any numeric value.</TD>
<TD>collisionSize=30;</TD>
</TR>
<TR>
<TD>CommandFire</TD>
<TD>When ordered to attack ground this weapon will only fire once, rather than continuously. This does not work when ordered to attack units (It will continue to fire until the target is dead). If the unit has CanDgun=1 in its FBI, commandfire will identify that weapon with the dgun button. The weapon wont fire unless the dgun button is pressed. Can be set to 1 or 0.</TD>
<TD>commandfire=1;</TD>
</TR>
<TR>
<TD>CoreThickness</TD>
<TD>Thickness of the core of a laser (the part which use rgbcolor2). Can be any numeric value.</TD>
<TD>coreThickness=0.25;</TD>
</TR>
<TR>
<TD>Coverage</TD>
<TD>The range for anti-weapon weapons, like antinukes. This will be shown on the minimap as a guide. Can be any numeric value.</TD>
<TD>coverage=1280;</TD>
</TR>
<TR>
<TD>CraterBoost</TD>
<TD>Adds a constant factor to the terraform the explosion does. Can be any numeric value. (default 0)</TD>
<TD>craterMult=0.1;</TD>
</TR>
<TR>
<TD>CraterMult</TD>
<TD>Multiplies with the terraform the explosion does. Can be any numeric value. (default :=impulsFactor)</TD>
<TD>craterMult=1.2;</TD>
</TR>
<TR>
<TD>CylinderTargetting</TD>
<TD>If greater than 0, range will be checked in a cylinder instead of a sphere:
half height=unitradius*cylinderTargetting
Defaults to 1 for Melee type weapons, 0 otherwise. In 0.76b1, does not work with BeamLaser weapons.([http://spring.clan-sy.com/phpbb/viewtopic.php?p=219659#p219659 image])</TD>
<TD>cylinderTargetting=0;</TD>
</TR>
<TR>
<TD>Dance</TD>
<TD>For missles, unlike wobble it doesn't rotate the missile and it prevents the missile from going too far off course so a dancing swarm will remain coherent. Can be any numeric value.</TD>
<TD>dance=97;</TD>
</TR>
<TR>
<TD>Dropped</TD>
<TD>Sets the weapon to be dropped, like from a bomber. Must be RenderType=6 and needs the Model tag to be specified. Mutually exclusive to Ballistic and LineOfSight. Can be set to 1 or 0.</TD>
<TD>dropped=1;</TD>
</TR>
<TR>
<TD>Duration</TD>
<TD>For how many seconds a beam weapon will be fired before waiting for reload time. Also controls the length of the beam in BeamWeapon projectiles. Can be any numeric value. Used for rendertype 0 and 7 weapons.</TD>
<TD>duration=.5;</TD>
</TR>
<TR>
<TD>DynDamageExp</TD>
<TD>Exponent of the range damage formula, 0 (the default) disables dynamic damage. 1 means linear scaling. Only used by BeamLasers and LightingCannons. Can be any numeric value. ([http://spring.clan-sy.com/phpbb/viewtopic.php?p=263438#p263438 image])</TD>
<TD>dynDamageExp=0;</TD>
</TR>
<TR>
<TD>DynDamageInverted</TD>
<TD>Inverts the damage curve (more damage at far range). Only used by BeamLasers and LightingCannons. Can be 0 or 1.</TD>
<TD>dynDamageInverted=0;</TD>
</TR>
<TR>
<TD>DynDamageMin</TD>
<TD>Minimum dynamic range damage value. Only used by BeamLasers and LightingCannons. Can be any numeric value.</TD>
<TD>dynDamageMin=0;</TD>
</TR>
<TR>
<TD>DynDamageRange</TD>
<TD>If set it will use this value in the dynamic range damage formula instead of the range value from the weapon in the calculation. Only used by BeamLasers and LightingCannons. Can be any numeric value.</TD>
<TD>DynDamageRange=400;</TD>
</TR>
<TR>
<TD>EdgeEffectiveness</TD>
<TD>Determines what percent of a weapon's maximum damage value will be applied to units as they are closer to the outer edge of the weapon's AreaOfEffect. Must have a decimal value between 0 and 1. Default in OTA was 0, probably the same in Spring. ([http://spring.clan-sy.com/phpbb/viewtopic.php?p=251180#p251180 image])</TD>
<TD>edgeEffectiveness=0.25;</TD>
</TR>
<TR>
<TD>EnergyPerShot</TD>
<TD>Energy used per shot. If the specified amount of energy is not available, the weapon will not be able to shoot. Can also be used to specify how much a Stockpile weapon wll cost to build. Can be any numeric value.</TD>
<TD>energypershot=5;</TD>
</TR>
<TR>
<TD>ExplosionSpeed</TD>
<TD>Explosion animation speed/time. (only used by BeamLaser and LightingCannon?) default:
gd=max(30, DefaultDamage/20); 
expSpeed=(8+(gd*2.5))/(9+(sqrt(gd)*.7))/2; 
Can be any numeric value.
</TD>
<TD>explosionSpeed=5;</TD>
</TR>
<TR>
<TD>FallOffRate</TD>
<TD>Rate at which the beamweapon fades out after it goes past its maximum range. 0 is never fade out, 1 is finish fading out exactly at max range, the default 0.5 is the previous behaviour.
<TD>FallOffRate=0.5;</TD>
</TR>
<TR>
<TD>FireStarter</TD>
<TD>How likely the weapon will set trees on fire. High values make trees likey to be set on fire, low values make trees likely to just explode or tip over. Can be any numeric value between 0 and 100.</TD>
<TD>fireStarter=75;</TD>
</TR>
<TR>
<TD>FireSubmersed</TD>
<TD>If set the weapon can fire underwater, if not then not. Use it for weapons that cannot fire underwater but can hit underwater targets. Works even for torpedoes. Can be 0 or 1.</TD>
<TD>fireSubmersed=1;</TD>
</TR>
<TR>
<TD>FixedLauncher</TD>
<TD>For missiles, starburst missiles and torpedoes, this makes the projectile spawn with the orientation of the shooting piece instead of their normal orientation. The weapon will not properly check if allies are in the way so make sure you align the launchers in a way that won't hammer right into your own forces and perhaps use collideFriendly=0. FixedLauncher conflicts with trajectoryHeight and IMO combining them is pointless anyway so don't use both on a weapon. Can be 0 or 1.</TD>
<TD>fixedLauncher=0;</TD>
</TR>
<TR>
<TD>FlameGFXTime</TD>
<TD>Makes the flamethrower projectile stay alive as a graphical effect (doesnt do any damage) after it has reached maxrange. It is defined in percent, so 1.2 makes it remain 20% beyond maxrange. Can be any numeric value.
<TD>flamegfxtime=1.2;</TD>
</TR>
<TR>
<TD>FlightTime</TD>
<TD>Can be any numeric value.</TD>
<TD>flightTime=10;</TD>
</TR>
<TR>
<TD>GroundBounce</TD>
<TD>Weather the weapon projectile will bounce on the ground (on land or the ocean floor). Can be 0 or 1, defaults to 0 (off)</TD>
<TD>groundbounce=1;</TD>
</TR>
<TR>
<TD>Guidance</TD>
<TD>Specifies whether or not the weapon is capable of correcting its trajectory mid-flight. Will not track a moving target. Works only on missile and torpedo weapons. Can be set to 1 or 0. See TurnRate for information on specifying how well a weapon can track a target. Requires rendertype=1, lineofsight=1, and selfprop=1;</TD>
<TD>guidance=1;</TD>
</TR>
<TR>
<TD>HardStop</TD>
<TD>For LaserCannon, defined if the laser effect hard stops or fade out. Can be 0 or 1.</TD>
<TD>hardStop=0;</TD>
</TR>
<TR>
<TD>HeightBoostFactor</TD>
<TD>Gives control of cannon height range boost (more than 1 means increased range, 0 means the cannon has fixed range regardless of height difference to target. default is a magic value calculated on weapon init, based on range tag and theoretical max range.). Can be any numeric value, including negative ones (<0 := automatically calculated).</TD>
<TD>heightBoostFactor=-1;</TD>
</TR>
<TR>
<TD>HeightMod</TD>
<TD>Changes the sphere weapon range into an ellipsis. If it is larger 1.0 the weapon can't shoot as height as far, i.e. 0.5 means it can shoot twice as height as far ([http://spring.clan-sy.com/phpbb/viewtopic.php?p=219659#p219659 image]). Note that this may not work well with beam weapons, use minIntensity (0..1) tag to fix that.</TD>
<TD>heightMod=1;</TD>
</TR>
<TR>
<TD>ImpulseBoost</TD>
<TD>A constant factor added on the weapon's impulsefactor. Can be any numeric value, including negative ones.</TD>
<TD>impulseBoost=0.5;</TD>
</TR>
<TR>
<TD>ImpulseFactor</TD>
<TD>The multiplier on the weapon's default impulsefactor, which is determined based on a weapon's default damage and AreaOfEffect. The impulse of a weapon is how strong of a kinetic force will be applied to its target or anything near the point of impact. Can be any numeric value, including negative ones.</TD>
<TD>impulsefactor=2.5;</TD>
</TR>
<TR>
<TD>Intensity</TD>
<TD>Alpha (brighness and washout effect) of the weapon. Can be used on any rendertype 0, 3, or 4 weapon. Can be any numeric value.</TD>
<TD>intensity=1.5;</TD>
</TR>
<TR>
<TD>InterceptedByShieldType</TD>
<TD>Bitfield representing the types of shields that can intercept this weapon. The best way to think about this is to think of it as the resulting binary. Every digit of binary that is set to one means that a shield with that digit set to one will intercept this weapon, for instance, the example will result in the weapons being blocked by shields with types 1 and/or 3. Maxium of 32 unique types. See [[Shield Interception Tag Use]].</TD>
<TD>InterceptedByShieldType=5;</TD>
</TR>
<TR>
<TD>Interceptor</TD>
<TD>Can intercept missiles with the Cruise tag.</TD>
<TD>interceptor=1;</TD>
</TR>
<TR>
<TD>LargeBeamLaser</TD>
<TD>If set to 1 a beamlaser uses an alternate graphics effect. Can be 0 or 1.</TD>
<TD>largeBeamLaser=0;</TD>
</TR>
<TR>
<TD>LaserFlareSize</TD>
<TD>Size of the flare for laser weapons, multiplier for thickness. Can be set to any numeric value. (default: 15)</TD>
<TD>laserFlareSize=15;</TD>
</TR>
<TR>
<TD>Leadbonus</TD>
<TD>Is multiplied with the unit's experience and added to the lead limit.</TD>
<TD>leadbonus=1;</TD>
</TR>
<TR>
<TD>LeadLimit</TD>
<TD>Limits the maximum distance a unit will lead a target (default is -1 which means infinite).</TD>
<TD>leadLimit=1;</TD>
</TR>
<TR>
<TD>LineOfSight</TD>
<TD>LineOfSight weapons ignore gravity and must have a direct line from the firing point to the impact point in order to be fired. Can be set to 1 or 0. Mutually exclusive to Ballistic and Dropped.</TD>
<TD>lineofsight=1;</TD>
</TR>
<TR>
<TD>LodDistance</TD>
<TD>Minimum camera distance at which the default beamweapon projectile is simplified to rectangle. Can be set to any numeric value. (default: 1000)</TD>
<TD>lodDistance=1000;</TD>
</TR>
<TR>
<TD>ManualBombSettings</TD>
<TD>For Bombers, use burst and burstrate tags instead of hardcoded values. Can be set to 1 or 0.</TD>
<TD>manualBombSettings=1;</TD>
</TR>
<TR>
<TD>MetalPerShot</TD>
<TD>Metal used per shot. If the specified amount is not available, the weapon cannot be fired. Can also be used to specify how much a Stockpile weapon wll cost to build. Can be set to any numeric value.</TD>
<TD>metalpershot=500;</TD>
</TR>
<TR>
<TD>MinIntensity</TD>
<TD>For beamlasers - always hit with some minimum intensity (a damage coeffcient normally dependent on distance - range 0 to 1). Can be set to any numeric value.</TD>
<TD>minIntensity=0.1;</TD>
</TR>
<TR>
<TD>Model</TD>
<TD>The 3DO or S3O model to be used as this weapon's physical representation. 3DO modesl do not need a .3do extension, but S3O weapon do.</TD>
<TD>model=missile;</TD>
</TR>
<TR>
<TD>MovingAccuracy</TD>
<TD>A weapon's accuracy while moving. See Accuracy. Can be any numeric value.</TD>
<TD>movingaccuracy=1000;</TD>
</TR>
<TR>
<TD>MyGravity</TD>
<TD>For ballistic weapons (Cannon and Bomb), it overrides the map gravity if used. Regular map gravity is around 0.2.</TD>
<TD>myGravity=0.2;</TD>
</TR>
<TR>
<TD>NoExplode</TD>
<TD>Whether or not the weapon will explode on impact or continue on its path. An example is the d-gun. Can be set to 1 or 0.</TD>
<TD>noexplode=1;</TD>
</TR>
<TR>
<TD>NoSelfDamage</TD>
<TD>This weapon will not damage the unit that fired it. For instance, a nuke silo could shoot itself and not take any damage if this was active. Can be set to 1 or 0.</TD>
<TD>noselfdamage=1;</TD>
</TR>
<TR>
<TD>NumBounce</TD>
<TD>The maximum number of times a weapon will bounce. -1 for infinite. Defaults to -1</TD>
<TD>numbounce=5;</TD>
</TR>
<TR>
<TD>Paralyzer</TD>
<TD>If active, this weapon will not cause any damage to its target, but will instead paralyze (aka EMP). The default damage value of a weapon with this active will be applied to the target's HP; once the HP is overwhelmed, it will be paralyzed. Can be set to 1 or 0.</TD>
<TD>paralyzer=1;</TD>
</TR>
<TR>
<TD>ParalyzerTime</TD>
<TD>On Paralyzer weapons, determines the maximum length of time the target will be paralyzed (In seconds?). The timer is refreshed every time the target is hit by the weapon. Can be set to any numerical value.</TD>
<TD>paralyzetime=10;</TD>
</TR>
<TR>
<TD>PredictBoost</TD>
<TD>No idea what it does. Default 0 for non-burnblow, 0.5 for burnblow weapons. Can be set to any numerical value.</TD>
<TD>predictBoost=15;</TD>
</TR>
<TR>
<TD>Projectiles</TD>
<TD>The weapon fires this many projectiles at once (shotgun style). Make sure you put them on different trajectories somehow (sprayangle or different firepoints) because otherwise they'll all be clumped in one shot. Works well combined with bursts. Can be set to any integer value.</TD>
<TD>projectiles=1o;</TD>
</TR>
<TR>
<TD>ProximityPriority</TD>
<TD>Acts as a multiplier for the distance to the target in the priority calculation. Note that negative values make weapons prefer distant targets. Can be set to any numerical value.</TD>
<TD>proximityPriority=1;</TD>
</TR>
<TR>
<TD>PulseSpeed</TD>
<TD>On LargeBeamLaser, how fast the pulsating effect at the beam start is. Can be set to any numerical value.</TD>
<TD>pulseSpeed=15;</TD>
</TR>
<TR>
<TD>Range</TD>
<TD>The maximum range of the weapon. If set to noexplode, the weapon will disappear after this range has been met. If set to burnblow, the weapon will explode after this range has been met. Can be set to any numerical value.</TD>
<TD>range=750;</TD>
</TR>
<TR>
<TD>ReloadTime</TD>
<TD>The amount of time between shots. If a unit is paralyzed, this stops counting down. Can be set to any numerical value.</TD>
<TD>reloadtime=3.5;</TD>
</TR>
<TR>
<TD>Rendertype</TD>
<TD>The way the weapon will be displayed. Certain rendertypes are incompatibile with other tags, but it's generally for a logical reason. The rendertypes are as follows: 0 - Laser, 1 - Model, 3 - Plasma, 4 - Unit explosion (usally), 5 - Flamethrower, 6 - Dropped, 7 - Lightning. There's no documented use of rendertype=2 in OTA, and it probably doesn't do anything in Spring. 3 and 4 are usually interchangeable, both can be used to render a plasma/EMG/whatever shot; this is probably for compatibility.</TD>
<TD>rendertype=1;</TD>
</TR>
<TR>
<TD>RGBColor</TD>
<TD>The color of the rendertype 0, 3, 4, 7 weapon, specified in RED_GREEN_BLUE format.</TD>
<TD>rgbcolor=1 0.3 1; - this would make evul-purple</TD>
</TR>
<TR>
<TR>
<TD>RGBColor2</TD>
<TD>The color at the core of a rendertype 0 (laser) weapon. Specified the same as above. Defaults to white.</TD>
<TD>RGBColor2=0 1 0; - this would make a weird green middle for the evul-purple laser</TD>
</TR>
<TR>
<TD>ScrollSeed</TD>
<TD>Only used by LargeBeamLaser. How fast the beam apears to be moving towards it target. Can be set to any numerical value.</TD>
<TD>scrollSeed=1;</TD>
</TR>
<TR>
<TD>Selfprop</TD>
<TD>Required for Guidance tag. This weapon can propel itself and can have things like acceleration, rather than always travelling at one speed. See Guidance, StartVelocity, WeaponAcceleration, WeaponVelocity. Can be set to 1 or 0.</TD>
<TD>selfprop=1;</TD>
</TR>
<TR>
<TD>Size</TD>
<TD>Defines the visible size of projectiles. Can be set to any numerical value.</TD>
<TD>size=10;</TD>
</TR>
<TR>
<TD>SizeGrowth</TD>
<TD>Defines how fast flame projectiles will grow in size. Can be set to any numerical value.</TD>
<TD>sizegrowth=0.6;</TD>
</TR>
<TR>
<TD>SmokeTrail</TD>
<TD>Does the projectile leave a smoke trail or not. Can be set to 1 or 0.</TD>
<TD>smoketrail=1;</TD>
</TR>
<TR>
<TD>SoundHit</TD>
<TD>The sound made whe the weapon hits. Must reference a .wav file in the .\Sounds directory.</TD>
<TD>soundhit=emghit;</TD>
</TR>
<TR>
<TD>SoundHitVolume</TD>
<TD>Can be any numerical value between 0 and 1.</TD>
<TD>soundhitvolume=0.5;</TD>
</TR>
<TR>
<TD>SoundStart</TD>
<TD>The sound made when the weapon begins to fire. Will fire only once if the weapon is shot in a burst. Must reference a .wav file in the .\Sounds directory.</TD>
<TD>soundstart=emgfire;</TD>
</TR>
<TR>
<TD>SoundStartVolume</TD>
<TD>Can be any numerical value between 0 and 1.</TD>
<TD>soundstartvolume=0.5;</TD>
</TR>
<TR>
<TD>SoundTrigger</TD>
<TD>If active, the weapon will sound every time a shot is fired in a burst sequence. Can be set to 1 or 0.</TD>
<TD>soundtrigger=1;</TD>
</TR>
<TR>
<TD>SprayAngle</TD>
<TD>How wide the the angle of a burst from a burst weapon can be. Very similar to Accuracy, except that if a weapon has no sprayangle, all the shots will be fired at the same spot, even if the weapon's aim is off.</TD>
<TD>sprayangle=1024;</TD>
</TR>
<TR>
<TD>StartVelocity</TD>
<TD>The starting speed of the weapon as it is first fired. Only applicable to weapons that can accelerate.</TD>
<TD>startvelocity=200;</TD>
</TR>
<TR>
<TD>Stockpile</TD>
<TD>Can this weapon be stockpiled, for instance like a nuke launcher. Can be set to 1 or 0.</TD>
<TD>stockpile=1;</TD>
</TR>
<TR>
<TD>SubMissile</TD>
<TD>For TorpedoLaunchers, if set to 1 the torpedo will travel like a missile outside of water. It will not emit a smoketrail, though. When fired from a plane it will behave the same way but the plane will probably be considered a fighter, not a bomber. Can be set to 1 or 0.</TD>
<TD>subMissile=0;</TD>
</TR>
<TR>
<TD>SweepFire</TD>
<TD>If 1 (default 0) it will make the weapon continue firing while it aims for a new target. Only works on continous beam lasers currently. Can be set to 1 or 0.</TD>
<TD>SweepFire=1;</TD>
</TR>
<TR>
<TD>TargeBorder</TD>
<TD>If nonzero, targetting units will TryTarget at the edge of collision sphere (radius*tag_value, [-1;1]) instead of its centre. Can be set between 0 and 1. Defaults to 1 for Melee type weapons, 0 otherwise. ([http://spring.clan-sy.com/phpbb/viewtopic.php?p=219659#p219659 image])</TD>
<TD>targetBorder=1;</TD>
</TR>
<TR>
<TD>Targetable</TD>
<TD>If active, the weapon will be automatically targeted by any Interceptor weapons.</TD>
<TD>targetable=1;</TD>
</TR>
<TR>
<TD>TargetMoveError</TD>
<TD>The degree to which a weapon's aiming will fail to keep up with its target's movement. If set very low or not set at all, a weapon will lead its target and almost always hit unless there's a lot of micromanagement on the part of the person controlling the target. If set too high (about 0.3 or above), the weapon will have a lot of difficulty even tracking its target enough to get a shot off. Can probably only be set between 0 and 1. Beyond 1, the weapon would be virtually useless.</TD>
<TD>targetmoveerror=0.15;</TD>
</TR>
<TR>
<TD>Thickness</TD>
<TD>Thickness of a beamweapon or beamlaser, default is 2. Can be set to any numerical value.</TD>
<TD>thickness=4;</TD>
</TR>
<TR>
<TD>TileLength</TD>
<TD>Only used by LargeBeamLaser. Defines the length before the texture used is repeated (tiled).</TD>
<TD>tileLength=4;</TD>
</TR>
<TR>
<TD>ToAirWeapon</TD>
<TD>If active, the weapon will only be capable of targetting units which are flying, or are capable of flying. Can be set to 0 or 1.</TD>
<TD>toairweapon=1;</TD>
</TR>
<TR>
<TD>Tolerance</TD>
<TD>The amount to which the weapon's "real" aim can be off while the weapon will still be able to fire accurately at the target. This worked in OTA, but I'm not 100% sure if it works in Spring. Can be set to any numerical value.</TD>
<TD>tolerance=1500;</TD>
</TR>
<TR>
<TD>Tracks</TD>
<TD>If the missile tracks a moving target. Can be set to 1 or 0.</TD>
<TD>tracks=1;</TD>
</TR>
<TR>
<TD>TrajectoryHeight</TD>
<TD>The height of the arc of a missile weapon. It is useful for compensating for mountains or debris. Is relative to the weapons speed (Higher speed, higher arc) and the range the weapon is firing at (Lower range lower arc). Requires Guidance and Turnrate to hit its target when over 1. </TD>
<TD>trajectoryheight=0.8;</TD>
</TR>
<TR>
<TD>Turnrate</TD>
<TD>How fast a guided weapon can turn. Can be any numerical value between 0 and 64000. If set to 0, the weapon can't turn at all, if set to 64000, the weapon can literally defy all known physics and turn 180 degrees in a fraction of a second. This is relative to a weapon's velocity; a weapon with a very low velocity (~200) wouldn't need a very high turnrate to keep up with a fighter, although it would probably never catch it because of its slow speed. A weapon with a very high velocity (~1000) would need a very high value in order to be able to hit targets that turn suddenly.
<TD>turnrate=32000;</TD>
</TR>
<TR>
<TD>Turret</TD>
<TD>Set to 1 if weapon is used by a turret that rotates. Set to 0 if weapon is forward firing, ie, has no rotating turret piece.</TD>
<TD>turret=1;</TD>
</TR>
<TR>
<TD>TwoPhase</TD>
<TD>Weapon operates in two phases... eh... yeah, I honestly have no idea what the difference between this and VLaunch is. Generally use it with VLaunch as well. Can be set to 1 or 0.</TD>
<TD>twophase=1;</TD>
</TR>
<TR>
<TD>VLaunch</TD>
<TD>Set to 1 to launch the weapon vertically. Can only be used with missile-type weapons with a TurnRate. Cannot be used at the same time as Turret. Set to 1 or 0.</TD>
<TD>vlaunch=1;</TD>
</TR>
<TR>
<TD>WaterBounce</TD>
<TD>Weather the weapon projectile will bounce on the surface of the water. Can be 0 or 1, defaults to 0 (off)</TD>
<TD>waterbounce=1;</TD>
</TR>
<TR>
<TD>WaterWeapon</TD>
<TD>Water weapons behave somewhat like Dropped weapons out of water, and like missiles underwater. Is the only type of weapon that can fire under water. Can be set to 1 or 0.</TD>
<TD>waterweapon=1;</TD>
</TR>
<TR>
<TD>WeaponAcceleration</TD>
<TD>Tells the weapon how fast it should accelerate from its StartVelocity to its actual WeaponVelocity. Increases the weapon's velocity every second by the amount specified. Can be any numerical value.</TD>
<TD>weaponacceleration=50;</TD>
</TR>
<TR>
<TD>WeaponTimer</TD>
<TD>;How long until the weapon will go into its second phase. For use with missile weapons. For VLaunch weapons, the weapon will turn to actually go towards its target after the specified number of seconds has expired. For non-VLaunch missiles with a TurnRate, the weapon will go randomly off-course after this period of time. Can be set to any numerical value.</TD>
<TD>weapontimer=5;</TD>
</TR>
<TR>
<TD>WeaponVelocity</TD>
<TD>The speed the weapon moves after being fired. If StartVelocity is lower than this number, the weapon will increase speed to its WeaponVelocity at the rate specified by its WeaponAcceleration.</TD>
<TD>weaponvelocity=800;</TD>
</TR>
<TR>
<TD>Wobble</TD>
<TD>The amount that a missile will wobble off-course. Requires TurnRate. Turnrate will wrestle with wobble to keep the weapon on course, so wobble must be high enough to compensate to have any effect. Can be set to any numerical value between 0 and 64000.</TD>
<TD>wobble=15000;</TD>
</TR>
</table>
NOTE: Variables that are defined by either a 1 or a 0 are BOOLEAN, where 1 means TRUE and 0 means FALSE.

NOTE 2: "Any numerical value" for things that relate to angles really means any value between 0 and 64,000 since that's between 0 and 360 degrees in spring measurement. Setting it higher than 64,000 will bring it 'full circle' so to speak.
 

=Texture Tags=
<center>
<table width=500 border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 1em; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;">
<TR><th> Weapon </th><th> Used Texture Tags </th> </tr>
<TR>
<TD>AircraftBomb</TD>
<TD>texture1 = projectile</TD>
</TR>
<TR>
<TD>BeamLaser</TD>
<TD>texture1 = beam texture2 = beamend texture3 = flare </TD>
</TR>
<TR>
<TD>PlasmaCannon</TD>
<TD>texture1 = projectile</TD>
</TR>
<TR>
<TD>EmgCannon</TD>
<TD>texture1 = projectile</TD>
</TR>
<TR>
<TD>FlameThrower</TD>
<TD>texture1 = flame</TD>
</TR>
<TR>
<TD>LargeBeamLaser</TD>
<TD>texture1 = beam texture2 = beamend texture3 = muzzle texture4 = flare </TD>
</TR>
<TR>
<TD>LaserCannon</TD>
<TD>texture1 = beam texture2 = beamend </TD>
</TR>
<TR>
<TD>LightingCannon</TD>
<TD>texture1 = beam </TD>
</TR>
<TR>
<TD>MissileLauncher</TD>
<TD>texture1 = flare texture2 = smoketrail </TD>
</TR>
<TR>
<TD>Shield</TD>
<TD>texture1 = shield</TD>
</TR>
<TR>
<TD>StarburstLauncher</TD>
<TD>texture1 = flare texture2 = smoketrail texture3 = flame </TD>
</TR>
<TR>
<TD>TorpedoLauncher</TD>
<TD>texture1 = projectile </TD>
</TR>
</TABLE>
</center>
NOTE: All textures need to be `atlased`. So you have to define them in the '''resources.tdf''' and use the reference name in the texture tags.
 

=Plasma Visuals=
<table width=730 border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;">
<TR><th>Variable </th><th> Description </th><th> Examples</Th> </tr>
<TR>
<TD>AlphaDecay</TD>
<TD>How much a plasma particle is more transparent than the previous particle. Can be set to any numerical value. (default: 1)</TD>
<TD>AlphaDecay=0.95;</TD>
</TR>
<TR>
<TD>NoGap</TD>
<TD>If set to 1, the distance between plasma particles is proportional to the size of the two particles. If set to 0, the distance between plasma particles will be proportional to the size of the first particle.
Can be set to 1 or 0. (default: 1)</TD>
<TD>NoGap=0;</TD>
</TR>
<TR>
<TD>Separation</TD>
<TD>Distance between each plasma particle. Can be set to any number value. (default: 1)</TD>
<TD>Separation=5;</TD>
</TR>
<TR>
<TD>SizeDecay</TD>
<TD>How much a plasma particle is smaller than the previous within the same plasma shot. Can be set to any numerical value. (default: 0)</TD>
<TD>SizeDecay=0.2;</TD>
</TR>
<TR>
<TD>Stages</TD>
<TD>Number of particles used in one plasma shot. Can be set to any number value. (default: 5)</TD>
<TD>Stages=20;</TD>
</TR>
</table>
 

=Shield/Repulsor Descriptions=
<table width=730 border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;">
<TR><th>Variable </th><th> Description </th><th> Examples</Th> </tr>
<TR>
<TD>ExteriorShield</TD>
<TD>If set to 1, the shield/repulsor will not have any effect on weapons fired from within its field. Can be 1 or 0.</TD>
<TD>exteriorshield=1;</TD>
</TR>
<TR>
<TD>IsShield</TD>
<TD>If set to 1, this "weapon" is no longer a weapon, is now a repulsor or a shield, based on the other properties given to it. Can be 1 or 0.</TD>
<TD>isshield=1;</TD>
</TR>
<TR>
<TD>ShieldAlpha</TD>
<TD>How clearly visible the shield is, if you have VisibleShield turned on. Value is between 0 and 1.</TD>
<TD>shieldalpha=0.4;</TD>
</TR>
<TR>
<TD>ShieldEnergyUse</TD>
<TD>The amount of energy used to repulse or destroy weapons. Will be used constantly while the weapon is in its area of effect if it is a repulsor, will be used only once on impact if it is a shield.</TD>
<TD>shieldenergyuse=1500;</TD>
</TR>
<TR>
<TD>ShieldForce</TD>
<TD>The force applied to weapons, an arbitrary number. Set to 1, it will not deflect very well. Only for use on repulsor-type. Can be set to any numerical value.</TD>
<TD>shieldforce=1.75;</TD>
</TR>
<TR>
<TD>ShieldBadColor</TD>
<TD>The color the shield is when it is at 0% strength, if you have VisibleShield turned on. Defined in R G B format.</TD>
<TD>shieldbadcolor=0 1 0;</TD>
</TR>
<TR>
<TD>ShieldGoodColor</TD>
<TD>The color the shield is when it is at 100% strength, if you have VisibleShield turned on.</TD>
<TD>shieldgoodcolor=1 0 0;</TD>
</TR>
<TR>
<TD>ShieldInterceptType</TD>
<TD>Bitfield representing the types of weapons that this shield can intercept. The best way to think about this is to think of it as the resulting binary. Every digit of binary that is set to one means that a weapon with that digit set to one will be intercepted by this shield, for instance, the example will result in the shield blocking weapons with types 2 and/or 3. Maxium of 32 unique types. See [[Shield Interception Tag Use]].</TD>
<TD>ShieldInterceptType=6;</TD>
</TR>
<TR>
<TD>ShieldMaxSpeed</TD>
<TD>The maximum speed the repulsor will push weapons away at. Only for use on repulsor-type. Can be set to any numerical value.</TD>
<TD>shieldmaxspeed=400;</TD>
</TR>
<TR>
<TD>ShieldPower</TD>
<TD>How much "power" a shield can store. "Power" is not the same as energy; think of it as the shield/repulsor's private battery source. It can be drained completely by defending against weapons, even if you have lots of energy. ''Power is drained by the affected weapons damage.'' Can be set to any numerical value.</TD>
<TD>shieldpower=1000;</TD>
</TR>
<TR>
<TD>ShieldPowerRegen</TD>
<TD>How quickly the shield regenerates its "power", even when under attack. Regenerates the amount specified every second. Can be set to any numerical value.</TD>
<TD>shieldpowerregen=25;</TD>
</TR>
<TR>
<TD>ShieldPowerRegenEnergy</TD>
<TD>How much energy is required to keep the shield regenerating its "power". For instance, you might have it set so that 100 units of energy are necessary for every 25 units of "power".</TD>
<TD>shieldpowerregenenergy=100;</TD>
</TR>
<TR>
<TD>ShieldRadius</TD>
<TD>Defines the size of the area the shield/repulsor protects. Can be set to any numerical value.</TD>
<TD>shieldradius=500;</TD>
</TR>
<TR>
<TD>ShieldRepulsor</TD>
<TD>If set to 1, the "shield"-type weapon will repulse projectiles. If set to 0, it will destroy them. Can be set to 1 or 0.</TD>
<TD>shieldrepulsor=1;</TD>
</TR>
<TR>
<TD>ShieldStartingPower</TD>
<TD>If set the shield starts with this much power instead of 0. Can be set to any numerical value.</TD>
<TD>shieldStartingPower=100;</TD>
</TR>
<TR>
<TD>SmartShield</TD>
<TD>If set to 1, the shield/repulsor will not affect owned/allied weapons. Can be set to 1 or 0.</TD>
<TD>smartshield=1;</TD>
</TR>
<TR>
<TD>VisibleShield</TD>
<TD>If set to 1, the shield will be visible. Only for use on shield-type. Can be set to 1 or 0.</TD>
<TD>visibleshield=1;</TD>
</TR>
<TR>
<TD>VisibleShieldHitFrames</TD>
<TD>Numbers of frames how long the shield should be visible after it got hit (the alpha value fades after the hit). Can be set to any numerical value. (default: 0 frames)</TD>
<TD>visibleShieldHitFrames=5;</TD>
</TR>
<TR>
<TD>VisibleShieldRepulse</TD>
<TD>If set to 1, the repulsing effect will be visible. Only for use on repulsor-type. Can be set to 1 or 0.</TD>
<TD>visibleshieldrepulse=1;</TD>
</TR>
</table>


[[category:Weapons]]

[[category:Shields]]

Lua VFS

2008-06-05T03:39:28Z

JK: /* Modes */

== Modes ==
'''VFS.RAW''' 
'''VFS.MOD''' (unimplemented, acts like VFS.ZIP) 
'''VFS.MAP''' (unimplemented, acts like VFS.ZIP) 
'''VFS.BASE''' (unimplemented, acts like VFS.ZIP) 
'''VFS.ZIP''' 
'''VFS.RAW_FIRST''' 
'''VFS.ZIP_FIRST''' 
'''VFS.RAW_ONLY''' (same as VFS.RAW) 
'''VFS.ZIP_ONLY''' (same as VFS.ZIP) 

== Files ==
'''VFS.Include'''
( string "filename" [, table enviroment [, number mode ] ] ) ->
'''VFS.LoadFile'''
( string "filename" [, number mode ] ) -> nil | lstring data
'''VFS.FileExists'''
( string "filename" [, number mode ] ) -> boolean
'''VFS.DirList'''
( string "directory" [, string "pattern" [, number mode [, string "optstr" ] ] ] )
-> { [1] = string filename, ... }
 optstr can contain:
"r" = recursive
"d" = include dirs

== Packing ==
The Pack- and Unpack-functions are used to convert numbers->strings and strings->numbers.
So you can read a binary file and then convert the received strings back to numbers and the other way around. Also you can use it in combination with the SendLuaXYZMsg-functions.

'''VFS.PackU8'''

'''VFS.PackU16'''

'''VFS.PackU32'''

'''VFS.PackS8'''

'''VFS.PackS16'''

'''VFS.PackS32'''

'''VFS.PackF32'''

arguments are:

'''VFS.PackX( number arg1, number arg2, number arg3, ... )''' -> string

'''VFS.PackX( {[1]=number,[2]=number,..} )''' -> string

'''VFS.UnpackU8'''

'''VFS.UnpackU16'''

'''VFS.UnpackU32'''

'''VFS.UnpackS8'''

'''VFS.UnpackS16'''

'''VFS.UnpackS32'''

'''VFS.UnpackF32'''

arguments are:

'''VFS.UnpackX( string "binary" [, number offset ] [, number count] )'''
-> number | table { [1]=number,[2]=number,.. }

Lua SyncedRead

2008-06-02T05:15:47Z

JK: /* StartBoxes/StartPositions */

== Game ==
=== Special TeamID Variables ===
'''Spring.ALL_UNITS''' 
'''Spring.MY_UNITS''' 
'''Spring.ALLY_UNITS''' 
'''Spring.ENEMY_UNITS'''

'''Spring.GetGaiaTeamID'''
( ) -> number teamID

=== GameStates ===
'''Spring.IsGodModeEnabled'''
( ) -> boolean
'''Spring.IsCheatingEnabled'''
( ) -> boolean
'''Spring.IsDevLuaEnabled'''
( ) -> boolean
'''Spring.IsEditDefsEnabled'''
( ) -> boolean
'''Spring.AreHelperAIsEnabled'''
( ) -> boolean

'''Spring.IsGameOver'''
( ) -> boolean

=== Rules ===
'''Spring.GetRulesInfoMap'''
( ) -> { [key1] = string value1, [key2] = string value2, ... }
( string "key" ) -> string

'''Spring.GetGameRulesParam'''
( number index | string ruleName ) -> number value
'''Spring.GetGameRulesParams'''
( ) -> { [rule1] = number value1, [rule2] = number value2, ... }

'''Spring.GetTeamRulesParam'''
( number teamID, number index | string ruleName ) -> nil | number value
'''Spring.GetTeamRulesParams'''
( number teamID ) -> nil | { [rule1] = number value1, [rule2] = number value2, ... }

'''Spring.GetUnitRulesParam'''
( number unitID, number index | string ruleName ) -> nil | number value
'''Spring.GetUnitRulesParams'''
( number unitID ) -> nil | { [rule1] = number value1, [rule2] = number value2, ... }

=== Mod-/Map-Options ===
'''Spring.GetModOptions'''
( ) -> {} | { "keyName1" = string "value", "keyName2" = string "value", ... }
'''Spring.GetMapOptions'''
( ) -> {} | { "keyName1" = string "value", "keyName2" = string "value", ... }

=== Speed/Time ===
'''Spring.GetGameSpeed'''
( ) -> number userSpeedFactor, number speedFactor, boolean paused
'''Spring.GetGameFrame'''
( ) -> number frameNum%dayFrames, number frameNum/dayFrames
'''Spring.GetGameSeconds'''
( ) -> number seconds

=== Vectors ===
'''Spring.GetWind'''
( ) -> number dirX, number dirY, number dirZ,
number strength, number normDirX, number normDirY, number normDirZ

'''Spring.GetHeadingFromVector'''
( number x, number z ) -> number heading
'''Spring.GetVectorFromHeading'''
( number heading ) -> number x, number z

== Teams ==
=== StartBoxes/StartPositions ===
'''Spring.GetAllyTeamStartBox'''
( number allyID ) -> nil | number xmin, number zmin, number xmax, number zmax
'''Spring.GetTeamStartPosition'''
( number teamID ) -> nil | number x, number y, number z

=== Player,Team,Ally Lists/Info ===
'''Spring.GetPlayerList'''
( [number teamID, boolean onlyActive] ) -> nil | { [1] = number playerID, etc... }
'''Spring.GetTeamList'''
( [number allyTeamID] ) -> nil | { [1] = number teamID, etc... }
'''Spring.GetAllyTeamList'''
( ) -> { [1] = number allyTeamID, etc... }

'''Spring.GetPlayerInfo'''
( number playerID ) ->
nil | string "name", (in synced code this is "SYNCED_NONAME"!)
boolean active,
boolean spectator,
number teamID,
number allyTeamID,
number pingTime,
number cpuUsage,
string country,
number rank
'''Spring.GetPlayerControlledUnit'''
( number playerID ) -> nil | number unitID

'''Spring.GetTeamInfo'''
( number teamID ) ->
nil | number teamNum,
number leader,
boolean isDead,
boolean isAiTeam,
string "side",
number allyTeam
'''Spring.GetTeamResources'''
( number teamID, string "metal" | "energy" ) ->
nil | number currentLevel,
number storage,
number pull,
number income,
number expense,
number share,
number sent,
number received
'''Spring.GetTeamUnitStats'''
( number teamID ) ->
nil | number killed,
number died,
number capturedBy,
number capturedFrom,
number received,
number sent
'''Spring.GetTeamStatsHistory'''
( number teamID, number startTime, number endTime ) ->
{
[1] = {
"frame" = number,
"metalUsed" = number,
"metalProduced" = number,
"metalExcess" = number,
"metalReceived" = number,
"metalSent" = number,
"energyUsed" = number,
"energyProduced" = number,
"energyExcess" = number,
"energyReceived" = number,
"energySent" = number,
"damageDealt" = number,
"damageReceived" = number,
"unitsProduced" = number,
"unitsDied" = number,
"unitsReceived" = number,
"unitsSent" = number,
"unitsCaptured" = number,
"unitsOutCaptured" = number,
"unitsKilled" = number
}, ...
}
'''Spring.GetTeamLuaAI'''
( number teamID ) -> string "luaAI"

=== Teams/PlayersAllied ===
'''Spring.AreTeamsAllied'''
( number teamID1, number teamID2 ) -> nil | boolean
'''Spring.ArePlayersAllied'''
( number playerID1, number playerID2 ) -> nil | boolean

== Units ==
=== GetUnits ===
'''Spring.GetAllUnits'''
( ) -> nil | unitTable = { [1] = number unitID, ... }
'''Spring.GetTeamUnits'''
( number teamID ) -> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetTeamUnitsSorted'''
( number teamID ) -> nil |
unitDefTable = {
[number unitDefID] = { [1] = [number unitID], etc... },
etc...
}
'''Spring.GetTeamUnitsCounts'''
( number teamID ) -> nil | countTable = { [number unitDefID] = count, etc... }
'''Spring.GetTeamUnitsByDefs'''
( number teamID, number unitDefID | { number unitDefID1, ... } )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetTeamUnitDefCount'''
( number teamID, number unitDefID ) -> nil | number count
'''Spring.GetTeamUnitCount'''
( number teamID ) -> nil | number count

'''Spring.GetUnitsInRectangle'''
( number xmin, number zmin, number xmax, number zmax [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInBox'''
( number xmin, number ymin, number zmin,
number xmax, number ymax, number zmax [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInSphere'''
( number x, number y, number z, number radius [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInCylinder'''
( number x, number z, number radius [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInPlanes'''
( planes = { [1] = { number nx, number ny, number nz, number d }, etc... } )
-> nil | unitTable = { [1] = number unitID, etc... }

plane normals point towards accepted space,
so the acceptance criteria for each plane is:
radius = unit radius
px, py, pz = unit position
[(nx * px) + (ny * py) + (nz * pz) + (d - radius)] <= 0


'''Spring.GetUnitNearestAlly'''
( number unitID [, number range ] ) -> nil | number unitID
'''Spring.GetUnitNearestEnemy'''
( number unitID [, number range ] ) -> nil | number unitID

=== Unit Informations ===
'''Spring.GetUnitTooltip'''
( number unitID ) -> nil | string tooltip
'''Spring.GetUnitDefID'''
( number unitID ) -> nil | number unitDefID
'''Spring.GetUnitTeam'''
( number unitID ) -> nil | number teamID
'''Spring.GetUnitAllyTeam'''
( number unitID ) -> nil | number allyID
'''Spring.GetUnitLineage'''
( number unitID ) -> nil | number lineage, boolean lineageRoot
'''Spring.GetUnitNeutral'''
( number unitID ) -> nil | boolean neutral
'''Spring.GetUnitHealth'''
( number unitID ) -> nil | number health, number maxHealth, number paralyzeDamage,
number captureProgress, number buildProgress
'''Spring.GetUnitIsDead'''
( number unitID ) -> nil | boolean dead
'''Spring.GetUnitIsStunned'''
( number unitID ) -> nil | boolean stunned_or_inbuild, boolean stunned, boolean inbuild
'''Spring.GetUnitResources'''
( number unitID ) -> nil | number metalMake, number metalUse,
number energyMake, number energyUse
'''Spring.GetUnitExperience'''
( number unitID ) -> nil | number experience
'''Spring.GetUnitStates'''
( number unitID ) -> nil | {
"firestate" = number,
"movestate" = number,
"repeat" = boolean,
"cloak" = boolean,
"active" = boolean,
"trajectory" = boolean,
["autoland" = boolean,]
["autorepairlevel" = number,]
["loopbackattack" = boolean]
}
'''Spring.GetUnitIsActive'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitIsCloaked'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitSelfDTime'''
( number unitID ) -> nil | number
'''Spring.GetUnitStockpile'''
( number unitID ) -> nil | number numStockpiled, number numStockpileQued,
number buildPercent
'''Spring.GetUnitHeight'''
( number unitID ) -> nil | number
'''Spring.GetUnitRadius'''
( number unitID ) -> nil | number
'''Spring.GetUnitPosition'''
( number unitID ) -> nil | number x, number y, number z
'''Spring.GetUnitBasePosition'''
( number unitID ) -> nil | number x, number y, number z
'''Spring.GetUnitDirection'''
( number unitID ) -> nil | number dx, number dy, number dz
'''Spring.GetUnitHeading'''
( number unitID ) -> nil | number heading
'''Spring.GetUnitVelocity'''
( number unitID ) -> nil | number velx, number vely, number velz
'''Spring.GetUnitBuildFacing'''
( number unitID ) -> nil | number
'''Spring.GetUnitIsBuilding'''
( number unitID ) -> nil | number unitID
'''Spring.GetUnitTransporter'''
( number unitID ) -> nil | number unitID
'''Spring.GetUnitIsTransporting'''
( number unitID ) -> nil | { [1] = number unitID, etc... }
'''Spring.GetUnitShieldState'''
( number unitID ) -> nil | number isEnabled, number curPower
'''Spring.GetUnitWeaponState'''
( number unitID [, number weaponNum] ) -> nil |
boolean angleGood, boolean loaded, number reloadFrame, number salvoLeft, number numStockpiled
'''Spring.GetUnitTravel'''
( number unitID ) -> nil | number travel, number travelPeriod
'''Spring.GetUnitLosState'''
( number unitID [, number allyTeamID ] ) -> nil |
{ ["los" = true] [, "radar" = true] [, "typed" = true] }
'''Spring.GetUnitSeparation''' (returns the distance of 2 units)
( number unitID1, number unitID2 [, boolean 2D ] ) -> nil | number distance
'''Spring.GetUnitDefDimensions'''
( number unitDefID ) -> nil |
{
"height" = number,
"radius" = number,
"midx" = number,
"minx" = number,
"maxx" = number,
"midy" = number,
"miny" = number,
"maxy" = number,
"midz" = number,
"minz" = number,
"maxz" = number
}

=== CommandQueues ===
'''Spring.GetUnitCommands'''
( number unitID [, number count] ) -> nil | commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean
}
}, ...
}
'''Spring.GetCommandQueue''' (same as Spring.GetUnitCommands)
( number unitID [, number count] ) -> nil | commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean
}
}, ...
}
'''Spring.GetFullBuildQueue'''
( number unitID ) ->
nil | buildOrders = {
[1] = { [number unitDefID] = number count }, etc...
}
'''Spring.GetRealBuildQueue''' (cleans the buildqueue of things the unit can't build itself)
( number unitID ) ->
nil | buildOrders = {
[1] = { [number unitDefID] = number count }, etc...
}
'''Spring.GetFactoryCommands'''
( number unitID [, number count] ) -> nil | commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean
}
}, ...
}
'''Spring.GetFactoryCounts''' (used to get the buildqueue of a factory, seems screwed o_O)
( number unitID [, number count [, boolean addCMDs ] ] ) -> nil | commandQueueTable = {
[2] = { [number unitDefID | number -cmdID] = number count }, ...
}

=== Command Descriptions/Buttons ===
'''Spring.GetUnitCmdDescs'''
( number unitID [, number startIndex [, number endIndex ] ] ) -> nil | {
[1] = {
"id" = number,
"type" = number,
"name" = string,
"action" = string,
"tooltip" = string,
"texture" = string,
"cursor" = string,
"hidden" = boolean,
"disabled" = boolean,
"showUnique" = boolean,
"onlyTexture" = boolean,

"params" = { [1] = string, ... }
}, ...
}
'''Spring.FindUnitCmdDesc'''
( number unitID, number cmdID ) -> nil | number index

=== Unit Pieces ===
'''Spring.GetUnitPiecePosition'''
( number unitID, number piece ) -> number posx, number posy, number posz
'''Spring.GetUnitPieceDirection'''
( number unitID, number piece ) -> number dirx, number diry, number dirz
'''Spring.GetUnitPieceMatrix'''
( number unitID, number piece ) -> { [1] = number, ... , [16] = number }
'''Spring.GetUnitPieceList'''
( number unitID ) -> { [1] = string "piecename", ... , [pieceNumN] = string "piecename" }
'''Spring.GetUnitPieceMap'''
( number unitID ) -> { "piecename1" = pieceNum1, ... , "piecenameN" = pieceNumN }
'''Spring.GetUnitPieceInfo'''
( number unitID, number piece ) -> {
"name" = string "piecename",
"isEmpty" = boolean,
"children" = { [1] = string "piecename", ... },
"min" = { [1] = number x, [2] = number y, [3] = number z },
"max" = { [1] = number x, [2] = number y, [3] = number z },
"offset" = { [1] = number x, [2] = number y, [3] = number z },
}
'''Spring.GetUnitScriptPiece'''
( number unitID [, number scriptPiece ] )
-> nil | { scriptPieceNum = number modelPieceNum } | number modelPieceNum

This functions translate the COB ScriptPiece numbers into the ModelPiece numbers (the set of
ScriptPieces is a subset of the ModelPieces, means #ScriptPieces <= #ModelPieces), which
is used in all other functions (the "number piece" means always the modelpiece).
So if you get via Cob2Lua a pieceID you have to translate it with this function.
Btw the COB ScriptPiece number is equal with the piece position in the piece definition
in your cob/bos.
'''Spring.GetUnitScriptNames'''
( number unitID )
-> { "cobpiecename1" = ScriptPieceNum1, ... , "cobpiecenameN" = ScriptPieceNumN }

== Features ==
=== GetFeatures ===
'''Spring.GetFeaturesInRectangle'''
( number xmin, number zmin, number xmax, number zmax [,number teamID] )
-> nil | featureTable = { [1] = number featureID, etc... }
'''Spring.GetAllFeatures'''
( ) -> nil | { [1] = number featureID, ... }
'''Spring.GetFeatureList''' // NOTE: this is not really required, now all FeatureDefs are pre-loaded

=== Feature Informations ===
'''Spring.GetFeatureDefID'''
( number featureID ) -> nil | number featureDefID
'''Spring.GetFeatureTeam'''
( number featureID ) -> nil | number teamID
'''Spring.GetFeatureAllyTeam'''
( number featureID ) -> nil | number allyID
'''Spring.GetFeatureHealth'''
( number featureID ) -> nil | number health, number maxHealth, number resurrectProgress
'''Spring.GetFeatureHeight'''
( number featureID ) -> nil | number
'''Spring.GetFeatureRadius'''
( number featureID ) -> nil | number
'''Spring.GetFeaturePosition'''
( number featureID ) -> nil | number x, number y, number z
'''Spring.GetFeatureDirection'''
( number featureID ) -> nil | number dirx, number diry, number dirz
'''Spring.GetFeatureHeading'''
( number featureID ) -> nil | number heading
'''Spring.GetFeatureResources'''
( number featureID ) -> nil | number RemainingMetal, number maxMetal,
number RemainingEnergy, number maxEnergy, number reclaimLeft
'''Spring.GetFeatureNoSelect'''
( number featureID ) -> nil | boolean noSelect
'''Spring.GetFeatureResurrect'''
( number featureID ) -> nil | string UnitDefName, number buildFacing

== COB ==
'''Spring.GetCOBUnitVar'''
( number unitID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBTeamVar'''
( number teamID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBAllyTeamVar'''
( number allyID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBGlobalVar'''
( integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY

== Ground ==
=== Ground Informations ===
'''Spring.GetGroundHeight'''
( number x, number y ) -> number z
'''Spring.GetGroundOrigHeight'''
( number x, number y ) -> number z
'''Spring.GetGroundNormal'''
( number x, number y ) -> number x, number y, number z
'''Spring.GetGroundInfo'''
( number x, number y ) -> string "Type", number metal, number hardness,
number tankSpeed, number kbotSpeed, number hoverSpeed,
number shipSpeed, boolean receiveTracks
'''Spring.GetGroundBlocked'''
( number x, number y |
number x1, number y1, number x2, number y2 )
-> nil | string "feature", number featureID | string "unit", number unitID
'''Spring.GetGroundExtremes'''
( ) -> nil | number minHeight, number maxHeight

=== Test Building ===
'''Spring.TestBuildOrder'''
( number unitDefID, number x, number y, number z, number facing)
-> number blocking [,number featureID]

blocking can be:
0 - blocked
1 - mobile unit in the way
2 - free (or if featureID is != 0 then with a blocking feature that can be reclaimed)
'''Spring.Pos2BuildPos'''
( number unitDefID, number x, number y, number z ) -> nil | number x, number y, number z

=== PathFinding ===
'''Spring.GetUnitEstimatedPath'''
( number unitID ) -> nil | {
[1] = { x,y,z }, ...
},{
[1] = startIdxOfDetailedPath,
[2] = startIdxOfDetailedEstimatedPath1,
[3] = startIdxOfDetailedEstimatedPath2,
}
GetUnitEstimatedPath() returns 2 tables:
1 table the waypoints and 1 table with indices (in the waypoint table)
when a new (more lazy) pathfinding algorithm begins.
So the waypoint table contains 3 different levels of details.

=== LOS ===
'''Spring.GetPositionLosState'''
( number x, number y, number z [, number allyID] )
-> boolean visible, boolean inLos, boolean inAirLos, boolean inRadar
'''Spring.GetClosestValidPosition''' //NOT FINISHED YET
( number unitDefID, number x, number z, number r ) -> nil

Associated Development Groups

2008-05-26T14:40:03Z

JK: /* Forums */

There are numerous people and groups involved in the Spring project, from development to content creation. This is meant as a cumulative list of associated groups to ease communication between them. However, use of this tenative listing to abuse or assault any of the below listed forums, groups, teams or individuals will not be tolerated.

===Forums===
*[http://cs.selu.edu/~ssmith/FORUM/ Smoth's Development Forum] - Smoth's forum showcases many prominent members of the Spring community in a cooperative enviroment outside of the main Spring forums.
*[http://trac.caspring.org/ CA's Trac] - The CA dev team is one of the most active and innovative groups in the spring community. Their Lua gadgets/widgets push the spring engine to its limits.

Associated Development Groups

2008-05-26T14:39:35Z

JK: /* Forums */

Associated Development Groups

2008-05-26T02:58:06Z

JK:

There are numerous people and groups involved in the Spring project, from development to content creation. This is meant as a cumulative list of associated groups to ease communication between them. However, use of this tenative listing to abuse or assault any of the below listed forums, groups, teams or individuals will not be tolerated.

===Forums===
*[http://cs.selu.edu/~ssmith/FORUM/ Smoth's Development Forum] - Smoth's forum showcases many prominent members of the Spring community in a cooperative enviroment outside of the main Spring forums.
*[http://trac.caspring.org/ CA's Trac] - The CA dev team is one of the most active and innovative group in the spring community. Their Lua gadgets/widgets push the spring engine to its limit.

Lua VFS

2008-05-26T01:42:30Z

JK: /* Packing */

== Modes ==
'''VFS.RAW''' 
'''VFS.MOD''' 
'''VFS.MAP''' 
'''VFS.BASE''' 
'''VFS.ZIP''' 
'''VFS.RAW_FIRST''' 
'''VFS.ZIP_FIRST''' 
'''VFS.RAW_ONLY''' 
'''VFS.ZIP_ONLY'''

== Files ==
'''VFS.Include'''
( string "filename" [, table enviroment [, number mode ] ] ) ->
'''VFS.LoadFile'''
( string "filename" [, number mode ] ) -> nil | lstring data
'''VFS.FileExists'''
( string "filename" [, number mode ] ) -> boolean
'''VFS.DirList'''
( string "directory" [, string "pattern" [, number mode [, string "optstr" ] ] ] )
-> { [1] = string filename, ... }
 optstr can contain:
"r" = recursive
"d" = include dirs

== Packing ==
The Pack- and Unpack-functions are used to convert numbers->strings and strings->numbers.
So you can read a binary file and then convert the received strings back to numbers and the other way around. Also you can use it in combination with the SendLuaXYZMsg-functions.

'''VFS.PackU8'''

'''VFS.PackU16'''

'''VFS.PackU32'''

'''VFS.PackS8'''

'''VFS.PackS16'''

'''VFS.PackS32'''

'''VFS.PackF32'''

arguments are:

'''VFS.PackX( number arg1, number arg2, number arg3, ... )''' -> string

'''VFS.PackX( {[1]=number,[2]=number,..} )''' -> string

'''VFS.UnpackU8'''

'''VFS.UnpackU16'''

'''VFS.UnpackU32'''

'''VFS.UnpackS8'''

'''VFS.UnpackS16'''

'''VFS.UnpackS32'''

'''VFS.UnpackF32'''

arguments are:

'''VFS.UnpackX( string "binary" [, number offset ] [, number count] )'''
-> number | table { [1]=number,[2]=number,.. }

Lua VFS

2008-05-26T00:34:03Z

JK: /* Packing */

== Modes ==
'''VFS.RAW''' 
'''VFS.MOD''' 
'''VFS.MAP''' 
'''VFS.BASE''' 
'''VFS.ZIP''' 
'''VFS.RAW_FIRST''' 
'''VFS.ZIP_FIRST''' 
'''VFS.RAW_ONLY''' 
'''VFS.ZIP_ONLY'''

== Files ==
'''VFS.Include'''
( string "filename" [, table enviroment [, number mode ] ] ) ->
'''VFS.LoadFile'''
( string "filename" [, number mode ] ) -> nil | lstring data
'''VFS.FileExists'''
( string "filename" [, number mode ] ) -> boolean
'''VFS.DirList'''
( string "directory" [, string "pattern" [, number mode [, string "optstr" ] ] ] )
-> { [1] = string filename, ... }
 optstr can contain:
"r" = recursive
"d" = include dirs

== Packing ==
Pack- and Unpack-functions are used to convert numbers->strings and strings->numbers.
So you can read a binary file and then convert the received strings back to numbers and the other way around. Also you can use it in combination with the SendLuaXYZMsg-functions.

'''VFS.PackU8'''

'''VFS.PackU16'''

'''VFS.PackU32'''

'''VFS.PackS8'''

'''VFS.PackS16'''

'''VFS.PackS32'''

'''VFS.PackF32'''

'''VFS.UnpackU8'''

'''VFS.UnpackU16'''

'''VFS.UnpackU32'''

'''VFS.UnpackS8'''

'''VFS.UnpackS16'''

'''VFS.UnpackS32'''

'''VFS.UnpackF32'''

Lua SyncedRead

2008-05-26T00:26:07Z

JK: /* Player,Team,Ally Lists/Info */

== Game ==
=== Special TeamID Variables ===
'''Spring.ALL_UNITS''' 
'''Spring.MY_UNITS''' 
'''Spring.ALLY_UNITS''' 
'''Spring.ENEMY_UNITS'''

'''Spring.GetGaiaTeamID'''
( ) -> number teamID

=== GameStates ===
'''Spring.IsGodModeEnabled'''
( ) -> boolean
'''Spring.IsCheatingEnabled'''
( ) -> boolean
'''Spring.IsDevLuaEnabled'''
( ) -> boolean
'''Spring.IsEditDefsEnabled'''
( ) -> boolean
'''Spring.AreHelperAIsEnabled'''
( ) -> boolean

'''Spring.IsGameOver'''
( ) -> boolean

=== Rules ===
'''Spring.GetRulesInfoMap'''
( ) -> { [key1] = string value1, [key2] = string value2, ... }
( string "key" ) -> string

'''Spring.GetGameRulesParam'''
( number index | string ruleName ) -> number value
'''Spring.GetGameRulesParams'''
( ) -> { [rule1] = number value1, [rule2] = number value2, ... }

'''Spring.GetTeamRulesParam'''
( number teamID, number index | string ruleName ) -> nil | number value
'''Spring.GetTeamRulesParams'''
( number teamID ) -> nil | { [rule1] = number value1, [rule2] = number value2, ... }

'''Spring.GetUnitRulesParam'''
( number unitID, number index | string ruleName ) -> nil | number value
'''Spring.GetUnitRulesParams'''
( number unitID ) -> nil | { [rule1] = number value1, [rule2] = number value2, ... }

=== Mod-/Map-Options ===
'''Spring.GetModOptions'''
( ) -> {} | { "keyName1" = string "value", "keyName2" = string "value", ... }
'''Spring.GetMapOptions'''
( ) -> {} | { "keyName1" = string "value", "keyName2" = string "value", ... }

=== Speed/Time ===
'''Spring.GetGameSpeed'''
( ) -> number userSpeedFactor, number speedFactor, boolean paused
'''Spring.GetGameFrame'''
( ) -> number frameNum%dayFrames, number frameNum/dayFrames
'''Spring.GetGameSeconds'''
( ) -> number seconds

=== Vectors ===
'''Spring.GetWind'''
( ) -> number dirX, number dirY, number dirZ,
number strength, number normDirX, number normDirY, number normDirZ

'''Spring.GetHeadingFromVector'''
( number x, number z ) -> number heading
'''Spring.GetVectorFromHeading'''
( number heading ) -> number x, number z

== Teams ==
=== StartBoxes/StartPositions ===
'''Spring.GetAllyTeamStartBox'''
( number allyID ) -> number xmin, number zmin, number xmax, number zmax
'''Spring.GetTeamStartPosition'''
( number teamID ) -> number x, number y, number z

=== Player,Team,Ally Lists/Info ===
'''Spring.GetPlayerList'''
( [number teamID, boolean onlyActive] ) -> nil | { [1] = number playerID, etc... }
'''Spring.GetTeamList'''
( [number allyTeamID] ) -> nil | { [1] = number teamID, etc... }
'''Spring.GetAllyTeamList'''
( ) -> { [1] = number allyTeamID, etc... }

'''Spring.GetPlayerInfo'''
( number playerID ) ->
nil | string "name", (in synced code this is "SYNCED_NONAME"!)
boolean active,
boolean spectator,
number teamID,
number allyTeamID,
number pingTime,
number cpuUsage,
string country,
number rank
'''Spring.GetPlayerControlledUnit'''
( number playerID ) -> nil | number unitID

'''Spring.GetTeamInfo'''
( number teamID ) ->
nil | number teamNum,
number leader,
boolean isDead,
boolean isAiTeam,
string "side",
number allyTeam
'''Spring.GetTeamResources'''
( number teamID, string "metal" | "energy" ) ->
nil | number currentLevel,
number storage,
number pull,
number income,
number expense,
number share,
number sent,
number received
'''Spring.GetTeamUnitStats'''
( number teamID ) ->
nil | number killed,
number died,
number capturedBy,
number capturedFrom,
number received,
number sent
'''Spring.GetTeamStatsHistory'''
( number teamID, number startTime, number endTime ) ->
{
[1] = {
"frame" = number,
"metalUsed" = number,
"metalProduced" = number,
"metalExcess" = number,
"metalReceived" = number,
"metalSent" = number,
"energyUsed" = number,
"energyProduced" = number,
"energyExcess" = number,
"energyReceived" = number,
"energySent" = number,
"damageDealt" = number,
"damageReceived" = number,
"unitsProduced" = number,
"unitsDied" = number,
"unitsReceived" = number,
"unitsSent" = number,
"unitsCaptured" = number,
"unitsOutCaptured" = number,
"unitsKilled" = number
}, ...
}
'''Spring.GetTeamLuaAI'''
( number teamID ) -> string "luaAI"

=== Teams/PlayersAllied ===
'''Spring.AreTeamsAllied'''
( number teamID1, number teamID2 ) -> nil | boolean
'''Spring.ArePlayersAllied'''
( number playerID1, number playerID2 ) -> nil | boolean

== Units ==
=== GetUnits ===
'''Spring.GetAllUnits'''
( ) -> nil | unitTable = { [1] = number unitID, ... }
'''Spring.GetTeamUnits'''
( number teamID ) -> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetTeamUnitsSorted'''
( number teamID ) -> nil |
unitDefTable = {
[number unitDefID] = { [1] = [number unitID], etc... },
etc...
}
'''Spring.GetTeamUnitsCounts'''
( number teamID ) -> nil | countTable = { [number unitDefID] = count, etc... }
'''Spring.GetTeamUnitsByDefs'''
( number teamID, number unitDefID | { number unitDefID1, ... } )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetTeamUnitDefCount'''
( number teamID, number unitDefID ) -> nil | number count
'''Spring.GetTeamUnitCount'''
( number teamID ) -> nil | number count

'''Spring.GetUnitsInRectangle'''
( number xmin, number zmin, number xmax, number zmax [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInBox'''
( number xmin, number ymin, number zmin,
number xmax, number ymax, number zmax [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInSphere'''
( number x, number y, number z, number radius [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInCylinder'''
( number x, number z, number radius [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInPlanes'''
( planes = { [1] = { number nx, number ny, number nz, number d }, etc... } )
-> nil | unitTable = { [1] = number unitID, etc... }

plane normals point towards accepted space,
so the acceptance criteria for each plane is:
radius = unit radius
px, py, pz = unit position
[(nx * px) + (ny * py) + (nz * pz) + (d - radius)] <= 0


'''Spring.GetUnitNearestAlly'''
( number unitID [, number range ] ) -> nil | number unitID
'''Spring.GetUnitNearestEnemy'''
( number unitID [, number range ] ) -> nil | number unitID

=== Unit Informations ===
'''Spring.GetUnitTooltip'''
( number unitID ) -> nil | string tooltip
'''Spring.GetUnitDefID'''
( number unitID ) -> nil | number unitDefID
'''Spring.GetUnitTeam'''
( number unitID ) -> nil | number teamID
'''Spring.GetUnitAllyTeam'''
( number unitID ) -> nil | number allyID
'''Spring.GetUnitLineage'''
( number unitID ) -> nil | number lineage, boolean lineageRoot
'''Spring.GetUnitNeutral'''
( number unitID ) -> nil | boolean neutral
'''Spring.GetUnitHealth'''
( number unitID ) -> nil | number health, number maxHealth, number paralyzeDamage,
number captureProgress, number buildProgress
'''Spring.GetUnitIsDead'''
( number unitID ) -> nil | boolean dead
'''Spring.GetUnitIsStunned'''
( number unitID ) -> nil | boolean stunned_or_inbuild, boolean stunned, boolean inbuild
'''Spring.GetUnitResources'''
( number unitID ) -> nil | number metalMake, number metalUse,
number energyMake, number energyUse
'''Spring.GetUnitExperience'''
( number unitID ) -> nil | number experience
'''Spring.GetUnitStates'''
( number unitID ) -> nil | {
"firestate" = number,
"movestate" = number,
"repeat" = boolean,
"cloak" = boolean,
"active" = boolean,
"trajectory" = boolean,
["autoland" = boolean,]
["autorepairlevel" = number,]
["loopbackattack" = boolean]
}
'''Spring.GetUnitIsActive'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitIsCloaked'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitSelfDTime'''
( number unitID ) -> nil | number
'''Spring.GetUnitStockpile'''
( number unitID ) -> nil | number numStockpiled, number numStockpileQued,
number buildPercent
'''Spring.GetUnitHeight'''
( number unitID ) -> nil | number
'''Spring.GetUnitRadius'''
( number unitID ) -> nil | number
'''Spring.GetUnitPosition'''
( number unitID ) -> nil | number x, number y, number z
'''Spring.GetUnitBasePosition'''
( number unitID ) -> nil | number x, number y, number z
'''Spring.GetUnitDirection'''
( number unitID ) -> nil | number dx, number dy, number dz
'''Spring.GetUnitHeading'''
( number unitID ) -> nil | number heading
'''Spring.GetUnitVelocity'''
( number unitID ) -> nil | number velx, number vely, number velz
'''Spring.GetUnitBuildFacing'''
( number unitID ) -> nil | number
'''Spring.GetUnitIsBuilding'''
( number unitID ) -> nil | number unitID
'''Spring.GetUnitTransporter'''
( number unitID ) -> nil | number unitID
'''Spring.GetUnitIsTransporting'''
( number unitID ) -> nil | { [1] = number unitID, etc... }
'''Spring.GetUnitShieldState'''
( number unitID ) -> nil | number isEnabled, number curPower
'''Spring.GetUnitWeaponState'''
( number unitID [, number weaponNum] ) -> nil |
boolean angleGood, boolean loaded, number reloadFrame, number salvoLeft, number numStockpiled
'''Spring.GetUnitTravel'''
( number unitID ) -> nil | number travel, number travelPeriod
'''Spring.GetUnitLosState'''
( number unitID [, number allyTeamID ] ) -> nil |
{ ["los" = true] [, "radar" = true] [, "typed" = true] }
'''Spring.GetUnitSeparation''' (returns the distance of 2 units)
( number unitID1, number unitID2 [, boolean 2D ] ) -> nil | number distance
'''Spring.GetUnitDefDimensions'''
( number unitDefID ) -> nil |
{
"height" = number,
"radius" = number,
"midx" = number,
"minx" = number,
"maxx" = number,
"midy" = number,
"miny" = number,
"maxy" = number,
"midz" = number,
"minz" = number,
"maxz" = number
}

=== CommandQueues ===
'''Spring.GetUnitCommands'''
( number unitID [, number count] ) -> nil | commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean
}
}, ...
}
'''Spring.GetCommandQueue''' (same as Spring.GetUnitCommands)
( number unitID [, number count] ) -> nil | commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean
}
}, ...
}
'''Spring.GetFullBuildQueue'''
( number unitID ) ->
nil | buildOrders = {
[1] = { [number unitDefID] = number count }, etc...
}
'''Spring.GetRealBuildQueue''' (cleans the buildqueue of things the unit can't build itself)
( number unitID ) ->
nil | buildOrders = {
[1] = { [number unitDefID] = number count }, etc...
}
'''Spring.GetFactoryCommands'''
( number unitID [, number count] ) -> nil | commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean
}
}, ...
}
'''Spring.GetFactoryCounts''' (used to get the buildqueue of a factory, seems screwed o_O)
( number unitID [, number count [, boolean addCMDs ] ] ) -> nil | commandQueueTable = {
[2] = { [number unitDefID | number -cmdID] = number count }, ...
}

=== Command Descriptions/Buttons ===
'''Spring.GetUnitCmdDescs'''
( number unitID [, number startIndex [, number endIndex ] ] ) -> nil | {
[1] = {
"id" = number,
"type" = number,
"name" = string,
"action" = string,
"tooltip" = string,
"texture" = string,
"cursor" = string,
"hidden" = boolean,
"disabled" = boolean,
"showUnique" = boolean,
"onlyTexture" = boolean,

"params" = { [1] = string, ... }
}, ...
}
'''Spring.FindUnitCmdDesc'''
( number unitID, number cmdID ) -> nil | number index

=== Unit Pieces ===
'''Spring.GetUnitPiecePosition'''
( number unitID, number piece ) -> number posx, number posy, number posz
'''Spring.GetUnitPieceDirection'''
( number unitID, number piece ) -> number dirx, number diry, number dirz
'''Spring.GetUnitPieceMatrix'''
( number unitID, number piece ) -> { [1] = number, ... , [16] = number }
'''Spring.GetUnitPieceList'''
( number unitID ) -> { [1] = string "piecename", ... , [pieceNumN] = string "piecename" }
'''Spring.GetUnitPieceMap'''
( number unitID ) -> { "piecename1" = pieceNum1, ... , "piecenameN" = pieceNumN }
'''Spring.GetUnitPieceInfo'''
( number unitID, number piece ) -> {
"name" = string "piecename",
"isEmpty" = boolean,
"children" = { [1] = string "piecename", ... },
"min" = { [1] = number x, [2] = number y, [3] = number z },
"max" = { [1] = number x, [2] = number y, [3] = number z },
"offset" = { [1] = number x, [2] = number y, [3] = number z },
}
'''Spring.GetUnitScriptPiece'''
( number unitID [, number scriptPiece ] )
-> nil | { scriptPieceNum = number modelPieceNum } | number modelPieceNum

This functions translate the COB ScriptPiece numbers into the ModelPiece numbers (the set of
ScriptPieces is a subset of the ModelPieces, means #ScriptPieces <= #ModelPieces), which
is used in all other functions (the "number piece" means always the modelpiece).
So if you get via Cob2Lua a pieceID you have to translate it with this function.
Btw the COB ScriptPiece number is equal with the piece position in the piece definition
in your cob/bos.
'''Spring.GetUnitScriptNames'''
( number unitID )
-> { "cobpiecename1" = ScriptPieceNum1, ... , "cobpiecenameN" = ScriptPieceNumN }

== Features ==
=== GetFeatures ===
'''Spring.GetFeaturesInRectangle'''
( number xmin, number zmin, number xmax, number zmax [,number teamID] )
-> nil | featureTable = { [1] = number featureID, etc... }
'''Spring.GetAllFeatures'''
( ) -> nil | { [1] = number featureID, ... }
'''Spring.GetFeatureList''' // NOTE: this is not really required, now all FeatureDefs are pre-loaded

=== Feature Informations ===
'''Spring.GetFeatureDefID'''
( number featureID ) -> nil | number featureDefID
'''Spring.GetFeatureTeam'''
( number featureID ) -> nil | number teamID
'''Spring.GetFeatureAllyTeam'''
( number featureID ) -> nil | number allyID
'''Spring.GetFeatureHealth'''
( number featureID ) -> nil | number health, number maxHealth, number resurrectProgress
'''Spring.GetFeatureHeight'''
( number featureID ) -> nil | number
'''Spring.GetFeatureRadius'''
( number featureID ) -> nil | number
'''Spring.GetFeaturePosition'''
( number featureID ) -> nil | number x, number y, number z
'''Spring.GetFeatureDirection'''
( number featureID ) -> nil | number dirx, number diry, number dirz
'''Spring.GetFeatureHeading'''
( number featureID ) -> nil | number heading
'''Spring.GetFeatureResources'''
( number featureID ) -> nil | number RemainingMetal, number maxMetal,
number RemainingEnergy, number maxEnergy, number reclaimLeft
'''Spring.GetFeatureNoSelect'''
( number featureID ) -> nil | boolean noSelect
'''Spring.GetFeatureResurrect'''
( number featureID ) -> nil | string UnitDefName, number buildFacing

== COB ==
'''Spring.GetCOBUnitVar'''
( number unitID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBTeamVar'''
( number teamID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBAllyTeamVar'''
( number allyID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBGlobalVar'''
( integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY

== Ground ==
=== Ground Informations ===
'''Spring.GetGroundHeight'''
( number x, number y ) -> number z
'''Spring.GetGroundOrigHeight'''
( number x, number y ) -> number z
'''Spring.GetGroundNormal'''
( number x, number y ) -> number x, number y, number z
'''Spring.GetGroundInfo'''
( number x, number y ) -> string "Type", number metal, number hardness,
number tankSpeed, number kbotSpeed, number hoverSpeed,
number shipSpeed, boolean receiveTracks
'''Spring.GetGroundBlocked'''
( number x, number y |
number x1, number y1, number x2, number y2 )
-> nil | string "feature", number featureID | string "unit", number unitID
'''Spring.GetGroundExtremes'''
( ) -> nil | number minHeight, number maxHeight

=== Test Building ===
'''Spring.TestBuildOrder'''
( number unitDefID, number x, number y, number z, number facing)
-> number blocking [,number featureID]

blocking can be:
0 - blocked
1 - mobile unit in the way
2 - free (or if featureID is != 0 then with a blocking feature that can be reclaimed)
'''Spring.Pos2BuildPos'''
( number unitDefID, number x, number y, number z ) -> nil | number x, number y, number z

=== PathFinding ===
'''Spring.GetUnitEstimatedPath'''
( number unitID ) -> nil | {
[1] = { x,y,z }, ...
},{
[1] = startIdxOfDetailedPath,
[2] = startIdxOfDetailedEstimatedPath1,
[3] = startIdxOfDetailedEstimatedPath2,
}
GetUnitEstimatedPath() returns 2 tables:
1 table the waypoints and 1 table with indices (in the waypoint table)
when a new (more lazy) pathfinding algorithm begins.
So the waypoint table contains 3 different levels of details.

=== LOS ===
'''Spring.GetPositionLosState'''
( number x, number y, number z [, number allyID] )
-> boolean visible, boolean inLos, boolean inAirLos, boolean inRadar
'''Spring.GetClosestValidPosition''' //NOT FINISHED YET
( number unitDefID, number x, number z, number r ) -> nil

Main Page

2008-05-15T12:03:25Z

JK:

{|border="2" cellpadding="4" cellspacing="0" style="margin: 10px; border: 1px #aaa solid; border-collapse: collapse; background: #f9f9f9"
|<center>'''Other Languages'''</center>
|<center>'''[[Image:france_flag.gif]] [[Page_principale|FranÃƒÂ§ais]]'''</center>
|<center>'''[[Image:germany_flag.gif]] [[Uebersicht der Wiki|Deutsch]]'''</center>
|<center>'''[[Pagina Principale|Italiano]]'''</center>
|}
{|border="0" cellpadding="4" cellspacing="10" width="100%"
|width="50%" valign="top" style="background: #e6e6fa; border: 1px #aaa solid;"|
== General ==

'''[[Read Me First]]''' Answers to questions often asked - Everyone should read this first. 
'''[[FAQ]]''' Has it been asked before? 
'''[[Using_Spring|Playing Spring]]''' How to play the game. Controls, issuing orders, and related topics. 
'''[[Mods]]''' Games that use the Spring engine. 
'''[[Maps]]''' All about maps for the Spring engine and where to get them. 
'''[[AIs]]''' Skirmish AIs, Helper AIs... 
'''[[Strategy and Tactics]]''' Basic ideas how to stand your ground. 
'''[[Glossary]]''' What does "AA" or "XTA" mean? Explanations for common terms and shorthand. 
'''[[Clans]]''' A list of the official clans in spring. 
'''[[King Titles]]''' Titles of importance. 
'''[[Spreading Spring]]''' Read before advertising. 
'''[[Hosting Spring]]''' Autohosting and related topics. 
'''[[The Lighter Side Of Spring]]''' Humour, comics and quotations. 
|width="50%" valign="top" style="background: #e6e6fa; border: 1px #aaa solid;"|
== Development ==
'''[[Engine Development]]''' Information regarding the source code of Spring. 
'''[[Mod_and_Unit_development#Mod_development|Game Development And Unit Creation]]''' Lots of links to valuable Articles and forum threads regarding Mod/Unit Development. 
'''[[Map_development|Map Development]]''' Tutorials and other useful information for creating maps. 

'''[[Lua Scripting]]''' Information regarding the use of the supplementary Lua scripting language for Widgets and beyond... 
'''[[Map, Mod, And Unit Development Programs|Content Development Programs]]''' Links to all kind of useful programs. 
'''[[Mission development]]''' Help on writing campaigns, demos and missions using Lua. 
'''[[AI|AI Development]]''' Lots of information about developing Skirmish, Unit and Group AIs for Spring. 
'''[[Linux_Page |Linux and Mac OS]]''' Mac OSX / NetBSD / Solaris / Linux / Cross-platform information. 
'''[[Monthly Topic Rotation]]''' Generally related to development of the engine or particular mods. Read before posting on the forums. 
'''[[General Resources]]''' Usable textures, sounds and code snippets by the community, for the community. 
'''[[Associated Development Groups]]''' Teams, Forums and Groups associated with Spring content and code development. 
|}

{|width="100%" style="margin:10px; background:#f9f9f9; padding:5px; border:1px #aaa solid;"
|
This site is put together by the community, which could (read as SHOULD) mean YOU! If you see information missing, or find out new information you think would be helpful, put it in. If you find a spelling mistake or phrase that could be clearer, fix it. If you find yourself doing repeated searches or going back to the [[Special:Allpages|Topic Index]] repeatedly when trying to find out about a particular feature, consider combining articles or linking them to one another. Any contributions you make to this Wiki are in the public domain. [[Help:Editing|Add to the Wiki]]

''"A wiki is a web application that allows users to add content, as on an Internet forum, but also allows anyone to edit the content."''
- [http://en.wikipedia.org/wiki/Wiki Wikipedia.org]
|}
__NOTOC__
__NOEDITSECTION__

If you wish to comment on this page (or the wiki) you need to login and then you can go [http://taspring.clan-sy.com/w/index.php?title=Talk:Main_Page&action=edit&section=new here], and post your thoughts.
[[Category:Spring]]

Main Page

2008-05-15T12:03:25Z

JK:

Development:Main

2008-05-03T03:56:11Z

JK: added note about compilation error of streflop with installed delphi

Outlined below is information on assisting with the development of the Spring source itself.

::NOTE: For information about developing a mod (units, maps, etc.) see the [[Mod Development]] page.

Below you can find information on how to work with the Spring source in the current mainline (Windows platform) if you like to work on another platform (Linux & Mac) please look at the bottem of this page under "Multiplatform development"

==Starting Development==
To start development, you will need
#The latest version of the source
#A good code manipulation program
#Compiling your modified source

== Keep track what others do ==
If you develop with others, you need to know what they do. We have [http://spring.clan-sy.com/fisheye/ fisheye], a very handy SVN helper, and [http://spring.clan-sy.com/websvn/ WebSVN] running on the server.

===Source Code Documentation===
A good place to start is [http://buildbot.no-ip.org/~buildbot/spring/doxygen the source code documentation].

An explanation on how the code is executed in game can be found in the [[Spring Engine Code]]
page.

==Obtaining the Source==
The latest SVN is at: [https://spring.clan-sy.com/svn/spring https://spring.clan-sy.com/svn/spring] 
A hourly updated read-only mirror is available at: svn://caspring.org:3691/

Another option is to manually [http://spring.clan-sy.com/download.php download] it along with the latest released version of the game. However, for serious developers, a better way would be to download the source straight from the subversion (SVN) repository. This will also allow you to make a patch out of the changes you make to the code, and send it to one of the developers with SVN access.

Windows SVN clients : [http://subversion.tigris.org Subversion] (Win32-Console),
[http://www.syntevo.com/smartsvn/index.jsp SmartSVN] (Java) and [http://tortoisesvn.tigris.org TortoiseSVN] (MSI).

Assuming that you are using the Subversion svn client you can download the latest SVN source with one of the following commands:

<code>svn.exe checkout https://spring.clan-sy.com/svn/spring/trunk 
svn.exe checkout svn://caspring.org:3691/trunk</code>

It will create a trunk subdirectory in the directory from where you ran it, which will contain the source code root directory which will be later referred to as /spring

If you're using Git rather than SVN, you need to initialize local repository and fetch using:

<code>git-svn clone https://spring.clan-sy.com/svn/spring
</code>

(this may take a while)

To update your local repository, use:

<code>git-svn fetch https://spring.clan-sy.com/svn/spring
</code>

==Learning C++==
You will need to know C++ to modify or understand Spring's source code. If you are interested in learning C++, see [[Learning_CPP]]

However please note that badly designed code (code created by a C++ novice for example), even if working will likely not be included in the spring code. Spring is a large project, and therefore it is necessary to stay away from hack jobs and create general solutions to problems.

==Setting up your development environment==
You have either to use the SCons build system that is multi platform, or use Microsoft Visual Studio for building spring. See also [[Development_IDEs]] for some more background information about the IDE to choose.

===Visual Studio 8 (2005)===
(possibly the free Express Edition)

* Install the [http://xta.wolfgame.org/SimBase/vclibs.7z vclibs library package]. You need to install this in the /spring directory from the SVN checkout the zipped source. If done right, it will look like:
**/spring/
**/spring/installer
**/spring/rts
**/spring/... other dirs
**/spring/vclibs
* Install the [http://msdn.microsoft.com/directx/sdk/ DirectX SDK]
* Install the PlatformSDK. I got away with unchecking the parts of the PlatformSDK that were obviously not related (IIS, web stuff). Makes for a smaller download. Make '''sure''' the Platform SDK and DirectX SDK are in the VS search/include directories:
* After installing them, open Visual C++. Click Tools >> Options >> Projects and Solutions >> VC++ Directories. Add these entries to the corresponding sections (paths just a reference, yours may be different):
**Include files:
***$(ProgramFiles)\Microsoft DirectX SDK (August 2007)\Include
***$(ProgramFiles)\Microsoft Platform SDK\include
**Library files:
***$(ProgramFiles)\Microsoft DirectX SDK (August 2007)\Lib\x86 (Might need \x64 on a 64-bit platform, I don't know.)
***$(ProgramFiles)\Microsoft Platform SDK\lib
* Open the solution. /spring/rts/build/vstudio8/rts.sln
* Start building (usually you want to select the release/no debug build, debug is really too slow and is used only when you really know what you want to test)
* Select the working directory in the project properties, otherwise spring will not work correctly

===SCONS/MinGW===
Code::Blocks and Dev C++ use MinGW too, so if you are using one of these IDEs, you'll want to follow these instructions too.

*[http://downloads.sourceforge.net/dev-cpp/devcpp-4.9.9.2_setup.exe Dev-C++ Installer]

Get [http://spring.clan-sy.com/dl/spring-mingwlibs-v10.exe the MinGW library package]. Make sure you install it it the checkout directory, so the path is: /spring/mingwlibs. If done right, it will look like:
**/spring/
**/spring/installer
**/spring/rts
**/spring/... other dirs
**/spring/mingwlibs

These programs are a must have if you want to compile Spring with MinGW, so install them now, if you don't have them already.

*[http://www.python.org/ftp/python/2.5.1/python-2.5.1.msi Python 2.5 installer]
*[http://downloads.sourceforge.net/pywin32/pywin32-210.win32-py2.5.exe Python 2.5 win32 extensions installer]
*[http://prdownloads.sourceforge.net/scons/scons-0.96.96.win32.exe Scons 0.96 installer]

Oh, and quick instructions:

* Grab and install the above programs.
* Make sure C:\Python25, C:\Python25\Scripts and C:\Dev-Cpp\bin are in your PATH environment variable. Set environment variables by: Start -> Settings -> Control Panel -> System -> Advanced -> Environment variables (for Windows XP).
* Make sure a MINGDIR environment variable with value C:\Dev-Cpp exists. (change paths where appropriate.)
* Checkout the Spring SVN repository, following the instructions above in obtaining source. (TODO:link)
* Open a console (Start -> Run -> cmd.exe -> Run), cd \where you checked it out in the previous step, if you checked it out on a different drive make sure to change drives with DriveLetter:<enter> first.
* Type scons configure<enter>. Refer to scons --help for options which can be passed to scons configure. Gotchas:
** If you get an error message starting with "EOFError: : env = Environement...", try deleting the file build/scons_signatures.dblite
** If you get an error message stating "ImportError: No module named win32file:", you have probably not installed the python-win32-extensions.
** If all proceeds as intended you will see a message similar to: "Everything seems OK. Run `scons' now to build."
* Type scons<enter> to start the compilation.
** If you have Delphi installed and get an error message that the commandline params "--no-print-directory" & "-C" aren't supported, then you should remove the Delphi dirs from your PATH variable, because scons tried to run the delphi's make.exe instead of using mingw32-make. (this will cause that streflop can't be build!)
* Wait for the compilation to finish, this may take a while.
* Copy datafiles and stuff from official Spring installation to the /spring/game directory (where spring.exe is located, after the compilation finished.)
* Copy missing DLLs from mingwlibs/dll.
* Start developing.

If you are using Linux, refer to the [[SetupGuide]] to build Spring and get it running.

==Development Suggestions==
Before starting to make modifications to the source, take a look at the [[development guidelines]] which outlines some important things to think about. To find something interesting to work on, look at the list of [[example projects]]. You can also check the list of [[whois doing what]] to see what others are doing. If you do edit the code, please add [[Doxygen style comments]] to the code, which will then enhance the source code documentation.

==How to get your code included==
If you create something that you think should be included in the official source tree, you can report a "bug" in [http://spring.clan-sy.com/mantis/ mantis, our BTS]. Add your patch as attachment, and put "[patch]" in front of the subject, so it is easy for us to separate patches from bugs.

It's also considered standard practice to post one's modifications in the [http://spring.clan-sy.com/phpbb/viewforum.php?f=12 development forum] and get feedback.

==Spring Engine TODO list==
There is a TODO list for developers who want to contribute to the engine itself:
[[SpringEngineTODO]]. There is also a [http://spring.clan-sy.com/phpbb/viewforum.php?f=21 feature request forum], which may give you some ideas. Don't be overwhelmed by the sheer number of (silly) requests though!

==Development links==
* [http://planetspring.free.fr/spring/ Automatic installer builds (crosscompiled, mingw)]
* [http://developer.berlios.de/projects/taspring-linux BerliOS project page (OLD)]
* [http://spring.clan-sy.com/mantis Bug Tracking System]
* [http://buildbot.no-ip.org:8010/ Buildbot]
* [https://lists.berlios.de/mailman/listinfo/taspring-linux-commit Commit mailing list]
* [http://spring.clan-sy.com/dl/spring-vc8libs.exe Development libraries for Visual Studio 2005]
* [http://www.unknown-files.net/spring/3839/mingwlibsv10/ Development libraries for MinGW]
* [http://lolut.utbm.info/cgi-bin/mailman/listinfo/taspring-linux Developers mailing list (practically dead, use this forum instead) (DOWN)]
* [http://buildbot.no-ip.org/~buildbot/spring/doxygen Doxygen pages of the latest source (regenerated nightly)]
* [http://spring.clan-sy.com/fisheye Fisheye interface to SVN]
* [http://sourceforge.net/projects/springrts SourceForge project page (OLD)]
* [http://buildbot.no-ip.org/~buildbot/spring/stacktraceTranslator.php StackTrace Translator]
* [https://spring.clan-sy.com/svn/spring/trunk/ Subversion repository]
* [http://spring.clan-sy.com/websvn/listing.php?repname=spring&path=%2F&sc=0 WebSVN]
* [http://spring.clan-sy.com/websvn/log.php?repname=spring&path=%2F&rev=0&sc=0&isdir=1 WebSVN link to "development log"]
* [http://spring.clan-sy.com/websvn/filedetails.php?repname=spring&path=%2Ftrunk%2FDocumentation%2Fchangelog.txt&rev=0&sc=0 WebSVN link to the most recent changelog.txt]

[[Category:Development]] [[Category:Source development]]

Complete Annihilation

2008-05-02T00:31:11Z

JK:

=Features=

==User interface and LuaUI==
*New cursors
*Centers and selects the Comm at startup
*Warns when d-gun is limited
*Shows which units are being transported
*Depicts unit experience with tank icons
*Automatically controls your metal makers for maximum efficiency
*Always see what your factories are building and give the orders quickly with buildbar.
*New button graphics.
*Units reply with speech.

==Gameplay and LuaRules==
*No effective single unit spam (hopefully).
*Kbots and Vehicles are both viable on most maps.
*Arm and Core have a different play style.
*Set at which percentage of remaining health your units will retreat to the nearest Commander or nanotower.
*Pointless micromanagement is not rewarded.
*The Commander can cloak nearby units or toggle the stealth ability, for a hefty energy cost.
*Once you have a factory, you can concentrate on the battle while the your metal extractors, radars or metal makers automatically upgrade themselves.
*Windmill output increases with altitude.
*Sharing with an enemy is disables unless cheat mode is active.
*Unit sharing is delayed to avoid share at last second before death scenarios.
*Lose the resources contained in a storage building when it is destroyed.

==Graphics==
*New models and textures.
*New explosions, weapon and unit effects.
*Play in cartoon mode with the outline widget.
*Higher resolution 3do textures.

=Mutators=

==Deployment Mutator==
Place your units and give orders to them before the game starts: you don't have to wait to use the big guns.

==Tactics Mutator==
Place your units on the battlefield before the game starts then wipe out your enemy. With no economic management, you are free to exercise your tactics.

=Links=

'''Homepage:'''
'''[http://www.caspring.org www.caspring.org]'''

'''Download it here:'''
'''[http://trac.caspring.org/wiki/CaUpdater CA Updater (the easiest & fastest to get CA and Spring maps)]'''

'''[[CA detailed unit guide]]'''

Back to [[Mods]]

[[Category:Mods]]
{{Category:Mods}}

Lua UnsyncedCtrl

2008-04-15T11:00:33Z

JK: there is no loop argument in PlaySoundStream, also shortened the descriptions (this is a documentation not a tutorial)

== Pipes ==
'''Spring.Echo'''
( arg1 [, arg2 [, ... ] ] ) -> nil

Usefull for debugging. Prints values in the spring chat console (hint: the default print() writes to STDIN).

'''Spring.PlaySoundFile'''
( string "soundfile" [, number volume
[, number x, number y, number z ] ] ) -> nil | boolean

Plays WAV sounds. By default, the soundfile is expected to be in the "Sounds" folder.

'''Spring.PlaySoundStream'''
( string "oggfile" [, number volume = 1.0
[, number x, number y, number z ]] ) -> nil | boolean true
Allow you to play an Ogg Vorbis (.OGG) compressed sound file. Note: you may only play _ONE_ stream at a time. If another stream is playing and you try to start a second one the call will fail, and silence will result.

'''Spring.StopSoundStream'''
( ) -> nil
Terminates any SoundStream is running. Since only one may play at any time (see above), this can be used as an interrupt.

== SendMessage ==
'''Spring.SendMessage'''
( string "message" ) -> nil

'''Spring.SendMessageToPlayer'''
( number playerID, string "message" ) -> nil

'''Spring.SendMessageToTeam'''
( number teamID, string "message" ) -> nil

'''Spring.SendMessageToAllyTeam'''
( number allyID, string "message" ) -> nil

'''Spring.SendMessageToSpectators'''
( string "message" ) -> nil

== Unit Selection ==
'''Spring.SelectUnitMap'''
( { [unitID] = anything, ...} [,boolean append] ) -> nil
'''Spring.SelectUnitArray'''
( { [1] = unitID1 , [2] = unitID2 , ...} [,boolean append] ) -> nil

== Unit Control ==
'''Spring.SetUnitNoDraw''' LuaGadgets only!
( number unitID, boolean noDraw ) -> nil
'''Spring.SetUnitNoSelect''' LuaGadgets only!
( number unitID, boolean noSelect ) -> nil
'''Spring.SetUnitNoMinimap''' LuaGadgets only!
( number unitID, boolean noMinimap ) -> nil

== GUI ==
'''Spring.SetDrawSky'''
( boolean drawSky ) -> nil
'''Spring.SetDrawWater'''
( boolean drawWater ) -> nil
'''Spring.SetDrawGround'''
( boolean drawGround ) -> nil

'''Spring.DrawUnitCommands'''
( number unitID ) -> nil
( { [1] = unitID, ... } [, false ] ) -> nil
( { [unitID] = anything, ... }, true ) -> nil

'''Spring.SetTeamColor'''
( number teamID, number r, number g, number b ) -> nil
'''Spring.AssignMouseCursor''' default hotspot is center!
( string "cmdName", string "iconFileName"
[, boolean overwrite [, boolean hotSpotTopLeft] ] ) -> nil | boolean
'''Spring.ReplaceMouseCursor''' default hotspot is center!
( string "oldFileName", string "newFileName" [, boolean hotSpotTopLeft] ) -> nil | boolean

'''Spring.SetCustomCommandDrawData''' register your custom cmd so it gets visible in the unit's cmd queue
( number cmdID,
number cmdIconID | string iconname | nil,
{ number r, number g, number b, number a } [, boolean showArea ] ) -> nil | true

== Camera ==
'''Spring.SetCameraState'''
( table camState, number camTime) -> nil | boolean
camState = {
mode = cameraID,
1 = cameraID,
2 = posX,
3 = posY,
4 = posZ,
5 = dirX,
6 = dirY,
7 = dirZ,
... and more (depending on the camera ...
}

'''Spring.SetCameraTarget'''
( number x, number y, number z [,number transTime] ) -> nil

== World Primitives ==
outdated! use opengl api instead!

'''Spring.AddWorldIcon'''
( number cmdID, number x, number y, number z ) -> nil
'''Spring.AddWorldText'''
( string "text", number x, number y, number z ) -> nil
'''Spring.AddWorldUnit'''
( number unitDefID,
number x, number y, number z,
number team, number facing) -> nil

Lua SyncedRead

2008-03-25T06:36:59Z

JK: /* Mod-/MapoOptions */

== Game ==
=== Special TeamID Variables ===
'''Spring.ALL_UNITS''' 
'''Spring.MY_UNITS''' 
'''Spring.ALLY_UNITS''' 
'''Spring.ENEMY_UNITS'''

'''Spring.GetGaiaTeamID'''
( ) -> number teamID

=== GameStates ===
'''Spring.IsGodModeEnabled'''
( ) -> boolean
'''Spring.IsCheatingEnabled'''
( ) -> boolean
'''Spring.IsDevLuaEnabled'''
( ) -> boolean
'''Spring.IsEditDefsEnabled'''
( ) -> boolean
'''Spring.AreHelperAIsEnabled'''
( ) -> boolean

'''Spring.IsGameOver'''
( ) -> boolean

=== Rules ===
'''Spring.GetRulesInfoMap'''
( ) -> { [key1] = string value1, [key2] = string value2, ... }
( string "key" ) -> string

'''Spring.GetGameRulesParam'''
( number index | string ruleName ) -> number value
'''Spring.GetGameRulesParams'''
( ) -> { [rule1] = number value1, [rule2] = number value2, ... }

'''Spring.GetTeamRulesParam'''
( number teamID, number index | string ruleName ) -> nil | number value
'''Spring.GetTeamRulesParams'''
( number teamID ) -> nil | { [rule1] = number value1, [rule2] = number value2, ... }

'''Spring.GetUnitRulesParam'''
( number unitID, number index | string ruleName ) -> nil | number value
'''Spring.GetUnitRulesParams'''
( number unitID ) -> nil | { [rule1] = number value1, [rule2] = number value2, ... }

=== Mod-/Map-Options ===
'''Spring.GetModOptions'''
( ) -> {} | { "keyName1" = string "value", "keyName2" = string "value", ... }
'''Spring.GetMapOptions'''
( ) -> {} | { "keyName1" = string "value", "keyName2" = string "value", ... }

=== Speed/Time ===
'''Spring.GetGameSpeed'''
( ) -> number userSpeedFactor, number speedFactor, boolean paused
'''Spring.GetGameFrame'''
( ) -> number frameNum%dayFrames, number frameNum/dayFrames
'''Spring.GetGameSeconds'''
( ) -> number seconds

=== Vectors ===
'''Spring.GetWind'''
( ) -> number dirX, number dirY, number dirZ,
number strength, number normDirX, number normDirY, number normDirZ

'''Spring.GetHeadingFromVector'''
( number x, number z ) -> number heading
'''Spring.GetVectorFromHeading'''
( number heading ) -> number x, number z

== Teams ==
=== StartBoxes/StartPositions ===
'''Spring.GetAllyTeamStartBox'''
( number allyID ) -> number xmin, number zmin, number xmax, number zmax
'''Spring.GetTeamStartPosition'''
( number teamID ) -> number x, number y, number z

=== Player,Team,Ally Lists/Info ===
'''Spring.GetPlayerList'''
( [number teamID, boolean onlyActive] ) -> nil | { [1] = number playerID, etc... }
'''Spring.GetTeamList'''
( [number allyTeamID] ) -> nil | { [1] = number teamID, etc... }
'''Spring.GetAllyTeamList'''
( ) -> { [1] = number allyTeamID, etc... }

'''Spring.GetPlayerInfo'''
( number playerID ) ->
nil | string "name",
boolean active,
boolean spectator,
number teamID,
number allyTeamID,
number pingTime,
number cpuUsage,
string country,
number rank
'''Spring.GetPlayerControlledUnit'''
( number playerID ) -> nil | number unitID

'''Spring.GetTeamInfo'''
( number teamID ) ->
nil | number teamNum,
number leader,
boolean isDead,
boolean isAiTeam,
string "side",
number allyTeam
'''Spring.GetTeamResources'''
( number teamID, string "metal" | "energy" ) ->
nil | number currentLevel,
number storage,
number pull,
number income,
number expense,
number share,
number sent,
number received
'''Spring.GetTeamUnitStats'''
( number teamID ) ->
nil | number killed,
number died,
number capturedBy,
number capturedFrom,
number received,
number sent
'''Spring.GetTeamStatsHistory'''
( number teamID, number startTime, number endTime ) ->
{
[1] = {
"frame" = number,
"metalUsed" = number,
"metalProduced" = number,
"metalExcess" = number,
"metalReceived" = number,
"metalSent" = number,
"energyUsed" = number,
"energyProduced" = number,
"energyExcess" = number,
"energyReceived" = number,
"energySent" = number,
"damageDealt" = number,
"damageReceived" = number,
"unitsProduced" = number,
"unitsDied" = number,
"unitsReceived" = number,
"unitsSent" = number,
"unitsCaptured" = number,
"unitsOutCaptured" = number,
"unitsKilled" = number
}, ...
}
'''Spring.GetTeamLuaAI'''
( number teamID ) -> string "luaAI"

=== Teams/PlayersAllied ===
'''Spring.AreTeamsAllied'''
( number teamID1, number teamID2 ) -> nil | boolean
'''Spring.ArePlayersAllied'''
( number playerID1, number playerID2 ) -> nil | boolean

== Units ==
=== GetUnits ===
'''Spring.GetAllUnits'''
( ) -> nil | unitTable = { [1] = number unitID, ... }
'''Spring.GetTeamUnits'''
( number teamID ) -> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetTeamUnitsSorted'''
( number teamID ) -> nil |
unitDefTable = {
[number unitDefID] = { [1] = [number unitID], etc... },
etc...
}
'''Spring.GetTeamUnitsCounts'''
( number teamID ) -> nil | countTable = { [number unitDefID] = count, etc... }
'''Spring.GetTeamUnitsByDefs'''
( number teamID, number unitDefID | { number unitDefID1, ... } )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetTeamUnitDefCount'''
( number teamID, number unitDefID ) -> nil | number count
'''Spring.GetTeamUnitCount'''
( number teamID ) -> nil | number count

'''Spring.GetUnitsInRectangle'''
( number xmin, number zmin, number xmax, number zmax [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInBox'''
( number xmin, number ymin, number zmin,
number xmax, number ymax, number zmax [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInSphere'''
( number x, number y, number z, number radius [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInCylinder'''
( number x, number z, number radius [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInPlanes'''
( planes = { [1] = { number nx, number ny, number nz, number d }, etc... } )
-> nil | unitTable = { [1] = number unitID, etc... }

plane normals point towards accepted space,
so the acceptance criteria for each plane is:
radius = unit radius
px, py, pz = unit position
[(nx * px) + (ny * py) + (nz * pz) + (d - radius)] <= 0


'''Spring.GetUnitNearestAlly'''
( number unitID [, number range ] ) -> nil | number unitID
'''Spring.GetUnitNearestEnemy'''
( number unitID [, number range ] ) -> nil | number unitID

=== Unit Informations ===
'''Spring.GetUnitTooltip'''
( number unitID ) -> nil | string tooltip
'''Spring.GetUnitDefID'''
( number unitID ) -> nil | number unitDefID
'''Spring.GetUnitTeam'''
( number unitID ) -> nil | number teamID
'''Spring.GetUnitAllyTeam'''
( number unitID ) -> nil | number allyID
'''Spring.GetUnitLineage'''
( number unitID ) -> nil | number lineage, boolean lineageRoot
'''Spring.GetUnitNeutral'''
( number unitID ) -> nil | boolean neutral
'''Spring.GetUnitHealth'''
( number unitID ) -> nil | number health, number maxHealth, number paralyzeDamage,
number captureProgress, number buildProgress
'''Spring.GetUnitIsDead'''
( number unitID ) -> nil | boolean dead
'''Spring.GetUnitIsStunned'''
( number unitID ) -> nil | boolean stunned_or_inbuild, boolean stunned, boolean inbuild
'''Spring.GetUnitResources'''
( number unitID ) -> nil | number metalMake, number metalUse,
number energyMake, number energyUse
'''Spring.GetUnitExperience'''
( number unitID ) -> nil | number experience
'''Spring.GetUnitStates'''
( number unitID ) -> nil | {
"firestate" = number,
"movestate" = number,
"repeat" = boolean,
"cloak" = boolean,
"active" = boolean,
"trajectory" = boolean,
["autoland" = boolean,]
["autorepairlevel" = number,]
["loopbackattack" = boolean]
}
'''Spring.GetUnitIsActive'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitIsCloaked'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitSelfDTime'''
( number unitID ) -> nil | number
'''Spring.GetUnitStockpile'''
( number unitID ) -> nil | number numStockpiled, number numStockpileQued,
number buildPercent
'''Spring.GetUnitHeight'''
( number unitID ) -> nil | number
'''Spring.GetUnitRadius'''
( number unitID ) -> nil | number
'''Spring.GetUnitPosition'''
( number unitID ) -> nil | number x, number y, number z
'''Spring.GetUnitBasePosition'''
( number unitID ) -> nil | number x, number y, number z
'''Spring.GetUnitDirection'''
( number unitID ) -> nil | number dx, number dy, number dz
'''Spring.GetUnitHeading'''
( number unitID ) -> nil | number heading
'''Spring.GetUnitVelocity'''
( number unitID ) -> nil | number velx, number vely, number velz
'''Spring.GetUnitBuildFacing'''
( number unitID ) -> nil | number
'''Spring.GetUnitIsBuilding'''
( number unitID ) -> nil | number unitID
'''Spring.GetUnitTransporter'''
( number unitID ) -> nil | number unitID
'''Spring.GetUnitIsTransporting'''
( number unitID ) -> nil | { [1] = number unitID, etc... }
'''Spring.GetUnitShieldState'''
( number unitID ) -> nil | number isEnabled, number curPower
'''Spring.GetUnitWeaponState'''
( number unitID [, number weaponNum] ) -> nil |
boolean angleGood, boolean loaded, number reloadFrame, number salvoLeft, number numStockpiled
'''Spring.GetUnitTravel'''
( number unitID ) -> nil | number travel, number travelPeriod
'''Spring.GetUnitLosState'''
( number unitID [, number allyTeamID ] ) -> nil |
{ ["los" = true] [, "radar" = true] [, "typed" = true] }
'''Spring.GetUnitSeparation''' (returns the distance of 2 units)
( number unitID1, number unitID2 [, boolean 2D ] ) -> nil | number distance
'''Spring.GetUnitDefDimensions'''
( number unitDefID ) -> nil |
{
"height" = number,
"radius" = number,
"midx" = number,
"minx" = number,
"maxx" = number,
"midy" = number,
"miny" = number,
"maxy" = number,
"midz" = number,
"minz" = number,
"maxz" = number
}

=== CommandQueues ===
'''Spring.GetUnitCommands'''
( number unitID [, number count] ) -> nil | commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean
}
}, ...
}
'''Spring.GetCommandQueue''' (same as Spring.GetUnitCommands)
( number unitID [, number count] ) -> nil | commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean
}
}, ...
}
'''Spring.GetFullBuildQueue'''
( number unitID ) ->
nil | buildOrders = {
[1] = { [number unitDefID] = number count }, etc...
}
'''Spring.GetRealBuildQueue''' (cleans the buildqueue of things the unit can't build itself)
( number unitID ) ->
nil | buildOrders = {
[1] = { [number unitDefID] = number count }, etc...
}
'''Spring.GetFactoryCommands'''
( number unitID [, number count] ) -> nil | commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean
}
}, ...
}
'''Spring.GetFactoryCounts''' (used to get the buildqueue of a factory, seems screwed o_O)
( number unitID [, number count [, boolean addCMDs ] ] ) -> nil | commandQueueTable = {
[2] = { [number unitDefID | number -cmdID] = number count }, ...
}

=== Command Descriptions/Buttons ===
'''Spring.GetUnitCmdDescs'''
( number unitID [, number startIndex [, number endIndex ] ] ) -> nil | {
[1] = {
"id" = number,
"type" = number,
"name" = string,
"action" = string,
"tooltip" = string,
"texture" = string,
"cursor" = string,
"hidden" = boolean,
"disabled" = boolean,
"showUnique" = boolean,
"onlyTexture" = boolean,

"params" = { [1] = string, ... }
}, ...
}
'''Spring.FindUnitCmdDesc'''
( number unitID, number cmdID ) -> nil | number index

=== Unit Pieces ===
'''Spring.GetUnitPiecePosition'''
( number unitID, number piece ) -> number posx, number posy, number posz
'''Spring.GetUnitPieceDirection'''
( number unitID, number piece ) -> number dirx, number diry, number dirz
'''Spring.GetUnitPieceMatrix'''
( number unitID, number piece ) -> { [1] = number, ... , [16] = number }
'''Spring.GetUnitPieceList'''
( number unitID ) -> { [1] = string "piecename", ... , [pieceNumN] = string "piecename" }
'''Spring.GetUnitPieceMap'''
( number unitID ) -> { "piecename1" = pieceNum1, ... , "piecenameN" = pieceNumN }
'''Spring.GetUnitPieceInfo'''
( number unitID, number piece ) -> {
"name" = string "piecename",
"isEmpty" = boolean,
"children" = { [1] = string "piecename", ... },
"min" = { [1] = number x, [2] = number y, [3] = number z },
"max" = { [1] = number x, [2] = number y, [3] = number z },
"offset" = { [1] = number x, [2] = number y, [3] = number z },
}
'''Spring.GetUnitScriptPiece'''
( number unitID [, number scriptPiece ] )
-> nil | { scriptPieceNum = number modelPieceNum } | number modelPieceNum

This functions translate the COB ScriptPiece numbers into the ModelPiece numbers (the set of
ScriptPieces is a subset of the ModelPieces, means #ScriptPieces <= #ModelPieces), which
is used in all other functions (the "number piece" means always the modelpiece).
So if you get via Cob2Lua a pieceID you have to translate it with this function.
Btw the COB ScriptPiece number is equal with the piece position in the piece definition
in your cob/bos.
'''Spring.GetUnitScriptNames'''
( number unitID )
-> { "cobpiecename1" = ScriptPieceNum1, ... , "cobpiecenameN" = ScriptPieceNumN }

== Features ==
=== GetFeatures ===
'''Spring.GetFeaturesInRectangle'''
( number xmin, number zmin, number xmax, number zmax [,number teamID] )
-> nil | featureTable = { [1] = number featureID, etc... }
'''Spring.GetAllFeatures'''
( ) -> nil | { [1] = number featureID, ... }
'''Spring.GetFeatureList''' // NOTE: this is not really required, now all FeatureDefs are pre-loaded

=== Feature Informations ===
'''Spring.GetFeatureDefID'''
( number featureID ) -> nil | number featureDefID
'''Spring.GetFeatureTeam'''
( number featureID ) -> nil | number teamID
'''Spring.GetFeatureAllyTeam'''
( number featureID ) -> nil | number allyID
'''Spring.GetFeatureHealth'''
( number featureID ) -> nil | number health, number maxHealth, number resurrectProgress
'''Spring.GetFeatureHeight'''
( number featureID ) -> nil | number
'''Spring.GetFeatureRadius'''
( number featureID ) -> nil | number
'''Spring.GetFeaturePosition'''
( number featureID ) -> nil | number x, number y, number z
'''Spring.GetFeatureDirection'''
( number featureID ) -> nil | number dirx, number diry, number dirz
'''Spring.GetFeatureHeading'''
( number featureID ) -> nil | number heading
'''Spring.GetFeatureResources'''
( number featureID ) -> nil | number RemainingMetal, number maxMetal,
number RemainingEnergy, number maxEnergy, number reclaimLeft
'''Spring.GetFeatureNoSelect'''
( number featureID ) -> nil | boolean noSelect
'''Spring.GetFeatureResurrect'''
( number featureID ) -> nil | string UnitDefName, number buildFacing

== COB ==
'''Spring.GetCOBUnitVar'''
( number unitID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBTeamVar'''
( number teamID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBAllyTeamVar'''
( number allyID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBGlobalVar'''
( integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY

== Ground ==
=== Ground Informations ===
'''Spring.GetGroundHeight'''
( number x, number y ) -> number z
'''Spring.GetGroundOrigHeight'''
( number x, number y ) -> number z
'''Spring.GetGroundNormal'''
( number x, number y ) -> number x, number y, number z
'''Spring.GetGroundInfo'''
( number x, number y ) -> string "Type", number metal, number hardness,
number tankSpeed, number kbotSpeed, number hoverSpeed,
number shipSpeed, boolean receiveTracks
'''Spring.GetGroundBlocked'''
( number x, number y |
number x1, number y1, number x2, number y2 )
-> nil | string "feature", number featureID | string "unit", number unitID
'''Spring.GetGroundExtremes'''
( ) -> nil | number minHeight, number maxHeight

=== Test Building ===
'''Spring.TestBuildOrder'''
( number unitDefID, number x, number y, number z, number facing)
-> number blocking [,number featureID]

blocking can be:
0 - blocked
1 - mobile unit in the way
2 - free (or if featureID is != 0 then with a blocking feature that can be reclaimed)
'''Spring.Pos2BuildPos'''
( number unitDefID, number x, number y, number z ) -> nil | number x, number y, number z

=== PathFinding ===
'''Spring.GetUnitEstimatedPath'''
( number unitID ) -> nil | {
[1] = { x,y,z }, ...
},{
[1] = startIdxOfDetailedPath,
[2] = startIdxOfDetailedEstimatedPath1,
[3] = startIdxOfDetailedEstimatedPath2,
}
GetUnitEstimatedPath() returns 2 tables:
1 table the waypoints and 1 table with indices (in the waypoint table)
when a new (more lazy) pathfinding algorithm begins.
So the waypoint table contains 3 different levels of details.

=== LOS ===
'''Spring.GetPositionLosState'''
( number x, number y, number z [, number allyID] )
-> boolean visible, boolean inLos, boolean inAirLos, boolean inRadar
'''Spring.GetClosestValidPosition''' //NOT FINISHED YET
( number unitDefID, number x, number z, number r ) -> nil

Lua SyncedCtrl

2008-03-18T22:49:09Z

JK: /* Heightmap */

= Resources =
'''Spring.AddTeamResource'''
( number teamID, string "m" | "e", number amount ) -> nil
'''Spring.UseTeamResource'''
( number teamID,
string "m" | "e", number amount |
{ m = number amount, e = number amount}
) -> nil | boolean hadEnough

'''Spring.SetTeamResource'''
( number teamID, string res, number amount ) -> nil

possible values for res are:
"m" = metal
"e" = energy
"ms" = metal storage
"es" = energy storage


'''Spring.SetTeamShareLevel'''
( number teamID, string "m" | "e", number amount ) -> nil

= Unit Handling =
'''Spring.CreateUnit'''
( string "defName",
number x, number y, number z,
(number facing | string "facing"),
number teamID ) -> number unitID

possible values for facing are:
"s" | 0 = south
"e" | 1 = east
"n" | 2 = north
"w" | 3 = west


'''Spring.DestroyUnit'''
( number unitID,
[boolean selfd,]
[boolean reclaimWreckage,]
[number attackerID] ) -> nil

'''Spring.TransferUnit'''
( number unitID,
numer newTeamID,
boolean given ) -> nil

== Unit Control ==
'''Spring.SetUnitCosts'''
( number unitID, {
[ buildTime = number amount ],
[ metalCost = number amount ],
[ energyCost = number amount ]
} ) -> nil

'''Spring.SetUnitTooltip'''
( number unitID, string "tooltip" ) -> nil

'''Spring.SetUnitHealth'''
( number unitID,
number health |
{ [ health = number health ],
[ capture = number capture ],
[ paralyze = number paralyze ],
[ build = number build ] }
) -> nil

'''Spring.SetUnitMaxHealth'''
( number unitID, number maxHealth ) -> nil

'''Spring.AddUnitDamage'''
( number unitID, number damage
[, number paralyze = 0 [, number attackerID = -1 [, number weaponID = -1
[, number impulse_x [, number impulse_y [, number impulse_z ]]] ]]] ) -> nil

'''Spring.SetUnitStockpile'''
( number unitID [, number stockpile [, number buildPercent ]]) -> nil

'''Spring.SetUnitExperience'''
( number unitID, number experience ) -> nil

'''Spring.SetUnitCloak'''
( number unitID,
boolean cloaked | number scriptCloak,
[ number decloakDistance | boolean decloakAbs ] ) -> nil


If the 2nd argument is a number, the value works like this:
1:=normal cloak
2:=for free cloak (cost no E)
3:=for free + no decloaking (except the unit is stunned)
4>=ultimative cloak (no ecost, no decloaking, no stunned decloak)

The decloak distance is only changed if the 3th argument is a number or a boolean.
If the boolean is false it takes the default decloak distance for that unitdef,
if the boolean is true it takes the absolute value of it.

'''Spring.SetUnitStealth'''
( number unitID, boolean stealth ) -> nil

'''Spring.SetUnitLineage'''
( number unitID, number teamID [, boolean isRoot] ) -> nil

'''Spring.SetUnitNeutral'''
( number unitID, boolean neutral ) -> nil

'''Spring.SetUnitTarget'''
( number unitID,
number enemyUnitID | number x, number y, number z,
[ boolean dgun = false ] ) -> nil

'''Spring.SetUnitAlwaysVisible'''
( number unitID, boolean alwaysVisible ) -> nil

'''Spring.SetUnitBlocking'''
( number unitID, boolean noBlock) -> nil

'''Spring.SetUnitMetalExtraction'''
( number unitID, number depth [,number range] ) -> nil

'''Spring.SetUnitBuildSpeed'''
( number builderID,
number buildSpeed, [ number repairSpeed [, number reclaimSpeed
[,number resurrectSpeed [, number captureSpeed [, number terraformSpeed ]] ]]] ) -> nil

'''Spring.SetUnitShieldState'''
( number unitID, boolean enabled [, number power] ) -> nil

'''Spring.SetUnitWeaponState'''
( number unitID, number weaponNum, table states ) -> nil

format of the states table:
{
["reloadstate" = number value,]
["reloadtime" = number value,]
["accuracy" = number value,]
["sprayangle" = number value,]
["range" = number value,]
["projectilespeed" = number value,]
}

'''Spring.SetUnitTravel'''
( number unitID, number travel [, number travelPeriod] ) -> nil

'''Spring.SetUnitMoveGoal''' used by default commands to get in build-,attackrange etc.
( number unitID, number x, number y, number z,
[, number radius = 0 [, number speed = unit->maxSpeed * 2 ] ] ) -> nil

'''Spring.SetUnitPhysics'''
( number unitID,
number posx, number posy, number posz,
number velx, number vely, number velz,
number rotx, number roty, number rotz,
) -> nil

'''Spring.SetUnitPosition'''
( number unitID, number x, number z [, boolean alwaysAboveSea] ) -> nil

'''Spring.SetUnitVelocity'''
( number unitID, number velx, number vely, number velz ) -> nil

'''Spring.SetUnitRotation'''
( number unitID, number rotx, number roty, number rotz ) -> nil

'''Spring.AddUnitImpulse'''
( number unitID, number x, number y, number z ) -> nil

== Unit Ressourcing ==
'''Spring.SetUnitResourcing'''
( number unitID,
string res, number amount |
{ res = number amount, ... }
) -> nil

possible values for res are: "[u|c][u|m][m|e]"
unconditional | conditional
use | make
metal | energy


'''Spring.AddUnitResource'''
( number unitID, string "m" | "e", number amount ) -> nil

'''Spring.UseUnitResource'''
( number unitID, string "m" | "e", number amount ) -> nil

= Feature Handling =
'''Spring.CreateFeature'''
( string "defName", number x, number y, number z
[,number heading [, number AllyTeamID ]] ) -> number featureID

'''Spring.DestroyFeature'''
( number featureID ) -> nil

'''Spring.TransferFeature'''
( number featureID, number AllyTeamID ) -> nil

== Feature Control ==
'''Spring.SetFeatureHealth'''
( number featureID, number health) -> nil

'''Spring.SetFeatureReclaim'''
( number featureID, number reclaimLeft) -> nil

'''Spring.SetFeatureResurrect'''
( number featureID, string "UnitDefName?" [, number facing | string "facing" ] ) -> nil

possible string values for facing are:
"s" = south
"e" = east
"n" = north
"w" = west


'''Spring.SetFeaturePosition'''
( number featureID, number x, number y, number z ) -> nil

'''Spring.SetFeatureDirection'''
( number featureID, number x, number y, number z ) -> nil

'''Spring.SetFeatureNoSelect'''
( number featureID, boolean noSelect ) -> nil

'''Spring.RemoveBuildingDecal'''
( number unitID ) -> nil

= Lua to COB =
'''Spring.CallCOBScript'''
( number unitID, number funcID | string funcName, number retArgs, COBArg1, COBArg2, ... )
-> nil | number returnValue, number retArg1, number retArg2, ...

'''Spring.CallCOBScriptCB'''
( number unitID, number funcID | string funcName, number retArgs, COBArg1, COBArg2, ... )
-> nil | number returnValue, number CallbackData, number retArg1, number retArg2, ...

'''Spring.GetCOBScriptID'''
( number unitID, string funcName ) -> nil | number funcID

'''Spring.GetUnitCOBValue'''
( number unitID [, boolean splitData=false], number COBValue
[, number param1 [,number param2 [, number param3 [, number param4 ] ] ] ] )
-> number result | number result1, number result2
'''Spring.SetUnitCOBValue'''
( number unitID, number COBValue, number param1 [,number param2] ) -> nil

= Give Order =
'''Spring.GiveOrderToUnit'''
( number unitID,
number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"} ) -> nil

'''Spring.GiveOrderToUnitMap'''
( unitMap = { [unitID] = dontCare, etc... },
number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"} ) -> nil

'''Spring.GiveOrderToUnitArray'''
( unitArray = { [1] = unitID, etc... },
number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"} ) -> nil

'''Spring.GiveOrderArrayToUnitMap'''
( unitMap = { [number unitID] = dontCare, etc... },
orderArray = {
{ number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"}
}, ..
}
) -> nil

'''Spring.GiveOrderArrayToUnitArray'''
( unitArray = { [1] = number unitID, etc... },
orderArray = {
{ number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"}
}, ..
}
) -> nil

= Heightmap =
'''Spring.LevelHeightMap'''
( number x1, number z1 [, number x2, number z2], number height ) -> nil

'''Spring.AdjustHeightMap''' (heightmap[x][z] += height;)
( number x1, number z1 [, number x2, number z2], number height ) -> nil

'''Spring.RevertHeightMap'''
( number x1, number z1 [, number x2, number z2], number origFactor ) -> nil

= Command Descriptions =
Doesn't work in unsynced code. 

'''Spring.EditUnitCmdDesc'''
( number unitID, number cmdDescID, table cmdArray ) -> nil

structure of cmdArray:
{
[ id = int ],
[ type = int ],
[ name = string ],
[ action = string ],
[ tooltip = string ],
[ texture = string ],
[ cursor = string ],
[ hidden = boolean ],
[ disabled = boolean ],
[ showUnique = boolean ],
[ onlyTexture = boolean ],
[ params = { string = string, ... } ]
}


'''Spring.InsertUnitCmdDesc'''
( number unitID [, number cmdDescID ] , table cmdArray ) -> nil

'''Spring.RemoveUnitCmdDesc'''
( number unitID [, number cmdDescID ] ) -> nil

= Other =
'''Spring.SetNoPause'''
( boolean noPause ) -> nil

'''Spring.SetUnitToFeature'''
( boolean tofeature ) -> nil

'''Spring.SetExperienceGrade'''
( number expGrade
[, number ExpPowerScale [, number ExpHealthScale [, number ExpReloadScale ]]] ) -> nil

expGrade defines how often UnitExperience() will be called,
it is based on the following equation:
(int) [exp/(exp+1)] / expGrade
If this integer differs from the one before the experience change
it will call UnitExperience().
Also those 3 last params are only available in .cheat

Lua Scream

2008-03-17T19:15:43Z

JK: /* Scream UserData Object */

== Scream UserData Object ==
'''Script.CreateScream'''
( ) -> nil

This creates an userdata object, which calls a special
user-defined function, when the object gets destroyed
(->garbage collector).
You use it like the follow:

'''local myScream = Script.CreateScream()'''
'''myScream.func = function() Spring.Echo("AHHHHHH") end'''

Lua SyncedCtrl

2008-03-15T04:04:15Z

JK: it is LuaUI and LuaGadgets (synced) only

= Resources =
'''Spring.AddTeamResource'''
( number teamID, string "m" | "e", number amount ) -> nil
'''Spring.UseTeamResource'''
( number teamID,
string "m" | "e", number amount |
{ m = number amount, e = number amount}
) -> nil | boolean hadEnough

'''Spring.SetTeamResource'''
( number teamID, string res, number amount ) -> nil

possible values for res are:
"m" = metal
"e" = energy
"ms" = metal storage
"es" = energy storage


'''Spring.SetTeamShareLevel'''
( number teamID, string "m" | "e", number amount ) -> nil

= Unit Handling =
'''Spring.CreateUnit'''
( string "defName",
number x, number y, number z,
(number facing | string "facing"),
number teamID ) -> number unitID

possible values for facing are:
"s" | 0 = south
"e" | 1 = east
"n" | 2 = north
"w" | 3 = west


'''Spring.DestroyUnit'''
( number unitID,
[boolean selfd,]
[boolean reclaimWreckage,]
[number attackerID] ) -> nil

'''Spring.TransferUnit'''
( number unitID,
numer newTeamID,
boolean given ) -> nil

== Unit Control ==
'''Spring.SetUnitCosts'''
( number unitID, {
[ buildTime = number amount ],
[ metalCost = number amount ],
[ energyCost = number amount ]
} ) -> nil

'''Spring.SetUnitTooltip'''
( number unitID, string "tooltip" ) -> nil

'''Spring.SetUnitHealth'''
( number unitID,
number health |
{ [ health = number health ],
[ capture = number capture ],
[ paralyze = number paralyze ],
[ build = number build ] }
) -> nil

'''Spring.SetUnitMaxHealth'''
( number unitID, number maxHealth ) -> nil

'''Spring.AddUnitDamage'''
( number unitID, number damage
[, number paralyze = 0 [, number attackerID = -1 [, number weaponID = -1
[, number impulse_x [, number impulse_y [, number impulse_z ]]] ]]] ) -> nil

'''Spring.SetUnitStockpile'''
( number unitID [, number stockpile [, number buildPercent ]]) -> nil

'''Spring.SetUnitExperience'''
( number unitID, number experience ) -> nil

'''Spring.SetUnitCloak'''
( number unitID,
boolean cloaked | number scriptCloak,
[ number decloakDistance | boolean decloakAbs ] ) -> nil


If the 2nd argument is a number, the value works like this:
1:=normal cloak
2:=for free cloak (cost no E)
3:=for free + no decloaking (except the unit is stunned)
4>=ultimative cloak (no ecost, no decloaking, no stunned decloak)

The decloak distance is only changed if the 3th argument is a number or a boolean.
If the boolean is false it takes the default decloak distance for that unitdef,
if the boolean is true it takes the absolute value of it.

'''Spring.SetUnitStealth'''
( number unitID, boolean stealth ) -> nil

'''Spring.SetUnitLineage'''
( number unitID, number teamID [, boolean isRoot] ) -> nil

'''Spring.SetUnitNeutral'''
( number unitID, boolean neutral ) -> nil

'''Spring.SetUnitTarget'''
( number unitID,
number enemyUnitID | number x, number y, number z,
[ boolean dgun = false ] ) -> nil

'''Spring.SetUnitAlwaysVisible'''
( number unitID, boolean alwaysVisible ) -> nil

'''Spring.SetUnitBlocking'''
( number unitID, boolean noBlock) -> nil

'''Spring.SetUnitMetalExtraction'''
( number unitID, number depth [,number range] ) -> nil

'''Spring.SetUnitBuildSpeed'''
( number builderID,
number buildSpeed, [ number repairSpeed [, number reclaimSpeed
[,number resurrectSpeed [, number captureSpeed [, number terraformSpeed ]] ]]] ) -> nil

'''Spring.SetUnitShieldState'''
( number unitID, boolean enabled [, number power] ) -> nil

'''Spring.SetUnitWeaponState'''
( number unitID, number weaponNum, table states ) -> nil

format of the states table:
{
["reloadstate" = number value,]
["reloadtime" = number value,]
["accuracy" = number value,]
["sprayangle" = number value,]
["range" = number value,]
["projectilespeed" = number value,]
}

'''Spring.SetUnitTravel'''
( number unitID, number travel [, number travelPeriod] ) -> nil

'''Spring.SetUnitMoveGoal''' used by default commands to get in build-,attackrange etc.
( number unitID, number x, number y, number z,
[, number radius = 0 [, number speed = unit->maxSpeed * 2 ] ] ) -> nil

'''Spring.SetUnitPhysics'''
( number unitID,
number posx, number posy, number posz,
number velx, number vely, number velz,
number rotx, number roty, number rotz,
) -> nil

'''Spring.SetUnitPosition'''
( number unitID, number x, number z [, boolean alwaysAboveSea] ) -> nil

'''Spring.SetUnitVelocity'''
( number unitID, number velx, number vely, number velz ) -> nil

'''Spring.SetUnitRotation'''
( number unitID, number rotx, number roty, number rotz ) -> nil

'''Spring.AddUnitImpulse'''
( number unitID, number x, number y, number z ) -> nil

== Unit Ressourcing ==
'''Spring.SetUnitResourcing'''
( number unitID,
string res, number amount |
{ res = number amount, ... }
) -> nil

possible values for res are: "[u|c][u|m][m|e]"
unconditional | conditional
use | make
metal | energy


'''Spring.AddUnitResource'''
( number unitID, string "m" | "e", number amount ) -> nil

'''Spring.UseUnitResource'''
( number unitID, string "m" | "e", number amount ) -> nil

= Feature Handling =
'''Spring.CreateFeature'''
( string "defName", number x, number y, number z
[,number heading [, number AllyTeamID ]] ) -> number featureID

'''Spring.DestroyFeature'''
( number featureID ) -> nil

'''Spring.TransferFeature'''
( number featureID, number AllyTeamID ) -> nil

== Feature Control ==
'''Spring.SetFeatureHealth'''
( number featureID, number health) -> nil

'''Spring.SetFeatureReclaim'''
( number featureID, number reclaimLeft) -> nil

'''Spring.SetFeatureResurrect'''
( number featureID, string "UnitDefName?" [, number facing | string "facing" ] ) -> nil

possible string values for facing are:
"s" = south
"e" = east
"n" = north
"w" = west


'''Spring.SetFeaturePosition'''
( number featureID, number x, number y, number z ) -> nil

'''Spring.SetFeatureDirection'''
( number featureID, number x, number y, number z ) -> nil

'''Spring.SetFeatureNoSelect'''
( number featureID, boolean noSelect ) -> nil

'''Spring.RemoveBuildingDecal'''
( number unitID ) -> nil

= Lua to COB =
'''Spring.CallCOBScript'''
( number unitID, number funcID | string funcName, number retArgs, COBArg1, COBArg2, ... )
-> nil | number returnValue, number retArg1, number retArg2, ...

'''Spring.CallCOBScriptCB'''
( number unitID, number funcID | string funcName, number retArgs, COBArg1, COBArg2, ... )
-> nil | number returnValue, number CallbackData, number retArg1, number retArg2, ...

'''Spring.GetCOBScriptID'''
( number unitID, string funcName ) -> nil | number funcID

'''Spring.GetUnitCOBValue'''
( number unitID [, boolean splitData=false], number COBValue
[, number param1 [,number param2 [, number param3 [, number param4 ] ] ] ] )
-> number result | number result1, number result2
'''Spring.SetUnitCOBValue'''
( number unitID, number COBValue, number param1 [,number param2] ) -> nil

= Give Order =
'''Spring.GiveOrderToUnit'''
( number unitID,
number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"} ) -> nil

'''Spring.GiveOrderToUnitMap'''
( unitMap = { [unitID] = dontCare, etc... },
number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"} ) -> nil

'''Spring.GiveOrderToUnitArray'''
( unitArray = { [1] = unitID, etc... },
number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"} ) -> nil

'''Spring.GiveOrderArrayToUnitMap'''
( unitMap = { [number unitID] = dontCare, etc... },
orderArray = {
{ number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"}
}, ..
}
) -> nil

'''Spring.GiveOrderArrayToUnitArray'''
( unitArray = { [1] = number unitID, etc... },
orderArray = {
{ number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"}
}, ..
}
) -> nil

= Heightmap =
'''Spring.LevelHeightMap'''
( number x1, number z1 [, number x2, number z2], number height ) -> nil

'''Spring.AdjustHeightMap'''
( number x1, number z1 [, number x2, number z2], number height ) -> nil

'''Spring.RevertHeightMap'''
( number x1, number z1 [, number x2, number z2], number origFactor ) -> nil

= Command Descriptions =
Doesn't work in unsynced code. 

'''Spring.EditUnitCmdDesc'''
( number unitID, number cmdDescID, table cmdArray ) -> nil

structure of cmdArray:
{
[ id = int ],
[ type = int ],
[ name = string ],
[ action = string ],
[ tooltip = string ],
[ texture = string ],
[ cursor = string ],
[ hidden = boolean ],
[ disabled = boolean ],
[ showUnique = boolean ],
[ onlyTexture = boolean ],
[ params = { string = string, ... } ]
}


'''Spring.InsertUnitCmdDesc'''
( number unitID [, number cmdDescID ] , table cmdArray ) -> nil

'''Spring.RemoveUnitCmdDesc'''
( number unitID [, number cmdDescID ] ) -> nil

= Other =
'''Spring.SetNoPause'''
( boolean noPause ) -> nil

'''Spring.SetUnitToFeature'''
( boolean tofeature ) -> nil

'''Spring.SetExperienceGrade'''
( number expGrade
[, number ExpPowerScale [, number ExpHealthScale [, number ExpReloadScale ]]] ) -> nil

expGrade defines how often UnitExperience() will be called,
it is based on the following equation:
(int) [exp/(exp+1)] / expGrade
If this integer differs from the one before the experience change
it will call UnitExperience().
Also those 3 last params are only available in .cheat

Lua CMDs

2008-03-12T15:55:41Z

JK: /* Commands */

== Options ==
'''CMD.OPT_ALT''' 
'''CMD.OPT_CTRL''' 
'''CMD.OPT_SHIFT''' 
'''CMD.OPT_RIGHT''' 
'''CMD.OPT_INTERNAL'''

== Waitcodes ==
'''CMD.WAITCODE_TIME''' 
'''CMD.WAITCODE_DEATH''' 
'''CMD.WAITCODE_SQUAD''' 
'''CMD.WAITCODE_GATHER'''

== Insert/Remove Commands ==
First, said "tags" are unique command identifiers, so each command that gets inserted into a unit's command
queue gets its unique "tag" number. (It is used to ''sync'' command queue operations, also it makes things much easier.) 
To receive those "tags" you can do the following:
local cmdQueue = Spring.GetUnitCommands(unitID);
if (#cmdQueue>0) then
local cmdTag = cmdQueue[1].tag
..
end

'''CMD.INSERT'''
options.ALT -> treat param0 as a position instead of a tag
options.CONTROL -> use the build queue for factories
params[0] = command tag or position (negative numbers to reference the back of the queue)
params[1] = insertCmd id
params[2] = insertCmd options (shift,alt,right click,etc.)
params[3 ... N+2] = insertCmd params[0 ... N-1]

example:
Spring.GiveOrderToUnit(unitID,
CMD.INSERT,
{-1,CMD.ATTACK,''CMD.OPT_SHIFT'',''unitID2''},
{"alt"}
);

Note: If you didn't already noticed, the command params and
the command options are twisted in the array (compared to GiverOrder)!

Note2: The command options in the array/table is a number value!
You have to use CMD.OPT_* in this case.

'''CMD.REMOVE'''
options.ALT -> use the parameters as commandIDs
options.CONTROL -> use the build queue for factories
params[0 ... N-1] = tags or commandIDs to remove

== Commands ==
Note, the CMD[] table is bidirectional. That means: CMD[CMD.STOP] := "CMD_STOP"

'''CMD.STOP'''
type CMDTYPE.ICON
'''CMD.WAIT'''
type CMDTYPE.ICON
'''CMD.TIMEWAIT'''
type CMDTYPE.NUMBER
'''CMD.DEATHWAIT'''
type CMDTYPE.ICON_UNIT_OR_RECTANGLE
'''CMD.SQUADWAIT'''
type CMDTYPE.NUMBER
'''CMD.GATHERWAIT'''
type CMDTYPE.ICON
'''CMD.MOVE'''
type CMDTYPE.ICON_MAP
'''CMD.PATROL'''
type CMDTYPE.ICON_MAP
'''CMD.FIGHT'''
type CMDTYPE.ICON_MAP
'''CMD.ATTACK'''
type CMDTYPE.ICON_UNIT_OR_MAP
'''CMD.AREA_ATTACK'''
type CMDTYPE.ICON_AREA
'''CMD.GUARD'''
type CMDTYPE.ICON_UNIT
'''CMD.AISELECT'''
type CMDTYPE.COMBO_BOX
'''CMD.GROUPSELECT'''
type CMDTYPE.ICON
'''CMD.GROUPADD'''
type CMDTYPE.ICON
'''CMD.GROUPCLEAR'''
type CMDTYPE.ICON
'''CMD.REPAIR'''
type CMDTYPE.ICON_UNIT_OR_AREA
'''CMD.FIRE_STATE'''
type CMDTYPE.ICON_MODE
'''CMD.MOVE_STATE'''
type CMDTYPE.ICON_MODE
'''CMD.SELFD'''
type CMDTYPE.ICON
'''CMD.LOAD_UNITS'''
type CMDTYPE.ICON_UNIT_OR_AREA
'''CMD.LOAD_ONTO'''
type CMDTYPE.ICON_UNIT
'''CMD.UNLOAD_UNITS'''
type CMDTYPE.ICON_UNIT_OR_AREA
'''CMD.UNLOAD_UNIT'''
type CMDTYPE.ICON_MAP
'''CMD.ONOFF'''
type CMDTYPE.ICON_MODE
'''CMD.RECLAIM'''
type CMDTYPE.ICON_UNIT_FEATURE_OR_AREA
'''CMD.CLOAK'''
type CMDTYPE.ICON_MODE
'''CMD.STOCKPILE'''
type CMDTYPE.ICON
'''CMD.DGUN'''
type CMDTYPE.ICON_MAP
'''CMD.RESTORE'''
type CMDTYPE.ICON_AREA
'''CMD.REPEAT'''
type CMDTYPE.ICON_MODE
'''CMD.TRAJECTORY'''
type CMDTYPE.ICON_MODE
'''CMD.RESURRECT'''
type CMDTYPE.ICON_UNIT_FEATURE_OR_AREA
'''CMD.CAPTURE'''
type CMDTYPE.ICON_UNIT_OR_AREA
'''CMD.AUTOREPAIRLEVEL'''
type CMDTYPE.ICON_MODE
'''CMD.LOOPBACKATTACK'''
type CMDTYPE.ICON_MODE
'''CMD.IDLEMODE'''
type CMDTYPE.ICON_MODE
'''CMD.SET_WANTED_MAX_SPEED'''
type CMDTYPE.NUMBER
'''CMD.SETBASE'''

'''CMD.INTERNAL'''
used in different ways

== CommandTypes ==
Note, the CMDTYPE[] table is bidirectional. That means: CMDTYPE[CMDTYPE.ICON] := "CMDTYPE_ICON"

'''CMDTYPE.ICON'''
expect 0 parameters in return
'''CMDTYPE.ICON_MODE'''
expect 1 parameter in return (number selected mode)
'''CMDTYPE.ICON_MAP'''
expect 3 parameters in return (mappos)
'''CMDTYPE.ICON_AREA'''
expect 4 parameters in return (mappos+radius)
'''CMDTYPE.ICON_UNIT'''
expect 1 parameters in return (unitid)
'''CMDTYPE.ICON_UNIT_OR_MAP'''
expect 1 parameters in return (unitid) or 3 parameters in return (mappos)
'''CMDTYPE.ICON_FRONT'''
expect 3 or 6 parameters in return (middle and right side of front if a front was defined)
'''CMDTYPE.COMBO_BOX'''
expect 1 parameter in return (number selected option)
'''CMDTYPE.ICON_UNIT_OR_AREA'''
expect 1 parameter in return (unitid) or 4 parameters in return (mappos+radius)
'''CMDTYPE.ICON_UNIT_FEATURE_OR_AREA'''
expect 1 parameter in return (unitid or featureid+MAX_UNITS (id>MAX_UNITS=feature))
or 4 parameters in return (mappos+radius)
'''CMDTYPE.ICON_BUILDING'''
expect 3 parameters in return (mappos)
'''CMDTYPE.ICON_UNIT_OR_RECTANGLE'''
expect 1 parameter in return (unitid)
or 3 parameters in return (mappos)
or 6 parameters in return (startpos+endpos)
'''CMDTYPE.NUMBER'''
expect 1 parameter in return (number)

'''CMDTYPE.CUSTOM'''
used with CMD_INTERNAL
'''CMDTYPE.NEXT''' next command page
used with CMD_INTERNAL
'''CMDTYPE.PREV''' previous command page
used with CMD_INTERNAL