Spring - User contributions [en]

Lua CMDs

2018-04-15T10:34:17Z

Kingraptor: /* IDs */

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

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

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

== Insert/Remove Commands ==
To get the commandqueue use the following lua-call

=== CommandQueues ===
'''Spring.GetUnitCommands''' 
'''Spring.GetCommandQueue''' (Alias)
( number unitID, number count = 0 ) -> nil | number commandQueueSize {{new|96}}
( number unitID [, number count = -1] )
-> nil | table commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean,
"meta" = boolean
}
}, ...
}

First, said "tags" aka "id" 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.)
Editors Note: I fucking hate it when open source devs use the word easy. It is a clear indicator that someone spends a whole day finding out about a well hidden simple concept. Well at least we are on this journey together :)
 
To look at those "tags" you can do the following:
local cmdQueue = Spring.GetUnitCommands(unitID);
if (#cmdQueue>0) then
local cmdTag = cmdQueue[1].tag
Spring.Echo(cmdTag)
..
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 and 0 the first)
params[1] = insertCmd id
params[2] = insertCmd options (shift,alt,right click,etc.)
params[3 ... N+2] = insertCmd params[0 ... N-1]

Example:
<syntaxhighlight lang="lua">
Spring.GiveOrderToUnit(unitID,
CMD.INSERT,
{-1,CMD.ATTACK,''CMD.OPT_SHIFT'',''unitID2''},
{"alt"}
);
</syntaxhighlight>

Command structure dissection:

'''What to do with the command - in our case insert:'''

'CMD.INSERT'

'''Place in the queue to insert:'''

'-1'

'''Type of command to insert:'''

'CMD.ATTACK'

'''Additional Information:'''

If the unit is working down a shift queue, add it seemless into it

'CMD.OPT_SHIFT'

'''TargetID or Position:'''

'unitID2'

'''The '-1' is the queue position and not a tag:'''

'{"alt"}'

if you insert cmd in pos 2 for example the rest of commands starting
from 2 will be pushed back.
Ilustration: {cmdA, cmdB, cmdC, cmdD} => {cmdA, cmdB, NewCmd, cmdC, cmdD}


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

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

Note3: The inserted command doesn't go through allowcommand callins, only CMD.INSERT does.

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

No clues what the above mean translated, but here is a working example of how to delete a buildorder from a factory:
<syntaxhighlight lang="lua">
local facCmds = Spring.GetFactoryCommands(factoryID)

if facCmds then -- nil check
local cmd = facCmds[1]
Spring.GiveOrderToUnit(factoryID, CMD.REMOVE, {i,cmd.tag}, {"ctrl"})
end
</syntaxhighlight>

== 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

A negative number means build command 
The number is -unitDefID of the unittype that this command orders to be built.
This means that build orders have no convenient CMD._____ string.
The command id for build orders must always be a "minus" sign appended to an integer value.
Spring.GiveOrderToUnit(unitID, -(unitDefID), {x,y,z(,facing)}, {"shift"})
alternatively:
Spring.GiveOrderToUnit(unitID, -UnitDefNames["unitname"].id, {x,y,z(,facing)}, {"shift"})
'facing' is an optional integer parameter that controls unit's facing when placed.
The values of (x,y,z) must all be number values (like the number "0"), or the build order will break.

== 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

== IDs ==
Below is a table of all CMD table entries and their IDs:

{|class="wikitable sortable"
!Command||ID
|-
|FIRESTATE_NONE||-1
|-
|MOVESTATE_NONE||-1
|-
|STOP||0
|-
|MOVESTATE_HOLDPOS||0
|-
|FIRESTATE_HOLDFIRE||0
|-
|INSERT||1
|-
|MOVESTATE_MANEUVER||1
|-
|FIRESTATE_RETURNFIRE||1
|-
|WAITCODE_TIME||1
|-
|WAITCODE_DEATH||2
|-
|MOVESTATE_ROAM||2
|-
|REMOVE||2
|-
|FIRESTATE_FIREATWILL||2
|-
|FIRESTATE_FIREATNEUTRAL||3
|-
|WAITCODE_SQUAD||3
|-
|OPT_META||4
|-
|WAITCODE_GATHER||4
|-
|WAIT||5
|-
|TIMEWAIT||6
|-
|DEATHWAIT||7
|-
|OPT_INTERNAL||8
|-
|SQUADWAIT||8
|-
|GATHERWAIT||9
|-
|MOVE||10
|-
|PATROL||15
|-
|FIGHT||16
|-
|OPT_RIGHT||16
|-
|LOOPBACKATTACK||20
|-
|ATTACK||20
|-
|AREA_ATTACK||21
|-
|GUARD||25
|-
|AISELECT||30
|-
|OPT_SHIFT||32
|-
|GROUPSELECT||35
|-
|GROUPADD||36
|-
|GROUPCLEAR||37
|-
|REPAIR||40
|-
|FIRE_STATE||45
|-
|MOVE_STATE||50
|-
|SETBASE||55
|-
|INTERNAL||60
|-
|OPT_CTRL||64
|-
|SELFD||65
|-
|SET_WANTED_MAX_SPEED||70
|-
|LOAD_UNITS||75
|-
|LOAD_ONTO||76
|-
|UNLOAD_UNITS||80
|-
|UNLOAD_UNIT||81
|-
|ONOFF||85
|-
|RECLAIM||90
|-
|CLOAK||95
|-
|STOCKPILE||100
|-
|MANUALFIRE||105
|-
|DGUN||105
|-
|RESTORE||110
|-
|REPEAT||115
|-
|TRAJECTORY||120
|-
|RESURRECT||125
|-
|OPT_ALT||128
|-
|CAPTURE||130
|-
|AUTOREPAIRLEVEL||135
|-
|IDLEMODE||145
|-
|}

[[category: Lua]]

Lua CMDs

2018-04-15T10:33:47Z

Kingraptor: Add ID table

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

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

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

== Insert/Remove Commands ==
To get the commandqueue use the following lua-call

=== CommandQueues ===
'''Spring.GetUnitCommands''' 
'''Spring.GetCommandQueue''' (Alias)
( number unitID, number count = 0 ) -> nil | number commandQueueSize {{new|96}}
( number unitID [, number count = -1] )
-> nil | table commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean,
"meta" = boolean
}
}, ...
}

First, said "tags" aka "id" 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.)
Editors Note: I fucking hate it when open source devs use the word easy. It is a clear indicator that someone spends a whole day finding out about a well hidden simple concept. Well at least we are on this journey together :)
 
To look at those "tags" you can do the following:
local cmdQueue = Spring.GetUnitCommands(unitID);
if (#cmdQueue>0) then
local cmdTag = cmdQueue[1].tag
Spring.Echo(cmdTag)
..
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 and 0 the first)
params[1] = insertCmd id
params[2] = insertCmd options (shift,alt,right click,etc.)
params[3 ... N+2] = insertCmd params[0 ... N-1]

Example:
<syntaxhighlight lang="lua">
Spring.GiveOrderToUnit(unitID,
CMD.INSERT,
{-1,CMD.ATTACK,''CMD.OPT_SHIFT'',''unitID2''},
{"alt"}
);
</syntaxhighlight>

Command structure dissection:

'''What to do with the command - in our case insert:'''

'CMD.INSERT'

'''Place in the queue to insert:'''

'-1'

'''Type of command to insert:'''

'CMD.ATTACK'

'''Additional Information:'''

If the unit is working down a shift queue, add it seemless into it

'CMD.OPT_SHIFT'

'''TargetID or Position:'''

'unitID2'

'''The '-1' is the queue position and not a tag:'''

'{"alt"}'

if you insert cmd in pos 2 for example the rest of commands starting
from 2 will be pushed back.
Ilustration: {cmdA, cmdB, cmdC, cmdD} => {cmdA, cmdB, NewCmd, cmdC, cmdD}


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

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

Note3: The inserted command doesn't go through allowcommand callins, only CMD.INSERT does.

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

No clues what the above mean translated, but here is a working example of how to delete a buildorder from a factory:
<syntaxhighlight lang="lua">
local facCmds = Spring.GetFactoryCommands(factoryID)

if facCmds then -- nil check
local cmd = facCmds[1]
Spring.GiveOrderToUnit(factoryID, CMD.REMOVE, {i,cmd.tag}, {"ctrl"})
end
</syntaxhighlight>

== 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

A negative number means build command 
The number is -unitDefID of the unittype that this command orders to be built.
This means that build orders have no convenient CMD._____ string.
The command id for build orders must always be a "minus" sign appended to an integer value.
Spring.GiveOrderToUnit(unitID, -(unitDefID), {x,y,z(,facing)}, {"shift"})
alternatively:
Spring.GiveOrderToUnit(unitID, -UnitDefNames["unitname"].id, {x,y,z(,facing)}, {"shift"})
'facing' is an optional integer parameter that controls unit's facing when placed.
The values of (x,y,z) must all be number values (like the number "0"), or the build order will break.

== 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

== IDs ==
Below is a table of all commands and their IDs:

{|class="wikitable sortable"
!Command||ID
|-
|FIRESTATE_NONE||-1
|-
|MOVESTATE_NONE||-1
|-
|STOP||0
|-
|MOVESTATE_HOLDPOS||0
|-
|FIRESTATE_HOLDFIRE||0
|-
|INSERT||1
|-
|MOVESTATE_MANEUVER||1
|-
|FIRESTATE_RETURNFIRE||1
|-
|WAITCODE_TIME||1
|-
|WAITCODE_DEATH||2
|-
|MOVESTATE_ROAM||2
|-
|REMOVE||2
|-
|FIRESTATE_FIREATWILL||2
|-
|FIRESTATE_FIREATNEUTRAL||3
|-
|WAITCODE_SQUAD||3
|-
|OPT_META||4
|-
|WAITCODE_GATHER||4
|-
|WAIT||5
|-
|TIMEWAIT||6
|-
|DEATHWAIT||7
|-
|OPT_INTERNAL||8
|-
|SQUADWAIT||8
|-
|GATHERWAIT||9
|-
|MOVE||10
|-
|PATROL||15
|-
|FIGHT||16
|-
|OPT_RIGHT||16
|-
|LOOPBACKATTACK||20
|-
|ATTACK||20
|-
|AREA_ATTACK||21
|-
|GUARD||25
|-
|AISELECT||30
|-
|OPT_SHIFT||32
|-
|GROUPSELECT||35
|-
|GROUPADD||36
|-
|GROUPCLEAR||37
|-
|REPAIR||40
|-
|FIRE_STATE||45
|-
|MOVE_STATE||50
|-
|SETBASE||55
|-
|INTERNAL||60
|-
|OPT_CTRL||64
|-
|SELFD||65
|-
|SET_WANTED_MAX_SPEED||70
|-
|LOAD_UNITS||75
|-
|LOAD_ONTO||76
|-
|UNLOAD_UNITS||80
|-
|UNLOAD_UNIT||81
|-
|ONOFF||85
|-
|RECLAIM||90
|-
|CLOAK||95
|-
|STOCKPILE||100
|-
|MANUALFIRE||105
|-
|DGUN||105
|-
|RESTORE||110
|-
|REPEAT||115
|-
|TRAJECTORY||120
|-
|RESURRECT||125
|-
|OPT_ALT||128
|-
|CAPTURE||130
|-
|AUTOREPAIRLEVEL||135
|-
|IDLEMODE||145
|-
|}

[[category: Lua]]

Lua SyncedRead

2017-02-12T06:03:35Z

Kingraptor: /* RulesParams */ Update Get*RulesParams return values (102.0)

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

== 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.FixedAllies'''
( ) -> nil | boolean

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

=== RulesParams ===
Those functions allow to save data per Game,Team and Unit. The advantage of it is that it can be read from anywhere (even from LuaUI and AIs!) 
string values are new since 95.0

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

'''Spring.GetGameRulesParam'''
( number ruleIndex | string ruleName ) -> nil | number value | string value
'''Spring.GetGameRulesParams'''
( ) -> nil | { [ruleName1] = number | string value1, ... }

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

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

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

! bool values are not transfered from C to Lua correctly, so in IF theres needed to use this condition: 
"if (tonumber(Spring.GetModOptions.exampleOption) == 1) then...end" 
not only: 
"if (Spring.GetModOptions.exampleOption) then...end"

=== Speed/Time ===
'''Spring.GetGameSpeed''' As of 98.0 moved to [[Lua_UnsyncedRead]] due to desyncs in replays/demos
( ) -> 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

== Sides/Factions ==
'''Spring.GetSideData'''
( string sideName ) -> nil | string startUnit, string caseSensitiveSideName
( number sideID ) -> nil | string sideName, string startUnit, string caseSensitiveSideName
( ) -> { [1] = { sideName=string,caseName=string,startUnit=string}, [2] = .., .. }

== 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 = -1 | boolean onlyActive = false] [, number teamID | boolean onlyActive])
-> nil | { [1] = number playerID, etc... }
'''Spring.GetTeamList'''
( [number allyTeamID = -1] ) -> nil | { [1] = number teamID, etc... }
'''Spring.GetAllyTeamList'''
( ) -> { [1] = number allyTeamID, etc... }

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

'''Spring.GetAIInfo'''
( number teamID ) ->
number skirmishAIID,
string name,
number hostingPlayerID,
string shortName, (synced => "SYNCED_NOSHORTNAME"; non-local => "UNKNOWN")
string version, (synced => "SYNCED_NOVERSION"; non-local => "UNKNOWN")
table options (synced & non-local => empty-table)
Note: Before 0.82, the first argument was teamID, and then every other argument with a shifted position.

'''Spring.GetAllyTeamInfo'''
( number allyteamID ) -> nil | table customTeamKeys

'''Spring.GetTeamInfo'''
( number teamID ) ->
nil | number teamID,
number leader, (:= a player id)
boolean isDead,
boolean isAiTeam,
string "side",
number allyTeam,
table customTeamKeys,
number incomeMultiplier
'''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.GetTeamResourceStats''' 0.82 and later
( number teamID, string "metal" | "energy" ) ->
nil | number used,
number produced,
number excessed,
number received,
number sent
'''Spring.GetTeamStatsHistory'''
( number teamID [, number startIndex [, number endIndex = startIndex ]]) ->
nil |
number cur_max_index |
{
[1] = {
"time" = number,
"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
}, ...
}
if called with just teamID as argument it returns the current possible range for startIndex/endIndex :={1..cur_max_index}

'''Spring.GetTeamLuaAI'''
( number teamID ) -> string "luaAI"

Returns string containing name of AI defined in file LuaAI.lua as name="<AI name>". Maybe it returns whole table with all values there, so maybe depends, but in my LuaAI.lua name is on first position...

=== 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 [, bool useLOS]] ) -> nil | number unitID

Post 95.0 this no longer returns neutral units

=== Unit Informations ===
'''Spring.ValidUnitID'''
( number unitID ) -> boolean
'''Spring.GetUnitIsDead'''
( number unitID ) -> nil | boolean
Returns false if unit exists and is alive, true for a brief period of time after unit dies, nil otherwise 
keep this in mind when using (not Spring.GetUnitIsDead())

'''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''' Removed from version 0.83.x 
( number unitID ) -> nil | number lineage | number lineage, boolean lineageIsRoot
'''Spring.GetUnitNeutral'''
( number unitID ) -> nil | boolean neutral
'''Spring.GetUnitHealth'''
( number unitID ) -> nil | number health, number maxHealth, number paralyzeDamage,
number captureProgress, number buildProgress
build Progress is returned as floating Point between 0.0 and 1.0

'''Spring.GetUnitArmored''' armorMultiple new in version 0.83.x
( number unitID ) -> nil | boolean armored, number armorMultiple
'''Spring.GetUnitIsStunned'''
( number unitID ) -> nil | boolean stunned_or_inbuild, boolean stunned, boolean inbuild
'''Spring.GetUnitMaxRange'''
( number unitID ) -> nil | number maxEngagementRange
'''Spring.GetUnitResources'''
( number unitID ) -> nil | number metalMake, number metalUse,
number energyMake, number energyUse
'''Spring.GetUnitHarvestStorage'''
( number unitID ) -> nil | number metal
See also {{xtaglink|Gamedev:UnitDefs|harvestStorage}} UnitDef tag.

'''Spring.GetUnitMetalExtraction''' 0.82+ and later
( number unitID ) -> nil | number
'''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.GetUnitMass''' {{new|101.0}}
( number unitID ) -> nil | number
'''Spring.GetUnitBlocking''' {{new|85.0}}
( number unitID ) -> nil | boolean blocking, boolean crushable
{{new|95.0}} Now return values are:
boolean isBlocking,
boolean isSolidObjectCollidable,
boolean isProjectileCollidable,
boolean isRaySegmentCollidable,
boolean crushable,
boolean blockEnemyPushing,
boolean blockHeightChanges

'''Spring.GetUnitPosition'''
( number unitID, [, boolean midPos [, boolean aimPos ] ] ) ->
nil |
number bpx, number bpy, number bpz
[, number mpx, number mpy, number mpz ]
[, number apx, number apy, number apz ]
since 89.0, returns the base (default), middle or aim position of the unit.

'''Spring.GetUnitBasePosition''' Deprecated in 89.0, use GetUnitPosition
( number unitID ) -> nil | number x, number y, number z
returns the bottom of the unit.

'''Spring.GetUnitDirection'''
( number unitID ) -> nil | number dx, number dy, number dz
returns the direction vector

'''Spring.GetUnitHeading'''
( number unitID ) -> nil | number heading
returns heading directions used in COB scripts

'''Spring.GetUnitRotation''' {{New|95.0}}
(number unitID) --> nil | number pitch, number yaw, number roll
Marked as (WIP) in changelog

'''Spring.GetUnitVelocity''' velw new in 95.0
( number unitID ) -> nil | number velx, number vely, number velz, number velLength
'''Spring.GetUnitBuildFacing'''
( number unitID ) -> nil | number
'''Spring.GetUnitIsBuilding''' returns what unit a constructor/factory is currently building
( number unitID ) -> nil | number unitID
'''Spring.GetUnitCurrentBuildPower''' {{new|92.0}}
( number unitID ) -> nil | number buildPower
'''Spring.GetUnitNanoPieces'''
( number unitID ) -> nil | { [1] = number piece1, etc ... }
'''Spring.GetUnitTransporter'''
( number unitID ) -> nil | number unitID
'''Spring.GetUnitIsTransporting'''
( number unitID ) -> nil | { [1] = number unitID, etc... }
'''Spring.GetUnitShieldState'''
( number unitID [, number weaponID = -1] ) -> nil | number isEnabled, number curPower
'''Spring.GetUnitTravel'''
( number unitID ) -> nil | number travel, number travelPeriod
'''Spring.GetUnitFuel'''
( number unitID ) -> nil | number
'''Spring.GetUnitFlanking'''
( number unitID, string "dir" ) -> nil | number x, number y, number z
( number unitID, string "mode" | "moveFactor" | "minDamage" | "maxDamage" ) -> nil | number
( number unitID ) -> nil | number mode, number modilityAdd,
number minDamage, number maxDamage, number dirX, number dirY, number dirZ
'''Spring.GetUnitSensorRadius'''
( number unitID, string type ) -> nil | number radius
possible types are: los, airLos, radar, sonar, seismic, radarJammer & sonarJammer

'''Spring.GetUnitLosState''' raw is only available in gadgets
( number unitID [, number allyTeamID [, boolean raw] ] ) -> nil | number raw |
{ ["los" = true] [, "radar" = true] [, "typed" = true] }
'''Spring.GetUnitSeparation''' surfaceDist new in 95.0
( number unitID1, number unitID2 [, boolean 2D] [, boolean surfaceDist] ) -> nil | number distance
returns the distance of 2 units, surfaceDist calculates the distance between the unitsphere surfaces instead of their midpos

'''Spring.GetUnitFeatureSeparation''' {{new|101.0}}
( number unitID, number featureID [, 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
}
'''Spring.GetUnitLastAttacker'''
( number unitID ) -> nil | number unitID
'''Spring.GetUnitLastAttackedPiece''''
( number unitID ) -> nil | string pieceName, number gameframe
'''Spring.GetUnitMoveTypeData''' new in version 0.80+
( number unitID ) -> nil | { movetype data }
'''Spring.GetUnitCollisionVolumeData'''
( number unitID )
-> number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetZ,
number volumeType, number testType, number primaryAxis, boolean disabled

==== Unit Weapon Informations ====
'''Spring.GetUnitWeaponState'''
( number unitID, number weaponNum ) -> nil |
boolean angleGood, boolean loaded, number reloadFrame, number salvoLeft, number numStockpiled
( number unitID, number weaponNum, string tag ) -> nil | number
`tag` can be:
"reloadState" == "reloadFrame"
"reloadTime"
"accuracy"
"sprayAngle"
"range"
"projectileSpeed"
"burst"
"burstRate"
"projectiles"

'''Spring.GetUnitWeaponDamages''' {{new|101.0}}
( number unitID, number weaponNum | "selfDestruct" | "explode", string tag ) -> nil | number
`tag` can be:
"paralyzeDamageTime"
"impulseFactor"
"impulseBoost"
"craterMult"
"craterBoost"
"dynDamageExp"
"dynDamageMin"
"dynDamageRange"
"dynDamageInverted"
"craterAreaOfEffect"
"damageAreaOfEffect"
"edgeEffectiveness"
"explosionSpeed"
- or -
an armor type index to get the damage against it.

'''Spring.GetUnitWeaponVectors'''
( number unitID, number weaponNum ) -> nil | number posX, number posY, number posZ,
number dirX, number dirY, number dirZ

'''Spring.GetUnitWeaponTryTarget''' {{new|94.0}}
( number unitID, number weaponNum,
number targetID | number posX, number posY, number posZ ) -> nil | boolean success

'''Spring.GetUnitWeaponTestTarget''' {{new|94.0}}
( number unitID, number weaponNum,
number targetID | number posX, number posY, number posZ ) -> nil | boolean success

'''Spring.GetUnitWeaponTestRange''' {{new|94.0}}
( number unitID, number weaponNum,
number targetID | number posX, number posY, number posZ ) -> nil | boolean success

'''Spring.GetUnitWeaponHaveFreeLineOfFire''' {{new|94.0}}
( number unitID, number weaponNum,
number targetID | number posX, number posY, number posZ ) -> nil | boolean success

'''Spring.GetUnitWeaponCanFire''' {{new|95.0}}
( number unitID, number weaponNum ) -> nil | boolean canFire

'''Spring.GetUnitWeaponTarget''' {{new|95.0}}
( number unitID, number weaponNum ) -> nil |
number 0 | number 1, bool isUserTarget, number unitID |
number 2, bool isUserTarget, { number posX, number posY, number posZ } |
number 3, bool isUserTarget, number ProjectileID

'''Spring.GetRadarErrorParams''' {{new|95.0}}
(number allyTeamID) --> nil |
number allyteamErrorSize, number baseErrorSize, number baseErrorMult

'''Spring.GetUnitPosErrorParams''' {{new|95.0}}
(number unitID) --> nil |
number posErrorVector.x, number posErrorVector.y, number posErrorVector.z,
number posErrorDelta.x, number posErrorDelta.y, number posErrorDelta.z,
number nextPosErrorUpdate

==== Unit LOS ====
'''Spring.IsUnitInLos''' {{new|101.0}}
( number unitID, number allyID ) -> boolean
'''Spring.IsUnitInAirLos''' {{new|101.0}}
( number unitID, number allyID ) -> boolean
'''Spring.IsUnitInRadar''' {{new|101.0}}
( number unitID, number allyID ) -> boolean
'''Spring.IsUnitInJammer''' {{new|101.0}}
( number unitID, number allyID ) -> boolean

=== Unit Pieces ===
'''Spring.GetUnitVectors'''
( number unitID ) -> nil | {frontX,frontY,frontZ}, {upX,upY,upZ}, {rightX,rightY,rightZ}

'''Spring.GetUnitPiecePosition'''
( number unitID, number piece ) -> number posx, number posy, number posz
Returns piece position in unit space. Also remember to multiply the x-axis value with -1 if you want move a piece to another piece.

'''Spring.GetUnitPieceDirection''' Fixed since 101. Now returns the same direction as Spring.GetUnitPiecePosDir
( number unitID, number piece ) -> number dirx, number diry, number dirz

'''Spring.GetUnitPiecePosDir'''
( number unitID, number pieceNum ) -> nil | number posX, number posY, number posZ,
number dirX, number dirZ, number dirY
Returns piece position and direction in world space. The direction (dirX, dirY, dirZ) is not necessarily normalized. The position is defined as the position of the first vertex of the piece and it defines direction as the direction in which the line from the first vertex to the second vertex points.

'''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 },
"parent" = string "parentpiecename",
}
{{new|95.0}} "parent" field
{{new|101.0}} parent for root pieces is now "[null]" instead of ""

'''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 }

'''Spring.GetUnitPieceCollisionVolumeData'''
( number unitID, number pieceID )
-> number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetZ,
number volumeType, number testType, number primaryAxis, boolean disabled
As of 101.0 this is 1-based piece index argument (was 0-based).

=== CommandQueues ===
'''Spring.GetUnitCommands''' 
'''Spring.GetCommandQueue''' (Alias)
( number unitID, number count = 0 ) -> nil | number commandQueueSize {{new|96}}
( number unitID [, number count = -1] )
-> nil | table commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean,
"meta" = boolean
}
}, ...
}

This function can trigger an error if called too often without passing a second parameter. Refer to [https://github.com/spring/spring/blob/92c54d5b15775c39a8c67b203c28fe9b9db51cea/rts/Lua/LuaSyncedRead.cpp#L3983-L3996 LuaSyncedRead.cpp#L3983-L3996]

'''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 = 0 ) -> nil | number commandQueueSize {{new|96}}
( number unitID [, number count = -1 ] )
-> nil | table commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean,
"meta" = 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

== Features ==
=== GetFeatures ===
'''Spring.GetFeaturesInRectangle'''
( number xmin, number zmin, number xmax, number zmax )
-> featureTable = { [1] = number featureID, etc... }
'''Spring.GetFeaturesInSphere'''
( number x, number y, number z, number radius )
-> featureTable = { [1] = number featureID, etc... }
'''Spring.GetFeaturesInCylinder'''
( number x, number z, number radius )
-> featureTable = { [1] = number featureID, etc... }
'''Spring.GetAllFeatures'''
( ) -> { [1] = number featureID, ... }

=== Feature Informations ===
'''Spring.ValidFeatureID'''
( number featureID ) -> boolean
'''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.GetFeatureMass''' {{new|101.0}}
( number featureID ) -> nil | number
'''Spring.GetFeatureSeparation''' {{new|101.0}}
( number featureID1, number featureID2 [, boolean 2D] ) -> nil | number distance
'''Spring.GetFeaturePosition'''
( number featureID, [, boolean midPos [, boolean aimPos ] ] ) ->
nil |
number bpx, number bpy, number bpz [,
number mpx, number mpy, number mpz [,
number apx, number apy, number apz ]]
since 89.0, returns the base (default), middle or aim position of the feature.

'''Spring.GetFeatureVelocity''' {{new|95.0}}
( number featureID [, boolean norm] )
-> nil | number velx, number vely, number velz, number velLength

'''Spring.GetFeatureDirection'''
( number featureID ) -> nil | number dirx, number diry, number dirz

'''Spring.GetFeatureRotation''' {{New|101.0}}
(number featureID) --> nil | number pitch, number yaw, number roll

'''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
'''Spring.GetFeatureCollisionVolumeData'''
( number featureID )
-> number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetZ,
number volumeType, number testType, number primaryAxis, boolean disabled

'''Spring.GetFeaturePieceCollisionVolumeData''' {{new|101.0}}
( number featuerID, number pieceID )
-> number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetZ,
number volumeType, number testType, number primaryAxis, boolean disabled

'''Spring.GetFeatureBlocking'''
(number featureID) --> boolean collidable, boolean crushable, boolean blocking
{{new|95.0}} Now return values are:
boolean isBlocking,
boolean isSolidObjectCollidable,
boolean isProjectileCollidable,
boolean isRaySegmentCollidable,
boolean crushable,
boolean blockEnemyPushing,
boolean blockHeightChanges

=== Feature Pieces ===
See #Unit_Pieces for full details.

'''Spring.GetFeatureLastAttackedPiece'''

'''Spring.GetFeaturePieceMap'''

'''Spring.GetFeaturePieceList'''

'''Spring.GetFeaturePieceInfo'''

'''Spring.GetFeaturePiecePosition'''

'''Spring.GetFeaturePieceDirection'''

'''Spring.GetFeaturePiecePosDir'''

'''Spring.GetFeaturePieceMatrix'''

== 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 ===
Elevation is y. Water level is always at y=0. Ground height can be changed during play (terraform or deformation).

'''Spring.GetGroundHeight'''
( number x, number z ) -> number y
'''Spring.GetGroundOrigHeight'''
( number x, number z ) -> number y
'''Spring.GetGroundNormal'''
( number x, number z [, smoothedNormal] ) -> number x, number y, number z, number slope
{{new|100.0}}: smoothedNormal and slope

'''Spring.GetGroundInfo'''
( number x, number z ) -> string "Type", number metal, number hardness,
number tankSpeed, number kbotSpeed, number hoverSpeed,
number shipSpeed, boolean receiveTracks
'''Spring.GetGroundBlocked'''
( number x, number z |
number x1, number z1, number x2, number z2 )
-> nil | string "feature", number featureID | string "unit", number unitID
'''Spring.GetGroundExtremes'''
( ) -> nil | number minHeight, number maxHeight

'''Spring.GetSmoothMeshHeight'''
( number x, number z ) -> number y

'''Spring.GetMetalMapSize'''
( ) -> number sizeX, number sizeY

'''Spring.GetMetalAmount'''
( number x, number z ) -> number metalAmount
where x & z are in metal map coordinates (worldspace/16)

'''Spring.GetMetalExtraction'''
( number x, number z ) -> number extractionAmount
where x & z are in metal map coordinates (worldspace/16)

'''Spring.GetTerrainTypeData''' {{new|92.0}}
( number i )
-> nil | string "name", number hardness,
number tankSpeed, number kbotSpeed, number hoverSpeed, number shipSpeed,
boolean receiveTracks

=== Test Orders ===
'''Spring.TestMoveOrder'''
( number unitDefID, number x, number y, number z) -> boolean validMove
{{New|95.0}} parameters now are:
number unitDefID,
number pos.x, number pos.y, number pos.z
[, number dir.x
[, number dir.y
[, number dir.z
[, boolean testTerrain
[, boolean testObjects
[, boolean centerOnly ]]]]]]
) --> boolean

'''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 != nil then with a blocking feature that can be reclaimed)
facing can be:
0, "s", "south"
1, "e", "east"
2, "n", "north"
3, "w", "west"
'''Spring.Pos2BuildPos''' optional param ''facing'' supported in 0.83 and later
( number unitDefID, number x, number y, number z[, number facing] )
-> 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.IsPosInLos'''
( number x, number y, number z, number allyID ) -> boolean
'''Spring.IsPosInRadar'''
( number x, number y, number z, number allyID ) -> boolean
'''Spring.IsPosInAirLos'''
( number x, number y, number z, number allyID ) -> boolean
'''Spring.GetPositionLosState''' jammed new in 95.0
( number x, number y, number z [, number allyID] )
-> boolean LosOrRadar, boolean inLos, boolean inRadar, boolean jammed
jammed indicates if a position is actively being radar- or sonar-jammed by '''any''' allyteam

'''Spring.GetClosestValidPosition''' //NOT FINISHED YET
( number unitDefID, number x, number z, number r ) -> nil

== Projectiles ==

'''Spring.GetProjectilesInRectangle'''

( number xmin, number zmin, number xmax, number zmax
[, boolean excludeWeaponProjectiles
[, boolean excludePieceProjectiles] ] )
-> nil | projectileTable = { [1] = number projectileID, etc... }

'''Spring.GetProjectileOwnerID''' {{new|99.0}}
(number projectileID) -> nil | number unitID

'''Spring.GetProjectileTeamID''' {{new|99.0}}
(number projectileID) -> nil | number teamID

'''Spring.GetProjectileDefID'''
(number projectileID) -> nil | number weaponDefID
using this to get a weaponDefID is HIGHLY preferred to indexing WeaponDefNames via GetProjectileName

'''Spring.GetProjectileName'''
( number projectileID ) -> nil | string name
'''Spring.GetProjectileType'''
( number projectileID ) -> nil | boolean weapon, boolean piece

'''Spring.GetProjectileTarget'''
( number projectileID )
Pre 95.0: -> nil | number targetID, string targetTypeStr
Post 95.0: -> nil | [number targetTypeInt, number targetID | table targetPos = {x, y, z}]

targetTypeStr can be one of:
'u' - unit
'f' - feature
'p' - projectile
while targetTypeInt is one of:
string.byte('g') := GROUND
string.byte('u') := UNIT
string.byte('f') := FEATURE
string.byte('p') := PROJECTILE

'''Spring.GetProjectileIntercepted''' {{new|99.0}}
( number projectileID ) -> nil | boolean isBeingIntercepted

'''Spring.GetProjectilePosition'''
( number projectileID ) -> nil | number px, number py, number pz
'''Spring.GetProjectileVelocity'''
( number projectileID ) -> nil | number vx, number vy, number vz
{{new|95.0}}: returns (targetPos - startPos) for Beamlasers and similar weapons

'''Spring.GetProjectileGravity'''
( number projectileID ) -> nil | number gravity

'''Spring.GetPieceProjectileParams''' {{new|95.0}}
( number projectileID ) -> nil | number explosionFlags, number spinAngle,
number spinSpeed, number spinVector.x, number spinVector.y, number spinVector.z
Where explosionFlags use binary flags with the following integer equivalents:
more info [http://springrts.com/wiki/Animation-CobConstants#explode here]
SHATTER = 1, EXPLODE = 2, EXPLODE_ON_HIT = 2, FALL = 4, SMOKE = 8, FIRE = 16
NONE = 32, NO_CEG_TRAIL = 64, NO_HEATCLOUD = 128 

'''Spring.GetProjectileTimeToLive''' {{new|99.0}}
( number projectileID ) -> nil | number ttl

'''Spring.GetProjectileDirection''' {{new|95.0}}
( number projectileID ) -> nil | number dir.x, number dir.y, number dir.z

'''Spring.GetProjectileSpinAngle''' Deprecated in 95.0
( number projectileID ) -> nil | number angle
'''Spring.GetProjectileSpinSpeed''' Deprecated in 95.0
( number projectileID ) -> nil | number spinSpeed
'''Spring.GetProjectileSpinVec''' Deprecated in 95.0
( number projectileID ) -> nil | number x, number y, number z

'''Spring.GetProjectileDamages''' {{new|101.0}}
( number unitID, number weaponNum, string tag ) -> nil | number
`tag` can be:
"paralyzeDamageTime"
"impulseFactor"
"impulseBoost"
"craterMult"
"craterBoost"
"dynDamageExp"
"dynDamageMin"
"dynDamageRange"
"dynDamageInverted"
"craterAreaOfEffect"
"damageAreaOfEffect"
"edgeEffectiveness"
"explosionSpeed"
- or -
an armor type index to get the damage against it.

[[category: Lua]]

Lua SaveLoad

2017-01-13T07:19:50Z

Kingraptor:

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

= Lua Save/Load support =

== Motivation ==

Engine save/load has been broken/unstable for a very long time. I believe the major reasons for this were:

* In particular for loading too much special code paths were traversed, that were not used for anything else (e.g. creg_Serialize and creg_PostLoad functions in many classes);
* Each class was responsible for it's own saving and loading;
* The code for loading was spread out over many classes;
* Save/load using CREG was extremely slow.
* Savegames created using CREG were bound to be incompatible between different Spring versions because they relied inherently on the implementation details of every single class involved;
* The save/load system strived to be 100% perfect, saving every single detail.
* No clear way to save Lua states (without making Lua aware of it)

I realised we have a pretty decent and reasonably stable Lua interface. So why use this for save/load:

* The code has been tested in practice (it's used in widgets and gadgets);
* The interface is reasonably stable, so savegames can be compatible between different Spring versions;
* Not a single class needs special support for save/load, as save/load uses existing APIs.
* By simply using the standard call-in mechanism any gadgets can save some state if that is desired. The save/load gadget does not need to get special treatment at all.

[http://springrts.com/phpbb/viewtopic.php?f=23&t=21805 Argh] and [http://springrts.com/phpbb/viewtopic.php?f=23&t=21836 zwzsg] had this idea too and implement save/load using Lua only. This is a little bit hacky and it is slow when saving large amounts of data such as e.g. the modified terrain heightmap.

Hence Lua save/load brings engine support for Lua save/load :-)

== Idea ==

Instead of having the engine be responsible for serializing every bit of gamestate to disk, Lua save/load transfers most of the responsibility to the game (developer). The game developer can decide what objects and what properties are important to save, and ultimately a gadget could be created that could be drag 'n dropped in nearly any game. (Argh's and zwzsg's code would be useful for this.)

There are two new call-ins: Load and Save, that allow a Lua save/load system to seamlessly integrate with other interfaces of the engine (e.g. commandline, lobby). Load is called by the engine if it has been instructed to load a game. Save is called by the engine whenever the chat command '/save <filename>' or '/savegame' is given. Both get a userdatum as argument. Using the methods open, read and write on this userdatum the Lua code can read/write chunks of data.

At this moment existing code for reading and writing zip files has been re-used for Lua save/load, so savegames are simply renamed zip files (.ssf)

== Chat commands ==

* <code>/save [-y] <filename></code>: Write a savegame to <filename>. The file is placed in the 'Saves' folder and the '.ssf' extension is automatically added. If -y is given the file is overwritten if it already exists. Filename cannot have spaces.
* <code>/savegame</code>: Write a savegame to 'Saves/QuickSave.ssf'.
* <code>/reloadgame</code>: Reload the savegame that was loaded when the engine was started. Useful for testing. Note that no cleanup is performed by the engine; i.e. Lua code should erase all units from the battlefield.

== Lua API documentation ==

Lua save/load brings two new call-ins:

=== <code>'''Load''' ( zip ) -> nil</code> ===

This '''SYNCED''' call-in is called after GamePreload and before GameStart. The single argument is a userdatum respresenting a zip file from which the game is being loaded.

On this userdatum the following methods are defined:

* <code>zip:open(filename)</code>: Opens a file within the zip file. Next calls to <code>zip:read</code> will read from this file.
* <code>zip:read(...)</code>: Reads data from the file that is currently open. Arguments and return values are similar to [http://www.lua.org/pil/21.1.html io.read], although only "*all" and ''num'' are supported. The special case io.read(0) should work.

Note that currently loading multiplayer games is not supported: the Load call-in is only called on the client loading the game.

=== <code>'''Save''' ( zip ) -> nil</code> ===

This '''UNSYNCED''' call-in is called when a chat command '/save' or '/savegame' is received. The single argument is a userdatum representing the savegame zip file.

On this userdatum the following methods are defined:

* <code>zip:open(filename)</code>: Opens a new file within the zip file. Next calls to <code>zip:write</code> will write to this file.
* <code>zip:write(...)</code>: Writes data to the file that is currently open. Arguments are same as [http://www.lua.org/pil/21.1.html io.write].

Usually when this call-in is called you'd do something like this (pseudocode) in one savegame gadget:

function gadget:Save(zip)
zip:open("units.lua")
for each unit do
write some properties about the unit in zip, e.g. position, heading, health
end
end

Note that Spring writes files into this zip file too. Any files in the directory 'Spring' are reserved for use by the engine.

== Example gadgets ==
* Zero-K: [https://github.com/ZeroK-RTS/Zero-K/blob/master/LuaRules/Gadgets/api_saveload.lua api_saveload.lua]
** For an example of a gadget that interacts with this API gadget, see [https://github.com/ZeroK-RTS/Zero-K/blob/master/LuaRules/Gadgets/start_unit_setup.lua start_unit_setup.lua]
If you have made a gadget that implements this interface, please add a link.
[[Category: Lua]]

Ren'Py

2015-03-28T08:28:33Z

Kingraptor: Moved to Github

'''Ren'Py''' is an open source visual novel engine, available [http://www.renpy.org/ here]. It can be used in conjunction with Spring to provide a singleplayer experience with narrative, dialogue, images and videos.

== Using Ren'Py with Spring ==
Without the use of sockets, Ren'Py and Spring can best communicate in the following way:

=== Ren'Py to Spring ===
Python can read a Spring startscript and modify it, say using [http://docs.python.org/2/library/string.html#formatstrings str.format] or the older [http://docs.python.org/2/library/stdtypes.html#string-formatting % (modulo) operator]. In this way, any arbitrary game, per-player or per-team information can be made available to Spring at runtime. It is also theoretically possible for Python to modify the contents of an .sdz or .sdd archive directly, but this is not recommended.

=== Spring to Ren'Py ===
A widget or gadget can write a Python file with any information to be communicated to Ren'Py, which it can then import using the [http://docs.python.org/2/library/functions.html#execfile execfile] function. Bear in mind that because Spring is limited in which directories its Lua can write files to, Ren'Py will need to know where the Spring datadir is.

=== Examples ===
[https://github.com/KingRaptor/springpy SpringPy] is a code example for Spring-Ren'Py communication. You can check out the whole repo and open/run the Ren'Py project with the Ren'Py SDK.
* [https://github.com/KingRaptor/springpy/blob/master/game/script.rpy Example script.rpy]
* [https://github.com/KingRaptor/springpy/blob/master/spring/script_pytest.txt Example startscript]
* [https://github.com/KingRaptor/springpy/blob/master/spring/LuaUI/Widgets/api_shared_functions.lua Widget to write Python dictionaries and module files]
* [https://github.com/KingRaptor/springpy/blob/master/spring/LuaUI/Widgets/dbg_test.lua Test widget]: writes data required by sample code on widget:Initialize()

[[Category:Game Dev]]

Gamedev:PublicRepos

2015-03-28T08:26:38Z

Kingraptor: Air Raid moved to Github

==What Is This?==
This is a small collection of publicly known and readable code repositories for established Spring games. The intention being to provide a wealth of examples to all game developers from noob to pro.

== Known Repos ==
[https://github.com/KingRaptor/air-raid-spring Air Raid]

[http://imolarpg.dyndns.org/trac/balatest/browser/trunk/ Balanced Annihilation]

[https://code.google.com/p/basically-ota/ BOTA]

[http://code.google.com/p/conflictterra/source/browse/#svn%2Fgames%2FCT Conflict Terra]

[http://www.petro.darkstars.co.uk/damned/ Damned]

[https://github.com/EvolutionRTS/Evolution-RTS Evolution RTS]

[https://github.com/imperialwinter/swiw.sdd Imperial Winter]

[http://code.google.com/p/journeywar/ Journeywar]

[https://github.com/jk3064?tab=repositories jK]
* [[Chili]]
* [[LUPS]]
* Custom-Unit-Shader-Framework
* [[Mapdev:Main#Blueprint | Map-Blueprint]]

[https://github.com/David-Becker/mods KDR_11k]
* Cuberors' Finest
* CvC
* Doserz
* Fibre
* GINTA
* Gun Wings Test
* Light Side of Spring
* MicroModules
* Pong

[https://sourceforge.net/p/mwspring/code/ MechCommander: Legacy]

[https://github.com/spring1944/spring1944 Spring: 1944]

[https://code.google.com/p/springtanks/source/browse/#svn%2Ftrunk Spring Tanks]

[http://code.google.com/p/springtutorialgame/source/browse/#svn%2Ftrunk%2FSpringTutorialGame.sdd Spring Tutorial Game]

[https://github.com/KingRaptor/THIS THIS]

[http://code.google.com/p/xta-springrts/ XTA]

[https://github.com/ZeroK-RTS/Zero-K/ Zero-K]

[[Category:Game Dev]]

Lua SyncedRead

2014-08-27T11:58:50Z

Kingraptor: /* Unit Informations */

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

== 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.FixedAllies'''
( ) -> nil | boolean

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

=== RulesParams ===
Those functions allow to save data per Game,Team and Unit. The advantage of it is that it can be read from anywhere (even from LuaUI and AIs!) 
string values are new since 95.0

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

'''Spring.GetGameRulesParam'''
( number ruleIndex | string ruleName ) -> nil | number value | string value
'''Spring.GetGameRulesParams'''
( ) -> nil | { [ruleIndex1] = {[ruleName1] = number | string value1}, ... }

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

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

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

! bool values are not transfered from C to Lua correctly, so in IF theres needed to use this condition: 
"if (tonumber(Spring.GetModOptions.exampleOption) == 1) then...end" 
not only: 
"if (Spring.GetModOptions.exampleOption) then...end"

=== 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

== Sides/Factions ==
'''Spring.GetSideData'''
( string sideName ) -> nil | string startUnit, string caseSensitiveSideName
( number sideID ) -> nil | string sideName, string startUnit, string caseSensitiveSideName
( ) -> { [1] = { sideName=string,caseName=string,startUnit=string}, [2] = .., .. }

== 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 = -1 | boolean onlyActive = false] [, number teamID | boolean onlyActive])
-> nil | { [1] = number playerID, etc... }
'''Spring.GetTeamList'''
( [number allyTeamID = -1] ) -> nil | { [1] = number teamID, etc... }
'''Spring.GetAllyTeamList'''
( ) -> { [1] = number allyTeamID, etc... }

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

'''Spring.GetAIInfo'''
( number teamID ) ->
number skirmishAIID,
string name,
number hostingPlayerID,
string shortName, (synced => "SYNCED_NOSHORTNAME"; non-local => "UNKNOWN")
string version, (synced => "SYNCED_NOVERSION"; non-local => "UNKNOWN")
table options (synced & non-local => empty-table)
Note: Before 0.82, the first argument was teamID, and then every other argument with a shifted position.

'''Spring.GetAllyTeamInfo'''
( number allyteamID ) -> nil | table customTeamKeys

'''Spring.GetTeamInfo'''
( number teamID ) ->
nil | number teamID,
number leader, (:= a player id)
boolean isDead,
boolean isAiTeam,
string "side",
number allyTeam,
table customTeamKeys,
number incomeMultiplier
'''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.GetTeamResourceStats''' 0.82 and later
( number teamID, string "metal" | "energy" ) ->
nil | number used,
number produced,
number excessed,
number received,
number sent
'''Spring.GetTeamStatsHistory'''
( number teamID [, number startIndex [, number endIndex = startIndex ]]) ->
nil |
number cur_max_index |
{
[1] = {
"time" = number,
"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
}, ...
}
if called with just teamID as argument it returns the current possible range for startIndex/endIndex :={1..cur_max_index}

'''Spring.GetTeamLuaAI'''
( number teamID ) -> string "luaAI"

Returns string containing name of AI defined in file LuaAI.lua as name="<AI name>". Maybe it returns whole table with all values there, so maybe depends, but in my LuaAI.lua name is on first position...

=== 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 [, bool useLOS]] ) -> nil | number unitID

Post 95.0 this no longer returns neutral units

=== Unit Informations ===
'''Spring.ValidUnitID'''
( number unitID ) -> boolean
'''Spring.GetUnitIsDead'''
( number unitID ) -> nil | boolean
Returns false if unit exists and is alive, true for a brief period of time after unit dies, nil otherwise 
keep this in mind when using (not Spring.GetUnitIsDead())

'''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''' Removed from version 0.83.x 
( number unitID ) -> nil | number lineage | number lineage, boolean lineageIsRoot
'''Spring.GetUnitNeutral'''
( number unitID ) -> nil | boolean neutral
'''Spring.GetUnitHealth'''
( number unitID ) -> nil | number health, number maxHealth, number paralyzeDamage,
number captureProgress, number buildProgress
build Progress is returned as floating Point between 0.0 and 1.0

'''Spring.GetUnitArmored''' armorMultiple new in version 0.83.x
( number unitID ) -> nil | boolean armored, number armorMultiple
'''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.GetUnitMetalExtraction''' 0.82+ and later
( number unitID ) -> nil | number
'''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.GetUnitBlocking''' {{new|85.0}}
( number unitID ) -> nil | boolean blocking, boolean crushable
{{new|95.0}} Now return values are:
boolean isBlocking,
boolean isSolidObjectCollidable,
boolean isProjectileCollidable,
boolean isRaySegmentCollidable,
boolean crushable,
boolean blockEnemyPushing,
boolean blockHeightChanges

'''Spring.GetUnitPosition'''
( number unitID, [, boolean midPos [, boolean aimPos ] ] ) ->
nil |
number bpx, number bpy, number bpz [,
number mpx, number mpy, number mpz [,
number apx, number apy, number apz ]]
since 89.0, returns the base (default), middle or aim position of the unit.

'''Spring.GetUnitBasePosition''' Deprecated in 89.0, use GetUnitPosition
( number unitID ) -> nil | number x, number y, number z
returns the bottom of the unit.

'''Spring.GetUnitDirection'''
( number unitID ) -> nil | number dx, number dy, number dz
returns the direction vector

'''Spring.GetUnitHeading'''
( number unitID ) -> nil | number heading
returns heading directions used in COB scripts

'''Spring.GetUnitRotation''' {{New|95.0}}
(number unitID) --> nil | number pitch, number yaw, number roll
Marked as (WIP) in changelog

'''Spring.GetUnitVelocity''' velw new in 95.0
( number unitID ) -> nil | number velx, number vely, number velz, number velLength
'''Spring.GetUnitBuildFacing'''
( number unitID ) -> nil | number
'''Spring.GetUnitIsBuilding''' returns what unit a constructor/factory is currently building
( number unitID ) -> nil | number unitID
'''Spring.GetUnitCurrentBuildPower''' {{new|92.0}}
( number unitID ) -> nil | number buildPower
'''Spring.GetUnitNanoPieces'''
( number unitID ) -> nil | { [1] = number piece1, etc ... }
'''Spring.GetUnitTransporter'''
( number unitID ) -> nil | number unitID
'''Spring.GetUnitIsTransporting'''
( number unitID ) -> nil | { [1] = number unitID, etc... }
'''Spring.GetUnitShieldState'''
( number unitID [, number weaponID = -1] ) -> nil | number isEnabled, number curPower
'''Spring.GetUnitTravel'''
( number unitID ) -> nil | number travel, number travelPeriod
'''Spring.GetUnitFuel'''
( number unitID ) -> nil | number
'''Spring.GetUnitFlanking'''
( number unitID, string "dir" ) -> nil | number x, number y, number z
( number unitID, string "mode" | "moveFactor" | "minDamage" | "maxDamage" ) -> nil | number
( number unitID ) -> nil | number mode, number modilityAdd,
number minDamage, number maxDamage, number dirX, number dirY, number dirZ
'''Spring.GetUnitSensorRadius'''
( number unitID, string type ) -> nil | number radius
possible types are: airLos, radar, sonar, seismic, radarJammer & sonarJammer
'''Spring.GetUnitLosState''' raw is only available in gadgets
( number unitID [, number allyTeamID [, boolean raw] ] ) -> nil | number raw |
{ ["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
}
'''Spring.GetUnitLastAttacker'''
( number unitID ) -> nil | number unitID
'''Spring.GetUnitLastAttackedPiece''''
( number unitID ) -> nil | string pieceName, number gameframe
'''Spring.GetUnitMoveTypeData''' new in version 0.80+
( number unitID ) -> nil | { movetype data }
'''Spring.GetUnitCollisionVolumeData'''
( number unitID )
-> number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetZ,
number volumeType, number testType, number primaryAxis, boolean disabled
'''Spring.GetUnitPieceCollisionVolumeData'''
( number unitID, number pieceID )
-> number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetZ,
number volumeType, number testType, number primaryAxis, boolean disabled

==== Unit Weapon Informations ====
'''Spring.GetUnitWeaponState'''
( number unitID, number weaponNum ) -> nil |
boolean angleGood, boolean loaded, number reloadFrame, number salvoLeft, number numStockpiled
( number unitID, number weaponNum, string tag ) -> nil | number
`tag` can be:
"reloadState" == "reloadFrame"
"reloadTime"
"accuracy"
"sprayAngle"
"range"
"projectileSpeed"
"burst"
"burstRate"
"projectiles"

'''Spring.GetUnitWeaponVectors'''
( number unitID, number weaponNum ) -> nil | number posX, number posY, number posZ,
number dirX, number dirY, number dirZ

'''Spring.GetUnitWeaponTryTarget''' {{new|94.0}}
( number unitID, number weaponNum,
number targetID | number posX, number posY, number posZ ) -> nil | boolean success

'''Spring.GetUnitWeaponTestTarget''' {{new|94.0}}
( number unitID, number weaponNum,
number targetID | number posX, number posY, number posZ ) -> nil | boolean success

'''Spring.GetUnitWeaponTestRange''' {{new|94.0}}
( number unitID, number weaponNum,
number targetID | number posX, number posY, number posZ ) -> nil | boolean success

'''Spring.GetUnitWeaponHaveFreeLineOfFire''' {{new|94.0}}
( number unitID, number weaponNum,
number targetID | number posX, number posY, number posZ ) -> nil | boolean success

'''Spring.GetUnitWeaponCanFire''' {{new|95.0}}
( number unitID, number weaponNum ) -> nil | boolean canFire

'''Spring.GetUnitWeaponTarget''' {{new|95.0}}
( number unitID, number weaponNum ) -> nil |
number 0 | number 1, bool isUserTarget, number unitID |
number 2, bool isUserTarget, { number posX, number posY, number posZ } |
number 3, bool isUserTarget, number ProjectileID

'''Spring.GetRadarErrorParams''' {{new|95.0}}
(number allyTeamID) --> nil |
number allyteamErrorSize, number baseErrorSize, number baseErrorMult

'''Spring.GetUnitPosErrorParams''' {{new|95.0}}
(number unitID) --> nil |
number posErrorVector.x, number posErrorVector.y, number posErrorVector.z,
number posErrorDelta.x, number posErrorDelta.y, number posErrorDelta.z,
number nextPosErrorUpdate

=== Unit Pieces ===
'''Spring.GetUnitVectors'''
( number unitID ) -> nil | {frontX,frontY,frontZ}, {upX,upY,upZ}, {rightX,rightY,rightZ}
'''Spring.GetUnitPiecePosition'''
( number unitID, number piece ) -> number posx, number posy, number posz
Returns piece position in unit space

'''Spring.GetUnitPieceDirection'''
( number unitID, number piece ) -> number dirx, number diry, number dirz
Consider this broken. It returns reverse direction in piece space (i.e. vertex(0)-vertex(1)) for pieces with >= 2 vertices and (1,1,1) for pieces with < 2 vertices)

'''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 },
"parent" = string "parentpiecename",
}
"parent" field {{New|95.0}}

'''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 }
'''Spring.GetUnitPiecePosDir'''
( number unitID, number pieceNum ) -> nil | number posX, number posY, number posZ,
number dirX, number dirZ, number dirY
Returns piece position and direction in world space. The direction (dirX, dirY, dirZ) is not necessarily normalized. The position is defined as the position of the first vertex of the piece and it defines direction as the direction in which the line from the first vertex to the second vertex points.

=== CommandQueues ===
'''Spring.GetUnitCommands''' 
'''Spring.GetCommandQueue''' (Alias)
( number unitID, number count = 0 ) -> nil | number commandQueueSize {{new|96}}
( number unitID [, number count = -1] )
-> nil | table commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean,
"meta" = 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 = 0 ) -> nil | number commandQueueSize {{new|96}}
( number unitID [, number count = -1 ] )
-> nil | table commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean,
"meta" = 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

== Features ==
=== GetFeatures ===
'''Spring.GetFeaturesInRectangle'''
( number xmin, number zmin, number xmax, number zmax )
-> nil | featureTable = { [1] = number featureID, etc... }
'''Spring.GetFeaturesInSphere'''
( number x, number y, number z, number radius )
-> nil | featureTable = { [1] = number featureID, etc... }
'''Spring.GetFeaturesInCylinder'''
( number x, number z, number radius )
-> nil | featureTable = { [1] = number featureID, etc... }
'''Spring.GetAllFeatures'''
( ) -> nil | { [1] = number featureID, ... }

=== Feature Informations ===
'''Spring.ValidFeatureID'''
( number featureID ) -> boolean
'''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, [, boolean midPos [, boolean aimPos ] ] ) ->
nil |
number bpx, number bpy, number bpz [,
number mpx, number mpy, number mpz [,
number apx, number apy, number apz ]]
since 89.0, returns the base (default), middle or aim position of the feature.

'''Spring.GetFeatureVelocity''' {{new|95.0}}
( number featureID [, boolean norm] )
-> nil | number velx, number vely, number velz, number velLength

'''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
'''Spring.GetFeatureCollisionVolumeData'''
( number featureID )
-> number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetZ,
number volumeType, number testType, number primaryAxis, boolean disabled

'''Spring.GetFeatureBlocking'''
(number featureID) --> boolean collidable, boolean crushable, boolean blocking
{{new|95.0}} Now return values are:
boolean isBlocking,
boolean isSolidObjectCollidable,
boolean isProjectileCollidable,
boolean isRaySegmentCollidable,
boolean crushable,
boolean blockEnemyPushing,
boolean blockHeightChanges

== 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 ===
Elevation is y. Water level is always at y=0. Ground height can be changed during play (terraform or deformation).

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

'''Spring.GetSmoothMeshHeight'''
( number x, number z ) -> number y

'''Spring.GetMetalMapSize'''
( ) -> number sizeX, number sizeY

'''Spring.GetMetalAmount'''
( number x, number z ) -> number metalAmount
where x & z are in metal map coordinates (worldspace/16)

'''Spring.GetMetalExtraction'''
( number x, number z ) -> number extractionAmount
where x & z are in metal map coordinates (worldspace/16)

'''Spring.GetTerrainTypeData''' {{new|92.0}}
( number i )
-> nil | string "name", number hardness,
number tankSpeed, number kbotSpeed, number hoverSpeed, number shipSpeed,
boolean receiveTracks

=== Test Orders ===
'''Spring.TestMoveOrder'''
( number unitDefID, number x, number y, number z) -> boolean validMove
{{New|95.0}} parameters now are:
number unitDefID,
number pos.x, number pos.y, number pos.z
[, number dir.x
[, number dir.y
[, number dir.z
[, boolean testTerrain
[, boolean testObjects
[, boolean centerOnly ]]]]]]
) --> boolean

'''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 != nil then with a blocking feature that can be reclaimed)
facing can be:
0, "s", "south"
1, "e", "east"
2, "n", "north"
3, "w", "west"
'''Spring.Pos2BuildPos''' optional param ''facing'' supported in 0.83 and later
( number unitDefID, number x, number y, number z[, number facing] )
-> 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.IsPosInLos'''
( number x, number y, number z, number allyID ) -> boolean
'''Spring.IsPosInRadar'''
( number x, number y, number z, number allyID ) -> boolean
'''Spring.IsPosInAirLos'''
( number x, number y, number z, number allyID ) -> boolean
'''Spring.GetPositionLosState''' jammed new in 95.0
( number x, number y, number z [, number allyID] )
-> boolean LosOrRadar, boolean inLos, boolean inRadar, boolean jammed
jammed indicates if a position is actively being radar- or sonar-jammed by '''any''' allyteam

'''Spring.GetClosestValidPosition''' //NOT FINISHED YET
( number unitDefID, number x, number z, number r ) -> nil

== Projectiles ==

'''Spring.GetProjectilesInRectangle'''

( number xmin, number zmin, number xmax, number zmax
[, boolean excludeWeaponProjectiles
[, boolean excludePieceProjectiles] ] )
-> nil | projectileTable = { [1] = number projectileID, etc... }

'''Spring.GetProjectileDefID'''
(number projectileID) -> nil | number weaponDefID
using this to get a weaponDefID is HIGHLY preferred to indexing WeaponDefNames via GetProjectileName

'''Spring.GetProjectileName'''
( number projectileID ) -> nil | string name
'''Spring.GetProjectileType'''
( number projectileID ) -> nil | boolean weapon, boolean piece

'''Spring.GetProjectileTarget'''
( number projectileID )
Pre 95.0: -> nil | number targetID, string targetTypeStr
Post 95.0: -> nil | [number targetTypeInt, number targetID | table targetPos = {x, y, z}]

targetTypeStr can be one of:
'u' - unit
'f' - feature
'p' - projectile
while targetTypeInt is one of:
string.byte('g') := GROUND
string.byte('u') := UNIT
string.byte('f') := FEATURE
string.byte('p') := PROJECTILE


'''Spring.GetProjectilePosition'''
( number projectileID ) -> nil | number px, number py, number pz
'''Spring.GetProjectileVelocity'''
( number projectileID ) -> nil | number vx, number vy, number vz
{{new|95.0}}: returns (targetPos - startPos) for Beamlasers and similar weapons

'''Spring.GetProjectileGravity'''
( number projectileID ) -> nil | number gravity

'''Spring.GetPieceProjectileParams''' {{new|95.0}}
( number projectileID ) -> nil | number explosionFlags, number spinAngle,
number spinSpeed, number spinVector.x, number spinVector.y, number spinVector.z
Where explosionFlags use binary flags with the following integer equivalents:
more info [http://springrts.com/wiki/Animation-CobConstants#explode here]
SHATTER = 1, EXPLODE = 2, EXPLODE_ON_HIT = 2, FALL = 4, SMOKE = 8, FIRE = 16
NONE = 32, NO_CEG_TRAIL = 64, NO_HEATCLOUD = 128 

'''Spring.GetProjectileDirection''' {{new|95.0}}
( number projectileID ) -> nil | number dir.x, number dir.y, number dir.z

'''Spring.GetProjectileSpinAngle''' Deprecated in 95.0
( number projectileID ) -> nil | number angle
'''Spring.GetProjectileSpinSpeed''' Deprecated in 95.0
( number projectileID ) -> nil | number spinSpeed
'''Spring.GetProjectileSpinVec''' Deprecated in 95.0
( number projectileID ) -> nil | number x, number y, number z

[[category: Lua]]

Lua SaveLoad

2014-07-28T06:09:03Z

Kingraptor: /* Example gadgets */

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

= Lua Save/Load support =

== Motivation ==

Engine save/load has been broken/unstable for a very long time. I believe the major reasons for this were:

* In particular for loading too much special code paths were traversed, that were not used for anything else (e.g. creg_Serialize and creg_PostLoad functions in many classes);
* Each class was responsible for it's own saving and loading;
* The code for loading was spread out over many classes;
* Save/load using CREG was extremely slow.
* Savegames created using CREG were bound to be incompatible between different Spring versions because they relied inherently on the implementation details of every single class involved;
* The save/load system strived to be 100% perfect, saving every single detail.
* No clear way to save Lua states (without making Lua aware of it)

I realised we have a pretty decent and reasonably stable Lua interface. So why use this for save/load:

* The code has been tested in practice (it's used in widgets and gadgets);
* The interface is reasonably stable, so savegames can be compatible between different Spring versions;
* Not a single class needs special support for save/load, as save/load uses existing APIs.
* By simply using the standard call-in mechanism any gadgets can save some state if that is desired. The save/load gadget does not need to get special treatment at all.

[http://springrts.com/phpbb/viewtopic.php?f=23&t=21805 Argh] and [http://springrts.com/phpbb/viewtopic.php?f=23&t=21836 zwzsg] had this idea too and implement save/load using Lua only. This is a little bit hacky and it is slow when saving large amounts of data such as e.g. the modified terrain heightmap.

Hence Lua save/load brings engine support for Lua save/load :-)

== Idea ==

Instead of having the engine be responsible for serializing every bit of gamestate to disk, Lua save/load transfers most of the responsibility to the game (developer). The game developer can decide what objects and what properties are important to save, and ultimately a gadget could be created that could be drag 'n dropped in nearly any game. (Argh's and zwzsg's code would be useful for this.)

There are two new call-ins: Load and Save, that allow a Lua save/load system to seamlessly integrate with other interfaces of the engine (e.g. commandline, lobby). Load is called by the engine if it has been instructed to load a game. Save is called by the engine whenever the chat command '/save <filename>' or '/savegame' is given. Both get a userdatum as argument. Using the methods open, read and write on this userdatum the Lua code can read/write chunks of data.

At this moment existing code for reading and writing zip files has been re-used for Lua save/load, so savegames are simply renamed zip files (.ssf)

== Chat commands ==

* <code>/save [-y] <filename></code>: Write a savegame to <filename>. The file is placed in the 'Saves' folder and the '.ssf' extension is automatically added. If -y is given the file is overwritten if it already exists.
* <code>/savegame</code>: Write a savegame to 'Saves/QuickSave.ssf'.
* <code>/reloadgame</code>: Reload the savegame that was loaded when the engine was started. Useful for testing. Note that no cleanup is performed by the engine; i.e. Lua code should erase all units from the battlefield.

== Lua API documentation ==

Lua save/load brings two new call-ins:

=== <code>'''Load''' ( zip ) -> nil</code> ===

This '''SYNCED''' call-in is called after GamePreload and before GameStart. The single argument is a userdatum respresenting a zip file from which the game is being loaded.

On this userdatum the following methods are defined:

* <code>zip:open(filename)</code>: Opens a file within the zip file. Next calls to <code>zip:read</code> will read from this file.
* <code>zip:read(...)</code>: Reads data from the file that is currently open. Arguments and return values are similar to [http://www.lua.org/pil/21.1.html io.read], although only "*all" and ''num'' are supported. The special case io.read(0) should work.

Note that currently loading multiplayer games is not supported: the Load call-in is only called on the client loading the game.

=== <code>'''Save''' ( zip ) -> nil</code> ===

This '''UNSYNCED''' call-in is called when a chat command '/save' or '/savegame' is received. The single argument is a userdatum representing the savegame zip file.

On this userdatum the following methods are defined:

* <code>zip:open(filename)</code>: Opens a new file within the zip file. Next calls to <code>zip:write</code> will write to this file.
* <code>zip:write(...)</code>: Writes data to the file that is currently open. Arguments are same as [http://www.lua.org/pil/21.1.html io.write].

Usually when this call-in is called you'd do something like this (pseudocode) in one savegame gadget:

function gadget:Save(zip)
zip:open("units.lua")
for each unit do
write some properties about the unit in zip, e.g. position, heading, health
end
end

Note that Spring writes files into this zip file too. Any files in the directory 'Spring' are reserved for use by the engine.

== Example gadgets ==
* Zero-K: [https://github.com/KingRaptor/Zero-K/blob/master/LuaRules/Gadgets/api_saveload.lua api_saveload.lua]
** For an example of a gadget that interacts with this API gadget, see [https://github.com/KingRaptor/Zero-K/blob/master/LuaRules/Gadgets/start_unit_setup.lua start_unit_setup.lua]
If you have made a gadget that implements this interface, please add a link.
[[Category: Lua]]

LuaCallinReturn

2014-04-20T11:47:36Z

Kingraptor: /* Unit-Specific: */ formatting + info on UnitGiven/Taken

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

==Engine Source==
If you can understand Lua code well and wish to get the most up to date info, you can refer to:
{{sourcelink|file=cont/base/springcontent/LuaGadgets/actions.lua}},
{{sourcelink|file=cont/LuaUI/widgets.lua}} and 
{{sourcelink|file=cont/base/springcontent/LuaGadgets/gadgets.lua}} 
to see how widget/gadget call-ins are distributed, find call-in and widgetHandler function definitions, see how they are processed and what values should be returned from some call ins
(are these the only files?)

==What is a callin anyway?==
Call-ins are calls from the engine, into the gadget or widget script. In other words, these functions are called when a particular â€œeventâ€ happens.
Some call-in functions can return values to the engine.
===Blocking events with return values===
The call-in functions named '''''Allow'''''XXX can block their event by returning ''false''. 
For example ''AllowUnitTransfer()'' 
<code>return true</code> = allow transfer 
<code>return false</code> = deny transfer

==Commands, general-purpose:==

Initialize() --> none. 
called when widget/gadget gets (re-)loaded.

Shutdown() --> none.

PlayerChanged --> (playerID).
gadget/widget: Use this to check whether a player has become spectator for instance.

LayoutButtons() --> unknown, please document.

ConfigureLayout() --> "command".

CommandNotify() --> "id, params, options", where id = the CommandID

KeyPress() --> "key, mods, isRepeat", where key = keymap, mods = SHIFT, etc.

KeyRelease() --> "key"

MouseMove() --> "x, y, dx, dy, button"

MousePress() --> "x, y, button" 
button parameter values: left - 1, middle - 2, right - 3

{{new|>96.0}} buttom param removed {{Sourcelinkhash|4c104344e92256e33d79820e9012c5e1178e212b}}

MouseRelease() --> "x, y, button" 
Please note that in order to have Spring call MouseRelease, you need to have a MousePress call-in in the same widget that returns true.

MouseWheel() --> "up, value"

IsAbove() --> "x, y" where x,y = screen coordinates.

GetTooltip() --> "x, y" where x,y = screen coordinates. Returns WorldTooltip.

AddConsoleLine() --> "msg, priority"

MapDrawCmd() --> "playerID, cmdType, px, py, pz, labeltext"

AllowCommand() --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag, synced"

CommandFallback() --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag"

CommandsChanged() --> unknown (none?)

AllowUnitCreation() --> "unitDefID, builderID, builderTeam, x, y, z, facing"

AllowUnitTransfer() --> "unitID, unitDefID, oldTeam, newTeam, capture"

AllowUnitBuildStep() --> "builderID, builderTeam, unitID, unitDefID, part"

AllowFeatureCreation() --> "featureDefID, teamID, x, y, z"

AllowFeatureBuildStep() --> unknown, please document.

AllowResourceLevel() --> "teamID, res, level"

AllowResourceTransfer() --> "teamID, res, level"

Update() --> "dt" 
called every screenframe. dt is the time since the last screenframe

DefaultCommand() --> "type,id" 
can return an [[Lua_CMDs|CMD]] to change cursor and command. {{forumlink|topic=26438|title=example usage}}

AllowDirectUnitControl(unitID, unitDefID, unitTeam, playerID) -> allowFpsControl 
''return true'' allows fps mode, ''return false'' blocks it.

==Unit-Specific:==

UnitPreDamaged() --> "unitID, unitDefID, unitTeam, damage, paralyzer, weaponDefID, attackerID, attackerDefID, attackerTeam" (prior to 94.0)

UnitPreDamaged() --> "unitID, unitDefID, unitTeam, damage, paralyzer, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam" (as of 94.0)

UnitDamaged() --> "unitID, unitDefID, unitTeam, damage, paralyzer, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam" (as of 95.0) 
Can overwrite the taken damage by returning a new number value. 

As of 88.0 for both UnitDamaged and UnitPreDamaged:
weaponDefID -1 --> debris collision
weaponDefID -2 --> ground collision
weaponDefID -3 --> object collision
weaponDefID -4 --> fire damage
weaponDefID -5 --> water damage
weaponDefID -6 --> kill damage
weaponDefID -7 --> crush damage

As of 96.0 {Unit,Feature}{Pre}Damaged events receive the 'attacker' ID when object is crushed

UnitExperience() --> "unitID, unitDefID, unitTeam, experience, oldExperience" 
Spring.SetExperienceGrade must be called first to determine how often it is called

UnitCreated() --> "unitID, unitDefID, teamID, builderID"

UnitFinished() --> "unitID, unitDefID, teamID"

UnitFromFactory() --> "unitID, unitDefID, unitTeam, factID, factDefID, userOrders"

UnitDestroyed() --> "unitID, unitDefID, teamID, attackerID, attackerDefID, attackerTeamID"

UnitTaken() --> "unitID, unitDefID, unitTeam, newTeam" 
Unit still belongs to old team

UnitGiven() --> "unitID, unitDefID, unitTeam, oldTeam" 
Unit now belongs to new team

UnitIdle() --> "unitID, unitDefID, teamID"

UnitCommand() --> "unitID, unitDefID, unitTeam, cmdID, cmdOpts, cmdParams, cmdTag" (cmdTag only available from version 95.0)

UnitSeismicPing() --> "x, y, z, strength"

UnitEnteredRadar() --> "unitID, unitTeam"

UnitEnteredLos() --> "unitID, teamID"

UnitLeftRadar() --> "unitID, unitTeam"

UnitLeftLos() --> "unitID, unitDefID, teamID"

UnitLoaded() --> "unitID, unitDefID, unitTeam, transportID, transportTeam"

UnitUnloaded() --> "unitID, unitDefID, teamID, transportID"

UnitCloaked() --> "unitID, unitDefID, teamID"

UnitDecloaked)--> "unitID, unitDefID, teamID"

UnitMoveFailed() --> "unitID, unitDefID, unitTeam"
 Only called for unitDefIDs registered via [[Lua_System#Synced|Script.SetWatchUnit]] since 85.0

StockpileChanged() --> "unitID, unitDefID, unitTeam, weaponNum, oldCount, newCount"

UnitEnteredWater() --> "unitID, unitDefID, teamID"
(as of 95.0)

UnitEnteredAir() --> "unitID, unitDefID, teamID"
(as of 95.0)

UnitLeftWater() --> "unitID, unitDefID, teamID"
(as of 95.0)

UnitLeftAir() --> "unitID, unitDefID, teamID"
(as of 95.0)

ShieldPreDamaged() --> "proID, proOwnerID, shieldEmitterWeaponNum, shieldCarrierUnitID, bounceProjectile"

UnitUnitCollision(colliderID, collideeID) -- needs SetWatchUnit enabled for both parties

AllowWeaponTargetCheck(attackerID, attackerWeaponNum, attackerWeaponDefID) Only called for weaponDefIDs registered via [[Lua_System#Synced|Script.SetWatchWeapon]] since 92.0

AllowWeaponTarget(attackerID, targetID, attackerWeaponNum, attackerWeaponDefID, defaultPriority)
--> <code>return "targetAllowed, targetPriority"</code>
defaultPriority new in 89.0 

Only called for weaponDefIDs registered via [[Lua_System#Synced|Script.SetWatchWeapon]] since 92.0

DrawShield(number unitID, number weaponID) --> boolean

''true'' (<-?) skips Spring's own drawing of shield <weaponID> owned by unit <unitID>

[https://github.com/spring/spring/commit/7bbfd9464d4f74c12163ea0740c8c60d1ba978f1 maybe new in 86.0+]

==Feature-Specific:==

FeatureCreated() --> "featureID, allyTeam"

FeatureDestroyed() --> "featureID, allyTeam"

TerraformComplete() --> "unitID, unitDefID, unitTeam, buildUnitID, buildUnitDefID, buildUnitTeam"

UnitCmdDone() --> "unitID, unitDefID, unitTeam, cmdID, cmdTag, cmdParams, cmdOptions" cmdParams and cmdOptions are only available from version 95.0

UnitFeatureCollision(colliderID, collideeID, crushKilled) -- needs SetWatchUnit for first and SetWatchFeature for second party

{{new|95.0}} FeatureDamaged() --> "featureID, featureDefID, featureTeam, damage, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam"

{{new|95.0}} FeaturePreDamaged() --> "featureID, featureDefID, featureTeam, damage, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam"

<code>--> return newDamage, impulseMult (=0)</code>

==Drawing:==
Inside these functions, you can use the [[Lua_OpenGL_Api | Lua OpenGL Api]] to draw graphics.

* DrawGenesis() --> none. Don't render here.

Spring draws the sky, the map, some water types, and unit selection.

* DrawWorldPreUnit() --> none.

Spring draws units, features, some water types, cloaked units, and the sun.

* DrawWorld() --> none.

Spring draws command queues, 'map stuff', and map marks.

Each unit might also have a DrawUnit call, [[Lua_UnitRendering|enabled here.]]

DrawUnit(unitID,DrawMode) 
With enum DrawMode { 
notDrawing = 0, 
normalDraw = 1, 
shadowDraw = 2, 
reflectionDraw = 3, 
refractionDraw = 4 
};

DrawFeature(featureID, DrawMode) 

DrawShield(unitID, weaponID, DrawMode) 

DrawProjectile(projectileID, DrawMode) 

DrawScreenEffects() --> "vsx, vsy" where vsx, vsy are screen coords.

DrawScreen() --> none.

DrawInMiniMap() --> "sx, sy" where sx,sy are values relative to the minimap's position and scale.

DrawWorldShadow() --> none.

DrawWorldReflection() --> none.

DrawWorldRefraction() --> none.

DrawLoadScreen() --> none. {{new|95.0}}

Only available to LuaIntro, draws custom load screens.

==Game Events:==

GameID() --> "gameID" {{new|89.0}}

Explosion() --> "weaponID, px, py, pz, ownerID"
 Only called for weaponDefIDs registered via Script.SetWatchWeapon
 return true to hide the weapon's CEG

ShockFront() --> "power, dx, dy, dz" Not yet implemented!

GameFrame() --> "frameNum"

CobCallback() --> unknown, marked FIXME.

GroupChanged() --> "groupID" where groupID is the value of Group whose table value changed.

WorldTooltip() --> "ttType, data1, data2, data3" special, should be documented in detail. Not yet implemented!

GamePreload() --> none.

GameStart() --> none.

GameProgress() --> "serverFrameNum" ( called every 60 frames, calculating delta between GameFrame and GameProgress can give an ETA about catching up with simulation ) Not yet implemented!

GameOver() --> "[ [1] = allyTeamID1, [2] = allyTeamID2, ... ]", a list of winning allyteams, if empty the game result was undecided ( like when dropping from an host ) Will return nil in pre 0.83.x

TeamDied() --> "TeamID" where TeamID = the team that has been eliminated.

AllowStartPosition() -->
number clampedPos.x, number clampedPos.y, number clampedPos.z,
number playerID,
number readyState,
number rawPickPos.x, number rawPickPos.y, number rawPickPos.z

clampedPos = coordinates clamped into startbox, rawPickPos = where player tried to start

{{New|95.0}} the default 'failed to choose' start-position is now just (0,0,0), not (0,-500,0)

readyState can be any one of:
PLAYER_RDYSTATE_UPDATED = 0 -- player picked a position
PLAYER_RDYSTATE_READIED = 1 -- player clicked ready
PLAYER_RDYSTATE_FORCED = 2 -- game was force-started (player did not click ready)
PLAYER_RDYSTATE_FAILED = 3

GameSetup() --> string "state", boolean "ready", table "playerStates"
 return success, newReady

GamePaused() --> "playerID, paused"

PlayerAdded() --> "playerID"

PlayerRemoved() --> "playerID, reason"

==Projectiles:==

ProjectileCreated() --> "proID, proOwnerID, weaponDefID"
 Only called for weaponDefIDs registered via Script.SetWatchWeapon

ProjectileDestroyed() --> "proID"
 Only called for weaponDefIDs registered via Script.SetWatchWeapon

AllowWeaponInterceptTarget --> "number interceptorUnitID, number interceptorWeaponID, number targetProjectileID"
returns boolean
 Only called for weaponDefIDs registered via Script.SetWatchWeapon

[[Category:Lua]]

Lobby Development

2013-11-11T09:30:46Z

Kingraptor: /* Lobby client development */

[[Engine_Development|Development]] < {{FULLPAGENAME}}

=Documentation=

==Protocol==
* [http://springrts.com/dl/LobbyProtocol/ HTML] (is updated once a day)
* [https://github.com/spring/LobbyProtocol/blob/master/ProtocolDescription.xml XML] (raw, always latest)

==Download Systems==
* [http://springrts.com/wiki/Dev:LobbyDownloadSystems Lobby Download Systems]

=Lobby client development=

==Useable lobby clients==

===SpringLobby===
cross-platform,
C++,
by BrainDamage &
koshi

SpringLobby is the official lobby client of spring and is bundled with the Spring engine in the installer. It uses the ''wxWidgets'' library. You can browse the sources and submit issues on its [http://springlobby.info/ website].

===Zero-K Lobby===
Windows/Linux,
C#,
by Licho & quantum

[https://code.google.com/p/zero-k/ Zero-K project page]

===TASClient===
Windows,
Delphi,
by Satirik

You can download the sources from the [http://springrts.com/svn/spring/Lobby/TASClient/ subversion repository] (svn://springrts.com/svn/spring/Lobby/TASClient/) and browse them on the [http://springrts.com/websvn/listing.php?repname=Spring&path=%2FLobby%2FTASClient%2F#_Lobby_TASClient_ websvn]. Latest binary version is always available here:
http://springrts.com/dl/tasclient/TASClientLatest.7z

[http://springrts.com/phpbb/viewtopic.php?f=12&t=18999 How to compile TASClient]

[http://springrts.com/phpbb/viewtopic.php?f=14&t=19014 How to customize TASClient]

===flobby===
Linux,
C++,
by cleanrock

[https://github.com/cleanrock/flobby github page]

===Weblobby===
cross-platform,
Java,
by CarRepairer

[http://weblobby.springrts.com weblobby.springrts.com]

[https://code.google.com/p/springweblobby/ project site]

==Work in progress or abandoned==

===Alphalobby===
Windows,
C,
unmaintained

Alphalobby is still very much work in progress. If you still wish to use it, source available from the [http://code.google.com/p/alphalobby/source/checkout mercurial repository], binary available on the [http://springfiles.com/spring/lobby-clients/alphalobby springfiles page].

===CheeseLobby===
cross-platform,
Java,
by Cheesecan

[http://springrts.com/phpbb/viewtopic.php?f=64&t=24905 forum thread]

[https://github.com/jahwag/cheeselobby binaries and code]

===QtLobby===
cross-platform,
C++,
unmaintained

[https://github.com/tizbac/qtlobby project page]

=Libraries and frameworks=

==Spring-PythonBotFramework==
cross-platform,
Python, by
BrainDamage & koshi

A bot framework written in python. [https://github.com/renemilk/tasbot/wiki GitHub wiki]

==Go SpringLobbyClient==
cross-platform,
Go

A simple client implementation of the lobby protocol in Go.
[https://github.com/Agon/go-slc/ project page]

=Lobby server development=

==SpringLS==
cross-platform,
Java,
hoijui

The longest-running lobby server, created by Betalord. You can fetch the sources through ''git''. Details can be found on the [http://github.com/spring/SpringLS development site].

==UberServer==
cross-platform,
Python,
by aegis

The primary lobby server currently running on springrts.com. All protocol commands in the primary documentation should be fully-functional and compatible between both uberserver and SpringLS. See the dedicated [[uberserver]] for mor info.

[[Category: Lobby]]

Changelog

2013-11-08T12:50:45Z

Kingraptor: fix mass bolding

__NOTOC__
=95.0=

==Major==
* new datadir structure: http://springrts.com/phpbb/viewtopic.php?f=12&t=30044 & http://springrts.com/dl/buildbot/default/master/95.0/manpages/spring.6.html
* new LuaIntro (Lua based loadscreen with examples)
* add map border rendering (+ /mapborder command)
* bugfixes & speedups
* remove support for SM3 maps (but fix #3942 so SM3 is left in a slightly less broken state for whoever wants to mess with it in the future)

==Performance==
* use SSE in some matrix math
* save a little mem in Pathfinder
* reduce PFS update rate by 10%
* little speedup in Grass rendering (it's still slow on some maps)
* use 32bit shadowmap. ~7% faster than 24bit one, cause of better alignment
* move Lua GC to its own callin; fixes bug where GC was too slow to catch up and ate >>100MB ram
* nihiliate MiniMap usage by rendering it to a texture
* PathEstimator: add unsynced caches (*might* help in big AI games)
* ExplosionGenerator: pre-load all static (weapon/model/piece) CEG's and never do lazy script-parsing anymore where possible
 (only CEG's delay-spawned by other CEG's are still loaded this way, rest can be dynamically reloaded)
* PFS: prevent special-case search expansion when unit is close to goal but goal is blocked
* make FeatureHandler::AllocateNewFeatureIDs more efficient in case of feature spam

==Misc==
* force-align all thread entry points so SSE functions don't crash (on win32)
* allow Lua AI's to be selected from the menu
* removed "mods" from archive scandirs
* converted RotateLogFiles to a bool var (defaults to false)
* remove "--projectiledump" and add "--list-ceg-classes" (converted to JSON format )
* do not switch camera-mode on countdown
* colorized stdout (you can use `spring --nocolor` & SPRING_NOCOLOR envvar to disable)
* show LuaMemUsage in /debug view
* load only image formats which work on all platforms, current supported image formats are: PNG, JPG, TGA, DDS, BMP
* remove engine support for gamedata/messages.tdf, see examples/Widgets/game_messages.lua for a possible replacement
* more verbose CEG parsing (warns now about unknown tags)
* switch to a high precision clock all over the engine (including Lua) NOTE THAT THIS IS DISABLED BY DEFAULT ON WINDOWS BUILDS (cf. UseHighResTimer)
* copied a lot config descriptions from wiki to the engine (thx for all the wiki'ers)
* http://springrts.com/wiki/Springsettings.cfg is now automatically updated with each release
* disable build of spring-multithreaded (unmaintained / doesn't compile)
* disable luaThreadingModel > 2, can be overriden with EnableUnsafeAndBrokenMT=1 fixes #3774, #2884, #2784, #3673, #3808
* more verbosity for spring-dedicated on exit & demo-writing
* add config "MenuArchive" to allow background image to be set which is read from the archive in the path bitmaps/ui/background/
* fix /keydebug for release builds
* updated game_end example gadget to handle quit/resigns better, reacts faster, and better code
* GuiTraceRay does not stop at water surface anymore by default (all ground-attack positions are adjusted in synced code now)
::*-> torpedo launchers cannot overshoot, etc.
* GuiTraceRay now ignores noSelect units
* SmoothCameraController: add SMOOTHing to alt+mousewheel zoom
* change WorldObject::speed to a float4, store magnitude in .w (saves a number of unnecessary .Length() calls here and there)
* PathCache: track maximum size + double initial capacity, register hash collisions and switch hash function
* GameServer: add config-option ServerRecordDemos non-dedicated servers (eg. headless builds used as "dedicated" standin) can now record games if desired ACHTUNG: server demos are now stored in a separate directory "demos-server/" to prevent name conflicts!
* AssParser: generalize logic for multiple UV channels fix major issue with baked transforms restrict support to well-known & -maintained formats (.3DS, .DAE, .LWO, .BLEND) allow modellers to work around #3552 by recognizing a number of new piece-table keys for the root piece: "xaxis" = float3, "yaxis" = float3, "zaxis" = float3 (determine global orientation of model) for all pieces: "rotAxisSigns" = float3 (determines direction of script-applied rotations around each axis) "rotAxisMap" = number (currently can only be 0=XYZ or 3=XZY, determines coordinate conversion)

* SpringApp: fix old bug in fullscreen&&dualscreen mode cutting window-size in half on each SDL_VIDEOEXPOSE event refactor to allow choice of (win32) timer via cmdline&config
* SpringTime: switch to native win32 clock (same as used by SDL) on windows select win32 clock based on config&cmdline-parameter 'useHighResTimer' remove the last SDL_GetTicks dependencies

==Sim==
* reduce target-lost CAI timeout from 8 to 2 seconds
* make calls to script->{Start, Stop}Moving more consistent: only run them when a unit transitions from zero to non-zero speed or vice versa, and no longer do so during in-place rotations --> animations should no longer be interrupted / reset THIS APPLIES TO ALL UNIT TYPES (AIR AND GROUND), TEST YOUR SCRIPTS
* remove TA-specific code in CobInstance::Create (this changes the argument value to COB's SetMaxReloadTime for units equipped with BeamLasers and / or more than one weapon)
* {Laser, Emg}Projectile: disable all collision-testing when ttl <= 0 these projectile types could exceed their range due to fadeout and only removed themselves (deleteMe=true) when intensity or length reached 0, so without disabling coldet (checkCol=false) range-exploits were possible
* remove impulse "capacitance" from ground units (SolidObject::residualImpulse and ::StoreImpulse())
* apply UnitDef::myGravity to ground units (if non-zero) NOTE: myGravity acts as a map-gravity MULTIPLIER for aircraft; it REPLACES map gravity for land-based units
* steering/avoidance: actively avoid only mobile units, let PFS/CD handle statics

* SolidObject: cleanup internal physical/collision state management
 model physical drag, use it for features and skidding units
== related to the change above Spring.Set*Physics now takes three extra number arguments (Set*Physics(..., number drag.x, number drag.y, number drag.z)) to control how much an object is affected by drag forces==

* Feature: set default impulseMult to 0 for 'immobile' / static wreckage (cf. new FeaturePreDamaged)
* Unit: transfer impulse to transporter if being transported
* Unit: swap order of UnitPreDamaged and HitByWeapon callins (viewtopic.php?f=23&t=30879)

* *Weapon: fix minor targeting issues due to new SolidObject underwater state definition
* LaserCannon: calculate projectile ttl from weapon range, not weapondef range
* BombDropper: *always* drop bombs/torpedoes in time to hit target (even if the distance from weapon to target still exceeds static range, range is not meaningful for these weapons anyway since it depends on launching unit's velocity, altitude and gravity)

* BeamLaser: fully reimplement the sweepfire logic still has no script interaction so use with care (respects reloadtime constraint but not much else)

:* UnitDef: read brakeRate for aircraft without scaling by 0.1 and make brakeRate default to maxAcc, not maxAcc * 3.0 (--> open up your unitdef_post's)
* WeaponDef: silently ignore bad slavedTo indices
* MoveDef: remove old naming-scheme restrictions (which required names to contain "tank", etc) instead parse key "speedModClass" with accepted values 0=Tank, 1=KBot, 2=Hover, 3=Ship
 fix insane default value for heatMod parameter (since 7bef7760f4)

* MoveType: fix LOS emit-heights for floating units being relative to ocean floor
* AAirMoveType: do not use fuel while being refueled (yo dawg...)
* StrafeAirMoveType: overshoot less when landing
* HoverAirMoveType: remove support for reading (and assigning to) key "brakeDistance" via MoveCtrl; this quantity is now calculated dynamically based on speed
* GroundMoveType: add missing TestMoveSquare checks in places where units are repositioned by coldet fix minor bug in GetGroundHeight (caused hovercraft to vibrate in shallow water)

* remove ancient "move transportee 1000 elmos under the map to hide it when attaching to piece -1" hack there is now a "void" state for such purposes; objects (units and features) in this state will never 1) take damage, even from Lua (but can be killed by Lua) 2) be rendered through any engine path (nor their icons) 3) be intersectable by either synced or unsynced rays 4) block any other objects from existing on top of them 5) be selectable
:::
* hovercraft now take water damage by default

==Lua==
* LuaUnitDefs: deprecate the "drag" key, was an internal variable
* LuaUnitDefs: add more is* functions for all unit-types known to Spring the complete function list as of 95.0 is: isTransport isImmobile isBuilding isBuilder isMobileBuilder isStaticBuilder isFactory isExtractor isGroundUnit isAirUnit isStrafingAirUnit isHoveringAirUnit isFighterAirUnit isBomberAirUnit fully deprecate the following UnitDef keys: after 95.0 these will all become nil, beware .builder .floater .canDGun .canCrash .isCommander .moveData .type .maxSlope

* LuaUnitDefs: deprecate canHover (check moveDef.family instead to determine if a unit is a hovercraft)
* LuaUnitDefs: log error when explodeAs & selfDestructAs are missing
* LuaUnitScript: optionally make Turn and Move insta-update piece matrices (pass "true" as the fifth argument)
* LuaRules: setup "proper" (transformation) state for the DrawProjectile callin
 add callin AllowWeaponInterceptTarget(number interceptorUnitID, number interceptorWeaponID, number targetProjectileID) --> boolean add callins FeatureDamaged and FeaturePreDamaged FeatureDamaged( number featureID, number featureDefID, number featureTeam, number damage [, number weaponDefID, number projectileID [, number attackerID, number attackerDefID, number attackerTeam ]] ) FeaturePreDamaged( number featureID, number featureDefID, number featureTeam, number damage [, number weaponDefID, number projectileID [, number attackerID, number attackerDefID, number attackerTeam ]] )

* LuaSynced*: make sure ALL weapon API functions are 1-based UPDATE YOUR GAME'S UNIT_SCRIPT.LUA IF IT HAS LUA-SCRIPTED UNITS AND YOU ARE NOT USING SPRING'S (BASECONTENT) VERSION

* LuaSynced*: make {S,G}et{Unit,Feature}Blocking signatures match Get{Unit,Feature}Blocking(number objectID) --> boolean isBlocking, boolean isSolidObjectCollidable, boolean isProjectileCollidable, boolean isRaySegmentCollidable, boolean crushable, boolean blockEnemyPushing, boolean blockHeightChanges
 Set{Unit,Feature}Blocking( number objectID, boolean isBlocking, boolean isSolidObjectCollidable [, boolean isProjectileCollidable [, boolean isRaySegmentCollidable [, boolean crushable [, boolean blockEnemyPushing [, boolean blockHeightChanges ]]]]] )

* LuaSynced*: slightly change {Get,Set}ProjectileTarget signatures GetProjectileTarget now returns a number instead of a string to indicate target-type GetProjectileTarget now always returns two arguments (if given projectileID is valid) GetProjectileTarget now always returns a target position if projectile has no target object SetProjectileTarget now takes a number instead of a string to indicate target-type
::: GetProjectileTarget(number projectileID) --> nil | [number targetType, number targetID | table targetPos = {[1] = x, ...}] SetProjectileTarget(number projectileID, [number targetID [, number targetType]] | [number x, number y, number z]) --> nil | boolean
::: where targetType is one of {string.byte('g') = GROUND, string.byte('u') = UNIT, string.byte('f') = FEATURE, string.byte('p') = PROJECTILE}

* LuaSynced*: add callout Spring.GetRadarErrorParams(number allyTeamID) --> nil | number allyteamErrorSize, number baseErrorSize, number baseErrorMult add callout Spring.SetRadarErrorParams(number allyTeamID, number allyteamErrorSize [, number baseErrorSize [, number baseErrorMult ]]) --> nil
 add callout Spring.SetUnitPosErrorParams(number unitID, number posErrorVector.x, number posErrorVector.y, number posErrorVector.z, number posErrorDelta.x, number posErrorDelta.y, number posErrorDelta.z [ , number nextPosErrorUpdate]) --> nil add callout Spring.GetUnitPosErrorParams(number unitID) --> nil | number posErrorVector.x, number posErrorVector.y, number posErrorVector.z, number posErrorDelta.x, number posErrorDelta.y, number posErrorDelta.z, number nextPosErrorUpdate
 add callout Spring.SetFeatureBlocking(args = see SetUnitBlocking) --> boolean add callout Spring.SetPieceProjectileParams(number projectileID, [ number explosionFlags, [ number spinAngle, [ number spinSpeed, [ number spinVector.x, [ number spinVector.y, [ number spinVector.z ]]]]]]) --> nil deprecate the Spring.SetProjectileSpin* functions add callout Spring.GetFeatureBlocking(number featureID) --> boolean collidable, boolean crushable, boolean blocking add third return-value to Spring.GetUnitBlocking (signature is the same as that of GetFeatureBlocking)

* LuaSyncedCtrl: add callout SetProjectileAlwaysVisible(number projectileID, boolean alwaysVisible) --> nil add callouts SetFeatureVelocity and SetFeaturePhysics (these work like their SetUnit* counterparts, reference the wiki docs)
== cleanup arg-parsing of Spring.SetUnitPieceCollisionVolumeData callout new signature SetUnitPieceCollisionVolumeData( number unitID, number pieceIdx, boolean enable, number scales.x, number scales.y, number scales.z, number offset.x, number offset.y, number offset.z [, number volumeType [, number primaryAxis]] )==

* LuaSyncedRead: deprecate the Spring.GetProjectileSpin* functions
* LuaSyncedRead: add Spring.GetPieceProjectileParams(number projectileID) --> number explosionFlags, number spinAngle, number spinSpeed, number spinVector.x, number spinVector.y, number spinVector.z add callout Spring.GetUnitWeaponCanFire(number unitID, number weaponNum) --> boolean add callout Spring.GetFeatureVelocity(number featureID[, boolean norm]) --> nil | number vel.x, number vel.y, number vel.z[, number |vel|] and Spring.GetProjectileDirection(number projectileID) --> nil | number dir.x, number dir.y, number dir.z add callout Spring.GetProjectileDefID(number projectileID) --> nil | number weaponDefID using this to get a weaponDefID is HIGHLY preferred to indexing WeaponDefNames via GetProjectileName add callout Spring.GetUnitRotation(number unitID) --> nil | number pitch, number yaw, number roll (WIP) extend arguments to Spring.TestMoveOrder old signature: TestMoveOrder( number unitDefID, number pos.x, number pos.y, number pos.z ) --> boolean new signature: TestMoveOrder( number unitDefID, number pos.x, number pos.y, number pos.z [, number dir.x [, number dir.y [, number dir.z [, boolean testTerrain [, boolean testObjects [, boolean centerOnly ]]]]]] ) --> boolean
 added GetUnitWeaponTarget(unitID, weaponID) -> nil | number targetType [, bool isUserTarget, table targetPos = {x, y, z} | number targetID] (returned number of args is always 3 if targetType != None)

* LuaUnsyncedRead: add callout Spring.GetPixelDir(int x, int y) -> number dirx, number diry, number dirz add callout Spring.GetVisibleProjectiles( [ number allyTeamID = -1 [ , boolean addSyncedProjectiles = true [ , boolean addWeaponProjectiles = true [ , boolean addPieceProjectiles = true ]]]] ) --> nil | {[1] = projectileID, ...}

* Spring.GetUnitNearestEnemy doesn't return neutral units anymore
* Spring.GetProjectileVelocity now returns (targetPos - startPos) for BeamLasers and other hitscan weapons
* Spring.Get{}Velocity: always return speed.w (it's free now)
* Spring.SpawnCEG: allow number (cegID) as first arg + return a second value (number cegID)
* add Spring.GetLogSections() & Spring.SetLogSectionFilterLevel(string sectionName, string|number logLevel)
* add new Game. constants: Game.gameName, Game.gameVersion, ...
* allow to save strings in RulesParams
* add 'parent' field to Spring.GetUnitPieceInfo
* GadgetHandler: add several missing callins (AllowStartPosition, ...) expose actionHandler through gadgetHandler table (seems to be a common enough mod) log if callin is not implemented unify callin lists (now all in callins.lua) add missing projectileID argument to UnitDamaged

* LuaOpenGL::Draw{List,Func}AtUnit: just use drawPos or drawMidPos

* gl: add callout UniformArray(number location, number type, table uniforms) -> nil (type can be one of {0 = int, 1 = float})
* gl.CreateShader: support uniform arrays (table values with more than 4 and up to 32 elements)
* gl.CreateShader: make 'definitions' a recognized key (whose value should be a subtable or string of shader #define's)

* Spring.{Get,Diff}Timer(s): save some precision (important with new high-resolution timers)
* Spring.DiffTimers: accept optional third argument (boolean) to return dt in milliseconds

* add some utility functions to the math table, see http://springrts.com/wiki/Lua_MathExtra

==Rendering==
* LoadingMT: add a runtime check that should detect incompatibilities
* disable ARB shaders with Intel/Mesa drivers (can be overridden by setting ForceEnableIntelShaderSupport=1)
* reduce used varyings in SMF GLSL shader in the hope it will fix advmapshading on some lowend GPUs
* render MiniMap to a texture and update it async from screen (new configtags: MiniMapRenderToTexture & MiniMapRefreshRate)
* do not draw ground reflections in water if drawGround=false
* 3DModel: do not set tex1 to 'default.png' (it breaks assimp's auto-texturing ability)
* SMFFragProg: fix '#version must occur before any other statement' and eliminate dynamic branching

* implement Lua-bindable map and model normal/depth/material buffers note: this is *FULLY* compatible with custom Lua UnitRendering shaders (even easier if some minor framework changes are made) so the vast majority of deferred rendering operations is now within Lua's abilities
== new configuration-keys to enable/disable G-buffer draw-passes AllowDeferredMapRendering (default true) AllowDeferredModelRendering (default true)==
== new LuaUnsyncedCtrl callouts to enable/disable G-buffer updates Spring.SetDrawGroundDeferred(boolean) -> nil Spring.SetDrawModelsDeferred(boolean) -> nil==
== new LuaUnitRendering Material keys "standard_shader" (same as "shader") "deferred_shader" = {vertex = ..., ...} "deferred" (same as "deferred_shader")==
 deferred fragment shaders must *ONLY* write to gl_FragData[i] where i = {0 = normals, 1 = diffuse, 2 = specular, 3 = emissive, 4 = misc}
== new Lua texture names "$map_gb_nt" or "$map_gbuffer_normtex" "$map_gb_dt" or "$map_gbuffer_difftex" "$map_gb_st" or "$map_gbuffer_spectex" "$map_gb_et" or "$map_gbuffer_emittex" // for emissive materials (bloom would be the canonical use) "$map_gb_mt" or "$map_gbuffer_misctex" // for arbitrary shader data "$map_gb_zt" or "$map_gbuffer_zvaltex"==
 "$mdl_gb_nt" or "$model_gbuffer_normtex" "$mdl_gb_dt" or "$model_gbuffer_difftex" "$mdl_gb_st" or "$model_gbuffer_spectex" "$mdl_gb_et" or "$model_gbuffer_emittex" "$mdl_gb_mt" or "$model_gbuffer_misctex" "$mdl_gb_zt" or "$model_gbuffer_zvaltex"

==Buildprocess==
* updated gentoo overlay url to https://github.com/springlobby/overlay
* switch to mingw64 for the windows build
* remove some custom Find*.cmake files
* fix #3645 Can't build if source directory has white spaces
* removed VS project files / fix compile with Visual Studio 2012 Express for Windows Desktop: use cmake -G "Visual Studio 11" to generate project files dropped support for Visual Studio 8, 9 & 10 see http://springrts.com/wiki/Building_Spring_on_Windows
* compile Spring using c++11 standard
* fix clang compile errors + some bugs detected by clang
* slightly refactored build system, now every target can be disabled: spring-dedicated, spring-headless, spring-legacy, spring-multithreaded
* more unittests (extended FileSystem, timers, unitsync, SSE Matrix Math, ...)
* fix some errors when running spring in-source (AI / Interfaces are still broken)
* remove unused libspringserver

==Bugfixes==
* fix {Get,Set}UnitWeapon{Fire,HoldFire,TryTarget,TestTarget,TestRange,HaveFreeLineOfFire} WeaponID argument to use the same 1-starting indexes as rest of lua interface
* fix #4092 (empty pieces Explode()'d with PF_FIRE flag leave behind small stationary fire FX)
* fix #4079 (resurrecting could lead to multiple units created by one wreck)
* fix #4078 (float-->int conversion overflow)
* fix #4073 (fuel-level of unit is lowered upon completion)
* fix #4070 (units can skip attack orders in their queue)
* fix #4068 (the "wrong cursor for certain attack commands" part)
* fix #4057 (double BeamLaser visualisation)
* fix #4054 (homing missiles miss radar dots of flying units)
* fix #4047 (ground decals don't fade away)
* fix #4043 (constructors can build large units ontop of themselves & walk through 'gaps')
* fix #4023 (allow 'key'=value options-table format in Spring.GiveOrderTo*)
* fix #4019 (receiveTracks not working reliably)
* fix #4011 (GetTeamStartPosition cannot determine whether start position was placed by player)
* fix #4010 (disable /spectator before gamestart)
* fix #4007 (large-radius air transports failing to load transportees)
* fix #3980 (air transports set to 'Land' wander around while idling if loaded)
* fix #3979 (unhelpful error message)
* fix #3974 (out-of-fuel bombers set to 'Land' fly all over the map)
* fix #3973 (aircraft taking off in wrong direction on attack orders)
* fix #3961 (expect ArmorDef subtables in array-format, show warning if armordefs contains old-style subtable entries)
* fix #3959 ("flying" ground-units colliding with aircraft looks unrealistic)
* fix #3957 (Unit icons of underwater units are drawn at water level instead of actual depth)
* fix #3951 submissile was being checked in the base-class for all weapons despite being a TorpedoLauncher-only property
* fix #3948 (broken voidwater shading)
* fix #3941 (CBitmapMuzzleFlame doesn't render when dir is <0 -1 0>)
* fix #3937 (transport unloading on top of non-blocking objects)
* fix #3924 (add callout Spring.UpdateInfoTexture(number texMode) --> boolean)
* fix #3890 (Unloaded units fly across the map)
* fix #3873 (lag while loading model-less features)
* fix #3862 (aircraft overshooting/flailing around repair pads, also #3834)
* fix #3861 (BeamLaser does not hit if it starts within hitvolume)
* fix #3855 (LosHandler bug that made provided full LOS on underwater units in radar coverage)
* fix #3835 (try to avoid clash between Weapon::AutoTarget and MobileCAI::AutoGenerateTarget)
* fix #3785 (Construction aircraft getting stuck)
* fix #3783 (add FailedCommand sound to default sounds.lua)
* fix #3765 (make Gaia the default feature team, not -1/0)
* fix #3754 (high decal-strength unit tracks drawn twice due to alpha-wraparound)
* fix #3752 (safeguard execution of SimFrame() against garbage keyframe messages)
* fix #3743 (partially: make non-hovering aircraft start turning to goal during takeoff)
* fix #3739 (apply impulse to aircraft)
* fix #3737 gadget:AllowStartPosition() now receives the raw unclamped start position as three extra arguments
* fix #3736 (TextureAtlas crash)
* fix #3720 (unit pushed through impassable part of factory)
* fix #3718 (units moving in circles near obstacles)
* fix #3715: make all info-textures individually queryable by Lua (gl.Texture) "$info" and "$extra" still map to the active info-texture as before "$info_losmap" or "$extra_losmap" map to the L-view texture "$info_mtlmap" or "$extra_mtlmap" map to the F4-view texture "$info_hgtmap" or "$extra_hgtmap" map to the F1-view texture "$info_blkmap" or "$extra_blkmap" map to the F2-view texture
 textures contain no data until user switches to their respective modes non-active textures are not updated in the background, so will go stale

* fix #3714 (minimap icons of enemy units visible after /spectator plus /specfullview 0)
* fix #3697 Spring.GetPositionLosState now returns a 4th argument which indicates if a position is actively being radar- or sonar-jammed by any allyteam
* fix #3686 (free flying ground units follow terrain slope)
* fix #3683 (minimap textures not freed on exit)
* fix #3681 (make widgetHandler:LoadConfigData() more robust)
* fix #3675 wrong loglevel in unit_script.lua
* fix #3665 AllowStartPosition now receives the ready-state of each player as an argument too, making its complete signature as of 95.0:
 AllowStartPosition( number clampedPos.x, number clampedPos.y, number clampedPos.z, number playerID, number readyState, number rawPickPos.x, number rawPickPos.y, number rawPickPos.z )
== where readyState can be one of PLAYER_RDYSTATE_UPDATED = 0 -- player picked a position PLAYER_RDYSTATE_READIED = 1 -- player clicked ready PLAYER_RDYSTATE_FORCED = 2 -- game was force-started (player did not click ready) PLAYER_RDYSTATE_FAILED = 3==

::::* the default 'failed to choose' start-position is now just (0,0,0), not (0,-500,0)

* fix #3662 (secret)
* fix #3660 (memory leak in Spring.GetVisibleFeatures)
* fix #3655 (UnitDef::canMove misinterpreted by factory CAI code)
* fix #3653 (clash between mutually push-resistant units moving to same spot)
* fix #3643 (get PFS and CD to agree regarding factories)
* fix #3641 (fix several issues with units using per-piece collision volumes)
* fix #3640 (Groundplates don't disappear when out of LOS)
* fix #3637 (desyncs due to not versioning cache-data, also #3692)
* fix #3633 (non-3DO projectile models not being rendered fully)
* fix #3623 (broken PPCV offsets for DAE models)
* fix #3617 (ship transports can't load units)
* fix #3614 (units stuck on narrow terrain passages)
* fix #3606 (TorpedoLauncher force-attack aims at water surface)
* fix #3598 ("vibrating" ground units due to gravity)
* fix #3373 (crash when exiting before countdown finished)
* fix #1368 (AllowBuildStep only called for building)

* fix ground units not moving in FPS mode
* fix (non-hovering) aircraft jittering at high altitude
* fix submarines being considered "underwater" even when pos.y + height > 0
* fix subtle bug in LegacyAtlasAlloc::Allocate exposed by Intel GMA atlas could grow LARGER than its maximum size in x-dimension due to TEXMARGIN not being considered 3DO texture atlas has a maximum size of 2048 pixels but grew to 2050 pixels in at least one *A game on Intel hardware with maxTextureSize=2048 this caused driver memory corruption --> random crashes
* fix units switching team-colors
* fix debug-vectors for ground units being drawn even when not cheating or not spectating
* fix LoadScreen exception being thrown just for failing to load a startpic
* fix crash in Spring.GetVisibleUnits on bad teamID value
* fix C stack overflow in Shard
* fix logLevel of WatchDog stacktraces
* fix decals were rendered twice
* fix spike CEGs
* fix units with PPCV's ignoring mouse-rays; run PPCV test before CV test
* fix possible bug in MoveCtrl.SetMoveDef

==Sound==
* don't automaticly set "MaxSounds"
* try to fix "[Sound] Error: CSoundSource::Play: Unknown Internal Error" on Mac

==AI==
* removed unused AI_UnpauseAfterInit config setting

==UnitSync==
* add DeleteSpringConfigKey(const char* name)

=94.1=
* bump path cache version

=94.0=
==Misc==
* default LogFlush to true again
* fix crash at start related to Optimus
* remove Tobis rapid client (its broken)
* add multi engine type support
* recycle unit and feature ID's less quickly again, a la 91.0 and prior although this was an unintentional change in 92.* / 93.*, it exposed many bugs in widgets and gadgets which INCORRECTLY assumed ID's were globally unique for all time --> check your code for more latent bugs

==Rendering==
* automatic runtime recompression of groundtextures to ETC1 (future MESA drivers should support ETC)

==Bugfixes==
* fix #3591 (UnitFromFactory(..., userOrders) always passes userOrders=false)
* fix #3561 (units getting stuck on edges of impassable areas --> pathing is no longer FUBAR)
* fix #3575 (QTPFS terrain deformation lagspikes)
* fix #3580 (decreased unit/feature ID randomness)
* fix #3557 (TorpedoLauncher weapon fires only when on land)
* fix #3564 (sun-flare visible when obscured by terrain)
* fix #3553 (sun-flare has harsh edge)
* fix #3562 (units are reluctant to fire in crowded situations after 'fix #3488')
* fix #3559 (avoidGround weapon tag is broken)
* fix #3563 (units rub against building edges and slow down to a crawl) and #3592 related to it
* fix #3567 (transported nanotowers periodically teleporting to ground)
* fix #3520 (kamikaze units always have bad attack cursor when giving manual attack command)
* fix #3531 (wrong textures assigned to assimp models)
* fix #3545 (AddUnitImpulse() causes unit to move in random direction)
* fix #3544 (units briefly invisible when transferred to another team)
* fix #3490 (ships cannot be transported by aircraft)
* fix #3596 (in debug-mode the firing-cone visualisation of weapons points up)
* fix 'fix #3506 (wrong calculation of goffset for assimp model pieces)'
* fix pseudo-static units (nanotowers, etc) no longer being transportable
* fix #3569 (texturing for OBJ and ASS projectile models)
* fix OBJ models being parsed by assimp
* fix SEGV on exit
* fix flashing team colors
* fix some trees drawn after being destroyed

==Lua==
* add Spring.UnitWeapon{Fire,HoldFire}(number unitID, number weaponID) --> nil
* add callouts Spring.GetUnitWeapon{TryTarget,TestTarget,TestRange,HaveFreeLineOfFire}(number attackerID, number weaponID, number attackeeID | [number targetPosX, number targetPosY, number targetPosZ]) --> boolean
* add Spring.SetProjectileTarget(number projectileID, [number objectID, string objectType] | [number x, number y, number z]) --> boolean
* add Spring.GetProjectileTarget(number projectileID) --> number targetID, string targetType
* add Spring.SpawnProjectile(number weaponDefID, table projectileParams) --> number projectileID | nil
* add MoveCtrl.SetMoveDef(number unitID, number moveDefID | string moveDefName) --> boolean
* add projectileID argument to UnitPreDamaged OLD signature: unitID, unitDefID, unitTeam, damage, paralyzer [, weaponDefID [, attackerID, attackerDefID, attackerTeam] ] NEW signature: unitID, unitDefID, unitTeam, damage, paralyzer [, weaponDefID, projectileID [, attackerID, attackerDefID, attackerTeam] ]

=93.2=
* fixed unitsync in linux static builds

=93.1=
==Bugfixes==
* fixed treedrawer crash
* fixed MT crashes
* fixed X11 cursor offset
* fixed smooth camera transitions
* fixed clipped sun
* fixed selection sounds
* fixed attack cursor for kamikaze units
* fixed wrong assimp texture

=93.0=
==Bugfixes==
* fixed disappearing GUI with non-GLSL drivers & grass rendering (3dtrees=1)
* fixed not working assimp textures
* fixed /ally
* fixed /chat[|ally|spec|all], so it doesn't misbehave when called from lua
* fixed attack-ground orders placed on water
* fix bug in footprint overlap detection reported by dnw
* make dead/crashing/stunned units unshareable (may fix #3476)
* fixed objects with cylindrical CVs would not take damage if hit in rear endcap
* block Lua from creating non-uniformly scaled COLVOL_TYPE_SPHERE volumes
* make sure pastetext and buffertext don't strip whitespaces from the attached message
* allow whisper between spec <-> spec (player -> spec and spec -> player whispers are still forbidden)
* fixed flying transport reservation not flushed properly with area commands (#3478)
* fix #3481 (unit targets not flushed on cloak + jam)
* fix #3488 (avoidFriendly check works improperly if firepoint is inside friendly unit)
* fix bug in ray-ground intersection logic
* make mutual push-resistant unit collisions more like 0.82.x (smoth's issue)
* fix some cases of units getting perma-stuck (s.t. even spammed user orders cannot free them) on terrain, esp. #3423
* fix #3506 (wrong calculation of goffset for assimp model pieces)
* fix #3505 (ground-transported units cannot be killed)
* fix #3465 (WeaponDef infolog error messages are unhelpful)
* fix attack-ground orders placed on water GuiTraceRay now stops at water surface by default, not ocean floor add sixth argument 'ignoreWater' to LuaUnsyncedRead::TraceScreenRay

==Misc==
* support double-resolution yardmaps for buildings (these require four times as many characters, beware) the engine will interpret a yardmap string as such if its FIRST (and ONLY its first) character is 'h'

==Pr-Downloader==
* workaround CVE-2013-0249 (disable all protocols expect http/https)
* reduce log messages
* fix invalid timeout
* fix ignored depends in http-downloads

==Assimp==
* apply rotations & scalings
* fixed per-piece colvols

=92.0=
==Major Changes==
* Linux cross-distro binary builds
* much faster Sim (~20% and ~50% with working OMP)
* new cmdline arguments
* better pathing
* add experimental map generator (see http://springrts.com/wiki/Mapgen for details)
* some new sim/weapon features

==AI==
* Shard update
* AAI: refactor / fixes
* AAI: add BAR config
* AAI: update XTA config, to work with XTA > 9.71
* fix bug in /aikill

==pr-download==
* new --download-engine
* fixes / speedups
* add c-api to shared lib & use it for pr-downloader

==Unitsync==
* fix return in GetInfoMapSize (#2996)
* no crashes in unitsync without init any more (#3120)
* ProcessUnits, GetUnitCount, GetMapCount, GetMapArchiveCount, GetInfoMap, GetPrimaryModInfoCount,GetPrimaryModArchive, GetSideCount, GetModOptionCount, GetCustomOptionCount, GetSkirmishAICount, GetInfoValueInteger, GetInfoValueFloat, GetOptionType, GetOptionNumberDef, GetOptionNumberStep, GetOptionStringMaxLen, GetOptionListCount and GetModValidMapCount returns now -1/-1.0f on error

==Lua==
* make TeamHandler::IsActiveTeam check Team::isDead
* gl.UnitPieceMatrix & gl.UnitPieceMultMatrix do now the same and work from UnitSpace & aren't recursive anymore (don't depend on the parent-piece)
* remove LuaLobby
* enable luasocket as default and always allow to listen (UDP & TCP)
* new Spring.GetTerrainTypeData (already on wiki)
* new Spring.GetUnitCurrentBuildPower(unitID) -> number 0..1
* new Spring.SetUnitNanoPieces(unitID, {piece1, piece2, ...})
* new Spring.GetUnitNanoPieces(unitID) -> table {piece1, piece2, ...}
* replace Spring.Echo with Spring.Log in most places in cont/
* LuaUnsyncedCtrl: make Spring.GetConfig* return non-nil (= 0) values when LuaModUICtrl=0 (3280)
* Lua: make Spring.GetPlayerRoster really return a boolean for spectator as the wiki says
* fix crash when calling Script.Kill() (3292)
* fix Spring.GetUnitNearestAlly takes self into account (3293)
* Spring.SetTerrainTypeData now only updates pathfinder when there is a real change (performance)
* fix crash in LuaUnitDefs when trying to read deathExpWeaponDef (#3333 & #3325)
* add Spring.GetReplayLength()
* add Spring.GetConfigParams()
* add Spring.GetUnitWeaponTryTarget(uid, wid, [number posx, number posy, number posz] | [number enemyid]) -> nil | boolean
* fix error spam on malformed Lua-issued unload commands (#3378)
* fix crash caused by comparing strings with numbers in base-content's weapondefs_post.lua
* add mapHardness to the Game constants table (#3390); make Spring.GetGroundInfo now match its wiki documentation
* make Create{Feature, Unit} take an optional (7th, 9th) {feature,unit}ID argument to spawn a feature/unit with a specific ID
* make CreateUnit take an optional (10th) builderID argument
* deprecate LuaUnitDefs.extractSquare
* replace LuaFeatureDefs.deathFeature(string) by LuaFeatureDefs.deathFeatureID(number)
* fix crash in Spring.GetVisibleFeatures (#3400)
* fix Spring.GetFeatureDirection returning direction in (x,z)-plane only (#1599)
* couple the AllowWeapon* callins to SetWatchWeapon state
* add optional 4th argument to Spring.SetUnitImpulse to control a unit's impulse decay-rate (now unhardcoded)
* Game.version now returns the same as `spring --sync-version`, e.g. "92.0" or "91.0.1-1283-gf3805a7"
* new Game.buildFlags (unsynced only) to get additional engine buildflags, e.g. "OMP" or "MT-Sim DEBUG"
* Better notification and protection from unbalanced OpenGL matrix stack after return from Lua rendering code

==CollisionVolumes==
* drop support for ellipsoid-cylinders and ellipsoids cylinders with round(!) baseplates are still supported! simplify how damage from an explosion is calculated, fewer magic numbers, etc no more distance approximations means no more invincible units (or features) and no more general "weird" cases like 3103 THIS WILL CAUSE BALANCE CHANGES, BE PREPARED
* get rid of TYPE_FOOTPRINT, it was an alias for TYPE_SPHERE in the continuous case which is now default and the original intent (a shape defined by the CSG intersection of sphere and footprint) would have been tricky to get right instead support a {Unit,Feature}Def key "useFootPrintCollisionVolume" which makes a collision volume a box with dimensions equal to the object's footprint (this overrides any custom scaling and/or offsets)
* let projectiles explode _on_ collision volumes and not in a interpolated pos in front of it
* rework projectile-vs-volume special cases so they can be distinguished better for the above
* rewrite TraceRay::{TestConeHelper, TestTrajectoryConeHelper} for #3399 these now no longer use any bounding-radius approximations to figure out if an object will potentially be hit, but calculate the exact colvol surface distance taking spread into account

==Pathing==
* faster updates
* legacy: use omp in ::Update to multithread a function that eats 40% of the time spent in ::Update
::* this gives a _massive_ boost with like >30% more FPS
::* it needs low latency omp threads to work, those are currently broken in gomp, the bug will be fixed with the next release of gcc
* QTPFS: a lot of fixes & optimizations, fixed dev-build desync (#3339), made cache reads/writes atomic, read constants from MapInfo
* give pathfinder debug-data drawing its own shortcut (alt+p)
* rewrite collision handling between units and static objects (again) instead of using impulse to push units away, do SCII-style strafing results: www.youtube.com/watch?v=4rycY4JfLGs
* put on upper limit on directional slope tolerance for "downhill" slopes before, units could move across ANY downhill slope if they ended up there and directional checking was enabled; now the downhill slope-tolerance is limited to twice the uphill tolerance
* set avoidMobilesOnPath to true by default again pro: groups moving without a ctrl-order clump much less contra: groups moving with a ctrl-order are less organized
* fix units moving orthogonally across too-steep faces (and getting stuck afterwards)
* fix humping triggered when unit crushes feature and feature spawns a non-crushable replacement (if unit's next waypoint happens to be inside replacement's footprint)
* change precondition for crushing units from 'collider must be moving' to 'collider impulse must exceed collidee impulse'
* units that are mutually forbidden from pushing each other will no longer get stuck blocking the other party
* units moving toward the same spot will no longer clump up into a jiggly ball (#3355 & #3381)
* units with low delta-v no longer receive bogus move orders after being told to stop (#3358)
* actively push units away from speedmod=0 squares when possible

==UnitScripts==
* LUS/COB: deprecate QueryNanoPiece() makes SimCode ~10% faster use the new Spring.SetUnitNanoPieces instead Note, once set the engine won't call `QueryNanoPiece` anymore and instead randomly toggles between the set nanopieces, saving a lot time-consuming COB/LUS calls.
* LUS/COB: cache QueryNanoPiece() results Note, this stops QueryNanoPiece() calls after 31 times no matter what! This breaks ZK's LupsNanoSpray, fixed version can be found here http://gw.gd/Zaae.

==Models/Assimp==
* support a 2nd texcoord
* auto-calc midPos
* read texture filepaths from modelfile if available
* extended auto-finding of textures

==Weapons/WeaponDefs==
* remove of manualBombSettings (backward-compability code in weapondefs_post.lua)
* fix: half craterAreaOfEffect the same way as it is done with damageAreaOfEffect
* removed color1 (hue) & color2 (sat). Use rgbColor instead!
* removed isShield. Use weaponType="Shield" instead!
* new 'interceptSolo', if true (=default) don't allow any other interceptors to target the same projectile
* allow any weapons to be interceptors/targetables (not that all combinations work/make sense)
* stop subs/AA-fighters trying to chase hovers and tanks (check all equipped weapons if they can target the unit, before _auto_ chasing enemies in FireAtWill)
* all weapons will now obey avoidFriendly, avoidNeutral, avoidFeature + avoidGround
* add new avoidGround weapondef tag (default true)

==FeatureDefs==
* remove "nodrawundergray" now that there is a proper "floating" tag

==GameServer==
* a new GameID tag to script.txt
* always account local players (even when host is a spectator!)
* don't lower-limit gameSpeed to `userSpeedFactor * 0.5f` when userSpeedFactor is greater than 2
* make game ways more responsive when running at high speeds

==Misc==
* add /ReloadShaders
* less jerky camera transitions (thx cleanrock)
* make camera a bit smoother by adding some micro-transitions
* pressing F5 no longer hides the minimap in dualscreen mode (#3095)
* SMF/MapInfo: new tag voidGround
* fix 'only FreeCamera allows to set FOV ingame' (3291)
* do not spam unit self-destruct messages when spectating
* new configtag "StacktraceOnGLErrors": Create a stacktrace when an OpenGL error occurs (only available in DEBUG builds)
* fix performance leak in CSolidObject::Block()
* make UnitScript::{ScriptToModel, ModelToScript} O(1) instead of linear (TODO: UnitScript::HaveListeners is another new O(n) source)
* remove OSC
* add new `cursorattackbad` mousecursor, used for static defense when giving a CMD_ATTACK
* get rid of the 'extractSquare' non-feature for extractor buildings
* when a team dies, redistribute unit-limits over the remaining teams in that team's allyteam (also means dead teams can no longer produce any units)
* record demos in-memory to make speccheating 1% harder
* make hovercraft with non-zero waterline transition into/out of water more smoothly
* make unit movement more physically-based: add modrule 'allowGroundUnitGravity'; allows fast units to catch air add modrule 'allowHoverUnitStrafing'; allows hovercraft to slide in turns ground units cannot change speed or direction in mid-air
* in god-mode, units can now be selected and commanded by any player even when not spectating (#3412)
* fix multiple build-started sounds being played when ordering single builder to construct something
* UnitDef::can{Restore, Repair, Reclaim, Capture, Resurrect} now default to true only if the unit is a builder and has the corresponding {Terraform, Repair, Reclaim, Capture, Resurrect}Speed property set to a non-zero value

==Rendering==
* speedup minimap icon rendering
* fix a few OpenGL errors reported by MESA drivers
* fix SimpleParticleSystem directional particles disappearing (#1665)
* ROAM: resize pool when running out of nodes fixes rendering on maps like Knockout
* disable occlusion query in BumpWater it doesn't work and just makes it slower
* move `lastFrameTime` calculation from the end of a drawframe to the beginning this way vsync locktimes are counted to the previous frame time
* removal of DepthBufferBits & StencilBufferBits
* BumpWater renders now with shadowmap & infotex
* clamp map ShadowDensity 0..1 (fixes shadow distortions on maps like Iamma)
* use VBOs for S3O and OBJ model piece geometry
* fix grass shadow rendering (no self-shadowing yet)
* changed `usable` range of GrassDetail configtag, so you can set it now >10 to increase viewrange w/o getting Tribble plushies

==Sim Bugfixes==
* stop buildframe decaying on reclaiming
* fix unload commands close to map edges are ignored (3175)
* fix nukes (3269)
* fix some issues with bombers (3253)
* fix MANUALFIRE hangs despite no target lock
* fix gunship jumping on takeoff (3526)
* make sure unsupported build orders are never given to new factory buildees (3257)
* fix aircraft failing to land properly on repair pads (3260)
* fix gunships jittering when stunned (3262)
* fix builders 'ignoring' wait-orders when reclaiming
* fix units failing ground-attack orders when their "main" weapon != weapons[0] (3276) logic change: MobileCAI::ExecuteAttack now cycles through all weapons until it finds one which can execute the order, and no longer depends on weapon[0] being the "main" weapon
* fix units gaining negative experience when shooting at dead targets
* fix old logic error in obstacle avoidance handling (IMMOBILE objects were being ignored --> no wonder the "infinite bouncing bug" was so pronounced)
* fix 'Crashing aircraft can be reclaimed' (3288)
* fix 'Units get stuck in sea labs on build completion' (3290)
* fix 'Paralyzed landed aircraft start moving forward slowly' (3287)
* fix bug reported by jamerlan (http://springrts.com/phpbb/viewtopic.php?p=529204#p529204)
* make HoverAirMoveType aircraft able to crash (3289)
* fix 'Move/Turn (piece) fails with negative speed' (3300)
* fix "Total velocity loss during a prolonged unit-to-unit [skidding] collision" (3302)
* fix 'Units with height advantage are unable to force fire with that range' (3303)
* fix air transports have trouble loading multiple units if units are large (3307)
* fix partly reclaiming factory allows unit teleportation/remote destruction (3308)
* fix 'SetFeaturePosition snapToGround get reset when there is terraform nearby' (3243)
* disable collision checking between transporter & transportee
* fix being-built units having order queues overwritten upon completion (#3342)
* fix FPE's in {Large}BeamLaserProjectile (#3413 & #3414)
* fix impulse not being applied to features (unit wrecks)
* allow underwater units to build stuff on the waterplane

==Bugfixes==
* fix network connection is not properly closed when an error occurs in pregame (3166)
* extend desync message (send in debugmode for specs too and send correct & got checksum)
* fix "Transport endpoint is not connected"
* fix secret exploit
* fix secret exploit #2
* fix memory leaks, particularly when the game is minimized
* fix several crashes in multithreaded exe

==Cmdline Arguments==
* new --game (-g) & --map (-m)
::* if both parameters are set, this starts spring a with minimal setup and it sets the modoption minimalsetup = 1
::* supports fuzzy search e.g. `spring -g ba -m Delta` or `spring -g zk -m "Delta X"`
* renamed shortarg -m (--minimised) to -b (~background)
* new `spring --list-def-tags`, will in future return all Unit-, Weapon-, FeatureDefs in a `--list-config-vars` manner (not finished yet)
* new benchmark mode (`--benchmark %time_min --benchmarkstart %starttime_min`) writes a benchmark.data parsable by gnuplot

==OS==
* set affinity of omp threads
* search script.txt & demofiles in $PWD
* detect Valgrind and disable Watchdog & syncing (it won't let us change the FPU state) if it is running
* don't install crash handler when core dumps are enabled

==Buildprocess==
* boost 1.50 compatibility
* detect ld.gold and compress debugsymbols
* update 7z to v9.22
* use tcmalloc when found (new USE_TCMALLOC use-flag)
* add target headercheck

==Windows==
* OpenMP build
* update to boost 1.50
* slightly improve speed of zip / sdz archives (#3338)
* Nvidia Optimus support
* removed springsettings.exe as its directly included in springlobby

==Linux==
* Linux's ctrl+c: `hardkill` after 10sec (and 5 seconds softkill)
* workaorund issue in FOSS ati drivers with NPOT cursors

=91.0=
==Bugfixes==
* fix Linux sync errors
* fix QTPFS deadlocks

=90.0=
==Bugfixes==
* fix endless loop in Shard in mingw32 builds
* fix builders sometimes don't notice when a building was finished by another unit
* fix SkyBox corruption
* fix QTPFS deadlock at start
* partially revert the "lock-on targeting" behavior: If a user-selected target moves out of range, the lock is now broken as it used to be and automatic targeting is not blocked anymore (though this can take some SlowUpdate's). For ground-attack orders it is still in place, since the behavior seems to be preferred (so a unit that is told to attack a position and then to move away will keep firing even when other targets are available)
* really fix "endgame stats only show APM for self"
* really fix "Size of unidentified radar blips can be determined with mouseover"
* fix ship wreckage drag
* fix gunships don't obey land/fly state
* fix 'Bombers with fight command do not fire' (3190)
* fix 'Emit-sfxed weapons point at {0, 0, 0}' (3205)
* fix an incorrect watchdog trigger before gamestart
* fix 'Aiming animations ignore maxAngleDif [actually tolerance]' (3180)
* fix 'Grass is not animated in LOS view' & 'LOS view does not render trees in the same way' (3207 & 3203)
* fix `halo` in BumpWater with EndlessOcean & OwnRefractionRenderPass
* fix 'Bombers with area attack dont work ' (3195)
* fix 'If air constructor lands it often fails to do next construction command' (3198)
* make fight commands work with noAutoTarget weapons (3190 #2)
* fix 'Constructor stops before it enters build range' (3210)
* fix bugged/all-white decals when shadows=0
* fix units being able to move down steep cliffs (directional slope-tolerance needs work)
* fix dangling pointer/memory corruption in QuadField (3211)
* fix 'Reclaiming units under construction results in no resources being returned' (3216)
* fix some OpenGL usage errors found by [teh]decay
* fix 'Gunships dont always aquire targets despite fireatwill+roam+fly' (3221)
* fix 'TargetBorder=1 only works when a unit has a specific attack command' (2971)
* fix CFeature::ForcedMove (3226)
* fix Spring crashes when sending large messages (3228)
* fix 'Armed constructors attack neutral units on Fight order'
* restore old shield visibility behaviour (3242)
* fix 'Units with cannons remain out of range when you force fire onto high ground' (3241)
* disable unit pushing bidirectionally when one of the parties is non-blocking

==Sim==
* make target locking optional via meta-key

==GameServer==
* support start-scripts of arbitrary size (still not advised to use scripts bugger than 256kB, and we won't optimize anything related to such huge scripts)

==UnitDefs==
* make cloakCostMoving default to cloakCost

==WeaponDefs==
* change default weapon "mainDir" to "0,0,1" (before it was "1,0,0")
* always enable continuous hit-testing (it showed discountinuous one is used <<1%, so it's not worth to keep it)

==FeatureDefs==
* add explicit `floating` featureDef tag (before it was implicit via nodrawundergray and failing a lot)

==Lua==
* add Spring.SetUnitDirection(unitid, x,y,z)
* add `ignoreLOS` tag to Spring.UpdateMapLight
* LuaRules: add DrawProjectile to complete the Draw* quartet

==ModInfo==
* add `allowAircraftToHitGround` tag (3199)

==Rendering==
* runtime create missing DDS mipmaps when supported by the hardware

==Windows==
* call SDL_WarpMouse every frame again (fixes `ghost mouse` in middle click scroll)
* explicit pipe --large-address-aware through -Wl (fixes compiling with tdm-gcc)

=89.0=
==Major Changes==
* LuaSocket
* MessageBox for unsupported GPUs (+drivers)
* fixed ATi PointSize bug
* LOS et al. are rendered now through the GLSL terrain shader (-> shadows in LOS-view)

==Changes==
* added Shard to the windows installer
* added pr-downloader as submodule (only compiled if libcurldev is available)
* limit infolog.txt buffer to 8kB
* open a MessageBox on systems with unsupported GPUs (+drivers) on engine start (suppressible with a config-tag)
* remove selectkeys.txt support (use uikeys.txt instead)
* remove TASServer.jar (outdated, use http://springrts.com/wiki/Spring_on_a_LAN )
* send gameID and SDF filename with SERVER_STARTPLAYING to autohost
* remove deprecated LogSubsystems config var
* do not send GameOver from a client that timed out
* add LogFlush config var for instant writes (disabled as default)
* add UI config-variables AutoAddBuiltUnitsToFactoryGroup (def: false) and AutoAddBuiltUnitsToSelectedGroup (def: false) if the first variable is true, new units auto-inherit their group number from the factory that built them if the first AND second are true, new units are auto-selected if their factory group is currently selected
* weapondefs.cylinderTargetting spelling fixed, the old one is deprecated
* exit with !=0 if spring can't connect to server
* decrease loglevel for "Load S3O texture now" & luasocket
* change content-exception (for a missing water texture) in BasicWater to a warning message
* dedicated server no longer consumes 100% CPU while waiting for gameID
* headless builds use less cpu-time (nominally 50% instead of 100%)

==Bugfixes==
* fix some orders are discarded when issuing commands to landed planes
* fix unfinished units with 100% hp can't be finished
* fix 'crash when getting LOS of a feature without 3d object and drawType!=-1' (3032)
* fix "changing unit speed does not work anymore" (2877/3016) (scripts can now arbitrarily override the UnitDef values, which are only used for initialization)
* fix 'LightningCannon can fire into water' (3057)
* fix BeamLasers and LightningCannons not ignoring stunned shields
* fix GameSetupDrawer player-state string (3064)
* fix 'Con/com gets weird move order after stop command is given' (3069) (was intended to keep factories clear, any side-effects are up to players to deal with)
* fix stunned=true crashing=true airplanes falling into the void (3078)
* fix zombie coverage from sensor-units (if activated while in a transport, exploit)
* fix crash in unit_script.lua
* fix 'Units stuck in factory' QTPFS bug (3055)
* fix units moving (being pushed) through factory walls
* fix terrain water reflections
* fix game does not end properly for a player that is being kicked
* fix problem to build near map edges
* fix ping display after mid-game (re-)join + try to reduce lag after mid-game join
* fix missing stack trace if out-of-memory occurs
* fix missing stack trace on abnormal termination (sigabrt)
* fix resurrecting an individual wreck results in the resurrector not healing it
* fix /godmode and /{luarules,luagaia} {reload,disable} not working in demos (2701)
* fix targetting bug (weapons sometimes failing to fire at badTargetCategory units) as a result of AllowWeaponTarget misuse
* fix kamikaze units not self-d'ing when given an attack order while on hold-fire (2405)
* fix 3105 (PlayerChanged callin not available in unsynced gadgets)
* fix 2947 (size of unidentified radar blips can be determined with mouseover)
* fix 1843 (Spring.GetUnitHealth returned nothing for buildProgress on in-LOS enemy units with "hideDamage=1")
* fix 3122 (failure to fire at badTargetCategory)
* fix crash when give all units to uncontrolled team
* fix fighters that have a target may refuse to obey orders
* fix crash in GetPlayerTeam (AI)
* fix sync warning when resizing the main window
* fix ctrl/alt/shift keys stuck after alt tab
* make COB's set(MAX_SPEED) permanent again like its Lua counterpart, rather than letting it apply only temporarily (for the duration of the current move command if any); use negative speed values if you want the change to be non-permanent

==Simulation==
* YardMap changes:
:* more verbose yardmap parsing
:* ignore any whitespaces in yardmap strings (esp. newlines)
:* new "i" yardmap code (inverse of "c")
* remove TA-ism in buildrange code:
:* make buildrange not immobile dependent
:* changed terraform range check a little
:* make terrain restore range check consistent with new terraform one
:* don't add target's radius to the builder's builddistance, only do so if the target is bigger than the builddistance (mostly only true for terraform)
:::*> from now on the to be built unit's centerpos has to be in buildrange not its border!
* remove obsolete default dependence of cloakCostMoving on cloakCost
* remove modelCenterOffset tag (can now be dynamically set with Lua)
* improved behaviour of builder masses
* make StartBox clamping of StartPositions synced
* don't reclaim in-the-way features when the buildee is going to morph into a feature of the same type (fixes the ancient bug where ordering a row of features with N > 1 builders causes each to be reclaimed and then immediately rebuilt)
* do not apply impulse to units being transported
* make falling wreckage (from aircraft) not lose all its forward speed
* make ground units consume waypoints less aggressively
* remove special treatment for collisions between mutually-pushResistant objects for 3031
* add 'allowUnitCollisionOverlap' (def=true) and 'useClassicGroundMoveType' (def=false) ModInfo keys the former allows unit movement like www.youtube.com/watch?v=mRtePUdVk2o at the cost of more clumping (learn to use ctrl+lmb formation orders) the latter is a ticket back to unit movement circa 2009: no reversing, no turninplace=false, no smooth collision handling, no nothing (figure it out)
* add mod-rule 'targetableTransportedUnits' (default false)
* introduce an independent Lua-controllable aim-position (defaults to mid-position) for units and features, used by weapons as their aiming/target point
* make ground units less keen on repairing fast units such as patrolling aircraft
* fix distinction between user-selected and internal CommandAI targets

==Pathing==
* QTPFS: less loadscreen spam, make F2 functional, enable corner-connected node topology, use staggered layer-updates, speedups and tweaks
* QTPFS: increase MAX_TEAM_SEARCHES, decrease LAYERS_PER_UPDATE (more units can request paths per frame, units get paths back more quickly)
* QTPFS: fix assertion failure, make execution of path requests more asynchronous

==Lua==
* some config values are now write protected (Spring.SetConfig*)
* added luasocket support for widgets, see http://springrts.com/wiki/LuaSocket
* fixed params of Spring.MarkerAddPoint & Spring.MarkerAddLine
* call AllowWeaponTarget at the end of the queue, so lua only gets those units which are _not_ filtered by the engine
* LuaSyncedRead: better hide enemy radarblobs unit-info
* MoveCtrl: remove SetGroundMoveTypeData(unitID, "wantedSpeed", v) and SetGroundMoveTypeData(unitID, "maxWantedSpeed", v) (the preferred way for gadgets to change a unit's speed is by calling SetGroundMoveTypeData(unitID, "maxSpeed", v))
* replace Game.gameID by synced callin GameID(string gameID)
* fix TraceScreenRay never returning "sky" when includeSky=true
* fix TraceScreenRay coordinate offset when onlyCoords=true
* fix typo in Spring.GetUnitVelocity
* add extra parameter 'defPriority' to AllowWeaponTarget (what the engine thinks the target priority should be)
* add bool FeatureDefs[xyz].autoreclaim
* add new gl.Texture("$minimap")
* add new gl.Texture("$info")
* remove gl.SelectBuffer and co.
* new Spring.LoadCmdColorsConfig(configStr) & Spring.LoadCtrlPanelConfig(configStr)
* add new 3 param 'pairwise' to Spring.GiveOrderArrayToUnitArray(), used to send multiple units a single individual command
* fix crash due to UpdateCallIn removing the current event client from list being iterated
* add missing team/player callins to (unsyced) GadgetHandler
* add new synced callouts Set{Unit,Feature}RadiusAndHeight(number id, number radius, number height) --> boolean
* add new synced callouts Set{Unit,Feature}MidAndAimPos(number id, number mpx, number mpy, number mpz, number apx, number apy, number apz) --> boolean
* add optional 2nd (boolean midPos) and 3rd (boolean aimPos) arguments to Spring.Get{Unit,Feature}Position to go with the above four callouts
* change Spring.GetUnitPosition to return a unit's base-position by default, like .GetFeaturePosition does for features (this is usually a point on the model closer to the ground than its mid-position, so may affect some Lua drawing code)
* fix keys hang after LuaUI tweakmode
* [MT] disallow other Lua environments to invoke LuaUI if LuaThreadingModel = 2, to prevent deadlock
* [MT] fix desync with LuaThreadingModel > 2
* [MT] fix teams sometimes wrong in UnitGiven() and UnitTaken()

==Rendering==
* fix DynWater ship wakes, BumpWater shorewaves
* fixed ATi PointSize bug
* update assimp to svn rev 1231
* fixed assimp lua metafiles
* warn about null normals in models
* add visualization of default object radii (used for AOE calculations, etc) to alt+v
* SMF: render the info-texture through GLSL (noob translation -> shadows in LOS-view)
* improved VSync under Linux (with support for AdaptiveVSync)
* added FeatureFadeDistance & FeatureDrawDistance config tags
* more failsafe shadow FBO creation
* fixed vibrating planes (again)
* fix spring_multithreaded hangs

==UI==
* display average draw & sim frame time in debugview
* draw buildRange for mobile selected units too & always render them on shift hover (also for shield range)

==Sound==
* all items in sounds.lua are now converted to lowercase
* allow to create a new "default" item in sounds.lua
* WeaponDef: support 'soundHitWet{Volume}' keys for in-water explosion sounds (the 'soundHit' key is now deprecated in favor of 'soundHitDry')

==Windows==
* set IMAGE_FILE_LARGE_ADDRESS_AWARE (increased >2GB memory limit)

==Linux==
* strip CXX_FLAGS & C_FLAGS in build process to prevent sync incompabilities (can be turned off with a new CUSTOM_CFLAGS cmake flag)
* on multicore systems set scheduler to SCHED_BATCH (semi-solves the core hoping issue)
* call SDL_WarpMouse only when needed (fixes massive FPS-drop in middle-click-scrolling)
* use a non-locking vsync mechanism & add support for nvidia's `adaptive vsync`
* explicit disable all CPU extensions except SSE1
* use mtune=generic on 64bit systems

==OSX==
* fix stack corruption in sound code

=88.0=
==Changes==
* showing collision volumes has now its own command (`/debugcolvol` & `alt+v`)
* use footprint (not model) radii for obstacle avoidance
* improve reconnecting sim/draw balance
* disable line/point smoothing in safemode
* time profiler updates now even when paused
* MoveInfo read "avoidMobilesOnPath" from correct table and disable it by default (before it was default enabled)

==Unitsync==
* allow to list files with unsolveable depends
* warn about usage of deprecated functions in unitsync

==Lua==
* added new Spring.TestMoveOrder(unitDefID, worldx, worldy, worldz) -> boolean
* added new Spring.Log()
:* same as Spring.Echo, but passes metadata to the logsystem
:* to be able to use LOG.XYZ you need to update your system.lua
:* Spring.Log(string logsection, int loglevel, ...) (with loglevel either: LOG.DEBUG, LOG.INFO, LOG.WARNING, LOG.ERROR, LOG.FATAL)
:* Spring.Log(string logsection, string loglevel, ...) (with either: "debug", "info", "warning", "error", "fatal" [lower-/uppercase doesn't matter])
* fixed WeaponDefs[123].pairs()
* added myGravity tag to WeaponDefs[] table (thx DeadnightWarrior)
* distinguish water-damage in Unit{Pre}Damaged
:* water damage has index -5
:* kill damage was -5 before and is now -6

==Bugfixes==
* fixed multiple crashes
* fixed SPRING_ISOLATED=1
* fixed gcc i686 march flag
* fixed an aircraft refueling bug
* fixed multiple pathing bugs/issues
* fixed crash at startup when DynamicSun=1
* fixed 'Nanoframe targeting and water' (3017)
* fixed desync _warning_ between 32- & 64-bit systems
* fixed FarTextures with GPU/drivers that don't support FBOs
* fixed spring-mt & spring-safemode links in window's startmenu
* fixed incorrect drawMidPos (e.g. used for command line drawing)

==Installer==
* add vcredist_x86.exe to the installer / remove MSVCR71.dll from mingwlibs
* fixed safemode shortcuts

=87.0=
==Bugfixes==
* restore pre86.0 maxAngleDif arcs
* remove the following Lua consts: wdef[id].areaOfEffect, wdef[id].maxVelocity & wdef[id].onlyTargetCategories
* fix "LuaUI didn't got unprocessed /xyz commands" (mantis 2982)
* fix shield rendering
* support for zlib 1.2.6 (thx sirmaverick)
* fix crash on start when invalid ai is in script.txt
* fix multiple pathing & collision issues
* some Maven (Java) updates
* removed ArchiveMover
* fix compile for "make tests" on win32

=86.0=
==Changes==
* new commandline argument "--safemode": It turns off all features that are known to cause problems on some system.
* ignore features with `blocking=false` in all RayTracing/Aiming functions (other code still checks them!!!)
* enable ROAM in spring-mt
* IsolationMode: scan ENV{SPRING_DATADIR} & config's SpringData as readonly datadirs
* using now OS functions to expand special paths in spring's include dirs (config's SpringData, ENV{SPRING_DATADIR}, ...)
:* Windows: now uses windows syntax ("$HOME/foo/bar" is now "%HOME%/foo/bar") (see msdn's ExpandEnvironmentStrings documentation)
:* Linux: now supports full bash path syntax ("~/", "${HOME}/.spring/", "/foo/../bar/", etc.) (see manpage of wordexp)
* remove "Start SpringSettings" and "Start the Lobby" from the test/develop menu
* remove support for selectionkeys.txt
* add internal_pthread_backtrace for freebsd
* update mingwlibs (fixes rotated textures)

==Simulation==
* make globalLOS a per-allyteam variable /globallos <n> --> toggle for allyteam <n>, no argument --> toggle for all

==Pathing==
* QTPFS: fix several minor issues and corner cases support partial searches, allow search to start from blocked nodes tweak heuristic so it overestimates less on non-flat terrain do not let units move before path-request is processed
* UnitDef: add turnInPlaceAngleLimit tag for a unit with turnInPlace=true, defines the maximum angle of a turn above which it starts to brake (defaults to 0.0, values in degrees)
* MoveDef: unhardcode default pathfinder cost-adjustment and speed-multipliers for squares blocked by *mobile* units: avoidMobilesOnPath = boolean, speedModMults = { mobileBusyMult = number, mobileIdleMult = number, mobileMoveMult = number, } unhardcode the DepthMod equation: depthModParams = { minHeight = number, maxHeight = number, maxScale = number, quadraticCoeff = number, linearCoeff = number, -- deprecates "depthMod" constantCoeff = number, } new formula is given by if h < depthModParams.minHeight: 1.0 if h > depthModParams.maxHeight: 0.0 else: depthScale = MAX(0.01, MIN(depthModParams.maxScale, (a * h * h) + (b * h) + c)) depthMod = 1 / depthScale where h = unit's absolute height below water surface a = depthModParams.quadraticCoeff b = depthModParams.linearCoeff c = depthModParams.constantCoeff

==unitsync==
* reload IsolatedMode & Dir via the EnvVar on Init() calls
* warn about invalid version numbers
* add python bindings for unitsync

==MacOSX==
* fix signal handling
* use native DialogBoxes

==Rendering==
* cleanup and extend SSMF shader, now includes a parallax-mapping stage

==Lua==
* add LuaRules callin `DrawShield(number unitID, number weaponID) --> boolean` (true skips Spring's own drawing of shield <weaponID> owned by unit <unitID>)
* make LuaUnsyncedCtrl::SendSkirmishAIMessage return a table, not N loose strings (but note there is nothing in this table due to "limitations" of the AI interface)
* add weaponDefID parameter to ProjectileCreated
* add facing parameter to AllowUnitCreation
* remove most range-checks in default gadget-handler for registering commands (2930+2952)
* distinguish damage-types for Unit{Pre}Damaged when weaponDefID < 0 (2966) weaponDefID -1 --> debris collision weaponDefID -2 --> ground collision weaponDefID -3 --> object collision weaponDefID -4 --> fire damage weaponDefID -5 --> kill damage

==Bugfixes==
* fixed Intel GPU detection under Windows
* fixed handling of duplicated used hotkeys (i.e. unit groups & specteam switching)
* fixed minor issues with ground collision RayTracing
* fixed compilation with boost >=1.48
* fixed Spring.Restart
* open logfiles on win32 with commit flag set
* don't allow spring to start when a depend file is missing

* "Rapid unit ejection from factory" (2864)
* "Units walk in circles on their way to a far awar move goal" (2866)
* "Excessive movement bouncing off buildings and wreckages" (2865)
* "armpw stuck in air while pathing around solars" (2854)
* "Enemied units can get stuck in each other with movectrl" (2832)
* "A factory set to wait continues the queue" (2868)
* "Change in Factory Behaviour wrt AllowUnitCreation" (2873)
* "Building with Meta-Key pressed does not work" (2764)
* "'Move at slowest speed of group' move order (ctrl+alt) semi-permanently changes unit maxvelocity." (2880)
* BeamLasers could hit but not damage units using per-piece colvols
* heap corruption in UnitDrawer::ShowUnitBuildSquare (2903)
* heap corruption in TransportCAI::UnloadDrop (2911)
* mismatched feature colvol matrices
* MoveCtrl.SetRelativeVelocity
* bug in TestTrajectoryCone for ballistic weapons
* transported units being unhittable (2875, 2934)
* SetUnitCrashing inconsistency, caused "Aircraft crashing while landed results in irregular behavior" (2924)
* obscure targetting bug, caused "Gunship jams when on hold fire" (2406)
* deprecate / remove the 'toAirWeapon' WeaponDef tag (use "onlyTargetCategory = VTOL" for the same effect)
* 'airmesh is 0 at x >= width or z >= height' (2938)
* GuiHandler crash when unit has no valid selfDExplosion (2852)
* <canSubmerge=false, floater=true> aircraft landing on sea floor (2856)
* 'waterweapon=false BeamLaser can fire into water' (2857)
* the units-humping-obstacles syndrome (forward and reverse)
* silly aircraft refueling bugs
* 'Warning message on SetGroundMoveTypeData(unitID, "maxSpeed", 0)' (and some related possible div0's)
* weird inability of weapons with a non-default onlyTargetCategory to attack the ground
* 'Unit LOD billboards are too dark' (2948)
* rare antinuke bug (2956)
* typo in setting of default turnInPlaceSpeedLimit
* "All terrain units move commands are removed when climbing cliffs" (2958)
* 'Landed gunships do not follow height reduction' (2823)

=85.0=
==Major Changes==
* ROAM \o/
* QTPFS (disabled by default)

==CommandLine==
* updated man-pages
* added new argument `--sync-version` (i.e. prints "85" for a 85.0 build or "84.0.1-567-g69ef7a3 develop" for a dev build)
* allow to build proper release builds without being on branch master
* added a full set of new arguments to spring-dedicated (see `spring-dedicated --help`)
* added --isolation & --isolation-dir arguments
* optionally, you may supply a path with SPRING_ISOLATED=<isolation-mode-dir>

==Rendering==
* added ROAM. Kudos go to B. Turner (the original author of the code) and Beherith (for integrating it into Spring).
* set SmoothLines & SmoothPoints by default on DONT_CARE (so your gfx driver settings decide if it is enabled or not)
* dynamic viewrange handling, so even a 32x32 map can be rendered w/o clipping in low camera angles
* log available video memory on NVidia/ATi gfx drivers
* disable GLSL shaders on Mesa/Intel drivers

==Internal/Bugfixes==
* re-added forced log file flushing when handling crashes
* made the (new) C++ AI Wrapper VS compatible
* name threads so you can identify them in `htop` (Linux only)
* some additional time-profilers in rendering code
* hide "(Headless)" in dedicated's returned version name
* fixed stacktrace translation with some Linux setups
* fix crash when specs are cheating in via /team
* fix transport loading failure

==(G)UI==
* fix keyshortcuts (handle F3 OR any+F3 but not both at once!)
* fix EndGameBox
* make F2 colors less ambiguous
* the ManualFire action now expects a cursor "cursormanfire"

==Sim==
* make units crushable like features
* implement avoidFeature for Cannons and MissileLaunchers
* fix extremely fast unit rotations after being hit
* fix FPS-mode range exploit
* fix teleport-to-smooth-mesh after unloading

==Pathing/MoveType==
* fix units sometimes moving onto impassable squares
* fix the mass-clumping unit movement bug
* properly restore MoveType::maxSpeed after a guard-order
* prevent units getting stuck when turning around the corner of other units

==CEG==
* give warning when textures used in SimpleParticles don't exists
* really fix default projectile colors

==MultiThreaded (GML)==
* fix hang/runtime error during pathing
* fix Creating unit in gadget:Initialize()
* lots of other fixes

==Sound==
* limit UnitReplies to max one concurrent playback
* play most unit sounds (activate, ...) only if unit is in LOS

==UnitDef==
* removed "commander" tag (The Commander selectkeys filter is now defunct (ctrl+c hotkey). Lua it, or add a new one that looks for any canManualFire units.)
* added new "blocking" bool tag
* "canDGun" is now a synonym for "canManualFire"
* added new tag "crushResistance" (defaults to unit's mass)
* make the default cloakCost* values 0 instead of -1,
* added new "canCloak" bool tag (If an unit can receive user cloak commands. Before, canCloak was auto set to true if cloakCost >= 0.)

FeatureDef
* added new tag "crushResistance" (defaults to feature's mass)

==WeaponDef==
* added new "craterAreaOfEffect" float tag (defaults to the value of areaOfEffect)

==modrules.lua==
* added "movement.allowCrushingAlliedUnits" (default false)
* added "movement.allowUnitCollisionDamage" (default false)
* added "system.pathFinderSystem" (defaults to 0, 1 is QTPFS)

==Lua==
* UnitDef[].isCommander returns now false
* fixed Spring.GetTimer/DiffTimers
* fixed Spring.SetMouseCursor when using hw cursor
* handle Lua code crashes in some events correctly, so they don't crash the whole Lua enviroment (fixes: "LuaRules::CheckStack top = -1")
* call UnitMoveFailed event only for via Script.SetWatchUnit registered UnitDefs
* added new WeaponDefs[].craterAreaOfEffect
* extend Spring.SetUnitBlocking with an optional 4th "crashable" bool argument
* added new Spring.GetUnitBlocking(unitid) -> blocking, crushable

==demo widgets==
* minimap_startbox.lua: play sound when start-positions are placed

==Buildbot==
* create spring_${VERSION}_minimal-portable+dedicated.zip

==UnitSync==
* if Init() is called, but we are already initialzied, do a re-initialization

=84.0=
==Bugfixes & Improvements==
* reduced 'Got invalid Select' message spam
* hide framNums from chat console
* fixed command queue bug (zombie builders)
* always flush stdout/stderr
* workaround a SDL bug with X11 & fullscreen that broke MiddleClickScrolling
* changed target behavior of enemies outside of LOS
* fixed BumpWater with DepthBufferBits=16
* fixed aircraft landing on repairpads
* reset aircraft state after starting from repairpad (`ground hover bug`)
* make UHM available before the gamestart (fixes Spring.GetGroundHeight in :Initialize() etc.)
* workaround 'Bertha' issue (UHM related)
* make C++ AI Wrapper compile with VS
* fixed fog in some shaders
* fixed F2 view
* improve weapon interceptors (anti nukes can now intercept nukes that fly over them)
* fixed free resources by NanoFrameDecay
* handle resigned players (:= /spectator) in game_end.lua gadget
* Lua Spring.KillTeam: disallow killing of Gaia (engine doesn't support so atm)
* fixed lasers not hitting targets at edge of range
* fixed stutter with low-reloadtime weapons
* Lua: removed WeaponDefs[i].graphicsType & renamed WeaponDefs[i].hardStop -> WeaponDefs[i].laserHardStop

=83.0=
==Major Changes==
* EFX/EAX support (sound reverb)
* ASSIMP support (not 100% finished yet)
* AI Interface pure-ification
* many speedups and double as much slowdowns
* use a new engine versioning scheme (RC12)

==Engine==
* use more smooth algorithm for wind updates
* fixed a few focus lost issues (keyboard & mouse)
* DebugMode now draws feature collision volumes too
* made ShadowSpace linear
* multithreaded loadingscreen
* hide out-of-LOS heightmap changes
* replace engine start point marker with lua-widget
* use "game" instead of "mod" in many places
* add "isolation" mode (do not use global data-dirs)
* change lobbyserver main address to "lobby.springrts.com"
* use http://springrts.com/ everywhere (deprecate clan-sy links)
* ArchiveMover uses unitsync to detect the writable data dir
* improve version logging on non-Windows OSs
* include player-name in log message when resingning
* add `../` as data-dir if it contains `maps/`, `games/` and `engines/`
* allow to define the default config- nad data-dir on windows, using env var PROGRAMDATA
* refuse to load too heavily compressed archives (see 0.82.3-1043-g2c15040 commit message for details)
* better IP v6 and v4/v6 mixed mode support
* lots of error messages improved and new ones added
* add the first few unit-tests
* add a validation-test
* add network bandwidth limits per player to prevent malicious command spam
* add optional high-loss network modes to make spring playable on very lossy connections (NetworkLossFactor = 0|1|2)

==Engine / bugfixes==
* too many to list, see http://springrts.com/mantis/changelog_page.php (incomplete!)
* calculate the team unit-limit without ancient hacks
* stop the maxunits team restriction from applying to Gaia (#2435)
* fix ray-ground intersections when camera is outside map
* fix spring on MacOSX
* CMake configure and make build are much more stable now (no more failure due to wrong order of actions)
* fix DamageArray related sync error
* fix a lot of memory-leaks
* fix unit does sometimes not reach target position when given a restore command
* prevent build time-out when builder or other units are blocking the build pos
* fix "cheat" status disparity between server and client after watching demo
* fix captured unit still getting shot at
* fix repeat commands remain even if the target object is destroyed
* fix unwanted error spam when disconnecting from server
* fix reconnect failure (incorrect password)
* fix rare desync and keyframe mismatch after reconnect
* fix two crashes related to audio channels
* eliminate some false hang detections on load
* fix multithreaded crash in lua material rendering
* fix hang after crash
* fix memory corruption in bitmap handling
* fix desync in PieceProjectile (#2591)
* fix a certain /take exploit
* fix hover aircraft may become unresponsive in conjunction with command chains and repeat enabled

==Engine / misc defs==
* replace UnitDef::pieceTrailCEG* by a Lua subtable of sfxTypes
* deprecate several *Def tags and their Lua*Defs copies (type/maxSlope/isBuilder/canDGun/transportableBuilding/dropped/canCrash/...)
* make a missing UnitDef::humanName non-fatal
* UnitDef: remove hardcoded: if ((waterline >= 5.0f) && canmove) { waterline += 10.0f; }
* make UnitDef::losHeight configurable instead of an unused hardcoded value
* add collide{Enemy, Ground} as weapondef tags
* use a more reasonable default for FeatureDef.autoreclaimable (== reclaimable)
* scan in 'effects/' as well as 'gamedata/explosions' for CEG definitions

==Engine / misc commands==
* add a /clearmapmarks command
* rename /advshading to /advmodelshading; add an /advmapshading analogue
* add '/reloadCEGs [cegtag]'; reloads all CEGs or one specific CEG by tag
* add '/dumpstate <minFrame> <maxFrame> [frameInt]'
* add '/CommandList'
* add '/CommandHelp <commandName>'
* more complete word completion for game-commands
* make auto-host command `paused` use a parameter (0|1)
* add scrollbars for player list in "quit" and "share" dialogs

==Engine / Userconfigs==
* removed the "FSAA" config tag (FSAALevel is enough)
* removed default 1024x768 res and use desktop one now instead (done when X/YResolution <= 0)
* added a new 3rd state for AtiHacks: -1 (autodetect each run, so you can switch GPUs)

==Engine / Simulation==
* never allow zero-area feature footprints
* remove radius halving for default aircraft collision-volumes
* close down another out-of-map attack exploit route
* rewrite collision detection/resolution between ground units
* skip path-estimating for unused MoveDefs
* use the full resolution of the blocking object map in pathestimator
* invoke higher resolution pathfinder if needed
* always add the "geovent" FeatureDef (#2402)
* only send UnitLoaded events for units that were not already being transported (when Attach'ing them)
* fix bizarre skidding behavior for ground units with non-zero slideTolerance
* higher priority for nano particles when capturing and reclaiming other teams units
* print error message for select commands referencing invalid object IDs
* make TorpedoLauncher weapons able to target any in-water unit
* make pushing of enemy units during collisions a ModInfo option ("allowPushingEnemyUnits")
* remove hardcoded enter-crashing-state-on-death behavior for aircraft (now delegated to Lua or COB)

==Engine / Map==
* merged both mapinfo.lua's! before there were two, one in the base-dir (-> ArchiveScanner) and one in "maphelper/mapinfo.lua" (-> MapParser/MapInfo) engine now always tries to read the base-dir one
* new mapinfo.lua tags:
:* "specularExponent" (moved from userconfig)
:* "fogEnd"
:* "bladeColor"
* check for the smt _next to_ the smf (which can already freely placed in the archive!)
* allow resources_map.lua to specify GroundFX textures for CEGs (that use CSimpleGroundFlash)

==Engine / Rendering==
* Lua-scriptable dynamic lighting of models and terrain (www.youtube.com/watch?v=H5je8TKDfNA)
* WIP DynamicSun option for moving shadows
* add optional SSMF normal-mapping and self-illumination stages
* fix holes in shadows cast by non-closed S3O/OBJ models icw. face culling
* always cull (non-3DO) model backfaces for the shadow pass
* squeeze some extra precision out of the shadow-map
* make map/model/tree/projectile shadows individually configurable
* allow weapons to not leave any explosion scars (add "explosionScar=true|false" to a WeaponDef)
* render all SMF maps through GLSL if it is available
* make depth-testing and -masking configurable for CSimpleGroundFlash
* fix mixed up textures in the multithreaded version
* fix awkward performance with multithreaded engine in games using custom model formats
* add peak display for time profiler
* don't display /mtinfo if the value is near zero
* properly fade out features
* make underwater shadows darker in deeper water
* significantly reduced performance impact for Lua rendering widgets in the multithreaded version
* enable creation of OpenGL objects such as display lists in the sim thread in the multithreaded version
* fix BumpWater on ATI cards when atiHacks=false

==Engine / Sound==
* added EFX/EAX support (reverb)
:* /tset UseEFX [0|1]
:* /tset snd_filter %gainlf %gainhf
:* /tset snd_eaxpreset "bathroom" (see EFXPresets.cpp for alternatives)
* fixed a bug when runtime changing the volume
* added a warning when trying to play a non-mono sound in 3d (OpenAL doesn't support this!)

==Engine / COB&LUS==
* fixed bug in WaitFor... [mantis #2499]
* minor animation-handler optimizations

==Engine / Lua==
* fixed "/luagaia xyz" cmds
* added EAX/EFX funcs: Spring.[Get|Set]SoundEffectParams
* totally remove following args of SetUnitPieceCollisionVolumeData: affectLocal, affectGlobal, enableGlobal (it's now always local!)
* fixed gl.PushAttrib(GL.ALL_ATTRIB_BITS)
* added a new channel argument to Spring.PlaySoundFile(). it is always the last argument (independent if you defined pos/speed) it can either be: "battle", "sfx", 1 "unitreply", "voice", 2 "userinterface", "ui", 3 anything else defaults to "general"
* removed teamcolors.lua (redundant since Spring.SetTeamColor)
* add optional flattenGround parameter to Spring.CreateUnit
* remove the "n" field from array-like tables returned by API functions
* added Spring.GetProjectilesInRectangle
* linked Projectile{Created, Destroyed} to the Spring.SetWatchWeapon state
* added Spring.SetWatchUnit(unitDefID) and Spring.SetWatchFeature(featureDefID) analogues of SetWatchWeapon
* extend LuaPathFinder with support for setting node cost overlays
* extend SyncedRead::Pos2BuildPos: add support for additional param "facing"
* added Spring.{Get, Set}MapSquareTexture (these allow complete dynamic run-time retexturing of SMF maps)
* added Spring.GetMetalMapSize (returns size in metal map coordinates)
* added Spring.GetMetalExtraction (note: uses metal map coordinates)
* added Spring.{Get, Set}MetalAmount (note: uses metal map coordinates)
* added Spring.GetFeaturesInCylinder
* added Spring.GetFeaturesInSphere
* added Spring.GetFeatureCollisionVolumeData
* added Spring.SetWMIcon
* added Spring.SetWMCaption
* added Spring.ClearWatchDogTimer
* added widget call-in GamePaused
* added widget call-in PlayerAdded
* added widget call-in PlayerRemoved
* added callins for collision events UnitUnitCollision(colliderID, collideeID) -- needs SetWatchUnit enabled for both parties UnitFeatureCollision(colliderID, collideeID, crushKilled) -- needs SetWatchFeature enabled for both parties
* added Spring.SetUnitCrashing
* add All/None buttons for widget selector
* fix multithreaded crashes in Spring.Get{Full,Real}BuildQueue
* fix Immobilebuilder fails near the map edge
* fix Spring.SetUnitWeaponState "range" for cannon weapons
* add control over airStrafe via MoveCtrl.SetGunshipMoveTypeData
* migrate MoveCtrl.SetLeaveTracks to (LuaUnsynced) Spring.SetUnitLeaveTracks
* removed all widgets (moved to examples/Widgets)

==Engine / Internal==
* added limited OpenMP support
* added multithreaded OpenGL support via offscreen contexts
* added LinkingTimeOptimization (currently fails with GCC4.5/6)
* more/better error reporting
* new logging system: frontend is leightweight frontend is C compatible is more modular supports log levels: DEBUG, INFO, WARNING, ERROR, FATAL "sub-systems" renamed to "sections" more section then before is compatible with unit-testing write DEBUG and INFO to stdout, the rest to stderr disable console logging for unitsync disable console output for dedicated server shared library turn off flushing to log-file completely
* added GL_ARB_debug_output support (callback-based opengl error reporting) NOTE: this doesn't work yet, because most drivers export this ext only for so called debug contexts. Creating those is impossible with near all current GL frameworks (SDL, SFML, ...).
* fixed unnecessary memory allocation in Archive7Zip
* promote the CrashHandler hang-detector thread to a WatchDog
* use a SafeVector for the Command parameter array
* lots of cleanup and refactoring
* get rid of goto
* modularized chat-/game-commands (for example /cheat)
* no more use of AUX_SOURCE_DIRECTORY in CMake (as recommended by CMake team)
* Remove the obsolete SCons build system
* reduces constantly allocated memory for drawing stuff for AIs from ~130MB to ~ 2KB
* add a new build-target "generateSources"
* allow to use a system-supplied minizip library
* allow to disable each build type individually at configure stage
* generate version from git-describe (git tags), instead of hardcoding them into a source-file
* unsynced deletion of synced projectiles
* watchdog monitoring for some additional threads

==AI==
* AI Interface pure-ification, see Forum: Development - AI - <sticky-thread>
* add full two-way communications between AI's and unsyced Lua
* let AI's send textual commands (like "/cheat")
* allow AI Interface plugins to provide info about available Skirmish AIs
* install Java-AIInterface and JavaOO-AIWrapper as maven artifacts into the local repository
* Legacy C++ AI: allow fetching the maximum number of units in a game
* fix source generation occasionally failing for Java-AIInterface
* treat allied units as always in LOS
* fetch the correct UnitDef for decoy units, if the unit is allied
* Java AI Interface: pack native sources too
* Maven-ize NullOOJavaAI
* Java AI: allow AIs to support compiling only through Maven
* generally improved Maven support
* make source generation compatible with BWK and GAWK 4.0.0
* E2323AI: bump to latest version
* KAIK: mid-game init fix
* AAI: prevent stack corruption in the case of file paths longer then 500 chars
* RAI: do not use a single/static team-instance callback in a place used by all RAI instances

==Unitsync==
* implemented GetDataDirectoryCount() and GetDataDirectory(int index)
* add support for retrieving non-string info value types (string, integer, float, bool)
* introduce GetPrimaryModInfoCount
* fix OpenArchiveFile

==Installer==
* create minimal-portable .7z version of engine and reuse it in installer
* ai's are now installed always (removed individual sections)
* add registry key to unitsync.dll HKLM\Software\Spring\SpringEngineHelper
* replace readme.html with http://springrts.com/wiki/Read_Me_First

=0.82.7.1=
==Engine / General==
* disable frame number prefix in messages to the console by default
* add temporary hack to not crash on HostIP=localhost

==Engine / Lua==
* change parameter `useOverlay` from type number to bool in config access functions

==Engine / Auto-Hosts==
* gracefully exit if the autohost is not reachable
* if the local socket supports IP v6, but AutohostIP is specified as IP v4, use v4 to connect
* stop server on config problem

==Engine / Dedicated-Server==
* fix crash when game ends prematurely

==Unitsync==
* add new function GetSpringVersionPatchset() (return "1" for a spring version of "0.82.7.1"
* remove accidentially added third paramter to Init()

==Installer==
* fix: do not check for running .exe in silent-mode
* Zero-K: desktop-shortcut: rename & add icon

==AI==
* KAIK: add missing initialization checks

=0.82.7=
==Engine / General==
* fix crash due to invalid lastAttacker
* do not bind a UDP socket for local games -> allows multiple local instances again sans hassle)
* clamp minimum mapHardness to 0.001 to prevent div/0
* fix dangling CUnit* (crash for everyone in-game)
* fix crash in 3DO Parser
* fix bug in CGround::TrajectoryGroundCol with outside map coordinations
* prevent memory-leak in LoadGrayscale() if there already was pixel-data
* fix some more memory-leaks
* prevent equal unsynced random seeds
* fix SetUnitRotation
* fix enemy units responding to bugger off
* apply damage wrt. impacted piece if usePieceCollisionVolumes == 1
* make CBitmap::ReverseYAxis() more efficient
* remove excess elements from BasicMapDamage::craterTable
* rename "mod" to "game" in default menu & add "games/" to mod scanDirs
* implement host-definable IP's
* do not save/restore minimized windows state on win32
* convert some crashes because of invalid CEGs into warnings
* properly ignore non-blocking objects during collisions
* change minimum for UnitDef.buildDistance from 128 to 38 (default stays 128)
* broadcast team died events to all players, so it is stored in the demo file

==Engine / Logging==
* give S3O model name in error message when a texture is missing
* print name of widget to infolog.txt before it starts to load
* prevent empty content_error messages
* catch model content_error exceptions ASAP
* unify stdout/infolog output

==Engine / Lua==
* fix global enviroment pollution in luaui.lua
* allow Spring.AssignMouseCursor & Spring.ReplaceMouseCursor from LuaRules, too
* Allow loading from subfolders for weapon-def files (tdf and lua)
* implement Lua's GameFrame event via the EventHandler
* added parameter includeSky to TraceScreenRay
* correct `AllowResourceTransfer` params in default gadget handler
* new parameter for LuaSyncedCtrl::SetUnitArmored allows setting of the armor multiple

==Engine / Path-Finder==
* fix units-stuck-behind-terrain
* fix Godde-III
* do not assign extra waypoints to aircraft
* decrease ETA-failure response time
* keep speed above UnitDef::turnInPlaceSpeedLimit when turning (if turnInPlace==0)
* fix units slowing down on negative slopes
* set a more reasonable default turnInPlaceSpeedLimit
* PFS: remove circular constraint from run-time searches
* set a more reasonable turnInPlaceSpeedLimit

==Engine / Rendering==
* fix cannon visuals
* fix rendering of tri-stripped S3O's
* require GLEW 1.5.1+ because 1.5.0 does not have `glMapBufferRange`
* do not crash on shader compilation error
* fix build-order drawing for OBJ models
* replace 63x63 icons with 64x64 ones in LuaUI/Icons/ (prevents glitches on some older GFX cards)
* fix occasionally strange wake SFX

==Engine / Auto-Hosts==
* builds other then dedicated-server now also support commands "kill" and "pause"
* make command `paused` support a parameter (0|1)

==Engine / Dedicated-Server==
* fix binary name

==Engine / Head-Less==
* crash fix
* remove of "jump depending on uninitialized value"

==AI==
* LegacyCpp-AIWrapper: fix some memory leaks
* KAIK: fix memory corruption (one-character-typo...)
* KAIK: clamp costs to 1.0, not to 0.0
* KAIK: compile fix for 64bit
* KAIK: fix infinite loop
* KAIK: do not access invalidated pointer
* KAIK: init value before use
* KAIK: prevent accessing of array at position -1
* KAIK: prevent a crash when enemy unit is out of map bounds
* KAIK: fix mid-game init
* AAI: add version independent config file (by azaremoth) for _The Cursed_ game
* RAI: made compatible with MSVC
* RAI: fix cache file names
* RAI: fix AI considering water as harmful
* RAI: fix building non suitable buildings on certain maps
* RAI: fix a crash at end of game
* E323AI: pump to version 3.25.0

==Stack-Trace-Translator==
* fixed for main binary (.exe, windows)

==Installer==
* do not check for .Net when installing Zero-K
* delete all files that were installed
* add Tobis rapid client

=0.82.6.1=
==Engine / General==
* prevent false hang detection trigger

==Engine / Rendering==
* fix occasional ATI crash

==Installer==
* rename SpringDownloader to Zero-K Lobby
* re-add MSVCR71.dll

=0.82.6=
==Engine / General==
* fix various bugs related to mid-game join
* fix LosHandler ignoring units with losRadius <= 0 but airLosRadius > 0
* fix a leftover icon bug
* fix BFGroundDrawer crash at extreme view-distances
* fix death-wait
* allow death-wait in games with more then 2 ally teams
* reduce risk for deadlock during stack trace
* allow to specify game-start-delay in the start script (GameStartDelay)

==Engine / Simulation==
* prevent SEGV when updating skidding units
* improve turnInPlace=0 path-following (#2072)
* units ignored ETA failures when <= 200 elmos from goal, even if goal unreachable
* make pushResistant (allied) units still move out of the way of constructions

==Engine / Rendering==
* update the displayed resource production for inbuilt units too
* fix spectators see ghosted buildings
* do not draw icons for noDraw units
* do not cast shadows for noDraw units
* do not draw healthbars for noDraw units either

==Engine / AI==
* add feature-ID trace-ray command
* allow fetching of other teams resources (current, income, usage, storage)
* EnableCheatEvents() was a no-op because it did not enable cheats temporarily
* IsUnitInLosOrRadarOfAllyTeam() now considers gs->globalLOS
::*> UnitCreated now may trigger EnemyCreated for non-cheating AI's
* E323AI: new version: 3.22.4
* Python AI Interface: removed a few memory leaks

==Unitsync==
* fix mapname/mapfilename conflicts

==Installer==
* add portable install option (default: disabled)
* add Python AI Interface to the windows installer

==Repository==
* remove SelectionEditor

=0.82.5.1=
==Engine / General==
* fix FPS/direct controlling crash

==Engine / multi-threaded==
* fix unit icons/healthbars crash

==Engine / AI==
* E323AI: NOTA and XTA support enhanced & lots of improvements

=0.82.5=
==Engine / General==
* draw icons for cloaked units again
* fix NaNs if map hardness is zero

Lua
* fix UnitPreDamaged Lua CallIn

==Engine / AI==
* AAI: do not crash on game end if mod did not spawn a commander in the first 450 frames
* E323AI: lots of fixes & support for NOTA & Conflict Terra and AI options

=0.82.4=
==Engine / General==
* fix demo desyncs if commands were issued during pause
* fix abnormal demo speed (during reconnect and temporary lags)
* fix demo runs away from local user
* fix mid-game join
* fix FullScreen mode under Linux
* fix KDE/GNOME detection for error message box
* fix another FPU reset in LuaLobby
* don't reload defaults each time /ctrlpanel command is used (behaves now the same way as /cmdcolors)
* speed up reflection pass a little
* disable heatmapping by default
* fix COB's KILL_UNIT for self-kills
* fix bugged default-argument passing in path-follower
* fix broken return-value handling for UnitPreDamaged
* OBJParser: deal with carriage returns
* fix holdSteady (and sweeping beamlaser) rotations
* fix SEGV when /give'ing features
* fix crash when linking grass shaders on non GLSL system
* fix specs do not see all features
* fix Projectiles do not show up for missile weapons or torpedoes
* fix crash on bad playername message
* disable team highlighting for spectators by default

Lua
* fix incorrect ClipPlanes in DrawInMinimap if gl.SlaveMiniMap is used
* fix metal-maker widget

==Engine / AI==
* fix crash on capture from/by AI
* fix Python AI Interface
* AAI support version independent mod config files, for example BA.cfg

==Engine / Dedicated server==
* fix/re-add sync-check
* possibly fix crash when sending data to improperly-connected autohost socket

==Unitsync==
* add support for more then 16 start positions

==Installer==
* fix checks for installed .Net version
* add SpringDownloader desktop shortcut

==CMake==
* fix _make install-spring_ to work after initial configure
* fix windows linking (related to -lws2_32)

==Documentation==
* updated man pages: spring & spring-dedicated
* new man pages: spring-headless & spring-multithreaded

=0.82.3=
==Engine / General==
* rebuild because of stale base content packages (different checksums between windows and linux)
* fix NullAI installing into /

=0.82.2=
==Engine / General==
* miscellaneous OS X compile/link fixes
* fixed incorrect handling of negative references in OBJParser
* fixed misinterpretation of the OBJ spec
* reorganized WindowState saving on exit on X
* fixed source package build
* always print crash errors to infolog
* added i965_dri.so to OGL driver crash detection on Linux

==Engine / Simulation==
* fixed autosharing resources to dead teams
* fixed units disappearing from quadfield after load-unload in transport

==Engine / Lua==
* fixed invalid FPU flags after LuaLobby connection is made
* fixed DrawFeature event
* Spring.UnitScript.GetScriptEnv returns nil if the unit does not run a Lua script
* Spring.GetCOBScriptID returns nil if the unit does not run a COB script
* fixed typo in mapdefaults.lua
* possibly fixed GetPlayerInfo

==Engine / AI==
* updated E323AI to latest version

=0.82.1=
==Engine / General==
* fixed source package build
* fixed MT crash in DrawCommands
* fixed radar blips seen by spectators
* fixed dark metal spots in watert
* reduced default value of max particles
* increased default LOD/icon distances
* glFont::GetTextHeight & glFont::GetTextNumLines return now 0 lines for empty strings
* fixed 3do shadows
* fixed minimap rendering in dualscreen modes
* fixed laggy camera update with UnitTracker
* fixed seismic pings with incorrect size
* fixed incorrect highlight on end game screen

==Engine / Simulation==
* prevent units from becoming immobile zombies while maneuvering
* base etaFailures limit on a unit's full-circle turning time
* decrease etaFailures every frame we are not standing still
* fixed vibrating planes
* fixed nanoframe being spawned while game is paused
* fixed slow response when releasing wait command
* fixed the silly unit spinning ad-infinitum bug
* fixed unit occasionally not taking damage when it just left a transport
* fixed some awkward transport behaviour
* properly deal with radars/jammers being transported
* fixed unit returning to pick up point when it dropped out of transport
* skip waypoints that are behind a unit but within its turning circle

==Engine / Lua==
* added a LuaRules DrawFeature call-in
* fixed LuaUnsyncedCtrl::SetWaterParams
* fixed Spring.Restart with Win 2k and OpenAL-soft
* LuaSyncedRead::GetUnitExperience: also returns limExperience now
* removed obsolete engine options from EngineOptions.lua

==Engine / Dedicated server==
* use default visibility (hidden) for spring-dedicated under non-windows

==AI==
* RAI: log files are now under _log/_ sub-dir
* AAI: added config for BA 7.14
* E323AI: added config for BA 7.14

==Installer==
* made main part mandatory

=0.82=
==Engine / General==
* added HeadLess version of the engine (no graphics, no sound) by hughperkins
* better overall handling of connection problems, with highlighting of uncontrolled units
* players in startscript may reconnect to a running game, even with changed IP address
* players can choose server speed throttling algorithm by voting (/speedcontrol)
* do not crash on AI Interface error
* MT/GML: now a separate build target: make spring-multithreaded
* fix linking under Fedora 13
* allow choosing between available sound devices through config (snd_device)
* add missing /skip variants to word completion
* use new dependency system for maphelper.sdz (by Beherith)
* OS X fixes
* hardcoded startscripts removed (Air Test, etc.)
* more default intercept types added EmgCannon -> 1, AircraftBomb -> 8, Flame -> 16, TorpedoLauncher -> 32 LightningCannon -> 64, Rifle -> 128, Melee -> 256
* engine does not spawn start unit anymore
* engine does not use StartUnit tag in sidedata.lua anymore (but still passes it to Spring.GetSideData)
* engine does not read `Script' map tag anymore
* engine does not read `ScriptName' modoption anymore
* engine does not deal with `StartMetal' and `StartEnergy' modoptions anymore
* pathfinder debugging views can be rendered now when spectating (and not cheating)
* dropped modinfo.tdf support (only modinfo.lua is supported now)
* clients now compare their path-cache CRCs and warn about differences instead of updating their running checksums with them
* Spring's CPU affinity can now also be set on non-win32 platforms, use the SetCoreAffinity ~/.springrc parameter as a bitmask

==Engine / Simulation==
* new unit tag: cloakTimeout, int, default 128 frames
* fixed the featureVisibility mod-option
* fixed calls to the engine path-finder to be sync-safe when run in unsynced context
* reduced frequency of units ending up in "can't reach destination" situations
* fixed units not inheriting orders from factories and piling up (due to having their paths aborted)
* removed the TEDclassString UnitDef parameter (side-effect: hub-like units will break if they have a yardmap)
* removed diminishing metal makers option
* changed the semantics of the holdSteady UnitDef tag true ==> slave transportees to orientation of transporter attachment piece false ==> slave transportees to orientation of transporter body (default)
* fixed canDGun+commandfire to properly reproduce commander-like DGun behavior without script hacks

==Engine / Rendering==
* fixed alpha-masked shadows for S3O models
* fixed ATI alpha masked shadows (trees, features)
* fixed far-textures (caused changing teamcolors and disappearing units)
* support the OBJ model format (http://springrts.com/phpbb/viewtopic.php?f=9&t=22635)
* support specular lighting, multiple blendable detail textures, and sky reflections on SMF maps ("SSMF") http://springrts.com/phpbb/viewtopic.php?f=13&t=21951 http://springrts.com/phpbb/viewtopic.php?f=13&t=22564 (slightly outdated wrt. the SMD parameters)
* converted all shadow, tree, grass, model, and map shaders to GLSL
* vertex-animated grass; maps can specify the grass blade- and shading-textures and the dimensions/angle for blades
* refactored and abstracted unit/feature/projectile drawing to be format-agnostic
* increased global decoupling between simulation and rendering code
* fixed model specular lighting (most visible on units)
* S3O model normals are now auto-scaled to unit-length
* maps with mis-specified skybox textures will now load (without crashing Spring)

==Sound==
* use OpenAL Soft 1.11 under windows (was Creative)
* air-absorpion: absorb high frequencies when sound effects are far away (config-key & default value: snd_airAbsorption=0.1)
* no-sound support through NO_SOUND compile time define or NoSound config-key

==Unitsync==
* list of data-dirs for engine & unitsync are now always equal
* API cleaned: no more void*, all structs deprecated
* data dirs read from /etc/spring/datadir (separator is now ":" instead of " ")

==FontRendering==
* added a new inline ctrl command '\008' which resets the TextColor to the color that was active when Print() got called, as in the following example: font:SetTextColor(0, 0, 1); -- blue font:Print("\255\255\000\000red\255\000\255\000green\008blue");

==Lua==
* LuaLobby: callouts:
::* Script.CreateLobby() -> userdata lobCon
::* lobCon:Connect(string url, int port)
::* lobCon:Disconnect()
::* lobCon:Login(string username, string password)
::* lobCon:Rename(string newname)
::* lobCon:ChangePass(string oldpassword, string newpassword)
::* lobCon:Register(string username, string password)
::* lobCon:ConfirmAggreement()
::* lobCon:JoinChannel(string chan_name [,string password])
::* lobCon:LeaveChannel(string chan_name)
::* lobCon:Say(string chan_name, string message)
::* lobCon:SayEx(string chan_name, string message)
::* lobCon:SayPrivate(string user_name, string message)
::* lobCon:StatusUpdate(bool ingame, bool away)
::* lobCon:Channels()
::* lobCon:KickChannelMember(string chan_name, string user_name, string reason)
::* lobCon:ChangeTopic(string chan_name, string topic)
::* lobCon:Poll() callins:
::* lobCon.DoneConnecting(bool sucess, string error_message)
::* lobCon.ServerGreeting(string server_version, string spring_version, int udp_port, int mode)
::* lobCon.RegisterDenied(string reason)
::* lobCon.RegisterAccepted()
::* lobCon.LoginDenied(string reason)
::* lobCon.LoginEnd()
::* lobCon.Aggreement(string text)
::* lobCon.Motd(string text)
::* lobCon.ServerMessage(string text)
::* lobCon.ServerMessageBox(string text, string url)
::* lobCon.AddUser(string user_name, string country, number cpu)
::* lobCon.RemoveUser(string user_name)
::* lobCon.UserStatusUpdate(string user_name, bool away, bool bot, bool ingame, bool moderator, int rank)
::* lobCon.ChannelInfo(string chan_name, int num_users)
::* lobCon.ChannelInfoEnd()
::* lobCon.RequestMutelist(string chan_name)
::* lobCon.Mutelist(string chan_name, table {"userABC","userXYZ",...})
::* lobCon.Joined(string chan_name)
::* lobCon.JoinFailed(string chan_name, string reason)
::* lobCon.ChannelMember(string chan_name, string user_name, bool joined)
::* lobCon.ChannelMemberLeft(string chan_name, string user_name, string reason)
::* lobCon.ChannelMemberKicked(string chan_name, string user_name, string reason)
::* lobCon.ChannelTopic(string chan_name, string author, int time, string topic)
::* lobCon.ChannelMessage(string chan_name, string text)
::* lobCon.Said(string chan_name, string user_name, string text)
::* lobCon.SaidEx(string chan_name, string user_name, string text)
::* lobCon.SaidPrivate(string user_name, string text)
::* lobCon.Disconnected()
::* lobCon.NetworkError(string message)

* added a new los checking argument to Set..RulesParam() e.g. new syntax is SetUnitRulesParam(int unitID, string paramName, float paramValue, { public = true } ) possible values for the table are: `private` : only readable by the ally (default) `allied` : readable by ally + ingame allied `inlos` : readable if the unit is in LOS `inradar` : readable if the unit is in AirLOS `public` : readable by all note: if one condition is fulfilled all beneath it are too (e.g. if an unit is in LOS it can read params with `inradar=true` even if the param has `inlos=false`) note2: all GameRulesParam are public, TeamRulesParams can just be `private`,`allied` and/or `public`
* new Spring.GetUnitMetalExtraction(unitID) -> nil | number
* new synced Spring.ShareTeamResource(teamID_src, teamID_dst, type = ["metal"|"energy"], amount) -> nil
* new Spring.GetTeamResourceStats(teamID, resourcetype = ["metal"|"energy"]) -> nil | used, produced, excess, recv, sent
* added Spring.SetProjectileMoveControl(number pid, boolean b) --> nil callout; if (b), makes all piece/weapon projectile movement fully Lua-controllable
* improved Spring.GetTeamStatsHistory. It retuns now also the most recent data, not just the data of the cached stats which get updated only all 16 seconds.
* fixed incorrect scaling in Spring.SetUnitResourceParam
* fixed Spring.GetAIInfo, it returned incorrectly the given teamID as first argument
* fixed a bug in Script.RemoveSyncedActionFallback
* added missing `coroutines` module and missing `select` function to unsynced LuaGadgets
* added os.setlocale to LuaUI
* added Save/Load callins, both get a userdatum representing a save file as single argument Save is unsynced, Load is synced (both gadget only) Should allow implementing savegames mod side with less hacks /reloadgame chat command added for development purposes, this fires the Load event again
* modified base {armordefs|movedefs|sidedata}.lua to follow pattern of icontypes.lua
* added a ShieldPreDamaged call-in to LuaRules, triggered before any engine shield-vs-projectile logic executes
* UnitDefs[i].model.textures now actually contains the names of the model textures for unit-type i
* script.txt: Engine ignores GAME\\ModOptions\\LuaRules & interprets GAME\\ModOptions\\LuaGaia just as a boolean now
* fixed GetScreenGeometry on win32 platforms to return the proper screenSizeY, not screenSizeY - taskbarSizeY
* moved Spring.SetUnitRulesParam, Spring.SetTeamRulesParam, Spring.SetGameRulesParam from LuaRules-only to LuaSyncedCtrl
* removed evaluator functions from LuaOpengl
* removed Spring.MakeFont
* removed Spring.SetRulesInfoMap, Spring.GetRulesInfoMap, Script.GetConfigString
* removed Spring.CreateUnitRulesParams, Spring.CreateTeamRulesParams, Spring.CreateGameRulesParams
* removed AllowUnsafeChanges("USE AT YOUR OWN PERIL"), it's always enabled now

==Engine / Unit Scripts==
* LUS: SetSignalMask raises error now when called outside thread
* LUS: Signal/SetSignalMask support arbitrary objects as `signal names' now, bitwise logic is still applied to numbers
* LUS: _G in a Lua Unit Script points to the environment of that Lua Unit Script now
* LUS: TargetWeight and BlockShot are actually called now
* COB: Added KSIN (135, 1024*sin(x)), KCOS (136), KTAN (137) and SQRT (138) get constants.
* LUS: Fixed a desync bug.

==Interface==
* fixed middle click scroll speed on linux
* added new MiddleClickScrollSpeed option
* more responsive mouse movement
* made it easier to select units in factories
* added new command "/buildwarnings [0|1]", analogous to "/movewarnings [0|1]"
* improved unit type mix in front moves
* new middle click scroll icon

==AIs==
* added various new debug-draw callouts for profiling, state visualization, etc.
* make sure the Release event always reaches dieing-state AI's
* added a GetUnitVel callback, returns a unit's velocity vector
* new Python AI Interface by theGeorge & abma
* E323AI bug-fixes, logic- and performance enhancements
* AAI: fix some crashes (one on death) & a logic error
* RAI, KAIK and AAI: support unit captured&given from&to them
* RAI, KAIK and AAI: config-, log- & cache-files now compatible with pool archived mods
* KAIK: switched to .lua config-file format, added a basic mod whitelisting mechanism
* KAIK: event-based TM updates
* fix a crash on Skirmish AI death
* fix Java AI Interface loading on Debian
* fix Java compilation on some systems
* fix Java crash: increase initial java heap size (by cranphin)
* send an Update event before the first UnitCreated (when initializing mid-game)

==Bugfixes==
* LightingCannon (sic) finally isn't supported anymore, use LightningCannon instead (default weapondef_post.lua includes backward compability)
* fixed a bug in LuaParser, so you can now use booleans in lua CEG configfiles (before it just accepted "1"/"0" for some tags)
* fixed occasional bug where countdown time went into negative numbers and game never started
* fixed impactOnly ignored features
* improved error handling on network packet level

=0.81.2.1=
==Engine==
* Fixed incorrect projection matrix (i.e. tiny build menu)
* Fixed some Mac and MSVC compile errors
* Switched to OpenAL-soft, that should fix volume escalation
* Slightly improved detection of ATI/Nvidia OpenGL driver crashes
* Fixed team-color bug for both units and flying pieces

==AIs==
* AAI: removed obsolete map config files
* AAI: added BA 7.12 config file
* KAIK: removed dependence on TEDClass

=0.81.2=
==Engine==
* Removed OpenGL 1.4 version check
* Fixed sync with GCC 4.3 builds
* Fixed crash when sending startpositions of uncontrolled team
* Fixed race condition when taking screenshot
* In 'info' screen, human name instead of archive name is shown
* Reduced input CPU usage
* StartSpectating only has an effect if the player is not already spectating
* Packet resends have higher priority now than new packets
* Print message to infolog when traffic from unknown IP gets dropped
* Fixed vsync for Linux
* Removed OpenGL immediate mode rendering to work around broken ATI drivers

==Engine / Simulation==
* Kamikaze distance is now 3D, this fixes mines
* Added new UnitDef tag 'kamikazeUseLOS' (default false)
* Fixed submarine stacking
* Fixed units using smoothMesh unable to land at repair pads near hills
* Fixed COB interpreter incorrect compiler optimizations (fixes e.g. XTA hovercraft)
* Fixed features not taking damage from impactOnly weapons
* Fixed multiple-cons-build failing on structures with open yardmaps
* Fixed maxParalyzeTime when paralyzeOnMaxHealth is enabled

==Engine / AI==
* Fixed AI initialization process for games with >1 human player and for Lua AIs
* Fixed NETMSG_AISHARE for message size >32k
* Allow fetching the file path of an AI interface plugin
* Fixed crash on Skirmish AI death

==Engine / Lua==
* Spring.MarkerAddPoint now defaults to local
* Spring.CreateFeature heading value is converted to closest-matching facing

==Lua Unit Scripts==
* Fixed handling of AimShield return value
* Fixed Sleep/WaitFor not working in Killed
* Slightly improved AimWeapon/AimShield/Killed error messages

==AIs==
* E323AI 3.18.1
* AAI: Doesn't use minkowski metric for retreat distances anymore
* AAI: Fixed some NaNs

=0.81.1.3=
==Engine==
* Fixed automatically assigning start position if none is chosen
* Fixed bug in DXT5 loading (caused artifacts with teamcolors)
* Fixed F1 heightmap view
* Fixed playing of demos created in a game in which Spring crashed
* Made spectator drawings white instead of random team color
* Disable recording demos from demos (default, DemoFromDemo in springrc to enable)
* Added a mechanism to register/unregister for messages that are normally not broadcasted to game server

==AIs==
* E323AI 3.14.5: * support for: partial watermaps (plays land only), group merging, auto kbot/vehicle lab selection, template configs * XTA & BA config improvements * Better lab assisting
* KAIK: do not build MExes on spots used by allies

=0.81.1=
==Engine / Simulation==
* Terrain types and water damage are now taken into account for pathing checksum (Fixes desyncs on maps with map options which modify terrain types or water damage)
* Changed builder patrol/fight behaviour for Hold Pos and Maneuver movestates
* Being-built units are now visible on radar by default

==Engine / Rendering, UI==
* Added speed display
* Improved basic player list
* If OpenGL 1.4 is not available, an error is shown
* Fixed being-built unit rendering
* Placing buildings close together works again
* Fixed canceling of first build item when buildiconsfirst is toggled

==Engine / Lua==
* Less strict type checking in VFS.DirList (fixes FBI2Lua converter)

==Engine / System==
* Map options fixed
* Menu doesn't crash anymore if no mods/maps found

=0.81.0=
==Engine / Simulation==
* Builders are now smart enough to to reclaim features that block their buildsite, which weren't there when they started moving to it
* Fixed issues with features with 0 metal and 0 energy
* Fixed crashes / desyncs when using area orders with a large radius
* Hold position doesn't imply "don't turn" anymore, and units with small firing arcs in general behave a lot better in this case.
* Units on hold position now don't get confused by nearby invalid targets
* Smooth ground mesh for better aircraft behaviour (unit tag: useSmoothMesh)
* Wind fixed to stay in between map boundaries
* Momentum isn't conserved anymore in unit-unit collisions
* Impulses decay every frame instead of every slow update
* Kamikaze units now do a visibility and 3d distance check
* Fixed ships were able to 'climb' cliffs
* Fixed multiple issues with pathmap updates after terraforms

==Engine / Rendering, UI==
* Changed default binds of forcestart, singlestep, debug to Alt+f, Alt+o, Alt+b
* Non-reclaimable features show up as red squares now when placing a building
* Out-of-LOS features don't show up anymore when placing a building
* Fixed icons not rendering properly when distance-to-ground method was used
* Better mipmap handling on SMF maps
* Fixed specular lighting calculation on SM3 maps
* Fixed "/shadows" command on SM3 maps
* Fixed SM3 map holes
* Fixed "/wiremap 0|1" (argument was inversed)
* Lots of other drawing fixes
* Far-textures fixed
* Load-screens preserve aspect ratio
* Added checks for insufficent gfx cards
* Added new shadow rendering option ("/shadows 2"): it disables terrain rendering in the shadow pass, which gives a huge performance increase
* Changed BumpWaterReflection values: 0 = disable; 1 = enable (no terrain); 2 = enable (with terrain - was '1' before)
* Fixed occasional hang when word wrapping text
* S3O transparency is now supported even with AdvUnitShading disabled

==Engine / Lua==
* Added AllowFeatureBuildStep call-in to included gadget handler
* Fixed typos in certain featuredefs.lua, weapondefs.lua that mutilated error messages
* Spring.Rehost fixed on Win32 when spaces in install path
* Added support for modifying CTAAirMoveType (gunships)
* Add GetUnitMoveTypeData(unitID) call-in, returns a table
* Fixed Spring.SetFeatureDirection

==Engine / System==
* Fixed incorrect startpositions in skirmish games
* Proper handling of mod dependencies
* MAN pages support (Linux)
* Support for external debug symbols (Linux)
* Fixed an issue with using the root of a drive as data directory
* Use less memory when reading from 7z archives
* Improved handling of spectators in case of sim slowdown and desync

==AIs==
* E323AI: CPU performance improvements & bug fixes
* KAIK: better D-Gun handling

=0.80.5.2=
==Bugfixes==
* AI: Properly fix Lua AI loading
* AI: Fix crash when Lua AI team dies
* AI: Fixed clean target of ant scripts
* Fixed deadlock in hang detection
* Fixed .desktop file
* Fixed crash on startup on Ubuntu Karmic
* Fixed reflections
* MT: Don't crash if draw callins access features
* Fixed fading features for ATI (atiHacks)
* Fixed crash when parsing certain chatmessage from autohost
* Fixed crash if OSC stats sender is enabled and no network is reachable
* cmake: Fixed 7-zip detection

==Changes==
* AI/cmake: Split system dependent/indepentent install parts (AI_LIBS_DIR, AI_DATA_DIR)
* AI: Debugging is now enabled by default in the ant scripts
* Time profiler cleanup, both code and UI
* Show an AI's shortName + version + nick in tooltips

=0.80.5.1=
==Bugfixes==
* fix a bug where empty network packets were spammed (eating bandwith and demo space)
* fix a possible desync in the pathfinder
* fix mouse jumping in windowed mode (windows)
* fixed crash in KAIK

=0.80.5=
==Bugfixes==
* lots of bugs in the AI interface fixed
* fix some network-related problems and improve behaviour under worse conditions
* large performance increase for units on patrol
* fix some performance problems with the new heatmap pathfinder
* fixed a crash which could occur after an AirBase was destroyed

==Gui==
* joystick support
* some bugs resolved which could lead to crashes when using ogg samples or music
* properly handle dds textures
* fix some mouse-jumping in windows

==Sim==
* lua unit scripts major rework
* some sources of desync fixed

==Misc==
* fix some compiling problems related to boost 1.40
* some fixes for OS X

=0.80.4.2=
==Bugfixes==
* fix crash when doing lots of mapdrawing (#1632)
* fix crash when loading certain cursornormal files
* fix drawing of ghosted buildings
* properly initialise SDL timer for dedicated server
* fixed GatherWait cursor
* don't send resign-command when already spectating
* fix units with vlaunch missiles (#1647)
* Spring compiles boost 1.40

=0.80.4.1=
==Bugfixes==
* Fix missing tree fog, misc fog fixes
* fix crash in AI pathing
* fix crashes in the Java AI interface
* added VFS.MapArchive
* fix possible crash on exit
* fix crash when loading certain ogg-files

=0.80.4.0=
==Bugfixes==
* don't reclaim dragonteeth with area-reclaim
* lua unit script framework respects script tag

=0.80.3.0=
==Bugfixes==
* fix direct control unit movement (forwards and backwards)
* don't spam empty directories everywhere
* fix BA crash when doom was installed
* fix desync in pathfinder
* fix music timing
* single units should move in straight lines again
* fix shadows on features
* fix LocalModelPiece::GetPiecePosIter,GetPos,GetEmitDirPos
* fix vertical text aligning of multiple GUI controls
* fix jumping in middle click scrolling (windows)
* massive speedup in Spring.GetVisibleUnits
* added changed font vertical alignment opchars in gl.Text & luaFonts
* fix wreckages sinking in the ground
* add a modinfo featureLOS.featureVisibility tag
* fix BumpWater shorewaves
* make /nocost reversible

==Lua==
* add snapToGround bool param to SetFeaturePosition (default true)
* add SetFeatureAlwaysVisible (analog to SetUnitAlwaysVisible)
* added changed font vertical alignment opchars in gl.Text & luaFonts (baseline renamed to 'd'->'x', and use 'd' for descender)
* unit script: added GetPieceTranslation, GetPieceRotation, GetPiecePosDir
* unit script: SetSpeed/SetDirection/Go changes (see commit b49928454225f19f5c439c908c0a8cad775fb7ed)
* unit script: removed Create (framework handles it)
*

=0.80.2.0=
==Bugfixes==
* fix creation of DDS textures
* Unbreak transports when loadingRadius <= some magic number

==Lua==
* fix Zlib-compression and decompression for lua
* Added VFS.SubDirs(dir, pattern, modes) callout to LuaParser
* added some more map water configs to Game. table

=0.80.1.0=
==Bugfixes==
* don't write spring-files where they don't belong
* some rendering fixes (ATI errors, bumpwater)
* IPs of players not broadcasted
* area reclaim doesn't know of features not in los anymore
* slightly better paralyzeDamage handling
* fixed several issues with ArchiveMover - it now moves files to My Documents\My Games\Spring and should be more reliable

=0.80.0.0=
==Engine / Simulation==
* units can now move backwards
* notable speed improvement of feature handling (unit wrecks, tress...)
* LuaCOB: make it possible to make units with Lua instead of bos/cob
* some fixes for sm3 map-format
* pathfinding improvements for close groups of units
* reclaim / ressurection now correctly exported to LuaAI
* make better use of SSE functions for speed improvements
* now compatible with Boost 1.34 again (was 1.35 for spring 0.79)

==Engine / GUI, System==
* IPv6 support for all parts of the engine
* caching for 7z archives: speed improvements at high compression levels (solid archives now usable)
* rudimentary menu when starting spring executable directly
* BumpWater got a major speed increase, and shorewaves look better
* various improvements for the sound system (multithreading, fixes for music, ogg-effects...)

==AIs==
* Added /aikill and /aicontrol commands (only works in singleplayer in this version)
* AIs won't crash the game anymore on startup
* some AIs play better now (especially KAIK)
* a lot of minor bugs

==Dedicated Server==
* ingame stats exported to the autohost on game end
* always print IPs of players, even if connection fails
* allow password-protecting client slots to prevent name spoofing (needs lobby support)

=0.79.1.1=
==Bugfixes==
* fix microlags and increased CPU usage for dedicated server
* fix the game ending when playign with AIs
* various AI-interface and AI-related fixes
* fallback to Lua for unhandled actions
* fixed exploit where spectator could make Team 0 resign
* fix certain soundeffects

=0.79.1=
==Bugfixes==
* fix crash when a direct-controlled unit dies
* fix watching of demos
* various AI-related fixes
* SetUnitShieldState fixed
* fix an infinite memory allocation loop on startup
* restore acceptable framerate on vey old cards

=0.79=
==Major stuff==
* rewritten AI interface in C
* new font renderer
* sound system and music overhaul
*> 2292 files changed, 149700 insertions, 290245 deletions

=0.78.2.1=
==Bugfixes==
* fix for game refusing to speed up after a slowdown
* set MaxSpeed to 20 on (test)singleplayer
* fix insta-gameover vs. AIs
* fixed the server to run away from the local player on high gamespeeds

=0.78.2=
==General bugfixes==
* fix crash on gamestart with lots of players
* should fix most of the desyncs

==Engine==
* fix startscript not written in demo header
* units trying to stay in LOS of a target account for mip levels
* fix the no-commander-for-side-Arm problem for local games not based on TA content
* cob: made modelpiece mapping case-insensitive
* initialize relPos in EmitSfx
* fix for a fix in GetEmitDirPos
* fix aircraft not flying back to repair pads when all are reserved
* planes that are being refuelled aren't able to fire anymore
* clamp map position in unitLoader.
* players who didn't choose a start position start in their ally box
* fixed short command line params on windows (mantis #1271)
* don't try to kill dead teams
* add gamemode 3 (no game over) and make it the default in non-AI non-script.txt games
* removed luabind + lua-startscripts
* fixed multithreaded pathing
* removed partial match test for piece mapping
* fixed emitsfx crash (Mantis: #1252,#1238 & #1242)
* stunned planes shouldn't keep repair pads reserved
* always apply a miniscule amount of impulse when a unit is damaged

==User Interface==
* fixed AltTab bug on gpus w/o FBO support
* EndGameBox shouldn't render stats if the game hasn't started
* changed minimap_startbox.lua to not show cones in top left (#1272)
* StartPosSelector now unloads itself when game is started without sending start positions.
* fixed refraction=2, disabled endless ocean for maps that don't show any water at the start of the game
* fix #1258 (FBO crash on exit with non-FBO gpus)

==Lua==
* gl.Texture() can now load the textures of s3o features, syntax is gl.Texture('%'..(Game.maxUnits+featureDefID)..(':0' or ':1'))
* added a new (unsynced) callout Spring.SetWaterParams, it needs cheating enabled and allows you to edit the mapwater settings ingame
* fix Luamsg if null-characters where inside
* add an GetUnitTransformMatrix unsynced callout (handy for shadow algs)

==Installer==
* add RAI to installer
* allow the user to close TASClient / downloader during install

=0.78.1.1=
* fix Features (wrecks, rocks) not beeing drawn with reflective units

=0.78.1=
(notice the new version number scheme, its MAJOR (0.78) - MINOR (1))
==Crashes==
* fix crash on window resizing
* more groundDecal fixes
* do not force useFPShadows to true unless they are supported (to prevent crashes during map-loading)
* fix UDP buffer overrun

==Engine==
* use %CSIDL_LOCAL_APPDATA%/springsettings.cfg (e.g. \Users\<user_name>\AppData\Local\) to store settings instead of registry
* use SSE instead of X87 for FP-calculations
* if in Choose ingame startposition mode its possible to play a map with more players than startpositions
* fix the aircraft hovering / drifting
* fix random start positions not being random
* fix area-attack for aircraft (#1144 again)
* GenerateTargets no longer has much information that the team requesting targets doesn't have
* fix spikes / lags in hosting demos
* don't allow gunships to drift off the map
* make planes bobble in place gently by default, and make hoverfactor work as intended
* fix unit reply sound
* don't open a (unused) network socket in single player mode
* Don't let static beamlasers overshoot
* Added new collision volume types: sphere, footprint.
* Units/features with no collision volume defined get 'footprint' type by default now, this restores the 0.76b1 behaviour as default
* Gave COB function BlockShotX a third parameter, userTarget, uses the engine's hasUserTarget value, that seems to reflect when unit has an attack order
* fix teamstats in demofile
* don't fail with "network unreachable" instantly, but wait until timeout or connection fix

==Spring start / script.txt changes==
* added Game/MyPlayerName (MyPlayerNum is now deprecated and will be removed sometimes)
* send the gamesetup to each client once they join the server
* Player / Team / Mod - options are not needed anymore for clients, they are transfered from the server once ingame

==User Interface==
* Argh's ground-decal shader shadow tweak
* enable startboxes by default
* decreased CPU load and increase drawing speed lines
* fix small memleak when resizing the window
* The protection ring shows up for non-stockpile interceptors
* fix detection of units under mouse for spectators
* fix the CTeam statistics tracking
* do not force useFPShadows to true unless they are supported (to prevent crashes during map-loading)
* fix for annoying flickering of the grounddetail texture in CA if some LUPS fx were visible
* fixed a bug with waterplane on centerrock (the terrain is deeper than the water plane was drawn)
* made forcestart a real shortcut, so you can unbind it
* don't draw the terrain if curMaxHeight<0 and voidwater
* fix long commandline options for linux build
* dynamic sky rednerspeed improvements

==Lua==
* added Spring.GetLastMessagePositions() (returns the 10 last message positions)
* moved Spring.GetDrawSelectionInfo() LuaUnsyncedCtrl -> LuaUnsyncedRead
* moved Spring.GetSoundStreamTime() LuaUnsyncedCtrl -> LuaUnsyncedRead
* added a 2nd return value to Spring.GetSoundStreamTime() (total sound stream length in seconds)
* Made it possible to specify start positions in map with LUA .smd file
* Immobile Builders doesn't put factories on patrol and doesn't give a stop order

==Unitsync==
* Don't crash/abort() on invalid handles, but throw exception instead
* Fix crash bug in unitsync when UnInit/Init was called after an earlier Init which returned error code
* Doesn't leak exceptions anymore over C interface.
* Doesn't just crash by design anymore after something goes wrong.
* Added API GetNextError, can be used to get error queue (currently limited to 1 error)
* added SetSpringConfigFile(char*): reinitialise config handler to use the provided path
* added char* GetSpringConfigFile(): return the currently used path to the config file

* Deprecated APIs:
::* GetCurrentList
::* AddClient
::* RemoveClient
::* GetClientDiff
::* InstallClientDiff
::* IsUnitDisabled
::* IsUnitDisabledByClient
* Removed all code supporting those functions.
* These deprecated functions pop up MessageBox once on windows to nag lobby devs.
* Use engine's logOutput, still writes to unitsync.log (overwrites, doesn't append)
* ProcessUnitsNoChecksum is now identical to ProcessUnits.
* ProcessUnits now returns 0 immediately (but should still be called in loop until it returns 0, in case it's changed sometime later)

==Installer==
* Fix groups.ini being overwritten by installer
* removed all maps and mods from the installer

AAI v0.875
* Current amount of land/water within the base is taken into account when selecting factories (e.g. don't order water factories on a land map anymore)
* Improved AAIs behaviour on water maps with start positions on islands/land masses
* Improved metal extractor construction algorithm (spots closer to available builder, faster algorithm, works better if there are land and sea spots available at the same time)
* Continent file version bumped to 0.87
* Fixed a crash on shut down

=0.77b5=
==Installer==
* check if common unitsync users are running, abort installation if any is found
* don't download and install RiverDale and SmallDivide when the user already has it

==Crashes==
* even more preventions of DIV0

==User Interface==
* whe watching a demo with a setup locally, overwrite maxspeed with 10
* fix mousehover detection for radar icons
* fixed performance of Lua fontHandler
* make the orbit-controller actually do something on win32
* make the orbit-controller speeds configurable
* rescale fonts on window resize so they don't look ugly
* fixed black border blending of fonts
* ATI drivers lie about not supporting extensions required by shadows. we ignore that extension now

==Engine==
* new fbi tag: bankingAllowed - only affects hoverAttack=1 units; controls if the aircraft can bank.
* fbi tag upright now affects gunships
* fix CAirMoveType using an uninitialized variable (maxSpeed)
* fix Aircraft fuel not working properly on units with multiple weapons
* fix SendLuaMsg
* improve heading table resolution, this makes huge units less jerky
* fix the gamespeed not going back up after it was slowed down
* when ArchiveCache has not been written yet, do not add archive dependencies that are already in the chain (was breaking demos)
* fix factories switching their yardmap to fully-blocked when a unit is present inside (so units don't getstuck inside)
* fixed map defined detailtex
* fix LUA Spring.GetTeamResources does not return "received" for one player on each team

==Unitsync / Lobby interface==
* engine now loads many start script options from GAME\ModOptions\ section in start script, instead of just GAME\
* added EngineOptions.lua to springcontent.sdz, this contains the default engine options for backward compatibility
* GetModOptions unitsync call parses both EngineOptions.lua and ModOptions.lua, and returns combined list of options

==Random==
* lots of fixes to CMake and dedicated server (already released)
* minor KAIK stability fixes

=0.77b4=
==Crashes==
* fixed a crash (on exit) in colormap.cpp
* fixed another division /0
* fix crashes on "/take"
* fix crash when loading units into transporters

==User Interface==
* fix tabulator toggling overview mode
* reduce the maxBreaking-is-zero message spam
* fix far textures showing up as gray rectangles
* the error message "no writable directories found" now has a windows version too
* Fix explosion spheres appearing at wrong position
* fix attackorder for radar dots
== Engine==
* fix attacking gaia units
* fix the collision detection for dgun (and other noExplode) projectiles
* Made gunships (and possibly other units too) point their noses at the midPos of their target instead of the pos, the old behaviour could cause trouble with units where midPos and pos differ much.
* added crashDrag tag (float, default 0.005) to fighter/bomber planes, when the plane is crashing it uses this drag instead of the automatically calculated drag it uses when flying. The calculated drag is no longer used when crashing, even if no crashDrag tag is present in the unit fbi
* fix (AirMoveType) aircraft refueling
* fix gameend detected not propperly
* gameslowdown triggers at higher CPU usage and is limited to half the userspeed

==0.77b3==
User Interface
* added a simple Orbit-Camera controller META-key + LMB + drag ==> alter elevation, rotation META-key + MMB + drag ==> pan up/down/left/right META-key + RMB + drag ==> zoom
* fix transports not killing their transportees when they should
* update installer shortcuts
* when kicking a player, kick only the player and don't disconnect everyone
* fix invalid command spam
* fix some divisions through 0
* fix crash for all players when someone gives away all his units

=0.77b1, 0.77b2=

==User Interface==
* all commands are prefixed with '/' instead of '.' (".cheat" becomes "/cheat", etc.)
* Added /mapmarks [0|1]
* Added /allmapmarks [0|1]
* Added /forcestart command
* Added /ally teamID [0|1] (Ingame alliances)
* Added /commands (shows all registered commands in the console)
* whisper private messages to any other player ingame (excluding spectators) by typing "/w Playername Your secret message"
* Added new camera controller: SmoothCamera behaves like overview controller, but feels much smoother
* Added possibility to specify files that should be excluded from Spring's archive checksumming routines ('springignore.txt').
* Added commandline resolution change: ./spring -xresolution 800 -yresolution 600
* Added /unitreplyvolume [0.0-1.0]
* Added /hardwarecursor [0|1]
* Added /minimap drawprojectiles [0|1] (you can turn off drawing of projectiles on the minimap now)
* Added /grounddecals [0|1]
* Added /movewarnings [0|1]
* Added /globalLOS [0|1] (needs cheats on)
* Added the /luamoduictrl [0|1] command. Enables LuaRules/LuaGaia access to many LuaUI callins/functions.
* Added ground rendering detail factors: GroundLODScaleReflection GroundLODScaleUnitReflection (GroundLODScaleRefraction unused atm)
* Added TextureLODBias to settings (global mipmapping bias)
* Added CompressTextures to settings (it compress textures on runtime)
* Added UsePBO to settings (enables PixelBufferObject usage for smf texture loading)
* Added CamModeName as an alternate for CamMode (should still be backwards compatible for settings programs)
* Added SPRING_DATADIR variable on linux
* Added option "AtiHacks" to settings. This fixes an issue with severe display corruption during building, on ati drivers, where multiple colored lines criss-cross the screen. It also fixes issues with the new texture mipmap generation.
* You can now cycle through the last 10 message positions with F3.

==Spring Engine==
* multithreaded avi-generator
* new water renderer: bumpwater ("/water 4"), pretty and fast
* the usual speedups and performance improvements
* Font rendering system overhaul
* Functionality of Sensors.tdf and Particles.tdf moved to modrules. removed Sensors.tdf or Particles.tdf Transfers resources.tdf to resources.lua, and resources_map.tdf to resources_map.lua. Sidedata.tdf -> sidedata.lua icontypes.lua changed SideData 'commander' tag to 'startUnit' Replaced 'messages.tdf' with 'messages.lua' modinfo.tdf --> modinfo.lua ArchiveCacheV6.txt --> ArchiveCacheV7.lua
* Add 'springcontent.sdz' as the last dependency for all primary mod archives
* Custom collision volumes for Units and Features
* you can ally / unally other teams ingame using the "/ally [teamnumber] [0|1]" command (needs to be activated in lobby)
* Made the groundplate decals follow their parent building's facing.
* Allow modnames (e.g. "OTA Content") in dependX tag (modinfo).
* Removed 50% capture progress after an unit got captured.
* Made units transfer their speed to their wrecks.
* submarines can now travel directly underneath surface vessels and floating obstacles (and conversely; ships can move across underwater objects), EDIT your mod's MoveInfo entries so that the classes used by submarine-style units have "subMarine=1;" set if you want to enable this fully
* Increased weapon limit per unit to 32.
* Added the following new tags to modrules.{lua,tdf}
::* repair.energyCostFactor
::* capture.energyCostFactor
::* resurrect.energyCostFactor
::* reclaim.unitEnergyCostFactor
::* reclaim.featureEnergyCostFactor
::* reclaim.unitMethod
::* reclaim.unitEfficiency
::* reclaim.allowEnemies
::* reclaim.allowAllies
* Allow any key binding to a CMDTYPE_ICON command to use the 'queued' keyword (except for build and stockpile commands, which already have special handling)
* Keep units in various situations from deciding to attack units they shouldn't (noChaseCatagory, neutral, under water without water weapons).

==Units & Weapons==
* Added canFireControl unitdef tag.
* Fixed the stop-turn-move-stop-turn behavior for ground units (new udef tag, turnInPlace)
* Added maxRepairSpeed tag for builders. Limits the rate a con swarm of any size can repair a single target.
* Made accuracy, sprayangle and similar tags work for starburst missiles. The inaccuracy is applied when the missile turns toward its target.
* Added capturable tag.
* Implemented 'y' value for yardmaps which means this square is not blocked.
* Have fighting, patrolling and guarding aircraft and guarding ground units follow noChaseCatagory.
* Added per-weapon highTrajectory tag (int, default 2). It acts like the unit tag, 0 is always low trajectory, 1 always high and 2 uses the unit's setting (whether the unit uses a switch or fixed setting).
* Added impactOnly weapon tag (bool, default false), if set the weapon does damage by colliding with units instead of causing an explosion (the CEG will still run) to avoid the shortcomings of small AOEs. It's only implemented for projectile weapons so far.
* Custom collision volumes:
::* collisionVolumeType (either: "ellipsoid","cylT" where 'T' is one of {X, Y, Z}, "box")
::* collisionVolumeScales (float3)
::* collisionVolumeOffsets (float3)
::* collisionVolumeTest (0: per-frame hit detection, 1: raytraced)
::* all these tags are the same for Features
* Added shieldRechargeDelay weapon tag (float, default 0). The delay is the number of seconds the shield won't charge after being hit (kinda like the idle autoheal for hitpoints)
* Added 'sonarStealth' unitDef tag.
* Added new stockpileTime weapondef tag. It allows seperate reload and stockpile times for stockpile weapons.
* Allow for square metal extraction areas (use the new extractSquare unitdef tag).
* Added moveState and fixed fireState unitdef tags.
* Added strafeToAttack tag. Moving sideways when in range but not shooting optional behaviour, the behaviour fails if the unit just takes its time for aiming (or cannot shoot at all) or has any other reason not to shoot.
* Added avoidNeutral (targetting) and collideNeutral (projectiles) weapon tags.
* Added verticalSpeed (float, default: 3.0) unitDef tag for non-fighter/bomber planes to define the speed of takeoff and landing (or loading).
* Made missiles obey burnblow=1 (existing tag), the missile will explode in midair instead of turning away or falling down when its flighttime expires if the tag is set.
* Added the 'customParams' table to both featureDefs and weaponDefs (accessible via the lua FeatureDefs and WeaponDefs' tables).
* only add ".wav" extension for unitdef sounds if it is missing
* Made MeleeWeapon obey impulseFactor.

==Maps==
* Maps have their own resource_map.lua/resource_map.tdf now.
* converted map config scripts to lua format (LuaParser / MapParser)
::* MapOptions.lua is now handed the 'Map' table information as well (allows one to write a generic MapOptions.lua file that accesses the SMD/SM3 files to retrieve the defaults)
::* the SM3 format is yet to be converted to the lua format (but its MapInfo information is)
* added SMF height overrides in the SMD file, example: smf = { minheight = -100.0f, maxheight = 200.0f, } (note: these values can be changed by MapOptions)
* new water tags (mostly used by the BumpWater renderer):
:* shoreWaves (true)
:* forceRendering (false)
:* ambientFactor (1.0)
:* diffuseFactor (1.0)
:* specularFactor (1.0)
:* specularPower (20.0)
:* diffuseColor float3(1.0, 1.0, 1.0)
:* specularColor float3(light.groundSunColor)
:* fresnelMin (0.2)
:* fresnelMax (0.8)
:* fresnelPower (4.0)
:* reflectionDistortion (1.0)
:* blurBase (2.0)
:* blurExponent (1.5)
:* perlinStartFreq (8.0)
:* perlinLacunarity (3.0)
:* perlinAmplitude (0.9)
:* foamTexture
:* normalTexture
:* numTiles
:* caustics (texture table)

==COB==
* Added new COB get constants MIN (131), MAX(132) and ABS(133).
* Added the SONAR_STEALTH (108) COB get/set parameter

==LUA changes==
* Added 'teamcolors.lua' to the installers
* Renamed 'gui.lua' to 'luaui.lua'
* Removed LuaCob, and redirected Cob2Lua calls to LuaRules
* removed the following compatibility defines from luaconf.h (can break compability with old lua scripts): LUA_COMPAT_GETN LUA_COMPAT_VARARG LUA_COMPAT_MOD LUA_COMPAT_LSTR LUA_COMPAT_GFIND LUA_COMPAT_OPENLIB
* Moved most of the LuaUI call-outs into LuaUnsyncedRead and LuaUnsyncedCtrl. The LuaUnsyncedCtrl call-outs require that the modUICtrl variable be enabled for gadget scripts to use them.
* Moved most of the LuaUI call-ins into LuaCallInHandler and LuaHandle. The moved call-ins require that the modUICtrl variable be enabled for gadget scripts to receive them.
* Updated included gadgetHandler
* Removed unwanted/confusing widgets.
* fonts.lua can load fonts from the VFS (and will create LuaUI/Fonts/ if it does not exist)
* Removed the unused CommandDesc 'hotkey' member
* Renamed CommandDescription's 'onlyKey' to 'hidden'
* lua scripts now get first crack at all mouse events
* Treat SDD file sizes as dynamic, so that lua scripts can be reloaded while dev'ing without having file size mismatches (LuaRules, LuaGaia, mod widgets, etc...)
* Added some new constants to the lua Game{} table.
* Added the dynamic HeightMapTexture
:* FLOAT32/LUMINANCE format, NEAREST/NEAREST filtering
:* can be accessed by lua scripts using '$heightmap'
:* can be disable by clients with 'HeightMapTex=0' (config parameter)
* Added multiple new callins:
::* UnitEnteredWater(unitID, unitDefID, unitTeam)
::* UnitEnteredAir(unitID, unitDefID, unitTeam)
::* UnitLeftWater(unitID, unitDefID, unitTeam)
::* UnitLeftAir(unitID, unitDefID, unitTeam)
::* PlayerChanged(playerID) (player changed team or spectating state)
::* TeamChanged(teamID) (team changed allyteam, not useful yet)
::* UnitCommand(unitID, unitDefID, unitTeam, cmdID, cmdOpts, cmdParams) (note that cmdOpts is a number)
::* UnitMoveFailed()
::* MoveCtrlNotify(unitID, unitDefID, unitTeam, data)
::::* currently called with data = 1 if the unit hits the ground and stops
::::* return true to disable the unit's MoveCtrl
::* ProjectileCreated(projectileID, projectileOwnerID) (arg #2 is -1 if no owner)
::* ProjectileDestroyed(projectileID)
::* GamePreload() (Called at the end of the loading process)
::* GameStart() (Called when the game is about to start)
::* TerraformComplete(UnitID, UnitDefID, UnitTeam, BuildUnitID, BuildUnitDefID, BuildUnitTeam) (it gets called after the terraforming for a construction is complete (once per terraforming builder), the return value is whether the con should stop building.)
::* DrawGenesis()
::::* called immediately following Update()
::::* called even when the game window is minimized
::::* modelview and projection matrices are identities
::::* can be used to update GPU-side physics simulation textures and custom per-unit textures
::* a real ViewResize() call-in
* Added the unicode values to the lua KeyPress() and KeyRelease() call-ins
* Replaced Spring.GetMouseMiniMapState() with: Spring.GetMiniMapGeometry() -> posX, posY, sizeX, sizeY, minimized, maximized, <false | "left" | "right">
* Changed the GetUnitNearestEnemy() lua call-out to: GetUnitNearestEnemy(number unitID[, number range[, boolean useLos=true]])
* Added geometry shader support to LuaOpenGL
* Added Spring.ValidUnitID(number id) -> boolean
* Added Spring.ValidFeatureID(number id) -> boolean
* Added Spring.GetUnitIsDead()
* Added Spring.GetModUICtrl()
* Added Spring.GetViewGeometry() -> sizeX, sizeY, posX, posY
* Added Spring.GetWindowGeometry() -> sizeX, sizeY, posX, posY
* Added Spring.GetScreenGeometry() -> sizeX, sizeY, posX, posY
* Added Spring.IsAboveMiniMap(x, y) -> boolean
* Added Spring.GetUnitLastAttacker()
* Added Spring.GetUnitFuel()
* Added Spring.SetUnitFuel()
* Added Spring.GetUnitSensorRadius(unitID, <type>)
* Added Spring.SetUnitSensorRadius(unitID, <type>, radius)
* new projectile call-outs: Spring.GetProjectilePosition(projectileID) -> px, py, pz Spring.GetProjectileVelocity(projectileID) -> vx, vy, vz Spring.SetProjectilePosition(projectileID, px, py, pz) -> nil Spring.SetProjectileVelocity(projectileID, vx, vy, vz) -> nil Spring.SetProjectileDetonate(projectileID) -> nil
* added the GL evaluator functions to the lua GL interface (note the gl.EvalEnable() and gl.EvalDisable() can only be called in a gl.Eval(func) block).
* Added Spring.SetUnitCollisionVolumeData(id, xs, ys, zs, xo, yo, zo, vtype, ptype, paxis) and Spring.SetFeatureCollisionVolumeData() (same args)
* Added Spring.SetLastMessagePosition(x,y,z)
* Added Spring.SetUnitLosMask(unitID, allyTeamID, number | table) -> nil and Spring.SetUnitLosState(unitID, allyTeamID, number | table) -> nil
* Added Spring.FixedAllies()
* Reverted the GetPositionLosState() to its original configuration (no air los)
* Added Spring.IsPosInLos()
* Added Spring.IsPosInRadar()
* Added Spring.IsPosInAirLos()
* Added Spring.PauseSoundStream(), Spring.GetSoundStreamTime(), Spring.SetSoundStreamVolume(number)
* Added burst, burstRate and projectiles to Spring.SetUnitWeaponState
* Added Spring.AddUnitIcon(string name, string texture [, number size[, number distance[, bool radiusAdjust]]]) Spring.FreeUnitIcon(string name)
* Added Spring.SetUnitSonarStealth()
* Added Spring.SpawnCEG(tag, px, py, pz, dx, dy, dz, rad, dmg) synced callout
* Added Spring.SetHeightMapFunc(lua_func,arg1,arg2,..), Spring.AddHeightMap(x, y, h) -> `final height` Spring.SetHeightMap(x, y, h [,t]) -> `absolute value changed`
* Added Spring.ExtractModArchiveFile(path) callout For example, Spring.ExtractModArchiveFile("sounds/boom.wav") will create a directory "sounds/" and extract "boom.wav" to it.
* Added Spring.GetUnitPiecePosDir(unitID, piece) -> posx,posy,posz, dirx,diry,dirz
* Added Spring.GetUnitVectors(unitID) -> {front_x,front_y,front_z},{up_x,up_y,up_z},{right_x,right_y,right_z}
* Added Spring.GetUnitWeaponVectors(unitID,weaponNum) -> wpos_x,wpos_y,wpos_z, wdir_x,wdir_y,wdir_z
* Added gl.ActiveShader(shaderID, function(), ...) (safe way to set shader uniforms in non-drawing code)
* Added gl.DepthClamp(bool) (not always available)
* Added gl.UnsafeState(number, [bool reverse, ] function, ...) (glEnable() / glDisable() for unknown states; considered 'unsafe')
* Added Occlusion Queries:
::* Added gl.CreateQuery() -> query
::* Added gl.DeleteQuery(query)
::* Added gl.RunQuery(query, function, ...)
::* Added gl.GetQuery(query) -> number
* Added the following unsynced query call-outs:
::* Spring.GetUnitLuaDraw()
::* Spring.GetUnitNoDraw()
::* Spring.GetUnitNoMinimap()
::* Spring.GetUnitNoSelect()
* Added the fbo 'readbuffer' parameter
* Added gl.ReadPixels(x, y, w, h [,format])
* Added StencilTests: NOTES: The engine expects that the stencil buffer be left in a state of all 0's when a task has finished with it. This is not enforced by the lua backend.
::* Added gl.StencilTest(bool)
::* Added gl.StencilMask(bits)
::* Added gl.StencilFunc(func, ref, mask)
::* Added gl.StencilOp(fail, zfail, zpass)
::* Added gl.StencilMaskSeparate()
::* Added gl.StencilFuncSeparate()
::* Added gl.StencilOpSeparate()
* Added gl.BlendEquation()
* Added gl.BlendEquationSeparate()
* Added gl.BlendFunc() -- redundant
* Added gl.BlendFuncSeparate()
* Added gl.Blending() convenience names: name blend_src blend_dst enabled "add" ONE ONE true "add_alpha" SRC_ALPHA ONE true "alpha" SRC_ALPHA ONE_MINUS_SRC_ALPHA true "reset" SRC_ALPHA ONE_MINUS_SRC_ALPHA true "disable" SRC_ALPHA ONE_MINUS_SRC_ALPHA false "color" SRC_COLOR ONE_MINUS_SRC_COLOR true "modulate" DST_COLOR ZERO true
* Added Picking support: gl.RenderMode() gl.SelectBuffer() gl.SelectBufferData() gl.InitNames() gl.PushName() gl.PopName() gl.LoadName()
* Added gl.Texture($shading) & gl.Texture($grass)
* Allowed to use gl.CopyToTexture with non GL_TEXTURE2D, i.e. GL_TEXTURE_RECTANGLE
* Modified Spring.GetVisibleUnits() so that the team specifier can use the ALL_UNITS, ALLY_UNITS, ENEMY_UNITS, and MY_UNITS values.
* 'facing' parameters can now use long strings: 'north', 'south', 'east', 'west'
* Spring.UnitCreated() call-out now accepts unitDef names and unitDef IDs
* Spring.SendCommands() can use a bunch of string arguments as well as the old table format. e.g Spring.SendCommands('echo aoeu', 'info 2', 'specteam 0')
* Fixed Spring.UnitRendering interface to make it possible to emulate the default 3do/s3o shaders
::* fixed $shadows texture params (you can now use shadow2DProj() in glsl)
::* fixed wrong (!=0) check if uniform locations are set (they begin with 0!)
::* added new uniforms: cameraposloc,shadowloc,shadowparamsloc
::* added new culling tag, so you can enable s3o backface culling w/o using a displaylist
::* auto enable alphatest (+blending in case of cloaked stuff) for luaUnitMaterials (alphatest: 0.5 for opaque and 0.1 for cloaked stuff)
* Fixed missing return;'s in gl.LoadMatrix() and gl.MulMatrix()
* Fixed WarpMouse() for dual mode (minimap on the left).
* Fixed the 'frame' table value returned by Spring.GetTeamStatsHistory() (and added the 'time' value, which is in seconds).
* Fixed full-view spectators get all LuaUI RecvLuaMsg() messages now.
* Fixed Spring.SetFeaturePosition().
* Fixed Spring.SetFeatureDirection().
* If Spring.SetDrawSky(false) is set, do not draw the sun.
* Fixed s3o recognition in LuaUnitDefs

==AI==
* Added new ai value AIVAL_SCRIPT returning start script text.
* Removed ABIC AI stuff that no-one is using.
* Added AIHCGetUnitDefById, AIHCGetWeaponDefById, AIHCGetFeatureDefById

==Unitsync==
* Added LuaParser API to unitsync.
* Added OpenArchiveType(name, type) to unitsync (type can be "zip", "7z", "dir", or "hpi").
* Added 'const char* GetSideStartUnit(int side)' to unitsync.
* Added InitDirListVFS(path, pattern, modes) and InitSubDirsVFS(path, pattern, modes)
* Mod/Map Options : 'section' option type added
* Mod/Map Options : 'style' option added, syntax not defined yet

==Bugfixes==
* Fixed Aircraft units that can't land not stopping when reaching the final waypoint.
* Fixed display of times in the EndGameBox (For example 9:07 displayed as 9: 7)
* Fixed the grey flashing that sometimes happened when making new buildings
* Prevent decay when the builder or factory is waiting (executing a wait command).
* Fixed positions occupied by units with a maxspeed of zero (hubs, etc) being considered valid build-sites.
* Fixed division by zero if two units are in the exact same spot and collide.
* Fixed negative pings
* Fix a dangling pointer when using ground decals. Could have caused desyncs and LuaUI bugs.
* Fixed possible out of bounds map reads that could cause crashes
* Fixed /cheat and /skip not working in demo-playback mode
* Fixed /noSpectatorChat
* Fixed /fpshud polarity
* Randomize unitIDs
* Fixed dds mipmapping filter (was GL_NEAREST_MIPMAP_LINEAR).
* Fixed dynamic water with geforce 8x00
* Fixed it so that units using ScriptMoveType can not be pushed
* Fixed an infinite recursion in the LuaUI layout handler
* Fixed the Lua SendToUnsynced() stack check bug
* Fixed ScriptMoveType vs. unit pushing
* Fixed "cloaked units were invisble underwater" with DynWater
* Blocked team changes for dead units
* Fixed beamlaser damage vs shields
* Fixed smoke textures loading from resource.tdf (resources/graphics/smoke/smoke00 .. smoke11).
* Fixed clipping issue with units begin built.
* Don't show two statistic windows after demo watching.
* Always create/update the perlin texture used by shields and not only if shadows are enabled.
* Fixed ctrl+c, it searches now for the iscommander tag instead for the commander category.
* Fixed a wrong rotation in ApplyTransform() (which is used by lua's gl.UnitPieceMultMatrix).
* Fixed black lines on CEGs when AntiAliasing is enabled.

=0.76b1=

==Installer==
* Add new installer SideBanner, Spring icon and ArchiveMover icon all contributed by AF.
* Put springcontent.sdz and bitmaps.sdz in upgrading installer.
* Installer greatly improved - all content is downloaded from the internet based on which mods and maps you choose to install.
* No more updating installer because updating and full one would be nearly identical (in size and functionality).
* Added the following original content mods to the installer (downloads):
:*Gundam
:*Kernel Panic
:*Evolution
:*Spring: 1944
:*Simbase
* Added springsettings.exe by koshi.
* Added ArchiveMover by zizu. Automatically moves .sdz and .sd7 files to the correct place (Spring folder\maps\ or Spring folder\mods\)
* Moved to Satirik's lobby, huge amount of changes.
* Moved shaders into springcontent.sdz
* Replacement Bark, bleaf and foam images.

==Spring engine varying changes==
* A lot of networking code was refactored.
* Reintroduced heightMod to TryTarget.
* New aircraft command CMD_IDLEMODE, it switches between landing when idle and not landing.
* Cache input and output of GetWantedDir to save a lot of expensive calculations for a little loss of accuracy.
* Tiny speedups in LosAdd and SafeLosAdd.
* Optimized unnecessary sqrt in GuiTraceRay.
* Made the replay format better:
:* It has a proper header now with version field instead of the entire file being just a data blob.
:* The header has made the gameSetup script.txt modifications redundant: the UnixTime and Spring Version are in the header, and the gameSetup script is stored unmodified now.
:* It stores a game ID, this can be used to match replays of the same game together.
:* It stores the winning ally team, if any.
:* It stores player stats.
:* It stores team stats.
:* It stores game duration, both in game time and wallclock time.
* Small messages are once again send together in one packet.
* Stop animations when network lags (timeout set to 0.5 sec).
* Added some OGGVorbis sound support.
* Added behavior to mobile units so that they will start chasing when the target is running away, but before the target exits weapons range, allowing the unit to fire continuously at the retreating unit, instead of the cycles of firing, then running to catch up that existed prevously.
* Added client side network traffic tallying (per packet type).
* Lasers no longer use their full texture on shots that hit before their full length.
* Negative damage now allowed.
* Log the version of some of the major libraries (SDL, GL, GLEW, AL)
* Bump the unit-limit to 10000.

==Lobby interface (unitsync, game setup)==
* Added new start positions mode Choose Before Game. Useful for AIs, you can select the starting position of players from the client.
* Gap removal in GameSetup, players/teams/allyteams can now be given\ with gaps in the numbering, e.g. PLAYER10 and PLAYER14 in an 1 vs 1. Ordering does still matter.
* Unitsync Java bindings now have a version number.
* Checksum is now read from 7z/zip archive header instead of checksumming entire file, making things like map list reloading faster by a huge amount.
* Added GetPrimaryModVersion() to unitsync.
* Bumped to ArchiveCache version to 6 ... ArchiveCacheV6.txt
* Applied patch by tc making Spring's configuration variables available through unitsync.
* Disabled recursive directory scanning for .sdd and omitted files within .../hidden/* directories from the scan.
* Added the following unitsync calls: int GetModValidMapCount() const char* GetModValidMapCount(int index)
:* Valid maps are listed in the mod's "ValidMaps.lua" file.
:* A valid map count of 0 means that any map can be used with the mod.
:* This can be used in concert with LuaRules to setup multi-player scenarios and tutorials.

==AI interface==
* Exposed unit->maxSpeed to the AI interface.
* Added CallLuaRules() to CAICallback.
* Added 'AIDLL=LuaAI:' -> CTeam::luaAI handling for LuaAI.
* Added AI unloading after team is destroyed.
* Allow GlobalAIs to send a startposition.

==User Interface==
* Added the CTRL modifier to area reclaims to allow reclaiming your own wrecks
* Removed some hard-coded key bindings and replaced them with: edit_return edit_escape edit_complete edit_backspace edit_delete edit_home edit_end edit_prev_line edit_next_line edit_prev_char edit_next_char edit_prev_word edit_next_word
* Added some reasonable default keybindings for all/ally/spec chat messaging: enter -> send to <last send type> Ctrl+enter -> send to All Alt+enter -> send to Allies Shift+enter -> send to Spectators (Note that the modifier versions can be used to change the send mode ever while typing the message.)
* Added the CTRL modifier to area reclaims for reclaiming all features.
* /specfullview 3 is the new default for spectating and watching demos. (can view and select all units)
* Added the ctrlpanel.txt "frontByEnds" option. (let's you use the endpoints to define a front instead of the midpoint and one of the ends.)
* When a factory is set on repeat, alt+build-click inserts the order as a no-repeat and right after the currently built unit. Behavior is unchanged if repeat is off.
* Added water lines while placing unit builds.
* Moved the clock and fps indicators to the upper right hand corner. (the default setup results in overlaps with the player info text.)
* Modified the LOS view to better show the los-only and radar-only conditions dark = no los, no radar white = los + radar blue = los-only green = radar-only red = jammed area
* Disabled shadow generation when using LOS viewmode. (would be better to add shadows in LOS mode, but might as well avoid the shadow generation overhead until the shadows are added.)
* Make Fight be able to be given a line command, like move already can be.
* Only add the SelectAI button if the current selection has valid GroupAIs.
* Change default keybinding for createvideo to Ctrl+Shift+F10 (was Any+F10), so it is less easy to accidentally hit it.
* Change savegame default keybinding from Any+F8 to Ctrl+Shift+F8, for the same reason as the createvideo keybind change.
* Improved view centering for the Free Camera mode.
* Made nano-particles unsynced. (and respect maxParticles)
* Added '/cross [size]'.
* Added .godmode [0|1] -- allows all players (even specs) to control all units.
* Added a team parameter to .give: .give [amount] <unitName> [team] @x,y,z
* .kick and .kickbynum messages are filtered.
* Changed '/grabinput' to '/grabinput [0|1]', and added state reporting.
* Added the "/grounddecals [0|1]" command.

==Modinfo / modrules tags==
* Allow for the modder to define whether the crashing planes (and/or units running long Killed() scripts) can be fired on via modrules.tdf new section: [FIREATDEAD] { fireAtKilled=0; fireAtCrashing=0; } The defaults are to disallow both (Spring 0.75 behaviour, both variables set to 0). Spring 0.74 behaviour (allow both) can be emulated by setting both variables to 1.
* Added modinfo.tdf 'version', 'mutator', and 'shortName' tags.
* Added the following to modrules.tdf (default values shown): [DISTANCE] { builderUse2D=0; } [EXPERIENCE] { powerScale=1.0; healthScale=0.7; reloadScale=0.4; }
* Adds [experience] { experienceMult = 1.0; } to modrules.
* Adds [flankingBonus] { defaultMode = 1; } to modrules.
* Replaces the old bonus shield system with flanking bonus

==Unit / feature definition tags==
* The TDF tags MetalStorage and EnergyStorage now override the StartMetal and StartEnergy specified in the startscript, instead of the other way round. If MetalStorage or EnergyStorage isn't specified the default values for commander units are StartMetal and StartEnergy. For other units the default remains 0.
* Moved the buildOptions definitions into the unitDef definitions, LuaParser handles backwards compatibility.
* Changed init_cloaked to initcloaked.
* Add a tag 'pushResistant' to UnitDef. If set to true, a unit will not be pushed out of the way by another when their footprints overlap, nor will it respond to BuggerOff directives when the other party has an important move order. Defaults to false.
* Added a per-soundfile volume control format for unitdefs sounds = { ok = 'oksound', cancel = { 'cancel1', 'cancel2', }, select = { { file = 'selsound1', volume = 2.0 }, { file = 'selsound2', volume = 2.5 }, etc... }, }
* Features have new tag "reclaimTime" defining how long they take to reclaim, default is metal+energy.
* Added tags: transportUnloadMethod = <integer>; // 0 - land unload, 1 - flyover drop, 2 - land flood fallSpeed = <float> unitFallSpeed = <float> These dictate the speed of units being dropped from the transport. fallSpeed is used on the transports FBI file, to dictate the speed of all units it drops, unitFallSpeed is used on each transported unit to override fallSpeed.
* Added flighttime functionality to cannons.
* Added flighttime to bombdroppers.
* Added FBI tag cantBeTransported=0|1, if set to 1 no transport can load this unit.
* Added FBI tag minTransportSize=int, determines the smallest size footprint that the transport can load
* Added FBI tag minTransportMass=float, determines the smallest mass unit that the transport can load.
* Removed the check for Air movetype for holdSteady FBI tag, so now ground transports can use it too.
* New FBI tag for transports; float unloadSpread: Controls the spacing between units in an area unload command, works as a multiple, default is 1.
* Added the 'decloakSpherical' unitDef tag (defaults to true).
* Added optional 3D ranging for all builder operations. (build, repair, reclaim, etc...) (per-unitdef buildRange3D=true)
* New unitDef parameters: int flankingBonusMode float flankingBonusMax float flankingBonusMin float flankingBonusMobilityAdd float3 flankingBonusDir
* Added the "canSelfDestruct = true" unitDef tag.
* Enable CEGs to be tied to pieces of exploding units (CEG replaces the default smoke if used, but not the miniscule fire-effect)
* Added CEG opcodes y, x, a, p and q. Except for p those operate on a set of 16 buffers that store a float value each. y# - Yank: Stores the running value in the buffer # and returns 0. x# - Multiply: Multiplies the value with the contents of buffer #. a# - Add: Adds the contents of buffer #. p# - Pow: Returns the #th power of the value. q# - Buffer Pow: Like Pow but uses the contents of buffer # as the exponent.
* Add a tag "factoryHeadingTakeoff" (on request of the SWS folks to prevent some clipping issues) which controls the takeoff behavior of TAAirMoveType aircraft. True (default) means planes start matching their factory's heading right after taking off from the pad, false means they maintain the heading of the pad until reaching wantedHeight.
* Added [CONSTRUCTION] section to Modruless.tdf: constructionDecay (bool, default true): Should constructions decay if noone is working on them? constructionDecayTime (float, default 6.66): How long until the decay starts? constructionDecaySpeed (float, default 0.03): The speed of the decay, whereby buildTime*decaySpeed = time for a total decay so higher = slower decay
* Added unit FBI collide tag (boolean, default: 1), currently affects only planes: If set to 0 the plane will not collide with any other unit. Most notably this saves the CPU-heavy collision checks every frame (big performance boost!) and avoids the damage planes normally take from bumping into each other. Projectiles will still collide with the units normally.

==Weapon definition tags==
* Added heightBoostFactor - a float tag that 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.)
* Added heightMod tag (height difference is multiplied by this value before checking range), default 0.8 for Cannon weapon type, 0.2 for everything else (i.e. stays as it was). Beamlasers have heightmod=1 by default so they use pure spherical targeting.
* Added GroundBounce, WaterBounce, NumBounce, BounceSlip, BounceRebound, and bounceExplosionGenerator tags.
* New tags beamttl (default: 0) and beamdecay (default: 1) for the beamlaser. Beamttl defines the time (in frames) the beam will stay after being fired and beamdecay defines the speed of the fadeout (each frame the beam's intensity is multiplied with that value). This applies to the single-frame beams the weapon emits, if it has a beamtime it will emit one such beam every frame, which is only useful if the source of the beam moves a lot (gives a cool trail effect). It's primarily intended for beams with a beamtime of one frame (which often simulate very fast shots instead of constant streams, e.g. railguns) so they don't disappear immediately.
* Added fixedLauncher tag (bool) 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.
* Added projectiles tag (int), each time a weapon fires this many projectiles are spawned (on the same frame). Make sure you put them on different trajectories somehow (sprayangle or different firepoints) because otherwise they'll all be clumped in one shot. Can be set to 0 as well for script trigger weapons and can be combined with burst.
* Missiles and starburst missiles now obey smoketrail, set it to 0 to disable the smoke. To get a missile without smoketrail you have to define the weapon as a missile with WeaponType=MissileLauncher in the tdf.
* Missiles, starburst missiles and torpedoes now use flighttime if present instead of the hardcoded formula (which is still used if flighttime is not present)
* Added SubMissile tag (bool) 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.
* Added fireSubmersed tag (bool), defaults to the value of waterweapon. 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.
* Starburst missiles now obey turnrate for the turn at the peak of their flight (if supplied, otherwise the old value is used).
* All weapons (save for the Rifle which noone uses anyway) can now attack underwater targets if they have waterweapon=1 set.
* Bombs can use manually defined burst and burstrate values instead of autogenerated ones by using the new manualBombSettings tag (bool). Keep in mind that (roughly) burst*burstrate defines the area in which the bomber is willing to drop the bomb so if you make it too small the bomber might miss the drop area and not drop any bomb.
* Added myGravity tag (float) for ballistic weapons (Cannon and Bomb), it overrides the map gravity if used. Regular map gravity is around 0.2.
* Bombs now obey Accuracy and SprayAngle.
* Added ShieldStartingPower tag (float) for shields, if set the shield starts with this much power instead of 0.
* Renamed flareEfficency -> flareEfficiency.
* Added the weaponDef 'cameraShake' tag.
* Added the dance tag for missilelaunchers that makes the missile move around randomly. 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.
* Beamlasers ignore beamtime if new tag "beamburst" is set. (for emulating weapons that do damage in bursts)
* New weapon FBI tags: WaterBounce and GroundBounce: (default: false) Boolean to allow a projectile to bounce off of a surface. BounceSlip: (default: 1) Amount of lateral speed kept by the projectile after it bounces. BounceRebound: (default: 1) Amount of vertical speed keeps and reverses. NumBounce: (default: -1) The number of bounces a weapon will make. -1 indicates no limit.
* Added the ability to bounce for Torpedos, Missiles, Lasers, Cannons, and Emgs.
* Added bounceExplosionGenerator tag, which defines an explosion generator to run when a projectile bounces.
* Added the tag "hardStop" (bool, default 0) which, if used, makes the laser not fade if it doesn't hit before hitting its range limit and instead has the laser stop immediately and contract, as if it had hit something. This looks better with really long lasers, especially those that are longer than their range.
* Weapon projectiles can now spawn a CEG at their position every frame using the cegTag weapon tag.
* ProximityPriority tag - acts as a multiplier for the distance to the target in the priority calculation. Note that negative values make weapons prefer distant targets.
* Adds three opcodes to the CEG definitions:
* m (modulo or sawtooth wave) returns the remainder of the running value divided by m's parameter (100 m24 returns 4),
* s (sine) returns the sine of the running value with the parameter acting as the amplitude,
* k (discrete) returns the running value floored to an integral multiple of the parameter.
* All weapon projectiles that have a TTL now supply their remaining ttl-value as the damage param to their trail CEG (Flame projectiles use curTime instead).
* Added alwaysVisible weapon tag, makes the projectile visible, even without LOS.
* Added the weapon tag leadLimit that limits the maximum distance a unit will lead a target (default is -1 which means infinite).
* Added the weapon tag leadbonus which is multiplied with the unit's experience and added to the lead limit.
* Added the weapon tag predictBoost (default 0 for non-burnblow, 0.5 for burnblow weapons).

==Bugfixes==

* Fixed cannons not able to shoot as far from high ground as they should.
* Fixed infinite lower cylinder when cylindertargetting is active.
* Loaded air transports no longer land on stop command .
* Fixes in glBallisticCircle. (use heightmod also in drawing range circles.)
* Spring now returns 0 when started with -V, -h or -p.
* Fix random start positions. (positions are handed out before gaia team is added)
* CMD_REMOVE also works for idle factories (with move/patrol queues)
* Changed Cannon::GetRange2D so it uses something closer to real-world physics.
* Fixed Melee weapon always aiming west.
* Do not allow commands with out-of-map destinations.
* "Connecting to server" message now does not pop up when starting without startscript.
* Commandline is now parsed before the filesystemhandler starts up (speedup starting with arguments like -V or -h).
* Fixed builders with area reclaim sometimes going out of their designated circle
* Bombs now obey Accuracy and SprayAngle.
* Fixed lightning weapons having a hardcoded inaccuracy, made it obey accuracy and sprayangle tag instead.
* Fixed Lightning weapons not doing damage to shields.
* Possible fix for the disappearing healthbars.
* Fixed crashbug when exiting the GroupAI, sharing and quit boxes in an unusual way.
* Fixed starburst missiles so they stop their engines after they travel out of range.
* Fixed a possible load/save bug.
* Fixed crash in DamageArray() copying constructor.
* Don't say 'content error' if modrules.tdf isn't found.
* Improved error reporting in GetTDFName and LoadMap.
* Fixed replays.
* Fixed savefiles on non-Windows OSes.
* Fixed the run-time Spring.MakeFont() call-out.
* Fixed beamlasers so they don't ignore CollideFriendly.
* Fixed both CollideFeature and CollideFriendly for weapontype=Rifle.
* Fixed unloading of aircraft.
* Fixed crash when sharing units with a GroupAI other player doesn't have.
* Fixed .team, .setminspeed and .setmaxspeed when playing a demo locally.
* Fix groundscars turning white after using LOS overlays or enabling shadows.
* Better error reporting in case of global AI version mismatch.
* Fix SM3 when resizing windows.
* Don't profile the water renderer on voidwater maps.
* Weapons now use AimFromWeapon to determine the part to aim from, this prevents waggling and failing to aim at close ranges. To simulate the old behaviour make AimFromWeapon return the same piece as QueryWeapon does.
* Melee weapon now reports a proper angle to AimWeapon.
* Made starburst missiles obey startvelocity and weaponacceleration.
* Try to minimize damage caused by LuaUI crashes until cause is found by disabling LuaUI after several errors happen.
* Hackish fix for units sometimes not going to factory designated rally point
* Install the game/fonts/*.ttf files to fonts/.
* Handle a missing argument to .skip a little better.
* Fix error message for missing font.
* Take screenshot of entire window (rather than left half only) in dual-screen mode.
* Lua stack was changed to fix some segfaults.
* Prohibit spectators (except for the host) from changing the gamespeed unless cheating is enabled.
* Fix an exploit where partially reclaimed corpses that are turned into wreckage end up being worth more than the remaining value of the corpse itself.
* Fix weaponAcceleration typo causing major bugs with nukes and vlaunch weapons et al.
* Fix two "unknown net msg" errors in CPreGame when playing certain demos.
* Fixed a crash bug (lastColWarning == NULL) in TAAirMoveType.
* Fixed a crash in AirMoveType.cpp.
* Removed the automatic 'userInputPrefix' tracking for incoming messages
* Fixed the unitsync GetUnitFullName().
* Ignore used writing keypresses (for bindings like: 'bind a+u edit_next_word')
* fixes a bug in LuaUnsyncedRead::TraceScreenRay() when using dualscreen mode and minimap is on left.
* Unit pieces inherit alpha threshold from owner.
* Fixed jittery falling units.
* Fix timeout while loading / pathing
* CommandFallback was broken wrt return values, fixed.
* Improved dgun responsiveness. (still not perfect, but at least shoots through features now)
* Construct a proper orthonormal basis for muzzle-flame bitmaps.
* Gracefully handle missing script failure.
* Fixed speed and pause in replay.
* Fix for teleporting units when area-unloading out of map.
* Fix for uadded tracking of PushMatrix and PopMatrix Lua call-ins to reduce number of gl errors.
* Fix ghosted buildings always being drawn with default facing.
* Fixed weapon TDF 'fireStarter' tag, for all weapon types.
* Units, when they are within range, but unable to hit the target of an attack command, will move sideways.
* Fixed the bug where laserprojectiles had weird garbage on the front if the projectile was within lod distance.
* Fixed set HEADING COB variable so it updates unit direction.
* Fixed giving commands while recording a video.
* Fixed bug where after load all moving ground units stops with message "Can't reach destination".
* Fix for patrolling builders repairing stuff that's being reclaimed
* In the tooltip displayed on mouseover, deconstructing nanoframes didn't show how much metal they are producing on mouseover.
* Don't set the default shareTeam to a dead team ever.
* Fixed random mod.
* Made glPrintOutlined() almost 50% faster by lowering quality.
* Reclaimers list is now saved.
* Now error messages are broadcast to all clients.
* Paralyzers no longer damage features.
* Fixed the wait/teleport factory bug.
* Fix flying/underground units bug.
* Unhide the gaia team, and colorize by allegiance.
* Made demo not found / demo corrupt / format outdated exceptions instead of logOutput-warnings
* /quit will now quit immediately if you are the only active player.
* Fixed a 'bad team' segv in Spring.CreateUnit().
* Added the ScopedMapLoader helper to unitsync.
* Paralyzers no longer shake the camera.
* Fixed the missile and starburst texture2 only applying to the first segment of the smoketrail (the segment that's still part of the projectile, not a CSmokeTrailProjectile). Now the entire trail uses the texture.
* Fix possible segmentation faults after loading a shared object failed.
* Fixed bug where server dont send remaining data (including NETMSG_QUIT) to server
* Set ACTIVATION issues CMD_ONOFF instead of activating/deactivating, fixing issues with on/off not showing correct state.
* Added a check for weapon 'slavedTo' values (content_error).
* Fixed some bugs in gl.TexEnv / gl.MultiTexEnv / gl.TexGen / gl.MultiTexGen
* Used the decoyDef ghost building models when appropriate.
* Fixed CAirMoveType planes not rotating on factory pads.
* Fixed CTAAirMoveType planes always taking off from labs facing south.
* Fixed missile-gunships from being unable to force-attack ground.
* Fixed CTRL-MOVE group orders causing units to move at snail's pace.
* Fixed mid-air explosions that occur over water triggering a water splash effect.
* Fixed the isAttackCapable() check.
* Prevent CMissileProjectile weapons with trajectoryHeight from over- or undershooting when firing at targets below or above attack position. Based the angular correction factor on missile speed.
* Not being able to lock the config file on linux is not a fatal error anymore.
* Remove the (bestDist < radius) bugs.
* Make sure the (paralyzeDamageTime >= 0).
* Added bestDist method for all area searches.
* Added a check for immobile builders that will stop internal. commands for when the unit has moved out of the build range.
* Fixed FlareProjectile. (flare projectile was always removed after one Update.)
* Allow for "non-decloakable" units.
* CGameHelper::GetClosestEnemyUnitNoLosTest() now includes the target's radius for spherical tests.
* Stunned factories don't open, build, or close.
* Players from demo once again can't change speed / pause.
* Factored out some glGetDoublev() calls (may be faster on certain GPU architectures)
* Fixed issue that some people can only get sound when hosting.
* Fixed bug in map damage loading from savegame.
* Fixed possible bug in explosions map damage.
* Fixed crash with saving after nuke was intercepted.
* Fixed ground-transports being unable to unload units on certain maps.
* Units that are still inside a non-firebase transport do not destun.
* Fixed units whose state is floating but are not in water taking water-damage.
* Print "spectator <name> left" rather than "player <name> left" if the guy leaving is a spectator.
* Added serializing for InMapDraw.
* Fixed bug with saving builders that terraform ground.
* Fixed stunned units being unhittable if pushed.
* Made a seperate update thread while the game loads to prevent network timeouts on slow computers. (thread is joined when loading finished.)
* CCobInstance::RealCall now checks if stack is big enough before getting arguments from stack.
* made StartBuilding measure the pitch from the center of the unit instead of the base to deal with units with large vertical offset.
* Put CMinimap always on back so it does not draw over the user interface.
* Moved the QueryNanoPiece COB call into synced code to hopefully fix a desync.
* Fixed the bug where a repair order on a construction whose terraforming is incomplete will start construction anyway.
* Fixed units terraforming the ground under units being built by factories.
* Added some protection against .wav's whose headers contain a garbage datalen. (was causing SEGV's with XTA 9.2)
* Change lots of printf calls to logOutput.Print().
* Don't send NETMSG_GAMEOVER when watching a demo with only 1 allyteam left.
* Throw content_error if a mod/map archive can not be found instead of only printing a warning in the log. This should stop the 'missing default cursor' message actually meaning 'missing a mod archive'.
* Added minimap ping on game start and set lastMsgPos to something meaningful. Notably this fixes F3 zooming to top left corner before something interesting happens.
* Fixed crash when singlestep was executed in client mode.
* Spring and ArchiveMover.exe requires administrative privileges now on Windows, as a workaround until user directories can be specified as data directories.
* "Can't reach destination" message spam should be reduced a bit.

==Lua==
* Added call-in gl.Smoothing(point, line, polygon).
* Added Spring.GetViewSizes() to LuaOpenGL.
* Added the SetLosViewColors() call-in.
* Added the StockpileChanged() call-in.
* Added the DefaultCommand() call-in.
* Added the LuaUI WorldTooltip() call-in.
* Added the LuaUI GameSetup() call-in.
* Added GetUnitHeight() call-out.
* Added GetFeatureHeight() call-out.
* Added GetFeatureRadius() call-out.
* Added GetFeatureResurrect() call-out.
* Added SetTeamColor() call-out.
* Added GetTeamColor() call-out.
* Added GetTeamOrigColor() call-out.
* Added the Spring.SetDrawSky() call-out.
* Added the Spring.SetDrawWater() call-out.
* Added the Spring.SetDrawGroud() call-out.
* Added the gl.UnitMultMatrix() call-out.
* Added the GetLuaAIDesc() call.
* Added the Spring.AddUnitDamage( number unitID, number damage, number paralyzeTime, number attackerID, number weaponID, number impulseX, number impulseXY, number impulseZ) lua call-out.
* Added the gl.UnitPieceMultMatrix() lua call-out.
* Added the gl.EdgeFlag() lua call-out.
* Added the Spring.GetCameraFOV() lua call-out.
* Added the Spring.GetCameraDirection() lua call-out.
* Added unit count protection to Spring.CreateUnit().
* Added the DrawUnit() LuaRules unsynced call-in. (for SetUnitLuaDraw())
* Added the Spring.SetUnitLuaDraw() LuaRules call-out.
* Added the GameFrame() call-in to LuaUI.
* Added the AICallIn() LuaRules unsynced call-in. (for CallLuaRules())
* Added the Spring.GetTeamLuaAI() lua call-out.
* Added LuaUI Spring.GetGatherMode().
* Added LuaUI Spring.GetInvertQueueKey().
* Added Spring.SetUnitLineage(unitID, teamID[, bool isRoot]).
* Added Spring.GetBuildFacing() for LuaUI.
* Added Spring.GetBuildSpacing() for LuaUI.
* Removed the color info from GetTeamInfo().
* Added GetHasLag(), returns true if currently lagging behind host.
* Added PlaySoundStream and StopSoundStream for OggVorbis audio.
* Added the rank parameter to GetPlayerInfo(). (arg 7)
* Added 'autoland' to GetUnitStates().
* Added the UnitCmdDone() call-in.
* Added the UnitCloaked() call-in.
* Added the UnitDecloaked() call-in.
* Adedd the MapDrawCmd() call-in. (only for LuaUI)
* Added the unsynced Spring.GetVisibleUnits([teamID] [,radius] [,useIcons]) call-out
* Added the following to both UnitDefs[] and FeatureDefs[] height, radius minx, midx, maxx miny, midy, maxy minz, midz, maxz
* Disabled the lua DrawScreen() call-in when the interface is hidden. (note that the DrawScreenEffects() call-in remains active.)
* The majority of mod files are now loaded via LuaParsers, which can be edited to load different types of files. The default LuaParsers simply load the normal style files with improved error checking and speed.
* Game.armorTypes[] was changed to a bidirectional map.
* WeaponDefs[x].damages.damages[] was replaced with WeaponDefs[x].damages[index] (starts at 0 for the default armorType)
* Added the 'teamcolors.lua' local team recoloring LuaParser script.
* Added the gui_game_setup.lua GameSetup widget.
* Added 'ghostedBuildings' to Game[].
* Changed Game.modName to use the humanName value.
* UnitDef names are always lower case now.
* Added on-the-fly lua font texture / specfile generation.
* Added localization support in the lua tooltips and ctrlpanel.
* Generated local speed-ups for some of the installed widgets.
* Created FeatureDefNames and WeaponDefNames for LuaUI.
* Added Spring.SetUnitNeutral(unitID, bool) and Spring.GetUnitNeutral(unitID).
* Neutral units (mainly for gaia and fake features), will not be attacked. automatic when the attacker to be has its fireState set to "Fire At Will".
* Added a hidden fourth fireState level (3) that will shoot at neutrals.
* Added SetCustomCommandDrawData.
* Added 'extractorRadius' to the LUA Game table.
* Added Spring.IsGodModeEnabled() to LuaSyncedRead.
* Added the "gamedata/LockLuaUI.txt" check for LuaUI. If this file exists in the mod, then LuaUI can only load its gui.lua" file from the archive filesystem, thus putting the mod in full control of what LuaUI can be used to do (including disabling all user widgets).
* LuaAI is now supported.
* Added custom mod / map options via Lua:
* MapOptions.lua is to be used with LuaGaia, and belongs in the map archive,
* ModOptions.lua is to be used with LuaRules, and belongs in the mod archive.
* Renamed cmdDesc iconname -> texture for LuaUI LayoutButtons() input.
* Renamed cmdDesc mouseicon -> cursor for LuaUI LayoutButtons() input.
* Changed the cmdDesc double texture format to: '&<xscale>x<yscale>&<tex1>&<tex2>' (both textures can use either the named textures or '#<unitDefID>' format)
* * Added the Spring.RequestPath() lua call-out
* RequestPath(<number moveID | string moveName>, startX, startY, startZ, endX, endY, endZ [, goalRadius]) -> nil | path
* it returns a lua userdata or nil
* the userdata has the following calls: path:Next([currX, currY, currZ[, minDist]]) -> nil | x, y, z path:GetEstimatedPath() -> {[1] = {x,y,z}, [2] = {x,y,z}, etc... }, -- waypoints {[1] = index, [2] = index, etc... } -- resolution start points
* Added Spring.GetUnitEstimatedPath() -- same return as path:GetEstimatedPath()
* Added GetEstimatedPoints() to CPathManager
* Added the NETMSG_LUAMSG net packet type
* Added the following calls to LuaUI: Spring.SendLuaUIMsg(msg [,mode = ''|'a'|'allies'|'s'|'specs']) Spring.SendLuaCobMsg(msg) Spring.SendLuaGaiaMsg(msg) Spring.SendLuaRulesMsg(msg)
* Added the RecvLuaMsg(msg, playerID) call-in to all lua scripts
* Added the weaponID to the lua UnitDamaged() for fullRead scripts
* Removed imageSizeX and imageSizeY (potential desync). The gl.TextureInfo() call can be used instead
* Made decloakDistance a per-unit property, and made it accessible to synced lua scripts as the third parameter to SetUnitCloak().
* Added GetModOptions() and GetMapOptions()
* Added UnitSeismicPing() (with a sound)
* Added the ability to set the stockpile percent
* Added the Spring.SetUnitTarget(unitID, targetID | <x,y,z>, bool userTarget) call-out
* Added the Spring.SetExperienceGrade(number) call-out (sets the experience steps that will trigger the UnitExperience() call-in, based on the limExperience varible value (exp / (exp + 1)))
* Added the UnitExperience() lua call-in
* Added VFS.UseArchive(filename, function(...) ... end, ...)
* allows for packaged widgets (source, textures, sounds, etc...)
* currently only works for raw filesystem access (limited to LuaUI)
* Added the following lua call-outs to allow unsynced read access to COB global variables: GetCOBUnitVar(unitID, varID) GetCOBTeamVar(teamID, varID) GetCOBAllyTeamVar(allyTeamID, varID) GetCOBGlobalVar(varID) (varIDs start at 0)
* Added FBO objects to lua GL, with MRT (multiple render targets) capability, and blitting
* Added RBO objects to lua GL, which should allow for depth + stencil format
* Added lua Scream objects, which can call a function when they are garbage collected
* Added VFS.SubDirs(), to get a list of subdirectories
* Spring.SendMessage() and friends can now be used by unsynced lua code
* added Lua SyncedCtrl function Spring.SetUnitMoveGoal(unitID, posX, posY, posZ[, radius[, speed]]), this makes the unit move closer to the target location, to a distance of <radius> (default 0). This is mostly for custom commands that should have the unit moving into range, it doesn't affect the order queue. It's marked as unsafe.
* New Lua call-out (SyncedCtrl): Spring.SetUnitWeaponState(unitID, weaponNum, stateTable) StateTable is a table containing one or more of reloadstate, reloadtime (this time in seconds), accuracy, sprayangle, range, projectilespeed. Obviously the values will be assigned to the variables the keys refer to.
* Added the Spring.GetMapList() call-out to the mod ValidMaps.lua script
* Added the Spring.GetMapInfo() call-out for the ValidMaps.lua script
* Added mapSizeX and mapSizeZ to the lua Game table
* Fix GetCmdDescIndex()
* Added a seventh parameter to AllowCommand, "synced". It's a bool that is true when the command was sent by either a Spring-internal action or synced Lua and it's false if the command came from the user or LuaUI. This should facilitate preventing user commands to a unit while allowing LuaRules commands.
* Removed the third return value of Spring.GetTeamInfo (active) since it was broken.

COB
* Give a COB error instead of crashing for invalid explosion generator indices or weapon indices in emit-sfx. #
* Added COB call to "ShotX" that happens shortly before weaponX uses QueryWeaponX, use this for switching firepoints in bursts or when using multiple projectiles.
* StartBuilding now supplies the pitch as the second parameter to help with custom build FX.
* Fixed cob bitwise not operator (was logical not.)
* Added a MOD COB opcode for modulo division
* Introduces the COB get/set variable 103, ALPHA_THRESHOLD. It ranges from 0-255 and changes the glAlphaFunc to use that alpha value as its minimum. In practice this allows disintegration-style effects or the reverse for build animations.
* Transport AI now calls the cob function 'StartUnload' which is called once when transport starts to lower during land flood method.
* Dropped units call the cob functions 'falling' and 'landed' so that you may start and stop a parachute animation.
* Added the 'cobID' unitDef tag, and the COB_ID (100) COB GET type
* Added the BlockShot#(unitID, block) COB call-in - set block to non-zero to block the unit firing at unitID
* Added the cob GET/SET STEALTH command (96)
* Added CRASHING (97) get/set constant to COB. Can be used to get/set whether an aircraft is crashing. Is ignored for non-CAirMoveType units. (including CTAAirMoveType aircraft)
* Added global, team, and ally GET/SET variables to COB scripts 1024 - 2047: 1024 global variables 2048 - 2175: 128 variables per team (the COB script unit's team) 2176 - 2303: 128 variables per allyteam (the COB script unit's allyteam)
* Added 8 shared per-unit variables (example: GET UNIT_VAR_START -unitID value)
* Added the SET_WEAPON_UNIT_TARGET (106) and SET_WEAPON_GROUND_TARGET (107) COB GET codes (used GET because of its extra parameters)
::* GET SET_WEAPON_UNIT_TARGET weaponID unitID userTarget
::* GET SET_WEAPON_GROUND_TARGET weaponID xzCoord yCoord userTarget
* Added TargetWeightX COB call-in and CHANGE_TARGET cob set var. COB call-in TargetWeightX(targetID, weight), weight defaults to 65536 which represents 1.0 and is multiplied with the target's value to determine priorities. Set CHANGE_TARGET to Y makes weaponY pick a new target.
* Adds the COB set constant CEG_DAMAGE (99), which defines the damage value for all CEGs triggered by emit-sfx 1024 + x to allow for some variability in the emitted effects (to e.g. make a charging energy ball grow larger or have smoke get progressively darker as the unit's HP decreases).
* Added a new get call, PLAY_SOUND, to play a sound that can be heard only by allies, enemy, in los, etc. GET PLAY_SOUND(sound number, volume, who hears the sound, where to play the sound) (see r4974 for full docs)
* Get health now allows a unit ID to be passed.
* Added COB and Lua access to some more weapon variables. New COB constants, all get-only (but not read-only): WEAPON_RELOADSTATE 125 (frame number of the next shot/burst) WEAPON_RELOADTIME 126 (in frames) WEAPON_ACCURACY 127 WEAPON_SPRAY 128 WEAPON_RANGE 129 WEAPON_PROJECTILESPEED 130 All of these use the first param (starting at 1) as the weapon index whereby positive means read and negative means write the second param to the value. In the latter case the previous value is returned.
* New COB GET/SETS FLANK_B_MODE 120 // set or get FLANK_B_DIR 121 // set or get, set is through get for multiple args FLANK_B_MOBILITY_ADD 122 // set or get FLANK_B_MAX_DAMAGE 123 // set or get FLANK_B_MIN_DAMAGE 124 // set or get

=0.75b2=

* Fixed possible crash while waiting for connection to the host.
* Fixed unknown net msg in read ahead bugs when large UDP packets were received.
* Fixed a crash when empty network packets where destructed.

* Fixed rapier like units being unable to attack enemy units.
* TargetBorder now takes the correct vertical distance into account.
* ".kick" and ".kickbynum" now just kick the given player instead of kicking everyone including the host himself.
* Game end condition is now fixed to check allyteams instead of teams.

* Added gui_xray_shader.lua widget
* Added gui_team_platter.lua widget
* Added camera_smooth_move.lua widget

=0.75b1=

==Uncategorized==
* Added LuaCob, LuaGaia, LuaRules synchronized scripting:
:* LuaCob: (mod) provides access to lua functions for COB scripts
:* LuaGaia: (map) controls the Gaia team
:* LuaRules: (mod) gives full read/ctrl to setup custom mod game rules
* Added LuaRules Spring.UnitRendering (LuaMaterials, unfinished).
* Merged the LuaUI code with the new lua library setup.
* Made LuaUI mod widgets possible.
* Added support for the Gaia team.
* Added SimpleGroundFlash to explosion generator.
* Added 'dds' and 'png' as default buildpic formats.
* Load/save now uses the creg serializer.
* Netcode has been refactored to be more readable.

==AI==
* Added Load/Save interface for AIs.
* Load/save support for EconomyAI and MexUpgraderAI.
* Added GetStartPos to IAICallback.
* Fixed CCommandQueue in AI interface.
* Added AIVAL_UNITLIMIT enabling AIs to query the maximum number of units.
* Added the ability to unload a specific unit using the UNLOAD_UNIT command (the unitID should be added as the fourth parameter)
* Added AIVAL_STOCKPILED to query the amount of stockpiled ammo.
* Added AIVAL_STOCKPILE_QUED to query the amount of queued stockpile ammo.

==Behavorial==
* Allow up to 16 pads per air base.
* Units can not build stuff on top of cloaked stuff anymore.
* Units guarding other units now properly repair the other unit if it's damaged.
* Units guarding factories prioritize repairing the factory instead of building new units.
* Stunned (and transported) units can not build anymore.
* Units (that are still paralyzed) are not un-stunned anymore during unloading.
* Changed the unit resource updates so that they occur even while stunned.
* Transporters can carry hovers and ships now.
* Transporters now check ground slope before unloading.
* Units on a slope steeper than their max slope will now skid down it.
* Disabled the ground flattening when building mobile units.
* Added paralyzed unit skipping for paralyzers. (use ALT to disable skipping, same modifier as for permanent area commands)
* Made a unit's ablity to slow itself relative to the angle of the slope.
* Improved aiming of Cannon type weapons. They will no longer over/under shoot due to large height differences.
* Weapons don't target dead and crashing units anymore.
* Mobile units under hold position in a temporary attack order don't move away from their patrol route anymore.
* Added ScriptMoveType (incomplete, but functional).
* Commander doesn't randomly D-gun buildings anymore when FPS mode is disabled.
* Missiles now honour SprayAngle weapon TDF tag.

==Bugfixes==
* Removed the maximum 8 sides limit.
* Fixed incorrect searching order in the virtual file system.
* Fixed teamcolor for S3O and 3DO features.
* Fixed cloaked S3O units losing their texture.
* Fixed teamcolor rendering for MissileProjectile and WeaponProjectile.
* Fixed handling of .give so team unitlimit is respected.
* Dynamic and refractive water are now reinitialized after window resize.
* Fixed rendering of shadows of S3O models with transparency.
* Fixed rendering of underwater grass.
* Made LuaUI compatible with VFS access.
* Fixed SM3 shader for ATI x1* series.
* Fixed incorrect cancelling of rotated buildings build orders.
* And many more

==Chat commands==
* Added an optional [0|1] parameter to the pause command.
* Added an optional [0|1] parameter to the showHealthBars command.
* Added an optional [0|1] parameter to the updatefov command.
* Added an optional [0|1] parameter to the drawtrees command.
* Added an optional [0|1] parameter to the dynamicsky command.
* Added an optional [0|1] parameter to the hideinterface command.
* Added ".editdefs [0|1]" to allow lua based UnitDef editing.
* Added ".reloadcob <unitName>" to reload cob scripts.
* Added ".skip <[+|f]seconds>" for in-game and replay fast-forwarding.
* Added "/safegl [0|1]" command for testing lua rendering overhead.
* Added "/buffertext <text>", copies text into the console history.
* Added dynamic "/vsync" control.
* Added the "/fpshud [0|1]" action.
* Added "endgraph [0|1]" action.
* Changed ".take" so that cheating must be enabled for spectators to use it.
* Added the ability to give features using ".give" (only if the unit name doesn't match, player's team is used)
* Added input text editing
:* backspace & delete
:* home & end (or ALT+{left|right})
:* CTRL+{left|right} for word skipping
* Added the '//' -> '/' command prefix conversion syntax
* Added the following LuaUI widget handler commands: "/luaui togglewidget <widgetname>" "/luaui enablewidget <widgetname>" "/luaui disablewidget <widgetname>"
* Added the '/lodscale [shadow|reflection|refraction] <scale>' command.

==COB==
* HitByWeaponId(z,x,id,damage) will be called instead of HitByWeapon if it exist in script.
* Implemented COB get/set constant STANDINGMOVEORDER (2)
* Implemented COB get/set constant STANDINGFIREORDER (3)
* Added a new COB query call, "QueryLandingPadCount".
:* if not defined, Spring will assume 16 as the maximum number of pads
:* it takes one argument, which is initially set to 16, the number returned in arg0 will be used as the maximum number of pads.
* Fixed logical XOR,AND,OR (they were implemented as binary XOR,AND,OR)
* Added COB get/set constant UPRIGHT (79)
* Added COB get constant POW (80) with 2 arguments x and y: it returns x^y.
* Added COB get constant PRINT (81) which prints it's 4 arguments to infolog.
* Added COB get constant HEADING (82)
* Added COB get constant TARGET_ID (83)
* Added COB get constant LAST_ATTACKER_ID (84)
* Added COB get/set constant LOS_RADIUS (85)
* Added COB get/set constant AIR_LOS_RADIUS (86)
* Added COB get/set constant RADAR_RADIUS (87)
* Added COB get/set constant JAMMER_RADIUS (88)
* Added COB get/set constant SONAR_RADIUS (89)
* Added COB get/set constant SONAR_JAM_RADIUS (90)
* Added COB get/set constant SEISMIC_RADIUS (91)
* Added COB get constant DO_SEISMIC_PING (92)
* Added COB get/set constant CURRENT_FUEL (93)
* Added COB get constant TRANSPORT_ID (94)
* Added COB get/set constant SHIELD_POWER (95)
* Added COB get/set constants LUA0-LUA9 (110-119)

==Config==
* Added "SMFTexAniso" config parameter (default = 0, disabled) (application controlled anisotropic texture filtering for SMF maps)
* Removed "SM3MaxTextureStages", it's confusing and the fallback mode isnt really useful (still slow).
* Added config parameter MaximumTransmissionUnit. This can be used to control the maximum UDP packet size Spring uses. The default is 512, which should keep all UDP packets below the required minimum MTU of 576 bytes (512 payload). If the hypothese that many player drops are because of too big UDP packets is correct, then this may solve it.

==Feature TDF tags==
* Added boolean feature TDF tag NoSelect. (default: 0)

==Fixed exploits==
* Fixed exploit: UnitRestricted could be circumvented by making multiple factories and starting a build of the restricted unit in all factories at the same time.
* Fixed exploit: CanAssist could be circumvented if multiple builders were ordered an identical build at the same time out of their immediate range.
* Fixed exploit: Aircraft can not cross map boundaries anymore in FPS mode.

==Game Setup==
* Added 'lineage' game mode (2). If the commander dies, all units directly or indirectly built by him die, regardless of the current owner of the unit.
* Added player 'CountryCode' tag for the gameSetup script.
* Added game setup script parameter 'Savefile'.
* SaveGame can also be loaded by command line: 'spring QuickSave.ssf' or 'spring C:\Spring\Saves\QuickSave.ssf'
* Added NoHelperAIs tag: determines whether helper AIs are allowed.
* Added LuaGaia tag: is LuaGaia enabled this game?
* Added LuaRules tag: is LuaRules enabled this game?

==GUI==
* Added land at 80% for aircraft.
* Better handling and display of widgets which are enabled, but not active.
* Disable unit tracking when using middle mouse button scrolling.
* Disable unit tracking when the viewport is set via the minimap.
* New unit selection filter "in hotkey group".
* Units being transported can not be selected anymore unless the transporter isfireplatform.
* Mobile units can be loaded onto a transport by clicking on the transport with the mobile unit selected.
* Added Free camera mode (to help make better videos). It's primarily intended to be used with keyboard input (CTRL/ALT/SHIFT/META behave differently then the normal camera modes). It's is not in the toggle list by default.
* Added CTRL+F5 default keybinding for free camera mode.
* Added text coloring for ally and spec message input.
* Changed unit sharing so that allied units do not clear their command queue, and cleaned up some more state for enemy transfers.
* Allowed build command descriptions to use text in the 4 corners of a button (0 = SW, 1 = NE, 2 = NW, 3 = SE)
* Added the "hotspot" command for the *.txt mouse cursor spec file
* Added side preference prefix for start pictures.
* Allow "allside_" start pictures to always be used (regardless of side).
* FPS mode now shows weapon names instead of numbers.
* Area build now builds every second row in the opposite direction.
* Perimeter build now builds everything in clockwise or counterclockwise order.
* Circle build now builds everything in clockwise or counterclockwise order.
* Circle build now works correctly when trying to use non-square buildings for circling anything.
* Improved QuitBox player selection visibility.
* Gunships and air builders now have a repair level switch.

==Mapping==
* New ocean.jpg (public domain) comes from golgotha texture set and tiles better then original ocean.jpg.
* Changed default repeat settings so the new texture fits better (wrt. scale)
* Added "MAP\WATER\WaterRepeatX" and "MAP\WATER\WaterRepeatY" SMD tags, defining the amount of times the water texture should be repeated in X and Y direction.
* Aspect ratio of water texture is taken into account now.
* Added 'gamedata/resources_map.tdf' for gaia unit projectile textures.

==Unit FBI tags==
* Added boolean FBI tag AirStrafe. Only effective if HoverAttack=1. If AirStrafe=1, gunships and construction aircraft will strafe in a circle around the target. If AirStrafe=0, they will not strafe, they will sit stationary in the air firing their weapons. If set to 0 they sit at one place.
* Added string FBI tag Gaia.
* Added string FBI tag DecoyFor: the name of the unit this one is a decoy for.
* Added boolean FBI tag CanBeAssisted. (default: 1)
:* Disabling assists to factories should work well.
:* Builders have to die to release their hold on a unit being built, and once the unit is released, multiple builders can repair the unit.
* Added boolean FBI tag CanSelfRepair. (default: 0)
* Added boolean FBI tag TransportByEnemy. (default: 1)
* Added boolean FBI tag HoldSteady, causes transports to hold units such that their updirs are always aligned.
* Added boolean FBI tag ReleaseHeld for transports. When set to 1, the units carried by the transport will survive the destruction of the transport itself.
* Added float FBI tag SlideTolerance, multiplies the the max slope for determining when skidding should begin, due to slope. Values less than 1 will cause the unit to never start skidding due to slope. (default: 0)
* Added float FBI tag MinCollisionSpeed, indicating the minimum net impact speed that will cause damage to a unit.
* Added vector FBI tag CollisionSphereOffset
* Added float FBI tag LoadingRadius
* Added boolean FBI tag FullHealthFactory, controls whether or not a unit can leave the factory if it is not at full health. (default: 0)
* Added float FBI tag RepairSpeed (default: WorkerTime)
* Added float FBI tag ReclaimSpeed (default: WorkerTime)
* Added float FBI tag ResurrectSpeed (default: WorkerTime)
* Added float FBI tag CaptureSpeed (default: WorkerTime)
* Added float FBI tag TerraformSpeed (default: WorkerTime)
* Added boolean FBI tag DecloakOnFire (default: 1)
* Up to 8 ok, select and arrived sounds can now be defined. (use tags ok1, ok2, etc.)
* Added float FBI tag CollisionSphereScale, this is a scaling factor for the unit's collision sphere. (default: 0.5 for aircraft, 1 for other units)

==Weapon TDF tags==

* Added weapon tdf command SweepFire, 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.
* Added boolean weapon TDF tag CanAttackGround. (default: 1)
* Added float weapon TDF tag float TargetBorder: if nonzero, targetting units will TryTarget at the edge of collision sphere (radius*tag_value, [-1;1]) instead of its centre. Defaults to 1 for Melee type weapons, 0 otherwise.
* Added float weapon TDF tag CylinderTargetting: if greater than 0, range will be checked in a cylinder (half height=unitradius*cylinderTargetting) instead of a sphere. Defaults to 1 for Melee type weapons, 0 otherwise.
* Added float weapon TDF tag MinIntensity: for beamlasers - always hit with some minimum intensity (a damage coeffcient normally dependent on distance).
* Added float weapon TDF tag SizeDecay: how much a plasma particle is smaller than the previous within the same plasma shot. (default: 0)
* Added float weapon TDF tag AlphaDecay: how much a plasma particle is more transparent than the previous particle. (default: 1)
* Added float weapon TDF tag Separation: distance between each plasma particle. (default: 1)
* Added int weapon TDF tag Stages: number of particles used in one plasma shot. (default: 5)
* Added boolean weapon TDF tag NoGap: 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. (default: 1)
* Added the weapons TDF tag 'visibleShieldHitFrames' (defaults to 0 frames)
:* can be used along with 'visibleShieldHit'
:* the alpha value fades after the hit
* Added colormap for ballistic ('cannon' type) weapons.
* Added boolean weapon TDF tag AvoidFeature, this makes the weapon avoid features while targetting. (default: 1)
* Added float weapon TDF tag FallOffRate: 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.
* Added float weapon TDF tag LodDistance: minimum camera distance at which the default beamweapon projectile is simplified to rectangle. (default: 1000)
* Added float weapon TDF tag DynDamageExp: exponent of the damage formula, 0 (the default) disables dynamic damage. 1 means linear scaling.
* Added float weapon TDF tag DynDamageMin: minimum damage value. (default: 0)
* Added boolean weapon TDF tag DynDamageInverted: inverts the damage curve.
* Added float weapon TDF tag DynDamageRange: if set it will use this value instead of the range value from the weapon in the calculation.

==New projectile handler textures==
* sbtrailtexture - default first section of starburst missile trail texture
* missiletrailtexture - default first section of missile trail texture
* muzzleflametexture - default muzzle flame texture
* repulsetexture - texture of impact on repulsor
* dguntexture - dgun texture
* flareprojectiletexture - texture used by flares that trick missiles
* sbflaretexture - default first section of starburst missile trail texture
* missileflaretexture - default first section of missile trail texture
* beamlaserflaretexture - default beam laser flare texture
* bubbletexture - torpedo trail texture
* gfxtexture - nanospray texture
* projectiletexture - appears to be unused
* repulsegfxtexture - used by repulsor
* sphereparttexture - sphere explosion texture
* wrecktexture - smoking explosion part texture
* plasmatexture - default plasma texture

==Scons build system==
* Added debugdefines configure option: true by default, if it's set to false (debugdefines=no) then a debug build will be made with release preprocessor defines. This can be used to generate debugging symbols for release builds.
* Added dc_allowed configure option to enable/disable direct control.

==Unitsync==
* Added GetSpringVersion() function to unitsync. This returns the Spring version.
* Deprecated InitArchiveScanner() unitsync function.
* Added java bindings to unitsync.
* Unitsync is now installed to libdir on Linux. It can be assumed this is either /usr/local/lib/spring/unitsync.so or /usr/lib/spring/unitsync.so.

=0.74b3=

* Added LuaUI v0.1 (with widget management code, somewhat experimental) (requires the LuaUI setting to be on to be autoloaded, "/luaui disable" to disable in-game "/luaui reload" to load in-game "/luaui reload fresh" to load in-game, but with fresh state)

* Renamed docs/lua_ui_interface.txt to LuaUI/API.txt

* Added "/minimap slavemode [0|1]" and "/minimap draw" for use with LuaUI

* Added "/specfullview 2" spectator mode, where you can both view and select all units

* Added "/volume <fraction>" command (0.0 to 1.0 range)

* Added "group <int> [ "set" | "add" | "selectadd" | "selectclear" | "selecttoggle" ]" action as an alternative to the group[0|9] commands (note that the key modifiers can be setup differently from the default)

* Fixed FBI tag floater for planes,
* Added FBI tag canSubmerge for planes. The following rules apply: 1) If a plane only has the 'floater' tag set to 1, it will land on the ocean surface. 2) If a plane only has the 'canSubmerge' tag set to 1, it will land on the ocean floor. 3) If a plane has both tags set to 1, it will obey rule 2.

* Fixed the factory cancelled-build delay bug.
* Fixed units get stuck while guarding factories bug.
* Fixed planes can't find landing pad on large maps bug.
* Fixed in game video creation (default binding F10).
* Fixed a bug causing much metal/energy to be lost instead of shared to allies.

* Smoothed LOS / Radar view.

=0.74b2=

* Planes can land on water surface if FBI tag floater is set to true.

* Added GROUND_WATER_HEIGHT (78) to get in cob script. Same as GROUND_HEIGHT (16) but in water it returns negative water depth instead of 0.

* Units don't slowdown on intermediate waypoints anymore.

* Added mingw compatible crashhandler.

* Fixed sharebox and quitbox for 16 players.
* Fixed FPS mode aiming to the northwest.
* Fixed FPU control word assertion that made spring unplayable with some sound drivers.

* Added sorting options to "/info", you can use names or numbers: 0 - "off", disable display 1 - "ally", allies (you, your team, your allyteam, your enemies, then spectators) 2 - "team", player team id 3 - "name", player name alphabetic sort 4 - "cpu", player cpu usage 5 - "ping", player ping time

* Added the "maxparticles <value>" action
* Added the "minimap simplecolors [0|1]" action
* Added the "specfullview [0|1]" action (setting it to 0 gives the same minimap and viewport visibility as the selected team)

* Added "OverheadTiltSpeed" config parameter

* Fixed the unit-limit vs. sharing bug

* Shadow mapping works for SM3

=0.74b1=

* Linux vs Windows is now synced if binaries are built using gcc 4.0 or higher.

* Games with more then 10 players now work properly.
* Several improvements and fixes for autohosting, including a .kickbynum command.

* Added minimap commands (two modes, see the MiniMapFullProxy config param)

* Added "MiniMapGeometry" config parameter
* Added "TooltipGeometry" config parameter
* Added "TooltipOutlineFont" config parameter
* Added "InfoConsoleGeometry" config parameter

* Added "/resbar [0|1]" action
* Added "/tooltip [0|1]" action
* Added "/specteam <number>" action (sets the spectator team)

* Added "newAttackMode" and friends to "ctrlpanel.txt"

* Added animated line stippling for queue rendering (see cmdcolors.txt)

* Cursors can now use TGA and PNG file formats
* Added an optional cursor control file for easier timing/frame control

* Renamed the /layout command to /luaui
* Renamed the "ctrlpanel.lua" file to "gui.lua"

* Added "timewait [seconds] ["queued"]" action
* Added "deathwait ["queued"]" action
* Added "squadwait [count] ["queued"]" action
* Added "gatherwait" action
* Added "gathermode [0|1]" action

* Added a number of features to the LuaUI (see Documentation/lua_ui_interface.txt)

* Improved the outline font rendering speed

* numbers in .info list are now team numbers, so they match with '.team X' commands.
* names are now prefixed with 's:' 'a:' or 'e:' for respectively spectators, allies and enemies.
* if spectating, an arrow is displayed in front of the team you are currently watching.

* added Shift and Alt/Meta group selection modifier features (Shift adds members to current selection, Alt/Meta toggles them)

* added the "viewsave <name>" and "viewload <name>" actions
* added GetCameraState() and SetCameraState() to the lua GUI interface

* added "selectcycle [restore]" action

* fixed queue build rendering (GL_DEPTH_TEST)

* added GetUnitHealth(), GetTeamResources(), and GetCommandQueue() to the lua GUI interface
* enabled loading the "ctrlpanel.lua" file from the VFS

* added "wait queued" and "selfd queued" to the default key bindings
* fixed WAIT behaviour for factories
* enabled queuing of Self Destruction commands
* added a pathetic SELFD cursor

* added "alwaysDrawQueue" and "buildBoxesOnShift" to cmdcolors.txt

* added the "invqueuekey [0|1]" action, and [InvertQueueKey=0] config parameter
* added mouse rocker gestures for immediate mode access when using inverted queue keying

* AIs can query a unit current fuelstorage via GetProperty() with property AIVAL_CURRENT_FUEL (2).
* AIs receive seismic pings via HandleEvent() function with message AI_EVENT_SEISMIC_PING (5).
* The icontype of enemy units is remembered if they are under continuous radar coverage.
* Ghosted buildings under continuous radar coverage don't have an error vector in their position anymore.
* Ghosted buildings also turn into unit icons when far away.

* Improved clickability of unit icons.

* Calling emit-sfx 2048 from a script will now allways fire the weapon. Emit-sfx 4096 will now take over the previous behavior of detonating the weapon at the piece position.

* Added unit FBI tag UnitRestricted to limit the number of a unit type allowed in a game.

* Added CLOAKED (76) and WANT_CLOAK (77) to get/set in cob script.

=0.73b1=

* added the ability to layout the control panel widget layout with a LUA script (uses a file called "ctrlpanel.lua")
* added the "/layout" command for direct interaction with the layout lua script

* Map packs (ie. multiple maps in one archive) are officially unsupported now because of technical reasons.

* Added keyword "dir" to explosiongenerator, this is a vector and can be diferent depending on what created the explosion. If created at a weapon impac it is the direction of the impact.

* Added the abillity to call explosiongenerators and weaponfire from within script via emit-sfx command. Explosiongenerators to be called via script are defined in the unit TDF file in a section called SFXTypes, with tags explosiongenerator+n=some_explosion and then called via emit-sfx 1024+n. Weaponfire are called via emit-sfx 2048+weapon_to_fire.

* added "ctrlpanel.txt" configuration file to control how the Control Panel is rendered (x/y icons counts, sizes, positions, prev/next menu icon locations, etc...)
* added an option in "ctrlpanel.txt" to render some of the screen text with an outlined font. This is a hack, and can cause FPS decreases on slower computers (main factor is blended fill-rate)

* added an outline around the minimap

* fixed reclaim exploit where extra metal was gained if you destroyed the building just before it would finish reclaiming.

* added "cmdcolors.txt" settings file to configure control indicator rendering (this includes command queue lines and ranges, highlighted unit ranges, the mouse selection box, and the selected unit boxes)
* added line width specification for items in "cmdcolors.txt"
* added blending mode specification for items in "cmdcolors.txt"

* removed "NoSound" config parameter in favour of "MaxSounds=0"
* passthru to the NullSound driver if there is a sound driver error

* added a page number to the control panel
* added "buildiconsfirst" command to toggle the order of control panel icons (also set the control panel page number to the cmdcolors.txt build color when the build icons are being placed first)

* added build range circles for immobile builders when holding shift over them

* added the techLevel variable to UserDef, with automatic detection of the tech levels in a mod based on the information in the sidedata.tdf file
* added the "techlevels" action, to save the tech levels to techlevels.txt (as well as sending them to stdout)
* display a unit's TechLevel in the tooltip window when cheats are enabled

* key commands now work while the GUI interface is hidden, and the default command cursor icon is updated as well
* change the control panel page when a key command accesses an off-page icon
* change the tooltip to reflect the unit being built rather then the builder while selecting the build position
* added cycling for command actions when more then one is available
* added "iconpos <#>" action, for positional access to control panel icons
* added "firstmenu" action (resets the control panel to its first page)

* added "keyset" command for named keysets
* added "keysym" command for custom key symbols
* added "fakemeta" key binding command to provide another modifier

* added SmoothLines and SmoothPoints config parameters (anti-aliasing) (0 = off, 1 = fastest, 2 = don't care, 3 = nicest)

* changed GameInfo so that it always displays map name and mod name

* group AI code now permits multiple AIs per dll/so. This is handled by identifying group AIs by a new datatype, 'AIKey', rather than using just the dll name. Group AI dlls should now implement GetAiNameList to return an array of available AI names in string (const char*) form, terminated by NULL. The existing group AI interface functions GetNewAi, ReleaseAi, and IsUnitSuited now take an unsigned aiNumber as their first parameter: this is a zero-based AI index, matching the array returned by GetAiNameList.

* improved default command selection

* added "/water [0-3]" to control water rendering in-game (the optional number is the mode; without the number, it cycles through the modes)
* added "/shadows [0-1]" to control shadow rendering in-game (the optional number means off/on; without the number, it toggles)

* Fix mouse-drag-move to make units spread across the front if it's big enough, also somewhat take into account unit sizes. Added CTRL-Move, CTRL-Mouse-Drag(front) move to make units move at the speed of slowest unit.
* [bugfix] Resource expendature now shows correct pull when economy is stalling.

* - Added transparency suport from texture2 in s3o drawing, requires advanced shading.
* added DualScreenMode and DualScreenMiniMapOnLeft configuration flags. This causes the game view width to be one half of the screen width, so the minimap can take the other half. You will need to spread your spring window across the 2 screens. Specifying DualScreenMiniMapOnLeft will place the minimap on the left hand screen, rather than the right (the default)
* geothermal vents with a geothermal unit on top will not create smoke.

* Added the following Unit FBI tags: canPatrol=1; Can the unit go on patrol canGuard=1; Can the unit guard things canAttack=1; Can the unit attack other units Reclaimable=1; Determines if a unit can be reclaimed by other units noAutoFire=0; (if set to 1, unit will fire once then switch to next target, and needs to be told to fire manually) canBuild (can the unit start new construction projects) canRepair (can the unit repair other things) canRestore (can the unit restore deformed ground) canReclaim (can the unit reclaim other things) canAssist (can the unit assist construction projects already started)

* added support for teamcolored nanospray (user option). Can be forced off by modder using gamedata/particles.tdf.
* new fbi tag shownanoframe: set to 0 to disable nanoframe while the unit is being built.
* new fbi tag shownanospray: set to 0 to disable nanospray.
* new fbi tag nanocolor: color of the nanospray and the nanoframe in red green blue format (white = 1 1 1). (These three fbi tags apply to the unit itself; not to the unit it's building.)

* linux vs linux is now synced, independently of the distribution & gcc version
* if host finishes loading before client executable is started spring no longer loses connection

* added the "say" action (does work with the .give command)

* changed .clock and .info to local commands (/clock and /info now work as well)

* replaced key binding code with a more flexible solution: * can specify key for almost all commands (including unit builds) * can specify modifiers (Alt, Ctrl, Meta, Shift) * can bind the same key to more then one action (first available action is used, handy for build orders)

* added internal default bindings (see rts/Game/UI/KeyBindings.cpp)
* added "unbindall" command
* added "unbindKeyset <keyset>" command
* added "unbindAction <action>" command
* added "unbind <keyset> <action>" command
* added "bindbuildtype ..." command (aka: auto-binder)

* added "hotbind" action for the control panel icons (Ctrl+insert)
* added "hotunbind" action for the control panel icons (Ctrl+delete)

* added /keysave and /keyload commands (keysave saves to "uikeys.tmp", not "uikeys.txt")
* added /keyprint, /keydebug, /keysyms, and /keycodes commands (these commands send information to stdout)

* added ability to specify item in icon mode buttons via its binding (ex: "firestate 0" binding will set firestate to hold fire)

* added ability to specify item in combo box buttons via its binding (ex: "aiselect Radar AI" binding will assign the selected units to the Radar AI)

* pseudo mouse actions now discard key repeats

* added command queue icons
* added build command queue directional lines
* added AreaAttack command queue area display

* added game info panel (with "gameinfo" and "gameinfoclose" actions) (i)

* versionned the "archivecache.txt" filename (ex: "ArchiveCacheV4.txt")

* Quit and Share menus close when they receive ESC

* added "drawlabel" action (avoid the double-click, and key repeats)

* added "screenshot png" action

* added "chatAll" action
* added "chatSwitchAll" action
* added "chatAlly" action
* added "chatSwitchAlly" action
* added "chatSpec" action
* added "chatSwitchSpec" action

* added tracked unit rotation
* added Average and Extents tracking modes
* added "trackoff" action
* added "trackmode" action

* added "viewfps" action (Ctrl+f1)
* added "viewta" action (Ctrl+f2)
* added "viewtw" action (Ctrl+f3)
* added "viewrot" action (Ctrl+f4)

* added "firestate" action
* added "movestate" action
* added "prevmenu" action (,)
* added "nextmenu" action (.)
* added "buildunit_<name>" action
* added "deselect" action
* added "select <selection criteria>" action (redundant)

* added new water rendering mode, refracting+reflecting but without the heavy dynamic simulation.
* Added '--quit=T', '/quit T' commandline option to auto-quit spring on game over or after T seconds.
* Added '--minimise', '/minimise' commandline option to start spring minimised.
* added gradual feature reclaiming, see mantis #262
* support for rotating buildings by 90 degrees, bind to "incbuildfacing" and "decbuildfacing" (bound to ']' and '[' by default)
* modified the ground attack command for queued attack and area attack patterns (the last queued attack position is repeated for backwards compatibility)
* removed the height factor from AirCAI ground attack command drawing
* added word completion, with dot commands, player names, and unit names (does partial match reporting, and the unit names are only active for .give commands)
*> "/<tab>" will show local commands
*> ".<tab>" will show remote commands
* added console input history buffer
* added [DoubleClickTime=200] config parameter
* added [WindowEdgeMove=1], for folks who run windowed with fullscreen size (ex: good with X11/icewm to allow moving between virtual screens, and to avoid display lockups during crashes)
* disabled rendering while inactive (minimized)
* added a null sound driver [NoSound=1]
* merged global synced/unsynced "drawdebug" variables
* added vsync for GLX
* windows users can use [VSync=-1] to use system default
* allow selection of vsync rate

* [feature] A new group AI, "MexUpgrader AI" has been added. See http://springrts.com/wiki/MexUpgrader_AI for more info.
* [feature] Custom unit icons are supported. See http://springrts.com/wiki/CustomUnitIcons for more info.
* [bugfix] 'Quit and Resign' dialog now also appears when you're hosting, and stays hidden when the game is over.
* [bugfix] Commands on enemy units (attack, reclaim) get canceled automatically when the unit leaves LOS / radar.
* [change] 'Quit and Resign' dialog now only gives everything to allies (and not enemies) if they are still alive.
* [change] The LOS drawing mode is remembered when you switch back and forth to others (e.g. metalmap, heightmap).
* [change] Radar and jammer range is shown by default if you press 'L'.
* [change] Radar and jammer toggle ';' happens instantly.

* New weapon tdf tag ColorMap, used for some weapon to define the color shift during their lifetime Used in flamethrower. Tag specify either a bitmap file, ex: "colormap = mycolormap.tga;" or defines the color directly in the weapon file in rgba order where 1 is full brightnes, ex: "colormap=1 0 0 1 0 0 0 1" start with red color and shift to black at the end.

* New weapon tdf tag rgbcolor2, used to make laser weapon have different color at the center, defaults to white.
* New weapon tdf tag corethickness, how thick the inner color of a laser is, this is a percentage value, default is 0.25
* New weapon tdf tag laserflaresize, size of the flare for laser weapons, multiplier for thickness, default 15.
* New weapon tdf tag LargeBeamLaser, if set to 1 a beamlaser uses an alternate graphics effect. New tags usable for a LargeBeamLaser is: tilelength: defines the length before the texture used is repeated (tiled). scrollspeed: how fast the beam apears to be moving towards it target. pulseSpeed: how fast the pulsating effect at the beam start is.

* Texture tag added to the explosiongenerator for HeatCloud and Dirt
* New weapon FBI tags, texture1, texture2, texture3, texture4, the texture must be defined in resources.tdf in the projectile section. MissileProjectile (standar rockets and guided missiles): texture1 = flare texture2 = smoke LaserProjectile: texture1 = laserbeam texture2 = Start and end of the beam (half of the texture used at either end.) BeamLaserProjectile: texture1 = laserbeam texture2 = Start and end of the beam (half of the texture used at either end.) texture3 = muzzle flare LargeBeamLaserProjectile: texture1 = laserbeam texture2 = Start and end of the beam (half of the texture used at either end.) texture3 = Extra graphical effect at the start of the beam. texture4 = muzzle flare StarBurstProjectile (starburst weaponry, like nukes): texture1 = flare texture2 = smoke texture3 = flame EmgProjectile texture1 = texture for the projectile LightningProjectile texture1 = texture for the lightning ExplosiveProjectile (used in most plasma cannons) texture1 = texture of the projectile, will be blended multiple times.

* tdf tag duration is used for laser weapons.
* tdf tag rgbcolor is used for EmgProjectile and ExplosiveProjectile.
* tdf tag intensity is used for EmgProjectile and ExplosiveProjectile.
* New weapon tdf tag soundstartvolume and soundhitvolume.
* New weapon tdf tag size, defines the visible size of projectiles.
* New weapon tdf tag CollisionSize, defines the physical size of projectiles, percentage of size for flamethrower and absolute value emg, plasma and laser.
* New weapon tdf tag sizegrowth, defines how fast flame projectiles will grow in size.
* New weapon tdf tag flamegfxtime, this makes the flame projectile stay alive as a graphical effect (doesnt do any damage) after it has reached maxrange. Default is 1.2 which makes it stay alive 20% beyond maxrange.
* New weapon tdf tag AvoidFriendly, if set to 0 units will not try to avoid friendly units in their line of fire.
* New weapon tdf tag CollideFriendly, if set to 0 this weapon will not hit friendly units.
* New weapon tdf tag ExplosionSpeed
* edgeEffectivness added for weapons

* Added limited fuel settings for units (only work for aircrafts so far, need a good mechanism for refueling other stuff)
* New fbi tag MaxFuel, max fuel in seconds that the unit can carry, default 0 = unlimited
* New fbi tag RefuelTime, how long time it takes to fully refuel the unit, default 5
* New fbi tag MinAirBasePower, minimum build power an airbase unit must have for the aircraft to land on it, default 0
* New fbi tag WeaponFuelUsage<1-16>, how much fuel in seconds that firing the weapon takes from the owning unit, default 0
* New fbi tag SeismicDistance, give the unit a seismic sensor for detecting movement through the ground.
* New fbi tag SeismicSignature, The magnitude of seismic disturbance when this unit is moving, default sqrt(mass/100).
* New COB "get"/"set" constant: 75 MAX_SPEED get/sets the max speed of the unit (multiplied with 64k)

* New archive format (for map/mod development): *.sdd. It is a directory, but it is treated as an archive just like *.sdz and *.sd7.
* New map format SM3, currently supported for testing purposes.

=0.72b1=

* Bos/Cob script for units can now animate the death of the unit. Just have the Kill function return after a while instead of directly and return wreck level in return value instead of in function argument.
* Fixed the com dies, game ends exploit: sharing your com now kills you
* Fixed a bug causing clients not to quit when server quits
* Fixed crash bug normally resulting in dialog with "no rtti data"
* ".give" cheat command doesn't desync the game anymore
* Made "Team0() is no more" message customizable by modders (see XTA for an example).
* Added weapontag "paralyzetime", controls how long a unit can maximaly be paralyzed after being hit by this weapon, default 10
* Adds some new options in the settings program for scroll speeds
* Added new fbi tag "levelground" set this to 0 to prevent a building from leveling ground beneth it. Make sure that the model continue some way below ground so that they dont look like they float in air.
* Fixed torpedo aircrafts not being able to attack subs
* Added support for decals on ground below buildings
* New fbi tag UseBuildingGroundDecal, set to 1 to enable decals for building
* New fbi tag BuildingGroundDecalType, name of a bitmap in unittextures folder
* New fbi tag BuildingGroundDecalSizeX,BuildingGroundDecalSizeY, size of decal (same scale as footprint for unit)
* New fbi tag BuildingGroundDecalDecaySpeed, how fast the decal will fade out after the building has died, default 0.1 (fades out in 10s)
* New fbi tag ShowPlayerName, if set to 1 the tooltip shows the player name instead of the unit description
* Fbi tag HideDamage now actually works: set it to 1 to hide most details in the unit's tooltip from enemies
* New weapon tag "rgbcolor", overrides the old color1 and color2 tags if it exists, gives the color in red green blue format (1 1 1 = white).
* Removed old plasmarepulser system and replaced it with a more generalized shield system
* New weapon tdf tag IsShield, if 1 mean the weapon is a shield and now a weapon
* New weapon tdf tag shieldrepulser, 0=destroy projectile,1=repulse (bounce) projectile
* New weapon tdf tag smartshield, 1=shield doesnt affect allies weapons
* New weapon tdf tag exteriorshield, 1=shield doesnt affect weapons fired from within shield
* New weapon tdf tag visibleshield, 1=see a visible shell representing the shield
* New weapon tdf tag visibleshieldrepulse, 1=see a beam showing when shield repulses something
* New weapon tdf tag shieldenergyuse, how much energy the shield use when repulsing/destroying something
* New weapon tdf tag shieldforce, how hard shield can accelerate some sort of projectiles away
* New weapon tdf tag shieldradius, size of shield effect
* New weapon tdf tag shieldmaxspeed, maximum speed the shield can push some sort of projectiles away
* New weapon tdf tag shieldpower, how much power the shield can store, power is drained by the affected weapons damage, 0=infinite
* New weapon tdf tag shieldpowerregen, how fast the shield regenerates power
* New weapon tdf tag shieldpowerregenenergy, how much energy the shield uses when regenerating power
* New weapon tdf tag shieldintercepttype, which types of weapon the shield can affect (bitfield)
* New weapon tdf tag interceptedbyshieldtype, which types of shields can affect this weapon, if (shieldInterceptType & interceptedByShieldType) is not zero the shield can affect the weapon, default 1 for plasma, 2 for laser, 4 for missiles, 0 for other
* New weapon tdf tag shieldgoodcolor, color of shield when power is full
* New weapon tdf tag shieldbadcolor, color of shield when power is empty
* New weapon tdf tag shieldalpha, how visible the shield shell is with visibleshield=1
* Added auto zooming using scroll + Left ALT key (patch from colorblind)
* Added simplified LOS drawing (patch from colorblind)
* Fixed mouse speed problems in windows with holding shift.
* Demo filenames with spaces in them work again.
* Changed non-positional sound behavior: only selected units give non-positional sound
* Missile weapons no longer tracks to exact position of non flying units (make missile units weaker against radar targets)
* Stun damage units now receives 1/10 of normal experience and no experience for attacking already stunned units
* Units no longer receive experience for "overkill" damage
* Adds support for using arbitary team colors, teamcolor textures for 3do need to be slightly changed to accomendate this (see the base texture archive to see how its done)
* Increased max camera zoom out (zooming to far can cause slowdowns/graphical glitches)
* Added Radar group AI from colorblind: It notifies the player of incoming enemy units.
* Added custom explosion generator: It can be enabled using "explosiongenerator=custom:SomeExplosionGeneratorName" in the weapon TDF. See the wiki page http://springrts.com/wiki/CustomExplosionGenerators for more info.
* Tab will now bring zoom out to show all map in any camera mode, tab again zooms back to the mouse cursor.
* Added GetGravity(), GetUnitDefHeight() and GetUnitDefRadius() to AI interface
* Mod can now be selected in the single player menu.
* Checksums of the map and mod are checked on game start.
* Mod can be selected when starting the spring exe directly.
* Various other small changes.

=0.71b1=

* Added new water renderer
* Fixed lasers firing two projectiles at once, efficiently doing double damage.
* Fixed several exploits with FPS mode.
* Added new fbi variable CanLoopbackAttack, only affects fighter aircrafts, if 1 this will enable the player to set the aircraft to do an immelman turn after firing instead of overflying the target.
* Changed so units in maneuver mode will abort anything that moves them further than a certain distance from the patrol path
* Added statistics to the end game dialog
* Units with S3O models can explode into pieces.
* Added a " all" option to .give to give all units in loaded mod
* Fixed autoheal being about 4x to fast (or measuring heal per 0.25s depending on how one sees it)
* Improved exception handling and crashreport handling in windows.
* Added DateTime to the [VERSION] block in the demo recorder file
* Removes los from units being transported
* To disable terrain deformation: Mapmakers: Put 'NotDeformable=1' in the .smd. script.txt: Put 'DisableMapDamage=1' in with the other properties.
* VSync can be disabled with the settings application.
* Several other smaller fixes and improvements.
* Unit reply sounds are non-positional and have a seperate volume setting in the config application. Their volume is also affected by the global volume.

=0.70b3=

* Shift/ctrl do not change rotation speed in rotating camera mode anymore.
* Submarines work again.
* Fixed attack claxxon.
* Fixed units getting stuck in buildings.
* Added possibility to bind mouse1, mouse2 and mouse3 to keyboard.
* Fixed shift+letter bug.
* Fixed Pathing Map (F2 view) bug.

=0.70b2=

* Fixed some (debug) message colors.
* Fixed keyboard layout problems.
* Fixed repeat orders/high trajectory etc not indicating their current state correctly
* Fixed problem with reading hpi archives
* Added custom SDL.dll (1.2.9) with refresh rate patch from SDL CVS, should help with the 60hz issue
* Fixed right shift/ctrl while scrolling.
* Fixed shift/ctrl while middle click drag scrolling.
* Fixed map loading by less strict tdf parser.
* Don't crash on parse errors, but show an error message instead.

=0.70b1=

* First use of crossplatform code! This required a lot of bugfixing and changes, which are not mentioned here. Among these changes are switches to using boost, SDL, freetype, instead of Win32 SDK + DirectX. For a full list of changes, see the subversion log.

* XTA Pimped Edition Version 3, a version of XTA with high detail models, is used as the default mod now.
* Binding for mouse button 4/5 added (defaults to Z and X), so you can set build spacing.
* You can enable advanced unit rendering without enabling shadow mapping (in the settings app).
* Various resource files are now read from gamedata/resources.tdf instead of hardcoded into the game exe.
* Added "dontland" unit tag, to specify aircraft that should not land. Don't use this on transport units!
* std::sort related bug fixed in projectile handler
* Fixed flipped features, they are now rendered exactly the same as units.
* A few new COB "get" constants: 70 MAX_ID returns maximum number of units - 1 71 MY_ID returns ID of current unit 72 UNIT_TEAM returns team of unit given with parameter 73 UNIT_BUILD_PERCENT_LEFT basically BUILD_PERCENT_LEFT, but comes with a unit parameter 74 UNIT_ALLIED is unit given with parameter allied to the unit of the current COB script. 1=allied, 0=not allied
* Fixed login packets being sent every frame instead of once a second when trying to connect
* Fixed ghosted buildings option.
* Fixed isairbase=1 unit tag.

=0.67b3=

*AI dll's can be used with startscripts again

=0.67b2=

*Fixed black map bug
*Impulsefactor now affects ground damage

*- Lobby changes

* battle hosts can now use /ring <username> command on players participating in their battles
* fixed problem with notification dialog switching focus back to application
* added /rename command which will rename your account (so that people who wish to add clan tags in front of their names don't have to reregister and lose their ranks). Player names may now also contain "[" and "]" characters.
* fixed small bug in demo script parser
* added /mute, /unmute and /mutelist commands for admins/mods
* clients behind same NAT now get local IPs instead of external one (from the server). Note that some issues still exist with currently implemented nat traversal method, so players hosting battles are advised to forward their port nonetheless.

=0.67b1=

*Catching AI exceptions can be disabled with the settings app.
*Fixed access-violation bug when creating sky.
*Fixed numerous division by zero bugs.
*Fixed default cursor for indestructible features.
*Beamlaser uses thickness value.
*COB support for Getting/Setting veteran level and unit speed. The returned veteran level is unit experience multiplied by 100 Unit speed can be set to something nonzero only when the current speed is nonzero, it can always be set to zero.
*Overhead camera can be tilted with control key + mousewheel now.
*Debug message verbose level can now be set with the settings application. (Modified update by Alantai) This will only affect AI console messages.
*Ghosted buildings can now be disabled by the lobby. They are enabled by default.

=0.66b1=

*Fixed transport units being able to load themself.
*Fixed gunship like aircraft always having the same altitude
*Fixed torpedo aircrafts now being able to attack underwater targets
*Support for upright, flammable and indestructible feature tags
*Fixed division-by-zero bug in bomb-dropper.
*Fixed access-violation bug in pathfinder.

*Added new s3o unit format

*Added new tags to .fbi file autoHeal - health per second that a unit allways will be autohealed for (default 0) idleAutoHeal - health per second that a unit will be autohealed for whenever its idling (default 10) idleTime - time in ticks without any action before a unit is considered idling (default 600)
*Added new tags to weaponfile file NoSelfDamage - Units take no splash damage from its own weapon impulsefactor - Explosion impulse will be multiplied by this

*Added read access to the virtual filesystem for the AI
*Further AI interface updates will now be backwards compatible (old AI's will not break on a new spring release)
*Added user input functions from Alik to the AI interface
*The global AI will now be notified if a unit changes team.
*UnitDestroyed/EnemyDestroyed get the attacker unit id if any (by submarine)

=0.65b2=

*Fixed crash with factories closing at the moment they die

*Fixed sync error on water maps
*Increased max players/teams to 32/16

*Added support for selecting which globalai-dll to use when starting spring.exe directly
*Added support for having more than one lua startscript. Put them in subfolder "startscripts".

*Added UnitMoveFailed to global AI interface. Called when ground units fail to move to their destination.

=0.65b1=

*Fixed crash bug involving radars on non square maps
*Fixed crash bug involving gunships landing on repairpads that get destroyed
*Fixed crash bug involving large units exploding

*Fixed resurrected building not having a footprint
*Increased time to reclaim wreckages
*Fixed acceleration for units not being correctly set from fbi file
*Fixed slope of map not getting updated properly for craters
*Fixed sonar jamming
*Can now switch viewed team when spectating using keys 1-9
*Added faster reload speed for experienced units
*Added support for multiplayer replays where several players can watch a reply at once
*Added option for minimap to show colors only based on owned(green),ally(blue),enemy(red)

*Added new FBI tag TransportMass, this is the maximum weight a tranporter can transport, default 100000
*Added new FBI tag Mass, this is the weight of the unit, default is metalcost of unit
*Added new FBI tags to set the control variables for aircrafts
*Added new FBI tag OnlyTargetCategory<weaponnum>, sort of like badtargetcategory but the weapon can only target units with these categories,toairweapon in weaponfile is the same as OnlyTargetCategory=VTOL; default is all categories
*Added bindings for creating startscripts in lua. See testscript.lua for an example. Note that you can only have one script (must be called testscript.lua), and that it is possible that the interface will change.

*Fixed bugs in the AI interface GetMetal* and GetEnergy* functions, they returned the values of the human player.
*Moved shared functions in the GroupAI callback and GlobalAI callback to a new AICallback interface. For AI developers: This means a small adjustment of your current code will be required to get it compiled again.

=0.64b1=

*Solved troublesome crash bug involving several pointers to a single object
*Fixed crash when calls such as get PIECE_XZ were used in the Create function of a unit

*SetSfxOccupy now updates correctly when unit is being transported
*Added support for aircrafts auto landing to repair when health gets low
*Removed autorepair while unit is flying
*When a unit has finished firing a burst the script function EndBurst<weaponnum> will now be called, use this instead of Fire<weaponnum> to switch pod/barrel etc to fire from to lessen friendly fire incidents
*Removed warning message when using transports

*New map smd tag map/voidwater, creates a void where there would normally be water, this is a purely graphical effect,default 0
*New command .give, .give <num> <unitname> gives you num units of type unitname, requires cheats to be on, only use in singleplayer
*Added support for aircrafts auto landing to repair when health gets low
*Added command .kick <playername> that server can use to kick out players from game
*Updated global AI interface with GetNumUnitDefs() and GetUnitDefList()

=0.63b2=
*Fixed crash when using new formation move commands
*Script interpreter now warns about incorrect piecenames in scripts instead of crashing

=0.63b1=

*Fixed multi delete error in LosHandler
*Fixed crash with features defined in mapfile

*Fixed problem with having more than one map in the same archive
*Pathmap display (F2) can now also show where selected building can be built (slow though, esp with large maps and buildings)
*Spring now remember the last a: etc prefix used in chat msgs
*Resurrecting a unit now cost half the energy of building it
*Changed so spring can keep several different path precalcs on disk for a single map, this will save recalculations for ppl switching mods a lot

*Added CMD_WAIT command to have units wait for a transport. Can be issued with the W key, can also be used to que up stuff and then releasing the unit to do it.
*Added tag "LIGHT\\SpecularSunColor" to smd file, modifies the color of the specular highlights on units, defaults to LIGHT\\UnitSunColor
*Added tag "isAirBase" to unit FBI file, sets if the units that are being transported will be stunned or not, defaults to 0.
*Spring can now use up to 16 weapons, use Weapon<1-16> and BadTargetCategory<1-16> in fbi file and QueryWeapon<1-16> AimWeapon<1-16> AimFromWeapon<1-16> FireWeapon<1-16> functions in scripts. Primary,secondary etc is aliased to weapon 1-3 but try not to mix old and new names in the same unit.
*Added new fbi tag WeaponSlaveTo<x>=y, this will force the weapon x to use the same target as weapon y (y must be a lower numbered weapon than x). Might be usefull for say a mech like unit with many different weapons that should target in the same direction.
*Added new fbi tags WeaponMainDir<1-16> and MaxAngleDif<1-16>. WeaponMainDir is a vector and defines the center direction of a cone in which the weapon can aim while MaxAngleDif defines how broad the cone is. Default WeaponMainDir = 0 0 1; (forward) and MaxAngleDif=360; (can fire everywhere)
*Added support for loading TA:K COB files and implemented the TA:K-specific opcode play-sound.
*Added some simple formation handling to the standard groups, hold alt on move to make them form an aproximate square and drag mouse to make them form up behind a front
*Added missile tdf tag wobble, this is in the same as turnrate except that it will turn in random directions instead of toward the target,default 0
*Added missile tdf tag trajectoryHeight, this sets in how high an arc the missile will move toward the target,0 = straight, 1=45 degree above, can be anything>=0, default 0
*New start file tag LimitDgun, if 1 it restricts dgunning to a radius around your startpos, size depending on mapsize, default 0
*New start file tags AllyTeam<x>/StartRect<Top.Bottom,Left,Right>, allows host to define where different allyteams might start on the map, given in the range 0-1 and scaled with map size

=0.62b1=

*Fixed crash when units exploded

*Mines no longer block terrain and can be overun (and if you are crazy built on top of :) ), removed ability for mines to hold fire since they would be completly undetectable.
*Heightmap view (F1) now updates correctly when terrain changes
*Pathcost view (F2) now works in non cheating mode but will then only show terrain modifiers
*Fixed gunships being able to fly below ground when comming in on step slopes
*Auto sharing now starts at 99% instead of 100% at startup meaning that there is less chance of the team losing resources because someone forgets to set it

*Installer associates .sdf files with spring.exe
*Spring.exe now accepts a demo filename on the commandline and starts playing it directly
*Added tag "MAP\\DetailTex" to smd file to specifiy map specific detail texture, default is bitmap\detailtex2.bmp, map specific textures should be placed in maps directory.
*Added possibility for surface of units to be shiny/reflective by using the alpha channel of the textures
*Addded command .take, will take the units from all teams allied with you that is missing a player (due to disconnect etc) and transfer them to your team

=0.61b2=

*Added tag "WATER\\WaterTexture" to smd file to specify another texture for the map than the default ocean.jpg (mapspecific water textures should be in the maps directory)
*Added tag "WATER\\WaterSurfaceColor" to smd file, changes the surface color of the water when using reflective water (default is 0.75 0.8 0.85 ).
*Fixed error msg while loading certain jpeg files
*Fixed spawn.txt not being readable from archives
*Fixed problem with reading large files from sd7 archives (such as skyboxes)

0.61b1 --------------------------------------

*Fixed crash in weapon aiming
*Fixed some other crashes
*Fixes some memory errors

*Fixed aircrafts landing outside map
*Fixed infinitly rotating starburst missiles
*Fixed different tracks getting superimposed on each other
*Plasma cannons should now detect mountains in the fire path better
*The generated path information for maps is now stored zipped in the subdirectory "paths"

*Added scar marks on map to explosions
*Can now control spacing when rowbuilding using the forward/back buttons (xButtons) on mouse
*Spring now attempts to find bmp or jpg files in bitmaps\loadpictures to use as background while loading
*Some messages now show their location on the minimap
*Moved spawn.txt into xta archive by default to allow replacements by other mods, and replaced it with "Storm Easy AI v1.0"
*New weapon tdf value, TargetMoveError, makes the weapon worse at hitting moving targets, default 0
*New weapon tdf value, MovingAccuracy, replaces the normal accuracy value while the unit is moving, defaults to normal accuracy of weapon
*New weapon tdf value, thickness, controls the thickensess of lasers, default 2
*New weapon tdf value, intensity, controls the alpha value of lasers, default 0.9
*New smd terraintype value, receivetracks, if this is 0 there wont be any tracks from units on this terrain type, default 1

=0.60b1=
*Added tag SmoothAnim=0/1 to the fbi. If it is 1, unis will use animation interpolation
*Added MAP\\WATER\\WaterPlaneColor tag to maps to set the color of the waterplane beneath the ground
*Added MAP\\ATMOSPHERE\\SkyBox tag to maps to use a dds cubemap as a sky instead of the cloud rendering
*Added an optional BuildPic tag to the units so they can use other than pcx buildpics
*Fixed crash when unit closed in on their destination

*Slopes are now calculated differently
*Random start order should now be more random
*Fixed commiting delayed animations before using getunitval
*Radar now jams everyones radar including your own. We will see how this turns out.
*New map format, adds ability to read texture from external (shared) files and a new terrain type overlay map
*Made ballistic weapons range somewhat more dependent on relative height of weapon and target
*Paralyzer tag for weapons now work
*CanCapture tag for units now works
*HighTrajectory now requires a HighTrajectory tag in the unit file (0=only low, 1=only high,2=choose)
*Ground under DT/FW get same kind of protection as under buildings, we will see how it works out
*"Slow" explosions, stuff far away from big explosions will have their damage delayed a bit

*Added globalai interface and changed groupai interface a bit
*Added resurrection capability
*Added support for regular zip archives. Using extension "sdz" to avoid confusion.
*Added support for 7zip archives. (http://www.7-zip.org/). Using extension "sd7" to avoid confusion. Note that it is probably not a good idea to use solid archives since Spring does not access the files sequentially.
*Added beamlaser type weapon
*Added possibility of units leaving tracks on map
*Added some new options to the game start file
*Added new camera mode rotatable overhead camera
*Added Flare capability to units to decoy incoming missiles

*Added boot option for battleroom host
*Hopefully fixed unit sync and some other bugs in battleroom

=0.51b1=
*Fixed a cob animation related crash
*Fixed crash using "simple formation ai"

*Fixed auto resource sharing, could share to enemies or not at all before
*Floating features now works
*Con air now stay within radius of build object better
*Spectators can no longer select start pos
*Yet more pathfinding/movement fixes
*Fixed timeout when host calculating paths
*New ingame command for host .nopause , prevents player from pausing game. Also harder to spam log with changespeed msgs now.
*Changed targeting calculations, now switch from badtargetcategory targets faster and never switch to them from other sort of targets even if those go out of los/radar
*Changed so several units cant reclaim a feature at once
*Flakker like units can now target fast units better

=0.50b2=

*Changed default DamageModifier to be 1 instead of 0
*Fixed so units no longer can dip slightly into lava and explode
*Adds a random enemies script for those that really want to test in single player. The enemies are read from spawn.txt (frame/enemyname pairs) and spawns at startpos 1-3 randomly

=0.50b1=

*Added support for set/get of unit variable ACTIVATION (allowing solars to close under attack for example)
*Added call to cob function SetMaxReloadTime for better ta unit compatibility
*Added stack boundary checking to cob interpreter
*Fixed buffer overrun problems in the sunparser
*Fixed threads contending over single global netbuf (hopefully no more netmsg errors)
*Now connects from the same udp port as connecting to (semi random before)

*Units can no longer move over infinite sloops
*Improved the pathfinder/movesystem
*Contruction units can no longer repair themselves
*Repair/Build/Reclaim now turn of cloak
*Unit paths are now only visible when cheats are enabled in debug mode
*F2 now shows the map from a pathfinding perspective if cheats are enabled
*Fixed grass not being drawn
*Previously visible buildings now stays on the map in a ghost state

*Added support for larger maps
*Added some more range circles
*Added keyboard bindings for mousewheel (pageup/down as default)
*Added guard order to aircrafts
*New .smd command MAP/WATER/WaterDamage. Indicates the amount of damage per second units take for being in "water". Make it >1000 to prevent ground units from entering water entirely, >10000 prevents hovers from moving over water.
*New in game commands for host .setmaxspeed .setminspeed sets the maximum and minimum game speeds

=0.41b1=

*Removed log spam with Use of GetPieceDir..
*Fixed "Error looking up server from ip" errors when trying to connect
*Fixed zero size units bug
*Can no longer overflow network buffer with large build orders
*Non square maps no longer crash
*Fixed some random crash bugs
*Added more filtering to the server and clients to filter out invalid net msgs

*Host can now force start the game with ctrl+return if not everyone show up
*Fixed repeat order for factories
*Units can no longer move onto terrain they cant move off (boats on land etc)
*Units can no longer die due to getting outside map
*Changed the alignment on buildings, fixes two buildings qued beside each other ending up blocking each other
*Buildings no longer decay when builder has slow animation
*Radar/jammer units now correctly updated when changing team

*New .smd value, MAP/AutoShowMetal. Set it to 0 if you dont want players to switch to metalmap view when selecting an extractor. (because you have created visible metal deposits on the map)
*New .smd value, MAP/MapHardness. Set how hard it is to create craters in map, default 100.
*Made it slightly easier to build buildings on slopes
*Made it somewhat harder to dig deep holes

*- Lobby changes

*Added extended ascii support in chatrooms. Can now use accent characters
*Added test button to battle host menu. It will tell the server to try and conncet to you on the port you specified, letting you know if others will be able to as well.
*Now can tell which battles are in progress, and which are still open
*Fixed bug that allowed more than the max number of players into a room
*Added ability to launch a browser when links are sent in a chatroom
*Added unit syncing. Now if users have different units, the differences are disabled
*Fixed a bug that allowed invalid log in names to be submitted

=0.40b2=

First public release[[category:Development]]

Chili-Classes

2013-09-11T06:47:21Z

Kingraptor: Created page with "Development < Chili < {{FULLPAGENAME}} {{stub}} Chili classes are the elements (panels, grids, etc.) that make up the game GUI. The .lua .lua files are st..."

[[Gamedev:Main|Development]] < [[Chili]] < {{FULLPAGENAME}}
{{stub}}
Chili classes are the elements (panels, grids, etc.) that make up the game GUI. The .lua .lua files are stored in the directory <code>LuaUI/Widgets/Chili/controls</code>. Displayed elements such as window, as distinct from non-control classes (specifically, font objects and the screen) are referred to as '''controls'''.

==Source==
The default Chili classes can be found [https://github.com/jk3064/chiliui/tree/master/chili/controls here].

==Data Types==
Tags may be one of the following data types:
* <code>number</code> - A number with or without decimals.
* <code>bool</code> - A value which can be <code>true</code> or <code>false</code>.
* <code>string</code> - Text, or more precisely a string of alphanumeric characters.
* <code>color</code> - An array of colors, in RGBA format.
* <code>number[4]</code> - An array of numbers; used for positioning, etc.
==Details==
Chili classes use OOP with inheritance, with the following hierarchy:
object
|_font
|_screen
|_control
|_button
|_image
|_checkbox
|_colorbars
|_label
|_layoutpanel
|_imagelistview
|_grid
|_stackpanel
|_treeview
|_panel
|_progressbar
|_scrollpanel
|_textbox
|_trackbar
|_treeview
|_treeviewnode
|_window

Consequently, it is possible for widgets to define their own Chili classes (discussed below).

Each Chili control has one parent (<code>Chili.screen0</code> or another Chili control) and any non-negative number of children. Position is specified relative to the parent, taking into account the parent's <code>padding</code> and <code>itemMargin</code> tags.

==Classes==
===Object===
The base Chili object class. It should ''not'' be used directly.

{{tag
|name = classname
|type = string
|default = "object"
|description = The class name.}}

{{tag
|name = hidden
|type = bool
|default = false
|description = Is the object hidden?}}

{{tag
|name = disableChildrenHitTest
|type = bool
|default = false
|description = If true, this object's children are not clickable, draggable, etc. - their mouse events are not processed.}}

===Control===
This is the base class for all Chili controls, specifying common properties. It should ''not'' be used directly.

'''General tags'''
{{tag
|name = tooltip
|type = string
|default = nil
|description = The control's tooltip.}}

{{tag
|name = skinName
|type = string
|default = nil
|description = Specifies the control to use a skin other than the default one.}}

'''Size tags'''
{{tag
|name = width
|type = number OR string
|description = The width of the control. This can be a number of pixels, or a percentage value enclosed in a string, e.g. "50%" means half as wide as the parent.}}

{{tag
|name = height
|type = number OR string
|description = The height of the control. This can be a number of pixels, or a percentage value enclosed in a string, e.g. "50%" means half as wide as the parent.}}

{{tag
|name = minWidth
|type = number
|default = 10 (50 for windows)
|description = The control's minimum width.}}

{{tag
|name = minHeight
|type = number
|default = 10 (50 for windows)
|description = The control's minimum height.}}

{{tag
|name = maxWidth
|type = number
|default = 1e9
|description = The control's maximum width.}}

{{tag
|name = maxHeight
|type = number
|default = 1e9
|description = The control's maximum height.}}

{{tag
|name = autosize
|type = bool
|default = false
|description = Does the control automatically resize to fit its children?}}

{{tag
|name = savespace
|type = bool
|default = false
|description = If <code>autosize</code> is enabled, it shrinks the control to the minimum needed space; if disabled <code>autosize</code> ''normally'' only enlarges the control.}}

{{tag
|name = fixedratio
|type = bool
|default = false
|description = Does this control attempt to maintain its original aspect ratio when resized?}}

{{tag
|name = resizable
|type = bool
|default = false
|description = Can this control be resized outside of tweakmode?}}

{{tag
|name = tweakResizable
|type = bool
|default = true
|description = Can this control be resized in tweakmode?}}

'''Positioning tags''' 
These tags can be combined in different ways with each other and the width/height tags to precisely define the bounds of the element.
{{tag
|name = x
|type = number
|description = The distance between the left edge of the control and that of its parent.}}

{{tag
|name = y
|type = number
|description = The distance between the top edge of the control and that of its parent.}}

{{tag
|name = right
|type = number
|description = The distance between the right edge of the control and that of its parent.}}

{{tag
|name = bottom
|type = number
|description = The distance between the bottom edge of the control and that of its parent.}}

{{tag
|name = draggable
|type = bool
|default = false
|description = Can this control be dragged around outside of tweakmode?}}

{{tag
|name = tweakDraggable
|type = bool
|default = true
|description = Can this control be dragged around in tweakmode?}}

'''Drawing tags'''
{{tag
|name = padding
|type = number[4]
|default = {5, 5, 5, 5}
|description = How much space there is between the borders of the control and its children. Numbers are for left, top, right and bottom.}}

{{tag
|name = backgroundColor
|type = color
|default = {0.8, 0.8, 1.0, 0.4} (can be overridden by skin)
|description = This is the background color of certain controls, particularly Windows.}}

===Window===
This is the basic container for all other controls. It is the only one that can be moved around by the user and responds to the docking widget. It can be made invisible for a borderless element, or to allow another control such as a Panel to draw the background.

===Panel===
A background element, similar to Window but drawn differently and without the resize/drag functions.

===Button===
Does things when clicked. Comes with its own implementation of <code>HitTest</code>, <code>MouseDown</code> and <code>MouseUp</code>, making it readily usable for this purpose.

{{tag
|name = caption
|type = string
|default = "button"
|description = A caption written on the button.}}

Template:Stub

2013-09-11T05:53:26Z

Kingraptor: Created page with ":''This article is a stub. You can help the Spring project by expanding it.''"

:''This article is a stub. You can help the Spring project by expanding it.''

Gamedev:WeaponDefs

2013-09-11T05:47:21Z

Kingraptor: Add link back to gamedev page

[[Gamedev:Main|Development]] < [[Gamedev:Main]] < {{FULLPAGENAME}}

==Location==
WeaponDef files are .lua files stored in the <code>Weapons/</code> directory of a Spring Game. Alternatively they can be integrated into [[Units-UnitDefs|UnitDefs]].

==Purpose==
WeaponDef files have one purpose; to define the properties of weapons. They are the main description file for what attributes your weapon should have and how it should behave.

==Source==
The engine source code which loads the tags from these files is viewable here:

* {{sourcelink|file=rts/Sim/Weapons/WeaponDef.cpp}}

==Data Types==
Tags may be one of the following data types:
* <code>int</code> - An integer number
* <code>float</code> - A number with decimals.
* <code>bool</code> - A value which can be <code>true</code> or <code>false</code>.
* <code>string</code> - Text, or more precisely a string of alphanumeric characters.
* <code>float[3]</code> - A vector, with three <code>float</code> components, representing x, y and z axes (y is 'up').

==Details==
There follows a comprehensive (certain deprecated tags are not present) list of the tags available, their data type, default value and a brief description of what they do. Bear in mind that the source code linked above is the ultimate reference when dealing with these tags.

In lua tables keys (i.e. the tags) should be lower case, here they are represented in camelCase for readability. In your files you may use the <code>lowerkeys</code> function on your final table to ensure the keys are properly cased.

It is usual to name the returned WeaponDef table the internal <code>weaponName</code> desired for the weapon.

===Common===
The following tags are common to all or at least a majority of '''WeaponTypes''', depending on the tag.

====General====
{{tag
|name = weaponType
|type = string
|default = "Cannon"
|description = Spring has 14 '''WeaponTypes''' which provide game developers with basic behaviours which they can customise to an extent with the '''WeaponDef''' tags. Some tags are specific to certain '''WeaponTypes''' and not implemented for others, [https://docs.google.com/spreadsheet/ccc?key=0Am5BbZxm93S9dEZXc1Q4dXR4TFRYTFM4NlR4OFJFdWc#gid=0 this two-way table] indicates which tags work for which types.}} The possible values are:
* [[#AircraftBomb|AircraftBomb]]
* [[#BeamLaser|BeamLaser]]
* [[#Cannon|Cannon]]
* [[#DGun|Dgun]]
* [[#EmgCannon|EmgCannon]]
* [[#Flame|Flame]]
* [[#LaserCannon|LaserCannon]]
* [[#LightningCannon|LightningCanon]]
* [[#Melee|Melee]]
* [[#MissileLauncher|MissileLauncher]]
* [[#Rifle|Rifle]]
* [[#Shield (WeaponType)|Shield]]
* [[#StarburstLauncher|StarburstLauncher]]
* [[#TorpedoLauncher|TorpedoLauncher]]

{{tag
|name = name
|type = string
|default = "Weapon"
|description = The descriptive name of the weapon as listed in FPS mode.}}

{{tag
|name = turret
|type = bool
|default = false
|description = Does the unit aim within an arc (up-to and including full 360Â° turret traverse) or always aim along the owner's heading?}}

{{tag
|name = noSelfDamage
|type = bool
|default = false
|description = Can the weapon's explosion damage the unit which fires it? Useful for preventing bombers with high-yield weapons destroying themselves.}}

{{tag
|name = impactOnly
|type = bool
|default = false
|description = Does the weapon only deal damage through direct hits and not 'splash' damage through {{taglink|areaOfEffect}}?}}

{{tag
|name = noExplode
|type = bool
|default = false
|description = Does the weapon explode on impact with a target or continue through? Note that these weapons will do damage every single frame they are inside the [[Unit_collision_volumes|collision volume]] of an object, underground or under water, massively multiplying their damage.}}

{{tag
|name = burnblow
|type = bool
|default = false
|description = Does the weapon explode when it reaches its maximum range or continue on its path? The name is an [[OTAism]].}}

{{tag
|name = range
|type = float
|default = 10.0
|description = The maximum range in [[elmo]]s that the weapon can fire at.}}

{{tag
|name = weaponVelocity
|type = float
|default = 0.0
|description = The velocity in [[elmo]]s per second of the weapon projectile.}}

{{tag
|name = reloadTime
|type = float
|default = 1.0
|description = The time in seconds between shots fired.}}

{{tag
|name = metalPerShot
|type = float
|default = 0.0
|description = 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 {{taglink|stockpile}} weapon will cost to build.}}

{{tag
|name = energyPerShot
|type = float
|default = 0.0
|description = Energy used per shot. If the specified amount is not available, the weapon cannot be fired. Can also be used to specify how much a {{taglink|stockpile}} weapon will cost to build.}}

{{tag
|name = myGravity
|type = float
|default = 0.0
|description = Overrides the map gravity for ballistic weapons. The default of <code>0.0</code> disables the tag in favour of map gravity.}}

{{tag
|name = fireStarter
|type = float
|default = 0.0
|description = The percentage chance (<code>0.0</code> to <code>100.0</code>) of the weapon setting fire to static map features on impact.}}

{{tag
|name = cameraShake
|type = float
|default = damage (0.0 for paralyzers)
|description = Passed to the [[LuaCallinReturn#Game_Events:|ShockFront() callin]] as the first argument. Intended as a means to make the camera shake if in range of detonation.}}

{{tag
|name = stockpile
|type = bool
|default = false
|description = Does each round of the weapon have to be built and stockpiled by the player? Will only correctly function for the first of each stockpiled weapons a unit has.}}

{{tag
|name = stockpileTime
|type = float
|default = reloadTime
|description = The time in seconds taken to stockpile one round of the weapon.}}

{{tag
|name = interceptedByShieldType
|type = int
|default = 0 (See description)
|description = [http://en.wikipedia.org/wiki/Mask_(computing) Bitmask] representing the types of shields that can intercept this weapon. Each digit of binary that is set to one means that a shield with the corresponding digit in its {{taglink|interceptType}} will intercept this weapon. The defaults are as follows:
* <code>1</code> - [[#Cannon]] and [[#EmgCannon]]
* <code>2</code> - [[#LaserCannon]] and [[#BeamLaser]]
* <code>4</code> - [[#MissileLauncher]] and [[#StarburstLauncher]]
* <code>8</code> - [[#AircraftBomb]]
* <code>16</code> - [[#Flame]]
* <code>32</code> - [[#TorpedoLauncher]]
* <code>64</code> - [[#LightningCannon]]
* <code>128</code> - [[#Rifle]]
* <code>256</code> - [[#Melee]]
(See [[Shield Interception Tag Use]]).}}

====Collision & Avoidance====

{{tag
|name = avoidGround
|type = bool
|default = true
|description = Should the weapon avoid firing if terrain blocks the line of fire?}}

{{tag
|name = avoidFriendly
|type = bool
|default = true
|description = Should the weapon avoid firing if a friendly unit is in the line of fire?}}

{{tag
|name = avoidFeature
|type = bool
|default = true
|description = Should the weapon avoid firing if a static map feature is in the line of fire?}}

{{tag
|name = avoidNeutral
|type = bool
|default = false
|description = Should the weapon avoid firing if a neutral unit is in the line of fire?}}

{{tag
|name = collideEnemy
|type = bool
|default = true
|description = Does the weapon projectile collide with enemy units or pass through?}}

{{tag
|name = collideFriendly
|type = bool
|default = true
|description = Does the weapon projectile collide with friendly units or pass through?}}

{{tag
|name = collideFeature
|type = bool
|default = true
|description = Does the weapon projectile collide with static map features or pass through?}}

{{tag
|name = collideNeutral
|type = bool
|default = true
|description = Does the weapon projectile collide with neutral units or pass through?}}

{{tag
|name = collideGround
|type = bool
|default = true
|description = Does the weapon projectile collide with terrain or pass through?}}

{{tag
|name = collisionSize
|type = float
|default = 0.05 (0.5 for [[#Flame]] and [[#LaserCannon]], 10.0 for [[#Dgun]])
|description = The radius used in collision calculations. For non-instant-hit weapons which do not use a 3D {{taglink|model}}.}}

====Targeting & Accuracy====
{{tag
|name = commandFire
|type = bool
|default = false
|description = Determines if the weapon will automatically fire on enemy units in range or only when manually ordered to attack.}}

{{tag
|name = canAttackGround
|type = bool
|default = true
|description = Determines if the weapon can be force-fired on ground positions or only fire on targeted units.}}

{{tag
|name = waterWeapon
|type = bool
|default = false
|description = Determines if the weapon can pass through water and target underwater units.}}

{{tag
|name = fireSubmersed
|type = bool
|default = waterWeapon
|description = Determines if the weapon can fire whilst underwater.}}

{{tag
|name = targetBorder
|type = float
|default = 0.0 (1.0 for [[#Melee]])
|description = Controls whether the weapon aims for the centre or the edge of its target's [[Unit_collision_volumes|collision volume]]. Clamped between <code>-1.0</code> - target the far border, and <code>1.0</code> - target the near border.}}

{{tag
|name = cylinderTargeting
|type = float
|default = 0.0 (1.0 for [[#Melee]])
|description = Controls whether the weapon range is calculated in a sphere or a cylinder. The height of the cylinder is determined by the value of this tag multiplied by the {{taglink|range}}. Clamped between <code>0.0</code> and <code>128.0</code>.}}

{{tag
|name = tolerance
|type = float
|default = 3000.0
|description = 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. For {{taglink|turret|false}} or {{taglink|fixedlauncher|true}} weapons this determines in what arc the unit will fire.}}

{{tag
|name = targetMoveError
|type = float
|default = 0.0
|description = 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.}}

{{tag
|name = leadLimit
|type = float
|default = -1.0
|description = Limits the maximum distance a unit will lead a target. The default of <code>-1</code> allows an infinite distance.}}

{{tag
|name = leadBonus
|type = float
|default = 0.0
|description = Controls how experience boosts the weapon's target leading. Is multiplied with the unit's experience and added to the {{taglink|leadLimit}}.}}

{{tag
|name = predictBoost
|type = float
|default = 0.0 (0.5 for {{taglink|burnblow|true}} weapons)
|description = Controls how well the weapon predicts unit speeds. Works in a similar way to {{taglink|targetMoveError}} except that it is 1-dimensional. This tag spreads the shots in a line based on the direction of the target whereas {{taglink|targetMoveError}} spreads the shots all around based on the movement.}}

{{tag
|name = heightMod
|type = float
|default = 0.2 (0.8 for [[#Cannon]], 1.0 for [[#BeamLaser]] and [[#LightningCannon]])
|description = Changes the spherical weapon range into an ellipsoid. Values above <code>1.0</code> mean the weapon cannot target as high as it can far, values below <code>1.0</code> mean it can target higher than it can far. For example <code>0.5</code> would allow the weapon to target twice as high as far.}}

{{tag
|name = proximityPriority
|type = float
|default = 1.0
|description = Acts as a multiplier for the distance to the target in the priority calculation. Note that negative values make weapons prefer distant targets.}}

{{tag
|name = accuracy
|type = float
|default = 0.0
|description = How accurate the weapon is. Lower values are more accurate. Accuracy is relative to the distance to the target; for instance, if the target is very close, even a very high value will probably still hit. If a target is very far away, even a very low value will likely cause the weapon to miss.}}

{{tag
|name = movingAccuracy
|type = float
|default = accuracy
|description = A weapon's {{taglink|accuracy}} whilst the owning unit is moving.}}

{{tag
|name = sprayAngle
|type = float
|default = 0.0
|description = How wide the the angle of a burst from a [[#Bursts|burst weapon]] can be. Very similar to {{taglink|accuracy}}, except that this tag affects each projectile in a burst, whilst the former does not.}}

{{tag
|name = ownerExpAccWeight
|type = float
|default = 0.0 (See description)
|description = A multiplier to {{taglink|accuracy}} and {{taglink|sprayAngle}} that reduces inaccuracy as a units experience increases. Defaults are as follows:
* <code>0.9</code> - [[#Cannon]], [[#Rifle]]
* <code>0.7</code> - [[#LaserCannon]], [[#BeamLaser]], [[#StarburstLauncher]]
* <code>0.5</code> - [[#MissileLauncher]], [[#LightningCannon]], [[#EmgCannon]], [[#DGun]]
* <code>0.2</code> - [[#Flame]]
}}

{{tag
|name = targetable
|type = int
|default = 0
|special = {{new|92.0}} Previously only for [[#StarburstLauncher]]
|description = [http://en.wikipedia.org/wiki/Mask_(computing) Bitmask] representing the types of weapon that can intercept this weapon. Each digit of binary that is set to one means that a weapon with the corresponding digit in its {{taglink|interceptor}} tag will intercept this weapon. Instant-hitting weapons such as [[#BeamLaser]], [[#LightningCannon]] and [[#Rifle]] cannot be targeted.
}}

{{tag
|name = interceptor
|type = int
|default = 0
|special = {{new|92.0}} Previously only for [[#StarburstLauncher]]
|description = [http://en.wikipedia.org/wiki/Mask_(computing) Bitmask] representing the types of weapons that this weapon can intercept. Each digit of binary that is set to one means that a weapon with the corresponding digit in its {{taglink|targetable}} tag will be intercepted by this weapon.
}}

{{tag
|name = interceptSolo
|type = bool
|default = true
|special = {{new|92.0}}
|description = If <code>true</code> no other interceptors may target the same projectile.
}}

{{tag
|name = coverage
|type = float
|default = 0.0
|special = {{new|92.0}} Previously only for [[#StarburstLauncher]]
|description = The radius in [[elmo]]s within which an {{taglink|interceptor}} weapon will fire on {{taglink|targetable}} weapons.
}}

====Bouncing====

{{tag
|name = waterBounce
|type = bool
|default = false
|description = Does the weapon bounce on water impacts?}}

{{tag
|name = groundBounce
|type = bool
|default = false
|description = Does the weapon bounce on ground impacts?}}

{{tag
|name = bounceSlip
|type = float
|default = 1.0
|description = The decimal-percentage amount of horizontal velocity a projectile keeps when it bounces.}}

{{tag
|name = bounceRebound
|type = float
|default = 1.0
|description = The decimal-percentage amount of vertical velocity a projectile keeps when it bounces.}}

{{tag
|name = numBounce
|type = int
|default = -1
|description = The number of times the weapon will bounce on impact before exploding. The default value of <code>-1</code> allows infinite bounces (at least until velocity reaches 0).}}

====Area Of Effect, Impulse & Cratering====

{{tag
|name = areaOfEffect
|type = float
|default = 8.0 * 0.5
|description = The ''diameter'' in [[elmo]]s in which the weapons explosion will cause damage.}}

{{tag
|name = craterAreaOfEffect
|type = float
|default = areaOfEffect * 0.5
|description = The ''radius'' in [[elmo]]s in which the weapons explosion will cause terrain cratering.}}

{{tag
|name = edgeEffectiveness
|type = float
|default = 0.0
|description = Determines what percent of a weapon's maximum damage value will be applied to units within the weapon's {{taglink|areaOfEffect}}. Falls off from the epicentre according to the formula <code>damageApplied = damage * [(areaOfEffect - distToUnit) / (areaOfEffect - (distToUnit * edgeEffectiveness))]</code>, a graph of the function for various values is available [[Media:EdgeEffectiveness.png|here]].}}

{{tag
|name = explosionSpeed
|type = float
|default = See description
|description = The speed at which the weapon's explosion propagates from the epicentre. The default is calculated by this complex formula: <code>defExpSpeed = {8.0 + [max(30.0, default_damage / 20.0) * 2.5]} / {9.0f + [sqrt(max(30.0, default_damage / 20.0f)) * 0.7]} * 0.5</code>.}}

{{tag
|name = impulseFactor
|type = float
|default = 1.0
|description = A multiplier to the impulse given to units within the explosion {{taglink|areaOfEffect}}, which is otherwise equal to the damage dealt after {{taglink|edgeEffectiveness}} is taken into account. For [[#Melee]] weapons this is instead multiplied by the owning unit's mass (See [[Units-UnitDefs#Tag:mass|Units-UnitDefs]]).}}

{{tag
|name = impulseBoost
|type = float
|default = 0.0
|description = A constant amount added to the weapon's impulse, regardless of distance from the epicentre or the damage potential of the explosion, prior to the application of {{taglink|impulseFactor}}}}

{{tag
|name = craterMult
|type = float
|default = impulseFactor
|description = A multiplier to depth of terrain crater the weapon's explosion will create, which is otherwise based on the damage potential.}}

{{tag
|name = craterBoost
|type = float
|default = 0.0
|description = A constant amount, added to the weapon's cratering depth before the application of {{taglink|craterMult}}.}}

====Bursts====

{{tag
|name = burst
|type = int
|default = 1
|description = How many shots to fire per burst.
}}

{{tag
|name = burstRate
|type = float
|default = 0.1
|description = The time in seconds between shots in a burst. Note that {{taglink|reloadTime}} starts to count down from the ''first'' round fired, not the last so if <code>reloadTime < burst * burstRate</code> the weapon will fire continuously.
}}

{{tag
|name = projectiles
|type = int
|default = 1
|description = How many projectiles released per shot (shotgun style). e.g. a weapon with {{taglink|burst|5}}, {{taglink|burstRate|0.5}} and {{taglink|projectiles|2}} will shoot 5 lots of 2 for 10 projectiles total, with gaps of 0.5 seconds, before waiting for {{taglink|reloadTime}}. Best used in conjunction with {{taglink|sprayAngle}} or changing the firing piece using [[Animation-LuaCallins#Weapons|ShotX]] as otherwise they'll all be clumped in one shot.
}}

====Paralyzing====
{{tag
|name = paralyzer
|type = bool
|default = false
|description = Is the weapon a paralyzer? If <code>true</code> the weapon only stuns enemy units and does not cause damage in the form of lost hit-points.
}}

{{tag
|name = paralyzeTime
|type = int
|default = 10
|description = Determines the maximum length of time in seconds that the target will be paralyzed. The timer is restarted every time the target is hit by the weapon. Cannot be less than <code>0</code>.
}}

====Dynamic Damage====
The following set of tags allow for a weapon's damage potential to vary with the distance to its target.

{{tag
|name = dynDamageExp
|type = float
|default = 0.0
|description = Exponent of the range-dependent damage formula, the default of <code>0.0</code> disables dynamic damage, <code>1.0</code> means linear scaling, <code>2.0</code> quadratic and so on.
}}

{{tag
|name = dynDamageMin
|type = float
|default = 0.0
|description = The minimum floor value that range-dependent damage can drop to.
}}

{{tag
|name = dynDamageRange
|type = float
|default = 0.0
|description = If set to non-zero values the weapon will use this value in the range-dependant damage formula instead of the actual {{taglink|range}}.
}}

{{tag
|name = dynDamageInverted
|type = bool
|default = false
|description = If <code>true</code> the damage curve is inverted i.e. the weapon does more damage at greater ranges as opposed to less.
}}

====Sounds====
{{tag
|name = soundTrigger
|type = bool
|default = false (true for [[#Melee]], [[#Rifle]] and non-beamBurst [[#BeamLaser]])
|description = Does the weapon play {{taglink|soundStart}} for every round in a burst or only once for each salvo?}}

{{tag
|name = soundStart
|type = string
|default = ""
|description = The name of a '''SoundItem''' (See [[Sounds.lua]]) or filename of a sound to play when the weapon fires.}}

{{tag
|name = soundHitDry
|type = string
|default = ""
|description = The name of a '''SoundItem''' (See [[Sounds.lua]]) or filename of a sound to play when the weapon collides with solid ground. Note that a [[#BeamLaser]] will play this sound every frame of its lifetime.}}

{{tag
|name = soundHitWet
|type = string
|default = ""
|description = The name of a '''SoundItem''' (See [[Sounds.lua]]) or filename of a sound to play when the weapon collides with water. Note that a [[#BeamLaser]] will play this sound every frame of its lifetime.}}

====Visuals====

{{tag
|name = cegTag
|type = string
|default = ""
|description = The name, without prefixes, of a [[CEG]] to be emitted by the projectile each frame.
}}

{{tag
|name = intensity
|type = float
|default = 0.9 (0.2 for [[#Cannon]])
|description = Alpha transparency for non-3D model projectiles. Lower values are more opaque, but <code>0.0</code> will cause the projectile to disappear entirely.
}}

{{tag
|name = model
|type = string
|default = ""
|description = The filename of a 3D model to use when rendering the projectile. Note that only the root piece of a projectile model is rendered. Currently only for [[#Cannon]], [[#LaserCannon]], [[#MissileLauncher]], [[#StarburstLauncher]] and [[#TorpedoLauncher]].
}}

{{tag
|name = explosionScar
|type = bool
|default = false
|description = Does the weapon's explosion leave a scar decal on the ground? For all types except [[#Melee]] and [[#Rifle]].
}}

{{tag
|name = alwaysVisible
|type = bool
|default = false
|description = If <code>true</code> the weapon is always rendered regardless of whether or not it is in LOS range of a player's units.
}}

{{tag
|name = rgbColor
|type = float[3]
|default = {1.0, 0.0, 0.0} (See Description)
|description = The primary colour for sprite rendering weapons. Additional defaults are as follows:
* [[#Cannon]] - <code>{1.0, 0.5, 0.0}</code>
* [[#EmgCannon]] - <code>{0.9, 0.9, 0.2}</code>
}}

{{tag
|name = explosionGenerator
|type = string
|default = ""
|description = The name of a [[CEG]], with <code>custom:</code> prefix, to spawn as the weapon's explosion. Does not currently work for [[#Melee]] and [[#Rifle]].
}}

{{tag
|name = bounceExplosionGenerator
|type = string
|default = ""
|description = For weapons which can use {{taglink|groundBounce|true}}, the name of a [[CEG]], with <code>custom:</code> prefix, to spawn when weapon the bounces.
}}

{{tag
|name = texture1
|type = string
|default = ""
|description = The projectile texture for [[#AircraftBomb]], [[#Cannon]], [[#EmgCannon]], [[#Flame]]; beam texture for [[#LaserCannon]], [[#BeamLaser]], [[#LightningCannon]]; flare texture for [[#MissileLauncher]], [[#StarburstLauncher]] and dome texture for the [[#Shield]].
}}

{{tag
|name = texture2
|type = string
|default = ""
|description = The end-of-beam texture for [[#LaserCannon]], [[#BeamLaser]] and {{taglink|smoketrail}} texture for [[#MissileLauncher]], [[#StarburstLauncher]].
}}

{{tag
|name = texture3
|type = string
|default = ""
|description = Flare texture for [[#BeamLaser]], or muzzle texture if {{taglink|largeBeamLaser|true}}. Also used as the flame texture for [[#StarburstLauncher]].
}}

{{tag
|name = texture4
|type = string
|default = ""
|description = Flare texture for [[#BeamLaser]] with {{taglink|largeBeamLaser|true}}.
}}

===AircraftBomb===
Drops a ballistic projectile at the same movement vector as the unit itself. Intended only for aircraft. Visually drawn as a billboarded sprite as used by the [[#Cannon]], but more commonly used with a 3D model.

There are no tags specific to this '''WeaponType'''

====AircraftBomb Visuals====

When not using a {{taglink|model}}, the AircraftBomb is the same as [[#Cannon Visuals]].

===BeamLaser===
An instant-hit weapon which spawns a beam and does a portion of its total damage each frame. Cannot be [[Animation-LuaCallouts#Effects|script emitted]] if it has a {{taglink|beamTime}} longer than one frame. Visually drawn as a [http://en.wikipedia.org/wiki/Star_Trek Star Trek] Phaser-style laser weapon. The {{taglink|largeBeamLaser}} tag allows changing the visual effect of the laser, such as using a tileable, scrolling texture without changing the behaviour.

{{tag
|name = minIntensity
|type = float
|default = 0.0
|description = The minimum percentage the weapon's damage can fall-off to over its range. Setting to <code>1.0</code> will disable fall off entirely. Unrelated to the visual-only {{taglink|intensity}} tag.
}}

{{tag
|name = beamTime
|type = float
|default = 1.0
|description = How long in seconds to fire the laser before waiting for {{taglink|reloadTime}} to start. Damage is distributed over the duration of the {{taglink|beamTime}}, and the weapon will aim to hit the target when the beam is in the middle of its {{taglink|beamTime}} (i.e. using prediction).
}}

{{tag
|name = beamBurst
|type = bool
|default = false
|description = Makes the laser fire a burst of beams that are all aimed towards the target (instead of aimed with the piece). A [[#BeamLaser]] can do its full damage with every shot if {{taglink|beamBurst}} is enabled. Disables {{taglink|beamTime}} in favour of the [[#Bursts|burst tags]].
}}

{{tag
|name = sweepFire
|type = bool
|default = false
|description = Makes the laser continue firing while it aims for a new target, 'sweeping' across the terrain. Somewhat unreliable.
}}

====BeamLaser Visuals====

See also {{taglink|thickness}} and {{taglink|coreThickness}}.

{{tag
|name = beamTTL
|type = int
|default = 0
|description = The time in frames for which the laser beam remains visible.
}}

{{tag
|name = beamDecay
|type = float
|default = 1.0
|description = How fast the beam fades out. Each frame the {{taglink|intensity}} is multiplied by this value.
}}

{{tag
|name = laserFlareSize
|type = float
|default = 15.0
|description = Determines the size of the firing flare.
}}

{{tag
|name = largeBeamLaser
|type = bool
|default = false
|description = Changes the visual effect allowing tiling and scrolling of the texture and a pulsating firing flare.
}}

{{tag
|name = tileLength
|type = float
|default = 200.0
|description = Defines the length before the texture used is repeated (tiled). Only if {{taglink|largeBeamLaser|true}}.
}}

{{tag
|name = scrollSpeed
|type = float
|default = 5.0
|description = Controls how fast the texture scrolls. Only if {{taglink|largeBeamLaser|true}}.
}}

{{tag
|name = pulseSpeed
|type = float
|default = 1.0
|description = Controls how fast the pulsating effect at the start of the beam is. Only if {{taglink|largeBeamLaser|true}}.
}}

===Cannon===
The default '''WeaponType'''. Fires a ballistic projectile, for the best result (without under/overshooting) the {{taglink|weaponVelocity}} should be set so as to give an elevation of 45Â° when firing at the maximum {{taglink|range}}. Substituting the angle into the [http://en.wikipedia.org/wiki/Trajectory#Range_and_height trajectory equation] and rearranging, we get:
<code><pre>weaponVelocity = âˆš(range * g)</pre></code>
where <code>g</code> is the map gravity, usually around <code>120</code> for most Spring maps (You can use the {{taglink|myGravity}} tag if you want to be exact). Visually drawn as a billboarded sprite or 3D model.

{{tag
|name = highTrajectory
|type = int
|default = 2
|description = Can this weapon be fired in a high trajectory (>45Â° angle). Can be <code>0</code> - low trajectory only, <code>1</code> - high trajectory only or <code>2</code> - enables a high/low toggle button on the unit.
}}

{{tag
|name = heightBoostFactor
|type = float
|default = -1.0
|description = Controls the boost given to {{taglink|range}} by high terrain. Values > <code>1.0</code> result in increased range, <code>0.0</code> means the cannon has fixed range regardless of height difference to target. Any value < <code>0.0</code> (i.e. the default value) result in an automatically calculated value based on {{taglink|range}} and theoretical maximum range.
}}

====Cannon Visuals====

{{tag
|name = size
|type = float
|default = 2.0 + min(default_damage * 0.0025, {{taglink|areaOfEffect}} * 0.1)
|description = The drawing radius of the billboarded sprite. Also for [[#AircraftBomb Visuals]], [[#EmgCannon Visuals]] (default: <code>3.0</code>) and [[#Flame Visuals]].
}}

{{tag
|name = colorMap
|type = string
|default = ""
|description = A set of RGB colours to transition between over the projectile's lifetime. Can be given as a string of RGB digits or an image filename (See [[CColorMap]]). Also for [[#Flame Visuals]].
}}

{{tag
|name = sizeDecay
|type = float
|default = 0.0
|description = How quickly each particle of the Cannon shot decays in size.
}}

{{tag
|name = alphaDecay
|type = float
|default = 1.0
|description = How quickly each particle of the Cannon shot fades out.
}}

{{tag
|name = separation
|type = float
|default = 0.0
|description = The distance between each particle of the Cannon shot.
}}

{{tag
|name = noGap
|type = bool
|default = true
|description = Switch between the distance between particles being proportional to the size of the two particles (<code>true</code>) or proportional to the size of the first particle (<code>false</code>).
}}

{{tag
|name = stages
|type = int
|default = 5
|description = The number of particles in each Cannon shot.
}}

===DGun===
Fires a line-of-sight or ballistic projectile (selected via the {{taglink|gravityAffected}} tag). Visually represented by a fireball effect that cannot be customised, however it can be replaced by a 3D model. The name and visual effect are [[OTAism]]s.

{{tag
|name = gravityAffected
|type = bool
|default = false
|description = Does the fireball projectile lose height due to map gravity?
}}

===EmgCannon===
A line-of-sight weapon. Visually drawn as a billboarded sprite very similar to that of the [[#Cannon]], however not as customisable, or a 3D model. The name is another [[OTAism]].

There are no tags specific to this '''WeaponType'''.

===Flame===
A line-of-sight weapon intended for use as a flamethrower or similar. Visually drawn as a stream of textured particles, the colour of which can be controlled very precisely using the {{taglink|colorMap}} tag (see [[CColorMap]]).

====Flame Visuals====
See also {{taglink|colorMap}}.

{{tag
|name = sizeGrowth
|type = float
|default = 0.5
|description = How much the draw radius of the flame projectile increases each frame.
}}

{{tag
|name = flameGFXTime
|type = float
|default = 1.2
|description = Makes the flamethrower projectile stay alive as a visual-only effect (i.e. does not deal any damage) after it has reached maximum {{taglink|range}}. It is a percentage multiplier, e.g. <code>1.2</code> makes the projectile stay alive until it reaches 20% beyond {{taglink|range}}.
}}

===LaserCannon===
A particularly versatile line-of-sight weapon. Visually drawn like a [http://en.wikipedia.org/wiki/Star_Wars Star Wars] Blaster-style laser weapon, or a 3D model.

====LaserCannon Visuals====

{{tag
|name = duration
|type = float
|default = 0.05
|description = Multiplied against {{taglink|weaponVelocity}} to determine the visual length of the beam projectile.
}}

{{tag
|name = hardStop
|type = bool
|default = false
|description = Does the laser projectile stop dead or fade out?
}}

{{tag
|name = fallOffRate
|type = float
|default = 0.5
|description = Rate at which the beam fades out after it goes past its maximum {{taglink|range}} if {{taglink|hardStop|false}}. A value of <code>0.0</code> is never fade out, <code>1.0</code> is finish fading out exactly at maximum {{taglink|range}}.
}}

{{tag
|name = lodDistance
|type = int
|default = 1000
|description = Minimum camera distance at which the default LaserCannon projectile is simplified to a single rectangle.
}}

{{tag
|name = thickness
|type = float
|default = 2.0
|description = The thickness (width) of the LaserCannon projectile. Also for [[#BeamLaser Visuals]].
}}

{{tag
|name = coreThickness
|type = float
|default = 2.0
|description = The thickness (width) of the LaserCannon projectile's core. Also for [[#BeamLaser Visuals]].
}}

{{tag
|name = rgbColor2
|type = float
|default = {1.0, 1.0, 1.0}
|description = The colour of the LaserCannon projectile's core. Also for [[#BeamLaser Visuals]].
}}

===LightningCannon===
An instant-hit weapon similar to the [[#BeamLaser]], but which does all its damage at once. Visually drawn like [http://en.wikipedia.org/wiki/Star_Wars Star Wars] 'Force Lightning' or [http://en.wikipedia.org/wiki/Command_%26_Conquer:_Red_Alert CnC: Red Alert] [http://en.wikipedia.org/wiki/Tesla_coil Tesla Coil] weapons, the effect is not very customisable.

There are no tags specific to this '''WeaponType'''.

===Melee===
A weapon that always damages the target, no ifs or buts; unsurprisingly intended for use as a close quarters [http://en.wikipedia.org/wiki/Melee#Use_in_gaming 'melee'] weapon. It does not fire a projectile and does not care about the line of fire.

There are no tags specific to this '''WeaponType'''.

===MissileLauncher===
A versatile weapon which can optionally track targets and accelerate from a low initial velocity. It can also use {{taglink|trajectoryHeight}} to have the shot arc similar to a ballistic projectile. Visually represented by a 3D model, with an optional {{taglink|smokeTrail}}.

{{tag
|name = startVelocity
|type = float
|default = 0.0
|description = The initial velocity of the weapon projectile. Also for [[#StarburstLauncher]] and [[#TorpedoLauncher]].
}}

{{tag
|name = acceleration
|type = float
|default = 0.0
|description = The initial acceleration of the weapon projectile. Also for [[#StarburstLauncher]] and [[#TorpedoLauncher]]. Note that if it is <code>0.0</code> the weapon can never increase from its {{taglink|startVelocity}} and will not reach its maximum {{taglink|weaponVelocity}}.
}}

{{tag
|name = tracks
|type = bool
|default = false
|description = Can the weapon projectile track a moving target? Also for [[#StarburstLauncher]] and [[#TorpedoLauncher]].}}

{{tag
|name = turnRate
|type = float
|default = 0.0
|description = The rate (in [[Elmo#Angular|cau]]) at which {{taglink|tracks|true}} weapons turn towards their target. This is relative to a projectile's current velocity; a weapon with a higher velocity will need a higher value in order to be able to hit targets that turn suddenly.}}

{{tag
|name = flightTime
|type = float
|default = 0.0
|description = The time in seconds before a missile projectile's fuel runs out; it ceases to obey {{taglink|tracks}}, loses velocity and falls to the ground. Also for [[#StarburstLauncher]]. Large values may cause over/undershoot problems.
}}

{{tag
|name = fixedLauncher
|type = bool
|default = false
|description = Makes the projectile spawn with the orientation of the shooting piece instead of their normal orientation. Also for [[#StarburstLauncher]] and [[#TorpedoLauncher]]. Weapons may not correctly obey [[#Collision & Avoidance|avoidance settings]] when using this tag.
}}

{{tag
|name = wobble
|type = float
|default = 0.0
|description = Adds a random vector to the direction of travel every 16 frames, multiplied by the value of the tag. The effect is reduced as the firing unit gains experience. As this missiles direction is changed, wobbling swarm of missiles will diverge.
}}

{{tag
|name = dance
|type = float
|default = 0.0
|description = Adds a random vector to the position of a missile projectile every 8 frames, multiplied by the value of the tag. As the projectile is not rotated, a dancing swarm of missiles will remain relatively coherent.
}}

{{tag
|name = trajectoryHeight
|type = float
|default = 0.0
|description = Determines the height of the arc the missile will reach as it moves towards its target. A value of <code>0.0</code> will result in a flat trajectory, <code>1.0</code> will launch at 45°. Can be any value >= <code>0.0</code>; extreme values may require the {{taglink|tracks}} tag to be able to hit a target.
}}

====MissileLauncher Visuals====
A note about the missile exhaust flare: the size of the flare is determined by the model radius. The emit position of the flare is at (0,0,-radius) so the model may need careful adjustment to get the flare looking right.

{{tag
|name = smokeTrail
|type = bool
|default = false
|description = Does the missile projectile emit a smoke trail as it travels? Also for [[#StarburstLauncher]].
}}

===Rifle===
An instant hit weapon which does all its damage at once. Visually represented by a hardcoded tracer, firing and hitting effects. Rarely used.

There are no tags specific to this '''WeaponType'''.

===Shield (WeaponType)===
As the name suggests, not a weapon but a defensive shield. Can absorb or deflect ({{taglink|repulsor|true}}) projectiles. Individual weapons can be set to be intercepted or not by the shield using a [http://en.wikipedia.org/wiki/Mask_(computing) bitmask] (see [[Shield Interception Tag Use]]). Visually represented as a translucent sphere, with control over colour and texture; by default the shield is invisible ({{taglink|visible|false}}).

See the [[#shield]] sub-table section for other tags specific to this type.

===StarburstLauncher===
Fires a projectile that rises vertically for {{taglink|weaponTimer}} seconds, then turns towards its target. It can optionally track targets and accelerate from a low initial velocity. This is the only weapon that can be {{taglink|targetable}} and act as an {{taglink|interceptor}}. Visually represented by a 3D model, with an optional {{taglink|smokeTrail}}.

{{tag
|name = weaponTimer
|type = float
|default = 0.0
|description = The time in seconds during which the missile ascends vertically before turning towards its target.
}}

===TorpedoLauncher===
Fires a projectile that will behave ballistically out of water and like a missile in water. Usually used with {{taglink|waterWeapon|true}} so they can fire underwater and target underwater units. An aircraft carrying a [[#TorpedoLauncher]] is a special case, the weapon turns into an [[#AircraftBomb]] projectile that will spawn a torpedo projectile on impact with water. Visually represented by a pointed black cuboid, usually the default object is replaced by a 3D model.

{{tag
|name = subMissile
|type = bool
|default = false
|description = Can the torpedo leave the water and target units and positions on land?
}}

===NoWeapon===
Not actually a '''WeaponType''', but an individual weapon requested by Spring to 'fill in the gaps' if a unit claims to have a weapon which isn't actually defined. There needs to be only one of these weapons and it is created by setting {{taglink|weaponName|"NOWEAPON"}} rather than by the {{taglink|weaponType}} tag.

==Sub Tables==

===damage===
The damage subtable lists how many hit points the weapon depletes against each armor class (See [[Armordefs.lua]]). It is a key-value map of armor class names and damage values. The special <code>default</code> entry is as the name suggests the default damage applied to any unit which does not belong to a listed armor class, or to shields.

For example a weapon which deals 100 damage by default but only 50 to units in the 'tank' armor class:

<code><pre>damage = {
default = 100,
tank = 50,
}</pre></code>

===shield===
The preferred way to create a shield or repulsor is to use the shield subtable rather than the old shield tags.

The following tags are repulsor specific:

{{tag
|name = repulsor
|type = bool
|default = false
|description = Does the shield [http://dictionary.reference.com/browse/repulse?s=t repulse] (deflect) projectiles or absorb them?}}

{{tag
|name = force
|type = float
|default = 0.0
|description = The force applied by the repulsor to the weapon - higher values will deflect weapons away at higher velocities.}}

{{tag
|name = maxSpeed
|type = float
|default = 0.0
|description = The maximum speed the repulsor will impart to deflected projectiles.}}

{{tag
|name = visibleRepulse
|type = bool
|default = false
|description = Is the (hard-coded) repulse effect rendered or not?}}

The following tags are general behaviour for all shields:

{{tag
|name = interceptType
|type = int
|default = 0
|description = [http://en.wikipedia.org/wiki/Mask_(computing) Bitmask] representing the types of weapons that this shield can intercept. Each digit of binary that is set to one means that a weapon with the corresponding digit in its {{taglink|interceptedByShieldType}} will be intercepted by this shield (See [[Shield Interception Tag Use]]).}}

{{tag
|name = smart
|type = bool
|default = false
|description = Determines whether or not projectiles fired by allied units can pass through the shield (<code>true</code>) or are intercepted as enemy weapons are (<code>false</code>).}}

{{tag
|name = exterior
|type = bool
|default = false
|description = Determines whether or not projectiles fired within the shield's radius can pass through the shield (<code>true</code>) or are intercepted (<code>false</code>).}}

{{tag
|name = energyUse
|type = float
|default = 0.0
|description = The amount of the energy resource consumed by the shield to absorb or repulse weapons, continually drained by a repulsor as long as the projectile is in range.}}

{{tag
|name = radius
|type = float
|default = 0.0
|description = The radius of the circular area the shield covers.}}

{{tag
|name = power
|type = float
|default = 0.0
|description = Essentially the maximum allowed hit-points of the shield - reduced by the <code>damage</code> of a weapon upon impact.}}

{{tag
|name = startingPower
|type = float
|default = 0.0
|description = How many hit-points the shield starts with - otherwise the shield must regenerate from <code>0</code> until it reaches maximum {{taglink|power}}.}}

{{tag
|name = powerRegen
|type = float
|default = 0.0
|description = How many hit-points the shield regenerates each second.}}

{{tag
|name = powerRegenEnergy
|type = float
|default = 0.0
|description = How much energy resource is consumed to regenerate each hit-point.}}

{{tag
|name = rechargeDelay
|type = float
|default = 0.0
|description = The delay in seconds before a shield begins to regenerate after it is hit.}}

The following tags control the visual aspects of the shield:

{{tag
|name = visible
|type = bool
|default = false
|description = Is the shield visible or not?}}

{{tag
|name = visibleHitFrames
|type = int
|default = 0
|description = The number of frames a shield becomes visible for when hit.}}

{{tag
|name = badColor
|type = float[3]
|default = {1.0, 0.5, 0.5} (Red)
|description = The RGB colour the shield transitions to as its hit-points are reduced towards <code>0</code>.}}

{{tag
|name = goodColor
|type = float[3]
|default = {0.5, 0.5, 1.0} (Blue)
|description = The RGB colour the shield transitions to as its hit-points are regenerated towards its maximum {{taglink|power}}.}}

{{tag
|name = alpha
|type = float
|default = 0.2
|description = The alpha transparency of the shield whilst it is visible.}}

===customParams===
The <code>customParams</code> subtable of a WeaponDef allows the game designer to give their weapons custom attributes, which can then be accessed via lua gadgets and widgets. It is a map (key-value pair indexed table) of strings. When accessing these attributes in lua the strings can be turned back into numbers, bools or even tables. This gives great control to game designers to essentially implement their own behaviour tags.

There are no additional tags specific to this subtable

==Examples==
[http://imolarpg.dyndns.org/trac/balatest/browser/trunk/weapons 'Balanced Annihilation' WeaponDefs]

[http://code.google.com/p/conflictterra/source/browse/#svn%2Fgames%2FCT%2Fweapons 'Conflict Terra' WeaponDefs] (Most are integrated into their [[Units-UnitDefs#Examples|UnitDefs]])

[https://code.google.com/p/evolutionrts/source/browse/#svn%2Ftrunk%2Fevolutiondev.sdd%2FWeapons 'Evolution RTS' WeaponDefs] (Most are integrated into their [[Units-UnitDefs#Examples|UnitDefs]])

[http://spring1944.svn.sourceforge.net/viewvc/spring1944/trunk/S44Main.sdd/weapons/ 'Spring: 1944' WeaponDefs] (Implements an [http://en.wikipedia.org/wiki/Object-oriented_programming OOP] paradigm with [http://en.wikipedia.org/wiki/Inheritance_(computer_science) inheritance])

[http://code.google.com/p/springtutorialgame/source/browse/#svn%2Ftrunk%2FSpringTutorialGame.sdd%2FWeapons 'Spring Tutorial Game' WeaponDefs]

[[Category: Units]]

Gamedev:UnitDefs

2013-09-11T05:46:51Z

Kingraptor: Add link back to gamedev page

[[Gamedev:Main|Development]] < [[Gamedev:Main]] < {{FULLPAGENAME}}

==Location==
UnitDef files are .lua files stored in the <code>Units/</code> directory of a Spring Game.

==Purpose==
UnitDef files have one purpose; to define the properties of units. They are the main description file for what attributes your unit should have and how it should behave.

==Source==
The engine source code which loads the tags from these files is viewable here:

* {{sourcelink|file=rts/Sim/Units/UnitDef.cpp}}

The engine source which reads the [[#sounds]] subtable can be found here:

* {{sourcelink|file=rts/Sim/Units/UnitDefHandler.cpp}}

==Data Types==
Tags may be one of the following data types:
* <code>int</code> - An integer number
* <code>float</code> - A number with decimals.
* <code>bool</code> - A value which can be <code>true</code> or <code>false</code>.
* <code>string</code> - Text, or more precisely a string of alphanumeric characters.
* <code>float[3]</code> - A vector, with three <code>float</code> components, representing x, y and z axes (y is 'up').

==Details==
There follows a comprehensive (certain deprecated tags are not present) list of the tags available, their data type, default value and a brief description of what they do. Bear in mind that the source code linked above is the ultimate reference when dealing with these tags.

In lua tables keys (i.e. the tags) should be lower case, here they are represented in camelCase for readability. In your files you may use the <code>lowerkeys</code> function on your final table to ensure the keys are properly cased.

It is usual to name the returned UnitDef table the internal <code>unitName</code> desired for the unit.

===General===
{{tag
|name = name
|type = string
|default = ""
|special = lua: humanName
|description = This is simply the name of the unit as it appears to the player.}}

{{tag
|name = description
|type = string
|default = name
|special = lua: tooltip
|description = This is the tooltip description of the unit seen by the player. It defaults to the {{taglink|name}} of the unit.}}

{{tag
|name = buildPic
|type = string
|default = ""
|special = lua: buildPicName
|description = The filename of the image to be used as the build picture, assumes <code>Unitpics/</code> directory (see [[Units:Buildpics]]).}}

{{tag
|name = objectName
|type = string
|default = ""
|special = lua: modelName
|description = The filename of the 3D model file for this unit, assumes <code>Objects3D/</code> directory.}}

{{tag
|name = script
|type = string
|default = unitName + ".cob"
|special = lua: scriptName
|description = The filename of the animation script file for this unit, assumes <code>Scripts/</code> directory. Default assumes .cob file but [[Animation-LuaScripting | LUS]] should be preferred.}}

{{tag
|name = maxDamage
|type = float
|default = 0.0
|special = lua: health
|description = The base 'hitpoints' the unit will have.}}

{{tag
|name = autoHeal
|type = float
|default = 0.0
|description = How much health the unit will regain every second.}}

{{tag
|name = idleAutoHeal
|type = float
|default = 10.0
|description = How much health the unit will regain every second whilst it is idle.}}

{{tag
|name = idleTime
|type = int
|default = 600
|description = The time in [[frames]] taken until a unit is considered to be idle.}}

{{tag
|name = buildCostMetal
|type = float
|default = 1.0
|special = lua: metalCost
|description = The amount of metal resource the unit costs to build. Cannot be below <code>1.0</code>.}}

{{tag
|name = buildCostEnergy
|type = float
|default = 0.0
|special = lua: energyCost
|description = The amount of energy resource the unit costs to build.}}

{{tag
|name = buildTime
|type = float
|default = 0.0
|description = The time taken to build the unit, in conjunction with the {{taglink|workerTime}} of the constructor. Effectively, <code>Time to build = buildTime / workerTime</code>. Defaults to <code>0.0</code> but cannot actually be below <code>1.0</code>.}}

{{tag
|name = mass
|type = float
|default = buildCostMetal
|description = The mass of the unit, used in weapon impulse calculations. Cannot be less than <code>1.0</code>.}}

{{tag
|name = reclaimable
|type = bool
|default = true
|description = Can the unit be reclaimed by a builder?}}

{{tag
|name = capturable
|type = bool
|default = true
|description = Can a unit be stolen by a builder using the capture command?}}

{{tag
|name = repairable
|type = bool
|default = true
|description = Can the unit be repaired by a builder?}}

{{tag
|name = maxRepairSpeed
|type = float
|default = 1e20
|description = The maximum cumulative speed at which this unit can be repaired.}}

{{tag
|name = iconType
|type = string
|default = "default"
|description = The name of the radar icon type this unit should use (see [[Icontypes.lua]]).}}

{{tag
|name = corpse
|type = string
|default = ""
|description = The name of the feature this unit should leave behind as a wreck when it dies (see [[Units-FeatureDefs]]).}}

{{tag
|name = explodeAs
|type = string
|default = ""
|description = The name of the weapon this unit should explode as when it is killed (see [[Units-WeaponDefs]]).}}

{{tag
|name = selfDestructAs
|type = string
|default = ""
|description = The name of the weapon this unit should explode as when it self destructs (see [[Units-WeaponDefs]]). Also used as the {{taglink|kamikaze}} weapon.}}

===Resources===
{{tag
|name = metalStorage
|type = float
|default = 0.0
|description = The amount of the metal resource storage the unit contributes.}}

{{tag
|name = energyStorage
|type = float
|default = 0.0
|description = The amount of the energy resource storage the unit contributes.}}

{{tag
|name = extractsMetal
|type = float
|default = 0.0
|description = The amount of the metal resource the unit extracts from the ground. The amount extracted depends on the metal map defined in the map itself. Works only for structures.}}

{{tag
|name = windGenerator
|type = float
|default = 0.0
|description = The amount of the energy resource the unit generates which is dependant on the map wind. Works only for structures.}}

{{tag
|name = tidalGenerator
|type = float
|default = 0.0
|description = The amount of the energy resource the unit generates which is dependant on the maps tidal power. Clearly, this only works on water structures.}}

{{tag
|name = metalUse
|type = float
|default = 0.0
|special = lua: metalUpkeep
|description = The amount of the metal resource the unit consumes per game 'tick'.}}

{{tag
|name = energyUse
|type = float
|default = 0.0
|special = lua: energyUpkeep
|description = The amount of the energy resource the unit consumes per game 'tick'.}}

{{tag
|name = metalMake
|type = float
|default = 0.0
|description = The amount of the metal resource the unit generates unconditionally per game 'tick'.}}

{{tag
|name = energyMake
|type = float
|default = 0.0
|description = The amount of the energy resource the unit generates unconditionally per game 'tick'.}}

{{tag
|name = makesMetal
|type = float
|default = 0.0
|description = The amount of the energy resource the unit turns into the metal resource per game 'tick'.}}

===Sensors===
{{tag
|name = onoffable
|type = bool
|default = false
|description = Does the unit have an on/off button? Currently the activation status tied to this button also turns sensors (other than LOS) on and off.}}

{{tag
|name = activateWhenBuilt
|type = bool
|default = false
|description = Should the unit's activation status be on or off when it is created?}}

{{tag
|name = sightDistance
|type = float
|default = 0.0
|special = lua: losRadius
|description = The radius of the units sight (LOS is circular in Spring)}}

{{tag
|name = airSightDistance
|type = float
|default = 1.5 * sightDistance
|special = lua: airLosRadius
|description = How far away the unit can see aircraft (and some FX).}}

{{tag
|name = losEmitHeight
|type = float
|default = 20.0
|special= lua: losHeight {{new|83.0}}
|description = How high up the unit is the point used to calculate it's LOS vs. the terrain?}}

{{tag
|name = radarEmitHeight
|type = float
|default = 20.0
|special= lua: radarHeight{{new|83.0}}
|description = How high up the unit is the point used to calculate it's radar vs. the terrain?}}

{{tag
|name = radarDistance
|type = int
|default = 0
|special = lua: radarRadius
|description = The radius of the units radar.}}

{{tag
|name = sonarDistance
|type = int
|default = 0
|special = lua: sonarRadius
|description = The radius of the units sonar.}}

{{tag
|name = radarDistanceJam
|type = int
|default = 0
|special = lua: jammerRadius
|description = The radius of the units radar jamming.}}

{{tag
|name = sonarDistance
|type = int
|default = 0
|special = lua: sonarJamRadius
|description = The radius of the units sonar jamming.}}

{{tag
|name = stealth
|type = bool
|default = false
|description = Is the unit undetectable by radar?}}

{{tag
|name = sonarStealth
|type = bool
|default = false
|description = Is the unit undetectable by sonar?}}

{{tag
|name = seismicDistance
|type = int
|default = 0
|special = lua: seismicRadius
|description = The radius of the unit's seismic (movement) sensor.}}

{{tag
|name = seismicSignature
|type = float
|default = 0 for units with {{taglink|floater}}, {{taglink|canHover}} or {{taglink|canFly}}, otherwise sqrt(mass / 100.0)
|description = How fast the seismic ring expands in [[elmo]]s per frame. Each ping always lasts 15 [[frames]], so this also determines the maximum radius of the seismic ring.}}

====Cloaking====
For units with {{taglink|canCloak|true}}:
{{tag
|name = cloakCost
|type = float
|default = 0.0
|description = The energy cost per tick to cloak the unit while it is stationary.}}

{{tag
|name = cloakCostMoving
|type = float
|default = cloakCost
|description = The energy cost per tick to cloak the unit while it is moving.}}

{{tag
|name = initCloaked
|type = bool
|default = false
|special = lua: startCloaked
|description = Is the unit cloaked as soon as it is created?}}

{{tag
|name = minCloakDistance
|type = float
|default = 0.0
|description = The minimum distance (radius) which the unit must be from any enemy units to remain cloaked.}}

{{tag
|name = decloakSpherical
|type = bool
|default = true
|description = Does {{taglink|minCloakDistance}} apply in 3D or only 2D? i.e. can aircraft flying above the unit decloak it?}}

{{tag
|name = decloakOnFire
|type = bool
|default = true
|description = Does the unit decloak when it fires a weapon?}}

{{tag
|name = cloakTimeout
|type = int
|default = 128
|description = The minimum time, in [[frames]], between a decloak and subsequent re-cloak.}}

===Commands===
{{tag
|name = canMove
|type = bool
|default = false
|description = Can the unit be issued Move orders?
}}

{{tag
|name = canAttack
|type = bool
|default = true
|description = Can the unit be issued Attack orders?
}}

{{tag
|name = canFight
|type = bool
|default = true
|description = Can the unit be issued Fight orders?
}}

{{tag
|name = canPatrol
|type = bool
|default = true
|description = Can the unit be issued Patrol orders?
}}

{{tag
|name = canGuard
|type = bool
|default = true
|description = Can the unit be issued Guard orders?
}}

{{tag
| name = canCloak
| type = bool
| default = false
| description =
Can the unit be issued Cloak orders?
}}

{{tag
|name = canRepeat
|type = bool
|default = true
|description = Can the unit be issued Repeat orders?
}}

{{tag
|name = canSelfDestruct
|type = bool
|default = true
|special = lua: canSelfD
|description = Can the unit be issued a self destruct order?
}}

{{tag
|name = moveState
|type = int
|default = -1 for mobile units, 1 for structures
|description = The initial movement state for the unit. Can be <code>-1</code> - Inherits from factory, <code>0</code> - Hold Position, <code>1</code> - Manoeuvre or <code>2</code> - Roam.
}}

{{tag
|name = fireState
|type = int
|default = -1 for units with {{taglink|noAutoFire|false}}, 2 otherwise
|description = The initial firing state for the unit. Can be <code>-1</code> - Inherits from factory, <code>0</code> - Hold Fire, <code>1</code> - Return Fire or <code>2</code> - Fire At Will.
}}

{{tag
|name = noAutoFire
|type = bool
|default = false
|special = lua: canFireControl
|description = Controls whether or not the unit has a fire state button.
}}

{{tag
|name = canManualFire
|type = bool
|default = false
|description = description = Can the unit be issued ManualFire commands? A ManualFire command will fire any weapons with the {{xtaglink|Units-WeaponDefs|commandfire}} tag.
}}

====Builder Commands====
{{tag
|name = canRestore
|type = bool
|default = builder && {{taglink|terraformSpeed}} > 0
|description = Can the unit be issued restore terrain commands? For builders only.
}}

{{tag
|name = canRepair
|type = bool
|default = builder && {{taglink|repairSpeed}} > 0
|description = Can the unit be issued repair commands? For builders only.
}}

{{tag
|name = canReclaim
|type = bool
|default = builder && {{taglink|reclaimSpeed}} > 0
|description = Can the unit be issued reclaim commands? For builders only.
}}

{{tag
|name = canResurrect
|type = bool
|default = builder && {{taglink|resurrectSpeed}} > 0
|description = Can the unit be issued resurrection commands? For builders only.
}}

{{tag
|name = canCapture
|type = bool
|default = builder && {{taglink|captureSpeed}} > 0
|description = Can the unit be issued capture commands? For builders only.
}}

===Builder===
{{tag
|name = builder
|type = bool
|default = false
|description = Is the unit a builder?}}

{{tag
|name = buildDistance
|type = float
|default = 128.0
|description = How far away from itself the unit can build, measured to the centre of the unit being built. The minimum value is <code>38.0</code>.}}

{{tag
|name = buildRange3D
|type = bool
|default = false
|description = Does the builders {{taglink|buildDistance}} apply in all 3 dimensions or only 2?}}

{{tag
|name = workerTime
|type = float
|default = 0.0
|special = lua: buildSpeed
|description = How fast the builder builds, used in conjunction with the {{taglink|buildTime}} of the unit being built. Effectively, <code>Time to build = buildTime / workerTime</code>. If this value is <= <code>0.0</code> then {{taglink|builder}} is set to false.}}

{{tag
|name = repairSpeed
|type = float
|default = workerTime
|description = How fast the builder can repair other units.}}

{{tag
|name = reclaimSpeed
|type = float
|default = workerTime
|description = How fast the builder can reclaim other units and features.}}

{{tag
|name = resurrectSpeed
|type = float
|default = workerTime
|description = How fast the builder can resurrect corpse features back into living units.}}

{{tag
|name = captureSpeed
|type = float
|default = workerTime
|description = How fast the builder can capture other units.}}

{{tag
|name = terraformSpeed
|type = float
|default = workerTime
|description = How fast the builder levels and restores terrain.}}

{{tag
|name = canAssist
|type = bool
|default = builder
|description = Can the builder assist other constructions?}}

{{tag
|name = canBeAssisted
|type = bool
|default = true
|description = Can the builder be assisted by other builders?}}

{{tag
|name = canSelfRepair
|type = bool
|default = false
|description = Can the builder repair itself?}}

{{tag
|name = showNanoSpray
|type = bool
|default = true
|description = Does the builder emit OTA-style nanospray whilst constructing?}}

{{tag
|name = nanoColor
|type = float[3]
|default = {0.2, 0.7, 0.2} aka green
|description = The RGB colour of a builders' emitted nano particles if {{taglink|showNanoSpray|true}}. Also controls the RBG colour of a unit's own nanoframe if {{taglink|showNanoFrame|true}}.}}

{{tag
|name = fullHealthFactory
|type = bool
|defaul[[elmo]]s
|description = If <code>true</code>, units are repaired before they are allowed to leave the factory i.e. units from this factory will be healed back to 100% health if they are damaged during construction.}}

{{tag
|name = isAirbase
|type = bool
|default = false
|description = Is this unit an airbase? Aircraft may land and repair on units which are airbases.}}

===Movement & Placement===
{{tag
|name = footprintX
|type = int
|default = 1
|description =
How wide the unit is in footprint units, left to right. 1 footprint unit = 16 [[elmo]]s. Cannot be below <code>1</code>. For mobile units this should be the same as the {{xtaglink|Movedefs.lua|footprintX}} of its {{taglink|movementClass}}. Also used for obstacle avoidance.
}}

{{tag
|name = footprintZ
|type = int
|default = 1
|description =
How wide the unit is in footprint units, top to bottom. 1 footprint unit = 16 [[elmo]]s. Cannot be below <code>1</code>. For mobile units this should be the same as the {{xtaglink|Movedefs.lua|footprintZ}} of its {{taglink|movementClass}}. Also used for obstacle avoidance.
}}

{{tag
|name = yardmap
|type = string
|default = ""
|description =
Used to determine a structure from a mobile unit. A string of characters which defines in detail each 'footprint square' of the structure. Each footprint square may be:
:: <code>y</code> - 'Yard' - Always open, unblocking,
:: <code>c</code> - 'Construction' - Open and unblocking only while constructing (for factories, controlled via <code>COB.YARD_OPEN</code> see [[Animation-LuaCallouts#Other]]),
:: <code>i</code> - 'Inversed Construction' - Closed and blocking only while constructing (for factories, controlled via <code>COB.YARD_OPEN</code> see [[Animation-LuaCallouts#Other]]) ({{new|89.0}}),
:: <code>g</code> - 'Geothermal' - Flags that the unit must be placed over a {{xtaglink|Units-FeatureDefs|geoThermal}} feature, does not actually count as a square,
:: <code>h</code> - 'High Resolution' - Indicates that the yardmap will use double resolution with four times as many characters. Must be the '''first''' character, and does not count as a square itself ({{new|93.0}}),
::<code>o</code> - 'Obstacle' - Always closed, blocking, all other chars are treated the same way.
: Tip: 'Draw' out the yardmap over multiple lines. As of 89.0 all whitespace characters are ignored, including newlines.
}}

{{tag
|name = levelGround
|type = bool
|default = false
|description = For structures. Does the constructor have to level the ground underneath the build area before beginning to build the structure?
}}

{{tag
|name = movementClass
|type = string
|default = ""
|description = The name of the movement type a mobile, non aircraft, unit should use. See [[Movedefs.lua]]. Other tag usage should be consistent with this i.e. {{taglink|canHover|true}} IFF using a <code>HOVER</code> based movetype.
}}

{{tag
|name = canHover
|type = bool
|default = false
|description = Is the unit a hovercraft? Hovercraft can cross water of any depth without a speed penalty. Hover's must also have <code>HOVER</code> within the name of their {{taglink|movementClass}} (see [[Movedefs.lua]]).
}}

{{tag
|name = floater
|type = bool
|default = true if {{taglink|waterline|true}}, false otherwise
|description = When a mobile unit is crossing water, or a structure is placed on water, does it float on top of the water or crawl / lay on the sea bed?
}}

{{tag
|name = upright
|type = bool
|default = false
|description = Does the unit follow the terrain or always remain upright? Generally used for walkers.
}}

{{tag
|name = maxSlope
|type = float
|default = 0.0
|special = lua: maxHeightDif (value changed)
|description = The maximum slope a building can be placed on. Mobile unit's use the {{xtaglink|Movedefs.lua|maxSlope}} set in their {{taglink|movementClass}}. The value is in degrees and is clamped between <code>0.0</code> and <code>89.0</code>. This value is converted to a "maximum allowed height difference" (call it M), which involves a hard-coded constant. When a building gets placed, the height of each of its footprint squares is compared to a reference height (calculated for the build position). If the difference exceeds M for any square, that build position is rejected.
}}

{{tag
|name = minWaterDepth
|type = float
|default = -10e6
|description = The minimum depth of water a building can be placed on. Mobile unit's use the {{xtaglink|Movedefs.lua|minWaterDepth}} set in their {{taglink|movementClass}}.
}}

{{tag
|name = maxWaterDepth
|type = float
|default = 10e6
|description = The maximum depth of water a building can be placed on. Mobile unit's use the {{xtaglink|Movedefs.lua|maxWaterDepth}} set in their {{taglink|movementClass}}.
}}

{{tag
|name = waterline
|type = float
|default = 0.0
|description = How low in the water does a ship sit? Higher values means the ship is lower in the water.
}}

{{tag
|name = minCollisionSpeed
|type = float
|default = 1.0
|description = The minimum net impact speed that will cause a unit to be damaged by collisions with another unit.
}}

{{tag
|name = pushResistant
|type = bool
|default = false
|description = Can the unit be pushed around by other units? Turning it on doesn't remove all pushing but is a marked improvement.
}}

{{tag
|name = maxVelocity
|type = float
|default = 0.0
|special = lua: ud.speed
|description = The maximum speed attainable by the unit in [[elmo]]s per frame. If the value is -ve, the absolute value is used.
}}

{{tag
|name = maxReverseVelocity
|type = float
|default = 0.0
|special = lua: ''missing''
|description = The maximum speed attainable by the unit in reverse in [[elmo]]s per frame. If the value is -ve, the absolute value is used.
}}

{{tag
|name = acceleration
|type = float
|default = 0.5
|special = lua: maxAcc
|description = The acceleration of the unit, in [[elmo]]s per frame2. If the value is -ve, the absolute value is used.
}}

{{tag
|name = brakeRate
|type = float
|default = 3.0 * acceleration
|special = lua: maxDec
|description = The deceleration of the unit, in [[elmo]]s per frame2. If the value is -ve, the absolute value is used. For units with {{taglink|canFly|true}} this is multiplied by <code>0.1</code>.
}}

{{tag
|name = turnRate
|type = float
|default = 0.0
|description = How fast the unit can turn. <code>degrees per seconds = 0.16 * turnRate</code>.
}}

{{tag
|name = turnInPlace
|type = bool
|default = true
|description = Does the unit turn on the spot (like a person or tank) or must it be moving forwards to turn (like a car).
}}

{{tag
|name = turnInPlaceSpeedLimit
|type = float
|default = A complex formula based on {{taglink|turnRate}} and {{taglink|maxVelocity}}
|description = For units with {{taglink|turnInPlace|false}}, this defines the minimum speed it will slow down to (the speed at which the turn is actually performed can be higher depending on the angular difference and {{taglink|turnRate}}).
}}

{{tag
| name = turnInPlaceAngleLimit
| type = float
| default = 0.0
| special = {{new|86.0}}
| description = For units with {{taglink|turnInPlace|true}}, defines the maximum angle (in degrees) of a turn above which it starts to brake.
}}

{{tag
|name = blocking
|type = bool
|default = true
|description = Does the unit block the movement of other units? (Mines, i.e. non-mobile units with the {{taglink|kamikaze}} tag default to <code>false</code>).
}}

{{tag
|name = crushResistance
|type = float
|default = mass
|special = {{new|85.0}}
|description = How resistant is the unit to being crushed? Any [[Movedefs.lua|'''MoveClass''']] with a {{xtaglink|Movedefs.lua|crushStrength}} greater than this will crush the unit - IFF this has been enabled via [[Lua_SyncedCtrl#Unit_Control|Spring.SetUnitBlocking]] and the collider impulse exceeds that of the colidee.
}}

===Flanking===
For a deeper explanation of these tags, see [[Units:FlankingBonus]].

{{tag
|name = flankingBonusMode
|type = int
|default = flankingBonus.defaultMode set in [[Modrules.lua]]
|description = The mode of operation of Spring's inbuilt flanking system. Can be <code>0</code> - No flanking bonus. Mode <code>1</code> builds up the ability to move over time, and swings to face attacks, but does not respect the way the unit is facing. Mode <code>2</code> also can swing, but moves with the unit as it turns. Mode <code>3</code> stays with the unit as it turns and otherwise doesn't move, the ideal mode to simulate something such as tank armour.
}}

{{tag
|name = flankingBonusDir
|type = float[3]
|default = {0.0, 0.0, 1.0}
|description = This is the direction vector where the armour is facing; i.e. where the least damage is applied. The default is straight forwards.
}}

{{tag
|name = flankingBonusMax
|type = float
|default = 1.9
|description = The maximum multiplier to the damage dealt, when a unit is hit from the opposite direction to {{taglink|flankingBonusDir}}.
}}

{{tag
|name = flankingBonusMin
|type = float
|default = 0.9
|description = The minimum multiplier to the damage dealt, when a unit is hit from the same direction as {{taglink|flankingBonusDir}}.
}}

{{tag
|name = flankingBonusMobilityAdd
|type = float
|default = 0.01
|description = This defines the ability of {{taglink|flankingBonusDir}} to move over time. Its value is added to the mobility every [[SlowUpdate]]. When the unit is attacked, the build up mobility value is multiplied by a vector facing the attack, which is added to {{taglink|flankingBonusDir}}.
}}

===Aircraft===
{{tag
|name = canFly
|type = bool
|default = false
|description = Can the unit fly, i.e. is it an aircraft?
}}

{{tag
|name = canSubmerge
|type = bool
|default = false
|description = Can the aircraft land underwater?
}}

{{tag
|name = factoryHeadingTakeoff
|type = bool
|default = true
|description = Controls the take-off behaviour of aircraft with {{taglink|hoverAttack|true}}. <code>true</code> means planes start matching their heading right after taking off from the pad, <code>false</code> means they maintain the heading of the pad until reaching {{taglink|cruiseAlt}}.
}}

{{tag
|name = collide
|type = bool
|default = true
|description = Does the unit collide with other aircraft, or can it occupy the same space?
}}

{{tag
|name = hoverAttack
|type = bool
|default = false
|description = Controls whether the aircraft flys and attacks like a fighter/bomber or a helicopter/gunship.
}}

{{tag
|name = airStrafe
|type = bool
|default = true
|description = For aircraft with {{taglink|hoverAttack|true}}, controls if the unit strafes side to side while attacking or remains stationary.
}}

{{tag
|name = cruiseAlt
|type = float
|default = 0.0
|special = lua: wantedHeight
|description = The altitude in [[elmo]]s which the unit attempts to fly at while cruising.
}}

{{tag
|name = airHoverFactor
|type = float
|default = -1.0
|special = lua: dlHoverFactor
|description = For aircraft with {{taglink|hoverAttack|true}}, less then <code>0</code> means it can land and >= <code>0</code> indicates how much the unit will move during hovering on the spot.
}}

{{tag
|name = bankingAllowed
|type = bool
|default = true
|description = For aircraft with {{taglink|hoverAttack|true}}, controls whether or not the unit banks when moving turning.
}}

{{tag
|name = useSmoothMesh
|type = bool
|default = true
|description = Does the aircraft follow the real map terrain or the special smoothed out navigation mesh generated by Spring specifically for aircraft?} Can become problematic for construction aircrafts, building in canyons.
}}

{{tag
|name = maxFuel
|type = float
|default = 0.0
|description = The maximum flight time in seconds before aircraft must return to an airbase to refuel.
}}

{{tag
|name = refuelTime
|type = float
|default = 5.0
|description = The time in seconds required to refuel the aircraft at an airbase.
}}

{{tag
|name = minAirbasePower
|type = float
|default = 0.0
|description = The minimum {{taglink|workerTime}} an airbase must have to repair / refuel this aircraft.
}}

{{tag
|name = canLoopbackAttack
|type = bool
|default = false
|description = Can the aircraft perform an [http://en.wikipedia.org/wiki/Immelmann_turn Immelmann turn]?
}}

====Advanced Air Tags====
The following set of tags are not well understood and using non-default values can lead to undesired flight behaviours.
{{tag
|name = wingDrag
|type = float
|default = 0.07
|description = The drag caused by the aircraft's wing. Clamped between <code>0.0</code> and <code>1.0</code>.
}}

{{tag
|name = wingAngle
|type = float
|default = 0.08
|description = The angle between the front and the wing plane.
}}

{{tag
|name = frontToSpeed
|type = float
|default = 0.1
|description = Fudge factor for lining up speed and front of plane.
}}

{{tag
|name = speedToFront
|type = float
|default = 0.07
|description = Fudge factor for lining up speed and front of plane.
}}

{{tag
|name = myGravity
|type = float
|default = 0.4
|description = As Spring aircraft are slower than real aircraft this tag allows to lower gravity to compensate. Multiplies against map gravity.
}}

{{tag
|name = crashDrag
|type = float
|default = 0.005
|description = The drag used when crashing. Clamped between <code>0.0</code> and <code>1.0</code>.
}}

{{tag
|name = maxBank
|type = float
|default = 0.8
|description = The maximum roll (z-axis rotation) the aircraft can achieve.
}}

{{tag
|name = maxPitch
|type = float
|default = 0.45
|description = The maximum pitch (x-axis rotation) the aircraft tries to keep.
}}

{{tag
|name = turnRadius
|type = float
|default = 500.0
|description = Hint to Spring unit AI about the required turning radius.
}}

{{tag
|name = verticalSpeed
|type = float
|default = 3.0
|description = The speed of takeoff and landing, at least for gunships ({{taglink|hoverAttack|true}}).
}}

{{tag
|name = maxAileron
|type = float
|default = 0.015
|description = The maximum turn speed around the roll (z) axis.
}}

{{tag
|name = maxElevator
|type = float
|default = 0.01
|description = The maximum turn speed around the pitch (x) axis.
}}

{{tag
|name = maxRudder
|type = float
|default = 0.004
|description = The maximum turn speed around the yaw (y) axis.
}}

{{tag
|name = maxAcc
|type = float
|default = 0.065
|description = The maximum acceleration or 'engine power' of the aircraft.
}}

====Flares====
The following set of tags are rarely used and are hardcoded to only work vs. missile weapons. The texture is hardcoded to be <code>flareprojectiletexture</code> defined in [[Resources.lua]].
{{tag
|name = canDropFlare
|type = bool
|default = false
|description = Can this aircraft drop flares to distract missile weapons?
}}

{{tag
|name = flareReload
|type = float
|default = 5.0
|special = lua: flareReloadTime
|description = The time in seconds between successive flare drops.
}}

{{tag
|name = flareDelay
|type = float
|default = 0.3
|description = The delay between detecting an incoming missile and launching flares. Multiplied by a random number between 1 and 16.
}}

{{tag
|name = flareEfficiency
|type = float
|default = 0.5
|description = The probability that an incoming missile will target the flare instead of the aircraft.
}}

{{tag
|name = flareDropVector
|type = float[3]
|default = {0.0, 0.0, 0.0}
|description = The direction vector which flares are emitted in.
}}

{{tag
|name = flareTime
|type = int
|default = 3
|description = The lifetime of a dropped flare in [[frames]].
}}

{{tag
|name = flareSalvoSize
|type = int
|default = 4
|description = How many flares are dropped at once?
}}

{{tag
|name = flareSalvoDelay
|type = int
|default = 0
|description = The delay in [[frames]] between the release of each individual flare in a burst.
}}

===Transports===
{{tag
|name = transportSize
|type = int
|default = 0
|description = The size of units that the transport can pick up, in terms of the passengers {{taglink|footprintX}}.}}

{{tag
|name = minTransportSize
|type = int
|default = 0
|description = The smallest size of unit that the transport can pick up, in terms of the passengers {{taglink|footprintX}}.}}

{{tag
|name = transportCapacity
|type = int
|default = 0
|description = The total number of units that the transport can pick up, with each unit multiplied by it's {{taglink|footprintX}} size. If this tag is not present, then any AttachUnit and DropUnit call in the animation script will be ignored (See [[Animation-LuaCallouts#Other]])}}

{{tag
|name = transportMass
|type = float
|default = 100000.0
|description = The total cumulative {{taglink|mass}} of passengers the transport can carry.}}

{{tag
|name = minTransportMass
|type = float
|default = 0.0
|description = The minimum {{taglink|mass}} passenger the transport can carry.}}

{{tag
|name = loadingRadius
|type = float
|default = 220.0
|description = How far away in [[elmo]]s can the transporter pick up and drop units?}}

{{tag
|name = unloadSpread
|type = float
|default = 1.0
|description = How spread out the passengers are when unloaded. Is multiplied by the passengers radius.}}

{{tag
|name = isFirePlatform
|type = bool
|default = false
|description = Can transported units still aim and shoot while loaded by this transport?}}

{{tag
|name = holdSteady
|type = bool
|default = false
|description = If <code>true</code> - passengers are slaved to orientation of transporter attachment piece, if <code>false</code> - passengers are slaved to orientation of transporter body.}}

{{tag
|name = releaseHeld
|type = bool
|default = false
|description = Does the transporter unload it's passengers when it dies?}}

{{tag
|name = cantBeTransported
|type = bool
|default = false for mobile units, true for structures
|description = Controls if a unit is transportable at all or not. If <code>false</code> it is overridden by [[Modrules.lua]] <code>transportability</code> subtable tags.}}

{{tag
|name = transportByEnemy
|type = bool
|default = true
|description = Controls if a unit can be transported by an enemy transport. i.e. can it be kidnapped.}}

{{tag
|name = transportUnloadMethod
|type = int
|default = 0
|description = For air transports. Can be <code>0</code> - Land to unload individually, <code>1</code> - Flyover drop (i.e. Parachute), or <code>2</code> - Land and flood unload all passengers. Can be used on ground transports with mixed results.}}

{{tag
|name = fallSpeed
|type = float
|default = 0.2
|description = For air transports with {{taglink|transportUnloadMethod|1}}. The speed in [[elmo]]s per second which units will fall at when released from the transport.}}

{{tag
|name = unitFallSpeed
|type = float
|default = 0.0
|description = Allows you to override {{taglink|fallSpeed}} for an individual passenger.}}

===Categories===
For a deeper explanation of these tags, see [[Unit_Categories]].
{{tag
|name = category
|type = string
|default = ""
|description = The category tag is a string of separate words, each representing a category of units. There is a maximum of 32 categories. The primary purpose of categories is weapon targeting (See [[#weapons]]).}}

{{tag
|name = noChaseCategory
|type = string
|default = ""
|description = The unit will still target enemies with a matching {{taglink|category}}, but will not chase after it if it moves out of weapon range.}}

===Decals===
{{tag
|name = leaveTracks
|type = bool
|default = false
|description = Does the unit leave a track mark decal behind it when it moves? For mobile units.}}

{{tag
|name = trackType
|type = string
|default = "stdTank"
|description = The filename of the image, without extension, assumed to be in <code>Bitmaps/Tracks/</code>, to be used as the track decal. The red channel of the image controls the brightness and the green channel the alpha (how visible it is) of the track. Blue channel is unused.}}

{{tag
|name = trackWidth
|type = float
|default = 32.0
|description = The width of the track decal left on the ground, in [[elmo]]s.}}

{{tag
|name = trackOffset
|type = float
|default = 0.0
|description = How far back in [[elmo]]s the track should be drawn from the centre of the unit.}}

{{tag
|name = trackStrength
|type = float
|default = 32.0
|description = How visible or 'deep' the track mark should be. Also used to determine how long the decal should last.}}

{{tag
|name = trackStretch
|type = float
|default = 1.0
|description = How much the track is stretched in the forward direction compared to the sides (i.e. used to change aspect ratio).}}

{{tag
|name = useBuildingGroundDecal
|type = bool
|default = false
|description = For structures, do they display a ground decal on the terrain under their model?}}

{{tag
|name = buildingGroundDecalType
|type = string
|default = ""
|description = The filename of the image to be used as ground decal. Assumed to be in <code>Unittextures/</code>.}}

{{tag
|name = buildingGroundDecalSizeX
|type = int
|default = 4
|description = How wide the decal is left to right, in footprint units.}}

{{tag
|name = buildingGroundDecalSizeY
|type = int
|default = 4
|description = How wide the decal is top to bottom, in footprint units.}}

{{tag
|name = buildingGroundDecalDecaySpeed
|type = float
|default = 0.1
|description = A measure of how quickly the decal should fade out if the structure dies. Essentially this value is multiplied by the time since death and subtracted from the original alpha until the decal is fully transparent.}}

===Collision Volumes===
For a deeper explanation of these tags, see [[Unit_collision_volumes | Unit Collision Volumes]].
{{tag
|name = modelCenterOffset
|type = float[3]
|default = {0.0, 0.0, 0.0}
|special = Removed in 89.0 (Now set via lua)
|description = How far from the model's defined centre should the centre of the unit be?}}

{{tag
|name = usePieceCollisionVolumes
|type = bool
|default = false
|description = When turned on the model and UnitDef collision volumes are ignored and Spring generates a bounding box volume for each piece of the unit model. These volumes can be manipulated or replaced by [[Lua_SyncedCtrl#Unit_Control | Spring.SetUnitPieceCollisionVolumeData]]. Increases the performance cost of collision calculations.}}

{{tag
|name = collisionVolumeType
|type = string
|default = ""
|description = What shape should the unit's collision volume be? Can be <code>box</code>, <code>ellipsoid</code> or a cylinder aligned to an axis; <code>cylX</code>, <code>cylY</code>, <code>cylZ</code>.}}

{{tag
|name = collisionVolumeScales
|type = float[3]
|default = {0.0, 0.0, 0.0}
|description = The lengths of the collision volume in each of the three axes. Note that non-spherical ellipsoids and elliptical cylinders are not supported.}}

{{tag
|name = collisionVolumeOffsets
|type = float[3]
|default = {0.0, 0.0, 0.0}
|description = The offset from the unit centre to the hit volume centre in each axis.}}

{{tag
|name = useFootPrintCollisionVolume
|type = bool
|default = false
|special = {{new|92.0}}
|description = Replaces any defined collision volume with a box with dimensions equal to the object's footprint (this also overrides any custom scaling and/or offsets).
}}

{{tag
|name = collisionVolumeTest
|type = int
|default = 0
|special = Removed in 90.0 (Now always continuous)
|description = The type of test used to detect collisions. Can be <code>0</code> (discrete) or <code>1</code> (continuous). Use the latter for catching high speed projectiles which may otherwise 'skip through' small collision volumes, but beware of the increased performance cost.}}

===Attack Behaviours===
{{tag
|name = highTrajectory
|type = int
|default = 0
|special = lua: highTrajectoryType
|description = Can the unit fire it's (ballistic) weapons in a high trajectory arc? Can be <code>0</code> - Low trajectory only, <code>1</code> - High trajectory only, or <code>2</code> - Toggle button.}}

{{tag
|name = kamikaze
|type = bool
|default = false
|special = lua: canKamikaze
|description = Does the unit attack its target by blowing itself up?}}

{{tag
|name = kamikazeDistance
|type = float
|default = 0.0
|special = lua: kamikazeDist
|description = How close to the target, in [[elmo]]s, the unit must get before detonating. Measured in 3D, not 2D.}}

{{tag
|name = kamikazeUseLOS
|type = bool
|default = false
|description = Does the target unit have to be in LOS when detonating or only within {{taglink|kamikazeDistance}}.}}

{{tag
|name = strafeToAttack
|type = bool
|default = false
|description = Should the unit move sideways when it can't shoot?}}

===Other===
{{tag
|name = decoyFor
|type = string
|default = ""
|description = The UnitDef name (not human {{taglink|name}}) which this unit is a decoy for.}}

{{tag
|name = selfDestructCountdown
|type = int
|default = 5
|special = lua: selfDCountdown
|description = The length in seconds taken between issuing self destruct order and the unit exploding.}}

{{tag
|name = damageModifier
|type = float
|default = 1.0
|special = lua: armoredMultiple
|description = The multiplier applied to weapon damage when the units ARMORED status (See [[Lua_ConstCOB]]) is turned on.}}

{{tag
|name = isTargetingUpgrade
|type = bool
|default = false
|special = lua: targFac
|description = Does the unit upgrade the targeting so that units shoot accurately at enemy units which are in radar but not in LOS.}}

{{tag
|name = isFeature
|type = bool
|default = false
|description = Does the unit immediately die into it's {{taglink|corpse}} feature when built? Used mainly for making walls.}}

{{tag
|name = hideDamage
|type = bool
|default = false
|description = Should the units current health be invisible to enemy players?}}

{{tag
|name = showPlayerName
|type = bool
|default = false
|description = Should the unit display it's controlling player as its name instead of {{taglink|name}}. Generally used for commander or hero units.}}

{{tag
|name = showNanoFrame
|type = bool
|default = true
|description = Does the unit show an OTA-style nanoframe whilst being constructed?}}

{{tag
|name = unitRestricted
|type = int
|default = MAX_UNITS
|special = lua: maxThisUnit
|description = How many of this unit type may a player control at once? Defaults to being the maximum amount of units controllable. Is overridden by lobby unit restrictions.}}

{{tag
|name = power
|type = float
|default = {{taglink|buildCostMetal}} + ({{taglink|buildCostEnergy}} / 60.0)
|description = The relative power of the unit. Used in weapon targeting priority and experience gain calculations.}}

==Sub Tables==

===weapons===
The <code>weapons</code> subtable of a UnitDef tells Spring which weapons the unit has. It is a simple array (number indexed table) of <code>weaponName</code>s (not the human readable <code>name</code>!).

The following additional tags are associated with this subtable:

{{tag
|name = name
|type = string
|default = ""
|description = The <code>weaponName</code> of the weapon (See [[Units-WeaponDefs]]). If using the [[weapondefs_post.lua]] provided by [[springcontent.sdz]], you may include the WeaponDef tables within the UnitDef as the <code>weaponDefs</code> subtable, and refer to them with <code>def</code> rather than <code>name</code>. This can be a useful way to organise definitions if units do not generally share weapons.}}

{{tag
|name = badTargetCategory
|type = string
|default = ""
|description = A string of unit {{taglink|category}} entries which this weapon prefers to avoid targeting. i.e. given two units which ''can'' be targeted, any unit whose {{taglink|category}} matches any entry in this tag, will be targeted last. (See [[#Categories]])}}

{{tag
|name = onlyTargetCategory
|type = string
|default = ""
|description = A string of unit {{taglink|category}} entries which this weapon can target. i.e. any unit whose {{taglink|category}} does not match any entry in this tag, cannot be targeted by this weapon. (See [[#Categories]])}}

{{tag
|name = slaveTo
|type = int
|default = 0
|description = The number of the weapon which this weapon is slaved to. A slaved weapon can only target what it's master is targeting. Weapon numbers start at <code>1</code> and correspond to the index of the weapon within the subtable.}}

{{tag
|name = mainDir
|type = float[3]
|default = {0.0, 0.0, 1.0} i.e. forwards
|description = A vector representing the firing direction of this weapon if it has a limited firing arc. Used in conjunction with {{taglink|maxAngleDif}} (See [[Units:WeaponMainDir]]).}}

{{tag
|name = maxAngleDif
|type = float
|default = 360.0
|description = How wide this weapons limited firing arc is in degrees. Symmetrical about {{taglink|mainDir}} i.e. <code>180.0</code> is 90 degree freedom either way (See [[Units:WeaponMainDir]]).}}

{{tag
|name = fuelUsage
|type = float
|default = 0.0
|description = How much fuel in seconds is deducted from the units initial {{taglink|maxFuel}} when this weapon fires.}}

===buildOptions===
The <code>buildOptions</code> subtable of a UnitDef tells Spring which other units the unit can build (in the case of a builder) or produce (in the case of a factory).
It is a simple array (number indexed table) of <code>unitName</code>s (not the human readable {{taglink|name}}!).

There are no additional tags specific to this subtable.

===SFXTypes===
The <code>SFXTypes</code> subtable of a UnitDef tells Spring which [[CEG]] effects are associated with the unit. It consists of two further subtables, with no additional tags specific to them.

====explosionGenerators====

The <code>explosionGenerators</code> subtable of <code>SFXTypes</code> tells Spring which [[CEG]]s the unit's script can call, via the <code>EmitSFX()</code> callout (See [[Animation-LuaCallouts#Effects]]). It is a simple array (number indexed table) of CEG names, prefaced by the string <code>"custom:"</code>.

====pieceExplosionGenerators====
{{new|83.0}}

The <code>pieceExplosionGenerators</code> subtable of <code>SFXTypes</code> tells Spring which [[CEG]]s the unit's script can pick at random to attach to a flying unit piece, created from the <code>Explode()</code> callout (See [[Animation-LuaCallouts#Effects]]). It is a simple array (number indexed table) of CEG names, with no prefix.

Forum thread (with examples): {{forumlink|topic=27554|title=pieceExplosionGenerators}}

===sounds===

The <code>sounds</code> subtable of a UnitDef tells Spring which sound files to play when the unit triggers various events.

Files are assumed to be in the <code>Sounds/</code> directory; accepted formats are .wav and .ogg, the former being assumed if no extension is given.

Sounds can be defined in one of three ways:

# Each event can be used as though it were a <code>string</code> tag referring to the filename.
# Each event can be the name of a subtable, which is a simple array containing the filenames. One sound is picked at random from the list each time the event occurs.
# Each event can be the name of a subtable, which is a simple array containing further tables, which contain the following tags:
{{tag
|name = file
|type = string
|default = ""
|description = The filename of the sound to play.}}

{{tag
|name = volume
|type = float
|default = 1.0
|description = The default volume of the sound.}}

Spring checks any referenced sound filename to see if a SoundItem has been created, which allows greater control over how it is played (See [[Sounds.lua]]).

====sounds Example====

For clarification, here is an example of all three methods:

<code><pre>sounds = {
-- Method 1
ok = 'oksound', -- .wav appended
-- Method 2
arrived = {
'arrived1.wav',
'arrived2.wav',
},
-- Method 3
select = {
{ file = 'selsound1.ogg', volume = 2.0 },
{ file = 'selsound2.ogg', volume = 2.5 },
},
}</pre></code>

====sounds Events====

The events called by the engine are as follows:

{{ItemType
|name = ok
|description = Unit is issued a command.
}}

{{ItemType
|name = select
|description = Unit is selected by the player.
}}

{{ItemType
|name = arrived
|description = Unit has arrived at its destination. Mobile ground units only.
}}

{{ItemType
|name = build
|description = Unit begins building. Called for both factories and mobile construction units.
}}

{{ItemType
|name = activate
|description = Unit is activated, i.e. Is turned on. Also called when a mobile ground unit starts moving.
}}

{{ItemType
|name = deactivate
|description = Unit deactivates, i.e. Is turned off.
}}

{{ItemType
|name = cant
|description = Unit cannot carry out this order. Loaded but not currently called by the engine.
}}

{{ItemType
|name = underattack
|description = Unit gets attacked. Loaded but not currently called by the engine.
}}

===customParams===
The <code>customParams</code> subtable of a UnitDef allows the game designer to give their units custom attributes, which can then be accessed via lua gadgets and widgets. It is a map (key-value pair indexed table) of strings. When accessing these attributes in lua the strings can be turned back into numbers, bools or even tables. This gives great control to game designers to essentially implement their own behaviour tags.

There are no additional tags specific to this subtable

==Examples==
[http://imolarpg.dyndns.org/trac/balatest/browser/trunk/units 'Balanced Annihilation' UnitDefs]

[http://code.google.com/p/conflictterra/source/browse/#svn%2Fgames%2FCT%2Funits 'Conflict Terra' UnitDefs]

[https://code.google.com/p/evolutionrts/source/browse/#svn%2Ftrunk%2Fevolutiondev.sdd%2FUnits 'Evolution RTS' UnitDefs]

[http://code.google.com/p/springtutorialgame/source/browse/#svn%2Ftrunk%2FSpringTutorialGame.sdd%2FUnits 'Spring Tutorial Game' UnitDefs]

[http://code.google.com/p/zero-k/source/browse/trunk#trunk%2Fmods%2Fzk%2Funits 'ZeroK' UnitDefs]

[[Category: Units]]

Ren'Py

2013-08-30T12:04:33Z

Kingraptor: /* Spring to Ren'Py */

'''Ren'Py''' is an open source visual novel engine, available [http://www.renpy.org/ here]. It can be used in conjunction with Spring to provide a singleplayer experience with narrative, dialogue, images and videos.

== Using Ren'Py with Spring ==
Without the use of sockets, Ren'Py and Spring can best communicate in the following way:

=== Ren'Py to Spring ===
Python can read a Spring startscript and modify it, say using [http://docs.python.org/2/library/string.html#formatstrings str.format] or the older [http://docs.python.org/2/library/stdtypes.html#string-formatting % (modulo) operator]. In this way, any arbitrary game, per-player or per-team information can be made available to Spring at runtime. It is also theoretically possible for Python to modify the contents of an .sdz or .sdd archive directly, but this is not recommended.

=== Spring to Ren'Py ===
A widget or gadget can write a Python file with any information to be communicated to Ren'Py, which it can then import using the [http://docs.python.org/2/library/functions.html#execfile execfile] function. Bear in mind that because Spring is limited in which directories its Lua can write files to, Ren'Py will need to know where the Spring datadir is.

=== Examples ===
[https://code.google.com/p/springpy/ SpringPy] is a code example for Spring-Ren'Py communication. You can check out the whole repo and open/run the Ren'Py project with the Ren'Py SDK.
* [https://code.google.com/p/springpy/source/browse/trunk/game/script.rpy Example script.rpy]
* [https://code.google.com/p/springpy/source/browse/trunk/spring/script_pytest.txt Example startscript]
* [https://code.google.com/p/springpy/source/browse/trunk/spring/LuaUI/Widgets/api_shared_functions.lua Widget to write Python dictionaries and module files]
* [https://code.google.com/p/springpy/source/browse/trunk/spring/LuaUI/Widgets/dbg_test.lua Test widget]: writes data required by sample code on widget:Initialize()

[[Category:Game Dev]]

LuaCallinReturn

2013-08-25T17:32:02Z

Kingraptor:

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

==Engine Source==
If you can understand Lua code well and wish to get the most up to date info, you can refer to:
{{sourcelink|file=cont/base/springcontent/LuaGadgets/actions.lua}},
{{sourcelink|file=cont/LuaUI/widgets.lua}} and 
{{sourcelink|file=cont/base/springcontent/LuaGadgets/gadgets.lua}} 
to see how widget/gadget call-ins are distributed, find call-in and widgetHandler function definitions, see how they are processed and what values should be returned from some call ins
(are these the only files?)

==What is a callin anyway?==
Call-ins are calls from the engine, into the gadget or widget script. In other words, these functions are called when a particular â€œeventâ€ happens.
Some call-in functions can return values to the engine.
===Blocking events with return values===
The call-in functions named '''''Allow'''''XXX can block their event by returning ''false''. 
For example ''AllowUnitTransfer()'' 
<code>return true</code> = allow transfer 
<code>return false</code> = deny transfer

==Commands, general-purpose:==

Initialize() --> none. 
called when widget/gadget gets (re-)loaded.

Shutdown() --> none.

PlayerChanged --> (playerID).
gadget/widget: Use this to check whether a player has become spectator for instance.

LayoutButtons() --> unknown, please document.

ConfigureLayout() --> "command".

CommandNotify() --> "id, params, options", where id = the CommandID

KeyPress() --> "key, mods, isRepeat", where key = keymap, mods = SHIFT, etc.

KeyRelease() --> "key"

MouseMove() --> "x, y, dx, dy, button"

MousePress() --> "x, y, button" 
button parameter values: left - 1, middle - 2, right - 3

MouseRelease() --> "x, y, button" 
Please note that in order to have Spring call MouseRelease, you need to have a MousePress call-in in the same widget that returns true.

MouseWheel() --> "up, value"

IsAbove() --> "x, y" where x,y = screen coordinates.

GetTooltip() --> "x, y" where x,y = screen coordinates. Returns WorldTooltip.

AddConsoleLine() --> "msg, priority"

MapDrawCmd() --> "playerID, cmdType, px, py, pz, labeltext"

AllowCommand() --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag, synced"

CommandFallback() --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag"

CommandsChanged() --> unknown (none?)

AllowUnitCreation() --> "unitDefID, builderID, builderTeam, x, y, z, facing"

AllowUnitTransfer() --> "unitID, unitDefID, oldTeam, newTeam, capture"

AllowUnitBuildStep() --> "builderID, builderTeam, unitID, unitDefID, part"

AllowFeatureCreation() --> "featureDefID, teamID, x, y, z"

AllowFeatureBuildStep() --> unknown, please document.

AllowResourceLevel() --> "teamID, res, level"

AllowResourceTransfer() --> "teamID, res, level"

Update() --> "dt" 
called every screenframe. dt is the time since the last screenframe

DefaultCommand() --> "type,id" 
can return an [[Lua_CMDs|CMD]] to change cursor and command. {{forumlink|topic=26438|title=example usage}}

AllowDirectUnitControl(unitID, unitDefID, unitTeam, playerID) -> allowFpsControl 
''return true'' allows fps mode, ''return false'' blocks it.

==Unit-Specific:==

UnitPreDamaged() --> "unitID, unitDefID, unitTeam, damage, paralyzer, weaponDefID, attackerID, attackerDefID, attackerTeam" (prior to 94.0)

UnitPreDamaged() --> "unitID, unitDefID, unitTeam, damage, paralyzer, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam" (as of 94.0)

UnitDamaged() --> "unitID, unitDefID, unitTeam, damage, paralyzer, weaponDefID, attackerID, attackerDefID, attackerTeam" 
Can overwrite the taken damage by returning a new number value. 

As of 88.0 for both UnitDamaged and UnitPreDamaged:
weaponDefID -1 --> debris collision
weaponDefID -2 --> ground collision
weaponDefID -3 --> object collision
weaponDefID -4 --> fire damage
weaponDefID -5 --> water damage
weaponDefID -6 --> kill damage

UnitExperience() --> "unitID, unitDefID, unitTeam, experience, oldExperience"

Spring.SetExperienceGrade must be called first to determine how often it is called

UnitCreated() --> "unitID, unitDefID, teamID, builderID"

UnitFinished() --> "unitID, unitDefID, teamID"

UnitFromFactory() --> "unitID, unitDefID, unitTeam, factID, factDefID, userOrders"

UnitDestroyed() --> "unitID, unitDefID, teamID, attackerID, attackerDefID, attackerTeamID"

UnitTaken() --> "unitID, unitDefID, unitTeam, newTeam"

UnitGiven() --> "unitID, unitDefID, unitTeam, oldTeam"

UnitIdle() --> "unitID, unitDefID, teamID"

UnitCommand() --> "unitID, unitDefID, unitTeam, cmdID, cmdOpts, cmdParams"

UnitSeismicPing() --> "x, y, z, strength"

UnitEnteredRadar() --> "unitID, unitTeam"

UnitEnteredLos() --> "unitID, teamID"

UnitLeftRadar() --> "unitID, unitTeam"

UnitLeftLos() --> "unitID, unitDefID, teamID"

UnitLoaded() --> "unitID, unitDefID, unitTeam, transportID, transportTeam"

UnitUnloaded() --> "unitID, unitDefID, teamID, transportID"

UnitCloaked() --> "unitID, unitDefID, teamID"

UnitDecloaked)--> "unitID, unitDefID, teamID"

UnitMoveFailed() --> "unitID, unitDefID, unitTeam"

Only called for unitDefIDs registered via [[Lua_System#Synced|Script.SetWatchUnit]] since 85.0

StockpileChanged() --> "unitID, unitDefID, unitTeam, weaponNum, oldCount, newCount"

UnitEnteredWater() --> "unitID, unitDefID, teamID"

UnitEnteredAir() --> "unitID, unitDefID, teamID"

UnitLeftWater() --> "unitID, unitDefID, teamID"

UnitLeftAir() --> "unitID, unitDefID, teamID"

ShieldPreDamaged() --> "proID, proOwnerID, shieldEmitterWeaponNum, shieldCarrierUnitID, bounceProjectile"

UnitUnitCollision(colliderID, collideeID) -- needs SetWatchUnit enabled for both parties

AllowWeaponTargetCheck(attackerID, attackerWeaponNum, attackerWeaponDefID)
{{new|83.0}}

Only called for weaponDefIDs registered via [[Lua_System#Synced|Script.SetWatchWeapon]] since 92.0

AllowWeaponTarget(attackerID, targetID, attackerWeaponNum, attackerWeaponDefID, defaultPriority)
--> <code>return "targetAllowed, targetPriority"</code>
{{new|83.0}}, defaultPriority new in 89.0 

Only called for weaponDefIDs registered via [[Lua_System#Synced|Script.SetWatchWeapon]] since 92.0

DrawShield(number unitID, number weaponID) --> boolean

''true'' (<-?) skips Spring's own drawing of shield <weaponID> owned by unit <unitID>

[https://github.com/spring/spring/commit/7bbfd9464d4f74c12163ea0740c8c60d1ba978f1 maybe new in 86.0+]

==Feature-Specific:==

FeatureCreated() --> "featureID, allyTeam"

FeatureDestroyed() --> "featureID, allyTeam"

TerraformComplete() --> "unitID, unitDefID, unitTeam, buildUnitID, buildUnitDefID, buildUnitTeam"

UnitCmdDone() --> "unitID, unitDefID, unitTeam, cmdID, cmdTag"

UnitFeatureCollision(colliderID, collideeID, crushKilled) -- needs SetWatchUnit for first and SetWatchFeature for second party

==Drawing:==
Inside these functions, you can use the [[Lua_OpenGL_Api | Lua OpenGL Api]] to draw graphics.

* DrawGenesis() --> none. Don't render here.

Spring draws the sky, the map, some water types, and unit selection.

* DrawWorldPreUnit() --> none.

Spring draws units, features, some water types, cloaked units, and the sun.

* DrawWorld() --> none.

Spring draws command queues, 'map stuff', and map marks.

Each unit might also have a DrawUnit call, [[Lua_UnitRendering|enabled here.]]

DrawUnit(unitID,DrawMode) 
With enum DrawMode { 
notDrawing = 0, 
normalDraw = 1, 
shadowDraw = 2, 
reflectionDraw = 3, 
refractionDraw = 4 
};

DrawFeature(featureID, DrawMode) 

DrawShield(unitID, weaponID, DrawMode) 

DrawProjectile(projectileID, DrawMode) 

DrawScreenEffects() --> "vsx, vsy" where vsx, vsy are screen coords.

DrawScreen() --> none.

DrawInMiniMap() --> "sx, sy" where sx,sy are values relative to the minimap's position and scale.

DrawWorldShadow() --> none.

DrawWorldReflection() --> none.

DrawWorldRefraction() --> none.

==Game Events:==

GameID() --> "gameID" {{new|89.0}}

Explosion() --> "weaponID, px, py, pz, ownerID"
 Only called for weaponDefIDs registered via Script.SetWatchWeapon
 return true to hide the weapon's CEG

ShockFront() --> "power, dx, dy, dz"

GameFrame() --> "frameNum"

CobCallback() --> unknown, marked FIXME.

GroupChanged() --> "groupID" where groupID is the value of Group whose table value changed.

WorldTooltip() --> "ttType, data1, data2, data3" special, should be documented in detail.

GamePreload() --> none.

GameStart() --> none.

GameProgress() --> "serverFrameNum" ( called every 60 frames, calculating delta between GameFrame and GameProgress can give an ETA about catching up with simulation ) New in 0.83.x

GameOver() --> "[ [1] = allyTeamID1, [2] = allyTeamID2, ... ]", a list of winning allyteams, if empty the game result was undecided ( like when dropping from an host ) Will return nil in pre 0.83.x

TeamDied() --> "TeamID" where TeamID = the team that has been eliminated.

AllowStartPosition() --> x,y,z, playerID
 return true/false to allow/deny placing startposition marker

GameSetup() --> string "state", boolean "ready", table "playerStates"
 return success, newReady

GamePaused() --> "playerID, paused" {{new|83.0}}

PlayerAdded() --> "playerID" {{new|83.0}}

PlayerRemoved() --> "playerID, reason" {{new|83.0}}

==Projectiles:==

ProjectileCreated() --> "proID, proOwnerID, weaponDefID"
 Only called for weaponDefIDs registered via Script.SetWatchWeapon

ProjectileDestroyed() --> "proID"
 Only called for weaponDefIDs registered via Script.SetWatchWeapon

[[Category:Lua]]

LuaCallinReturn

2013-08-25T16:57:39Z

Kingraptor:

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

==Engine Source==
If you can understand Lua code well and wish to get the most up to date info, you can refer to:
{{sourcelink|file=cont/base/springcontent/LuaGadgets/actions.lua}},
{{sourcelink|file=cont/LuaUI/widgets.lua}} and 
{{sourcelink|file=cont/base/springcontent/LuaGadgets/gadgets.lua}} 
to see how widget/gadget call-ins are distributed, find call-in and widgetHandler function definitions, see how they are processed and what values should be returned from some call ins
(are these the only files?)

==What is a callin anyway?==
Call-ins are calls from the engine, into the gadget or widget script. In other words, these functions are called when a particular â€œeventâ€ happens.
Some call-in functions can return values to the engine.
===Blocking events with return values===
The call-in functions named '''''Allow'''''XXX can block their event by returning ''false''. 
For example ''AllowUnitTransfer()'' 
<code>return true</code> = allow transfer 
<code>return false</code> = deny transfer

==Commands, general-purpose:==

Initialize() --> none. 
called when widget/gadget gets (re-)loaded.

Shutdown() --> none.

PlayerChanged --> (playerID).
gadget/widget: Use this to check whether a player has become spectator for instance.

LayoutButtons() --> unknown, please document.

ConfigureLayout() --> "command".

CommandNotify() --> "id, params, options", where id = the CommandID

KeyPress() --> "key, mods, isRepeat", where key = keymap, mods = SHIFT, etc.

KeyRelease() --> "key"

MouseMove() --> "x, y, dx, dy, button"

MousePress() --> "x, y, button" 
button parameter values: left - 1, middle - 2, right - 3

MouseRelease() --> "x, y, button" 
Please note that in order to have Spring call MouseRelease, you need to have a MousePress call-in in the same widget that returns true.

MouseWheel() --> "up, value"

IsAbove() --> "x, y" where x,y = screen coordinates.

GetTooltip() --> "x, y" where x,y = screen coordinates. Returns WorldTooltip.

AddConsoleLine() --> "msg, priority"

MapDrawCmd() --> "playerID, cmdType, px, py, pz, labeltext"

AllowCommand() --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag, synced"

CommandFallback() --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag"

CommandsChanged() --> unknown (none?)

AllowUnitCreation() --> "unitDefID, builderID, builderTeam, x, y, z, facing"

AllowUnitTransfer() --> "unitID, unitDefID, oldTeam, newTeam, capture"

AllowUnitBuildStep() --> "builderID, builderTeam, unitID, unitDefID, part"

AllowFeatureCreation() --> "featureDefID, teamID, x, y, z"

AllowFeatureBuildStep() --> unknown, please document.

AllowResourceLevel() --> "teamID, res, level"

AllowResourceTransfer() --> "teamID, res, level"

Update() --> "dt" 
called every screenframe. dt is the time since the last screenframe

DefaultCommand() --> "type,id" 
can return an [[Lua_CMDs|CMD]] to change cursor and command. {{forumlink|topic=26438|title=example usage}}

AllowDirectUnitControl(unitID, unitDefID, unitTeam, playerID) -> allowFpsControl 
''return true'' allows fps mode, ''return false'' blocks it.

==Unit-Specific:==

UnitPreDamaged() --> "unitID, unitDefID, unitTeam, damage, paralyzer, weaponDefID, attackerID, attackerDefID, attackerTeam" (prior to 94.0)

UnitPreDamaged() --> "unitID, unitDefID, unitTeam, damage, paralyzer, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam" (as of 94.0)

UnitDamaged() --> "unitID, unitDefID, unitTeam, damage, paralyzer, weaponDefID, attackerID, attackerDefID, attackerTeam" 
Can overwrite the taken damage by returning a new number value. 

As of 88.0 for both UnitDamaged and UnitPreDamaged:
weaponDefID -1 --> debris collision
weaponDefID -2 --> ground collision
weaponDefID -3 --> object collision
weaponDefID -4 --> fire damage
weaponDefID -5 --> water damage
weaponDefID -6 --> kill damage

UnitExperience() --> "unitID, unitDefID, unitTeam, experience, oldExperience"

Spring.SetExperienceGrade must be called first to determine how often it is called

UnitCreated() --> "unitID, unitDefID, teamID, builderID"

UnitFinished() --> "unitID, unitDefID, teamID"

UnitFromFactory() --> "unitID, unitDefID, unitTeam, factID, factDefID, userOrders"

UnitDestroyed() --> "unitID, unitDefID, teamID, attackerID, attackerDefID, attackerTeamID"

UnitTaken() --> "unitID, unitDefID, unitTeam, newTeam"

UnitGiven() --> "unitID, unitDefID, unitTeam, oldTeam"

UnitIdle() --> "unitID, unitDefID, teamID"

UnitCommand() --> "unitID, unitDefID, unitTeam, cmdID, cmdOpts, cmdParams"

UnitSeismicPing() --> "x, y, z, strength"

UnitEnteredRadar() --> "unitID, unitTeam"

UnitEnteredLos() --> "unitID, teamID"

UnitLeftRadar() --> "unitID, unitTeam"

UnitLeftLos() --> "unitID, unitDefID, teamID"

UnitLoaded() --> "unitID, unitDefID, unitTeam, transportID, transportTeam"

UnitUnloaded() --> "unitID, unitDefID, teamID, transportID"

UnitCloaked() --> "unitID, unitDefID, teamID"

UnitDecloaked)--> "unitID, unitDefID, teamID"

UnitMoveFailed() --> "unitID, unitDefID, unitTeam"

Only called for unitDefIDs registered via [[Lua_System#Synced|Script.SetWatchUnit]] since 85.0

StockpileChanged() --> "unitID, unitDefID, unitTeam, weaponNum, oldCount, newCount"

UnitEnteredWater() --> "unitID, unitDefID, teamID"

UnitEnteredAir() --> "unitID, unitDefID, teamID"

UnitLeftWater() --> "unitID, unitDefID, teamID"

UnitLeftAir() --> "unitID, unitDefID, teamID"

ShieldPreDamaged() --> "proID, proOwnerID, shieldEmitterWeaponNum, shieldCarrierUnitID, bounceProjectile"

UnitUnitCollision(colliderID, collideeID) -- needs SetWatchUnit enabled for both parties

AllowWeaponTargetCheck(attackerID, attackerWeaponNum, attackerWeaponDefID)
{{new|83.0}}

Only called for weaponDefIDs registered via [[Lua_System#Synced|Script.SetWatchWeapon]] since 92.0

AllowWeaponTarget(attackerID, targetID, attackerWeaponNum, attackerWeaponDefID, defaultPriority)
--> <code>return "targetAllowed, targetPriority"</code>
{{new|83.0}}, defaultPriority new in 89.0 

Only called for weaponDefIDs registered via [[Lua_System#Synced|Script.SetWatchWeapon]] since 92.0

DrawShield(number unitID, number weaponID) --> boolean

''true'' (<-?) skips Spring's own drawing of shield <weaponID> owned by unit <unitID>

[https://github.com/spring/spring/commit/7bbfd9464d4f74c12163ea0740c8c60d1ba978f1 maybe new in 86.0+]

==Feature-Specific:==

FeatureCreated() --> "featureID, allyTeam"

FeatureDestroyed() --> "featureID, allyTeam"

TerraformComplete() --> "unitID, unitDefID, unitTeam, buildUnitID, buildUnitDefID, buildUnitTeam"

UnitCmdDone() --> "unitID, unitDefID, unitTeam, cmdID, cmdTag"

UnitFeatureCollision(colliderID, collideeID, crushKilled) -- needs SetWatchUnit for first and SetWatchFeature for second party

==Drawing:==
Inside these functions, you can use the [[Lua_OpenGL_Api | Lua OpenGL Api]] to draw graphics.

* DrawGenesis() --> none. Don't render here.

Spring draws the sky, the map, some water types, and unit selection.

* DrawWorldPreUnit() --> none.

Spring draws units, features, some water types, cloaked units, and the sun.

* DrawWorld() --> none.

Spring draws command queues, 'map stuff', and map marks.

Each unit might also have a DrawUnit call, [[Lua_UnitRendering|enabled here.]]

DrawUnit(unitID,DrawMode) 
With enum DrawMode { 
notDrawing = 0, 
normalDraw = 1, 
shadowDraw = 2, 
reflectionDraw = 3, 
refractionDraw = 4 
};

DrawFeature(featureID, DrawMode) 

DrawShield(unitID, weaponID, DrawMode) 

DrawProjectile(projectileID, DrawMode) 

DrawScreenEffects() --> "vsx, vsy" where vsx, vsy are screen coords.

DrawScreen() --> none.

DrawInMiniMap() --> "sx, sy" where sx,sy are values relative to the minimap's position and scale.

DrawWorldShadow() --> none.

DrawWorldReflection() --> none.

DrawWorldRefraction() --> none.

==Game Events:==

GameID() --> "gameID" {{new|89.0}}

Explosion() --> "weaponID, px, py, pz, ownerID"

ShockFront() --> "power, dx, dy, dz"

GameFrame() --> "frameNum"

CobCallback() --> unknown, marked FIXME.

GroupChanged() --> "groupID" where groupID is the value of Group whose table value changed.

WorldTooltip() --> "ttType, data1, data2, data3" special, should be documented in detail.

GamePreload() --> none.

GameStart() --> none.

GameProgress() --> "serverFrameNum" ( called every 60 frames, calculating delta between GameFrame and GameProgress can give an ETA about catching up with simulation ) New in 0.83.x

GameOver() --> "[ [1] = allyTeamID1, [2] = allyTeamID2, ... ]", a list of winning allyteams, if empty the game result was undecided ( like when dropping from an host ) Will return nil in pre 0.83.x

TeamDied() --> "TeamID" where TeamID = the team that has been eliminated.

AllowStartPosition() --> x,y,z, playerID

return true/false to allow/deny placing startposition marker

GameSetup()
 --> string "state", boolean "ready", table "playerStates"

return success, newReady

GamePaused() --> "playerID, paused" {{new|83.0}}

PlayerAdded() --> "playerID" {{new|83.0}}

PlayerRemoved() --> "playerID, reason" {{new|83.0}}

==Projectiles:==

ProjectileCreated() --> "proID, proOwnerID, weaponDefID"
 Only called for weapons with SetWatchWeapon enabled

ProjectileDestroyed() --> "proID"
 Only called for weapons with SetWatchWeapon enabled

[[Category:Lua]]

Gamedev:PublicRepos

2013-08-19T17:47:23Z

Kingraptor: /* Known Repos */

==What Is This?==
This is a small collection of publicly known and readable code repositories for established Spring games. The intention being to provide a wealth of examples to all game developers from noob to pro.

== Known Repos ==
[https://code.google.com/p/air-raid-spring/ Air Raid]

[http://imolarpg.dyndns.org/trac/balatest/browser/trunk/ Balanced Annihilation]

[https://sourceforge.net/p/mwspring/code/ BattleTech: Legacy]

[http://code.google.com/p/conflictterra/source/browse/#svn%2Fgames%2FCT Conflict Terra]

[https://code.google.com/p/evolutionrts/source/browse/#svn%2Ftrunk%2Fevolutiondev.sdd Evolution RTS]

[https://github.com/imperialwinter/swiw.sdd Imperial Winter]

[https://sourceforge.net/p/spring1944/code/HEAD/tree/trunk/S44Main.sdd/ Spring: 1944]

[https://code.google.com/p/springtanks/source/browse/#svn%2Ftrunk Spring Tanks]

[http://code.google.com/p/springtutorialgame/source/browse/#svn%2Ftrunk%2FSpringTutorialGame.sdd Spring Tutorial Game]

[https://github.com/KingRaptor/THIS THIS]

[http://code.google.com/p/zero-k/source/browse/trunk#trunk%2Fmods%2Fzk Zero-K]

[[Category:Game Dev]]

Gamedev:PublicRepos

2013-08-19T17:01:49Z

Kingraptor: /* Known Repos */

==What Is This?==
This is a small collection of publicly known and readable code repositories for established Spring games. The intention being to provide a wealth of examples to all game developers from noob to pro.

== Known Repos ==
[https://code.google.com/p/air-raid-spring/ 'Air Raid' Repo]

[http://imolarpg.dyndns.org/trac/balatest/browser/trunk/ 'Balanced Annihilation' Repo]

[https://sourceforge.net/p/mwspring/code/ 'BattleTech: Legacy' Repo]

[http://trac.caspring.org/browser/trunk/mods/ca/ 'Complete Annihilation' Repo]

[http://code.google.com/p/conflictterra/source/browse/#svn%2Fgames%2FCT 'Conflict Terra' Repo]

[https://code.google.com/p/evolutionrts/source/browse/#svn%2Ftrunk%2Fevolutiondev.sdd 'Evolution RTS' Repo]

[https://github.com/imperialwinter/swiw.sdd 'Imperial Winter' Repo]

[https://sourceforge.net/p/spring1944/code/HEAD/tree/trunk/S44Main.sdd/ 'Spring: 1944' Repo]

[http://code.google.com/p/springtutorialgame/source/browse/#svn%2Ftrunk%2FSpringTutorialGame.sdd 'Spring Tutorial Game' Repo]

[http://code.google.com/p/zero-k/source/browse/trunk#trunk%2Fmods%2Fzk 'ZeroK' Repo]

[[Category:Game Dev]]

Gamedev:WeaponDefs

2013-08-18T13:10:13Z

Kingraptor: /* damage */

==Location==
WeaponDef files are .lua files stored in the <code>Weapons/</code> directory of a Spring Game. Alternatively they can be integrated into [[Units-UnitDefs|UnitDefs]].

==Purpose==
WeaponDef files have one purpose; to define the properties of weapons. They are the main description file for what attributes your weapon should have and how it should behave.

==Source==
The engine source code which loads the tags from these files is viewable here:

* {{sourcelink|file=rts/Sim/Weapons/WeaponDef.cpp}}

==Data Types==
Tags may be one of the following data types:
* <code>int</code> - An integer number
* <code>float</code> - A number with decimals.
* <code>bool</code> - A value which can be <code>true</code> or <code>false</code>.
* <code>string</code> - Text, or more precisely a string of alphanumeric characters.
* <code>float[3]</code> - A vector, with three <code>float</code> components, representing x, y and z axes (y is 'up').

==Details==
There follows a comprehensive (certain deprecated tags are not present) list of the tags available, their data type, default value and a brief description of what they do. Bear in mind that the source code linked above is the ultimate reference when dealing with these tags.

In lua tables keys (i.e. the tags) should be lower case, here they are represented in camelCase for readability. In your files you may use the <code>lowerkeys</code> function on your final table to ensure the keys are properly cased.

It is usual to name the returned WeaponDef table the internal <code>weaponName</code> desired for the weapon.

===Common===
The following tags are common to all or at least a majority of '''WeaponTypes''', depending on the tag.

====General====
{{tag
|name = weaponType
|type = string
|default = "Cannon"
|description = Spring has 14 '''WeaponTypes''' which provide game developers with basic behaviours which they can customise to an extent with the '''WeaponDef''' tags. Some tags are specific to certain '''WeaponTypes''' and not implemented for others, [https://docs.google.com/spreadsheet/ccc?key=0Am5BbZxm93S9dEZXc1Q4dXR4TFRYTFM4NlR4OFJFdWc#gid=0 this two-way table] indicates which tags work for which types.}} The possible values are:
* [[#AircraftBomb|AircraftBomb]]
* [[#BeamLaser|BeamLaser]]
* [[#Cannon|Cannon]]
* [[#DGun|Dgun]]
* [[#EmgCannon|EmgCannon]]
* [[#Flame|Flame]]
* [[#LaserCannon|LaserCannon]]
* [[#LightningCannon|LightningCanon]]
* [[#Melee|Melee]]
* [[#MissileLauncher|MissileLauncher]]
* [[#Rifle|Rifle]]
* [[#Shield (WeaponType)|Shield]]
* [[#StarburstLauncher|StarburstLauncher]]
* [[#TorpedoLauncher|TorpedoLauncher]]

{{tag
|name = name
|type = string
|default = "Weapon"
|description = The descriptive name of the weapon as listed in FPS mode.}}

{{tag
|name = turret
|type = bool
|default = false
|description = Does the unit aim within an arc (up-to and including full 360Â° turret traverse) or always aim along the owner's heading?}}

{{tag
|name = noSelfDamage
|type = bool
|default = false
|description = Can the weapon's explosion damage the unit which fires it? Useful for preventing bombers with high-yield weapons destroying themselves.}}

{{tag
|name = impactOnly
|type = bool
|default = false
|description = Does the weapon only deal damage through direct hits and not 'splash' damage through {{taglink|areaOfEffect}}?}}

{{tag
|name = noExplode
|type = bool
|default = false
|description = Does the weapon explode on impact with a target or continue through? Note that these weapons will do damage every single frame they are inside the [[Unit_collision_volumes|collision volume]] of an object, underground or under water, massively multiplying their damage.}}

{{tag
|name = burnblow
|type = bool
|default = false
|description = Does the weapon explode when it reaches its maximum range or continue on its path? The name is an [[OTAism]].}}

{{tag
|name = range
|type = float
|default = 10.0
|description = The maximum range in [[elmo]]s that the weapon can fire at.}}

{{tag
|name = weaponVelocity
|type = float
|default = 0.0
|description = The velocity in [[elmo]]s per second of the weapon projectile.}}

{{tag
|name = reloadTime
|type = float
|default = 1.0
|description = The time in seconds between shots fired.}}

{{tag
|name = metalPerShot
|type = float
|default = 0.0
|description = 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 {{taglink|stockpile}} weapon will cost to build.}}

{{tag
|name = energyPerShot
|type = float
|default = 0.0
|description = Energy used per shot. If the specified amount is not available, the weapon cannot be fired. Can also be used to specify how much a {{taglink|stockpile}} weapon will cost to build.}}

{{tag
|name = myGravity
|type = float
|default = 0.0
|description = Overrides the map gravity for ballistic weapons. The default of <code>0.0</code> disables the tag in favour of map gravity.}}

{{tag
|name = fireStarter
|type = float
|default = 0.0
|description = The percentage chance (<code>0.0</code> to <code>100.0</code>) of the weapon setting fire to static map features on impact.}}

{{tag
|name = cameraShake
|type = float
|default = damage (0.0 for paralyzers)
|description = Passed to the [[LuaCallinReturn#Game_Events:|ShockFront() callin]] as the first argument. Intended as a means to make the camera shake if in range of detonation.}}

{{tag
|name = stockpile
|type = bool
|default = false
|description = Does each round of the weapon have to be built and stockpiled by the player? Will only correctly function for the first of each stockpiled weapons a unit has.}}

{{tag
|name = stockpileTime
|type = float
|default = reloadTime
|description = The time in seconds taken to stockpile one round of the weapon.}}

{{tag
|name = interceptedByShieldType
|type = int
|default = 0 (See description)
|description = [http://en.wikipedia.org/wiki/Mask_(computing) Bitmask] representing the types of shields that can intercept this weapon. Each digit of binary that is set to one means that a shield with the corresponding digit in its {{taglink|interceptType}} will intercept this weapon. The defaults are as follows:
* <code>1</code> - [[#Cannon]] and [[#EmgCannon]]
* <code>2</code> - [[#LaserCannon]] and [[#BeamLaser]]
* <code>4</code> - [[#MissileLauncher]] and [[#StarburstLauncher]]
* <code>8</code> - [[#AircraftBomb]]
* <code>16</code> - [[#Flame]]
* <code>32</code> - [[#TorpedoLauncher]]
* <code>64</code> - [[#LightningCannon]]
* <code>128</code> - [[#Rifle]]
* <code>256</code> - [[#Melee]]
(See [[Shield Interception Tag Use]]).}}

====Collision & Avoidance====

{{tag
|name = avoidGround
|type = bool
|default = true
|description = Should the weapon avoid firing if terrain blocks the line of fire?}}

{{tag
|name = avoidFriendly
|type = bool
|default = true
|description = Should the weapon avoid firing if a friendly unit is in the line of fire?}}

{{tag
|name = avoidFeature
|type = bool
|default = true
|description = Should the weapon avoid firing if a static map feature is in the line of fire?}}

{{tag
|name = avoidNeutral
|type = bool
|default = false
|description = Should the weapon avoid firing if a neutral unit is in the line of fire?}}

{{tag
|name = collideEnemy
|type = bool
|default = true
|description = Does the weapon projectile collide with enemy units or pass through?}}

{{tag
|name = collideFriendly
|type = bool
|default = true
|description = Does the weapon projectile collide with friendly units or pass through?}}

{{tag
|name = collideFeature
|type = bool
|default = true
|description = Does the weapon projectile collide with static map features or pass through?}}

{{tag
|name = collideNeutral
|type = bool
|default = true
|description = Does the weapon projectile collide with neutral units or pass through?}}

{{tag
|name = collideGround
|type = bool
|default = true
|description = Does the weapon projectile collide with terrain or pass through?}}

{{tag
|name = collisionSize
|type = float
|default = 0.05 (0.5 for [[#Flame]] and [[#LaserCannon]], 10.0 for [[#Dgun]])
|description = The radius used in collision calculations. For non-instant-hit weapons which do not use a 3D {{taglink|model}}.}}

====Targeting & Accuracy====
{{tag
|name = commandFire
|type = bool
|default = false
|description = Determines if the weapon will automatically fire on enemy units in range or only when manually ordered to attack.}}

{{tag
|name = canAttackGround
|type = bool
|default = true
|description = Determines if the weapon can be force-fired on ground positions or only fire on targeted units.}}

{{tag
|name = waterWeapon
|type = bool
|default = false
|description = Determines if the weapon can pass through water and target underwater units.}}

{{tag
|name = fireSubmersed
|type = bool
|default = waterWeapon
|description = Determines if the weapon can fire whilst underwater.}}

{{tag
|name = targetBorder
|type = float
|default = 0.0 (1.0 for [[#Melee]])
|description = Controls whether the weapon aims for the centre or the edge of its target's [[Unit_collision_volumes|collision volume]]. Clamped between <code>-1.0</code> - target the far border, and <code>1.0</code> - target the near border.}}

{{tag
|name = cylinderTargeting
|type = float
|default = 0.0 (1.0 for [[#Melee]])
|description = Controls whether the weapon range is calculated in a sphere or a cylinder. The height of the cylinder is determined by the value of this tag multiplied by the {{taglink|range}}. Clamped between <code>0.0</code> and <code>128.0</code>.}}

{{tag
|name = tolerance
|type = float
|default = 3000.0
|description = 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. For {{taglink|turret|false}} or {{taglink|fixedlauncher|true}} weapons this determines in what arc the unit will fire.}}

{{tag
|name = targetMoveError
|type = float
|default = 0.0
|description = 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.}}

{{tag
|name = leadLimit
|type = float
|default = -1.0
|description = Limits the maximum distance a unit will lead a target. The default of <code>-1</code> allows an infinite distance.}}

{{tag
|name = leadBonus
|type = float
|default = 0.0
|description = Controls how experience boosts the weapon's target leading. Is multiplied with the unit's experience and added to the {{taglink|leadLimit}}.}}

{{tag
|name = predictBoost
|type = float
|default = 0.0 (0.5 for {{taglink|burnblow|true}} weapons)
|description = Controls how well the weapon predicts unit speeds. Works in a similar way to {{taglink|targetMoveError}} except that it is 1-dimensional. This tag spreads the shots in a line based on the direction of the target whereas {{taglink|targetMoveError}} spreads the shots all around based on the movement.}}

{{tag
|name = heightMod
|type = float
|default = 0.2 (0.8 for [[#Cannon]], 1.0 for [[#BeamLaser]] and [[#LightningCannon]])
|description = Changes the spherical weapon range into an ellipsoid. Values above <code>1.0</code> mean the weapon cannot target as high as it can far, values below <code>1.0</code> mean it can target higher than it can far. For example <code>0.5</code> would allow the weapon to target twice as high as far.}}

{{tag
|name = proximityPriority
|type = float
|default = 1.0
|description = Acts as a multiplier for the distance to the target in the priority calculation. Note that negative values make weapons prefer distant targets.}}

{{tag
|name = accuracy
|type = float
|default = 0.0
|description = How accurate the weapon is. Lower values are more accurate. Accuracy is relative to the distance to the target; for instance, if the target is very close, even a very high value will probably still hit. If a target is very far away, even a very low value will likely cause the weapon to miss.}}

{{tag
|name = movingAccuracy
|type = float
|default = accuracy
|description = A weapon's {{taglink|accuracy}} whilst the owning unit is moving.}}

{{tag
|name = sprayAngle
|type = float
|default = 0.0
|description = How wide the the angle of a burst from a [[#Bursts|burst weapon]] can be. Very similar to {{taglink|accuracy}}, except that this tag affects each projectile in a burst, whilst the former does not.}}

{{tag
|name = ownerExpAccWeight
|type = float
|default = 0.0 (See description)
|description = A multiplier to {{taglink|accuracy}} and {{taglink|sprayAngle}} that reduces inaccuracy as a units experience increases. Defaults are as follows:
* <code>0.9</code> - [[#Cannon]], [[#Rifle]]
* <code>0.7</code> - [[#LaserCannon]], [[#BeamLaser]], [[#StarburstLauncher]]
* <code>0.5</code> - [[#MissileLauncher]], [[#LightningCannon]], [[#EmgCannon]], [[#DGun]]
* <code>0.2</code> - [[#Flame]]
}}

{{tag
|name = targetable
|type = int
|default = 0
|special = {{new|92.0}} Previously only for [[#StarburstLauncher]]
|description = [http://en.wikipedia.org/wiki/Mask_(computing) Bitmask] representing the types of weapon that can intercept this weapon. Each digit of binary that is set to one means that a weapon with the corresponding digit in its {{taglink|interceptor}} tag will intercept this weapon. Instant-hitting weapons such as [[#BeamLaser]], [[#LightningCannon]] and [[#Rifle]] cannot be targeted.
}}

{{tag
|name = interceptor
|type = int
|default = 0
|special = {{new|92.0}} Previously only for [[#StarburstLauncher]]
|description = [http://en.wikipedia.org/wiki/Mask_(computing) Bitmask] representing the types of weapons that this weapon can intercept. Each digit of binary that is set to one means that a weapon with the corresponding digit in its {{taglink|targetable}} tag will be intercepted by this weapon.
}}

{{tag
|name = interceptSolo
|type = bool
|default = true
|special = {{new|92.0}}
|description = If <code>true</code> no other interceptors may target the same projectile.
}}

{{tag
|name = coverage
|type = float
|default = 0.0
|special = {{new|92.0}} Previously only for [[#StarburstLauncher]]
|description = The radius in [[elmo]]s within which an {{taglink|interceptor}} weapon will fire on {{taglink|targetable}} weapons.
}}

====Bouncing====

{{tag
|name = waterBounce
|type = bool
|default = false
|description = Does the weapon bounce on water impacts?}}

{{tag
|name = groundBounce
|type = bool
|default = false
|description = Does the weapon bounce on ground impacts?}}

{{tag
|name = bounceSlip
|type = float
|default = 1.0
|description = The decimal-percentage amount of horizontal velocity a projectile keeps when it bounces.}}

{{tag
|name = bounceRebound
|type = float
|default = 1.0
|description = The decimal-percentage amount of vertical velocity a projectile keeps when it bounces.}}

{{tag
|name = numBounce
|type = int
|default = -1
|description = The number of times the weapon will bounce on impact before exploding. The default value of <code>-1</code> allows infinite bounces (at least until velocity reaches 0).}}

====Area Of Effect, Impulse & Cratering====

{{tag
|name = areaOfEffect
|type = float
|default = 8.0 * 0.5
|description = The ''diameter'' in [[elmo]]s in which the weapons explosion will cause damage.}}

{{tag
|name = craterAreaOfEffect
|type = float
|default = areaOfEffect * 0.5
|description = The ''radius'' in [[elmo]]s in which the weapons explosion will cause terrain cratering.}}

{{tag
|name = edgeEffectiveness
|type = float
|default = 0.0
|description = Determines what percent of a weapon's maximum damage value will be applied to units within the weapon's {{taglink|areaOfEffect}}. Falls off from the epicentre according to the formula <code>damageApplied = damage * [(areaOfEffect - distToUnit) / (areaOfEffect - (distToUnit * edgeEffectiveness))]</code>, a graph of the function for various values is available [[Media:EdgeEffectiveness.png|here]].}}

{{tag
|name = explosionSpeed
|type = float
|default = See description
|description = The speed at which the weapon's explosion propagates from the epicentre. The default is calculated by this complex formula: <code>defExpSpeed = {8.0 + [max(30.0, default_damage / 20.0) * 2.5]} / {9.0f + [sqrt(max(30.0, default_damage / 20.0f)) * 0.7]} * 0.5</code>.}}

{{tag
|name = impulseFactor
|type = float
|default = 1.0
|description = A multiplier to the impulse given to units within the explosion {{taglink|areaOfEffect}}, which is otherwise equal to the damage dealt after {{taglink|edgeEffectiveness}} is taken into account. For [[#Melee]] weapons this is instead multiplied by the owning unit's mass (See [[Units-UnitDefs#Tag:mass|Units-UnitDefs]]).}}

{{tag
|name = impulseBoost
|type = float
|default = 0.0
|description = A constant amount added to the weapon's impulse, regardless of distance from the epicentre or the damage potential of the explosion, prior to the application of {{taglink|impulseFactor}}}}

{{tag
|name = craterMult
|type = float
|default = impulseFactor
|description = A multiplier to depth of terrain crater the weapon's explosion will create, which is otherwise based on the damage potential.}}

{{tag
|name = craterBoost
|type = float
|default = 0.0
|description = A constant amount, added to the weapon's cratering depth before the application of {{taglink|craterMult}}.}}

====Bursts====

{{tag
|name = burst
|type = int
|default = 1
|description = How many shots to fire per burst.
}}

{{tag
|name = burstRate
|type = float
|default = 0.1
|description = The time in seconds between shots in a burst. Note that {{taglink|reloadTime}} starts to count down from the ''first'' round fired, not the last so if <code>reloadTime < burst * burstRate</code> the weapon will fire continuously.
}}

{{tag
|name = projectiles
|type = int
|default = 1
|description = How many projectiles released per shot (shotgun style). e.g. a weapon with {{taglink|burst|5}}, {{taglink|burstRate|0.5}} and {{taglink|projectiles|2}} will shoot 5 lots of 2 for 10 projectiles total, with gaps of 0.5 seconds, before waiting for {{taglink|reloadTime}}. Best used in conjunction with {{taglink|sprayAngle}} or changing the firing piece using [[Animation-LuaCallins#Weapons|ShotX]] as otherwise they'll all be clumped in one shot.
}}

====Paralyzing====
{{tag
|name = paralyzer
|type = bool
|default = false
|description = Is the weapon a paralyzer? If <code>true</code> the weapon only stuns enemy units and does not cause damage in the form of lost hit-points.
}}

{{tag
|name = paralyzeTime
|type = int
|default = 10
|description = Determines the maximum length of time in seconds that the target will be paralyzed. The timer is restarted every time the target is hit by the weapon. Cannot be less than <code>0</code>.
}}

====Dynamic Damage====
The following set of tags allow for a weapon's damage potential to vary with the distance to its target.

{{tag
|name = dynDamageExp
|type = float
|default = 0.0
|description = Exponent of the range-dependent damage formula, the default of <code>0.0</code> disables dynamic damage, <code>1.0</code> means linear scaling, <code>2.0</code> quadratic and so on.
}}

{{tag
|name = dynDamageMin
|type = float
|default = 0.0
|description = The minimum floor value that range-dependent damage can drop to.
}}

{{tag
|name = dynDamageRange
|type = float
|default = 0.0
|description = If set to non-zero values the weapon will use this value in the range-dependant damage formula instead of the actual {{taglink|range}}.
}}

{{tag
|name = dynDamageInverted
|type = bool
|default = false
|description = If <code>true</code> the damage curve is inverted i.e. the weapon does more damage at greater ranges as opposed to less.
}}

====Sounds====
{{tag
|name = soundTrigger
|type = bool
|default = false (true for [[#Melee]], [[#Rifle]] and non-beamBurst [[#BeamLaser]])
|description = Does the weapon play {{taglink|soundStart}} for every round in a burst or only once for each salvo?}}

{{tag
|name = soundStart
|type = string
|default = ""
|description = The name of a '''SoundItem''' (See [[Sounds.lua]]) or filename of a sound to play when the weapon fires.}}

{{tag
|name = soundHitDry
|type = string
|default = ""
|description = The name of a '''SoundItem''' (See [[Sounds.lua]]) or filename of a sound to play when the weapon collides with solid ground. Note that a [[#BeamLaser]] will play this sound every frame of its lifetime.}}

{{tag
|name = soundHitWet
|type = string
|default = ""
|description = The name of a '''SoundItem''' (See [[Sounds.lua]]) or filename of a sound to play when the weapon collides with water. Note that a [[#BeamLaser]] will play this sound every frame of its lifetime.}}

====Visuals====

{{tag
|name = cegTag
|type = string
|default = ""
|description = The name, without prefixes, of a [[CEG]] to be emitted by the projectile each frame.
}}

{{tag
|name = intensity
|type = float
|default = 0.9 (0.2 for [[#Cannon]])
|description = Alpha transparency for non-3D model projectiles. Lower values are more opaque, but <code>0.0</code> will cause the projectile to disappear entirely.
}}

{{tag
|name = model
|type = string
|default = ""
|description = The filename of a 3D model to use when rendering the projectile. Note that only the root piece of a projectile model is rendered. Currently only for [[#Cannon]], [[#LaserCannon]], [[#MissileLauncher]], [[#StarburstLauncher]] and [[#TorpedoLauncher]].
}}

{{tag
|name = explosionScar
|type = bool
|default = false
|description = Does the weapon's explosion leave a scar decal on the ground? For all types except [[#Melee]] and [[#Rifle]].
}}

{{tag
|name = alwaysVisible
|type = bool
|default = false
|description = If <code>true</code> the weapon is always rendered regardless of whether or not it is in LOS range of a player's units.
}}

{{tag
|name = rgbColor
|type = float[3]
|default = {1.0, 0.0, 0.0} (See Description)
|description = The primary colour for sprite rendering weapons. Additional defaults are as follows:
* [[#Cannon]] - <code>{1.0, 0.5, 0.0}</code>
* [[#EmgCannon]] - <code>{0.9, 0.9, 0.2}</code>
}}

{{tag
|name = explosionGenerator
|type = string
|default = ""
|description = The name of a [[CEG]], with <code>custom:</code> prefix, to spawn as the weapon's explosion. Does not currently work for [[#Melee]] and [[#Rifle]].
}}

{{tag
|name = bounceExplosionGenerator
|type = string
|default = ""
|description = For weapons which can use {{taglink|groundBounce|true}}, the name of a [[CEG]], with <code>custom:</code> prefix, to spawn when weapon the bounces.
}}

{{tag
|name = texture1
|type = string
|default = ""
|description = The projectile texture for [[#AircraftBomb]], [[#Cannon]], [[#EmgCannon]], [[#Flame]]; beam texture for [[#LaserCannon]], [[#BeamLaser]], [[#LightningCannon]]; flare texture for [[#MissileLauncher]], [[#StarburstLauncher]] and dome texture for the [[#Shield]].
}}

{{tag
|name = texture2
|type = string
|default = ""
|description = The end-of-beam texture for [[#LaserCannon]], [[#BeamLaser]] and {{taglink|smoketrail}} texture for [[#MissileLauncher]], [[#StarburstLauncher]].
}}

{{tag
|name = texture3
|type = string
|default = ""
|description = Flare texture for [[#BeamLaser]], or muzzle texture if {{taglink|largeBeamLaser|true}}. Also used as the flame texture for [[#StarburstLauncher]].
}}

{{tag
|name = texture4
|type = string
|default = ""
|description = Flare texture for [[#BeamLaser]] with {{taglink|largeBeamLaser|true}}.
}}

===AircraftBomb===
Drops a ballistic projectile at the same movement vector as the unit itself. Intended only for aircraft. Visually drawn as a billboarded sprite as used by the [[#Cannon]], but more commonly used with a 3D model.

There are no tags specific to this '''WeaponType'''

====AircraftBomb Visuals====

When not using a {{taglink|model}}, the AircraftBomb is the same as [[#Cannon Visuals]].

===BeamLaser===
An instant-hit weapon which spawns a beam and does a portion of its total damage each frame. Cannot be [[Animation-LuaCallouts#Effects|script emitted]] if it has a {{taglink|beamTime}} longer than one frame. Visually drawn as a [http://en.wikipedia.org/wiki/Star_Trek Star Trek] Phaser-style laser weapon. The {{taglink|largeBeamLaser}} tag allows changing the visual effect of the laser, such as using a tileable, scrolling texture without changing the behaviour.

{{tag
|name = minIntensity
|type = float
|default = 0.0
|description = The minimum percentage the weapon's damage can fall-off to over its range. Setting to <code>1.0</code> will disable fall off entirely. Unrelated to the visual-only {{taglink|intensity}} tag.
}}

{{tag
|name = beamTime
|type = float
|default = 1.0
|description = How long in seconds to fire the laser before waiting for {{taglink|reloadTime}} to start. Damage is distributed over the duration of the {{taglink|beamTime}}, and the weapon will aim to hit the target when the beam is in the middle of its {{taglink|beamTime}} (i.e. using prediction).
}}

{{tag
|name = beamBurst
|type = bool
|default = false
|description = Makes the laser fire a burst of beams that are all aimed towards the target (instead of aimed with the piece). A [[#BeamLaser]] can do its full damage with every shot if {{taglink|beamBurst}} is enabled. Disables {{taglink|beamTime}} in favour of the [[#Bursts|burst tags]].
}}

{{tag
|name = sweepFire
|type = bool
|default = false
|description = Makes the laser continue firing while it aims for a new target, 'sweeping' across the terrain. Somewhat unreliable.
}}

====BeamLaser Visuals====

See also {{taglink|thickness}} and {{taglink|coreThickness}}.

{{tag
|name = beamTTL
|type = int
|default = 0
|description = The time in frames for which the laser beam remains visible.
}}

{{tag
|name = beamDecay
|type = float
|default = 1.0
|description = How fast the beam fades out. Each frame the {{taglink|intensity}} is multiplied by this value.
}}

{{tag
|name = laserFlareSize
|type = float
|default = 15.0
|description = Determines the size of the firing flare.
}}

{{tag
|name = largeBeamLaser
|type = bool
|default = false
|description = Changes the visual effect allowing tiling and scrolling of the texture and a pulsating firing flare.
}}

{{tag
|name = tileLength
|type = float
|default = 200.0
|description = Defines the length before the texture used is repeated (tiled). Only if {{taglink|largeBeamLaser|true}}.
}}

{{tag
|name = scrollSpeed
|type = float
|default = 5.0
|description = Controls how fast the texture scrolls. Only if {{taglink|largeBeamLaser|true}}.
}}

{{tag
|name = pulseSpeed
|type = float
|default = 1.0
|description = Controls how fast the pulsating effect at the start of the beam is. Only if {{taglink|largeBeamLaser|true}}.
}}

===Cannon===
The default '''WeaponType'''. Fires a ballistic projectile, for the best result (without under/overshooting) the {{taglink|weaponVelocity}} should be set so as to give an elevation of 45Â° when firing at the maximum {{taglink|range}}. Substituting the angle into the [http://en.wikipedia.org/wiki/Trajectory#Range_and_height trajectory equation] and rearranging, we get:
<code><pre>weaponVelocity = âˆš(range * g)</pre></code>
where <code>g</code> is the map gravity, usually around <code>120</code> for most Spring maps (You can use the {{taglink|myGravity}} tag if you want to be exact). Visually drawn as a billboarded sprite or 3D model.

{{tag
|name = highTrajectory
|type = int
|default = 2
|description = Can this weapon be fired in a high trajectory (>45Â° angle). Can be <code>0</code> - low trajectory only, <code>1</code> - high trajectory only or <code>2</code> - enables a high/low toggle button on the unit.
}}

{{tag
|name = heightBoostFactor
|type = float
|default = -1.0
|description = Controls the boost given to {{taglink|range}} by high terrain. Values > <code>1.0</code> result in increased range, <code>0.0</code> means the cannon has fixed range regardless of height difference to target. Any value < <code>0.0</code> (i.e. the default value) result in an automatically calculated value based on {{taglink|range}} and theoretical maximum range.
}}

====Cannon Visuals====

{{tag
|name = size
|type = float
|default = 2.0 + min(default_damage * 0.0025, {{taglink|areaOfEffect}} * 0.1)
|description = The drawing radius of the billboarded sprite. Also for [[#AircraftBomb Visuals]], [[#EmgCannon Visuals]] (default: <code>3.0</code>) and [[#Flame Visuals]].
}}

{{tag
|name = colorMap
|type = string
|default = ""
|description = A set of RGB colours to transition between over the projectile's lifetime. Can be given as a string of RGB digits or an image filename (See [[CColorMap]]). Also for [[#Flame Visuals]].
}}

{{tag
|name = sizeDecay
|type = float
|default = 0.0
|description = How quickly each particle of the Cannon shot decays in size.
}}

{{tag
|name = alphaDecay
|type = float
|default = 1.0
|description = How quickly each particle of the Cannon shot fades out.
}}

{{tag
|name = separation
|type = float
|default = 0.0
|description = The distance between each particle of the Cannon shot.
}}

{{tag
|name = noGap
|type = bool
|default = true
|description = Switch between the distance between particles being proportional to the size of the two particles (<code>true</code>) or proportional to the size of the first particle (<code>false</code>).
}}

{{tag
|name = stages
|type = int
|default = 5
|description = The number of particles in each Cannon shot.
}}

===DGun===
Fires a line-of-sight or ballistic projectile (selected via the {{taglink|gravityAffected}} tag). Visually represented by a fireball effect that cannot be customised, however it can be replaced by a 3D model. The name and visual effect are [[OTAism]]s.

{{tag
|name = gravityAffected
|type = bool
|default = false
|description = Does the fireball projectile lose height due to map gravity?
}}

===EmgCannon===
A line-of-sight weapon. Visually drawn as a billboarded sprite very similar to that of the [[#Cannon]], however not as customisable, or a 3D model. The name is another [[OTAism]].

There are no tags specific to this '''WeaponType'''.

===Flame===
A line-of-sight weapon intended for use as a flamethrower or similar. Visually drawn as a stream of textured particles, the colour of which can be controlled very precisely using the {{taglink|colorMap}} tag (see [[CColorMap]]).

====Flame Visuals====
See also {{taglink|colorMap}}.

{{tag
|name = sizeGrowth
|type = float
|default = 0.5
|description = How much the draw radius of the flame projectile increases each frame.
}}

{{tag
|name = flameGFXTime
|type = float
|default = 1.2
|description = Makes the flamethrower projectile stay alive as a visual-only effect (i.e. does not deal any damage) after it has reached maximum {{taglink|range}}. It is a percentage multiplier, e.g. <code>1.2</code> makes the projectile stay alive until it reaches 20% beyond {{taglink|range}}.
}}

===LaserCannon===
A particularly versatile line-of-sight weapon. Visually drawn like a [http://en.wikipedia.org/wiki/Star_Wars Star Wars] Blaster-style laser weapon, or a 3D model.

====LaserCannon Visuals====

{{tag
|name = duration
|type = float
|default = 0.05
|description = Multiplied against {{taglink|weaponVelocity}} to determine the visual length of the beam projectile.
}}

{{tag
|name = hardStop
|type = bool
|default = false
|description = Does the laser projectile stop dead or fade out?
}}

{{tag
|name = fallOffRate
|type = float
|default = 0.5
|description = Rate at which the beam fades out after it goes past its maximum {{taglink|range}} if {{taglink|hardStop|false}}. A value of <code>0.0</code> is never fade out, <code>1.0</code> is finish fading out exactly at maximum {{taglink|range}}.
}}

{{tag
|name = lodDistance
|type = int
|default = 1000
|description = Minimum camera distance at which the default LaserCannon projectile is simplified to a single rectangle.
}}

{{tag
|name = thickness
|type = float
|default = 2.0
|description = The thickness (width) of the LaserCannon projectile. Also for [[#BeamLaser Visuals]].
}}

{{tag
|name = coreThickness
|type = float
|default = 2.0
|description = The thickness (width) of the LaserCannon projectile's core. Also for [[#BeamLaser Visuals]].
}}

{{tag
|name = rgbColor2
|type = float
|default = {1.0, 1.0, 1.0}
|description = The colour of the LaserCannon projectile's core. Also for [[#BeamLaser Visuals]].
}}

===LightningCannon===
An instant-hit weapon similar to the [[#BeamLaser]], but which does all its damage at once. Visually drawn like [http://en.wikipedia.org/wiki/Star_Wars Star Wars] 'Force Lightning' or [http://en.wikipedia.org/wiki/Command_%26_Conquer:_Red_Alert CnC: Red Alert] [http://en.wikipedia.org/wiki/Tesla_coil Tesla Coil] weapons, the effect is not very customisable.

There are no tags specific to this '''WeaponType'''.

===Melee===
A weapon that always damages the target, no ifs or buts; unsurprisingly intended for use as a close quarters [http://en.wikipedia.org/wiki/Melee#Use_in_gaming 'melee'] weapon. It does not fire a projectile and does not care about the line of fire.

There are no tags specific to this '''WeaponType'''.

===MissileLauncher===
A versatile weapon which can optionally track targets and accelerate from a low initial velocity. It can also use {{taglink|trajectoryHeight}} to have the shot arc similar to a ballistic projectile. Visually represented by a 3D model, with an optional {{taglink|smokeTrail}}.

{{tag
|name = startVelocity
|type = float
|default = 0.0
|description = The initial velocity of the weapon projectile. Also for [[#StarburstLauncher]] and [[#TorpedoLauncher]].
}}

{{tag
|name = acceleration
|type = float
|default = 0.0
|description = The initial acceleration of the weapon projectile. Also for [[#StarburstLauncher]] and [[#TorpedoLauncher]]. Note that if it is <code>0.0</code> the weapon can never increase from its {{taglink|startVelocity}} and will not reach its maximum {{taglink|weaponVelocity}}.
}}

{{tag
|name = tracks
|type = bool
|default = false
|description = Can the weapon projectile track a moving target? Also for [[#StarburstLauncher]] and [[#TorpedoLauncher]].}}

{{tag
|name = turnRate
|type = float
|default = 0.0
|description = The rate (in [[Elmo#Angular|cau]]) at which {{taglink|tracks|true}} weapons turn towards their target. This is relative to a projectile's current velocity; a weapon with a higher velocity will need a higher value in order to be able to hit targets that turn suddenly.}}

{{tag
|name = flightTime
|type = float
|default = 0.0
|description = The time in seconds before a missile projectile's fuel runs out; it ceases to obey {{taglink|tracks}}, loses velocity and falls to the ground. Also for [[#StarburstLauncher]]. Large values may cause over/undershoot problems.
}}

{{tag
|name = fixedLauncher
|type = bool
|default = false
|description = Makes the projectile spawn with the orientation of the shooting piece instead of their normal orientation. Also for [[#StarburstLauncher]] and [[#TorpedoLauncher]]. Weapons may not correctly obey [[#Collision & Avoidance|avoidance settings]] when using this tag.
}}

{{tag
|name = wobble
|type = float
|default = 0.0
|description = Adds a random vector to the direction of travel every 16 frames, multiplied by the value of the tag. The effect is reduced as the firing unit gains experience. As this missiles direction is changed, wobbling swarm of missiles will diverge.
}}

{{tag
|name = dance
|type = float
|default = 0.0
|description = Adds a random vector to the position of a missile projectile every 8 frames, multiplied by the value of the tag. As the projectile is not rotated, a dancing swarm of missiles will remain relatively coherent.
}}

{{tag
|name = trajectoryHeight
|type = float
|default = 0.0
|description = Determines the height of the arc the missile will reach as it moves towards its target. A value of <code>0.0</code> will result in a flat trajectory, <code>1.0</code> will launch at 45°. Can be any value >= <code>0.0</code>; extreme values may require the {{taglink|tracks}} tag to be able to hit a target.
}}

====MissileLauncher Visuals====
A note about the missile exhaust flare: the size of the flare is determined by the model radius. The emit position of the flare is at (0,0,-radius) so the model may need careful adjustment to get the flare looking right.

{{tag
|name = smokeTrail
|type = bool
|default = false
|description = Does the missile projectile emit a smoke trail as it travels? Also for [[#StarburstLauncher]].
}}

===Rifle===
An instant hit weapon which does all its damage at once. Visually represented by a hardcoded tracer, firing and hitting effects. Rarely used.

There are no tags specific to this '''WeaponType'''.

===Shield (WeaponType)===
As the name suggests, not a weapon but a defensive shield. Can absorb or deflect ({{taglink|repulsor|true}}) projectiles. Individual weapons can be set to be intercepted or not by the shield using a [http://en.wikipedia.org/wiki/Mask_(computing) bitmask] (see [[Shield Interception Tag Use]]). Visually represented as a translucent sphere, with control over colour and texture; by default the shield is invisible ({{taglink|visible|false}}).

See the [[#shield]] sub-table section for other tags specific to this type.

===StarburstLauncher===
Fires a projectile that rises vertically for {{taglink|weaponTimer}} seconds, then turns towards its target. It can optionally track targets and accelerate from a low initial velocity. This is the only weapon that can be {{taglink|targetable}} and act as an {{taglink|interceptor}}. Visually represented by a 3D model, with an optional {{taglink|smokeTrail}}.

{{tag
|name = weaponTimer
|type = float
|default = 0.0
|description = The time in seconds during which the missile ascends vertically before turning towards its target.
}}

===TorpedoLauncher===
Fires a projectile that will behave ballistically out of water and like a missile in water. Usually used with {{taglink|waterWeapon|true}} so they can fire underwater and target underwater units. An aircraft carrying a [[#TorpedoLauncher]] is a special case, the weapon turns into an [[#AircraftBomb]] projectile that will spawn a torpedo projectile on impact with water. Visually represented by a pointed black cuboid, usually the default object is replaced by a 3D model.

{{tag
|name = subMissile
|type = bool
|default = false
|description = Can the torpedo leave the water and target units and positions on land?
}}

===NoWeapon===
Not actually a '''WeaponType''', but an individual weapon requested by Spring to 'fill in the gaps' if a unit claims to have a weapon which isn't actually defined. There needs to be only one of these weapons and it is created by setting {{taglink|weaponName|"NOWEAPON"}} rather than by the {{taglink|weaponType}} tag.

==Sub Tables==

===damage===
The damage subtable lists how many hit points the weapon depletes against each armor class (See [[Armordefs.lua]]). It is a key-value map of armor class names and damage values. The special <code>default</code> entry is as the name suggests the default damage applied to any unit which does not belong to a listed armor class, or to shields.

For example a weapon which deals 100 damage by default but only 50 to units in the 'tank' armor class:

<code><pre>damage = {
default = 100,
tank = 50,
}</pre></code>

===shield===
The preferred way to create a shield or repulsor is to use the shield subtable rather than the old shield tags.

The following tags are repulsor specific:

{{tag
|name = repulsor
|type = bool
|default = false
|description = Does the shield [http://dictionary.reference.com/browse/repulse?s=t repulse] (deflect) projectiles or absorb them?}}

{{tag
|name = force
|type = float
|default = 0.0
|description = The force applied by the repulsor to the weapon - higher values will deflect weapons away at higher velocities.}}

{{tag
|name = maxSpeed
|type = float
|default = 0.0
|description = The maximum speed the repulsor will impart to deflected projectiles.}}

{{tag
|name = visibleRepulse
|type = bool
|default = false
|description = Is the (hard-coded) repulse effect rendered or not?}}

The following tags are general behaviour for all shields:

{{tag
|name = interceptType
|type = int
|default = 0
|description = [http://en.wikipedia.org/wiki/Mask_(computing) Bitmask] representing the types of weapons that this shield can intercept. Each digit of binary that is set to one means that a weapon with the corresponding digit in its {{taglink|interceptedByShieldType}} will be intercepted by this shield (See [[Shield Interception Tag Use]]).}}

{{tag
|name = smart
|type = bool
|default = false
|description = Determines whether or not projectiles fired by allied units can pass through the shield (<code>true</code>) or are intercepted as enemy weapons are (<code>false</code>).}}

{{tag
|name = exterior
|type = bool
|default = false
|description = Determines whether or not projectiles fired within the shield's radius can pass through the shield (<code>true</code>) or are intercepted (<code>false</code>).}}

{{tag
|name = energyUse
|type = float
|default = 0.0
|description = The amount of the energy resource consumed by the shield to absorb or repulse weapons, continually drained by a repulsor as long as the projectile is in range.}}

{{tag
|name = radius
|type = float
|default = 0.0
|description = The radius of the circular area the shield covers.}}

{{tag
|name = power
|type = float
|default = 0.0
|description = Essentially the maximum allowed hit-points of the shield - reduced by the <code>damage</code> of a weapon upon impact.}}

{{tag
|name = startingPower
|type = float
|default = 0.0
|description = How many hit-points the shield starts with - otherwise the shield must regenerate from <code>0</code> until it reaches maximum {{taglink|power}}.}}

{{tag
|name = powerRegen
|type = float
|default = 0.0
|description = How many hit-points the shield regenerates each second.}}

{{tag
|name = powerRegenEnergy
|type = float
|default = 0.0
|description = How much energy resource is consumed to regenerate each hit-point.}}

{{tag
|name = rechargeDelay
|type = float
|default = 0.0
|description = The delay in seconds before a shield begins to regenerate after it is hit.}}

The following tags control the visual aspects of the shield:

{{tag
|name = visible
|type = bool
|default = false
|description = Is the shield visible or not?}}

{{tag
|name = visibleHitFrames
|type = int
|default = 0
|description = The number of frames a shield becomes visible for when hit.}}

{{tag
|name = badColor
|type = float[3]
|default = {1.0, 0.5, 0.5} (Red)
|description = The RGB colour the shield transitions to as its hit-points are reduced towards <code>0</code>.}}

{{tag
|name = goodColor
|type = float[3]
|default = {0.5, 0.5, 1.0} (Blue)
|description = The RGB colour the shield transitions to as its hit-points are regenerated towards its maximum {{taglink|power}}.}}

{{tag
|name = alpha
|type = float
|default = 0.2
|description = The alpha transparency of the shield whilst it is visible.}}

===customParams===
The <code>customParams</code> subtable of a WeaponDef allows the game designer to give their weapons custom attributes, which can then be accessed via lua gadgets and widgets. It is a map (key-value pair indexed table) of strings. When accessing these attributes in lua the strings can be turned back into numbers, bools or even tables. This gives great control to game designers to essentially implement their own behaviour tags.

There are no additional tags specific to this subtable

==Examples==
[http://imolarpg.dyndns.org/trac/balatest/browser/trunk/weapons 'Balanced Annihilation' WeaponDefs]

[http://code.google.com/p/conflictterra/source/browse/#svn%2Fgames%2FCT%2Fweapons 'Conflict Terra' WeaponDefs] (Most are integrated into their [[Units-UnitDefs#Examples|UnitDefs]])

[https://code.google.com/p/evolutionrts/source/browse/#svn%2Ftrunk%2Fevolutiondev.sdd%2FWeapons 'Evolution RTS' WeaponDefs] (Most are integrated into their [[Units-UnitDefs#Examples|UnitDefs]])

[http://spring1944.svn.sourceforge.net/viewvc/spring1944/trunk/S44Main.sdd/weapons/ 'Spring: 1944' WeaponDefs] (Implements an [http://en.wikipedia.org/wiki/Object-oriented_programming OOP] paradigm with [http://en.wikipedia.org/wiki/Inheritance_(computer_science) inheritance])

[http://code.google.com/p/springtutorialgame/source/browse/#svn%2Ftrunk%2FSpringTutorialGame.sdd%2FWeapons 'Spring Tutorial Game' WeaponDefs]

[[Category: Units]]

CEG-Format

2013-08-13T17:47:09Z

Kingraptor: /* Conditions */ Underwater tag works.

'''Source:''' {{sourcelink|file=rts/Sim/Projectiles}}

== Overall Format ==

A CEG file contains one or more CEGs. Each CEG follows this format:

<code><pre>
[ceg_name] {
useDefaultExplosions = 0;
[spawner_name_0] {
class=CClassName;
[properties] {
property0 = value0;
property1 = value1;
//and so on...
}
condition0 = 1;
condition1 = 0;
count = 1;
}

[spawner_name_1] {
//each spawner follows that format
}

[groundflash] {
//groundflash is a special name; it always generates a groundflash
flashsize=16;
flashalpha=1;
circlegrowth=1;
circlealpha=0;
ttl=8;
color=1,1,1;
}
}
</pre></code>

=== useDefaultExplosions ===
If this is set, the CEG will use the default explosion (based on damage and area of effect) in addition to any spawners you define.

=== Spawners ===
A CEG can contain any number of spawners. The name of the spawners don't really matter, as long as it's not "groundflash", which has a special meaning. You can think of each spawner as being one component of the overall explosion.

==== Class ====
Each spawner has a class that determines what kind of graphical effect it creates. Spring has a number of standard classes that you can choose from. See [[CEG-Classes]] for details.

==== Properties ====
Depending on what class a spawner is, it will have a set of properties that allow you to fine-tune what the spawner displays. Again, see [[CEG-Classes]] for details.

==== Conditions ====
These determine under what conditions the spawner will run. The available conditions are "air" (at least 20 elmos above ground/sea level), "water", "underwater", "ground", "unit" (hits a unit), and "nounit" (doesn't hit a unit). If you set the condition to true (e.g., "water = 1;"), the spawner will run if the explosion takes place under that condition. If you set more than one condition, the spawner will run if ''any'' of them are true. If you want a spawner to run only if two or more conditions are ''all'' true, you have to do a little trick with the CExpGenSpawner class.

==== Count ====
The count determines the number of times the spawner will run.

=== groundflash ===
If you name a spawner "groundflash," it will always generate a groundflash. A groundflash has the following properties:

*flashsize (float): The radius of the groundflash.
*flashalpha (float in [0, 1]): How transparent the groundflash is. Generally, the higher, the brighter.
*circlegrowth (float): A groundflash can have an additional circle that expands outwards. This controls how fast the circle grows.
*circlealpha (float in [0, 1]): How transparent the circle is.
*ttl (int): How long the groundflash lasts.
*color (float3): The color of the groundflash.

Suggested Use: A short groundflash (~8 frames) is good for any explosion that gives off light. You can also use a longer groundflash to suggest the ground is glowing from heat.

=== Data Types ===
CEGs use the following data types:

*float: Most properties are floats. e.g. `0.123`
*int: Used for counts and ttls. e.g. `1234`
*bool: Use for conditions, and some properties. e.g. `true`, `1`, `false`
*float3: Used for vectors and colors. The components are floats, separated by commas. You can also use the keyword <code>dir</code>, which represents the direction fed to the CEG. e.g. "0.1 , 1.2 , 3.4", "dir"
*string: Used for colormaps and texture names. In .lua you delimit a string by quotes; in .tdf you do not. Color maps consist of 2 or more groups of 4 numbers, each group representing a RGBA color. Textures are the names you define in gamedata/resources.tdf or gamedata/resources.lua. e.g. "1.0 0.0 0.0 1 0 0 1.0 1" (are gradient from red to blue)

You can use [[CEG-Operators]] to define floats that are not fixed.

=== Units ===

All distances are in elmos; all time is in frames.

[[Category:CEG]]

Lua SyncedCtrl

2013-07-04T14:47:55Z

Kingraptor: /* Give Order */ added note on number params for options

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

= Game End =
'''Spring.KillTeam''' {{new|83.0}}
( number teamID ) -> nil
Will declare a team to be dead ( no further orders can be assigned to such teams's units ), Gaia team cannot be killed.

'''Spring.GameOver''' {{new|83.0}}
( {number allyTeamID1, number allyTeamID2, ...} ) -> nil
Will declare game over, a list of winning allyteams can be passed, if undecided ( like when dropped from the host ) it should be empty ( no winner ), in the case of a draw with multiple winners, all should be listed

= Resources =
'''Spring.AddTeamResource'''
( number teamID, string "metal" | "energy", number amount ) -> nil
'''Spring.UseTeamResource'''
( number teamID,
string "metal" | "energy",number amount |
{ metal = number amount, energy = 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 "metal" | "energy", number amount ) -> nil

'''Spring.ShareTeamResource''' 0.82 and later
( number teamID_src, number teamID_recv, string "metal" | "energy", number amount ) -> nil

= Unit Handling =
'''Spring.CreateUnit''' note: offmap positions are clamped! (you still can use MoveCtrl todo so)
( string "defName" | number unitDefID,
number x, number y, number z,
(number facing | string "facing"),
number teamID
[, boolean build = false]
[, boolean flattenGround = true]
[, number unitID]
[, number builderID]) -> number unitID

possible values for facing are:
"south" | "s" | 0
"east" | "e" | 1
"north" | "n" | 2
"west" | "w" | 3
if build is true the unit is created in "being built" state, with buildProgress = 0
unitID and builderID are {{new|92.0}}, the former allowing to spawn a unit with
a specific ID.


'''Spring.DestroyUnit'''
( number unitID
[, boolean selfd = false]
[, boolean reclaimed = false]
[, number attackerID ] ) -> nil

selfd := makes the unit act like it self-destructed
reclaimed := don't show any DeathSequences, don't leave a wreckage.
NOTE this does _not_ give back the resources to the team!


'''Spring.TransferUnit'''
( number unitID,
numer newTeamID
[, boolean given = true ] ) -> nil
if given=false, the unit is captured

== 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.SetUnitFuel'''
( number unitID, number fuel ) -> nil

'''Spring.SetUnitCrashing''' {{new|83.0}}
( number unitID, boolean crashing ) -> boolean success

'''Spring.SetUnitLineage''' Removed from version 83.0 
( 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.SetUnitBlocking''' crushable new in version 85.0
( number unitID, boolean blocking [, boolean collide [, boolean crushable]] ) -> 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.SetUnitNanoPieces''' {{new|92.0}}
( number builderID, table pieces ) -> nil

'''Spring.SetUnitArmored''' armorMultiple new in version 0.83.x
( number unitID, boolean armored [, number armorMultiple] ) -> nil

'''Spring.SetUnitShieldState'''
( number unitID [, number weaponID = -1] [, boolean enabled] [, number power] ) -> nil

'''Spring.SetUnitFlanking'''
( number unitID, string "mode", number mode ) -> nil
( number unitID, string "moveFactor", number factor) -> nil
( number unitID, string "minDamage", number minDamage ) -> nil
( number unitID, string "mazDamage", number maxDamage ) -> nil
( number unitID, string "dir", number x, number y, number z) -> nil

'''Spring.SetUnitWeaponState'''
( number unitID, number weaponNum, table states ) -> nil
( number unitID, number weaponNum, string key, number value ) -> nil
format of the states table:
{
["reloadState" = number value,]
["reloadFrame" = number value,] (synonym for reloadState!)
["reloadTime" = number value,]
["accuracy" = number value,]
["sprayAngle" = number value,]
["range" = number value,]
["projectileSpeed" = number value,]
["burst" = number value,]
["burstRate" = number value,]
["projectiles" = number value,]
["aimReady" = number value,] (<>0.0f := true)
}

'''Spring.SetUnitCollisionVolumeData'''
( number unitID, number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetX,
number vType, number tType, number Axis
) -> nil
enum COLVOL_TYPES {
COLVOL_TYPE_DISABLED = -1,
COLVOL_TYPE_ELLIPSOID = 0,
COLVOL_TYPE_CYLINDER,
COLVOL_TYPE_BOX,
COLVOL_TYPE_SPHERE,
COLVOL_NUM_TYPES // number of non-disabled collision volume types
};
enum COLVOL_TESTS {
COLVOL_TEST_DISC = 0,
COLVOL_TEST_CONT = 1,
COLVOL_NUM_TESTS = 2 // number of tests
};
enum COLVOL_AXES {
COLVOL_AXIS_X = 0,
COLVOL_AXIS_Y = 1,
COLVOL_AXIS_Z = 2,
COLVOL_NUM_AXES = 3 // number of collision volume axes
};


'''Spring.SetUnitPieceCollisionVolumeData'''
( number unitID, number pieceIndex, boolean enableLocal,
number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetZ,
number vType, number Axis
) -> nil

'''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.SetUnitDirection''' {{new|90.0}}
( number unitID, number x, number y, number z ) -> 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 [, decayRate ] ) -> nil

'''Spring.AddUnitSeismicPing'''
( number unitID, number pingSize ) -> nil

'''Spring.RemoveBuildingDecal'''
( number unitID ) -> nil

'''Spring.SetUnitMidAndAimPos''' {{new|89.0}}
( number unitID,
number mpx, number mpy, number mpz,
number apx, number apy, number apz,
[, boolean relative] ) -> boolean success


mpx, mpy, mpz: new middle position of unit

apx, apy, apz: new position that enemies aim at on this unit

relative: are the new coordinates relative to world or unit coordinates?


'''Spring.SetUnitRadiusAndHeight''' {{new|89.0}}
( number unitID, number radius, number height ) -> boolean success

'''Spring.UnitWeaponFire'''
( number unitID, number weaponID ) -> nil
'''Spring.UnitWeaponHoldFire'''
( number unitID, number weaponID ) -> nil

== Unit LOS ==
'''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.SetUnitSonarStealth'''
( number unitID, boolean sonarStealth ) -> nil

'''Spring.SetUnitStealth'''
( number unitID, boolean stealth ) -> nil

'''Spring.SetUnitAlwaysVisible'''
( number unitID, boolean alwaysVisible ) -> nil

'''Spring.SetUnitLosMask'''
( number unitID, number allyTeam, number los | table losTypes ) -> nil
the 3th argument is either the bit-and combination of the following numbers:
LOS_INLOS = 1
LOS_INRADAR = 2
LOS_PREVLOS = 4
LOS_CONTRADAR = 8
or a table of the following form:
losTypes = {
[los = boolean,]
[radar = boolean,]
[prevLos = boolean,]
[contRadar = boolean,]
}

'''Spring.SetUnitLosState'''
( number unitID, number allyTeam, number los | table losTypes ) -> nil
see above for more info on the arguments

'''Spring.SetUnitSensorRadius'''
( number unitID, string type, number radius ) -> nil | number newRadius
type can be:
"los","airLos","radar","sonar","seismic","radarJammer","sonarJammer"

== Unit Resourcing ==
'''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 | boolean okay
( number unitID, { ["m" | "metal" | "e" | "energy"] = amount, ... } ) -> nil | boolean okay

= Feature Handling =
'''Spring.CreateFeature'''
( string "defName" | number featureDefID,
number x, number y, number z
[, number heading
[, number AllyTeamID
[, number featureID ]]] ) -> number featureID

'''Spring.DestroyFeature'''
( number featureID ) -> nil

'''Spring.TransferFeature'''
( number featureID, number teamID ) -> 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 values for facing are:
"south" | "s" | 0
"east" | "e" | 1
"north" | "n" | 2
"west" | "w" | 3


'''Spring.SetFeaturePosition'''
( number featureID, number x, number y, number z [, boolean snapToGround]) -> nil

'''Spring.SetFeatureDirection'''
( number featureID, number x, number y, number z ) -> nil

'''Spring.SetFeatureNoSelect'''
( number featureID, boolean noSelect ) -> nil

'''Spring.SetFeatureAlwaysVisible'''
( number featureID, boolean enable ) -> nil

'''Spring.SetFeatureCollisionVolumeData'''
( number featureID, number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetX,
number vType, number tType, number Axis
) -> nil
check Spring.SetUnitCollisionVolumeData for further explanation of the arguments

'''Spring.SetFeatureMidAndAimPos''' {{new|89.0}}
( number unitID,
number mpx, number mpy, number mpz,
number apx, number apy, number apz,
[, boolean relative] ) -> boolean success

check Spring.SetUnitMidAndAimPos for further explanation of the arguments

'''Spring.SetFeatureRadiusAndHeight''' {{new|89.0}}
( number unitID, number radius, number height ) -> boolean success

= Lua to COB =
'''Spring.CallCOBScript'''
( number unitID, number funcID | string funcName, number retArgs, COBArg1, COBArg2, ... )
-> nil | number returnValue, number retArg1, number retArg2, ...

'''Spring.CallCOBScriptCB''' 
broken in 0.78.2.1; will be removed with the introduction of Lua as COB replacement
( 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

Note: Don't use Spring.[Get|Set]UnitCOBValue in LUS just because you are familar with it since bos/cob, use the mighty LuaSpringAPI instead!

'''Spring.GetUnitCOBValue'''
( number unitID [, boolean splitData=false], number COBValue
[, number param1 [,number param2 [, number param3 [, number param4 ] ] ] ] )
-> number result | number result1, number result2
you find the possible values for `COBValue` in [[Lua_ConstCOB#Get.2FSet|Lua_ConstCOB]]
 also see [[Animation-CobConstants#Custom_Variables|Custom_Variables]]

'''Spring.SetUnitCOBValue'''
( number unitID, number COBValue, number param1 [,number param2] ) -> nil
you find the possible values for `COBValue` in [[Lua_ConstCOB#Get.2FSet|Lua_ConstCOB]]
 also see [[Animation-CobConstants#Custom_Variables|Custom_Variables]]

= Give Order =
options can also be a bitmask; e.g. 0 instead of an empty table (can avoid performance hit on table creation) 
see [[Lua CMDs]] for relevant constants


'''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,
{number, etc...}, params
{"alt", "ctrl", "shift", "right"} options
}, ..
}
) -> nil

'''Spring.GiveOrderArrayToUnitArray'''
( unitArray = { [1] = number unitID, etc... },
orderArray = {
{ number cmdID,
{number, etc...}, params
{"alt", "ctrl", "shift", "right"} options
}, ..
}
) -> nil

=Ground=
== Grass ==
'''Spring.AddGrass'''
( number x, number y, number z ) -> nil

'''Spring.RemoveGrass'''
( number x, number y, number z ) -> nil

== Heightmap ==
Note that x & z coords are in worldspace (Game.mapSizeX/Z), still the heightmap resolution is Game.squareSize.

'''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

'''Spring.SetHeightMapFunc'''
( lua_function [, arg1 ,[ arg2 [, ... ] ] ) -> nil | number absTotalHeightMapAmountChanged
Example code:<code><pre>
Spring.SetHeightMapFunc(function()
for z=0,Game.mapSizeZ, Game.squareSize do
for x=0,Game.mapSizeX, Game.squareSize do
Spring.SetHeightMap( x, z, 200 + 20 * math.cos((x + z) / 90) )
end
end
end)
</pre></code>
'''Spring.AddHeightMap''' can only be called in SetHeightMapFunc()
( number x, number z, number height ) -> nil | number newHeight
'''Spring.SetHeightMap''' can only be called in SetHeightMapFunc()
( number x, number z, number height [,number terraform = 1] ) -> nil | number absHeightDiff
the terraform argument is a scaling factor:
so if 0 nothing will be changed (the terraform starts) and if it is 1 the terraform will be finished.

'''Spring.LevelSmoothMesh'''
( number x1, number z1 [, number x2, number z2], number height ) -> nil
'''Spring.AdjustSmoothMesh'''
( number x1, number z1 [, number x2, number z2], number height ) -> nil
'''Spring.RevertSmoothMesh'''
( number x1, number z1 [, number x2, number z2], number origFactor ) -> nil

'''Spring.SetSmoothMeshFunc'''
( lua_function [, arg1 ,[ arg2 [, ... ] ] ) -> nil | number absTotalHeightMapAmountChanged
'''Spring.AddSmoothMesh''' can only be called in SetSmoothMeshFunc()
( number x, number z, number height ) -> nil | number newHeight
'''Spring.SetSmoothMesh''' can only be called in SetSmoothMeshFunc()
( number x, number z, number height [,number terraform = 1] ) -> nil | number absHeightDiff

== TerrainTypes ==
'''Spring.SetMapSquareTerrainType'''
( number x, number z, int newType ) -> nil | int oldType
'''Spring.SetTerrainTypeData'''
( int typeIndex
[, number speedTanks = nil ]
[, number speedKBOTs = nil ]
[, number speedHovers = nil ]
[, number speedShips = nil ] ) -> nil | boolean true

== MetalAmount ==
'''Spring.SetMetalAmount''' {{new|83.0}}
( number x, number z, number metalAmount)
x & z coords are in worldspace/16 metalAmount must be between 0 and 255*maxMetal (with maxMetal from the .smd or mapinfo.lua)

= 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

an ugly global switch that can be used to block units turning into features when they finish being built (like *A DT's do, which have the isFeature tag)
[http://springrts.com/phpbb/viewtopic.php?f=14&p=481521 thread]


'''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


'''Spring.SpawnCEG'''
( string "cegname",
number posX = 0, number posY = 0, number posZ = 0,
number dirX = 0, number dirY = 0, number dirZ = 0,
number radius = 0, number damage = 0
) -> nil

= Projectiles =
'''Spring.SpawnProjectile'''
( number weaponDefID, table projectileParams ) -> nil | number projectileID
possible keys of projectileParams are:
pos = {number x, number y, number z},
end = {number x, number y, number z},
speed = {number x, number y, number z},
spread = {number x, number y, number z},
error = {number x, number y, number z},
owner = number,
team = number,
ttl = number,
gravity = number,
tracking = number,
maxRange = number,
startAlpha = number,
endAlpha = number,
model = string,
cegTag = string,


'''Spring.SetProjectileTarget'''
( number projID,
[ targetID, targetType ] | [ number posX, number posY, number posZ ] )
-> nil | boolean validTarget
targetType can be one of:
'u' - unit
'f' - feature
'p' - projectile

'''Spring.SetProjectileMoveControl''' (disables engine movecontrol, so lua can fully control the physics)
( number projID, boolean enable ) -> nil
'''Spring.SetProjectilePosition'''
( number projID [, number x = 0 [, number y = 0 [, number z = 0 ]]] ) -> nil
'''Spring.SetProjectileVelocity'''
( number projID [, number x = 0 [, number y = 0 [, number z = 0 ]]] ) -> nil
'''Spring.SetProjectileCollision'''
( number projID ) -> nil
'''Spring.SetProjectileGravity'''
( number projID [, number grav = 0] ) -> nil
'''Spring.SetProjectileSpinAngle'''
( number projID [, number spinAngle = 0] ) -> nil
'''Spring.SetProjectileSpinSpeed'''
( number projID [, number speed = 0] ) -> nil
'''Spring.SetProjectileSpinVec'''
( number projID [, number x = 0 [, number y = 0 [, number z = 0]]] ) -> nil
'''Spring.SetProjectileCEG'''
( number projID, string ceg_name ) -> nil

[[category: Lua]]

Gamedev:Main

2013-06-14T02:13:00Z

Kingraptor: Add Ren'Py in a misc section at the end (didn't know where to put it)

[[Engine_Development|Development]] < {{FULLPAGENAME}}

= Game Development =
This information is meant to help newcomers learn how to develop their own games for the Spring Engine.

= General =

*[[Game structure]]
*[[VirtualFileSystem]]
*[[Game specification|Game specification]]
*[http://answers.springlobby.info/ Q&A Site for the Spring Engine]

= Templates =
*[[SpringABC]] - 3 Templates of Increasing Complexity
*[[SpringTutorialGame|Spring Tutorial Game]] - A Tutorial Template Game with full examples

= Technical Documentation =
; '''GameData'''
* [[Armordefs.lua]]
* [[Icontypes.lua]]
* [[Messages.lua]]
* [[Modinfo.lua]]
* [[Modrules.lua]] - Global game variables
* [[Movedefs.lua]]
* [[Resources.lua]]
* [[Sidedata.lua]]
* [[Sounds.lua]]

; '''Definition Files'''
* [[Units-UnitDefs]] - define the attributes of units
* [[Units-WeaponDefs]] - define the attributes of weapons/projectiles
* [[Units-FeatureDefs]] - define the attributes of static map features and wrecks
* [[CEG]] Particle effects (explosions etc)

; '''Lua API & Libraries'''
* [[Lua_Scripting|Lua API Documentation]]
* [[LUPS]] - Lua Particle System
* [[Chili]] - A GUI Framework
* [[Custom Unit Shaders]] - Normal mapping and more
* {{forumlink|topic=28341|title=ChangePiece}} - Switch piece geometry

; '''Animation'''
Lua Animations
*[[Animation-LuaScripting]]
**[[Animation-LuaCallins]]
**[[Animation-LuaCallouts]]
**[[Animation-CobLuaDifferences]]

COB Animations (Deprecated)
*[[Animation-CobOverview]]
**[[Animation-CobAnimation]]
**[[Animation-CobCallins]]
**[[Animation-CobConstants]]
**[[Animation-CobThreads]]
**[[Animation-CobHitByWeaponID]]
**[[Units:LuaCOB]] - how to interface COB with LUA
**[[CEG_For_Units|Game Development:Calling basic CEGs from COB]]
**{{forumlink|topic=132943#132943|title=GPL COB Examples}}

; '''Unit Development'''
* [[Unit_collision_volumes | Unit Collision Volumes]] - collision detection
* [[Units:WeaponMainDir]]
* [[Units:Buildpics]]

; '''Models & Textures'''
* [[About_s3o|.s3o]]
* [[Assimp]]
* [[Units:Textures]]

; '''Misc'''
* [[MouseCursors]]
* [[Mod Development:Archives|Game Development:Archives]]
* [[Mod Development:Sidepics|Game Development:Sidepics]]

= Tools =
== In-Game Tools ==
*[[ToolBox]] - A Collection of Game Development Tools
*[[Map Making: Feature Placer|Feature Placer]] - A Map Feature & NPC Unit Placement Tool
== External Tools ==
* [[Upspring]]
* [[Map,_Mod,_And_Unit_Development_Programs|Development Tools]]

= Engine Related =
* [[Download_Testing]] - Test the compatibility of your game on upcoming versions of the Spring engine.

= Tutorials =
== Game Development Tutorials ==
*[[The Complete Guide To Making A Spring Game]] - A fairly comprehensive getting started tutorial.
*[http://springrts.com/phpbb/viewtopic.php?f=14&t=26409| Porting TA content to Spring]
*<strike>[[Simple Mod Tutorial|Simple Game Tutorial]]</strike> - needs to be updated

==Modelling Tutorials==
'''Wings3D'''
* [[Units:CreateModel]]
* [http://springrts.com/phpbb/viewtopic.php?t=10612 Wings UV Mapping Tutorial]
* [http://springrts.com/phpbb/viewtopic.php?f=9&t=12354 Saving polygons in Wings3d Tutorial]

'''Blender'''
* [[TutorialBlenderWorkFlow|Blender Workflow Tutorial]]

'''3DS Max'''
* [http://springrts.com/phpbb/viewtopic.php?t=10503 Runecrafter's 3DS Max UV Mapping Tutorial]

==Texturing Tutorials==
* [http://springrts.com/phpbb/viewtopic.php?f=57&t=22392 DDS Textures: How To]
* [http://springrts.com/phpbb/viewtopic.php?t=10947 Greeble Tutorial 1]
* [http://springrts.com/phpbb/viewtopic.php?f=9&t=12356 Greeble Tutorial 2]

=Misc=
* [[Ren'Py]]: a visual novel engine that can be used with Spring

[[Category:Game Dev]]

Ren'Py

2013-06-14T02:11:42Z

Kingraptor: Created page with "'''Ren'Py''' is an open source visual novel engine, available [http://www.renpy.org/ here]. It can be used in conjunction with Spring to provide a singleplayer experience with..."

'''Ren'Py''' is an open source visual novel engine, available [http://www.renpy.org/ here]. It can be used in conjunction with Spring to provide a singleplayer experience with narrative, dialogue, images and videos.

== Using Ren'Py with Spring ==
Without the use of sockets, Ren'Py and Spring can best communicate in the following way:

=== Ren'Py to Spring ===
Python can read a Spring startscript and modify it, say using [http://docs.python.org/2/library/string.html#formatstrings str.format] or the older [http://docs.python.org/2/library/stdtypes.html#string-formatting % (modulo) operator]. In this way, any arbitrary game, per-player or per-team information can be made available to Spring at runtime. It is also theoretically possible for Python to modify the contents of an .sdz or .sdd archive directly, but this is not recommended.

=== Spring to Ren'Py ===
A widget or gadget can write a Python file with any information to be communicated to Ren'Py, which it can then import as a module. Bear in mind that because Spring is limited in which directories its Lua can write files to, Ren'Py will need to know where the Spring datadir is.

=== Examples ===
[https://code.google.com/p/springpy/ SpringPy] is a code example for Spring-Ren'Py communication. You can check out the whole repo and open/run the Ren'Py project with the Ren'Py SDK.
* [https://code.google.com/p/springpy/source/browse/trunk/game/script.rpy Example script.rpy]
* [https://code.google.com/p/springpy/source/browse/trunk/spring/script_pytest.txt Example startscript]
* [https://code.google.com/p/springpy/source/browse/trunk/spring/LuaUI/Widgets/api_shared_functions.lua Widget to write Python dictionaries and module files]
* [https://code.google.com/p/springpy/source/browse/trunk/spring/LuaUI/Widgets/dbg_test.lua Test widget]: writes data required by sample code on widget:Initialize()

Lua SyncedCtrl

2013-02-21T17:12:25Z

Kingraptor: /* Unit Handling */ Fix CreateUnit args

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

= Game End =
'''Spring.KillTeam''' {{new|83.0}}
( number teamID ) -> nil
Will declare a team to be dead ( no further orders can be assigned to such teams's units ), Gaia team cannot be killed.

'''Spring.GameOver''' {{new|83.0}}
( {number allyTeamID1, number allyTeamID2, ...} ) -> nil
Will declare game over, a list of winning allyteams can be passed, if undecided ( like when dropped from the host ) it should be empty ( no winner ), in the case of a draw with multiple winners, all should be listed

= Resources =
'''Spring.AddTeamResource'''
( number teamID, string "metal" | "energy", number amount ) -> nil
'''Spring.UseTeamResource'''
( number teamID,
string "metal" | "energy",number amount |
{ metal = number amount, energy = 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 "metal" | "energy", number amount ) -> nil

'''Spring.ShareTeamResource''' 0.82 and later
( number teamID_src, number teamID_recv, string "metal" | "energy", number amount ) -> nil

= Unit Handling =
'''Spring.CreateUnit''' note: offmap positions are clamped! (you still can use MoveCtrl todo so)
( string "defName" | number unitDefID,
number x, number y, number z,
(number facing | string "facing"),
number teamID
[, boolean build = false]
[, boolean flattenGround = true]
[, number unitID]
[, number builderID]) -> number unitID

possible values for facing are:
"south" | "s" | 0
"east" | "e" | 1
"north" | "n" | 2
"west" | "w" | 3
if build is true the unit is created in "being built" state, with buildProgress = 0
unitID and builderID are {{new|92.0}}, the former allowing to spawn a unit with
a specific ID.


'''Spring.DestroyUnit'''
( number unitID
[, boolean selfd = false]
[, boolean reclaimed = false]
[, number attackerID ] ) -> nil

selfd := makes the unit act like it self-destructed
reclaimed := don't show any DeathSequences, don't leave a wreckage.
NOTE this does _not_ give back the resources to the team!


'''Spring.TransferUnit'''
( number unitID,
numer newTeamID
[, boolean given = true ] ) -> nil
if given=false, the unit is captured

== 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.SetUnitFuel'''
( number unitID, number fuel ) -> nil

'''Spring.SetUnitCrashing''' {{new|83.0}}
( number unitID, boolean crashing ) -> boolean success

'''Spring.SetUnitLineage''' Removed from version 83.0 
( 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.SetUnitBlocking''' crushable new in version 85.0
( number unitID, boolean blocking [, boolean collide [, boolean crushable]] ) -> 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.SetUnitNanoPieces''' {{new|92.0}}
( number builderID, table pieces ) -> nil

'''Spring.SetUnitArmored''' armorMultiple new in version 0.83.x
( number unitID, boolean armored [, number armorMultiple] ) -> nil

'''Spring.SetUnitShieldState'''
( number unitID [, number weaponID = -1] [, boolean enabled] [, number power] ) -> nil

'''Spring.SetUnitFlanking'''
( number unitID, string "mode", number mode ) -> nil
( number unitID, string "moveFactor", number factor) -> nil
( number unitID, string "minDamage", number minDamage ) -> nil
( number unitID, string "mazDamage", number maxDamage ) -> nil
( number unitID, string "dir", number x, number y, number z) -> nil

'''Spring.SetUnitWeaponState'''
( number unitID, number weaponNum, table states ) -> nil
( number unitID, number weaponNum, string key, number value ) -> nil
format of the states table:
{
["reloadState" = number value,]
["reloadFrame" = number value,] (synonym for reloadState!)
["reloadTime" = number value,]
["accuracy" = number value,]
["sprayAngle" = number value,]
["range" = number value,]
["projectileSpeed" = number value,]
["burst" = number value,]
["burstRate" = number value,]
["projectiles" = number value,]
["aimReady" = number value,] (<>0.0f := true)
}

'''Spring.SetUnitCollisionVolumeData'''
( number unitID, number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetX,
number vType, number tType, number Axis
) -> nil
enum COLVOL_TYPES {
COLVOL_TYPE_DISABLED = -1,
COLVOL_TYPE_ELLIPSOID = 0,
COLVOL_TYPE_CYLINDER,
COLVOL_TYPE_BOX,
COLVOL_TYPE_SPHERE,
COLVOL_NUM_TYPES // number of non-disabled collision volume types
};
enum COLVOL_TESTS {
COLVOL_TEST_DISC = 0,
COLVOL_TEST_CONT = 1,
COLVOL_NUM_TESTS = 2 // number of tests
};
enum COLVOL_AXES {
COLVOL_AXIS_X = 0,
COLVOL_AXIS_Y = 1,
COLVOL_AXIS_Z = 2,
COLVOL_NUM_AXES = 3 // number of collision volume axes
};


'''Spring.SetUnitPieceCollisionVolumeData'''
( number unitID, number pieceIndex, boolean enableLocal,
number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetZ,
number vType, number Axis
) -> nil

'''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.SetUnitDirection''' {{new|90.0}}
( number unitID, number x, number y, number z ) -> 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 [, decayRate ] ) -> nil

'''Spring.AddUnitSeismicPing'''
( number unitID, number pingSize ) -> nil

'''Spring.RemoveBuildingDecal'''
( number unitID ) -> nil

'''Spring.SetUnitMidAndAimPos''' {{new|89.0}}
( number unitID,
number mpx, number mpy, number mpz,
number apx, number apy, number apz,
[, boolean relative] ) -> boolean success


mpx, mpy, mpz: new middle position of unit

apx, apy, apz: new position that enemies aim at on this unit

relative: are the new coordinates relative to world or unit coordinates?


'''Spring.SetUnitRadiusAndHeight''' {{new|89.0}}
( number unitID, number radius, number height ) -> boolean success

== Unit LOS ==
'''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.SetUnitSonarStealth'''
( number unitID, boolean sonarStealth ) -> nil

'''Spring.SetUnitStealth'''
( number unitID, boolean stealth ) -> nil

'''Spring.SetUnitAlwaysVisible'''
( number unitID, boolean alwaysVisible ) -> nil

'''Spring.SetUnitLosMask'''
( number unitID, number allyTeam, number los | table losTypes ) -> nil
the 3th argument is either the bit-and combination of the following numbers:
LOS_INLOS = 1
LOS_INRADAR = 2
LOS_PREVLOS = 4
LOS_CONTRADAR = 8
or a table of the following form:
losTypes = {
[los = boolean,]
[radar = boolean,]
[prevLos = boolean,]
[contRadar = boolean,]
}

'''Spring.SetUnitLosState'''
( number unitID, number allyTeam, number los | table losTypes ) -> nil
see above for more info on the arguments

'''Spring.SetUnitSensorRadius'''
( number unitID, string type, number radius ) -> nil | number newRadius
type can be:
"los","airLos","radar","sonar","seismic","radarJammer","sonarJammer"

== Unit Resourcing ==
'''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 | boolean okay
( number unitID, { ["m" | "metal" | "e" | "energy"] = amount, ... } ) -> nil | boolean okay

= Feature Handling =
'''Spring.CreateFeature'''
( string "defName" | number featureDefID,
number x, number y, number z
[, number heading
[, number AllyTeamID
[, number featureID ]]] ) -> number featureID

'''Spring.DestroyFeature'''
( number featureID ) -> nil

'''Spring.TransferFeature'''
( number featureID, number teamID ) -> 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 values for facing are:
"south" | "s" | 0
"east" | "e" | 1
"north" | "n" | 2
"west" | "w" | 3


'''Spring.SetFeaturePosition'''
( number featureID, number x, number y, number z [, boolean snapToGround]) -> nil

'''Spring.SetFeatureDirection'''
( number featureID, number x, number y, number z ) -> nil

'''Spring.SetFeatureNoSelect'''
( number featureID, boolean noSelect ) -> nil

'''Spring.SetFeatureAlwaysVisible'''
( number featureID, boolean enable ) -> nil

'''Spring.SetFeatureCollisionVolumeData'''
( number featureID, number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetX,
number vType, number tType, number Axis
) -> nil
check Spring.SetUnitCollisionVolumeData for further explanation of the arguments

'''Spring.SetFeatureMidAndAimPos''' {{new|89.0}}
( number unitID,
number mpx, number mpy, number mpz,
number apx, number apy, number apz,
[, boolean relative] ) -> boolean success

check Spring.SetUnitMidAndAimPos for further explanation of the arguments

'''Spring.SetFeatureRadiusAndHeight''' {{new|89.0}}
( number unitID, number radius, number height ) -> boolean success

= Lua to COB =
'''Spring.CallCOBScript'''
( number unitID, number funcID | string funcName, number retArgs, COBArg1, COBArg2, ... )
-> nil | number returnValue, number retArg1, number retArg2, ...

'''Spring.CallCOBScriptCB''' 
broken in 0.78.2.1; will be removed with the introduction of Lua as COB replacement
( 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

Note: Don't use Spring.[Get|Set]UnitCOBValue in LUS just because you are familar with it since bos/cob, use the mighty LuaSpringAPI instead!

'''Spring.GetUnitCOBValue'''
( number unitID [, boolean splitData=false], number COBValue
[, number param1 [,number param2 [, number param3 [, number param4 ] ] ] ] )
-> number result | number result1, number result2
you find the possible values for `COBValue` in [[Lua_ConstCOB#Get.2FSet|Lua_ConstCOB]]
 also see [[Animation-CobConstants#Custom_Variables|Custom_Variables]]

'''Spring.SetUnitCOBValue'''
( number unitID, number COBValue, number param1 [,number param2] ) -> nil
you find the possible values for `COBValue` in [[Lua_ConstCOB#Get.2FSet|Lua_ConstCOB]]
 also see [[Animation-CobConstants#Custom_Variables|Custom_Variables]]

= 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,
{number, etc...}, params
{"alt", "ctrl", "shift", "right"} options
}, ..
}
) -> nil

'''Spring.GiveOrderArrayToUnitArray'''
( unitArray = { [1] = number unitID, etc... },
orderArray = {
{ number cmdID,
{number, etc...}, params
{"alt", "ctrl", "shift", "right"} options
}, ..
}
) -> nil

=Ground=
== Grass ==
'''Spring.AddGrass'''
( number x, number y, number z ) -> nil

'''Spring.RemoveGrass'''
( number x, number y, number z ) -> nil

== Heightmap ==
Note that x & z coords are in worldspace (Game.mapSizeX/Z), still the heightmap resolution is Game.squareSize.

'''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

'''Spring.SetHeightMapFunc'''
( lua_function [, arg1 ,[ arg2 [, ... ] ] ) -> nil | number absTotalHeightMapAmountChanged
Example code:<code><pre>
Spring.SetHeightMapFunc(function()
for z=0,Game.mapSizeZ, Game.squareSize do
for x=0,Game.mapSizeX, Game.squareSize do
Spring.SetHeightMap( x, z, 200 + 20 * math.cos((x + z) / 90) )
end
end
end)
</pre></code>
'''Spring.AddHeightMap''' can only be called in SetHeightMapFunc()
( number x, number z, number height ) -> nil | number newHeight
'''Spring.SetHeightMap''' can only be called in SetHeightMapFunc()
( number x, number z, number height [,number terraform = 1] ) -> nil | number absHeightDiff
the terraform argument is a scaling factor:
so if 0 nothing will be changed (the terraform starts) and if it is 1 the terraform will be finished.

'''Spring.LevelSmoothMesh'''
( number x1, number z1 [, number x2, number z2], number height ) -> nil
'''Spring.AdjustSmoothMesh'''
( number x1, number z1 [, number x2, number z2], number height ) -> nil
'''Spring.RevertSmoothMesh'''
( number x1, number z1 [, number x2, number z2], number origFactor ) -> nil

'''Spring.SetSmoothMeshFunc'''
( lua_function [, arg1 ,[ arg2 [, ... ] ] ) -> nil | number absTotalHeightMapAmountChanged
'''Spring.AddSmoothMesh''' can only be called in SetSmoothMeshFunc()
( number x, number z, number height ) -> nil | number newHeight
'''Spring.SetSmoothMesh''' can only be called in SetSmoothMeshFunc()
( number x, number z, number height [,number terraform = 1] ) -> nil | number absHeightDiff

== TerrainTypes ==
'''Spring.SetMapSquareTerrainType'''
( number x, number z, int newType ) -> nil | int oldType
'''Spring.SetTerrainTypeData'''
( int typeIndex
[, number speedTanks = nil ]
[, number speedKBOTs = nil ]
[, number speedHovers = nil ]
[, number speedShips = nil ] ) -> nil | boolean true

== MetalAmount ==
'''Spring.SetMetalAmount''' {{new|83.0}}
( number x, number z, number metalAmount)
x & z coords are in worldspace/16 metalAmount must be between 0 and 255*maxMetal (with maxMetal from the .smd or mapinfo.lua)

= 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

an ugly global switch that can be used to block units turning into features when they finish being built (like *A DT's do, which have the isFeature tag)
[http://springrts.com/phpbb/viewtopic.php?f=14&p=481521 thread]


'''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


'''Spring.SpawnCEG'''
( string "cegname",
number posX = 0, number posY = 0, number posZ = 0,
number dirX = 0, number dirY = 0, number dirZ = 0,
number radius = 0, number damage = 0
) -> nil

= Projectiles =
'''Spring.SetProjectileMoveControl''' (disables engine movecontrol, so lua can fully control the physics)
( number projID, boolean enable ) -> nil
'''Spring.SetProjectilePosition'''
( number projID [, number x = 0 [, number y = 0 [, number z = 0 ]]] ) -> nil
'''Spring.SetProjectileVelocity'''
( number projID [, number x = 0 [, number y = 0 [, number z = 0 ]]] ) -> nil
'''Spring.SetProjectileCollision'''
( number projID ) -> nil
'''Spring.SetProjectileGravity'''
( number projID [, number grav = 0] ) -> nil
'''Spring.SetProjectileSpinAngle'''
( number projID [, number spinAngle = 0] ) -> nil
'''Spring.SetProjectileSpinSpeed'''
( number projID [, number speed = 0] ) -> nil
'''Spring.SetProjectileSpinVec'''
( number projID [, number x = 0 [, number y = 0 [, number z = 0]]] ) -> nil
'''Spring.SetProjectileCEG'''
( number projID, string ceg_name ) -> nil

[[category: Lua]]

Animation-LuaCallouts

2012-11-04T06:38:24Z

Kingraptor: /* Introduction */

== Introduction ==

The new callouts are defined in the Spring.UnitScript table.

Types for arguments are only shown where they're ambiguous. For a number of (common) arguments, the types are:

* unitID: number
* piece: number
* axis: number (1 = x axis, 2 = y axis, 3 = z axis)
* destination: number (elmos (linear), radians (angular))
* speed: number (elmos per second (linear), radians per second (angular))
* accel/decel: number (radians per second per frame)

== Animation ==

'''Spring.UnitScript.SetPieceVisibility''' ( piece, boolean visible ) -> nil 
'''Spring.UnitScript.Show''' ( piece ) -> nil 
'''Spring.UnitScript.Hide''' ( piece ) -> nil

These may be used to show/hide pieces of the unit's model.

'''Spring.UnitScript.Move''' ( piece, axis, destination[, speed] ) -> nil

Move piece along axis to the destination position. If speed is given, the piece isn't moved immediately, but will move there at the desired speed. The X axis is mirrored compared to BOS/COB scripts, to match the direction of the X axis in Spring world space.

'''Spring.UnitScript.Turn''' ( piece, axis, destination[, speed] ) -> nil

Turn piece around axis to the destination angle. If speed is given, the piece isn't rotated immediately, but will turn at the desired angular velocity. Angles are in radians.
Always uses the shortest angular towards destinationdegree, and if at exactly 180 degrees opposide, will go counterclockwise.

'''Spring.UnitScript.Spin''' ( piece, axis, speed[, accel] ) -> nil

Makes piece spin around axis at the desired angular velocity. If accel is given, the piece does not start at this velocity at once, but will accelerate to it. Both negative and positive angular velocities are supported. Accel should always be positive, even if speed is negative.

Beware gimbal lock: http://en.wikipedia.org/wiki/Gimbal_lock

'''Spring.UnitScript.StopSpin''' ( piece, axis[, decel] ) -> nil

Stops a piece from spinning around the given axis. If decel is given, the piece does not stop at once, but will decelerate to it. Decel should always be positive. This function is similar to Spin(piece, axis, 0, decel), however, StopSpin also frees up the animation record.

'''Spring.UnitScript.IsInTurn''' (number piece, number axis) -> boolean 
'''Spring.UnitScript.IsInMove''' (number piece, number axis) -> boolean 
'''Spring.UnitScript.IsInSpin''' (number piece, number axis) -> boolean

Returns true if such an animation exists, false otherwise.

'''Spring.UnitScript.GetPieceTranslation''' ( piece ) -> number x, y, z 
'''Spring.UnitScript.GetPieceRotation''' ( piece ) -> number x, y, z

Get the current translation/rotation of a piece. The returned numbers match the values passed into Move and Turn.

'''Spring.UnitScript.GetPiecePosDir''' ( piece ) -> number px, py, pz, dx, dy, dz

Get the piece's position (px, py, pz) and direction (dx, dy, dz) in '''unit space'''. This is quite similar to ''Spring.GetUnitPiecePosDir'', however that function returns in '''world space'''.

== Threads ==

'''Spring.UnitScript.StartThread''' ( function fun, ... ) -> nil

Starts a new (animation) thread, which will execute the function 'fun'. All arguments except the function to run are passed as-is as arguments to 'fun'. [[Animation-CobThreads|COB-Threads]] has a decent description on COB threads, which are mimicked here in Lua using coroutines.

'''Spring.UnitScript.SetSignalMask''' ( number mask ) -> nil 
'''Spring.UnitScript.Signal''' ( number signal ) -> nil

These two support functions offer a powerful way to kill running threads. SetSignalMask assigns a mask to the currently running thread (any new threads started by this one will inherit the signal mask). Signal immediately stops all threads of this unit for which the bitwise and of mask and signal is not zero.

[http://springrts.com/phpbb/viewtopic.php?f=14&t=26274&start=2| What signal will stop which threads?]

'''Spring.UnitScript.WaitForMove''' ( piece, axis ) -> nil 
'''Spring.UnitScript.WaitForTurn''' ( piece, axis ) -> nil

Waits until the piece has stopped moving along / turning around the axis. If the piece is not animating, this functions return at once. You can not wait for a spin, because a spin does never finish.

'''Spring.UnitScript.Sleep''' ( number milliseconds ) -> nil

Waits a number of milliseconds before returning.

== Effects ==

'''Spring.UnitScript.EmitSfx''' ( piece, number id ) -> nil

Emits a [[CEG]] effect or weapon from the given piece. The id is based on one of the effect or weapon ids defined in the units unitdef. 
Example:

<pre>
--get the id of the CEG effects:
local smokecloud = SFX.CEG --the first effect from the list in the unitdef
local smokecloud2 = SFX.CEG +1 --the second effect from the list in the unitdef
local fire = SFX.CEG +2 --the third effect from the list in the unitdef
--get the id of the emiter piece:
local turret = piece "turret"
EmitSfx(turret, smokecloud) --emit the first effect
</pre>

'''Spring.UnitScript.ShowFlare''' ( number piece ) -> nil

Same as COB's show _inside_ FireWeaponX.

'''Spring.UnitScript.Explode''' ( piece, number flags ) -> nil

Explodes a piece, optionally creating a particle which flies off. Typically used inside Killed. Explode does not hide the piece by itself; if using it outside Killed you may want to Hide the piece immediately after. The flags may be any combination of:
* '''SFX.NONE''': do nothing after creating a heatcloud. Other flags have no effect, except NO_HEATCLOUD. If that is given too, the call is a no-op.
* '''SFX.SHATTER''': shatter the piece in many fragments. Only the NO_HEATCLOUD flag has any effect if this is present.
* '''SFX.EXPLODE''' | '''SFX.EXPLODE_ON_HIT''': the piece that flies of should explode when it hits something.
* '''SFX.FALL''': the piece should be affected by gravity (this is currently always forced on by Spring, to prevent pieces that float in air indefinitely).
* '''SFX.SMOKE''': leave smoke trail.
* '''SFX.FIRE''': the piece is on fire when it flies off.
* '''SFX.NO_CEG_TRAIL''': disable a CEG trail, if present.
* '''SFX.NO_HEATCLOUD''': suppress the heat cloud that's shown by default.

== Other ==

'''Spring.UnitScript.AttachUnit''' ( piece, passengerID ) -> nil 
'''Spring.UnitScript.DropUnit''' ( passengerID ) -> nil

Attaches or detaches another unit (a passenger, as this is designed for transports) to this unit. For AttachUnit, piece specifies the attachment point.

'''Spring.UnitScript.GetUnitValue''' ( ... ) -> number | number, number 
'''Spring.UnitScript.SetUnitValue''' ( ... ) -> nil

This may be used instead of COB's get and set codes. It is recommended however, to use dedicated Lua functions (e.g. Spring.GetUnitHealth(unitID) instead of GetUnitValue(4)): these functions should be considered a relic of the past.

Note that these are identical to Spring.GetUnitCOBValue and Spring.SetUnitCOBValue (see also [[Lua_SyncedCtrl#Lua_to_COB]] for the signature of those functions), except that an unitID argument shouldn't be passed to the versions in the Spring.UnitScript table.

'''Spring.UnitScript.GetLongestReloadTime''' ( unitID ) -> number reloadTime

Returns max(reload time) of all the unit's weapons in milliseconds. This utility function exists to aid in porting BOS scripts, which have a SetMaxReloadTime call-in that is called immediately after Create.

== Internal ==

You generally shouldn't need any of the following call-outs, they are provided by the engine to allow the Lua framework to do it's work.

'''Spring.UnitScript.CreateScript''' ( unitID, table callIns ) -> nil

This deletes the unit's current script (whether it's a COB or Lua script doesn't matter), and sets it up with a brand new Lua unit script, initially registering the call-ins given in the table as (string, function) pairs.

'''Spring.UnitScript.UpdateCallIn''' ( unitID, string name[, function callIn] ) -> nil

This updates a single call-in for the unit's current '''Lua''' unit script. If the unit does not currently have a Lua unit script, an error is raised. If the callIn argument is not given (or nil), the call-in with the given name is removed.

'''Spring.UnitScript.CallAsUnit''' ( unitID, function fun, ... ) -> nil

As none of the call-outs takes a unitID, the engine needs to know the ''active unit'' when one of those is called. Using this function another function can be called with the active unit set arbitrarily.

'''Spring.UnitScript.SetDeathScriptFinished''' ( [number wreckLevel] )

Tells Spring the Killed script finished, and which wreckLevel to use. If wreckLevel is not given no wreck is created. May only be called after Killed has been called. DO NOT USE, the framework handles this transparently (it passes the return value of Killed into this function.)
[[Category:Unit_development]]
[[Category:Animation]]
[[Category:Lua]]

Animation-LuaCallouts

2012-11-04T05:09:26Z

Kingraptor: Clarified units of measure in the introduction

== Introduction ==

The new callouts are defined in the Spring.UnitScript table.

Types for arguments are only shown where they're ambiguous. For a number of (common) arguments, the types are:

* unitID: number
* piece: number
* axis: number (1 = x axis, 2 = y axis, 3 = z axis)
* destination: number (elmos (linear), radians (angular))
* speed: number (elmos (linear), radians per second (angular))
* accel/decel: number (radians per second per frame)

== Animation ==

'''Spring.UnitScript.SetPieceVisibility''' ( piece, boolean visible ) -> nil 
'''Spring.UnitScript.Show''' ( piece ) -> nil 
'''Spring.UnitScript.Hide''' ( piece ) -> nil

These may be used to show/hide pieces of the unit's model.

'''Spring.UnitScript.Move''' ( piece, axis, destination[, speed] ) -> nil

Move piece along axis to the destination position. If speed is given, the piece isn't moved immediately, but will move there at the desired speed. The X axis is mirrored compared to BOS/COB scripts, to match the direction of the X axis in Spring world space.

'''Spring.UnitScript.Turn''' ( piece, axis, destination[, speed] ) -> nil

Turn piece around axis to the destination angle. If speed is given, the piece isn't rotated immediately, but will turn at the desired angular velocity. Angles are in radians.
Always uses the shortest angular towards destinationdegree, and if at exactly 180 degrees opposide, will go counterclockwise.

'''Spring.UnitScript.Spin''' ( piece, axis, speed[, accel] ) -> nil

Makes piece spin around axis at the desired angular velocity. If accel is given, the piece does not start at this velocity at once, but will accelerate to it. Both negative and positive angular velocities are supported. Accel should always be positive, even if speed is negative.

Beware gimbal lock: http://en.wikipedia.org/wiki/Gimbal_lock

'''Spring.UnitScript.StopSpin''' ( piece, axis[, decel] ) -> nil

Stops a piece from spinning around the given axis. If decel is given, the piece does not stop at once, but will decelerate to it. Decel should always be positive. This function is similar to Spin(piece, axis, 0, decel), however, StopSpin also frees up the animation record.

'''Spring.UnitScript.IsInTurn''' (number piece, number axis) -> boolean 
'''Spring.UnitScript.IsInMove''' (number piece, number axis) -> boolean 
'''Spring.UnitScript.IsInSpin''' (number piece, number axis) -> boolean

Returns true if such an animation exists, false otherwise.

'''Spring.UnitScript.GetPieceTranslation''' ( piece ) -> number x, y, z 
'''Spring.UnitScript.GetPieceRotation''' ( piece ) -> number x, y, z

Get the current translation/rotation of a piece. The returned numbers match the values passed into Move and Turn.

'''Spring.UnitScript.GetPiecePosDir''' ( piece ) -> number px, py, pz, dx, dy, dz

Get the piece's position (px, py, pz) and direction (dx, dy, dz) in '''unit space'''. This is quite similar to ''Spring.GetUnitPiecePosDir'', however that function returns in '''world space'''.

== Threads ==

'''Spring.UnitScript.StartThread''' ( function fun, ... ) -> nil

Starts a new (animation) thread, which will execute the function 'fun'. All arguments except the function to run are passed as-is as arguments to 'fun'. [[Animation-CobThreads|COB-Threads]] has a decent description on COB threads, which are mimicked here in Lua using coroutines.

'''Spring.UnitScript.SetSignalMask''' ( number mask ) -> nil 
'''Spring.UnitScript.Signal''' ( number signal ) -> nil

These two support functions offer a powerful way to kill running threads. SetSignalMask assigns a mask to the currently running thread (any new threads started by this one will inherit the signal mask). Signal immediately stops all threads of this unit for which the bitwise and of mask and signal is not zero.

[http://springrts.com/phpbb/viewtopic.php?f=14&t=26274&start=2| What signal will stop which threads?]

'''Spring.UnitScript.WaitForMove''' ( piece, axis ) -> nil 
'''Spring.UnitScript.WaitForTurn''' ( piece, axis ) -> nil

Waits until the piece has stopped moving along / turning around the axis. If the piece is not animating, this functions return at once. You can not wait for a spin, because a spin does never finish.

'''Spring.UnitScript.Sleep''' ( number milliseconds ) -> nil

Waits a number of milliseconds before returning.

== Effects ==

'''Spring.UnitScript.EmitSfx''' ( piece, number id ) -> nil

Emits a [[CEG]] effect or weapon from the given piece. The id is based on one of the effect or weapon ids defined in the units unitdef. 
Example:

<pre>
--get the id of the CEG effects:
local smokecloud = SFX.CEG --the first effect from the list in the unitdef
local smokecloud2 = SFX.CEG +1 --the second effect from the list in the unitdef
local fire = SFX.CEG +2 --the third effect from the list in the unitdef
--get the id of the emiter piece:
local turret = piece "turret"
EmitSfx(turret, smokecloud) --emit the first effect
</pre>

'''Spring.UnitScript.ShowFlare''' ( number piece ) -> nil

Same as COB's show _inside_ FireWeaponX.

'''Spring.UnitScript.Explode''' ( piece, number flags ) -> nil

Explodes a piece, optionally creating a particle which flies off. Typically used inside Killed. Explode does not hide the piece by itself; if using it outside Killed you may want to Hide the piece immediately after. The flags may be any combination of:
* '''SFX.NONE''': do nothing after creating a heatcloud. Other flags have no effect, except NO_HEATCLOUD. If that is given too, the call is a no-op.
* '''SFX.SHATTER''': shatter the piece in many fragments. Only the NO_HEATCLOUD flag has any effect if this is present.
* '''SFX.EXPLODE''' | '''SFX.EXPLODE_ON_HIT''': the piece that flies of should explode when it hits something.
* '''SFX.FALL''': the piece should be affected by gravity (this is currently always forced on by Spring, to prevent pieces that float in air indefinitely).
* '''SFX.SMOKE''': leave smoke trail.
* '''SFX.FIRE''': the piece is on fire when it flies off.
* '''SFX.NO_CEG_TRAIL''': disable a CEG trail, if present.
* '''SFX.NO_HEATCLOUD''': suppress the heat cloud that's shown by default.

== Other ==

'''Spring.UnitScript.AttachUnit''' ( piece, passengerID ) -> nil 
'''Spring.UnitScript.DropUnit''' ( passengerID ) -> nil

Attaches or detaches another unit (a passenger, as this is designed for transports) to this unit. For AttachUnit, piece specifies the attachment point.

'''Spring.UnitScript.GetUnitValue''' ( ... ) -> number | number, number 
'''Spring.UnitScript.SetUnitValue''' ( ... ) -> nil

This may be used instead of COB's get and set codes. It is recommended however, to use dedicated Lua functions (e.g. Spring.GetUnitHealth(unitID) instead of GetUnitValue(4)): these functions should be considered a relic of the past.

Note that these are identical to Spring.GetUnitCOBValue and Spring.SetUnitCOBValue (see also [[Lua_SyncedCtrl#Lua_to_COB]] for the signature of those functions), except that an unitID argument shouldn't be passed to the versions in the Spring.UnitScript table.

'''Spring.UnitScript.GetLongestReloadTime''' ( unitID ) -> number reloadTime

Returns max(reload time) of all the unit's weapons in milliseconds. This utility function exists to aid in porting BOS scripts, which have a SetMaxReloadTime call-in that is called immediately after Create.

== Internal ==

You generally shouldn't need any of the following call-outs, they are provided by the engine to allow the Lua framework to do it's work.

'''Spring.UnitScript.CreateScript''' ( unitID, table callIns ) -> nil

This deletes the unit's current script (whether it's a COB or Lua script doesn't matter), and sets it up with a brand new Lua unit script, initially registering the call-ins given in the table as (string, function) pairs.

'''Spring.UnitScript.UpdateCallIn''' ( unitID, string name[, function callIn] ) -> nil

This updates a single call-in for the unit's current '''Lua''' unit script. If the unit does not currently have a Lua unit script, an error is raised. If the callIn argument is not given (or nil), the call-in with the given name is removed.

'''Spring.UnitScript.CallAsUnit''' ( unitID, function fun, ... ) -> nil

As none of the call-outs takes a unitID, the engine needs to know the ''active unit'' when one of those is called. Using this function another function can be called with the active unit set arbitrarily.

'''Spring.UnitScript.SetDeathScriptFinished''' ( [number wreckLevel] )

Tells Spring the Killed script finished, and which wreckLevel to use. If wreckLevel is not given no wreck is created. May only be called after Killed has been called. DO NOT USE, the framework handles this transparently (it passes the return value of Killed into this function.)
[[Category:Unit_development]]
[[Category:Animation]]
[[Category:Lua]]

Lua UnsyncedRead

2012-11-02T19:18:28Z

Kingraptor: /* GUI Settings */ Corrected GetMapDrawMode's return value when in pathing (F2) view

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}
=Unsynced Read=

== Replay/Spectating ==
'''Spring.IsReplay'''
( ) -> nil | boolean
'''Spring.GetSpectatingState'''
( ) -> boolean spectating, boolean fullView, boolean fullSelect

== ModUI ==
'''Spring.GetModUICtrl'''
( ) -> boolean

== MyInfo ==
'''Spring.GetMyAllyTeamID'''
( ) -> number
'''Spring.GetMyTeamID'''
( ) -> number
'''Spring.GetMyPlayerID'''
( ) -> number

== Local Player,Team,Ally ==
Redundant same as the GetMyXYZ functions!

'''Spring.GetLocalPlayerID'''
( ) -> number playerID
'''Spring.GetLocalTeamID'''
( ) -> number teamID
'''Spring.GetLocalAllyTeamID'''
( ) -> number allyID

== Team/Player Info ==
'''Spring.GetPlayerRoster'''
( [number sortType] ) ->
nil | playerTable = {
[1] = {
string name,
number playerID,
number teamID,
number allyTeamID,
boolean spectator,
number cpuUsage,
number pingTime
},
etc...
}

 Sort codes:
1 = Sort by allies (the default)
2 = Sort by teamID
3 = Sort by playerName
4 = Sort by CPU usage
5 = Sort by ping time
'''Spring.GetTeamColor'''
( number teamID ) -> nil | number r, number g, number b, number a
'''Spring.GetTeamOrigColor'''
( number teamID ) -> nil | number r, number g, number b, number a
'''Spring.GetPlayerTraffic'''
( number playerID [, number packetID] ) -> number

== Sound ==
'''Spring.GetSoundStreamTime'''
( ) -> number playedTime, number totalTime

== Camera ==
'''Spring.GetCameraNames'''
( ) -> { [camName] = number camNum, ... }
'''Spring.GetCameraState'''
( ) -> { "name" = string, "mode" = number camIdx, state1 = number, state2 = number, ... }

See [[Lua_camState]] for details about Spring.GetCameraState output.

'''Spring.GetCameraPosition'''
( ) -> number x, number y, number z
'''Spring.GetCameraDirection'''
( ) -> number forward_x, number forward_y, number forward_z
'''Spring.GetCameraFOV'''
( ) -> number fov
'''Spring.GetCameraVectors'''
( ) -> vectorTable = {
forward = { [1] = number x, [2] = number y, [3] = number z },
up = { [1] = number x, [2] = number y, [3] = number z },
right = { [1] = number x, [2] = number y, [3] = number z },
top = { [1] = number x, [2] = number y, [3] = number z },
bottom = { [1] = number x, [2] = number y, [3] = number z },
leftside = { [1] = number x, [2] = number y, [3] = number z },
rightside = { [1] = number x, [2] = number y, [3] = number z }
}

=== Inview ===
'''Spring.GetVisibleUnits'''
( [number teamID = -1 [, number radius = 30 [, boolean Icons = true ]]] )
-> nil | unitTable = { [1] = number unitID, ... }
'''Spring.GetVisibleFeatures'''
( [number allyTeamID = -1 [, number radius = 30 [, boolean Icons = true [, boolean geos = true ]]]] )
-> nil | featureTable = { [1] = number featureID, ... }

'''Spring.IsAABBInView'''
( number minX, number minY, number minZ,
number maxX, number maxY, number maxZ ) -> nil | boolean
'''Spring.IsSphereInView'''
( number x, number y, number z [, number radius ] ) -> nil | boolean
'''Spring.IsUnitIcon'''
( number unitID ) -> nil | boolean
'''Spring.IsUnitInView'''
( number unitID ) -> nil | boolean
'''Spring.IsUnitVisible'''
( number unitID [, number radius [, boolean checkIcons] ] ) -> nil | boolean

=== Screen Trace ===
'''Spring.WorldToScreenCoords'''
( number x, number y, number z ) -> number x, number y, number z
'''Spring.TraceScreenRay'''
( number mouseX, number mouseY [, boolean onlyCoords
[, boolean useMinimap, [boolean includeSky]] ] )
-> nil |
string "unit", number unitID |
string "feature", number featureID |
string "ground", { [1] = number x, [2] = number y, [3] = number z }

=== Screen & Window Geometry ===
'''Spring.GetViewGeometry'''
( ) -> number viewSizeX, number viewSizeY, number viewPosX, number viewPosY
'''Spring.GetWindowGeometry'''
( ) -> number winSizeX, number winSizeY, number winPosX, number winPosY
'''Spring.GetScreenGeometry''' (is missing multiscreen support!)
( ) -> number screenSizeX, number screenSizeY, number ZERO, number ZERO

== Unit ==
'''Spring.IsUnitAllied'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitViewPosition'''
( number unitID [, boolean midPos = false ] ) -> nil | number x, number y, number z
'''Spring.GetUnitTransformMatrix'''
( number unitID [, boolean invert = false] ) -> nil | number a11, number a12 ..., number a44 (4x4 matrix)

=== Selected Units ===
'''Spring.GetSelectedUnits'''
( ) -> { [1] = unitID, ... }
'''Spring.GetSelectedUnitsSorted'''
( ) -> { [number unitDefID] = { [1] = [number unitID], etc...}, ... }
'''Spring.GetSelectedUnitsCounts'''
( ) -> { [number unitDefID] = number count, etc... }
'''Spring.GetSelectedUnitsCount'''
( ) -> number count
'''Spring.IsUnitSelected'''
( number unitID ) -> nil | boolean

=== Unit Groups ===
'''Spring.GetUnitGroup'''
( number unitID ) -> nil | number

'''Spring.GetGroupList'''
( ) -> nil | {
[number] = number unitCount,
...
}
'''Spring.GetSelectedGroup'''
( ) -> number
'''Spring.GetGroupAIName'''
( number groupID ) -> string aiName
'''Spring.GetGroupAIList'''
( ) -> {
[1] = string aiName, ...
}

'''Spring.GetGroupUnits'''
( number groupID ) -> nil | {
[1] = number unitID, ...
}
'''Spring.GetGroupUnitsSorted'''
( number groupID ) -> nil | {
[number unitDefID] = {number unitID, ...}, ...
}
'''Spring.GetGroupUnitsCounts'''
( number groupID ) -> nil | {
[number unitDefID] = number count, ...
}
'''Spring.GetGroupUnitsCount'''
( number groupID ) -> nil | number count

== UI ==

=== GUI Settings ===
'''Spring.IsGUIHidden'''
( ) -> nil | boolean
'''Spring.HaveShadows'''
( ) -> nil | boolean
'''Spring.HaveAdvShading'''
( ) -> nil | boolean
'''Spring.GetWaterMode'''
( ) -> nil | number mode, string "mode"

 mode numbers:
0 - basic
1 - reflective
2 - dynamic
3 - refractive
4 - bumpwater
default - unknown
'''Spring.GetMapDrawMode'''
( ) -> nil | "normal" | "height" | "metal" | "pathTraversability" | "los"
'''Spring.GetDrawSelectionInfo''' Returns whether "Selected units" text is displayed.
( ) -> boolean

=== Unit GUI States ===
'''Spring.GetUnitLuaDraw'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitNoDraw'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitNoMinimap'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitNoSelect'''
( number unitID ) -> nil | boolean

=== Minimap ===
'''Spring.GetMiniMapGeometry'''
( ) -> number posX, number posY, number sizeX, number sizeY,
boolean minimized, boolean maximized
'''Spring.GetMiniMapDualScreen'''
( ) -> boolean false | string "left" | string "right"
'''Spring.IsAboveMiniMap'''
( number x, number y ) -> nil | boolean

=== (Build-)Menu ===
'''Spring.GetActiveCommand'''
( ) -> nil | number index (, number cmd_id, number cmd_type, string cmd_name)
'''Spring.GetDefaultCommand'''
( ) -> nil | number index (, number cmd_id, number cmd_type, string cmd_name)
'''Spring.GetActiveCmdDescs'''
( ) -> 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.GetActiveCmdDesc'''
( number index ) -> nil | {
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.GetCmdDescIndex'''
( number cmdID ) -> nil | number index
'''Spring.GetActivePage'''
( ) -> nil | number pageNum, number maxPages

=== Build Facing ===
'''Spring.GetBuildFacing'''
( ) -> nil | number
'''Spring.GetBuildSpacing'''
( ) -> nil | number

=== GatherMode & InvertQueueKey ===
'''Spring.GetGatherMode'''
( ) -> nil | number
'''Spring.GetInvertQueueKey'''
( ) -> nil | boolean

=== Mouse States ===
'''Spring.GetMouseState'''
( ) -> number X, number Y,
boolean leftPressed, boolean middlePressed, boolean rightPressed
'''Spring.GetMouseCursor'''
( ) -> string name, number scale
'''Spring.GetMouseStartPosition'''
( number mouseButton ) -> nil | number pressedX, number pressedY,
number camPosX, number camPosY, number camPosZ,
number dirX, number dirY, number dirZ

=== (Hot-)Keys ===
'''Spring.GetKeyState'''
( number key ) -> nil | boolean
'''Spring.GetModKeyState'''
( ) -> boolean alt, boolean ctrl, boolean meta, boolean shift
'''Spring.GetPressedKeys'''
( ) -> {
[number] = boolean,
...
}
'''Spring.GetKeyCode'''
( string keysym ) -> number
'''Spring.GetKeySymbol'''
( number key ) -> string "keysym1", string "keysym2"
'''Spring.GetKeyBindings'''
( string keyset ) -> nil | { [1] = {[string actionCmd] = string actionExtra}, ... }
'''Spring.GetActionHotKeys'''
( string action ) -> nil | { [1] = string hotKey, ... }

=== Console ===
'''Spring.GetLastMessagePositions'''
( ) -> nil | {
[1] = { number X, number Y, number Z },
...
}
'''Spring.GetConsoleBuffer'''
( [number maxLines] ) -> nil | {
[1] = {
text = string,
priority = number
}, ...
}
'''Spring.GetCurrentTooltip'''
( ) -> string

== FPS & GetDrawFrame ==
'''Spring.GetFPS'''
( ) -> number
'''Spring.GetDrawFrame'''
( ) -> number low 16bit, number high 16bit

== Time ==
'''Spring.GetFrameTimeOffset'''
( ) -> nil | number
'''Spring.GetLastUpdateSeconds'''
( ) -> nil | number
'''Spring.GetHasLag'''
( ) -> boolean
'''Spring.GetTimer'''
( ) -> timer
'''Spring.DiffTimers'''
( timer cur, timer ago) -> number seconds

== Rendering ==

'''Spring.GetMapSquareTexture'''
(number texSqrX, number texSqrY, number texMipLvl, string luaTexName) -> boolean success

[[category: Lua]]

Lua camState

2012-10-26T16:48:05Z

Kingraptor: /* TL;DR */ seems at least some of this info is only applicable to free cam

== TL;DR ==
'''px''', '''py''' and '''pz''' are camera position in world coords.

=== Free camera ===
'''rx''' and '''ry''' are camera rotation in radians about the X and Y axes respectively, where an rx of 0 is horizontal and an ry of 0 is facing south, positive values running anticlockwise. '''rz''' currently (91.0) does nothing.

'''dx''', '''dy''' and '''dz''' have ''nothing'' to do with camera rotation.

== The raw info ==
<pre>
I wanted to use Spring.SetCameraState( table camState, number camTime) -> nil | boolean

The wiki said: camState has the same format as the output of Spring.GetCameraState().

So I ran Spring.Echo(Spring.GetCameraState())
All I got was:
<table>
TABLE:

So, I ran, for every kind of camera:
for index,value in pairs(Spring.GetCameraState()) do
Spring.Echo(index,value)
end

This is what I got:

Switching to Overhead (TA) style camera
name : "ta"
mode : 1
px,py,pz : Position of the ground point in screen center (not camera position)
dx,dy,dz : Camera direction vector?
zscale: how tilted is the camera, from 10 (near horizontal) to 0.05 (near vertical). We have y/z = 1.0/zscale (with a -1 thrown in if flipped)
height : how much above the ground is the camera, cannot be negative -- '' it's absolute height of the camera, ie the camera positions y value, actually (so no difference if cam is above mountain or valley)~~~~''
flipped : -1 for when south is down, 1 for when north is down

exemple:
px, 2000
py, 70
pz, 1800
flipped, -1
dy, 0
name, ta
zscale, 0.5
height, 500
mode, 1
dx, 0
dz, 0

Switching to Total War style camera
rz, 0
rx, -0.9727737903595
name, tw
ry, 3.1415927410126
px, 477.53298950195
py, 100
pz, 447.54751586914
mode, 2

Switching to Rotatable overhead camera
name : "rot"
mode : 3
px,py,pz : Position of the ground point in screen center (not camera position) -- '' actually it seems to be the camera position to me (I set the height with py, not so sure about the others...) ~~~~''
dx,dy,dz : Camera direction vector?
rx,ry,rz : Camera rotation?
oldHeight : how much above the ground is the camera, cannot be negative, cannot be changed (I guess it's just in for when switching to a view that requires it next)

exemple:
px, 522.32415771484
py, 600
pz, 441.25302124023
rz, 0
dx, -4.9136563262664e-008
dy, -0.82505232095718
name, rot
ry, 3.1415927410126
rx, -0.9727737903595
mode, 3
dz, -0.56205677986145
oldHeight, 500

Switching to Free style camera
avx, 0
px, 522.32415771484
gravity, -500
pz, 873.39385986328
autoTilt, 2.6179938316345
dx, -0.011240424588323
dy, -0.82505232095718
dz, -0.5619443655014
py, 964.28167724609
gndOffset, 16
gndLock, -1
goForward, -1
mode, 4
tiltSpeed, 2.6179938316345
velTime, 1.5
slide, 0.5
avz, 0
rx, -0.9727737903595
invertAlt, -1
rz, 0
ry, 3.1615927219391
avy, 0
scrollSpeed, 100
name, free
fov, 45
vz, 0
avelTime, 1
vx, 0
vy, 0

Switching to Smooth style camera
px, 522.32415771484
py, 109.49719238281
pz, 873.39385986328
flipped, -1
dy, -0.89428168535233
name, sm
zscale, 0.5
height, 500
mode, 5
dx, 0
dz, -0.44714084267616

Switching to Orbit style camera
tx, 522.32415771484
ty, 241.19664001465
name, OrbitController
tz, 644.45776367188
px, 522.32415771484
py, 556.63806152344
pz, 873.39385986328
mode, 6

Switching to FPS style camera
px, 1233.4810791016
py, 554.39453125
pz, 873.39385986328
rz, 0
dx, -0.011240424588323
dy, -0.82505232095718
name, fps
ry, 3.1615927219391
rx, -0.9727737903595
mode, 0
dz, -0.5619443655014
oldHeight, 300

Switching to Overhead (TA) style camera
px, 1324.8835449219
py, 254.39453125
pz, 871.56591796875
flipped, -1
dy, -0.89428168535233
name, ta
zscale, 0.5
height, 713.52716064453
mode, 1
dx, 0
dz, -0.44714084267616

Now someone go comment that.

It appears that mod eis simply a number containing the same information as name, but while name is a string, mode is an integer between 0 and 6.

I guess px,py,pz could be the postion, while dx,dy,dz could be the direction?

But what is height? What is zscale? What is flipped? What is oldHeigh? What are rx,ry,rz? Why has orbit no dx,dy,dz but some tx,ty,tz? What about all the free style camera settings? If you know edit that page please!

From testing, I found out flipped invert north/south depending on whether it's negative or positive.

From testing, I found out zscale is how horizontal/vertical are some camera, 10 for almost horizontal TA overhead, 0.05 for almost vertical TA overhead.
</pre>
[[Category: Lua]]

Lua camState

2012-10-26T16:23:37Z

Kingraptor: /* TL;DR */

== TL;DR ==
'''px''', '''py''' and '''pz''' are camera position in world coords.

'''rx''' and '''ry''' are camera rotation in radians about the X and Y axes respectively, where an rx of 0 is horizontal and an ry of 0 is facing south, positive values running anticlockwise. '''rz''' currently (91.0) does nothing.

'''dx''', '''dy''' and '''dz''' have ''nothing'' to do with camera rotation.

== The raw info ==
<pre>
I wanted to use Spring.SetCameraState( table camState, number camTime) -> nil | boolean

The wiki said: camState has the same format as the output of Spring.GetCameraState().

So I ran Spring.Echo(Spring.GetCameraState())
All I got was:
<table>
TABLE:

So, I ran, for every kind of camera:
for index,value in pairs(Spring.GetCameraState()) do
Spring.Echo(index,value)
end

This is what I got:

Switching to Overhead (TA) style camera
name : "ta"
mode : 1
px,py,pz : Position of the ground point in screen center (not camera position)
dx,dy,dz : Camera direction vector?
zscale: how tilted is the camera, from 10 (near horizontal) to 0.05 (near vertical). We have y/z = 1.0/zscale (with a -1 thrown in if flipped)
height : how much above the ground is the camera, cannot be negative -- '' it's absolute height of the camera, ie the camera positions y value, actually (so no difference if cam is above mountain or valley)~~~~''
flipped : -1 for when south is down, 1 for when north is down

exemple:
px, 2000
py, 70
pz, 1800
flipped, -1
dy, 0
name, ta
zscale, 0.5
height, 500
mode, 1
dx, 0
dz, 0

Switching to Total War style camera
rz, 0
rx, -0.9727737903595
name, tw
ry, 3.1415927410126
px, 477.53298950195
py, 100
pz, 447.54751586914
mode, 2

Switching to Rotatable overhead camera
name : "rot"
mode : 3
px,py,pz : Position of the ground point in screen center (not camera position) -- '' actually it seems to be the camera position to me (I set the height with py, not so sure about the others...) ~~~~''
dx,dy,dz : Camera direction vector?
rx,ry,rz : Camera rotation?
oldHeight : how much above the ground is the camera, cannot be negative, cannot be changed (I guess it's just in for when switching to a view that requires it next)

exemple:
px, 522.32415771484
py, 600
pz, 441.25302124023
rz, 0
dx, -4.9136563262664e-008
dy, -0.82505232095718
name, rot
ry, 3.1415927410126
rx, -0.9727737903595
mode, 3
dz, -0.56205677986145
oldHeight, 500

Switching to Free style camera
avx, 0
px, 522.32415771484
gravity, -500
pz, 873.39385986328
autoTilt, 2.6179938316345
dx, -0.011240424588323
dy, -0.82505232095718
dz, -0.5619443655014
py, 964.28167724609
gndOffset, 16
gndLock, -1
goForward, -1
mode, 4
tiltSpeed, 2.6179938316345
velTime, 1.5
slide, 0.5
avz, 0
rx, -0.9727737903595
invertAlt, -1
rz, 0
ry, 3.1615927219391
avy, 0
scrollSpeed, 100
name, free
fov, 45
vz, 0
avelTime, 1
vx, 0
vy, 0

Switching to Smooth style camera
px, 522.32415771484
py, 109.49719238281
pz, 873.39385986328
flipped, -1
dy, -0.89428168535233
name, sm
zscale, 0.5
height, 500
mode, 5
dx, 0
dz, -0.44714084267616

Switching to Orbit style camera
tx, 522.32415771484
ty, 241.19664001465
name, OrbitController
tz, 644.45776367188
px, 522.32415771484
py, 556.63806152344
pz, 873.39385986328
mode, 6

Switching to FPS style camera
px, 1233.4810791016
py, 554.39453125
pz, 873.39385986328
rz, 0
dx, -0.011240424588323
dy, -0.82505232095718
name, fps
ry, 3.1615927219391
rx, -0.9727737903595
mode, 0
dz, -0.5619443655014
oldHeight, 300

Switching to Overhead (TA) style camera
px, 1324.8835449219
py, 254.39453125
pz, 871.56591796875
flipped, -1
dy, -0.89428168535233
name, ta
zscale, 0.5
height, 713.52716064453
mode, 1
dx, 0
dz, -0.44714084267616

Now someone go comment that.

It appears that mod eis simply a number containing the same information as name, but while name is a string, mode is an integer between 0 and 6.

I guess px,py,pz could be the postion, while dx,dy,dz could be the direction?

But what is height? What is zscale? What is flipped? What is oldHeigh? What are rx,ry,rz? Why has orbit no dx,dy,dz but some tx,ty,tz? What about all the free style camera settings? If you know edit that page please!

From testing, I found out flipped invert north/south depending on whether it's negative or positive.

From testing, I found out zscale is how horizontal/vertical are some camera, 10 for almost horizontal TA overhead, 0.05 for almost vertical TA overhead.
</pre>
[[Category: Lua]]

Lua camState

2012-10-26T16:21:45Z

Kingraptor: /* TL;DR */

== TL;DR ==
'''px''', '''py''' and '''pz''' are camera position in world coords.

'''rx''' and '''ry''' are camera rotation in radians about the X and Y axes respectively, where an rx of 0 is horizontal and an ry of 0 is facing south. '''rz''' currently (91.0) does nothing.

'''dx''', '''dy''' and '''dz''' have ''nothing'' to do with camera rotation.

== The raw info ==
<pre>
I wanted to use Spring.SetCameraState( table camState, number camTime) -> nil | boolean

The wiki said: camState has the same format as the output of Spring.GetCameraState().

So I ran Spring.Echo(Spring.GetCameraState())
All I got was:
<table>
TABLE:

So, I ran, for every kind of camera:
for index,value in pairs(Spring.GetCameraState()) do
Spring.Echo(index,value)
end

This is what I got:

Switching to Overhead (TA) style camera
name : "ta"
mode : 1
px,py,pz : Position of the ground point in screen center (not camera position)
dx,dy,dz : Camera direction vector?
zscale: how tilted is the camera, from 10 (near horizontal) to 0.05 (near vertical). We have y/z = 1.0/zscale (with a -1 thrown in if flipped)
height : how much above the ground is the camera, cannot be negative -- '' it's absolute height of the camera, ie the camera positions y value, actually (so no difference if cam is above mountain or valley)~~~~''
flipped : -1 for when south is down, 1 for when north is down

exemple:
px, 2000
py, 70
pz, 1800
flipped, -1
dy, 0
name, ta
zscale, 0.5
height, 500
mode, 1
dx, 0
dz, 0

Switching to Total War style camera
rz, 0
rx, -0.9727737903595
name, tw
ry, 3.1415927410126
px, 477.53298950195
py, 100
pz, 447.54751586914
mode, 2

Switching to Rotatable overhead camera
name : "rot"
mode : 3
px,py,pz : Position of the ground point in screen center (not camera position) -- '' actually it seems to be the camera position to me (I set the height with py, not so sure about the others...) ~~~~''
dx,dy,dz : Camera direction vector?
rx,ry,rz : Camera rotation?
oldHeight : how much above the ground is the camera, cannot be negative, cannot be changed (I guess it's just in for when switching to a view that requires it next)

exemple:
px, 522.32415771484
py, 600
pz, 441.25302124023
rz, 0
dx, -4.9136563262664e-008
dy, -0.82505232095718
name, rot
ry, 3.1415927410126
rx, -0.9727737903595
mode, 3
dz, -0.56205677986145
oldHeight, 500

Switching to Free style camera
avx, 0
px, 522.32415771484
gravity, -500
pz, 873.39385986328
autoTilt, 2.6179938316345
dx, -0.011240424588323
dy, -0.82505232095718
dz, -0.5619443655014
py, 964.28167724609
gndOffset, 16
gndLock, -1
goForward, -1
mode, 4
tiltSpeed, 2.6179938316345
velTime, 1.5
slide, 0.5
avz, 0
rx, -0.9727737903595
invertAlt, -1
rz, 0
ry, 3.1615927219391
avy, 0
scrollSpeed, 100
name, free
fov, 45
vz, 0
avelTime, 1
vx, 0
vy, 0

Switching to Smooth style camera
px, 522.32415771484
py, 109.49719238281
pz, 873.39385986328
flipped, -1
dy, -0.89428168535233
name, sm
zscale, 0.5
height, 500
mode, 5
dx, 0
dz, -0.44714084267616

Switching to Orbit style camera
tx, 522.32415771484
ty, 241.19664001465
name, OrbitController
tz, 644.45776367188
px, 522.32415771484
py, 556.63806152344
pz, 873.39385986328
mode, 6

Switching to FPS style camera
px, 1233.4810791016
py, 554.39453125
pz, 873.39385986328
rz, 0
dx, -0.011240424588323
dy, -0.82505232095718
name, fps
ry, 3.1615927219391
rx, -0.9727737903595
mode, 0
dz, -0.5619443655014
oldHeight, 300

Switching to Overhead (TA) style camera
px, 1324.8835449219
py, 254.39453125
pz, 871.56591796875
flipped, -1
dy, -0.89428168535233
name, ta
zscale, 0.5
height, 713.52716064453
mode, 1
dx, 0
dz, -0.44714084267616

Now someone go comment that.

It appears that mod eis simply a number containing the same information as name, but while name is a string, mode is an integer between 0 and 6.

I guess px,py,pz could be the postion, while dx,dy,dz could be the direction?

But what is height? What is zscale? What is flipped? What is oldHeigh? What are rx,ry,rz? Why has orbit no dx,dy,dz but some tx,ty,tz? What about all the free style camera settings? If you know edit that page please!

From testing, I found out flipped invert north/south depending on whether it's negative or positive.

From testing, I found out zscale is how horizontal/vertical are some camera, 10 for almost horizontal TA overhead, 0.05 for almost vertical TA overhead.
</pre>
[[Category: Lua]]

Lua camState

2012-10-26T16:20:56Z

Kingraptor: A small amount of info gleaned from my testing.

== TL;DR ==
'''px''', '''py''' and '''pz''' are camera position in world coords.

'''rx''' and '''ry''' are camera rotation in radians about the X and Y axes respectively. '''rz''' currently (91.0) does nothing.

'''dx''', '''dy''' and '''dz''' have ''nothing'' to do with camera rotation.

== The raw info ==
<pre>
I wanted to use Spring.SetCameraState( table camState, number camTime) -> nil | boolean

The wiki said: camState has the same format as the output of Spring.GetCameraState().

So I ran Spring.Echo(Spring.GetCameraState())
All I got was:
<table>
TABLE:

So, I ran, for every kind of camera:
for index,value in pairs(Spring.GetCameraState()) do
Spring.Echo(index,value)
end

This is what I got:

Switching to Overhead (TA) style camera
name : "ta"
mode : 1
px,py,pz : Position of the ground point in screen center (not camera position)
dx,dy,dz : Camera direction vector?
zscale: how tilted is the camera, from 10 (near horizontal) to 0.05 (near vertical). We have y/z = 1.0/zscale (with a -1 thrown in if flipped)
height : how much above the ground is the camera, cannot be negative -- '' it's absolute height of the camera, ie the camera positions y value, actually (so no difference if cam is above mountain or valley)~~~~''
flipped : -1 for when south is down, 1 for when north is down

exemple:
px, 2000
py, 70
pz, 1800
flipped, -1
dy, 0
name, ta
zscale, 0.5
height, 500
mode, 1
dx, 0
dz, 0

Switching to Total War style camera
rz, 0
rx, -0.9727737903595
name, tw
ry, 3.1415927410126
px, 477.53298950195
py, 100
pz, 447.54751586914
mode, 2

Switching to Rotatable overhead camera
name : "rot"
mode : 3
px,py,pz : Position of the ground point in screen center (not camera position) -- '' actually it seems to be the camera position to me (I set the height with py, not so sure about the others...) ~~~~''
dx,dy,dz : Camera direction vector?
rx,ry,rz : Camera rotation?
oldHeight : how much above the ground is the camera, cannot be negative, cannot be changed (I guess it's just in for when switching to a view that requires it next)

exemple:
px, 522.32415771484
py, 600
pz, 441.25302124023
rz, 0
dx, -4.9136563262664e-008
dy, -0.82505232095718
name, rot
ry, 3.1415927410126
rx, -0.9727737903595
mode, 3
dz, -0.56205677986145
oldHeight, 500

Switching to Free style camera
avx, 0
px, 522.32415771484
gravity, -500
pz, 873.39385986328
autoTilt, 2.6179938316345
dx, -0.011240424588323
dy, -0.82505232095718
dz, -0.5619443655014
py, 964.28167724609
gndOffset, 16
gndLock, -1
goForward, -1
mode, 4
tiltSpeed, 2.6179938316345
velTime, 1.5
slide, 0.5
avz, 0
rx, -0.9727737903595
invertAlt, -1
rz, 0
ry, 3.1615927219391
avy, 0
scrollSpeed, 100
name, free
fov, 45
vz, 0
avelTime, 1
vx, 0
vy, 0

Switching to Smooth style camera
px, 522.32415771484
py, 109.49719238281
pz, 873.39385986328
flipped, -1
dy, -0.89428168535233
name, sm
zscale, 0.5
height, 500
mode, 5
dx, 0
dz, -0.44714084267616

Switching to Orbit style camera
tx, 522.32415771484
ty, 241.19664001465
name, OrbitController
tz, 644.45776367188
px, 522.32415771484
py, 556.63806152344
pz, 873.39385986328
mode, 6

Switching to FPS style camera
px, 1233.4810791016
py, 554.39453125
pz, 873.39385986328
rz, 0
dx, -0.011240424588323
dy, -0.82505232095718
name, fps
ry, 3.1615927219391
rx, -0.9727737903595
mode, 0
dz, -0.5619443655014
oldHeight, 300

Switching to Overhead (TA) style camera
px, 1324.8835449219
py, 254.39453125
pz, 871.56591796875
flipped, -1
dy, -0.89428168535233
name, ta
zscale, 0.5
height, 713.52716064453
mode, 1
dx, 0
dz, -0.44714084267616

Now someone go comment that.

It appears that mod eis simply a number containing the same information as name, but while name is a string, mode is an integer between 0 and 6.

I guess px,py,pz could be the postion, while dx,dy,dz could be the direction?

But what is height? What is zscale? What is flipped? What is oldHeigh? What are rx,ry,rz? Why has orbit no dx,dy,dz but some tx,ty,tz? What about all the free style camera settings? If you know edit that page please!

From testing, I found out flipped invert north/south depending on whether it's negative or positive.

From testing, I found out zscale is how horizontal/vertical are some camera, 10 for almost horizontal TA overhead, 0.05 for almost vertical TA overhead.
</pre>
[[Category: Lua]]

Lua UnsyncedCtrl

2012-01-24T04:34:27Z

Kingraptor: Multiple sound streams can be played at once

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

<div class="note">
NOTE: Entries below marked (needs ModUICtrl) require the setting ModUICtrl to be enabled in the users [[springrc]], if you want to use them in unsynced LuaRules/LuaGaia. It is enabled by default so you generally don't need to care.</div>

= UI =
'''Spring.SetLastMessagePosition'''
( number x, number y, number z ) -> nil

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

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

'''Spring.SendCommands''' (needs ModUICtrl)
( string command1 [, string command2 [ ... ] ] ) -> nil
( {string command1, string command2, ...} ) -> nil

== GUI ==
'''Spring.SetActiveCommand''' (needs ModUICtrl)
( string action [, string actionExtra ] ) -> nil | boolean
( number cmdIndex [, number button = 1
[, boolean leftClick, boolean rightClick,
boolean alt, boolean ctrl, boolean meta, boolean shift]] ) -> nil | boolean
'''Spring.ForceLayoutUpdate''' (needs ModUICtrl)
( ) -> nil
'''Spring.SetDrawSelectionInfo''' disables the "Selected Units x" box in the GUI (needs ModUICtrl)
( boolean enable ) -> nil

== Mouse ==
'''Spring.SetMouseCursor''' (needs ModUICtrl)
( string cursorName [, number scale ] ) -> nil
'''Spring.WarpMouse''' (needs ModUICtrl)
( number x, number y ) -> nil

== LOS Colors ==
'''Spring.SetLosViewColors''' (needs ModUICtrl)
( table reds = { number always, number LOS, number radar, number jam },
table greens = { number always, number LOS, number radar, number jam },
table blues = { number always, number LOS, number radar, number jam } ) -> nil

== 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
Funfact:
<PLAYER#> (with # being a playerid) inside the string will be replaced with the players name.
ie
Spring.SendMessage ("<PLAYER1> did something")
might display as "ProRusher did something"

== Markers ==
'''Spring.MarkerAddPoint''' (needs ModUICtrl)
( number x, number y, number z [, string text = ""] ) -> nil
'''Spring.MarkerAddLine''' (needs ModUICtrl)
( number x1, number y1, number z1, number x2, number y2, number z2 ) -> nil
'''Spring.MarkerErasePosition''' (needs ModUICtrl)
( number x, number y, number z ) -> nil

= Sounds =
'''Spring.LoadSoundDef'''
( string "soundfile" ) -> nil | boolean success
Loads a SoundDefs file, the format is the same as in `gamedata/sounds.lua`.

'''Spring.PlaySoundFile''' Plays WAV or OGG sounds.
( string "soundfile" [, number volume = 1.0
[, number posx, number posy, number posz
[, number speedx, number speedy, number speedz ] ] ], [string/number channel ] ) -> nil | boolean
`channel` is new in Spring0.83, and can be one of those:
"general" || 0 || nil (default)
"battle" || "sfx" | 1
"unitreply" || "voice" || 2
"userinterface" || "ui" || 3


'''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. In 83.0 and up multiple sound streams may be played at once 
'''Spring.StopSoundStream'''
( ) -> nil
Terminates any SoundStream currently running.
'''Spring.PauseSoundStream'''
( ) -> nil
'''Spring.SetSoundStreamVolume'''
( number volume ) -> nil

= SendLuaMessage =
Very important! (allows synced inter-lua-enviroment communications)

'''Spring.SendLuaUIMsg''' (needs ModUICtrl)
( string message, string mode ) -> nil
possible modes are: "s"/"specs" & "a"/"allies"
'''Spring.SendLuaGaiaMsg''' (needs ModUICtrl)
( string message ) -> nil
'''Spring.SendLuaRulesMsg''' (needs ModUICtrl)
( string message ) -> nil

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

'''Spring.SetDrawSelectionInfo'''
( boolean drawSelectionInfo ) -> nil

== Unit Group ==
'''Spring.SetUnitGroup''' (needs ModUICtrl)
( number unitID, number groupID ) -> nil

== Give Order ==
'''Spring.GiveOrder''' gives order to all selected units (needs ModUICtrl)
( number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"} ) -> nil | boolean true
'''Spring.GiveOrderToUnit''' (needs ModUICtrl)
( number unitID,
number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"} ) -> nil | boolean true
'''Spring.GiveOrderToUnitMap''' (needs ModUICtrl)
( unitMap = { [unitID] = dontCare, etc... },
number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"} ) -> nil | boolean true
'''Spring.GiveOrderToUnitArray''' (needs ModUICtrl)
( unitArray = { [1] = unitID, etc... },
number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"} ) -> nil | boolean true
'''Spring.GiveOrderArrayToUnitMap''' (needs ModUICtrl)
( unitMap = { [number unitID] = dontCare, etc... },
orderArray = {
{ number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"}
}, ..
}
) -> nil | boolean true
'''Spring.GiveOrderArrayToUnitArray''' (needs ModUICtrl)
( unitArray = { [1] = number unitID, etc... },
orderArray = {
{ number cmdID,
params = {number, etc...},
options = {"alt", "ctrl", "shift", "right"}
}, ..
}
) -> nil | boolean true

'''Spring.SetBuildFacing'''
( int Facing ) -> nil

'''Spring.SetBuildSpacing'''
( int Spacing ) -> nil

== Unit NoDraw,NoSelect,NoMinimap ==
'''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

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

'''Spring.SetWaterParams''' needs cheating enabled!
( table params ) -> nil
Allows to change water params (mostly BumpWater ones) at runtime. You may want to set BumpWaterUseUniforms in your [[springrc]] to 1, then you don't even need to restart BumpWater via `/water 4`. 
`params` table may contain:
params = {
absorb = {number r, number g, number b},
baseColor = {number r, number g, number b},
minColor = {number r, number g, number b},
surfaceColor = {number r, number g, number b},
diffuseColor = {number r, number g, number b},
specularColor = {number r, number g, number b},
planeColor = {number r, number g, number b},
texture = string file,
foamTexture = string file,
normalTexture = string file,
damage = number value,
repeatX = number value,
repeatY = number value,
surfaceAlpha = number value,
ambientFactor = number value,
diffuseFactor = number value,
specularFactor = number value,
specularPower = number value,
fresnelMin = number value,
fresnelMax = number value,
fresnelPower = number value,
reflectionDistortion = number value,
blurBase = number value,
blurExponent = number value,
perlinStartFreq = number value,
perlinLacunarity = number value,
perlinAmplitude = number value,
numTiles = number value,
shoreWaves = boolean value,
forceRendering = boolean value,
hasWaterPlane = boolean value,
}

= GUI =
'''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''' changes/creates the cursor of a single CursorCmd
( string "cmdName", string "iconFileName"
[, boolean overwrite = true [, boolean hotSpotTopLeft = false] ] ) -> nil | boolean
Note, that iconFileName is not the full filename instead it is like this:
filename: Anims/cursorattack_0.bmp
iconFileName: cursorattack


'''Spring.ReplaceMouseCursor''' mass replace all occurrence of the cursor in all CursorCmds
( string "oldFileName", string "newFileName" [, boolean hotSpotTopLeft = false] ) -> 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

= Sharing =
'''Spring.SetShareLevel''' note: shareLevel is 0<= x <= 1 (needs ModUICtrl)
( string "metal" | "energy", number shareLevel ) -> nil
'''Spring.ShareResources''' (needs ModUICtrl)
( number teamID, string "units" ) -> nil
( number teamID, string "metal" | "energy", number amount ) -> nil

= UnitDef RadarIcons & BuildPics =
'''Spring.AddUnitIcon'''
( string iconName, string texFile [, number size [, number dist [, boolean radAdjust ]]] ) -> nil | boolean
'''Spring.FreeUnitIcon'''
( string iconName ) -> nil | boolean
'''Spring.SetUnitDefIcon''' (RadarIcon) (needs ModUICtrl)
( number unitDefID, string iconName ) -> nil
'''Spring.SetUnitDefImage''' (BuildPic) (needs ModUICtrl)
( number unitDefID, luaTexture | string texFile ) -> nil

= Camera =
'''Spring.SetCameraState'''
( table camState, number camTime) -> nil | boolean
camState has the same format as the output of Spring.GetCameraState(). See [[Lua_camState]] for details about camState.

'''Spring.SetCameraTarget'''
( number x, number z, number y [,number transTime] ) -> nil
For Spring Engine XZ represents horizontal, from north west corner of map and Y vertical, from water level and rising.

'''Spring.SetCameraOffset''' (needs ModUICtrl)
( [number px = 0 [, number py = 0 [, number pz = 0
[, number tx = 0 [, number ty = 0 [, number tz = 0]]]]]] ) -> nil

= (Virtual-)FileSystem =
'''Spring.ExtractModArchiveFile'''
( string modfile ) -> boolean
'''Spring.CreateDir''' (needs ModUICtrl)
( number path ) -> nil | boolean

= Engine Config =
The following functions read the engine configs saved in [[springrc]], a version-ed instance of these or a custom file supplied on the command line.
If ''*Overlay'' is ''true'', the value will only be set in memory, and not be restored for the next game

'''Spring.GetConfigInt''' (needs ModUICtrl)
( string name [, number default [, boolean setInOverlay = false]] ) -> nil | number
'''Spring.SetConfigInt''' (needs ModUICtrl)
( string name, number value [, boolean useOverlay = false] ) -> nil
'''Spring.GetConfigString''' (needs ModUICtrl)
( string name [, string default [, boolean setInOverlay = false]] ) -> nil | string
'''Spring.SetConfigString''' (needs ModUICtrl)
( string name, string value [, boolean useOverlay = false] ) -> 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

= Misc =

'''Spring.Restart''' (0.79+)
( string commandline_args, string startscript )
-> if this call returns, something went wrong
''commandline_args'' are commandline arguments passed to spring executable

start-script is the CONTENT of the script.txt spring should use to start (if empty, no start-script is added, you can still point spring to your custom script.txt when you add the file-path to ''commandline_args''

'''Spring.SetWMIcon''' (0.83+)
( string iconFileName ) -> nil
Sets the icon for the process which is seen in the OS task-bar and other places (default: spring-logo). 
Note: has to be 24bit or 32bit 
Note: on windows, it has to be 32x32 pixels in size (recommended for cross-platform) 
Note: ''*.bmp'' images have to be in BGR format (default for m$ ones). 
Note: ''*.ico'' images are not supported.

'''Spring.SetWMCaption''' (0.83+)
( string title [, string titleShort = title ] ) -> nil

Sets the window ''title'' for the process (default: "Spring <version>").

The ''shortTitle'' is displayed in the OS task-bar (default: "Spring <version>").

'''NOTE:''' ''shortTitle'' is only ever possibly used under X11 (Linux & OS X), but not with QT (KDE) and never under Windows. See [http://www.gpwiki.org/index.php/SDL:Tutorials:Initializing_SDL_Libraries#About_the_icon_.28.22Icon_Title.22.29_parameter_on_different_window-managers this site] for more details.

= Rendering =
NOTE: these (0.83+) lighting callouts only work when called from unsynced gadgets!

'''Spring.AddMapLight''' (requires MaxDynamicMapLights > 0)
(table lightParams) -> number lightHandle
'''Spring.AddModelLight''' (requires MaxDynamicModelLights > 0)
(table lightParams) -> number lightHandle

'''Spring.UpdateMapLight'''
(number lightHandle, table lightParams) -> boolean success
'''Spring.UpdateModelLight'''
(number lightHandle, table lightParams) -> boolean success

'''Spring.SetMapLightTrackingState'''
(number lightHandle, number unitOrProjectileID,
boolean enableTracking, boolean unitOrProjectile) -> boolean success
'''Spring.SetModelLightTrackingState'''
(number lightHandle, number unitOrProjectileID,
boolean enableTracking, boolean unitOrProjectile) -> boolean success

'''lightParams''' is a table that should contain at least one of the following recognized key/value pairs:

lightParams = {
position = {px, py, pz},
direction = {dx, dy, dz},
ambientColor = {red, green, blue},
diffuseColor = {red, green, blue},
specularColor = {red, green, blue},
intensityWeight = {ambientWeight, diffuseWeight, specularWeight},

-- per-frame decay of ambientColor (spread over TTL frames)
ambientDecayRate = {ambientRedDecay, ambientGreenDecay, ambientBlueDecay},
-- per-frame decay of diffuseColor (spread over TTL frames)
diffuseDecayRate = {diffuseRedDecay, diffuseGreenDecay, diffuseBlueDecay},
-- per-frame decay of specularColor (spread over TTL frames)
specularDecayRate = {specularRedDecay, specularGreenDecay, specularBlueDecay},
-- *DecayType = 0.0 -> interpret *DecayRate values as linear, else as exponential
decayFunctionType = {ambientDecayType, diffuseDecayType, specularDecayType},

radius = number elmos,
fov = number degrees,
ttl = number frames,
priority = number,
}

'''Spring.SetMapSquareTexture'''
(number texSqrX, number texSqrY, string luaTexName) -> boolean success
'''Spring.GetMapSquareTexture'''
(number texSqrX, number texSqrY, number texMipLvl, string luaTexName) -> boolean success

[[category: Lua]]

Gamedev:CollisionVolumes

2011-05-14T07:32:48Z

Kingraptor: Some refinements

==What is a collision volume?==
The collision volume is a geometric shape around (almost) all Spring units.
If a projectile collides with this shape, the engine registers it as a hit.
Other names are hitbox, hitsphere etc.

http://springrts.com/mediawiki/images/0/06/Units_with_hitboxes.jpg

==How to see them ingame==
Press ctrl + b and look at the black wireframe shapes around units.
If you can not see them, the collision volume might be blocked from view by the 3D model or be very offset like underground or in the sky.
Red shapes indicate the unit was hit.

==What else are they used for?==
*collision between units
*when selecting units, where you have to click
???

==How to edit their shape==
===What are they measured in?===
[http://answers.springlobby.info/questions/339/dimension-of-spring in elmos.]
===In Upspring===
in the 3D view, click on the blue "3D" text and a menu opens. 
Click "draw model radius + height" 
At the right side, go to the "Model" tab and edit the values. 
With Upspring, you can only define sphere shaped collision volumes. 

editing_hitbox_in_upspring.jpg

===in the UnitDef===
There are numerous [http://springrts.com/wiki/Units:FBI tags] that controll shape, size, position of the collision volume.
You have to restart spring.exe for the changes to take effect, there is no way to reload unitdefs.

<pre>collisionVolumeOffsets = [[0 0 0]],</pre> position of the collision volume, in this example center of the unit. The value is relative to the unit center set in Upspring.

<pre>collisionVolumeType = [[box]],</pre>
defines the shape. possible are: ''box'', ''ellipsoid'' and cylinders:
''CylX'', ''CylY'', ''CylZ''

<pre>collisionVolumeScales = = [[40 20 55]]</pre>
dimensions along X Y Z axes.

====boxxy the hitbox editor====
This creation allows you move hitboxes by pressing buttons.
This way you can get the needed numbers and copy them to the unitdef file.

http://h-4.abload.de/img/loveandtrolls25t5u.gif

[http://springrts.com/phpbb/viewtopic.php?f=14&t=24882 forum thread]

===Multiple collision volumes===
A unit can have multiple collision volumes. For example a tank could use a box for the chasis and a cylinder for the turret.

Each piece can have its own collision volume. <pre>usePieceCollisionVolumes = true,</pre> will cause each piece on the model to have an autogenerated hitvolume; unwanted hitvolumes can then be removed with Lua.

==Can they be changed during gameplay?==
Yes. One example would be "pop up" turrets that get a smaller hitbox when sunken into the ground etc.
See <code>Spring.SetUnitCollisionVolumeData()</code> and <code>Spring.SetUnitPieceCollisionVolumeData()</code>
at [[Lua_SyncedCtrl]]
There seems to be no noticeable cpu usage when dynamically adjusting collision volumes.

==CPU Usage of non-sphere volumes==
For the engine, collision with a sphere are fastest to calculate. Cylinders and boxes require more math and so are slower.
How much does it really matter? No idea.

==Unit radius & height VS collision volume==
When a unit uses a box volume, is the unit radius that was set in Upspring used for ''anything?''
Unit-Unit collision? Selecting?

==Which spot on an enemy do units target==
The model center set in Upspring

==Common problems (and how to solve)==
===weapons miss the unit===
Weapons like Dgun and torpedos might pass through under the unit if the hitvolume does not extend a bit into the ground/underwater.

===Intersecting hitboxes===
Two near units might refuse to shoot if their turrets intersect with each other's hitboxes.

===Fast projectiles passing through collision volumes===
The problem: fast projectiles sometimes fly through small hit volumes without causing damage:
http://h-3.abload.de/img/screenshot_xta_spring_2gmr.jpg
The solution: <code>collisionVolumeTest = true,</code> in the unitDef and hits will register correctlu.

==Hitbox related weapon tags==
<pre>targetBorder = 1,</pre> unit targets the border of the hit volume instead of its center.
only works on hitspheres: http://springrts.com/phpbb/viewtopic.php?f=12&t=18824&p=352456&hilit=targetborder#p352456 (???)

others???

==Aircraft==
The hitspheres of airplanes seem to be scaled down -50% by the engine.

==Engine code==
related engine parts are:
1 ...
2 ...
...

[[Category:Unit development]]

Lua OpenGL Api

2011-04-01T05:12:55Z

Kingraptor: /* LineWidth & PointSize */ Added ATI warning for pointsize

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

= 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''' used for Unit LODs
( number screenWidth, number screenDistance ) -> nil

'''gl.DrawMiniMap''' argument new in 0.82+
( boolean tansform = true ) -> nil

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

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

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

= Matrices & Viewport =
'''gl.Viewport'''
( number x, number y, number w, number h ) -> nil

'''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.Billboard'''
( ) -> nil
Use this to draw 2d primitives in DrawWorld().
To render a 2D billboarded quad in the gameworld at world position x,y,z, you do the following (at a minimum; I am skipping blending / depthtesting) here:
gl.PushMatrix()
gl.Texture(read what you need here)
gl.Translate(x,y,z)
gl.Billboard()
gl.TexRect(x1,y1,x2,y2)
gl.PopMatrix()

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

= Clear =
'''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

= ResetState/Matrices =
'''gl.ResetState''' DON'T USE IT AS LONG AS YOU KNOW WHAT YOU ARE DOING! each callin has different default states, but this function resets all states no matter what to the states below!
() -> nil

ShadeModel = GL_SMOOTH
Scissor = false
Texture = false
Lighting = 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 = true (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


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

'''gl.Color'''
( { number r, number g, number b[, number a] } |
number r, number g, number b[, number a] ) -> 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.EdgeFlag'''
( boolean enable ) -> 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

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

'''gl.FogCoord'''
( number value ) -> 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...]] ) -> number listID

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

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

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

options are:
horizontal alignment:
'c' = center
'r' = right
vertical alignment:
'a' = ascender
't' = top
'v' = vertical center
'x' = baseline
'b' = bottom
'd' = descender
decorations:
'o' = black outline
'O' = white outline
's' = shadow
other:
'n' = don't round vertex coords to nearest integer (font may get blurry)

http://home.arcor.de/jkei/fontlines.png

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

'''gl.GetTextHeight'''
( string "text" ) -> nil | number height, number descender, number numlines (in pixels, with a font size of 1.0)
further descriptions here: [[GetTextHeight]]

If you have multiple gl.Text calls, then you can bunch them between a gl.BeginText and gl.EndText to speedup the rendering. 
'''gl.BeginText'''
( ) -> nil
'''gl.EndText'''
( ) -> nil

= 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''' (doesn't apply worldspace->unit transformation! only works if rawdraw is true )
( 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

= States (Blending,AlphaTest...) =
'''gl.Blending'''
( boolean enable | number [[Lua_ConstGL#BlendingFactorSrc|srcmode]], number [[Lua_ConstGL#BlendingFactorDest|dstmode]] ) -> nil
( string mode ) -> nil
{| cellpadding="0" cellspacing="0" style="margin-top: -5px; margin-left:5px"
! style="color:#55ee99" | mode maybe:
|-
| style="color:#55ee99" | "add"
| style="color:#55ee99" | = GL_ONE, GL_ONE
|-
| style="color:#55ee99" | "alpha_add"
| style="color:#55ee99" | = GL_SRC_ALPHA, GL_ONE
|-
| style="color:#55ee99" | "alpha"
| style="color:#55ee99" | = GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA
|-
| style="color:#55ee99" | "reset"
| style="color:#55ee99" | = GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA
|-
| style="color:#55ee99" | "color"
| style="color:#55ee99" | = GL_SRC_COLOR, GL_ONE_MINUS_SRC_ALPHA
|-
| style="color:#55ee99" | "modulate"
| style="color:#55ee99" | = GL_DST_COLOR, GL_ZERO
|-
| style="color:#55ee99" | "disable"
| style="color:#55ee99" | = GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA
|}

'''gl.BlendEquation'''
( number mode ) -> nil

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

'''gl.BlendEquationSeparate''' (needs openGL2.0!)
( number modeRGB, number modeAlpha ) -> nil

'''gl.BlendFuncSeparate''' (needs openGL2.0!)
( number [[Lua_ConstGL#BlendingFactorSrc|srcRGB]], number [[Lua_ConstGL#BlendingFactorDest|dstRGB]], number [[Lua_ConstGL#BlendingFactorSrc|srcAlpha]], number [[Lua_ConstGL#BlendingFactorDest|dstAlpha]] ) -> 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.DepthClamp''' not always available, needs GL_NV_depth_clamp!
( boolean enable ) -> 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

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

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

= Stencil =
'''gl.StencilTest'''
( boolean enable ) -> nil
'''gl.StencilMask'''
( number mask ) -> nil
'''gl.StencilFunc'''
( number func, number ref, number mask ) -> nil
'''gl.StencilOp'''
( number fail, number zfail, number zpass ) -> nil

'''gl.StencilMaskSeparate''' (needs openGL2.0!)
( number [[Lua_ConstGL#Culling|face]], number mask ) -> nil
'''gl.StencilFuncSeparate''' (needs openGL2.0!)
( number [[Lua_ConstGL#Culling|face]], number func, number ref, number mask ) -> nil
'''gl.StencilOpSeparate''' (needs openGL2.0!)
( number [[Lua_ConstGL#Culling|face]], number fail, number zfail, number zpass ) -> nil

= LineWidth & PointSize =
'''gl.LineWidth'''
( number width ) -> nil

'''gl.PointSize''' (values != 1 can break severely on ATI cards, see http://springrts.com/mantis/view.php?id=2390)
( number size ) -> nil

'''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

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

{| cellpadding="0" cellspacing="0" style="margin-top: -5px; margin-left:5px"
! style="color:#55ee99; text-align:left" |`name` maybe:
|-
| style="color:#55ee99" | #12
| style="color:#55ee99" | = unitDef 12 buildpic
|-
| style="color:#55ee99" | %34:1
| style="color:#55ee99" | = unitDef 34 s3o tex2 (:0->tex1,:1->tex2)
|-
| style="color:#55ee99" | %-102:0
| style="color:#55ee99" | = featureDef 102 s3o tex1
|-
| style="color:#55ee99" | !56
| style="color:#55ee99" | = lua generated texture 56 (= return value of gl.CreateTexture)
|-
| style="color:#55ee99" | $units
| style="color:#55ee99" | = 3do textureatlas tex1
|-
| style="color:#55ee99" | $units1
| style="color:#55ee99" | = 3do textureatlas tex1
|-
| style="color:#55ee99" | $units2
| style="color:#55ee99" | = 3do textureatlas tex2
|-
| style="color:#55ee99" | $shadow
| style="color:#55ee99" | = shadowmap
|-
| style="color:#55ee99" | $specular
| style="color:#55ee99" | = specular cube map
|-
| style="color:#55ee99" | $reflection
| style="color:#55ee99" | = reflection cube map
|-
| style="color:#55ee99" | $shading
| style="color:#55ee99" | = ground shading texture
|-
| style="color:#55ee99" | $grass
| style="color:#55ee99" | = grass shading texture
|-
| style="color:#55ee99" | $heightmap
| style="color:#55ee99" | = heightmap (needs HeightMapTexture=1 set in spring config)
|-
| style="color:#55ee99" | ${opt}:/LuaUI/images/image.png
| style="color:#55ee99" | = load a texture from the VFS
|}

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

example: ":iac:/LuaUI/images/image.png"
example: ":cr16,16:/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

= PixelReadback =
'''gl.SaveImage'''
( number x, number y, number w, number h,
string filename [, table {alpha=boolean, yflip=boolean} ] ) -> nil | boolean success

'''gl.ReadPixels'''
( number x, number y, number w, number h [, number format = GL_RGBA ] )
-> nil | number r,[g,[b,[a]]] | table { { {1 = number r, 2 = number g, 3 = number b, 4 = number a}, ... }, ... }

= 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

= 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
Note: number divs is the number of sides the circle will have. the higher the smoother the circle (and more GPU intensive) 

'''gl.DrawGroundQuad''' Note: x1,z1,x2 & z2 are rounded, so don't use it for very small or moving objects. x and z are correspond to the coordinates displayed by the tooltip 
( number x1, number z1, number x2, number z2,
[ boolean useNorm, (does nothing!)
[ number tu1, number tv1, number tu2, number tv2 |
boolean useTextureCoord ] ] ) -> nil

= Queries =
'''gl.CreateQuery''' needs >=OpengGL2.0!
( ) -> nil | userdata query
'''gl.DeleteQuery''' needs >=OpengGL2.0!
( userdata query ) -> nil
'''gl.RunQuery''' needs >=OpengGL2.0!
( userdata query, function, arg1, arg2, ... ) -> nil
'''gl.GetQuery''' needs >=OpengGL2.0!
( userdata query ) -> nil | number renderedFragments

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

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

'''gl.GetGlobalTexCoords''' gets the texcoord of a 3do texture in the 3do texture atlas
( string 3doTextureName ) -> number xstart, number ystart, number xend, number yend

'''gl.UnsafeState'''
( number state [, boolean disable_state ], function, arg1, arg2, ... ) -> nil
Calls glEnable(state) or glDisable(state) (if disable_state==true) and then calls the lua_function and afterwards reverts the state.

'''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.Flush'''
() -> nil

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

= Shaders (GLSL) =
[[Lua_GLSL_Api]]

[[category: Lua]]

Lua:Main

2011-02-19T14:47:20Z

Kingraptor: /* Other useful information */

[[Engine_Development|Development]] < {{FULLPAGENAME}}

=Lua FAQ=
[[Lua_Beginners_FAQ]] 
[http://springrts.com/phpbb/viewtopic.php?f=23&t=15596 Forum topic with some basic information about gadgets] 
[http://springrts.com/phpbb/viewtopic.php?f=23&t=16223 Forum topic with a manual on Spring lua scripting] 
[http://answers.springlobby.info/ Q&A Site for Spring Developement]

=Interfaces (last update: 0.82rc)=
[[:Category:Lua]] (shows which interfaces are loaded by LuaUI,LuaRules,etc.) 
{{LuaInterfaces}}

=Other useful information=
[[LuaCallinReturn]] 
[http://spring.clan-sy.com/wiki/COB_Constants#Custom_Variables COB Custom Variables] 
[http://springrts.com/phpbb/viewtopic.php?f=12&t=19560 Font Drawing System] 
[[UI_commands]] 
[http://spring.clan-sy.com/wiki/Lua_sync_to_unsync Synced <-> unsynced communication] 
[[Animation-LuaScripting]]

=Official Lua documentation=
[http://www.lua.org/pil/ 'Programming in Lua' book online] 
[http://www.lua.org/manual/5.1/ Lua 5.1 Reference manual] 
[http://lua-users.org/wiki/TutorialDirectory Lua tutorials]
[[Category: Lua]]

Lua SyncedCtrl

2011-01-13T10:17:35Z

Kingraptor: /* Unit Control */ Added SetUnitNoSelect (why is it missing?)

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

= Game End =
'''Spring.KillTeam''' New in version 0.83.x 
( number teamID ) -> nil
 will declare a team to be dead ( no further orders can be assigned to such teams's units )

'''Spring.GameOver''' New in version 0.83.x 
( [ [1] = allyTeamID1, [2] = allyTeamID2, .. ] ) -> nil
 will declare game over, a list of winning allyteams can be passed, if undecided ( like when dropped from the host ) it should be empty ( no winner ), in the case of a draw with multiple winners, all should be listed

= Resources =
'''Spring.AddTeamResource'''
( number teamID, string "metal" | "energy", number amount ) -> nil
'''Spring.UseTeamResource'''
( number teamID,
string "metal" | "energy",number amount |
{ metal = number amount, energy = 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 "metal" | "energy", number amount ) -> nil

'''Spring.ShareTeamResource''' 0.82 and later
( number teamID_src, number teamID_recv, string "metal" | "energy", number amount ) -> nil

= Unit Handling =
'''Spring.CreateUnit''' note: offmap positions are clamped! (you still can use MoveCtrl todo so)
( string "defName" | number unitDefID,
number x, number y, number z,
(number facing | string "facing"),
number teamID,
[boolean build = false] ) -> number unitID

possible values for facing are:
"south" | "s" | 0
"east" | "e" | 1
"north" | "n" | 2
"west" | "w" | 3
if build is true the unit is created in "being built" state, with buildProgress = 0


'''Spring.DestroyUnit'''
( number unitID,
[boolean selfd = false,]
[boolean reclaimed = false,]
[number attackerID] ) -> nil

selfd := makes the unit act like it self-destructed
reclaimed := don't show any DeathSequences, don't leave a wreckage.
NOTE this does _not_ give back the resources to the team!


'''Spring.TransferUnit'''
( number unitID,
numer newTeamID,
[boolean given = true] ) -> nil
if given=false, the unit is captured

== 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.SetUnitFuel'''
( number unitID, number fuel ) -> nil

'''Spring.SetUnitLineage''' Removed from version 0.83.x 
( 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.SetUnitBlocking'''
( number unitID, boolean blocking [, boolean collide ] ) -> 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.SetUnitNoSelect'''
( number featureID, boolean noSelect ) -> nil

'''Spring.SetUnitArmored''' armorMultiple new in version 0.83.x
( number unitID, boolean armored [, number armorMultiple] ) -> nil

'''Spring.SetUnitShieldState'''
( number unitID [, number weaponID = -1] [, boolean enabled] [, number power] ) -> nil

'''Spring.SetUnitFlanking'''
( number unitID, string "mode", number mode ) -> nil
( number unitID, string "moveFactor", number factor) -> nil
( number unitID, string "minDamage", number minDamage ) -> nil
( number unitID, string "mazDamage", number maxDamage ) -> nil
( number unitID, string "dir", number x, number y, number z) -> nil

'''Spring.SetUnitWeaponState'''
( number unitID, number weaponNum, table states ) -> nil
( number unitID, number weaponNum, string key, number value ) -> nil
format of the states table:
{
["reloadState" = number value,]
["reloadFrame" = number value,] (synonym for reloadState!)
["reloadTime" = number value,]
["accuracy" = number value,]
["sprayAngle" = number value,]
["range" = number value,]
["projectileSpeed" = number value,]
["burst" = number value,]
["burstRate" = number value,]
["projectiles" = number value,]
["aimReady" = number value,] (<>0.0f := true)
}

'''Spring.SetUnitCollisionVolumeData'''
( number unitID, number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetX,
number vType, number tType, number Axis
) -> nil
enum COLVOL_TYPES {
COLVOL_TYPE_DISABLED = -1,
COLVOL_TYPE_ELLIPSOID = 0,
COLVOL_TYPE_CYLINDER,
COLVOL_TYPE_BOX,
COLVOL_TYPE_SPHERE,
COLVOL_TYPE_FOOTPRINT, // intersection of sphere and footprint-prism
COLVOL_NUM_TYPES // number of non-disabled collision volume types
};
enum COLVOL_TESTS {
COLVOL_TEST_DISC = 0,
COLVOL_TEST_CONT = 1,
COLVOL_NUM_TESTS = 2 // number of tests
};
enum COLVOL_AXES {
COLVOL_AXIS_X = 0,
COLVOL_AXIS_Y = 1,
COLVOL_AXIS_Z = 2,
COLVOL_NUM_AXES = 3 // number of collision volume axes
};


'''Spring.SetUnitPieceCollisionVolumeData'''
( number unitID, number pieceIndex, boolean affectLocal, boolean affectGlobal,
boolean enableLocal, boolean enableGlobal, number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetZ,
number vType, number Axis
) -> nil

'''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

'''Spring.AddUnitSeismicPing'''
( number unitID, number pingSize ) -> nil

'''Spring.RemoveBuildingDecal'''
( number unitID ) -> nil

== Unit LOS ==
'''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.SetUnitSonarStealth'''
( number unitID, boolean sonarStealth ) -> nil

'''Spring.SetUnitStealth'''
( number unitID, boolean stealth ) -> nil

'''Spring.SetUnitAlwaysVisible'''
( number unitID, boolean alwaysVisible ) -> nil

'''Spring.SetUnitLosMask'''
( number unitID, number allyTeam, number los | table losTypes ) -> nil
the 3th argument is either the bit-and combination of the following numbers:
LOS_INLOS = 1
LOS_INRADAR = 2
LOS_PREVLOS = 4
LOS_CONTRADAR = 8
or a table of the following form:
losTypes = {
[los = boolean,]
[radar = boolean,]
[prevLos = boolean,]
[contRadar = boolean,]
}

'''Spring.SetUnitLosState'''
( number unitID, number allyTeam, number los | table losTypes ) -> nil
see above for more info on the arguments

'''Spring.SetUnitSensorRadius'''
( number unitID, string type, number radius ) -> nil | number newRadius
type can be:
"los","airLos","radar","sonar","seismic","radarJammer","sonarJammer"

== 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 | boolean okay
( number unitID, { ["m" | "metal" | "e" | "energy"] = amount, ... } ) -> nil | boolean okay

= Feature Handling =
'''Spring.CreateFeature'''
( string "defName" | number featureID, number x, number y, number z
[,number heading [, number AllyTeamID ]] ) -> number featureID

'''Spring.DestroyFeature'''
( number featureID ) -> nil

'''Spring.TransferFeature'''
( number featureID, number teamID ) -> 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 values for facing are:
"south" | "s" | 0
"east" | "e" | 1
"north" | "n" | 2
"west" | "w" | 3


'''Spring.SetFeaturePosition'''
( number featureID, number x, number y, number z [, boolean snapToGround]) -> nil

'''Spring.SetFeatureDirection'''
( number featureID, number x, number y, number z ) -> nil

'''Spring.SetFeatureNoSelect'''
( number featureID, boolean noSelect ) -> nil

'''Spring.SetFeatureAlwaysVisible'''
( number featureID, boolean enable ) -> nil

'''Spring.SetFeatureCollisionVolumeData'''
( number featureID, number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetX,
number vType, number tType, number Axis
) -> nil
check Spring.SetUnitCollisionVolumeData for further explanation of the arguments

= Lua to COB =
'''Spring.CallCOBScript'''
( number unitID, number funcID | string funcName, number retArgs, COBArg1, COBArg2, ... )
-> nil | number returnValue, number retArg1, number retArg2, ...

'''Spring.CallCOBScriptCB''' 
broken in 0.78.2.1; will be removed with the introduction of Lua as COB replacement
( 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

Note: Don't use Spring.[Get|Set]UnitCOBValue in LUS just because you are familar with it since bos/cob, use the mighty LuaSpringAPI instead!

'''Spring.GetUnitCOBValue'''
( number unitID [, boolean splitData=false], number COBValue
[, number param1 [,number param2 [, number param3 [, number param4 ] ] ] ] )
-> number result | number result1, number result2
you find the possible values for `COBValue` in [[Lua_ConstCOB#Get.2FSet|Lua_ConstCOB]]
 also see [[Animation-CobConstants#Custom_Variables|Custom_Variables]]

'''Spring.SetUnitCOBValue'''
( number unitID, number COBValue, number param1 [,number param2] ) -> nil
you find the possible values for `COBValue` in [[Lua_ConstCOB#Get.2FSet|Lua_ConstCOB]]
 also see [[Animation-CobConstants#Custom_Variables|Custom_Variables]]

= 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,
{number, etc...}, params
{"alt", "ctrl", "shift", "right"} options
}, ..
}
) -> nil

'''Spring.GiveOrderArrayToUnitArray'''
( unitArray = { [1] = number unitID, etc... },
orderArray = {
{ number cmdID,
{number, etc...}, params
{"alt", "ctrl", "shift", "right"} options
}, ..
}
) -> nil

=Ground=
== Grass ==
'''Spring.AddGrass'''
( number x, number y, number z ) -> nil

'''Spring.RemoveGrass'''
( number x, number y, number z ) -> 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

'''Spring.SetHeightMapFunc'''
( lua_function [, arg1 ,[ arg2 [, ... ] ] ) -> nil | number absTotalHeightMapAmountChanged
'''Spring.AddHeightMap''' can only be called in SetHeightMapFunc()
( number x, number z, number height ) -> nil | number newHeight
'''Spring.SetHeightMap''' can only be called in SetHeightMapFunc()
( number x, number z, number height [,number terraform = 1] ) -> nil | number absHeightDiff
the terraform argument is a scaling factor:
so if 0 nothing will be changed (the terraform starts) and if it is 1 the terraform will be finished.

'''Spring.LevelSmoothMesh'''
( number x1, number z1 [, number x2, number z2], number height ) -> nil
'''Spring.AdjustSmoothMesh'''
( number x1, number z1 [, number x2, number z2], number height ) -> nil
'''Spring.RevertSmoothMesh'''
( number x1, number z1 [, number x2, number z2], number origFactor ) -> nil

'''Spring.SetSmoothMeshFunc'''
( lua_function [, arg1 ,[ arg2 [, ... ] ] ) -> nil | number absTotalHeightMapAmountChanged
'''Spring.AddSmoothMesh''' can only be called in SetSmoothMeshFunc()
( number x, number z, number height ) -> nil | number newHeight
'''Spring.SetSmoothMesh''' can only be called in SetSmoothMeshFunc()
( number x, number z, number height [,number terraform = 1] ) -> nil | number absHeightDiff

== TerrainTypes ==
'''Spring.SetMapSquareTerrainType'''
( number x, number z, int newType ) -> nil | int oldType
'''Spring.SetTerrainTypeData'''
( int typeIndex
[, number speedTanks = nil ]
[, number speedKBOTs = nil ]
[, number speedHovers = nil ]
[, number speedShips = nil ] ) -> nil | boolean true

= 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


'''Spring.SpawnCEG'''
( string "cegname",
number posX = 0, number posY = 0, number posZ = 0,
number dirX = 0, number dirY = 0, number dirZ = 0,
number radius = 0, number damage = 0
) -> nil

= Projectiles =
'''Spring.SetProjectileMoveControl''' (disables engine movecontrol, so lua can fully control the physics)
( number projID, boolean enable ) -> nil
'''Spring.SetProjectilePosition'''
( number projID [, number x = 0 [, number y = 0 [, number z = 0 ]]] ) -> nil
'''Spring.SetProjectileVelocity'''
( number projID [, number x = 0 [, number y = 0 [, number z = 0 ]]] ) -> nil
'''Spring.SetProjectileCollision'''
( number projID ) -> nil
'''Spring.SetProjectileGravity'''
( number projID [, number grav = 0] ) -> nil
'''Spring.SetProjectileSpinAngle'''
( number projID [, number spinAngle = 0] ) -> nil
'''Spring.SetProjectileSpinSpeed'''
( number projID [, number speed = 0] ) -> nil
'''Spring.SetProjectileSpinVec'''
( number projID [, number x = 0 [, number y = 0 [, number z = 0]]] ) -> nil
'''Spring.SetProjectileCEG'''
( number projID, string ceg_name ) -> nil

[[category: Lua]]

LuaCallinReturn

2010-09-17T16:08:35Z

Kingraptor: UnitCreated() returns builderID

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

===Lua Call-Ins, with parameters===

''Here are the known reserved parameter values for all Lua Call-Ins. If you add new Call-Ins to Spring, please document them here.''

==Commands, general-purpose:==

Shutdown() --> none.

LayoutButtons() --> unknown, please document.

ConfigureLayout() --> "command".

CommandNotify() --> "id, params, options", where id = the CommandID

KeyPress() --> "key, mods, isRepeat", where key = keymap, mods = SHIFT, etc.

KeyRelease() --> "key"

MapDrawCmd() --> "playerID, cmdType, px, py, pz, label"

MouseMove() --> "x, y, dx, dy, button"

MousePress() --> "x, y, button"

MouseRelease() --> "x, y, button"

IsAbove() --> "x, y" where x,y = screen coordinates.

GetTooltip() --> "x, y" where x,y = screen coordinates. Returns WorldTooltip.

AddConsoleLine() --> "msg, priority"

MapDrawCmd() --> "playerID, cmdType, px, py, pz, labeltext"

AllowCommand() --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag, synced"

CommandFallback() --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag"

CommandsChanged() --> unknown (none?)

AllowUnitCreation() --> "unitDefID, builderID, builderTeam, x, y, z"

AllowUnitTransfer() --> "unitID, unitDefID, oldTeam, newTeam, capture"

AllowUnitBuildStep() --> "builderID, builderTeam, unitID, unitDefID, part"

AllowFeatureCreation() --> "featureDefID, teamID, x, y, z"

AllowFeatureBuildStep() --> unknown, please document.

AllowResourceLevel() --> "teamID, res, level"

AllowResourceTransfer() --> "teamID, res, level"

==Unit-Specific:==

UnitPreDamaged() --> "unitID, unitDefID, unitTeam, damage, paralyzer, weaponID, attackerID, attackerDefID, attackerTeam"

UnitDamaged() --> "unitID, unitDefID, unitTeam, damage, paralyzer, weaponID, attackerID, attackerDefID, attackerTeam"

UnitCreated() --> "unitID, unitDefID, teamID, builderID"

UnitFinished() --> "unitID, unitDefID, teamID"

UnitFromFactory() --> "unitID, unitDefID, unitTeam, factID, factDefID, userOrders"

UnitDestroyed() --> "unitID, unitDefID, teamID, attackerID?"

UnitTaken() --> "unitID, unitDefID, unitTeam, newTeam"

UnitGiven() --> "unitID, unitDefID, unitTeam, oldTeam"

UnitIdle() --> "unitID, unitDefID, teamID"

UnitCommand() --> "unitID, unitDefID, unitTeam, cmdID, cmdOpts, cmdParams"

UnitSeismicPing() --> "x, y, z, strength"

UnitEnteredRadar() --> "unitID, unitTeam"

UnitEnteredLos() --> "unitID, teamID"

UnitLeftRadar() --> "unitID, unitTeam"

UnitLeftLos() --> "unitID, unitDefID, teamID"

UnitLoaded() --> "unitID, unitDefID, unitTeam, transportID, transportTeam"

UnitUnloaded() --> "unitID, unitDefID, teamID, transportID"

UnitCloaked() --> "unitID, unitDefID, teamID"

UnitDecloaked)--> "unitID, unitDefID, teamID"

UnitMoveFailed() --> "unitID, unitDefID, unitTeam"

StockpileChanged() --> "unitID, unitDefID, unitTeam, weaponNum, oldCount, newCount"

UnitEnteredWater() --> "unitID, unitDefID, teamID"

UnitEnteredAir() --> "unitID, unitDefID, teamID"

UnitLeftWater() --> "unitID, unitDefID, teamID"

UnitLeftAir() --> "unitID, unitDefID, teamID"

==Feature-Specific:==

FeatureCreated() --> "featureID, allyTeam"

FeatureDestroyed() --> "featureID, allyTeam"

TerraformComplete() --> "unitID, unitDefID, unitTeam, buildUnitID, buildUnitDefID, buildUnitTeam"

UnitCmdDone() --> "unitID, unitDefID, unitTeam, cmdID, cmdTag"

==Drawing:==

* DrawGenesis() --> none. Don't render here.

* Spring draws the sky, the map, some water types, and unit selection.

* DrawWorldPreUnit() --> none.

* Spring draws units, features, some water types, cloaked units, and the sun.

* DrawWorld() --> none.

* Spring draws command queues, 'map stuff', and map marks.

Each unit might also have a DrawUnit call, [[Lua_UnitRendering|enabled here.]]

DrawUnit(unitID,DrawMode) 
With enum DrawMode { 
notDrawing = 0, 
normalDraw = 1, 
shadowDraw = 2, 
reflectionDraw = 3, 
refractionDraw = 4 
};

DrawScreenEffects() --> "vsx, vsy" where vsx, vsy are screen coords.

DrawScreen() --> none.

DrawInMiniMap() --> "sx, sy" where sx,sy are values relative to the minimap's position and scale.

DrawWorldShadow() --> none.

DrawWorldReflection() --> none.

DrawWorldRefraction() --> none.

==Game Events:==

Explosion() --> "weaponID, px, py, pz, ownerID"

ShockFront() --> "power, dx, dy, dz"

GameFrame() --> "frameNum"

CobCallback() --> unknown, marked FIXME.

GroupChanged() --> "groupID" where groupID is the value of Group whose table value changed.

WorldTooltip() --> "ttType, data1, data2, data3" special, should be documented in detail.

GamePreload() --> none.

GameStart() --> none.

GameOver() --> "[ [1] = allyTeamID1, [2] = allyTeamID2, ... ]", a list of winning allyteams, if empty the game result was undecided ( like when dropping from an host ) Will return nil in pre 0.83.x

TeamDied() --> "TeamID" where TeamID = the team that has been eliminated.

==Projectiles:==

ProjectileCreated() --> "proID, proOwnerID"

ProjectileDestroyed() --> "proID"

[[category: Lua]]

LuaCallinReturn

2010-08-28T05:50:48Z

Kingraptor: Added MapDrawCmd

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

===Lua Call-Ins, with parameters===

''Here are the known reserved parameter values for all Lua Call-Ins. If you add new Call-Ins to Spring, please document them here.''

==Commands, general-purpose:==

Shutdown() --> none.

LayoutButtons() --> unknown, please document.

ConfigureLayout() --> "command".

CommandNotify() --> "id, params, options", where id = the CommandID

KeyPress() --> "key, mods, isRepeat", where key = keymap, mods = SHIFT, etc.

KeyRelease() --> "key"

MapDrawCmd() --> "playerID, cmdType, px, py, pz, label"

MouseMove() --> "x, y, dx, dy, button"

MousePress() --> "x, y, button"

MouseRelease() --> "x, y, button"

IsAbove() --> "x, y" where x,y = screen coordinates.

GetTooltip() --> "x, y" where x,y = screen coordinates. Returns WorldTooltip.

AddConsoleLine() --> "msg, priority"

AllowCommand() --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag, synced"

CommandFallback() --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag"

CommandsChanged() --> unknown (none?)

AllowUnitCreation() --> "unitDefID, builderID, builderTeam, x, y, z"

AllowUnitTransfer() --> "unitID, unitDefID, oldTeam, newTeam, capture"

AllowUnitBuildStep() --> "builderID, builderTeam, unitID, unitDefID, part"

AllowFeatureCreation() --> "featureDefID, teamID, x, y, z"

AllowFeatureBuildStep() --> unknown, please document.

AllowResourceLevel() --> "teamID, res, level"

AllowResourceTransfer() --> "teamID, res, level"

==Unit-Specific:==

UnitPreDamaged() --> "unitID, unitDefID, unitTeam, damage, paralyzer, weaponID, attackerID, attackerDefID, attackerTeam"

UnitDamaged() --> "unitID, unitDefID, unitTeam, damage, paralyzer, weaponID, attackerID, attackerDefID, attackerTeam"

UnitCreated() --> "unitID, unitDefID, teamID" ... I hope that's self-explanatory

UnitFinished() --> "unitID, unitDefID, teamID"

UnitFromFactory() --> "unitID, unitDefID, unitTeam, factID, factDefID, userOrders"

UnitDestroyed() --> "unitID, unitDefID, teamID, attackerID?"

UnitTaken() --> "unitID, unitDefID, unitTeam, newTeam"

UnitGiven() --> "unitID, unitDefID, unitTeam, oldTeam"

UnitIdle() --> "unitID, unitDefID, teamID"

UnitCommand() --> "unitID, unitDefID, unitTeam, cmdID, cmdOpts, cmdParams"

UnitSeismicPing() --> "x, y, z, strength"

UnitEnteredRadar() --> "unitID, unitTeam"

UnitEnteredLos() --> "unitID, teamID"

UnitLeftRadar() --> "unitID, unitTeam"

UnitLeftLos() --> "unitID, unitDefID, teamID"

UnitLoaded() --> "unitID, unitDefID, unitTeam, transportID, transportTeam"

UnitUnloaded() --> "unitID, unitDefID, teamID, transportID"

UnitCloaked() --> "unitID, unitDefID, teamID"

UnitDecloaked)--> "unitID, unitDefID, teamID"

UnitMoveFailed() --> "unitID, unitDefID, unitTeam"

StockpileChanged() --> "unitID, unitDefID, unitTeam, weaponNum, oldCount, newCount"

UnitEnteredWater() --> "unitID, unitDefID, teamID"

UnitEnteredAir() --> "unitID, unitDefID, teamID"

UnitLeftWater() --> "unitID, unitDefID, teamID"

UnitLeftAir() --> "unitID, unitDefID, teamID"

==Feature-Specific:==

FeatureCreated() --> "featureID, allyTeam"

FeatureDestroyed() --> "featureID, allyTeam"

TerraformComplete() --> "unitID, unitDefID, unitTeam, buildUnitID, buildUnitDefID, buildUnitTeam"

UnitCmdDone() --> "unitID, unitDefID, unitTeam, cmdID, cmdTag"

==Drawing:==

* DrawGenesis() --> none. Don't render here.

* Spring draws the sky, the map, some water types, and unit selection.

* DrawWorldPreUnit() --> none.

* Spring draws units, features, some water types, cloaked units, and the sun.

* DrawWorld() --> none.

* Spring draws command queues, 'map stuff', and map marks.

Each unit might also have a DrawUnit call, [[Lua_UnitRendering|enabled here.]]

DrawUnit(unitID,DrawMode) 
With enum DrawMode { 
notDrawing = 0, 
normalDraw = 1, 
shadowDraw = 2, 
reflectionDraw = 3, 
refractionDraw = 4 
};

DrawScreenEffects() --> "vsx, vsy" where vsx, vsy are screen coords.

DrawScreen() --> none.

DrawInMiniMap() --> "sx, sy" where sx,sy are values relative to the minimap's position and scale.

DrawWorldShadow() --> none.

DrawWorldReflection() --> none.

DrawWorldRefraction() --> none.

==Game Events:==

Explosion() --> "weaponID, px, py, pz, ownerID"

ShockFront() --> "power, dx, dy, dz"

GameFrame() --> "frameNum"

CobCallback() --> unknown, marked FIXME.

GroupChanged() --> "groupID" where groupID is the value of Group whose table value changed.

WorldTooltip() --> "ttType, data1, data2, data3" special, should be documented in detail.

GamePreload() --> none.

GameStart() --> none.

GameOver() --> none.

TeamDied() --> "TeamID" where TeamID = the team that has been eliminated.

==Projectiles:==

ProjectileCreated() --> "proID, proOwnerID"

ProjectileDestroyed() --> "proID"

[[category: Lua]]

Balanced Annihilation:Chat

2009-11-08T14:58:53Z

Kingraptor: /spectator is no longer a /cheat command

'''[[Using_Spring|<--Back to Using Spring]]'''

==Chat, Cheats, and Text Commands==

Pressing ENTER will bring up a "say:" prompt which you can use to communicate with other players or issue "Text Commands". 
-To send a message to all who are connected, type your message and press ENTER. 
-To send a message only to your allies, preface your message with "a:". 
-To send a message to any spectators, type "s:" 
-To send a message to a certain player, type "/w <playername>" 
Press ENTER to send it. There are also keybindings for all/ally/spec chat messaging:

Enter -> send to <send type>

Ctrl+Enter -> send to All (and sets <send type> to all)

Alt+Enter -> send to Allies (and sets <send type> to allies)

Shift+Enter -> send to Spectators (and sets <send type> to spectators)

<nowiki> To enter a Text Command, simply type the command and press ENTER.</nowiki>

===Basic Text Commands===

<table border="3" cellpadding="2" cellspacing="0">
<tr>
<th>Command</th><th>Effect</th>
</tr>
<tr>
<td>/info #</td>
<td>Shows you what colour each player is, its CPU usage percentage and their ping delay in the bottom right corner of the screen. This is on by default. Arguments:<ol>
<li>Sorts by allies</li>
<li>Sorts by TeamID</li>
<li>Sorts by name</li>
<li>Sorts by CPU Usage</li>
<li>Sorts by Ping</li>
</ol>
</td>
</tr>
<tr>
<td>/clock</td><td>Shows you the elapsed game time in minutes and seconds in the upper right corner of the screen. This is on by default.</td>
</tr>
<tr>
<td>/fps</td><td>Shows FPS counter in the upper right corner of the screen.</td>
</tr>
<tr>
<td>/gameinfo</td><td>Shows game information. Game version, actual game speed, commander ends, gravity, tidal, min wind, max wind, map size, map name and mod name.</td>
</tr>
<tr>
<td>/kick <name></td><td>Kicks a player, only works for hosts.</td>
</tr>
<tr>
<td>/kickbynum #</td><td>Kicks a player, only works for hosts.</td>
</tr>
<tr>
<td>/take</td><td>Places all allied units that are owned by players who have lost connection to the server under your control. It is generally considered polite to consult with any still-connected allies before doing this. In a Commander Dies, Game Ends game, a player only loses once they have lost ''all'' their Commanders, and this mechanism will give them a second one.</td>
</tr>
<tr>
<td>/setmaxspeed #</td><td>Changes the maximum speed multiplier (default is 3.0)</td>
</tr>
<tr>
<td>/setminspeed #</td><td>Changes the minimum speed multiplier (default is 0.3)</td>
</tr>
<tr>
<td>/spectator</td><td>Resigns from the game and goes to spectator mode.</td>
</tr>
<tr>
<td>/nospectatorchat [0|1]</td><td>Toggles spectator chat on/off, optional true/false parameters can be put in the end, for example: ".nospectatorchat 1", otherwise it will toggle it on/off. Only works for hosts.</td>

</tr>
</table>

===Cheat Codes===

<table border="3" cellpadding="2" cellspacing="0">
<tr>
<th>Cheat Command</th><th>Effect</th></tr>
<tr>
<td>'''/cheat'''</td><td>'''enable cheats - Cheats don't work in multiplayer until the host types this'''</td>
</tr>
<tr>
<td>/nocost</td><td>Insta-build; everything is built immediatly. (doesn't work on things already under construction, only on new ones)</td>
</tr>
<tr>
<td>/team #</td><td>Change player</td>
</tr>
<tr>
<td>/give [amount] <unitName> [team] @x,y,z</td>
<td>Place 1 or specified number of specified unit. Valid units are the internal names of units as specified in the unit definition. Use the "all" switch to get ALL the units in the current mod. Putting a number after the unit name will give those units to the specified team. some examples:
<ul><li>/give ARMCOM - gives you one ARMCOM</li> <li>/give 10 CORKROG 3 - gives team 3 10 CORKROGs</li> <li>/give all - gives one of every unit available</li></ul></td>

</tr>
<tr>
<td>/atm</td><td>gain 1000 extra energy and metal.</td>
</tr>
<tr>
<td>/godmode [0|1]</td><td>If set to 1, everybody (including specs) can control and view all units.</td>
</tr>
</table>

===Graphic Settings===

<table border="3" cellpadding="2" cellspacing="0">
<tr>
<th>Command</th><th>Effect</th>
</tr>
<tr>
<td>/advshading [0|1]</td><td>Disables/enables advanced shading (reflective units, more?).</td>
</tr>
<tr>
<td>/grounddecals [0|1]</td><td>Disables/enables ground decals (immune to tab complete?).</td>
</tr>
<tr>
<td>/maxparticles #</td><td>Sets maximum amount of particles. Accepted values are between 1000 and 20000.</td>
</tr>
<tr>
<td>/shadows [0|1] #</td><td>Sets shadows to on or off, supports a second argument for shadow quality (1024, 2048, 4096 or 8192). Note that shadows are a massive performance hit</td>
</tr>
<tr>
<td>/vsync [0|1]</td><td>Disables/enables vsync.</td>
</tr>
<tr>
<td>/water #</td>
<td>Sets water quality:<ol start=0>
<li>Basic water, no performance hit.</li>
<li>Reflective, Pretty, not a too large performance hit.</li>
<li>Dynamic, Very pretty, MASSIVE performance hit and buggy on some hardware.</li>
<li>Reflective + Refractive, Prettier than reflective and pretty much the same performance hit, slightly buggy on some hardware.</li>
<li>Bump-mapped water, very low impact like basic water, very pretty and realistic at average ranges. Has shore waves and some basic effects for impacts/movement through the water.
</ol>
</td>
</tr>
</table>

===Misc===

<table border="3" cellpadding="2" cellspacing="0">
<tr>
<th>Command</th><th>Effect</th>
</tr>
<tr>
<td>/cmdcolors <filename></td><td>Loads specified cmdcolors.txt.</td>
</tr>
<tr>
<td>/ctrlpanel <filename></td><td>Loads specified ctrlpanel.txt</td>
</tr>
<tr>
<td>/luaui</td><td>Access LuaUI commands provided by widgets. Use /luaui reload if LuaUI crashes. You can also use disable/enable arguments.</td>
</tr>
<tr>
<td>/echo <text></td><td>Prints a message to the console.</td>
</tr>
<tr>
<td>/say <text></td><td>Specifies that you want to say something to the other players, useful for telling them how to do something with a / command without running it yourself. For example /say /luaui reload.</td>
</tr>
<tr>
<td>/specfullview #</td>
<td>Sets spectator viewing and selection options:<ol start=0>
<li>No special abilities.</li>
<li>view-all.</li>
<li>select-all.</li>
<li>view-all and select-all.</li>
</ol>
</td>
</tr>
<tr>
<td>/volume #</td><td>Sets volume, accepted values are between 0 and 1.</td>
</tr>
</table>

===Keybindings===

<table border="3" cellpadding="2" cellspacing="0">
<tr>
<th>Command</th><th>Effect</th>
</tr>
<tr>
<td>/bind <keyset> <action></td><td>Binds a key or key combination.</td>
</tr>
<tr>
<td>/unbind <keyset> <action></td><td>Unbinds a key or key combination.</td>
</tr>
<tr>
<td>/unbindaction <action></td><td>Unbinds all keybinds that uses <action>.</td>
</tr>
<tr>
<td>/unbindkeyset <keyset></td><td>Unbinds all bindings that uses <keyset>.</td>
</tr>
<tr>
<td>/unbindall</td><td>Unbinds all keys except the chat keybinding.</td>
</tr>
<tr>
<td>/keysym <name> <keycode></td><td>Adds a custom key symbol, The defaults can not be overridden. Name must start with a letter, and only contain letters, numbers, and '_'</td>
</tr>
<tr>
<td>/keyset <name> <keyset></td><td>Specifies a named keyset. Name must start with a letter, and only contain letters, numbers, and '_'. Named keysets may be accessed by prepending the '&' character to the name.</td>
</tr>
<tr>
<td>/fakemeta <keysym></td><td>Assigns an auxiliary key for the meta modifier ("space" is a good choice. Use fakemeta none to disable this feature</td>
</tr>
</table>

'''[[Using_Spring|<--Back to Using Spring]]'''

[[category:Using Spring]]

Expand and Exterminate

2009-10-08T03:34:30Z

Kingraptor: Note EE discontinued

[[Image:E&E-wikiheadline.png|right|Expand & Exterminate]]

__TOC__
[[Image:E&E-screenshot2.jpg|thumb|200px|right|URC units outside a GD stronghold.]]

=Overview=

[[Image:E&E-screenshot.jpg|thumb|200px|right|A well defended GD stronghold.]]

Expand and Exterminate offers three very unique and dynamic factions fighting for global domination. Each faction has its own design and fighting style that requires players to employ their own style of combat to defeat opponents. All three teams also have their own unique super weapons that offer great strategic difference. Expand and Exterminate is set in the near future that includes many futuristic and even alien-like vehicles for combat.

Expand and Exterminate is currently ''discontinued''.

'''Download it here:''' 
[http://xn--d-bga.su/EEv46.sd7 - '''V .46''' (current)] 
[http://hosted.filefront.com/Fang4606 - '''V .43''' (oudated)]

'''Single Player:''' 
Use KAIK

=Faction Overview=

==Global Dynasty==
[[IMAGE:E&E-GD.png|left]]
A tank force that uses brute force to push through enemies. GD uses conventional weapons like miniguns, cannon shells, and rockets along with more specialized laser and nuclear weapons. In a one on one fight, GD has the stronger units but they also have higher costs and build times. Their airforce consists of jets and helicopters.
[[GD Unit Guide]]

==United Robot Confederation==
[[Image:E&E-URC.png|left]]
Enforces control through walking mechanized units that use stealth and versatility to attack. URC's main weapons are plasma and rockets with both flamethrowers and cannons showing up on more specialized units. URC units are the best at climbing hills and can navigate high terrain better than any other faction. Their airforce consists of Vtols. [[URC Unit Guide]]

==New Initiative==
[[Image:E&E-NI.png|left]]
Utilizies heavy amounts of hovercraft and aircraft to swiftly move and attack enemies, great for raiding. They also expand quicker than the other two factions but those expansions are quite fragile. The NI use exotic weapons such as lightning, lasers and photon systems along with conventional rockets. Includes largest and strongest airforce of all three factions. (This faction is not currently available but is under active development)

==Aliens==
Unknown force that fields bipedal and hovering ground combat units. This side is able to clone and morph many of its units to build up larger forces or advance to a new tech. They have the most powerful and most expensive units on the battlefield. They have a smaller air force than the other sides thats based on flying drones.

=Strategy=

==GD==

In this guide you will learn how to utilize the GD's greatest attribute: staying power, and minimize their weakness: lack of mobility.

* '''STAYING POWER''' - GD units generally have more armor, better range, and greater firepower than the combat units of the other factions. This allows GD tanks to form a line and focus fire on incoming enemies. GD also has better artillery than the other factions. The higher you climb the tech lvls the more armor hp damage and turrets you get on your units. At lvl 3 GD's tanks are lumbering behemoths with multiple turrets spewing fire in many directions. The key word in that last sentence is lumbering for those tanks are slow so either transport them or hide them till they are in range.
** '''LVL1'''
** '''LVL2'''
** '''LVL3'''

* '''CENTRALIZED RESOURCING''' - GD basic mexes give energy, so you won't need to build a reactor immediately. GD also has a light gas plant that gives the same amount of energy as the mexes. When you're getting around to building a nuclear reactor it gives 2x+ more energy than its closest equivalent (URC fusion). While this means less building you had better space out your reactors cause they go up like nukes. At lvl3 the Gd get the ability to make a Super reactor that produces around 2000 energy. GD also may construct armed mexes, allowing them to more easily hold territory and making raiding difficult but are more expensive.

* '''LACK OF MOBILITY''' - Overall GD is the slowest of the three factions. GD's first transport unit is available in the lvl1 air plant and is a key unit in their plans. Armed mexes combined with the rapid deployment of units via air transports helps minimize GD's lack of mobility. GD light tanks can climb fairly well, lvl2 tanks have more difficulty, lvl3 tanks have horrid climbing ability. At lvl3 the GD receive a heavily armored transport helo. With a little skill (and some pre raid destruction) these will be able to penetrate enemy airspace and drop of their precious cargo.

* '''METAL RAIN''' - GD arty will devastate almost any target save air units. They have an advantage vs any side but they are expensive and slow moving so you must protect them wisely. Lvl 1 arty is good support for your tanks and can help soften up a defensive line before a push. Lvl 2 arty is more effective than its lvl 1 cousin, where as the lvl 1 arty fired straight up in high trajectory, the lvl 2 can fire both in low and high trajectories. The main difference is in accuracy, with low trajectory having higher accuracy. At lvl 3 the GD gain both saturation artillery and nuke artillery. The saturation arty is like its lvl 1 cousin in that it fires straight up but that is the end of similarities. With four barrels this unit puts out a constant stream of shells that is devastating to both static defense and mobile units. The nuke artillery is a devastating weapon if used correctly. You must pay for each individual shell you fire so this is gonna be expensive unit to use in bulk or consistently. However the power unleashed form this units is devastating. The GD also have a tactical nuke launcher. Similar to the nuke artillery, you must pay for each missile you fire. The main difference between them is accuracy. The tactical nuke is perfect for pinpoint strikes while the nuke arty can and does miss so be forewarned.

GD is all about brute force; avoid your enemies' emplacements if you can, but you can likely roll right over them. Lasers are particularly good at taking down defensive turrets (as well as units).-Decimator

Most definitely. Don't forget to mix your units as well. -Shadowsage

==URC==

this short guide you will explain URC's best attributes, agility and stealth.

* '''Mobility''' - To begin, when using the URC faction its best to take advantage of their ability to climb steep slopes and mountains. There are a number of ways to utilize this advantage as you have the ability to attack from angles no other faction can. Its advised that when possible that you should attack from the steepest ground possible as GD and NI units will usually not be able to follow you and your units will gain greater firing range. But most important to URC strategy is the potential for invading bases by avoiding defenses. While GD shoves through defenses and NI runs through it, the URC can completely ignore it by going through high terrain to surprise attack an opponent's base. If the high terrain is steep enough, you're assured that neither GD or NI can build defenses on their hills or mountains around their base.

* '''STEALTH''' - The URC are the only faction to have units that cloak. After you have put up your early economy and first land factory use spiders (cheap, cloakable spy units that can build cameras and mines) very early in game to put cameras around key positions and to observe enemy bases. A good objective to keep in mind is to use this unit as your eyes and ears to basically monitor your enemies base for an undefended route that you can use late game to invade. Be sure to build a few battle mechs and a couple construction mechs afterwards to properly expand in early game. During middle to late game, you can build a stealth factory to produce a variety of medium strength attack mechs that can both cloak and jam radars. At the cost of this ability however these mechs are more expensive and take less damage than their non-stealth counterparts. Therefore its advised to use these units in small raiding parties to disrupt and destroy the opponents economy. Do not mainly focus them on aiding your main armies in combat as its not cost effective, they are best used for surprising un-protected bases.

As URC you have many options open to you in conquest. Even though I have written guidelines for a suggested play style, you can still win without using stealth and agility, its entirely up to your gameplay style. You may find that using URC as brute force works better for you, as they can operate a highly strong head on function in proper numbers. Whatever your style is, URC can probably fit into it. -Flintlock

Your increased mobility on the ground combined with stealth can give you as a URC player the option of choosing when and where you battle, a decisive point. As Flintlock said, you can essentially run successfully with any of an array of play styles. -Neddiedrow

==Aliens==

Aliens are the newest race to enter the E&E battlezones and also one of the most unique. This quick guide should give you a heads up as to how they operate.

* '''CLONE AND MORPH''' - Rather than using traditional factories like GD or URC, the aliens increase their forces (and tech level) by cloning or morphing their units. The commander can construct the scout, construction and light combat forms. These units are built the same way as a building. To get more of these units, the commander can build more or a live unit can clone itself. Cloning will stop whatever the unit was currently doing and freeze it in place. As the process moves along the clone's outline will flash next to the cloning unit. Once cloning is finished the unit can go back to what it was doing (though builders will not automatically go back to building something they started) and the clone is ready to go. Aircraft however cannot morph or clone and must be built by the appropriate level Anti Air form. Ships can clone but not morph, in order to access higher level ships you'll need a higher level constructor.

* Morphing works similarly to cloning except the unit that is morphed from is lost (in a sense you are "upgrading" that unit to the new type). The morph tree is [http://img252.imageshack.us/img252/6838/morphsystemkz1.jpg here]. You will know you are morphing as the build pic will be overlaid with the word Morph.

* '''EARLY GAME''' - The aliens have the most powerful units in the game, one vs. one they will beat their counterparts in the other factions. However this comes at the cost of a high price tag both in resources and building/cloning/morphing time. It is imperative that an alien player spread out and take as many metal deposits on the map as possible. This is best done using the scout form. Scout forms are cheap, fast, have long Line of Sight, and can very quickly get Extraction Pylons up over a large radius. Going construction form first will stall your economy to the point where you might never recover.

* Generally two Extractors and four Energies will be enough to cover early unit costs.
* After the inital set of Scouts (2-4)and Light Combat Forms(0-2), have you commander go on to building 6-7 or so Energy Pylons.
* Use cloning and morphing to increase your army size and diversity but always have some "live" units to deal with enemies.
* Storage is very important for the aliens as an excess of resources allows cloning and morphing whenever its needed. 3-4 storage will carry you through most of a match but spares are always nice to have.

[[Image:E&E-screenshot3wide.jpg|702px|center|]]

=Links=
*'''[http://xn--d-bga.su/EEv46.sd7 Download current version]''' (.46)
*'''[http://hosted.filefront.com/Fang4606/ Download outdated versions]''' WARNING: these versions can be testing versions so bugs and imbalances could be present!!!
*'''[http://spring.clan-sy.com/phpbb/viewtopic.php?f=14&t=13801 Current Expand & Exterminate Thread on Spring Forums]'''
*'''[http://smoth.net/foram/viewforum.php?f=7 Expand & Exterminate section on Smoth's Forums]'''

=Credits=
'''Mod Creation'''
*Fang - Created all of E&E, scripted, textured, modeled and compiled
*Smoth - Scripting and modeling advice, and much other assistance
*Argh - Scripting and modeling advice, as well as much other assistance
*Ground Zero - Provided modeling help and sounds
*Nemo - Weapon setup assistance
*Forboding Angel - Cursors/Loading Screens/Sounds
*Wasp - Buildpics/Icons/Website help

'''Additional Help'''
*Decimator - Wrote GD Strategy
*Flintlock - Initial Promotional/Biography/Wiki/Graphic Designs
*Zoombie - Unit Guides
*j5mello - Wiki

'''Alpha Testing'''
*Big Steve
*Cabbage
*DasBruce
*DavetheBrave
*Decimator
*Drexion
*GuiltySpark
*OverDamage
*Flintlock
*Forboding Angel
*J5mello
*Smoth
*Tenebrous
*Wasp

'''Beta Testing'''
*Sleksa
*WarhammerC
*Cronyx
*Chapparal
*Sekhmet/Neddiedrow
*Aun
*Kixxe
*Krogothe
*Drone_Fragger

'''Current Players'''
*Thank you for playing and keep giving input on the current version.

Back to [[Games]]

[[Category:Games]]
{{Category:Mods}}

The Lighter Side Of Spring

2008-11-16T08:01:27Z

Kingraptor:

Even developers, content creators and rabid players occassionally have abberant moments of comedic genius. Therefore, there is a section of the Spring Wiki dedicated to the lighter side of what we as a community do and who we as a community are.

===Comics & Images===
*[[1v0ry_k1ng's Works]]
*[http://spring.clan-sy.com/phpbb/viewtopic.php?t=8428&highlight=smug Smug Guide to Running Your Boy]
*[[Ra1ders Works]]
*[[http://spring.clan-sy.com/phpbb/viewtopic.php?f=10&t=15187&start=36 The Battlefield in CORE SUXXX from the-middleman]]
*[[http://spring.clan-sy.com/phpbb/viewtopic.php?f=10&t=15405 The Battlefield in Roleplay from the-middleman]]

===Quotations & Sound Clips===

*[http://springlobby.info/quotes SpringBash] - Real quotes from lobby, often taken out of context!

FAQ:player

2008-11-16T07:48:02Z

Kingraptor:

=Playing=

==What is with this weird right-click mode? I'm 'bout to break my keyboard.==

Sorry, you'll just have to get used to it. As of now it can't be changed.

==Why is somebody else also controlling my units?==

In the 'game lobby' there are two sets of teams. There are the 'Ids' and the 'teams'. If you are on the same 'Id', then you both get the same commander, and can control the same units (commonly referred to as comsharing). If you are on the same 'Team', then you both get different commanders and can't control each others units.

==Then why would I want to be on the same 'Id' as somebody?==

Because it's fun to just drive around units and not have to worry about commanding. (Assuming that one of the people on the team is commanding.)
Most importantly, however, you can split tasks, such as base building, and troops management.

==Is there a way that I can play music directly through Spring, with alternating tracks for building/attacking like in the original Total Annihilation?==

Yes, there is. It is an add on (GroupAI) you have to download separately:
http://jobjol.nl/1188

There is also an ingame sound-volume-slider you might find useful (lua-script):
http://jobjol.nl/1218

==Sometimes I can't write anything but numbers and some other symbols. Why is that?==

This is most likely because of the Windows language bar change from which Spring doesn't recognize the characters written.
Note: That Default hotkeys in Windows XP for changing the language is Shift+Alt, which is similar to square build hotkeys in Spring!

==How do I talk to my allies only?==

You must type 'a:' before you speak, or press "Alt Enter" at the same time. Here's an example: a: Now I am talking to my allies only. 

==Help! After I'm finished driving a unit, the camera is all insane! This is nuts! How do I fix it?==

Whoa now. Calm down. Just press ctrl + mouse button 3 to change camera modes. If your unit is destroyed in FPS mode, you will stay in FPS mode until you change camera modes. Also, the camera will stay in "free look" when FPS mode is disengaged, press middle-mouse or J to switch to normal scrolling.

==After I'm finished driving a unit, where what used to be my mouse pointer is now a crosshair. Why?==

-This is a special 'view mode' that allows you to move around the screen much faster. It's good for viewing the battle or getting screenshots. Simply press on your third mouse button or 'delete' to revert back to your mouse pointer.

==But I don't have a third mouse button!==

The key 'J' works in the same way as the 'middle mouse button' does. So where you would use ctrl + middle mouse button to change camera modes, ctrl + j does the same thing. Pressing J once will also switch you from 'crosshair mode' to 'pointer mode' and vice versa.

==IÃ‚Â´ve managed to get stuck in this weird camera mode and my perspective is all messed up. How do I switch to the overhead (OTA style) camera?==

Shift+Backspace (or Shift+J or Shift+MiddleMouseClick) switches between the fps style, total war style and OTA style cameras. Use it to get your camera back to normal in this situation.

==People are cheating! How do I stop it?!==
Well currently, you can't.

Only the host can "activate" the cheat codes. After that, any player can do almost all cheats.

The best thing to do is just not play with the cheaters anymore. But with new spring version cheats are disabled in multiplayer, so that paragraph is hopefully now irrelevant.

==Well how do you cheat?==

<table border="3" cellpadding="2" cellspacing="0">

<tr><th>Cheat Command</th><th>Effect</th></tr>

<tr>
<td>'''.cheat'''</td><td>'''enable cheats - Cheats don't work in multiplayer until the host types this'''</td>
</tr>

<tr>
<td>.nocost</td><td>instabuild (doesn't work on things already under construction, only on new ones)</td>
</tr>

<tr>
<td>.setmaxspeed 50</td><td>Changes the maximum speed multiplier (default is 3.0)</td>
</tr>

<tr>
<td>.setminspeed 0</td><td>Changes the minimum speed multiplier (default is 0.3)</td>
</tr>

<tr>
<td>.spectator</td><td>Allows you to see the entire map... but you lose control of your units</td>
</tr>

<tr>
<td>.team 0, .team 1, etc.</td><td>Change player</td>
</tr>

<tr>
<td>.give ARMCOM, .give 10 CORKROG, etc.</td><td>Place 1 or specified number of specified unit. Valid units are the internal names of units as specified in the unit definition.</td>
</tr>

</table>
You can use auto-completion in the spring console if you don't remember the internal unit name. To do that type:
".give arm" and then press your '''TAB key'''
A list of all matching units will be shown.

==In Game Commands==

The following ''non-cheating'' commands are also available in game:

<table border="3" cellpadding="2" cellspacing="0">

<tr>
<th>Command</th><th>Effect</th>
</tr>

<tr>
<td>/info</td><td>Shows you what colour each player is and their ping delay in the bottom right corner of the screen.</td>
</tr>

<tr>
<td>/clock</td><td>Shows you the elapsed game time in minutes and seconds in the upper right corner of the screen</td>
</tr>

<tr>
<td>.take</td><td>Pulls all allied units, that are owned by players who have lost connection to the server, to your team.</td>
</tr>

</table>

==How do I ally or unally in game?==

Type /ally <teamID> [0|1] (this only works if the host allows changing allies midgame).

==How do I give somebody units or metal or energy?==

Press the 'H' key. Then select the amount of metal and/or energy to share. Then select the receiving player and press OK.

When sharing units, you must first select the units to share, then press 'H' key. Tick share units checkbox and choose a receiving player.

==How do I continually give somebody metal and/or energy after a certain point (i.e. Original TA commands +setshare..., +shareall)?==

You'll notice that on your metal and energy bars (top of screen), there are two red bars. You have to put them wherever you want your metal and energy to be shared after.

==This game is different than TA, the units HP and damage are not the same==

First off, Spring is not TA. Spring is an engine, on which various games can be run, some of which are modifications of TA content.

Now, there were several third party "balance" mods for the original TA game. One of those mods were XTA, and was developed by the same clan (SY) that has brought life back to TA, making Spring.

There are many other such mods, of which [[Balanced Annihilation]] is the most popular.

Now are several mods available, install the mod of your choice.

* http://spring.jobjol.nl/files.php?subcategory_id=5
* http://spring-portal.com/index.php/docman/cat_view/36-mods
* http://www.tasdownloads.com/?ta=2

==XTA? OTA? AA? OMFGLAMO? WTF do those abbreviations mean?==

zwzsg maintains a handy dandy FAQ about TA, and the abbreviations that relate to Spring too, of course.
[http://www.tauniverse.com/forum/showthread.php?t=27309 click here]. See also the Spring [[Glossary]], which contains brief explanations for all non-standard words and phrases.

==Why am I destroyed so easily by long range assaults?==

This is a realistic feature of Spring. Units will automatically attack 'radar blips' (units that they can not actually see, but that are indicated on radar). However, the accuracy is very bad while shooting at radar blips until:

* Your unit kills a lot of units and gets experience
* You get a targeting facility.

==Can I kick people from my 'game lobby' or my game?==

First of all, you have to be the host to kick. Use the good old "/kick playernamehere" command. Works in-game too, use it wisely.

==I hate driving around with the 'arrow keys'. Is there any way I can use the 'W-A-S-D' controls (the controls most First Person Shooters use) anymore?==

Go into your Spring directory and edit the uikeys file. Keep in mind that 'S' is originally a 'hot-key' that will stop your units and that 'D' is a 'hot-key' for your commander's D-Gun. You might want to change those too.

==I turned the shadows feature on; I still don't see shadows. What gives?==

Your graphics card can't handle shadows, so Spring automatically turns them off.

==I can't go backwards when I am 'driving' a unit. Why not?==

Because TA units were never intended to go backwards. Sorry, but you just cant.

==I'm in an Unreal Tournament kind of mood. How do I strafe?==

You can only strafe in 'brawler type' ships, such as the brawler, rapier, and light gunships.

==How can I record and watch demos/replays?==

From version 0.62 onwards recordings of all the games you play are easily available for replay via the Replays button in the TASClient.

You can use the Speed up/Slow down game keys while watching the replay, along with other in-game commands like .team

From version 0.60b1 onwards, demos are automatically recorded in the "demos" folder, underneath your Spring folder (default is C:\Program Files\Spring\demos), named for the date and map they were played on. If you play multiple games in the same day on the same map, the games will also be numbered to prevent them from overwriting each other.

From version 0.62 onwards, to view a demo from the Windows file manager you can just double click the file name.

==Sometimes when I play get "not sync" "delayed sync" errors==

That's caused because of lag. One of the players in the game is having some lag issues. Ask him/her to free up its bandwidth for the game to use.

Alternatively, you can use the pause key and wait till the connection gets more stable.

Ping is the second number showed when you use the /info command ingame, values larger than ~1000ms are not usual in a normal game and are a signal of lag.

FAQ:content

2008-11-16T07:47:13Z

Kingraptor:

=Content=

==Do Spring maps need a "ground"?==

Spring maps do require a ground. We have had many requests to have space maps, however, a "true" (ala Homeworld) space setting is not likely. It would have to wait until a much later stage. This does not mean that TA's style of "space" maps won't be possible, (see the Final Frontier TC for examples of this).

==You stated that Spring uses the TA unit format.==

Spring does use the Total Annihilation unit format. However, there is also a new format dubbed '.s3o' which uses a UV mapped texture instead of 3do's per face texturing system, as well as other improvements.

==How powerful will Spring's custom format be?==

Total Annihilation's unit format was extremely limited. Most of these limitations will either be expanded or non-existent in Spring's custom unit format. One of the most exciting improvements is the introduction of an entirely new method of scripting, with nearly complete control over every aspect of a unit's actions and behaviors.

==Does Spring have a limited number of weapons?==
No. Unlike Total Annihilation, Spring's weapon IDs will be unlimited. Meaning it will be possible to add as many third-party units as you want. However, the current model format limits 16 weapons to each unit.

==Does Spring have a limited number of unique units?==

No. Unit IDs, like weapon IDs, will be unlimited.

==Will units have a maximum of 3 unique weapons?==

Total Annihilation had a limitation that permitted a maximum of 3 unique weapons per unit. Spring currently has a way to have 16 weapons per unit. (Replace Primary, Secondary, Tertiary by 1 2 3 ...16). More can be made possible by modifying the source if there's a sufficient demand by mod makers.

==I'm curious as to the per-unit polygon limit.==

The engine itself does not have a polygon count limit. The limit is that of the processing power of today's computers. Since Spring requires a 3D card, the maximum polygon count per unit will be many, many times higher than Total Annihilation's; tricounts of >1000 on Peewee equivalents are perfectly viable. This isn't an excuse to waste polies, though!

==Will units be able to perform basic terraforming?==

Units do not have terraforming ability by default. Support for terraforming is possible with [[Lua Scripting]], such as in the [[Complete Annihilation]] mod. Alternatively, construction units can restore ground, and certain weapons (especially explosive ones) can be used to deform the ground.

==Will tunnel building be possible?==

Subterranean areas of any sort is impossible. However, it is possible to heavily deform the ground with explosives... Which is great fun!

==Will the ground's water retention be editable?==

No. Water will always collect when a piece of land has a height below sea level.

==Does Spring have a limit on the number of races?==

Spring has no limit on the total number of sides/races.

==What are the sizes of the biggest and smallest units?==

Static units (buildings, defenses, etc.) have no size limitations in the engine. Technically, neither do mobile units, but units with a footprint larger than 4x4 "squares" (an arbitrary size standard created by Cavedog) might have problems pathfinding.

==What is going to be the maximum possible sea depth?==

For all practical purposes, it will be unlimited. The depth values are stored as "float variables", so it is doubtful that maps would ever be made which even come close to approaching the limit.

==Will Spring support campaigns?==

Basic Map scripting has been implemented, using a Lua scripting engine. From that, it would be possible to make a basic campaign, but for ease of use a better way of selecting scripts and an improved Single player menu is needed.

See [[Mission development]] for more details.

==How big are the Spring files?==

Spring will be as small as however much content is included with it. The "essential" files are only be several megabytes large. Content (such as maps and units) will add considerable size to the Spring download. Currently, the file size is roughly 30 MB.

==How will Spring render sound effects?==

Sound is rendered 3D, meaning that the volume and direction (assuming a multi-speaker setup) vary with the location of the camera from the sound "emitter". What this translates into gameplay terms means that the closer you are to a unit making a sound or motion, the louder the sound will be. Additionally, the sound will be heard differently depending on which way the camera is facing relative to units making sound.

==Will Spring have ambient sound?==

There is no ambient sound, and we haven't planned on adding it thus far.

==Will there be an AI or a "skirmish" mode?==

We have created an interface for artificial intelligences (AIs), and several are currently under development. Information on these can be found at the [[AIs]] wiki page.

==Will a "possess" or a FPS option be present?==

Yes, it is possible to fully control a unit from the first person view. It is more of a gimmick, but it still allows for a nice diversion once in a while. Instructions on its use are in the [[Using_Spring#FPS_.22Mode.22_.28C.29|Using Spring]] article.

==How do I create maps?==

See the [[Map development]] page for all the map info.

==How do I create units/mods?==

See the [[Mod_and_Unit_development#Mod_devlopement|Mod and Unit development]] page on creating units/ mods.

[[Category:Content]]

FAQ:player

2008-11-16T07:44:40Z

Kingraptor:

=Playing=

==What is with this weird right-click mode? I'm 'bout to break my keyboard.==

Sorry, you'll just have to get used to it. As of now it can't be changed.

==Why is somebody else also controlling my units?==

In the 'game lobby' there are two sets of teams. There are the 'Ids' and the 'teams'. If you are on the same 'Id', then you both get the same commander, and can control the same units (commonly referred to as comsharing). If you are on the same 'Team', then you both get different commanders and can't control each others units.

==Then why would I want to be on the same 'Id' as somebody?==

Because it's fun to just drive around units and not have to worry about commanding. (Assuming that one of the people on the team is commanding.)
Most importantly, however, you can split tasks, such as base building, and troops management.

==Is there a way that I can play music directly through Spring, with alternating tracks for building/attacking like in the original Total Annihilation?==

Yes, there is. It is an add on (GroupAI) you have to download separately:
http://jobjol.nl/1188

There is also an ingame sound-volume-slider you might find useful (lua-script):
http://jobjol.nl/1218

==Sometimes I can't write anything but numbers and some other symbols. Why is that?==

This is most likely because of the Windows language bar change from which Spring doesn't recognize the characters written.
Note: That Default hotkeys in Windows XP for changing the language is Shift+Alt, which is similar to square build hotkeys in Spring!

==How do I talk to my allies only?==

You must type 'a:' before you speak, or press "Alt Enter" at the same time. Here's an example: a: Now I am talking to my allies only. 

==Help! After I'm finished driving a unit, the camera is all insane! This is nuts! How do I fix it?==

Whoa now. Calm down. Just press ctrl + mouse button 3 to change camera modes. If your unit is destroyed in FPS mode, you will stay in FPS mode until you change camera modes. Also, the camera will stay in "free look" when FPS mode is disengaged, press middle-mouse or J to switch to normal scrolling.

==After I'm finished driving a unit, where what used to be my mouse pointer is now a crosshair. Why?==

-This is a special 'view mode' that allows you to move around the screen much faster. It's good for viewing the battle or getting screenshots. Simply press on your third mouse button or 'delete' to revert back to your mouse pointer.

==But I don't have a third mouse button!==

The key 'J' works in the same way as the 'middle mouse button' does. So where you would use ctrl + middle mouse button to change camera modes, ctrl + j does the same thing. Pressing J once will also switch you from 'crosshair mode' to 'pointer mode' and vice versa.

==IÃ‚Â´ve managed to get stuck in this weird camera mode and my perspective is all messed up. How do I switch to the overhead (OTA style) camera?==

Shift+Backspace (or Shift+J or Shift+MiddleMouseClick) switches between the fps style, total war style and OTA style cameras. Use it to get your camera back to normal in this situation.

==People are cheating! How do I stop it?!==
Well currently, you can't.

Only the host can "activate" the cheat codes. After that, any player can do almost all cheats.

The best thing to do is just not play with the cheaters anymore. But with new spring version cheats are disabled in multiplayer, so that paragraph is hopefully now irrelevant.

==Well how do you cheat?==

<table border="3" cellpadding="2" cellspacing="0">

<tr><th>Cheat Command</th><th>Effect</th></tr>

<tr>
<td>'''.cheat'''</td><td>'''enable cheats - Cheats don't work in multiplayer until the host types this'''</td>
</tr>

<tr>
<td>.nocost</td><td>instabuild (doesn't work on things already under construction, only on new ones)</td>
</tr>

<tr>
<td>.setmaxspeed 50</td><td>Changes the maximum speed multiplier (default is 3.0)</td>
</tr>

<tr>
<td>.setminspeed 0</td><td>Changes the minimum speed multiplier (default is 0.3)</td>
</tr>

<tr>
<td>.spectator</td><td>Allows you to see the entire map... but you lose control of your units</td>
</tr>

<tr>
<td>.team 0, .team 1, etc.</td><td>Change player</td>
</tr>

<tr>
<td>.give ARMCOM, .give 10 CORKROG, etc.</td><td>Place 1 or specified number of specified unit. Valid units are the internal names of units as specified in the unit definition.</td>
</tr>

</table>
You can use auto-completion in the spring console if you don't remember the internal unit name. To do that type:
".give arm" and then press your '''TAB key'''
A list of all matching units will be shown.

==In Game Commands==

The following ''non-cheating'' commands are also available in game:

<table border="3" cellpadding="2" cellspacing="0">

<tr>
<th>Command</th><th>Effect</th>
</tr>

<tr>
<td>/info</td><td>Shows you what colour each player is and their ping delay in the bottom right corner of the screen.</td>
</tr>

<tr>
<td>/clock</td><td>Shows you the elapsed game time in minutes and seconds in the upper right corner of the screen</td>
</tr>

<tr>
<td>.take</td><td>Pulls all allied units, that are owned by players who have lost connection to the server, to your team.</td>
</tr>

</table>

==How do I ally or unally in game?==

I'm pretty sure you can't. Yet.

==How do I give somebody units or metal or energy?==

Press the 'H' key. Then select the amount of metal and/or energy to share. Then select the receiving player and press OK.

When sharing units, you must first select the units to share, then press 'H' key. Tick share units checkbox and choose a receiving player.

==How do I continually give somebody metal and/or energy after a certain point (i.e. Original TA commands +setshare..., +shareall)?==

You'll notice that on your metal and energy bars (top of screen), there are two red bars. You have to put them wherever you want your metal and energy to be shared after.

==This game is different than TA, the units HP and damage are not the same==

First off, Spring is not TA. Spring is an engine, on which various games can be run, some of which are modifications of TA content.

Now, there were several third party "balance" mods for the original TA game. One of those mods were XTA, and was developed by the same clan (SY) that has brought life back to TA, making Spring.

There are many other such mods, of which [[Balanced Annihilation]] is the most popular.

Now are several mods available, install the mod of your choice.

* http://spring.jobjol.nl/files.php?subcategory_id=5
* http://spring-portal.com/index.php/docman/cat_view/36-mods
* http://www.tasdownloads.com/?ta=2

==XTA? OTA? AA? OMFGLAMO? WTF do those abbreviations mean?==

zwzsg maintains a handy dandy FAQ about TA, and the abbreviations that relate to Spring too, of course.
[http://www.tauniverse.com/forum/showthread.php?t=27309 click here]. See also the Spring [[Glossary]], which contains brief explanations for all non-standard words and phrases.

==Why am I destroyed so easily by long range assaults?==

This is a realistic feature of Spring. Units will automatically attack 'radar blips' (units that they can not actually see, but that are indicated on radar). However, the accuracy is very bad while shooting at radar blips until:

* Your unit kills a lot of units and gets experience
* You get a targeting facility.

==Can I kick people from my 'game lobby' or my game?==

First of all, you have to be the host to kick. Use the good old "/kick playernamehere" command. Works in-game too, use it wisely.

==I hate driving around with the 'arrow keys'. Is there any way I can use the 'W-A-S-D' controls (the controls most First Person Shooters use) anymore?==

Go into your Spring directory and edit the uikeys file. Keep in mind that 'S' is originally a 'hot-key' that will stop your units and that 'D' is a 'hot-key' for your commander's D-Gun. You might want to change those too.

==I turned the shadows feature on; I still don't see shadows. What gives?==

Your graphics card can't handle shadows, so Spring automatically turns them off.

==I can't go backwards when I am 'driving' a unit. Why not?==

Because TA units were never intended to go backwards. Sorry, but you just cant.

==I'm in an Unreal Tournament kind of mood. How do I strafe?==

You can only strafe in 'brawler type' ships, such as the brawler, rapier, and light gunships.

==How can I record and watch demos/replays?==

From version 0.62 onwards recordings of all the games you play are easily available for replay via the Replays button in the TASClient.

You can use the Speed up/Slow down game keys while watching the replay, along with other in-game commands like .team

From version 0.60b1 onwards, demos are automatically recorded in the "demos" folder, underneath your Spring folder (default is C:\Program Files\Spring\demos), named for the date and map they were played on. If you play multiple games in the same day on the same map, the games will also be numbered to prevent them from overwriting each other.

From version 0.62 onwards, to view a demo from the Windows file manager you can just double click the file name.

==Sometimes when I play get "not sync" "delayed sync" errors==

That's caused because of lag. One of the players in the game is having some lag issues. Ask him/her to free up its bandwidth for the game to use.

Alternatively, you can use the pause key and wait till the connection gets more stable.

Ping is the second number showed when you use the /info command ingame, values larger than ~1000ms are not usual in a normal game and are a signal of lag.

Complete Annihilation

2008-09-09T07:41:37Z

Kingraptor: fix list

=Introduction=
[http://trac.caspring.org/wiki/ Complete Annihilation] is generally the second most played mod in Spring. It has an active playerbase and while it is still under development, it is kept fully playable. It traces its heritage to Total Annihilation, however, ''CA is not OTA''. It is gradually moving away from OTA, replacing the copyrighted models and textures with open-source ones while shifting change the gameplay dramatically. CA aims to be a dynamic, action-packed, hassle-free game, full of clever strategies and constantly moving combat.

[http://trac.caspring.org/wiki/CaIntro Click here for a more detailed introduction]

== Design goals ==
*A large range of viable tactics.
*Larger emphasis on unit decisions/selections and their micromanagement.
*Less emphasis on economy micromanagement (mex overdrive replaces moho metal extractors and metal makers).
*All units situationally useful throughout the game (there is no unit redundancy, heavy and light units work together on the battlefield).
*Superior graphics and appearance.
*Powerfull LUA GUI enhancements to free your hands and allow players to focus on tactical decisions (air transports automatically ferry units from factories, units can be set to autoretreat when damaged etc.).
*Faster and more demanding gameplay (units move faster and unit selection is more important).
*Unit differences achieved using game dynamics and not using special hidden damages/armor classes.

=Features=

==Gameplay==
*No effective single unit spam (hopefully).
*Kbots and Vehicles are both viable on most maps.
*Arm and Core have a different play style.
*Windmill output increases with altitude.

==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/sd SpringDownloader (the easiest & fastest to get CA and Spring maps)]''

''[http://web.alexmic.free.fr/CAUpdater.html CAUpdater, written in PyQt4 (windows, linux) ]''

Back to [[Mods]]

[[Category:Mods]]
{{Category:Mods}}

Mods

2008-09-07T16:26:35Z

Kingraptor:

{|border="2" cellpadding="4" cellspacing="0" style="margin: 10px; border: 1px #aaa solid; border-collapse: collapse; background: #1155aa"
|<center>'''Other Languages'''</center>
|<center>'''[[Image:germany_flag.gif]] [[Mods (de)|Deutsch]]'''</center>

|}

If you're interested in editing mods or creating your own mods, see the [[Mod Development]] page.

===What are Mods? / Spring Client-Compatible Mods===

Mods traditionally constitute additions to a game that change the way it works. However, the term Mod when used in connection to the Spring project refers to a game in its own right that runs on the Spring engine. The following mods adhere to the official [[Mod_specification]] which ensures that they work with the Lobby Client.

{{Category:Mods}}

===Where to download Mods===
* [http://spring.clan-sy.com/wiki/Getting_Spring_Content_and_Links "Getting Spring Content and Links"] wiki page

* http://spring.jobjol.nl/files.php?subcategory_id=5

* http://spring-portal.com/index.php/docman/cat_view/36-mods

* http://www.tasdownloads.com/?ta=2

===Gimmick Mods===

* [[Chess Mod]]
* [[Spawn]]
* [[Timberwolf Mod]]
* [[The Blue Tanks]]
* [[Duel]]

===Mod Mutators===

* [[Epic EE|Epic Scale Expand & Exterminate]]
* [[Nemo's Final Frontier]]
* [[WarC/Balanced Absolute Annihilation]]
* [[Forged Absolute Annihilation]]
* [[Hover Absolute Annihilation]]
* [[Persh/Excessive Absolute Annihilation]]

===Mods in Production===

=====Unreleased=====
* [[GEM|Galactic Empire Mod]]
* [[RealOTA]]
* [[Dune]]
* [[Lego Spring]]
* [[Spring1944|Spring 1944 (Formally AATA on the OTA engine)]]
* [[GINTA]]
* [[CvC]]
* [[TrueOTA]]
* [[Dozerz]]
* [[Tactical Front]]
* [[Tactical Smash]]
* [[EPIC ANNIHILATION RELOADED (WITH KROGOTS LOL)]]

=====Released Incomplete=====
* [[Battletech]]
* [[TA_BattleFleet]] by VonGratz
* [[BloX]]
* [[The Plot of War]]
* [[Epic Legions]]

===Incomplete Mods===

These consist of "crude" mods that do not work with the current builds of the Spring engine and incomplete projects that are not in production. You can download many of the following other, partially functioning Mods from: [http://www.fileuniverse.com/?page=listing&ID=92 File Universe]:

* DM45Spring.exe
* [[MAD TA]] Buildpics for Spring
* [[MiniSpring]] (Actually a code modification, abandoned.)
* [[OTAR-EVAMP]]
* [[Project Ragnarok]]
* [[Rhyoss]] for Spring
* [[UTASP]] 5 Spring
* [[WH - F]]
* [[Kustorion]] Thoughs Of Whole Design

=== Other Resources ===
* [http://www.fileuniverse.com/?page=listing&ID=92 File Universe] link
* "[http://www.tauniverse.com/forum/showthread.php?s=&postid=435292#post435292 Mods, Races, TCs, Unit Packs]" entry in the [http://www.tauniverse.com tauniverse.com] forum
* [[Modweb_Generator]] is a tool that allows you to set up a web that shows information about mods, this page has some example mod-webs.
* [http://modinfo.adune.nl Modinfo] shows information about units/weapons/corpses etc stuff, in almost any mod (if some mod is missing, PM at TradeMark). Modinfo has also an "error reporting" tool, which shows errors in the TDF files, like missing ; marks. "find errors" utility shows several types of errors, and other useful information about cleaning up your mod.

[[Category:Mods]] [[Category:Content]]

Category:Mods

2008-09-07T16:20:35Z

Kingraptor: Fixed background color. Someone needs to go over the wiki and fix all the tables

<center>'''Spring Mods'''</center>
{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; background: #1155aa; border: 1px #aaa solid; border-collapse: collapse;"
|align="center" width="245"|[[Absolute Annihilation]]
|align="center" width="245"|[[Balanced Annihilation]]
|align="center" width="245"|[[BOTA|Basically OTA]]
|-
|align="center"|[[Complete Annihilation]]
|align="center"|[[Commander Shooter]]
|align="center"|[[EvoTA]]
|-
|align="center"|[[Expand and Exterminate]]
|align="center"|[[Final Frontier]]
|align="center"|[[Gundam Annihilation|Gundam RTS]]
|-
|align="center"|[[Kernel Panic]]
|align="center"|[[KuroTA]]
|align="center" width="245"|[[Maximum Annihilation]]
|-
|align="center"|[[Nanoblobs]]
|align="center"|[[SWTA|Star Wars TA]]
|align="center"|[[SpiderPack]]
|-
|align="center"|[[TA-WD|TA: World Domination]]
|align="center"|[[The Blue Tank]]
|align="center"|[[The Lost Legacy]]
|-
|align="center"|[[UberHack]]
|align="center"|[[War Evolution]]
|align="center"|[[NOTA]]
|-
|align="center"|[[Xect vs. Mynn]]
|align="center"|[[XTA]]
|align="center"|
|}
[[Category:Content]]

Complete Annihilation

2008-09-07T15:46:19Z

Kingraptor:

=Introduction=

Complete Annihilation (CA) is a game made for the Spring engine. It is a derivative of the original Total Annihilation (OTA), with the goal of eventually replacing all copyrighted content (models, textures and the like) with original, open source content.

CA emphasizes distinct unit roles and fluid, always-moving gameplay from start to finish.

[http://trac.caspring.org/wiki/CaIntro A more detailed introduction]

=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 for a hefty energy cost.
*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/sd SpringDownloader (the easiest & fastest to get CA and Spring maps)]''

''[http://web.alexmic.free.fr/CAUpdater.html CAUpdater, written in PyQt4 (windows, linux) ]''

Back to [[Mods]]

[[Category:Mods]]
{{Category:Mods}}